Class: GeographicItem

Inherits:

Object
ActiveRecord::Base
ApplicationRecord
GeographicItem

show all

Includes:: Housekeeping::Timestamps, Housekeeping::Users, Shared::HasPapertrail, Shared::IsData, Shared::SharedAcrossProjects

Defined in:: app/models/geographic_item.rb

Overview

A GeographicItem is one and only one of [point, line_string, polygon, multi_point, multi_line_string, multi_polygon, geometry_collection] which describes a position, path, or area on the globe, generally associated with a geographic_area (through a geographic_area_geographic_item entry), and sometimes only with a georeference.

Key methods in this giant library

‘#geo_object` - return a RGEO object representation

Direct Known Subclasses

GeometryCollection, LineString, MultiLineString, MultiPoint, MultiPolygon, Point, Polygon

Defined Under Namespace

Classes: GeometryCollection, LineString, MultiLineString, MultiPoint, MultiPolygon, Point, Polygon

Constant Summary collapse

DATA_TYPES =

[
  :point,
  :line_string,
  :polygon,
  :multi_point,
  :multi_line_string,
  :multi_polygon,
  :geometry_collection
].freeze

GEOMETRY_SQL =

Arel::Nodes::Case.new(arel_table[:type])
.when('GeographicItem::MultiPolygon').then(Arel::Nodes::NamedFunction.new('CAST', [arel_table[:multi_polygon].as('geometry')]))
.when('GeographicItem::Point').then(Arel::Nodes::NamedFunction.new('CAST', [arel_table[:point].as('geometry')]))
.when('GeographicItem::LineString').then(Arel::Nodes::NamedFunction.new('CAST', [arel_table[:line_string].as('geometry')]))
.when('GeographicItem::Polygon').then(Arel::Nodes::NamedFunction.new('CAST', [arel_table[:polygon].as('geometry')]))
.when('GeographicItem::MultiLineString').then(Arel::Nodes::NamedFunction.new('CAST', [arel_table[:multi_line_string].as('geometry')]))
.when('GeographicItem::MultiPoint').then(Arel::Nodes::NamedFunction.new('CAST', [arel_table[:multi_point].as('geometry')]))
.when('GeographicItem::GeometryCollection').then(Arel::Nodes::NamedFunction.new('CAST', [arel_table[:geometry_collection].as('geometry')]))
.freeze

GEOGRAPHY_SQL =

"CASE geographic_items.type
WHEN 'GeographicItem::MultiPolygon' THEN multi_polygon
WHEN 'GeographicItem::Point' THEN point
WHEN 'GeographicItem::LineString' THEN line_string
WHEN 'GeographicItem::Polygon' THEN polygon
WHEN 'GeographicItem::MultiLineString' THEN multi_line_string
WHEN 'GeographicItem::MultiPoint' THEN multi_point
WHEN 'GeographicItem::GeometryCollection' THEN geometry_collection
END".freeze

ANTI_MERIDIAN = ANTI_MERIDIAN = ‘0X0102000020E61000000200000000000000008066400000000000405640000000000080664000000000004056C0’

'LINESTRING (180 89.0, 180 -89)'.freeze

Instance Attribute Summary collapse

#cached_total_area ⇒ Numeric

If polygon-based the value of the enclosed area in square meters.
#geometry ⇒ Hash^?

An internal variable for use in super calls, holds a Hash in GeoJSON format (temporarily).
#line_string ⇒ RGeo::Geographic::ProjectedLineStringImpl
#multi_line_string ⇒ RGeo::Geographic::ProjectedMultiLineStringImpl
#multi_point ⇒ RGeo::Geographic::ProjectedMultiPointImpl
#multi_polygon ⇒ RGeo::Geographic::ProjectedMultiPolygonImpl

CCW orientation is applied.
#no_cached ⇒ Boolean

When true cached values are not built.
#point ⇒ RGeo::Geographic::ProjectedPointImpl
#polygon ⇒ RGeo::Geographic::ProjectedPolygonImpl

CCW orientation is applied.
#shape ⇒ Boolean, RGeo object

TODO: WHY! boolean not nil, or object Used to build geographic items from a shape [ of what class ] !?.
#type ⇒ String

Rails STI, determines the geography column as well.

Attributes included from Housekeeping::Users

#by

Class Method Summary collapse

.aliased_geographic_sql(name = 'a') ⇒ Object
.are_contained_in_item(column_name, *geographic_items) ⇒ Scope

See are_contained_in_item_by_id.
.are_contained_in_item_by_id(column_name, *geographic_item_ids) ⇒ Scope

rubocop:disable Metrics/MethodLength If this scope is given an Array of GeographicItems as a second parameter, it will return the ‘OR’ of each of the objects against the table.
.are_contained_in_wkt(column_name, geometry) ⇒ Scope

a single WKT geometry is compared against column or columns (except geometry_collection) to find geographic_items which are contained in the WKT.
.contained_by(*geographic_item_ids) ⇒ Scope

(works via ST_ContainsProperly).
.contained_by_where_sql(*geographic_item_ids) ⇒ String

Note: Can not use GEOMETRY_SQL because geometry_collection is not supported in ST_ContainsProperly Note: !! If the target GeographicItem#id crosses the anti-meridian then you may/will get unexpected results.
.contained_by_with_antimeridian_check(*ids) ⇒ Array

TODO: test this.
.contained_by_wkt_shifted_sql(wkt) ⇒ String

Note: this routine is called when it is already known that the A argument crosses anti-meridian.
.contained_by_wkt_sql(wkt) ⇒ String

TODO: Remove the hard coded 4326 reference.
.containing(*geographic_item_ids) ⇒ Scope

The geographic items containing these collective geographic_item ids, not including self.
.containing_point(rgeo_point) ⇒ Scope

TODO: should be containing_wkt ?.
.containing_sql(target_column_name = nil, geographic_item_id = nil, source_column_name = nil) ⇒ String

A SQL fragment for ST_Contains() function, returns all geographic items which are contained in the item supplied.
.containing_where_for_point_sql(rgeo_point) ⇒ String

TODO: Remove the hard coded 4326 reference TODO: should this be wkt_point instead of rgeo_point?.
.containing_where_sql(*geographic_item_ids) ⇒ String
.containing_where_sql_geog(*geographic_item_ids) ⇒ String
.crosses_anti_meridian?(wkt) ⇒ Boolean

Whether or not the wtk intersects with the anti-meridian !! StrongParams security considerations.
.crosses_anti_meridian_by_id?(*ids) ⇒ Boolean

Whether or not any GeographicItem passed intersects the anti-meridian !! StrongParams security considerations This is our first line of defense against queries that define multiple shapes, one or more of which crosses the anti-meridian.
.debug_draw(geographic_item_ids = []) ⇒ Object private

Crude debuging helper, write the shapes to a png.
.default_by_geographic_area_ids(geographic_area_ids = []) ⇒ GeographicItem::ActiveRecord_Relation
.disjoint_from(column_name, *geographic_items) ⇒ Scope

A SQL fragment for ST_DISJOINT, specifies all geographic_items that have data in column_name that are disjoint from the passed geographic_items.
.distance_between(geographic_item_id1, geographic_item_id2) ⇒ Float
.eval_for_type(type_name) ⇒ String

If type.
.geometry_for(geographic_item_id) ⇒ RGeo::Geographic object

example, not used.
.geometry_for_collection_sql(*geographic_item_ids) ⇒ String

example, not used.
.geometry_for_sql(geographic_item_id) ⇒ String

example, not used.
.geometry_sql(geographic_item_id = nil, source_column_name = nil) ⇒ String

source_column_name, i.e.
.geometry_sql2(*geographic_item_ids) ⇒ String

geometry as ‘geometry’ for a single id.
.intersecting(column_name, *geographic_items) ⇒ Scope
.intersecting_radius_of_wkt_sql(wkt, distance) ⇒ String

TODO: 3D is overkill here !! This is intersecting.
.is_contained_by(column_name, *geographic_items) ⇒ Scope

rubocop:disable Metrics/MethodLength containing the items the shape of which is contained in the geographic_item supplied.
.is_contained_by_sql(column_name, geographic_item) ⇒ String

rubocop:disable Metrics/MethodLength.
.lat_long_sql(choice) ⇒ String

A fragment returning either latitude or longitude columns.
.not_including(geographic_items) ⇒ Scope
.ordered_by_longest_distance_from(column_name, geographic_item) ⇒ Scope
.ordered_by_shortest_distance_from(column_name, geographic_item) ⇒ Scope
.point_inferred_geographic_name_hierarchy(point) ⇒ Hash

As per #inferred_geographic_name_hierarchy but for Rgeo point.
.reverse_containing_sql(target_column_name = nil, geographic_item_id = nil, source_column_name = nil) ⇒ String

A SQL fragment for ST_Contains(), returns all geographic_items which contain the supplied geographic_item.
.select_distance_with_geo_object(column_name, geographic_item) ⇒ String
.select_geography_sql(geographic_item_id) ⇒ String

A SQL select statement that returns the geography for the geographic_item with the specified id.
.select_geometry_sql(geographic_item_id) ⇒ String

A SQL select statement that returns the geometry for the geographic_item with the specified id.
.single_geometry_sql(*geographic_item_ids) ⇒ String

Returns one or more geographic items combined as a single geometry in column ‘single’.
.st_buffer_st_within(geographic_item_id, distance, buffer = 0) ⇒ String
.st_collect(geographic_item_scope) ⇒ Object
.st_collect_sql(*geographic_item_ids) ⇒ String

provided via ST_Collect).
.st_multi(*geographic_item_ids) ⇒ Scope

example, not used.
.st_union(geographic_item_scope) ⇒ Object
.where_distance_greater_than_zero(column_name, geographic_item) ⇒ Scope
.with_area ⇒ Scope

Adds an area_in_meters field, with meters.
.with_collecting_event_through_georeferences ⇒ Scope

This uses an Arel table approach, this is ultimately more decomposable if we need.
.with_is_valid_geometry_column(geographic_item) ⇒ Scope

Includes an ‘is_valid’ attribute (True/False) for the passed geographic_item.
.with_latitude ⇒ Scope

Include a ‘latitude’ column.
.with_longitude ⇒ Scope

Include a ‘longitude’ column.
.within_radius_of_item(geographic_item_id, distance) ⇒ ActiveRecord::Relation

!! should be distance, not radius?!.
.within_radius_of_item_sql(geographic_item_id, distance) ⇒ String
.within_radius_of_wkt_sql(wkt, distance) ⇒ String

!! This is fully covering.

Instance Method Summary collapse

#align_winding ⇒ Object private
#area ⇒ Float

TODO: share with world Geographic item 96862 (Cajamar in Brazil) is the only(?) record to fail using ‘false` (quicker) method of everything we tested.
#center_coords ⇒ Array

The lat, long, as STRINGs for the centroid of this geographic item Meh- this: postgis.net/docs/en/ST_MinimumBoundingRadius.html.
#centroid ⇒ RGeo::Geographic::ProjectedPointImpl

Representing the centroid of this geographic item.
#containing_geographic_areas ⇒ Scope

The Geographic Areas that contain (gis) this geographic item.
#contains?(target_geo_object) ⇒ Boolean
#far(target_geo_object, distance) ⇒ Boolean
#geo_object ⇒ RGeo instance^?

The Rgeo shape (See rubydoc.info/github/dazuma/rgeo/RGeo/Feature).
#geo_object_type ⇒ Symbol

according to the list of DATA_TYPES, or nil.
#geo_type ⇒ Symbol private

Returns the attribute (column name) containing data nearly all methods should use #geo_object_type, not geo_type.
#geographic_name_hierarchy ⇒ Object
#has_polygons? ⇒ Boolean

!! Unused.
#inferred_geographic_name_hierarchy ⇒ Hash

finding the smallest area containing this GeographicItem, in the most accurate gazetteer and using it to return country/state/county.
#intersecting_area(geographic_item_id) ⇒ Float, false

The value in square meters of the interesecting area of this and another GeographicItem.
#intersects?(target_geo_object) ⇒ Boolean
#is_basic_donut? ⇒ Boolean

!! Does not confirm that shapes are nested !!.
#line_string_to_a(line_string) ⇒ Array private

Of points in the line.
#line_string_to_hash(line_string) ⇒ Hash private

Of points in the line.
#multi_line_string_to_a(multi_line_string) ⇒ Array private

Of line_strings as arrays of points.
#multi_line_string_to_hash(_multi_line_string) ⇒ Hash private

Of line_strings as hashes of points.
#multi_point_to_a(multi_point) ⇒ Array private

Of points.
#multi_point_to_hash(_multi_point) ⇒ Hash private

Of points.
#multi_polygon_to_a(multi_polygon) ⇒ Array private

Of arrays of points in the polygons (exterior_ring ONLY).
#multi_polygon_to_hash(_multi_polygon) ⇒ Hash private

Of hashes of points in the polygons (exterior_ring ONLY).
#near(target_geo_object, distance) ⇒ Boolean
#orientations ⇒ Object

Convention is to store in PostGIS in CCW.
#point_to_a(point) ⇒ Array private

Of a point Longitude |, Latitude -.
#point_to_hash(point) ⇒ Hash private

Of a point.
#polygon_to_a(polygon) ⇒ Array private

Of points in the polygon (exterior_ring ONLY).
#polygon_to_hash(polygon) ⇒ Hash private

Of points in the polygon (exterior_ring ONLY).
#quick_geographic_name_hierarchy ⇒ Hash

This is a quick approach that works only when the geographic_item is linked explicitly to a GeographicArea.
#radius ⇒ Object

TODO: This is bad, while internal use of ONE_WEST_MEAN is consistent it is in-accurate given the vast differences of radius vs.
#rgeo_to_geo_json ⇒ GeoJSON hash

Via Rgeo apparently necessary for GeometryCollection.
#set_cached ⇒ Object private

else render json: false end end.
#set_type_if_geography_present ⇒ Boolean, String private

False if already set, or type to which it was set.
#some_data_is_provided ⇒ Boolean private

Iff there is one and only one shape column set.
#st_centroid ⇒ String

A WKT POINT representing the centroid of the geographic item.
#st_distance(geographic_item_id) ⇒ Double (also: #distance_to)

Distance in meters (slower, more accurate).
#st_distance_spheroid(geographic_item_id) ⇒ Double

Distance in meters (faster, less accurate).
#st_distance_to_geographic_item(geographic_item) ⇒ Double

Like st_distance but works with changed and non persisted objects.
#st_isvalid ⇒ Object
#st_isvalidreason ⇒ Object
#st_npoints ⇒ Integer

The number of points in the geometry.
#start_point ⇒ Array of latitude, longitude

The lat, lon of the first point in the GeoItem, see subclass for #st_start_point.
#to_geo_json ⇒ Hash

In GeoJSON format Computed via “raw” PostGIS (much faster).
#to_geo_json_feature ⇒ Hash

The shape as a GeoJSON Feature with some item metadata.
#to_geo_json_string ⇒ Object

We don’t need to serialize to/from JSON.
#to_wkt ⇒ String
#valid_geometry? ⇒ Boolean

Whether stored shape is ST_IsValid.
#within?(target_geo_object) ⇒ Boolean

Instance Attribute Details

#cached_total_area ⇒ `Numeric`

Returns if polygon-based the value of the enclosed area in square meters.

Returns:

(Numeric) —

if polygon-based the value of the enclosed area in square meters

# File 'app/models/geographic_item.rb', line 40

class GeographicItem < ApplicationRecord
  include Housekeeping::Users
  include Housekeeping::Timestamps
  include Shared::HasPapertrail
  include Shared::IsData
  include Shared::SharedAcrossProjects

  # @return [Hash, nil]
  #   An internal variable for use in super calls, holds a Hash in GeoJSON format (temporarily)
  attr_accessor :geometry

  # @return [Boolean, RGeo object]
  # @params value [Hash in GeoJSON format] ?!
  # TODO: WHY! boolean not nil, or object
  # Used to build geographic items from a shape [ of what class ] !?
  attr_accessor :shape

  # @return [Boolean]
  #   When true cached values are not built
  attr_accessor :no_cached

  DATA_TYPES = [
:point,
:line_string,
:polygon,
:multi_point,
:multi_line_string,
:multi_polygon,
:geometry_collection
  ].freeze

  GEOMETRY_SQL = Arel::Nodes::Case.new(arel_table[:type])
.when('GeographicItem::MultiPolygon').then(Arel::Nodes::NamedFunction.new('CAST', [arel_table[:multi_polygon].as('geometry')]))
.when('GeographicItem::Point').then(Arel::Nodes::NamedFunction.new('CAST', [arel_table[:point].as('geometry')]))
.when('GeographicItem::LineString').then(Arel::Nodes::NamedFunction.new('CAST', [arel_table[:line_string].as('geometry')]))
.when('GeographicItem::Polygon').then(Arel::Nodes::NamedFunction.new('CAST', [arel_table[:polygon].as('geometry')]))
.when('GeographicItem::MultiLineString').then(Arel::Nodes::NamedFunction.new('CAST', [arel_table[:multi_line_string].as('geometry')]))
.when('GeographicItem::MultiPoint').then(Arel::Nodes::NamedFunction.new('CAST', [arel_table[:multi_point].as('geometry')]))
.when('GeographicItem::GeometryCollection').then(Arel::Nodes::NamedFunction.new('CAST', [arel_table[:geometry_collection].as('geometry')]))
.freeze

  GEOGRAPHY_SQL = "CASE geographic_items.type
WHEN 'GeographicItem::MultiPolygon' THEN multi_polygon
WHEN 'GeographicItem::Point' THEN point
WHEN 'GeographicItem::LineString' THEN line_string
WHEN 'GeographicItem::Polygon' THEN polygon
WHEN 'GeographicItem::MultiLineString' THEN multi_line_string
WHEN 'GeographicItem::MultiPoint' THEN multi_point
WHEN 'GeographicItem::GeometryCollection' THEN geometry_collection
END".freeze

# ANTI_MERIDIAN = '0X0102000020E61000000200000000000000008066400000000000405640000000000080664000000000004056C0'
ANTI_MERIDIAN = 'LINESTRING (180 89.0, 180 -89)'.freeze

has_many :cached_map_items, inverse_of: :geographic_item

has_many :geographic_areas_geographic_items, dependent: :destroy, inverse_of: :geographic_item
has_many :geographic_areas, through: :geographic_areas_geographic_items
has_many :asserted_distributions, through: :geographic_areas
has_many :geographic_area_types, through: :geographic_areas
has_many :parent_geographic_areas, through: :geographic_areas, source: :parent

has_many :georeferences, inverse_of: :geographic_item
has_many :georeferences_through_error_geographic_item,
  class_name: 'Georeference', foreign_key: :error_geographic_item_id, inverse_of: :error_geographic_item
has_many :collecting_events_through_georeferences, through: :georeferences, source: :collecting_event
has_many :collecting_events_through_georeference_error_geographic_item,
  through: :georeferences_through_error_geographic_item, source: :collecting_event

# TODO: THIS IS NOT GOOD
before_validation :set_type_if_geography_present

validate :some_data_is_provided
validates :type, presence: true # not needed

scope :include_collecting_event, -> { includes(:collecting_events_through_georeferences) }
scope :geo_with_collecting_event, -> { joins(:collecting_events_through_georeferences) }
scope :err_with_collecting_event, -> { joins(:georeferences_through_error_geographic_item) }

after_save :set_cached, unless: Proc.new {|n| n.no_cached || errors.any? }
after_save :align_winding

class << self

  def aliased_geographic_sql(name = 'a')
    "CASE #{name}.type \
     WHEN 'GeographicItem::MultiPolygon' THEN #{name}.multi_polygon \
     WHEN 'GeographicItem::Point' THEN #{name}.point \
     WHEN 'GeographicItem::LineString' THEN #{name}.line_string \
     WHEN 'GeographicItem::Polygon' THEN #{name}.polygon \
     WHEN 'GeographicItem::MultiLineString' THEN #{name}.multi_line_string \
     WHEN 'GeographicItem::MultiPoint' THEN #{name}.multi_point \
     WHEN 'GeographicItem::GeometryCollection' THEN #{name}.geometry_collection \
     END"
  end

  def st_union(geographic_item_scope)
    GeographicItem.select("ST_Union(#{GeographicItem::GEOMETRY_SQL.to_sql}) as collection")
      .where(id: geographic_item_scope.pluck(:id))
  end

  def st_collect(geographic_item_scope)
    GeographicItem.select("ST_Collect(#{GeographicItem::GEOMETRY_SQL.to_sql}) as collection")
      .where(id: geographic_item_scope.pluck(:id))
  end

  # @return [GeographicItem::ActiveRecord_Relation]
  # @params [Array] array of geographic area ids
  def default_by_geographic_area_ids(geographic_area_ids = [])
    GeographicItem.
      joins(:geographic_areas_geographic_items).
      merge(::GeographicAreasGeographicItem.default_geographic_item_data).
      where(geographic_areas_geographic_items: {geographic_area_id: geographic_area_ids})
  end

  # @param [String] wkt
  # @return [Boolean]
  #   whether or not the wtk intersects with the anti-meridian
  #   !! StrongParams security considerations
  def crosses_anti_meridian?(wkt)
    GeographicItem.find_by_sql(
      ['SELECT ST_Intersects(ST_GeogFromText(?), ST_GeogFromText(?)) as r;', wkt, ANTI_MERIDIAN]
    ).first.r
  end

  # @param [Integer] ids
  # @return [Boolean]
  #   whether or not any GeographicItem passed intersects the anti-meridian
  #   !! StrongParams security considerations
  #   This is our first line of defense against queries that define multiple shapes, one or
  #   more of which crosses the anti-meridian.  In this case the current TW strategy within the
  #   UI is to abandon the search, and prompt the user to refactor the query.
  def crosses_anti_meridian_by_id?(*ids)
    q1 = ["SELECT ST_Intersects((SELECT single_geometry FROM (#{GeographicItem.single_geometry_sql(*ids)}) as " \
          'left_intersect), ST_GeogFromText(?)) as r;', ANTI_MERIDIAN]
    _q2 = ActiveRecord::Base.send(:sanitize_sql_array, ['SELECT ST_Intersects((SELECT single_geometry FROM (?) as ' \
                                                        'left_intersect), ST_GeogFromText(?)) as r;', GeographicItem.single_geometry_sql(*ids), ANTI_MERIDIAN])
    GeographicItem.find_by_sql(q1).first.r
  end

  #
  # SQL fragments
  #

  # @param [Integer, String]
  # @return [String]
  #   a SQL select statement that returns the *geometry* for the geographic_item with the specified id
  def select_geometry_sql(geographic_item_id)
    "SELECT #{GeographicItem::GEOMETRY_SQL.to_sql} from geographic_items where geographic_items.id = #{geographic_item_id}"
  end

  # @param [Integer, String]
  # @return [String]
  #   a SQL select statement that returns the geography for the geographic_item with the specified id
  def select_geography_sql(geographic_item_id)
    ActiveRecord::Base.send(:sanitize_sql_for_conditions, [
      "SELECT #{GeographicItem::GEOMETRY_SQL.to_sql} from geographic_items where geographic_items.id = ?",
      geographic_item_id])
  end

  # @param [Symbol] choice
  # @return [String]
  #   a fragment returning either latitude or longitude columns
  def lat_long_sql(choice)
    return nil unless [:latitude, :longitude].include?(choice)
    f = "'D.DDDDDD'" # TODO: probably a constant somewhere
    v = (choice == :latitude ? 1 : 2)
    "CASE geographic_items.type
  WHEN 'GeographicItem::GeometryCollection' THEN split_part(ST_AsLatLonText(ST_Centroid" \
  "(geometry_collection::geometry), #{f}), ' ', #{v})
  WHEN 'GeographicItem::LineString' THEN split_part(ST_AsLatLonText(ST_Centroid(line_string::geometry), " \
  "#{f}), ' ', #{v})
  WHEN 'GeographicItem::MultiPolygon' THEN split_part(ST_AsLatLonText(" \
  "ST_Centroid(multi_polygon::geometry), #{f}), ' ', #{v})
  WHEN 'GeographicItem::Point' THEN split_part(ST_AsLatLonText(" \
  "ST_Centroid(point::geometry), #{f}), ' ', #{v})
  WHEN 'GeographicItem::Polygon' THEN split_part(ST_AsLatLonText(" \
  "ST_Centroid(polygon::geometry), #{f}), ' ', #{v})
  WHEN 'GeographicItem::MultiLineString' THEN split_part(ST_AsLatLonText(" \
  "ST_Centroid(multi_line_string::geometry), #{f} ), ' ', #{v})
  WHEN 'GeographicItem::MultiPoint' THEN split_part(ST_AsLatLonText(" \
  "ST_Centroid(multi_point::geometry), #{f}), ' ', #{v})
END as #{choice}"
  end

  # @param [Integer] geographic_item_id
  # @param [Integer] distance
  # @return [String]
  def within_radius_of_item_sql(geographic_item_id, distance)
    "ST_DWithin((#{GeographicItem::GEOGRAPHY_SQL}), (#{select_geography_sql(geographic_item_id)}), #{distance})"
  end


  # @param [Integer] geographic_item_id
  # @param [Number] distance in meters to grow/shrink the shape (negative allowed)
  # @param [Number] distance (in meters) (positive only?!)
  # @return [String]
  def st_buffer_st_within(geographic_item_id, distance, buffer = 0)
    "ST_DWithin(
    ST_Buffer(#{GeographicItem::GEOGRAPHY_SQL}, #{buffer}),
    (#{select_geography_sql(geographic_item_id)}), #{distance}
   )"
  end


  # TODO: 3D is overkill here
  # @param [String] wkt
  # @param [Integer] distance (meters)
  # @return [String]
  # !! This is intersecting
  def intersecting_radius_of_wkt_sql(wkt, distance)
    "ST_DWithin((#{GeographicItem::GEOGRAPHY_SQL}), ST_Transform( ST_GeomFromText('#{wkt}', " \
      "4326), 4326), #{distance})"
  end

  # @param [String] wkt
  # @param [Integer] distance (meters)
  # @return [String]
  # !! This is fully covering
  def within_radius_of_wkt_sql(wkt, distance)
    "ST_Covers( ST_Buffer(ST_SetSRID( ST_GeomFromText('#{wkt}'), 4326)::geography, #{distance}), (#{GeographicItem::GEOGRAPHY_SQL}))"
  end

  # @param [String, Integer, String]
  # @return [String]
  #   a SQL fragment for ST_Contains() function, returns
  #   all geographic items which are contained in the item supplied
  def containing_sql(target_column_name = nil, geographic_item_id = nil, source_column_name = nil)
    return 'false' if geographic_item_id.nil? || source_column_name.nil? || target_column_name.nil?
    "ST_Contains(#{target_column_name}::geometry, (#{geometry_sql(geographic_item_id, source_column_name)}))"
  end

  # @param [String, Integer, String]
  # @return [String]
  #   a SQL fragment for ST_Contains(), returns
  #   all geographic_items which contain the supplied geographic_item
  def reverse_containing_sql(target_column_name = nil, geographic_item_id = nil, source_column_name = nil)
    return 'false' if geographic_item_id.nil? || source_column_name.nil? || target_column_name.nil?
    "ST_Contains((#{geometry_sql(geographic_item_id, source_column_name)}), #{target_column_name}::geometry)"
  end

  # @param [Integer, String]
  # @return [String]
  #   a SQL fragment that represents the geometry of the geographic item specified (which has data in the
  # source_column_name, i.e. geo_object_type)
  def geometry_sql(geographic_item_id = nil, source_column_name = nil)
    return 'false' if geographic_item_id.nil? || source_column_name.nil?
    "select geom_alias_tbl.#{source_column_name}::geometry from geographic_items geom_alias_tbl " \
      "where geom_alias_tbl.id = #{geographic_item_id}"
  end

  # rubocop:disable Metrics/MethodLength
  # @param [String] column_name
  # @param [GeographicItem] geographic_item
  # @return [String] of SQL
  def is_contained_by_sql(column_name, geographic_item)
    geo_id = geographic_item.id
    geo_type = geographic_item.geo_object_type
    template = '(ST_Contains((select geographic_items.%s::geometry from geographic_items where ' \
      'geographic_items.id = %d), %s::geometry))'
    retval = []
    column_name.downcase!
    case column_name
    when 'any'
      DATA_TYPES.each { |column|
        unless column == :geometry_collection
          retval.push(template % [geo_type, geo_id, column])
        end
      }
    when 'any_poly', 'any_line'
      DATA_TYPES.each { |column|
        unless column == :geometry_collection
          if column.to_s.index(column_name.gsub('any_', ''))
            retval.push(template % [geo_type, geo_id, column])
          end
        end
      }
    else
      retval = template % [geo_type, geo_id, column_name]
    end
    retval = retval.join(' OR ') if retval.instance_of?(Array)
    retval
  end

  # @param [Interger, Array of Integer] geographic_item_ids
  # @return [String]
  #   a select query that returns a single geometry (column name 'single_geometry' for the collection of ids
  # provided via ST_Collect)
  def st_collect_sql(*geographic_item_ids)
    geographic_item_ids.flatten!
    ActiveRecord::Base.send(:sanitize_sql_for_conditions, [
      "SELECT ST_Collect(f.the_geom) AS single_geometry
 FROM (
    SELECT (ST_DUMP(#{GeographicItem::GEOMETRY_SQL.to_sql})).geom as the_geom
    FROM geographic_items
    WHERE id in (?))
  AS f", geographic_item_ids])
  end

  # @param [Interger, Array of Integer] geographic_item_ids
  # @return [String]
  #    returns one or more geographic items combined as a single geometry in column 'single'
  def single_geometry_sql(*geographic_item_ids)
    a = GeographicItem.st_collect_sql(geographic_item_ids)
    '(SELECT single.single_geometry FROM (' + a + ' ) AS single)'
  end

  # @param [Interger, Array of Integer] geographic_item_ids
  # @return [String]
  #   returns a single geometry "column" (paren wrapped) as "single" for multiple geographic item ids, or the
  # geometry as 'geometry' for a single id
  def geometry_sql2(*geographic_item_ids)
    geographic_item_ids.flatten! # *ALWAYS* reduce the pile to a single level of ids
    if geographic_item_ids.count == 1
      "(#{GeographicItem.geometry_for_sql(geographic_item_ids.first)})"
    else
      GeographicItem.single_geometry_sql(geographic_item_ids)
    end
  end

  # @param [Interger, Array of Integer] geographic_item_ids
  # @return [String]
  def containing_where_sql(*geographic_item_ids)
    "ST_CoveredBy(
      #{GeographicItem.geometry_sql2(*geographic_item_ids)},
       CASE geographic_items.type
         WHEN 'GeographicItem::MultiPolygon' THEN multi_polygon::geometry
         WHEN 'GeographicItem::Point' THEN point::geometry
         WHEN 'GeographicItem::LineString' THEN line_string::geometry
         WHEN 'GeographicItem::Polygon' THEN polygon::geometry
         WHEN 'GeographicItem::MultiLineString' THEN multi_line_string::geometry
         WHEN 'GeographicItem::MultiPoint' THEN multi_point::geometry
      END)"
  end

  # @param [Interger, Array of Integer] geographic_item_ids
  # @return [String]
  def containing_where_sql_geog(*geographic_item_ids)
    "ST_CoveredBy(
      #{GeographicItem.geometry_sql2(*geographic_item_ids)},
       CASE geographic_items.type
         WHEN 'GeographicItem::MultiPolygon' THEN multi_polygon::geography
         WHEN 'GeographicItem::Point' THEN point::geography
         WHEN 'GeographicItem::LineString' THEN line_string::geography
         WHEN 'GeographicItem::Polygon' THEN polygon::geography
         WHEN 'GeographicItem::MultiLineString' THEN multi_line_string::geography
         WHEN 'GeographicItem::MultiPoint' THEN multi_point::geography
      END)"
  end

  # @param [Interger, Array of Integer] ids
  # @return [Array]
  #   If we detect that some query id has crossed the meridian, then loop through
  #   and "manually" build up a list of results.
  #   Should only be used if GeographicItem.crosses_anti_meridian_by_id? is true.
  #   Note that this does not return a Scope, so you can't chain it like contained_by?
  # TODO: test this
  def contained_by_with_antimeridian_check(*ids)
    ids.flatten! # make sure there is only one level of splat (*)
    results = []

    crossing_ids = []

    ids.each do |id|
      # push each which crosses
      crossing_ids.push(id) if GeographicItem.crosses_anti_meridian_by_id?(id)
    end

    non_crossing_ids = ids - crossing_ids
    results.push GeographicItem.contained_by(non_crossing_ids).to_a if non_crossing_ids.any?

    crossing_ids.each do |id|
      # [61666, 61661, 61659, 61654, 61639]
      q1 = ActiveRecord::Base.send(:sanitize_sql_array, ['SELECT ST_AsText((SELECT polygon FROM geographic_items ' \
                                                         'WHERE id = ?))', id])
      r = GeographicItem.where(
        # GeographicItem.contained_by_wkt_shifted_sql(GeographicItem.find(id).geo_object.to_s)
        GeographicItem.contained_by_wkt_shifted_sql(
          ApplicationRecord.connection.execute(q1).first['st_astext'])
      ).to_a
      results.push(r)
    end

    results.flatten.uniq
  end

  # @params [String] well known text
  # @return [String] the SQL fragment for the specific geometry type, shifted by longitude
  # Note: this routine is called when it is already known that the A argument crosses anti-meridian
  def contained_by_wkt_shifted_sql(wkt)
    "ST_Contains(ST_ShiftLongitude(ST_GeomFromText('#{wkt}', 4326)), (
    CASE geographic_items.type
       WHEN 'GeographicItem::MultiPolygon' THEN ST_ShiftLongitude(multi_polygon::geometry)
       WHEN 'GeographicItem::Point' THEN ST_ShiftLongitude(point::geometry)
       WHEN 'GeographicItem::LineString' THEN ST_ShiftLongitude(line_string::geometry)
       WHEN 'GeographicItem::Polygon' THEN ST_ShiftLongitude(polygon::geometry)
       WHEN 'GeographicItem::MultiLineString' THEN ST_ShiftLongitude(multi_line_string::geometry)
       WHEN 'GeographicItem::MultiPoint' THEN ST_ShiftLongitude(multi_point::geometry)
    END
    )
  )"
  end

  # TODO: Remove the hard coded 4326 reference
  # @params [String] wkt
  # @return [String] SQL fragment limiting geographics items to those in this WKT
  def contained_by_wkt_sql(wkt)
    if crosses_anti_meridian?(wkt)
      retval = contained_by_wkt_shifted_sql(wkt)
    else
      retval = "ST_Contains(ST_GeomFromText('#{wkt}', 4326), (
    CASE geographic_items.type
       WHEN 'GeographicItem::MultiPolygon' THEN multi_polygon::geometry
       WHEN 'GeographicItem::Point' THEN point::geometry
       WHEN 'GeographicItem::LineString' THEN line_string::geometry
       WHEN 'GeographicItem::Polygon' THEN polygon::geometry
       WHEN 'GeographicItem::MultiLineString' THEN multi_line_string::geometry
       WHEN 'GeographicItem::MultiPoint' THEN multi_point::geometry
    END
    )
  )"
    end
    retval
  end

  # @param [Interger, Array of Integer] geographic_item_ids
  # @return [String] sql for contained_by via ST_ContainsProperly
  # Note: Can not use GEOMETRY_SQL because geometry_collection is not supported in ST_ContainsProperly
  # Note: !! If the target GeographicItem#id crosses the anti-meridian then you may/will get unexpected results.
  def contained_by_where_sql(*geographic_item_ids)
    "ST_Contains(
    #{GeographicItem.geometry_sql2(*geographic_item_ids)},
    CASE geographic_items.type
      WHEN 'GeographicItem::MultiPolygon' THEN multi_polygon::geometry
      WHEN 'GeographicItem::Point' THEN point::geometry
      WHEN 'GeographicItem::LineString' THEN line_string::geometry
      WHEN 'GeographicItem::Polygon' THEN polygon::geometry
      WHEN 'GeographicItem::MultiLineString' THEN multi_line_string::geometry
      WHEN 'GeographicItem::MultiPoint' THEN multi_point::geometry
    END)"
  end

  # @param [RGeo:Point] rgeo_point
  # @return [String] sql for containing via ST_CoveredBy
  # TODO: Remove the hard coded 4326 reference
  # TODO: should this be wkt_point instead of rgeo_point?
  def containing_where_for_point_sql(rgeo_point)
    "ST_CoveredBy(
  ST_GeomFromText('#{rgeo_point}', 4326),
  #{GeographicItem::GEOMETRY_SQL.to_sql}
 )"
  end

  # @param [Interger] geographic_item_id
  # @return [String] SQL for geometries
  # example, not used
  def geometry_for_sql(geographic_item_id)
    'SELECT ' + GeographicItem::GEOMETRY_SQL.to_sql + ' AS geometry FROM geographic_items WHERE id = ' \
      "#{geographic_item_id} LIMIT 1"
  end

  # @param [Interger, Array of Integer] geographic_item_ids
  # @return [String] SQL for geometries
  # example, not used
  def geometry_for_collection_sql(*geographic_item_ids)
    'SELECT ' + GeographicItem::GEOMETRY_SQL.to_sql + ' AS geometry FROM geographic_items WHERE id IN ' \
      "( #{geographic_item_ids.join(',')} )"
  end

  #
  # Scopes
  #

  # @param [Interger, Array of Integer] geographic_item_ids
  # @return [Scope]
  #    the geographic items containing these collective geographic_item ids, not including self
  def containing(*geographic_item_ids)
    where(GeographicItem.containing_where_sql(geographic_item_ids)).not_ids(*geographic_item_ids)
  end

  # @param [Interger, Array of Integer] geographic_item_ids
  # @return [Scope]
  #    the geographic items contained by any of these geographic_item ids, not including self
  # (works via ST_ContainsProperly)
  def contained_by(*geographic_item_ids)
    where(GeographicItem.contained_by_where_sql(geographic_item_ids))
  end

  # @param [RGeo::Point] rgeo_point
  # @return [Scope]
  #    the geographic items containing this point
  # TODO: should be containing_wkt ?
  def containing_point(rgeo_point)
    where(GeographicItem.containing_where_for_point_sql(rgeo_point))
  end

  # @return [Scope]
  #   adds an area_in_meters field, with meters
  def with_area
    select("ST_Area(#{GeographicItem::GEOGRAPHY_SQL}, false) as area_in_meters")
  end

  # return [Scope]
  #   A scope that limits the result to those GeographicItems that have a collecting event
  #   through either the geographic_item or the error_geographic_item
  #
  # A raw SQL join approach for comparison
  #
  # GeographicItem.joins('LEFT JOIN georeferences g1 ON geographic_items.id = g1.geographic_item_id').
  #   joins('LEFT JOIN georeferences g2 ON geographic_items.id = g2.error_geographic_item_id').
  #   where("(g1.geographic_item_id IS NOT NULL OR g2.error_geographic_item_id IS NOT NULL)").uniq

  # @return [Scope] GeographicItem
  # This uses an Arel table approach, this is ultimately more decomposable if we need. Of use:
  #  http://danshultz.github.io/talks/mastering_activerecord_arel  <- best
  #  https://github.com/rails/arel
  #  http://stackoverflow.com/questions/4500629/use-arel-for-a-nested-set-join-query-and-convert-to-activerecordrelation
  #  http://rdoc.info/github/rails/arel/Arel/SelectManager
  #  http://stackoverflow.com/questions/7976358/activerecord-arel-or-condition
  #
  def with_collecting_event_through_georeferences
    geographic_items = GeographicItem.arel_table
    georeferences = Georeference.arel_table
    g1 = georeferences.alias('a')
    g2 = georeferences.alias('b')

    c = geographic_items.join(g1, Arel::Nodes::OuterJoin).on(geographic_items[:id].eq(g1[:geographic_item_id]))
      .join(g2, Arel::Nodes::OuterJoin).on(geographic_items[:id].eq(g2[:error_geographic_item_id]))

    GeographicItem.joins(# turn the Arel back into scope
                         c.join_sources # translate the Arel join to a join hash(?)
                        ).where(
                          g1[:id].not_eq(nil).or(g2[:id].not_eq(nil)) # returns a Arel::Nodes::Grouping
                        ).distinct
  end

  # @return [Scope] include a 'latitude' column
  def with_latitude
    select(lat_long_sql(:latitude))
  end

  # @return [Scope] include a 'longitude' column
  def with_longitude
    select(lat_long_sql(:longitude))
  end

  # @param [String, GeographicItems]
  # @return [Scope]
  def intersecting(column_name, *geographic_items)
    if column_name.downcase == 'any'
      pieces = []
      DATA_TYPES.each { |column|
        pieces.push(GeographicItem.intersecting(column.to_s, geographic_items).to_a)
      }

      # @TODO change 'id in (?)' to some other sql construct

      GeographicItem.where(id: pieces.flatten.map(&:id))
    else
      q = geographic_items.flatten.collect { |geographic_item|
        "ST_Intersects(#{column_name}, '#{geographic_item.geo_object}'    )" # seems like we want this: http://danshultz.github.io/talks/mastering_activerecord_arel/#/15/2
      }.join(' or ')

      where(q)
    end
  end

  # @param [GeographicItem#id] geographic_item_id
  # @param [Float] distance in meters ?!?!
  # @return [ActiveRecord::Relation]
  # !! should be distance, not radius?!
  def within_radius_of_item(geographic_item_id, distance)
    where(within_radius_of_item_sql(geographic_item_id, distance))
  end

  # @param [String, GeographicItem]
  # @return [Scope]
  #   a SQL fragment for ST_DISJOINT, specifies all geographic_items that have data in column_name
  #   that are disjoint from the passed geographic_items
  def disjoint_from(column_name, *geographic_items)
    q = geographic_items.flatten.collect { |geographic_item|
      "ST_DISJOINT(#{column_name}::geometry, (#{geometry_sql(geographic_item.to_param,
                                                         geographic_item.geo_object_type)}))"
    }.join(' and ')

    where(q)
  end

  # @return [Scope]
  #   see are_contained_in_item_by_id
  # @param [String] column_name
  # @param [GeographicItem, Array] geographic_items
  def are_contained_in_item(column_name, *geographic_items)
    are_contained_in_item_by_id(column_name, geographic_items.flatten.map(&:id))
  end

  # rubocop:disable Metrics/MethodLength
  # @param [String] column_name to search
  # @param [GeographicItem] geographic_item_ids or array of geographic_item_ids to be tested.
  # @return [Scope] of GeographicItems
  #
  # If this scope is given an Array of GeographicItems as a second parameter,
  # it will return the 'OR' of each of the objects against the table.
  # SELECT COUNT(*) FROM "geographic_items"
  #        WHERE (ST_Contains(polygon::geometry, GeomFromEWKT('srid=4326;POINT (0.0 0.0 0.0)'))
  #               OR ST_Contains(polygon::geometry, GeomFromEWKT('srid=4326;POINT (-9.8 5.0 0.0)')))
  #
  def are_contained_in_item_by_id(column_name, *geographic_item_ids) # = containing
    geographic_item_ids.flatten! # in case there is a array of arrays, or multiple objects
    column_name.downcase!
    case column_name
    when 'any'
      part = []
      DATA_TYPES.each { |column|
        unless column == :geometry_collection
          part.push(GeographicItem.are_contained_in_item_by_id(column.to_s, geographic_item_ids).to_a)
        end
      }
      # TODO: change 'id in (?)' to some other sql construct
      GeographicItem.where(id: part.flatten.map(&:id))
    when 'any_poly', 'any_line'
      part = []
      DATA_TYPES.each { |column|
        if column.to_s.index(column_name.gsub('any_', ''))
          part.push(GeographicItem.are_contained_in_item_by_id("#{column}", geographic_item_ids).to_a)
        end
      }
      # TODO: change 'id in (?)' to some other sql construct
      GeographicItem.where(id: part.flatten.map(&:id))
    else
      q = geographic_item_ids.flatten.collect { |geographic_item_id|
        # discover the item types, and convert type to database type for 'multi_'
        b = GeographicItem.where(id: geographic_item_id)
          .pluck(:type)[0].split(':')[2].downcase.gsub('lti', 'lti_')
        # a = GeographicItem.find(geographic_item_id).geo_object_type
        GeographicItem.containing_sql(column_name, geographic_item_id, b)
      }.join(' or ')
      q = 'FALSE' if q.blank? # this will prevent the invocation of *ALL* of the GeographicItems, if there are
      # no GeographicItems in the request (see CollectingEvent.name_hash(types)).
      where(q) # .not_including(geographic_items)
    end
  end

  # rubocop:enable Metrics/MethodLength

  # @param [String] column_name
  # @param [String] geometry of WKT
  # @return [Scope]
  # a single WKT geometry is compared against column or columns (except geometry_collection) to find geographic_items
  # which are contained in the WKT
  def are_contained_in_wkt(column_name, geometry)
    column_name.downcase!
    # column_name = 'point'
    case column_name
    when 'any'
      part = []
      DATA_TYPES.each { |column|
        unless column == :geometry_collection
          part.push(GeographicItem.are_contained_in_wkt(column.to_s, geometry).pluck(:id).to_a)
        end
      }
      # TODO: change 'id in (?)' to some other sql construct
      GeographicItem.where(id: part.flatten)
    when 'any_poly', 'any_line'
      part = []
      DATA_TYPES.each { |column|
        if column.to_s.index(column_name.gsub('any_', ''))
          part.push(GeographicItem.are_contained_in_wkt("#{column}", geometry).pluck(:id).to_a)
        end
      }
      # TODO: change 'id in (?)' to some other sql construct
      GeographicItem.where(id: part.flatten)
    else
      # column = points, geometry = square
      q = "ST_Contains(ST_GeomFromEWKT('srid=4326;#{geometry}'), #{column_name}::geometry)"
      where(q) # .not_including(geographic_items)
    end
  end

  # rubocop:disable Metrics/MethodLength
  #    containing the items the shape of which is contained in the geographic_item[s] supplied.
  # @param column_name [String] can be any of DATA_TYPES, or 'any' to check against all types, 'any_poly' to check
  # against 'polygon' or 'multi_polygon', or 'any_line' to check against 'line_string' or 'multi_line_string'.
  #  CANNOT be 'geometry_collection'.
  # @param geographic_items [GeographicItem] Can be a single GeographicItem, or an array of GeographicItem.
  # @return [Scope]
  def is_contained_by(column_name, *geographic_items)
    column_name.downcase!
    case column_name
    when 'any'
      part = []
      DATA_TYPES.each { |column|
        unless column == :geometry_collection
          part.push(GeographicItem.is_contained_by(column.to_s, geographic_items).to_a)
        end
      }
      # @TODO change 'id in (?)' to some other sql construct
      GeographicItem.where(id: part.flatten.map(&:id))

    when 'any_poly', 'any_line'
      part = []
      DATA_TYPES.each { |column|
        unless column == :geometry_collection
          if column.to_s.index(column_name.gsub('any_', ''))
            part.push(GeographicItem.is_contained_by(column.to_s, geographic_items).to_a)
          end
        end
      }
      # @TODO change 'id in (?)' to some other sql construct
      GeographicItem.where(id: part.flatten.map(&:id))

    else
      q = geographic_items.flatten.collect { |geographic_item|
        GeographicItem.reverse_containing_sql(column_name, geographic_item.to_param,
                                              geographic_item.geo_object_type)
      }.join(' or ')
      where(q) # .not_including(geographic_items)
    end
  end

  # rubocop:enable Metrics/MethodLength

  # @param [String, GeographicItem]
  # @return [Scope]
  def ordered_by_shortest_distance_from(column_name, geographic_item)
    if true # check_geo_params(column_name, geographic_item)
      select_distance_with_geo_object(column_name, geographic_item)
        .where_distance_greater_than_zero(column_name, geographic_item).order('distance')
    else
      where('false')
    end
  end

  # @param [String, GeographicItem]
  # @return [Scope]
  def ordered_by_longest_distance_from(column_name, geographic_item)
    if true # check_geo_params(column_name, geographic_item)
      q = select_distance_with_geo_object(column_name, geographic_item)
        .where_distance_greater_than_zero(column_name, geographic_item)
        .order('distance desc')
      q
    else
      where('false')
    end
  end

  # @param [String] column_name
  # @param [GeographicItem] geographic_item
  # @return [String]
  def select_distance_with_geo_object(column_name, geographic_item)
    select("*, ST_Distance(#{column_name}, GeomFromEWKT('srid=4326;#{geographic_item.geo_object}')) as distance")
  end

  # @param [String, GeographicItem]
  # @return [Scope]
  def where_distance_greater_than_zero(column_name, geographic_item)
    where("#{column_name} is not null and ST_Distance(#{column_name}, " \
          "GeomFromEWKT('srid=4326;#{geographic_item.geo_object}')) > 0")
  end

  # @param [GeographicItem]
  # @return [Scope]
  def not_including(geographic_items)
    where.not(id: geographic_items)
  end

  # @return [Scope]
  #   includes an 'is_valid' attribute (True/False) for the passed geographic_item.  Uses St_IsValid.
  # @param [RGeo object] geographic_item
  def with_is_valid_geometry_column(geographic_item)
    where(id: geographic_item.id).select("ST_IsValid(ST_AsBinary(#{geographic_item.geo_object_type})) is_valid")
  end

  #
  # Other
  #

  # @param [Integer] geographic_item_id1
  # @param [Integer] geographic_item_id2
  # @return [Float]
  def distance_between(geographic_item_id1, geographic_item_id2)
    q1 = "ST_Distance(#{GeographicItem::GEOGRAPHY_SQL}, " \
      "(#{select_geography_sql(geographic_item_id2)})) as distance"
    _q2 = ActiveRecord::Base.send(
      :sanitize_sql_array, ['ST_Distance(?, (?)) as distance',
                            GeographicItem::GEOGRAPHY_SQL,
                            select_geography_sql(geographic_item_id2)])
    GeographicItem.where(id: geographic_item_id1).pluck(Arel.sql(q1)).first
  end

  # @param [RGeo::Point] point
  # @return [Hash]
  #   as per #inferred_geographic_name_hierarchy but for Rgeo point
  def point_inferred_geographic_name_hierarchy(point)
    GeographicItem.containing_point(point).order(cached_total_area: :ASC).limit(1).first&.inferred_geographic_name_hierarchy
  end

  # @param [String] type_name ('polygon', 'point', 'line' [, 'circle'])
  # @return [String] if type
  def eval_for_type(type_name)
    retval = 'GeographicItem'
    case type_name.upcase
    when 'POLYGON'
      retval += '::Polygon'
    when 'LINESTRING'
      retval += '::LineString'
    when 'POINT'
      retval += '::Point'
    when 'MULTIPOLYGON'
      retval += '::MultiPolygon'
    when 'MULTILINESTRING'
      retval += '::MultiLineString'
    when 'MULTIPOINT'
      retval += '::MultiPoint'
    else
      retval = nil
    end
    retval
  end

  # example, not used
  # @param [Integer] geographic_item_id
  # @return [RGeo::Geographic object]
  def geometry_for(geographic_item_id)
    GeographicItem.select(GeographicItem::GEOMETRY_SQL.to_sql + ' AS geometry').find(geographic_item_id)['geometry']
  end

  # example, not used
  # @param [Integer, Array] geographic_item_ids
  # @return [Scope]
  def st_multi(*geographic_item_ids)
    GeographicItem.find_by_sql(
      "SELECT ST_Multi(ST_Collect(g.the_geom)) AS singlegeom
 FROM (
    SELECT (ST_DUMP(#{GeographicItem::GEOMETRY_SQL.to_sql})).geom AS the_geom
    FROM geographic_items
    WHERE id IN (?))
  AS g;", geographic_item_ids.flatten
    )
  end
end # class << self

# @return [Hash]
#    a geographic_name_classification or empty Hash
# This is a quick approach that works only when
# the geographic_item is linked explicitly to a GeographicArea.
#
# !! Note that it is not impossible for a GeographicItem to be linked
# to > 1 GeographicArea, in that case we are assuming that all are
# equally refined, this might not be the case in the future because
# of how the GeographicArea gazetteer is indexed.
def quick_geographic_name_hierarchy
  geographic_areas.order(:id).each do |ga|
    h = ga.geographic_name_classification # not quick enough !!
    return h if h.present?
  end
  return  {}
end

# @return [Hash]
#   a geographic_name_classification (see GeographicArea) inferred by
# finding the smallest area containing this GeographicItem, in the most accurate gazetteer
# and using it to return country/state/county. See also the logic in
# filling in missing levels in GeographicArea.
def inferred_geographic_name_hierarchy
  if small_area = containing_geographic_areas
    .joins(:geographic_areas_geographic_items)
    .merge(GeographicAreasGeographicItem.ordered_by_data_origin)
    .ordered_by_area
    .limit(1)
    .first
  return small_area.geographic_name_classification
  else
    {}
  end
end

def geographic_name_hierarchy
  a = quick_geographic_name_hierarchy # quick; almost never the case, UI not setup to do this
  return a if a.present?
  inferred_geographic_name_hierarchy # slow
end

# @return [Scope]
#   the Geographic Areas that contain (gis) this geographic item
def containing_geographic_areas
  GeographicArea.joins(:geographic_items).includes(:geographic_area_type)
    .joins("JOIN (#{GeographicItem.containing(id).to_sql}) j on geographic_items.id = j.id")
end

# @return [Boolean]
#   whether stored shape is ST_IsValid
def valid_geometry?
  GeographicItem.with_is_valid_geometry_column(self).first['is_valid']
end

# @return [Array of latitude, longitude]
#    the lat, lon of the first point in the GeoItem, see subclass for #st_start_point
def start_point
  o = st_start_point
  [o.y, o.x]
end

# @return [Array]
#   the lat, long, as STRINGs for the centroid of this geographic item
#   Meh- this: https://postgis.net/docs/en/ST_MinimumBoundingRadius.html
def center_coords
  r = GeographicItem.find_by_sql(
    "Select split_part(ST_AsLatLonText(ST_Centroid(#{GeographicItem::GEOMETRY_SQL.to_sql}), " \
    "'D.DDDDDD'), ' ', 1) latitude, split_part(ST_AsLatLonText(ST_Centroid" \
    "(#{GeographicItem::GEOMETRY_SQL.to_sql}), 'D.DDDDDD'), ' ', 2) " \
    "longitude from geographic_items where id = #{id};")[0]

  [r.latitude, r.longitude]
end

# @return [RGeo::Geographic::ProjectedPointImpl]
#    representing the centroid of this geographic item
def centroid
  # Gis::FACTORY.point(*center_coords.reverse)
  return geo_object if type == 'GeographicItem::Point'
  return Gis::FACTORY.parse_wkt(self.st_centroid)
end

# @param [Integer] geographic_item_id
# @return [Double] distance in meters (slower, more accurate)
def st_distance(geographic_item_id) # geo_object
  q1 = "ST_Distance((#{GeographicItem.select_geography_sql(id)}), " \
    "(#{GeographicItem.select_geography_sql(geographic_item_id)})) as d"
  _q2 = ActiveRecord::Base.send(:sanitize_sql_array, ['ST_Distance((?),(?)) as d',
                                                      GeographicItem.select_geography_sql(self.id),
                                                      GeographicItem.select_geography_sql(geographic_item_id)])
  deg = GeographicItem.where(id:).pluck(Arel.sql(q1)).first
  deg * Utilities::Geo::ONE_WEST
end

# @param [GeographicItem] geographic_item
# @return [Double] distance in meters
# Like st_distance but works with changed and non persisted objects
def st_distance_to_geographic_item(geographic_item)
  unless !persisted? || changed?
    a = "(#{GeographicItem.select_geography_sql(id)})"
  else
    a = "ST_GeographyFromText('#{geo_object}')"
  end

  unless !geographic_item.persisted? || geographic_item.changed?
    b = "(#{GeographicItem.select_geography_sql(geographic_item.id)})"
  else
    b = "ST_GeographyFromText('#{geographic_item.geo_object}')"
  end

  ActiveRecord::Base.connection.select_value("SELECT ST_Distance(#{a}, #{b})")
end

alias_method :distance_to, :st_distance

# @param [Integer] geographic_item_id
# @return [Double] distance in meters (faster, less accurate)
def st_distance_spheroid(geographic_item_id)
  q1 = "ST_DistanceSpheroid((#{GeographicItem.select_geometry_sql(id)})," \
    "(#{GeographicItem.select_geometry_sql(geographic_item_id)}),'#{Gis::SPHEROID}') as distance"
  _q2 = ActiveRecord::Base.send(:sanitize_sql_array,
                                ['ST_DistanceSpheroid((?),(?),?) as distance',
                                 GeographicItem.select_geometry_sql(id),
                                 GeographicItem.select_geometry_sql(geographic_item_id),
                                 Gis::SPHEROID])
  # TODO: what is _q2?
  GeographicItem.where(id:).pluck(Arel.sql(q1)).first
end

# @return [String]
#   a WKT POINT representing the centroid of the geographic item
def st_centroid
  GeographicItem.where(id: to_param).pluck(Arel.sql("ST_AsEWKT(ST_Centroid(#{GeographicItem::GEOMETRY_SQL.to_sql}))")).first.gsub(/SRID=\d*;/, '')
end

# @return [Integer]
#   the number of points in the geometry
def st_npoints
  GeographicItem.where(id:).pluck(Arel.sql("ST_NPoints(#{GeographicItem::GEOMETRY_SQL.to_sql}) as npoints")).first
end

# @return [Symbol]
#   the geo type (i.e. column like :point, :multipolygon).  References the first-found object,
# according to the list of DATA_TYPES, or nil
def geo_object_type
  if self.class.name == 'GeographicItem' # a proxy check for new records
    geo_type
  else
    self.class::SHAPE_COLUMN
  end
end

# !!TODO: migrate these to use native column calls

# @return [RGeo instance, nil]
#  the Rgeo shape (See http://rubydoc.info/github/dazuma/rgeo/RGeo/Feature)
def geo_object
  begin
    if r = geo_object_type # rubocop:disable Lint/AssignmentInCondition
      send(r)
    else
      false
    end
  rescue RGeo::Error::InvalidGeometry
    return nil # TODO: we need to render proper error for this!
  end
end

# @param [geo_object]
# @return [Boolean]
def contains?(target_geo_object)
  return nil if target_geo_object.nil?
  self.geo_object.contains?(target_geo_object)
end

# @param [geo_object]
# @return [Boolean]
def within?(target_geo_object)
  self.geo_object.within?(target_geo_object)
end

# @param [geo_object]
# @return [Boolean]
def intersects?(target_geo_object)
  self.geo_object.intersects?(target_geo_object)
end

# @param [geo_object, Double]
# @return [Boolean]
def near(target_geo_object, distance)
  self.geo_object.unsafe_buffer(distance).contains?(target_geo_object)
end

# @param [geo_object, Double]
# @return [Boolean]
def far(target_geo_object, distance)
  !near(target_geo_object, distance)
end

# @return [GeoJSON hash]
#    via Rgeo apparently necessary for GeometryCollection
def rgeo_to_geo_json
  RGeo::GeoJSON.encode(geo_object).to_json
end

# @return [Hash]
#   in GeoJSON format
#   Computed via "raw" PostGIS (much faster). This
#   requires the geo_object_type and id.
#
def to_geo_json
  JSON.parse(
    GeographicItem.connection.select_one(
      "SELECT ST_AsGeoJSON(#{geo_object_type}::geometry) a " \
      "FROM geographic_items WHERE id=#{id};")['a'])
end

# We don't need to serialize to/from JSON
def to_geo_json_string
  GeographicItem.connection.select_one(
    "SELECT ST_AsGeoJSON(#{geo_object_type}::geometry) a " \
    "FROM geographic_items WHERE id=#{id};")['a']
end

# @return [Hash]
#   the shape as a GeoJSON Feature with some item metadata
def to_geo_json_feature
  @geometry ||= to_geo_json
  {'type' => 'Feature',
   'geometry' => geometry,
   'properties' => {
     'geographic_item' => {
       'id' => id}
   }
  }
end

# @param value [String] like:
#   '{"type":"Feature","geometry":{"type":"Point","coordinates":[2.5,4.0]},"properties":{"color":"red"}}'
#
#   '{"type":"Feature","geometry":{"type":"Polygon","coordinates":"[[[-125.29394388198853, 48.584480409793],
#      [-67.11035013198853, 45.09937589848195],[-80.64550638198853, 25.01924647619111],[-117.55956888198853,
#      32.5591595028449],[-125.29394388198853, 48.584480409793]]]"},"properties":{}}'
#
#  '{"type":"Point","coordinates":[2.5,4.0]},"properties":{"color":"red"}}'
#
# @return [Boolean, RGeo object]
def shape=(value)

  if value.present?
    geom = RGeo::GeoJSON.decode(value, json_parser: :json, geo_factory: Gis::FACTORY)
    this_type = nil

    if geom.respond_to?(:geometry_type)
      this_type = geom.geometry_type.to_s
    elsif geom.respond_to?(:geometry)
      this_type = geom.geometry.geometry_type.to_s
    else
    end

    self.type = GeographicItem.eval_for_type(this_type) unless geom.nil?

    if type.blank?
      errors.add(:base, 'type is not set from shape')
      return
    end
    # raise('GeographicItem.type not set.') if type.blank?

    object = nil

    s = geom.respond_to?(:geometry) ? geom.geometry.to_s : geom.to_s

    begin
      object = Gis::FACTORY.parse_wkt(s)
    rescue RGeo::Error::InvalidGeometry
      errors.add(:self, 'Shape value is an Invalid Geometry')
    end

    write_attribute(this_type.underscore.to_sym, object)
    geom
  end
end

# @return [String]
def to_wkt
  #  10k  #<Benchmark::Tms:0x00007fb0dfd30fd0 @label="", @real=25.237487000005785, @cstime=0.0, @cutime=0.0, @stime=1.1704609999999995, @utime=5.507929999999988, @total=6.678390999999987>
  #  GeographicItem.select("ST_AsText( #{GeographicItem::GEOMETRY_SQL.to_sql}) wkt").where(id: id).first.wkt

  # 10k <Benchmark::Tms:0x00007fb0e02f7540 @label="", @real=21.619827999995323, @cstime=0.0, @cutime=0.0, @stime=0.8850890000000007, @utime=3.2958549999999605, @total=4.180943999999961>
  if a =  ApplicationRecord.connection.execute( "SELECT ST_AsText( #{GeographicItem::GEOMETRY_SQL.to_sql} ) wkt from geographic_items where geographic_items.id = #{id}").first
    return a['wkt']
  else
    return nil
  end
end

# @return  [Float] in meters, calculated
# TODO: share with world
#    Geographic item 96862 (Cajamar in Brazil) is the only(?) record to fail using `false` (quicker) method of everything we tested
def area
  a = GeographicItem.where(id:).select("ST_Area(#{GeographicItem::GEOGRAPHY_SQL}, true) as area_in_meters").first['area_in_meters']
  a = nil if a.nan?
  a
end

# @return [Float, false]
#    the value in square meters of the interesecting area of this and another GeographicItem
def intersecting_area(geographic_item_id)
  a = GeographicItem.aliased_geographic_sql('a')
  b = GeographicItem.aliased_geographic_sql('b')

  c = GeographicItem.connection.execute(
    "SELECT ST_Area(ST_Intersection(#{a}, #{b})) as intersecting_area
      FROM geographic_items a, geographic_items b
      WHERE a.id = #{id} AND b.id = #{geographic_item_id};"
  ).first
  c && c['intersecting_area'].to_f
end

# TODO: This is bad, while internal use of ONE_WEST_MEAN is consistent it is in-accurate given the vast differences of radius vs. lat/long position.
# When we strike the error-polygon from radius we should remove this
#
# Use case is returning the radius from a circle we calculated via buffer for error-polygon creation.
def radius
  r = ApplicationRecord.connection.execute( "SELECT ST_MinimumBoundingRadius( ST_Transform(  #{GeographicItem::GEOMETRY_SQL.to_sql}, 4326 )  ) AS radius from geographic_items where geographic_items.id = #{id}").first['radius'].split(',').last.chop.to_f
  r = (r * Utilities::Geo::ONE_WEST_MEAN).to_i
end


# Convention is to store in PostGIS in CCW
# @return Array [Boolean]
#   false - cw
#   true - ccw (preferred), except cee donuts
def orientations
  if multi_polygon.present?
    ApplicationRecord.connection.execute(" \
         SELECT ST_IsPolygonCCW(a.geom) as is_ccw
            FROM ( SELECT b.id, (ST_Dump(p_geom)).geom AS geom
               FROM (SELECT id, multi_polygon::geometry AS p_geom FROM geographic_items where id = #{id}) AS b \
          ) AS a;").collect{|a| a['is_ccw']}
  elsif polygon.present?
    ApplicationRecord.connection.execute("SELECT ST_IsPolygonCCW(polygon::geometry) as is_ccw \
            FROM geographic_items where  id = #{id};").collect{|a| a['is_ccw']}
  else
    []
  end
end

# @return Boolean
#   looks at all orientations
#   if they follow the pattern [true, false, ... <all false>] then `true`, else `false`
# !! Does not confirm that shapes are nested !!
def is_basic_donut?
  a = orientations
  b = a.shift
  return false unless b
  a.uniq!
  a == [false]
end

def st_isvalid
  r = ApplicationRecord.connection.execute( "SELECT ST_IsValid(  #{GeographicItem::GEOMETRY_SQL.to_sql }) from  geographic_items where geographic_items.id = #{id}").first['st_isvalid']
end

def st_isvalidreason
  r = ApplicationRecord.connection.execute( "SELECT ST_IsValidReason(  #{GeographicItem::GEOMETRY_SQL.to_sql }) from  geographic_items where geographic_items.id = #{id}").first['st_isvalidreason']
end

# !! Unused. Doesn't check Geometry collection
def has_polygons?
  ['GeographicItem::MultiPolygon', 'GeographicItem::Polygon'].include?(self.type)
end

private

def align_winding
  if orientations.flatten.include?(false)
    case type
    when 'multi_polygon'
      ApplicationRecord.connection.execute(
        "UPDATE geographic_items set multi_polygon = ST_ForcePolygonCCW(multi_polygon::geometry) 
          WHERE id = #{self.id};"
       )
    when 'polygon'
     ApplicationRecord.connection.execute(
        "UPDATE geographic_items set polygon = ST_ForcePolygonCCW(polygon::geometry) 
          WHERE id = #{self.id};"
       )
    end     
  end
  true
end

# Crude debuging helper, write the shapes
# to a png
def self.debug_draw(geographic_item_ids = [])
  return false if geographic_item_ids.empty?

  sql = "SELECT ST_AsPNG(
     ST_AsRaster(
        (SELECT ST_Union(multi_polygon::geometry) from geographic_items where id IN (" + geographic_item_ids.join(',') + ")), 1920, 1080
    )
   ) png;"

  # ST_Buffer( multi_polygon::geometry, 0, 'join=bevel'),
  #     1920,
  #     1080)


  result = ActiveRecord::Base.connection.execute(sql).first['png']
  r = ActiveRecord::Base.connection.unescape_bytea(result)

  prefix = if geographic_item_ids.size > 10
             'multiple'
           else
             geographic_item_ids.join('_') + '_debug.draw.png'
           end

  n = prefix + '_debug.draw.png'

  # Open the file in binary write mode ("wb")
  File.open(n, 'wb') do |file|
    # Write the binary data to the file
    file.write(r)
  end
end

# def png

#   if ids = Otu.joins(:cached_map_items).first.cached_map_items.pluck(:geographic_item_id)

#     sql = "SELECT ST_AsPNG(
#    ST_AsRaster(
#        ST_Buffer( multi_polygon::geometry, 0, 'join=bevel'),
#            1024,
#            768)
#     ) png
#        from geographic_items where id IN (" + ids.join(',') + ');'

#     # hack, not the best way to unpack result
#     result = ActiveRecord::Base.connection.execute(sql).first['png']
#     r = ActiveRecord::Base.connection.unescape_bytea(result)

#     send_data r, filename: 'foo.png', type: 'imnage/png'

#   else
#     render json: {foo: false}
#   end
# end

def set_cached
  update_column(:cached_total_area, area)
end

# @return [Symbol]
#   returns the attribute (column name) containing data
#   nearly all methods should use #geo_object_type, not geo_type
def geo_type
  DATA_TYPES.each { |item|
    return item if send(item)
  }
  nil
end

# @return [Boolean, String] false if already set, or type to which it was set
def set_type_if_geography_present
  if type.blank?
    column = geo_type
    self.type = "GeographicItem::#{column.to_s.camelize}" if column
  end
end

# @param [RGeo::Point] point
# @return [Array] of a point
#   Longitude |, Latitude -
def point_to_a(point)
  data = []
  data.push(point.x, point.y)
  data
end

# @param [RGeo::Point] point
# @return [Hash] of a point
def point_to_hash(point)
  {points: [point_to_a(point)]}
end

# @param [RGeo::MultiPoint] multi_point
# @return [Array] of points
def multi_point_to_a(multi_point)
  data = []
  multi_point.each { |point|
    data.push([point.x, point.y])
  }
  data
end

# @return [Hash] of points
def multi_point_to_hash(_multi_point)
  # when we encounter a multi_point type, we only stick the points into the array, NOT it's identity as a group
  {points: multi_point_to_a(multi_point)}
end

# @param [Reo::LineString] line_string
# @return [Array] of points in the line
def line_string_to_a(line_string)
  data = []
  line_string.points.each { |point|
    data.push([point.x, point.y])
  }
  data
end

# @param [Reo::LineString] line_string
# @return [Hash] of points in the line
def line_string_to_hash(line_string)
  {lines: [line_string_to_a(line_string)]}
end

# @param [RGeo::Polygon] polygon
# @return [Array] of points in the polygon (exterior_ring ONLY)
def polygon_to_a(polygon)
  # TODO: handle other parts of the polygon; i.e., the interior_rings (if they exist)
  data = []
  polygon.exterior_ring.points.each { |point|
    data.push([point.x, point.y])
  }
  data
end

# @param [RGeo::Polygon] polygon
# @return [Hash] of points in the polygon (exterior_ring ONLY)
def polygon_to_hash(polygon)
  {polygons: [polygon_to_a(polygon)]}
end

# @return [Array] of line_strings as arrays of points
# @param [RGeo::MultiLineString] multi_line_string
def multi_line_string_to_a(multi_line_string)
  data = []
  multi_line_string.each { |line_string|
    line_data = []
    line_string.points.each { |point|
      line_data.push([point.x, point.y])
    }
    data.push(line_data)
  }
  data
end

# @return [Hash] of line_strings as hashes of points
def multi_line_string_to_hash(_multi_line_string)
  {lines: to_a}
end

# @param [RGeo::MultiPolygon] multi_polygon
# @return [Array] of arrays of points in the polygons (exterior_ring ONLY)
def multi_polygon_to_a(multi_polygon)
  data = []
  multi_polygon.each { |polygon|
    polygon_data = []
    polygon.exterior_ring.points.each { |point|
      polygon_data.push([point.x, point.y])
    }
    data.push(polygon_data)
  }
  data
end

# @return [Hash] of hashes of points in the polygons (exterior_ring ONLY)
def multi_polygon_to_hash(_multi_polygon)
  {polygons: to_a}
end

# @return [Boolean] iff there is one and only one shape column set
def some_data_is_provided
  data = []

  DATA_TYPES.each do |item|
    data.push(item) if send(item).present?
  end

  case data.count
  when 0
    errors.add(:base, 'No shape provided or provided shape is invalid')
  when 1
    return true
  else
    data.each do |object|
      errors.add(object, 'More than one shape type provided')
    end
  end
  true
end
end

#geometry ⇒ `Hash`^?

Returns An internal variable for use in super calls, holds a Hash in GeoJSON format (temporarily).

Returns:

(Hash, nil) —

An internal variable for use in super calls, holds a Hash in GeoJSON format (temporarily)



49
50
51

# File 'app/models/geographic_item.rb', line 49

def geometry
  @geometry
end

#line_string ⇒ `RGeo::Geographic::ProjectedLineStringImpl`

Returns:

(RGeo::Geographic::ProjectedLineStringImpl)

# File 'app/models/geographic_item.rb', line 40

class GeographicItem < ApplicationRecord
  include Housekeeping::Users
  include Housekeeping::Timestamps
  include Shared::HasPapertrail
  include Shared::IsData
  include Shared::SharedAcrossProjects

  # @return [Hash, nil]
  #   An internal variable for use in super calls, holds a Hash in GeoJSON format (temporarily)
  attr_accessor :geometry

  # @return [Boolean, RGeo object]
  # @params value [Hash in GeoJSON format] ?!
  # TODO: WHY! boolean not nil, or object
  # Used to build geographic items from a shape [ of what class ] !?
  attr_accessor :shape

  # @return [Boolean]
  #   When true cached values are not built
  attr_accessor :no_cached

  DATA_TYPES = [
:point,
:line_string,
:polygon,
:multi_point,
:multi_line_string,
:multi_polygon,
:geometry_collection
  ].freeze

  GEOMETRY_SQL = Arel::Nodes::Case.new(arel_table[:type])
.when('GeographicItem::MultiPolygon').then(Arel::Nodes::NamedFunction.new('CAST', [arel_table[:multi_polygon].as('geometry')]))
.when('GeographicItem::Point').then(Arel::Nodes::NamedFunction.new('CAST', [arel_table[:point].as('geometry')]))
.when('GeographicItem::LineString').then(Arel::Nodes::NamedFunction.new('CAST', [arel_table[:line_string].as('geometry')]))
.when('GeographicItem::Polygon').then(Arel::Nodes::NamedFunction.new('CAST', [arel_table[:polygon].as('geometry')]))
.when('GeographicItem::MultiLineString').then(Arel::Nodes::NamedFunction.new('CAST', [arel_table[:multi_line_string].as('geometry')]))
.when('GeographicItem::MultiPoint').then(Arel::Nodes::NamedFunction.new('CAST', [arel_table[:multi_point].as('geometry')]))
.when('GeographicItem::GeometryCollection').then(Arel::Nodes::NamedFunction.new('CAST', [arel_table[:geometry_collection].as('geometry')]))
.freeze

  GEOGRAPHY_SQL = "CASE geographic_items.type
WHEN 'GeographicItem::MultiPolygon' THEN multi_polygon
WHEN 'GeographicItem::Point' THEN point
WHEN 'GeographicItem::LineString' THEN line_string
WHEN 'GeographicItem::Polygon' THEN polygon
WHEN 'GeographicItem::MultiLineString' THEN multi_line_string
WHEN 'GeographicItem::MultiPoint' THEN multi_point
WHEN 'GeographicItem::GeometryCollection' THEN geometry_collection
END".freeze

# ANTI_MERIDIAN = '0X0102000020E61000000200000000000000008066400000000000405640000000000080664000000000004056C0'
ANTI_MERIDIAN = 'LINESTRING (180 89.0, 180 -89)'.freeze

has_many :cached_map_items, inverse_of: :geographic_item

has_many :geographic_areas_geographic_items, dependent: :destroy, inverse_of: :geographic_item
has_many :geographic_areas, through: :geographic_areas_geographic_items
has_many :asserted_distributions, through: :geographic_areas
has_many :geographic_area_types, through: :geographic_areas
has_many :parent_geographic_areas, through: :geographic_areas, source: :parent

has_many :georeferences, inverse_of: :geographic_item
has_many :georeferences_through_error_geographic_item,
  class_name: 'Georeference', foreign_key: :error_geographic_item_id, inverse_of: :error_geographic_item
has_many :collecting_events_through_georeferences, through: :georeferences, source: :collecting_event
has_many :collecting_events_through_georeference_error_geographic_item,
  through: :georeferences_through_error_geographic_item, source: :collecting_event

# TODO: THIS IS NOT GOOD
before_validation :set_type_if_geography_present

validate :some_data_is_provided
validates :type, presence: true # not needed

scope :include_collecting_event, -> { includes(:collecting_events_through_georeferences) }
scope :geo_with_collecting_event, -> { joins(:collecting_events_through_georeferences) }
scope :err_with_collecting_event, -> { joins(:georeferences_through_error_geographic_item) }

after_save :set_cached, unless: Proc.new {|n| n.no_cached || errors.any? }
after_save :align_winding

class << self

  def aliased_geographic_sql(name = 'a')
    "CASE #{name}.type \
     WHEN 'GeographicItem::MultiPolygon' THEN #{name}.multi_polygon \
     WHEN 'GeographicItem::Point' THEN #{name}.point \
     WHEN 'GeographicItem::LineString' THEN #{name}.line_string \
     WHEN 'GeographicItem::Polygon' THEN #{name}.polygon \
     WHEN 'GeographicItem::MultiLineString' THEN #{name}.multi_line_string \
     WHEN 'GeographicItem::MultiPoint' THEN #{name}.multi_point \
     WHEN 'GeographicItem::GeometryCollection' THEN #{name}.geometry_collection \
     END"
  end

  def st_union(geographic_item_scope)
    GeographicItem.select("ST_Union(#{GeographicItem::GEOMETRY_SQL.to_sql}) as collection")
      .where(id: geographic_item_scope.pluck(:id))
  end

  def st_collect(geographic_item_scope)
    GeographicItem.select("ST_Collect(#{GeographicItem::GEOMETRY_SQL.to_sql}) as collection")
      .where(id: geographic_item_scope.pluck(:id))
  end

  # @return [GeographicItem::ActiveRecord_Relation]
  # @params [Array] array of geographic area ids
  def default_by_geographic_area_ids(geographic_area_ids = [])
    GeographicItem.
      joins(:geographic_areas_geographic_items).
      merge(::GeographicAreasGeographicItem.default_geographic_item_data).
      where(geographic_areas_geographic_items: {geographic_area_id: geographic_area_ids})
  end

  # @param [String] wkt
  # @return [Boolean]
  #   whether or not the wtk intersects with the anti-meridian
  #   !! StrongParams security considerations
  def crosses_anti_meridian?(wkt)
    GeographicItem.find_by_sql(
      ['SELECT ST_Intersects(ST_GeogFromText(?), ST_GeogFromText(?)) as r;', wkt, ANTI_MERIDIAN]
    ).first.r
  end

  # @param [Integer] ids
  # @return [Boolean]
  #   whether or not any GeographicItem passed intersects the anti-meridian
  #   !! StrongParams security considerations
  #   This is our first line of defense against queries that define multiple shapes, one or
  #   more of which crosses the anti-meridian.  In this case the current TW strategy within the
  #   UI is to abandon the search, and prompt the user to refactor the query.
  def crosses_anti_meridian_by_id?(*ids)
    q1 = ["SELECT ST_Intersects((SELECT single_geometry FROM (#{GeographicItem.single_geometry_sql(*ids)}) as " \
          'left_intersect), ST_GeogFromText(?)) as r;', ANTI_MERIDIAN]
    _q2 = ActiveRecord::Base.send(:sanitize_sql_array, ['SELECT ST_Intersects((SELECT single_geometry FROM (?) as ' \
                                                        'left_intersect), ST_GeogFromText(?)) as r;', GeographicItem.single_geometry_sql(*ids), ANTI_MERIDIAN])
    GeographicItem.find_by_sql(q1).first.r
  end

  #
  # SQL fragments
  #

  # @param [Integer, String]
  # @return [String]
  #   a SQL select statement that returns the *geometry* for the geographic_item with the specified id
  def select_geometry_sql(geographic_item_id)
    "SELECT #{GeographicItem::GEOMETRY_SQL.to_sql} from geographic_items where geographic_items.id = #{geographic_item_id}"
  end

  # @param [Integer, String]
  # @return [String]
  #   a SQL select statement that returns the geography for the geographic_item with the specified id
  def select_geography_sql(geographic_item_id)
    ActiveRecord::Base.send(:sanitize_sql_for_conditions, [
      "SELECT #{GeographicItem::GEOMETRY_SQL.to_sql} from geographic_items where geographic_items.id = ?",
      geographic_item_id])
  end

  # @param [Symbol] choice
  # @return [String]
  #   a fragment returning either latitude or longitude columns
  def lat_long_sql(choice)
    return nil unless [:latitude, :longitude].include?(choice)
    f = "'D.DDDDDD'" # TODO: probably a constant somewhere
    v = (choice == :latitude ? 1 : 2)
    "CASE geographic_items.type
  WHEN 'GeographicItem::GeometryCollection' THEN split_part(ST_AsLatLonText(ST_Centroid" \
  "(geometry_collection::geometry), #{f}), ' ', #{v})
  WHEN 'GeographicItem::LineString' THEN split_part(ST_AsLatLonText(ST_Centroid(line_string::geometry), " \
  "#{f}), ' ', #{v})
  WHEN 'GeographicItem::MultiPolygon' THEN split_part(ST_AsLatLonText(" \
  "ST_Centroid(multi_polygon::geometry), #{f}), ' ', #{v})
  WHEN 'GeographicItem::Point' THEN split_part(ST_AsLatLonText(" \
  "ST_Centroid(point::geometry), #{f}), ' ', #{v})
  WHEN 'GeographicItem::Polygon' THEN split_part(ST_AsLatLonText(" \
  "ST_Centroid(polygon::geometry), #{f}), ' ', #{v})
  WHEN 'GeographicItem::MultiLineString' THEN split_part(ST_AsLatLonText(" \
  "ST_Centroid(multi_line_string::geometry), #{f} ), ' ', #{v})
  WHEN 'GeographicItem::MultiPoint' THEN split_part(ST_AsLatLonText(" \
  "ST_Centroid(multi_point::geometry), #{f}), ' ', #{v})
END as #{choice}"
  end

  # @param [Integer] geographic_item_id
  # @param [Integer] distance
  # @return [String]
  def within_radius_of_item_sql(geographic_item_id, distance)
    "ST_DWithin((#{GeographicItem::GEOGRAPHY_SQL}), (#{select_geography_sql(geographic_item_id)}), #{distance})"
  end


  # @param [Integer] geographic_item_id
  # @param [Number] distance in meters to grow/shrink the shape (negative allowed)
  # @param [Number] distance (in meters) (positive only?!)
  # @return [String]
  def st_buffer_st_within(geographic_item_id, distance, buffer = 0)
    "ST_DWithin(
    ST_Buffer(#{GeographicItem::GEOGRAPHY_SQL}, #{buffer}),
    (#{select_geography_sql(geographic_item_id)}), #{distance}
   )"
  end


  # TODO: 3D is overkill here
  # @param [String] wkt
  # @param [Integer] distance (meters)
  # @return [String]
  # !! This is intersecting
  def intersecting_radius_of_wkt_sql(wkt, distance)
    "ST_DWithin((#{GeographicItem::GEOGRAPHY_SQL}), ST_Transform( ST_GeomFromText('#{wkt}', " \
      "4326), 4326), #{distance})"
  end

  # @param [String] wkt
  # @param [Integer] distance (meters)
  # @return [String]
  # !! This is fully covering
  def within_radius_of_wkt_sql(wkt, distance)
    "ST_Covers( ST_Buffer(ST_SetSRID( ST_GeomFromText('#{wkt}'), 4326)::geography, #{distance}), (#{GeographicItem::GEOGRAPHY_SQL}))"
  end

  # @param [String, Integer, String]
  # @return [String]
  #   a SQL fragment for ST_Contains() function, returns
  #   all geographic items which are contained in the item supplied
  def containing_sql(target_column_name = nil, geographic_item_id = nil, source_column_name = nil)
    return 'false' if geographic_item_id.nil? || source_column_name.nil? || target_column_name.nil?
    "ST_Contains(#{target_column_name}::geometry, (#{geometry_sql(geographic_item_id, source_column_name)}))"
  end

  # @param [String, Integer, String]
  # @return [String]
  #   a SQL fragment for ST_Contains(), returns
  #   all geographic_items which contain the supplied geographic_item
  def reverse_containing_sql(target_column_name = nil, geographic_item_id = nil, source_column_name = nil)
    return 'false' if geographic_item_id.nil? || source_column_name.nil? || target_column_name.nil?
    "ST_Contains((#{geometry_sql(geographic_item_id, source_column_name)}), #{target_column_name}::geometry)"
  end

  # @param [Integer, String]
  # @return [String]
  #   a SQL fragment that represents the geometry of the geographic item specified (which has data in the
  # source_column_name, i.e. geo_object_type)
  def geometry_sql(geographic_item_id = nil, source_column_name = nil)
    return 'false' if geographic_item_id.nil? || source_column_name.nil?
    "select geom_alias_tbl.#{source_column_name}::geometry from geographic_items geom_alias_tbl " \
      "where geom_alias_tbl.id = #{geographic_item_id}"
  end

  # rubocop:disable Metrics/MethodLength
  # @param [String] column_name
  # @param [GeographicItem] geographic_item
  # @return [String] of SQL
  def is_contained_by_sql(column_name, geographic_item)
    geo_id = geographic_item.id
    geo_type = geographic_item.geo_object_type
    template = '(ST_Contains((select geographic_items.%s::geometry from geographic_items where ' \
      'geographic_items.id = %d), %s::geometry))'
    retval = []
    column_name.downcase!
    case column_name
    when 'any'
      DATA_TYPES.each { |column|
        unless column == :geometry_collection
          retval.push(template % [geo_type, geo_id, column])
        end
      }
    when 'any_poly', 'any_line'
      DATA_TYPES.each { |column|
        unless column == :geometry_collection
          if column.to_s.index(column_name.gsub('any_', ''))
            retval.push(template % [geo_type, geo_id, column])
          end
        end
      }
    else
      retval = template % [geo_type, geo_id, column_name]
    end
    retval = retval.join(' OR ') if retval.instance_of?(Array)
    retval
  end

  # @param [Interger, Array of Integer] geographic_item_ids
  # @return [String]
  #   a select query that returns a single geometry (column name 'single_geometry' for the collection of ids
  # provided via ST_Collect)
  def st_collect_sql(*geographic_item_ids)
    geographic_item_ids.flatten!
    ActiveRecord::Base.send(:sanitize_sql_for_conditions, [
      "SELECT ST_Collect(f.the_geom) AS single_geometry
 FROM (
    SELECT (ST_DUMP(#{GeographicItem::GEOMETRY_SQL.to_sql})).geom as the_geom
    FROM geographic_items
    WHERE id in (?))
  AS f", geographic_item_ids])
  end

  # @param [Interger, Array of Integer] geographic_item_ids
  # @return [String]
  #    returns one or more geographic items combined as a single geometry in column 'single'
  def single_geometry_sql(*geographic_item_ids)
    a = GeographicItem.st_collect_sql(geographic_item_ids)
    '(SELECT single.single_geometry FROM (' + a + ' ) AS single)'
  end

  # @param [Interger, Array of Integer] geographic_item_ids
  # @return [String]
  #   returns a single geometry "column" (paren wrapped) as "single" for multiple geographic item ids, or the
  # geometry as 'geometry' for a single id
  def geometry_sql2(*geographic_item_ids)
    geographic_item_ids.flatten! # *ALWAYS* reduce the pile to a single level of ids
    if geographic_item_ids.count == 1
      "(#{GeographicItem.geometry_for_sql(geographic_item_ids.first)})"
    else
      GeographicItem.single_geometry_sql(geographic_item_ids)
    end
  end

  # @param [Interger, Array of Integer] geographic_item_ids
  # @return [String]
  def containing_where_sql(*geographic_item_ids)
    "ST_CoveredBy(
      #{GeographicItem.geometry_sql2(*geographic_item_ids)},
       CASE geographic_items.type
         WHEN 'GeographicItem::MultiPolygon' THEN multi_polygon::geometry
         WHEN 'GeographicItem::Point' THEN point::geometry
         WHEN 'GeographicItem::LineString' THEN line_string::geometry
         WHEN 'GeographicItem::Polygon' THEN polygon::geometry
         WHEN 'GeographicItem::MultiLineString' THEN multi_line_string::geometry
         WHEN 'GeographicItem::MultiPoint' THEN multi_point::geometry
      END)"
  end

  # @param [Interger, Array of Integer] geographic_item_ids
  # @return [String]
  def containing_where_sql_geog(*geographic_item_ids)
    "ST_CoveredBy(
      #{GeographicItem.geometry_sql2(*geographic_item_ids)},
       CASE geographic_items.type
         WHEN 'GeographicItem::MultiPolygon' THEN multi_polygon::geography
         WHEN 'GeographicItem::Point' THEN point::geography
         WHEN 'GeographicItem::LineString' THEN line_string::geography
         WHEN 'GeographicItem::Polygon' THEN polygon::geography
         WHEN 'GeographicItem::MultiLineString' THEN multi_line_string::geography
         WHEN 'GeographicItem::MultiPoint' THEN multi_point::geography
      END)"
  end

  # @param [Interger, Array of Integer] ids
  # @return [Array]
  #   If we detect that some query id has crossed the meridian, then loop through
  #   and "manually" build up a list of results.
  #   Should only be used if GeographicItem.crosses_anti_meridian_by_id? is true.
  #   Note that this does not return a Scope, so you can't chain it like contained_by?
  # TODO: test this
  def contained_by_with_antimeridian_check(*ids)
    ids.flatten! # make sure there is only one level of splat (*)
    results = []

    crossing_ids = []

    ids.each do |id|
      # push each which crosses
      crossing_ids.push(id) if GeographicItem.crosses_anti_meridian_by_id?(id)
    end

    non_crossing_ids = ids - crossing_ids
    results.push GeographicItem.contained_by(non_crossing_ids).to_a if non_crossing_ids.any?

    crossing_ids.each do |id|
      # [61666, 61661, 61659, 61654, 61639]
      q1 = ActiveRecord::Base.send(:sanitize_sql_array, ['SELECT ST_AsText((SELECT polygon FROM geographic_items ' \
                                                         'WHERE id = ?))', id])
      r = GeographicItem.where(
        # GeographicItem.contained_by_wkt_shifted_sql(GeographicItem.find(id).geo_object.to_s)
        GeographicItem.contained_by_wkt_shifted_sql(
          ApplicationRecord.connection.execute(q1).first['st_astext'])
      ).to_a
      results.push(r)
    end

    results.flatten.uniq
  end

  # @params [String] well known text
  # @return [String] the SQL fragment for the specific geometry type, shifted by longitude
  # Note: this routine is called when it is already known that the A argument crosses anti-meridian
  def contained_by_wkt_shifted_sql(wkt)
    "ST_Contains(ST_ShiftLongitude(ST_GeomFromText('#{wkt}', 4326)), (
    CASE geographic_items.type
       WHEN 'GeographicItem::MultiPolygon' THEN ST_ShiftLongitude(multi_polygon::geometry)
       WHEN 'GeographicItem::Point' THEN ST_ShiftLongitude(point::geometry)
       WHEN 'GeographicItem::LineString' THEN ST_ShiftLongitude(line_string::geometry)
       WHEN 'GeographicItem::Polygon' THEN ST_ShiftLongitude(polygon::geometry)
       WHEN 'GeographicItem::MultiLineString' THEN ST_ShiftLongitude(multi_line_string::geometry)
       WHEN 'GeographicItem::MultiPoint' THEN ST_ShiftLongitude(multi_point::geometry)
    END
    )
  )"
  end

  # TODO: Remove the hard coded 4326 reference
  # @params [String] wkt
  # @return [String] SQL fragment limiting geographics items to those in this WKT
  def contained_by_wkt_sql(wkt)
    if crosses_anti_meridian?(wkt)
      retval = contained_by_wkt_shifted_sql(wkt)
    else
      retval = "ST_Contains(ST_GeomFromText('#{wkt}', 4326), (
    CASE geographic_items.type
       WHEN 'GeographicItem::MultiPolygon' THEN multi_polygon::geometry
       WHEN 'GeographicItem::Point' THEN point::geometry
       WHEN 'GeographicItem::LineString' THEN line_string::geometry
       WHEN 'GeographicItem::Polygon' THEN polygon::geometry
       WHEN 'GeographicItem::MultiLineString' THEN multi_line_string::geometry
       WHEN 'GeographicItem::MultiPoint' THEN multi_point::geometry
    END
    )
  )"
    end
    retval
  end

  # @param [Interger, Array of Integer] geographic_item_ids
  # @return [String] sql for contained_by via ST_ContainsProperly
  # Note: Can not use GEOMETRY_SQL because geometry_collection is not supported in ST_ContainsProperly
  # Note: !! If the target GeographicItem#id crosses the anti-meridian then you may/will get unexpected results.
  def contained_by_where_sql(*geographic_item_ids)
    "ST_Contains(
    #{GeographicItem.geometry_sql2(*geographic_item_ids)},
    CASE geographic_items.type
      WHEN 'GeographicItem::MultiPolygon' THEN multi_polygon::geometry
      WHEN 'GeographicItem::Point' THEN point::geometry
      WHEN 'GeographicItem::LineString' THEN line_string::geometry
      WHEN 'GeographicItem::Polygon' THEN polygon::geometry
      WHEN 'GeographicItem::MultiLineString' THEN multi_line_string::geometry
      WHEN 'GeographicItem::MultiPoint' THEN multi_point::geometry
    END)"
  end

  # @param [RGeo:Point] rgeo_point
  # @return [String] sql for containing via ST_CoveredBy
  # TODO: Remove the hard coded 4326 reference
  # TODO: should this be wkt_point instead of rgeo_point?
  def containing_where_for_point_sql(rgeo_point)
    "ST_CoveredBy(
  ST_GeomFromText('#{rgeo_point}', 4326),
  #{GeographicItem::GEOMETRY_SQL.to_sql}
 )"
  end

  # @param [Interger] geographic_item_id
  # @return [String] SQL for geometries
  # example, not used
  def geometry_for_sql(geographic_item_id)
    'SELECT ' + GeographicItem::GEOMETRY_SQL.to_sql + ' AS geometry FROM geographic_items WHERE id = ' \
      "#{geographic_item_id} LIMIT 1"
  end

  # @param [Interger, Array of Integer] geographic_item_ids
  # @return [String] SQL for geometries
  # example, not used
  def geometry_for_collection_sql(*geographic_item_ids)
    'SELECT ' + GeographicItem::GEOMETRY_SQL.to_sql + ' AS geometry FROM geographic_items WHERE id IN ' \
      "( #{geographic_item_ids.join(',')} )"
  end

  #
  # Scopes
  #

  # @param [Interger, Array of Integer] geographic_item_ids
  # @return [Scope]
  #    the geographic items containing these collective geographic_item ids, not including self
  def containing(*geographic_item_ids)
    where(GeographicItem.containing_where_sql(geographic_item_ids)).not_ids(*geographic_item_ids)
  end

  # @param [Interger, Array of Integer] geographic_item_ids
  # @return [Scope]
  #    the geographic items contained by any of these geographic_item ids, not including self
  # (works via ST_ContainsProperly)
  def contained_by(*geographic_item_ids)
    where(GeographicItem.contained_by_where_sql(geographic_item_ids))
  end

  # @param [RGeo::Point] rgeo_point
  # @return [Scope]
  #    the geographic items containing this point
  # TODO: should be containing_wkt ?
  def containing_point(rgeo_point)
    where(GeographicItem.containing_where_for_point_sql(rgeo_point))
  end

  # @return [Scope]
  #   adds an area_in_meters field, with meters
  def with_area
    select("ST_Area(#{GeographicItem::GEOGRAPHY_SQL}, false) as area_in_meters")
  end

  # return [Scope]
  #   A scope that limits the result to those GeographicItems that have a collecting event
  #   through either the geographic_item or the error_geographic_item
  #
  # A raw SQL join approach for comparison
  #
  # GeographicItem.joins('LEFT JOIN georeferences g1 ON geographic_items.id = g1.geographic_item_id').
  #   joins('LEFT JOIN georeferences g2 ON geographic_items.id = g2.error_geographic_item_id').
  #   where("(g1.geographic_item_id IS NOT NULL OR g2.error_geographic_item_id IS NOT NULL)").uniq

  # @return [Scope] GeographicItem
  # This uses an Arel table approach, this is ultimately more decomposable if we need. Of use:
  #  http://danshultz.github.io/talks/mastering_activerecord_arel  <- best
  #  https://github.com/rails/arel
  #  http://stackoverflow.com/questions/4500629/use-arel-for-a-nested-set-join-query-and-convert-to-activerecordrelation
  #  http://rdoc.info/github/rails/arel/Arel/SelectManager
  #  http://stackoverflow.com/questions/7976358/activerecord-arel-or-condition
  #
  def with_collecting_event_through_georeferences
    geographic_items = GeographicItem.arel_table
    georeferences = Georeference.arel_table
    g1 = georeferences.alias('a')
    g2 = georeferences.alias('b')

    c = geographic_items.join(g1, Arel::Nodes::OuterJoin).on(geographic_items[:id].eq(g1[:geographic_item_id]))
      .join(g2, Arel::Nodes::OuterJoin).on(geographic_items[:id].eq(g2[:error_geographic_item_id]))

    GeographicItem.joins(# turn the Arel back into scope
                         c.join_sources # translate the Arel join to a join hash(?)
                        ).where(
                          g1[:id].not_eq(nil).or(g2[:id].not_eq(nil)) # returns a Arel::Nodes::Grouping
                        ).distinct
  end

  # @return [Scope] include a 'latitude' column
  def with_latitude
    select(lat_long_sql(:latitude))
  end

  # @return [Scope] include a 'longitude' column
  def with_longitude
    select(lat_long_sql(:longitude))
  end

  # @param [String, GeographicItems]
  # @return [Scope]
  def intersecting(column_name, *geographic_items)
    if column_name.downcase == 'any'
      pieces = []
      DATA_TYPES.each { |column|
        pieces.push(GeographicItem.intersecting(column.to_s, geographic_items).to_a)
      }

      # @TODO change 'id in (?)' to some other sql construct

      GeographicItem.where(id: pieces.flatten.map(&:id))
    else
      q = geographic_items.flatten.collect { |geographic_item|
        "ST_Intersects(#{column_name}, '#{geographic_item.geo_object}'    )" # seems like we want this: http://danshultz.github.io/talks/mastering_activerecord_arel/#/15/2
      }.join(' or ')

      where(q)
    end
  end

  # @param [GeographicItem#id] geographic_item_id
  # @param [Float] distance in meters ?!?!
  # @return [ActiveRecord::Relation]
  # !! should be distance, not radius?!
  def within_radius_of_item(geographic_item_id, distance)
    where(within_radius_of_item_sql(geographic_item_id, distance))
  end

  # @param [String, GeographicItem]
  # @return [Scope]
  #   a SQL fragment for ST_DISJOINT, specifies all geographic_items that have data in column_name
  #   that are disjoint from the passed geographic_items
  def disjoint_from(column_name, *geographic_items)
    q = geographic_items.flatten.collect { |geographic_item|
      "ST_DISJOINT(#{column_name}::geometry, (#{geometry_sql(geographic_item.to_param,
                                                         geographic_item.geo_object_type)}))"
    }.join(' and ')

    where(q)
  end

  # @return [Scope]
  #   see are_contained_in_item_by_id
  # @param [String] column_name
  # @param [GeographicItem, Array] geographic_items
  def are_contained_in_item(column_name, *geographic_items)
    are_contained_in_item_by_id(column_name, geographic_items.flatten.map(&:id))
  end

  # rubocop:disable Metrics/MethodLength
  # @param [String] column_name to search
  # @param [GeographicItem] geographic_item_ids or array of geographic_item_ids to be tested.
  # @return [Scope] of GeographicItems
  #
  # If this scope is given an Array of GeographicItems as a second parameter,
  # it will return the 'OR' of each of the objects against the table.
  # SELECT COUNT(*) FROM "geographic_items"
  #        WHERE (ST_Contains(polygon::geometry, GeomFromEWKT('srid=4326;POINT (0.0 0.0 0.0)'))
  #               OR ST_Contains(polygon::geometry, GeomFromEWKT('srid=4326;POINT (-9.8 5.0 0.0)')))
  #
  def are_contained_in_item_by_id(column_name, *geographic_item_ids) # = containing
    geographic_item_ids.flatten! # in case there is a array of arrays, or multiple objects
    column_name.downcase!
    case column_name
    when 'any'
      part = []
      DATA_TYPES.each { |column|
        unless column == :geometry_collection
          part.push(GeographicItem.are_contained_in_item_by_id(column.to_s, geographic_item_ids).to_a)
        end
      }
      # TODO: change 'id in (?)' to some other sql construct
      GeographicItem.where(id: part.flatten.map(&:id))
    when 'any_poly', 'any_line'
      part = []
      DATA_TYPES.each { |column|
        if column.to_s.index(column_name.gsub('any_', ''))
          part.push(GeographicItem.are_contained_in_item_by_id("#{column}", geographic_item_ids).to_a)
        end
      }
      # TODO: change 'id in (?)' to some other sql construct
      GeographicItem.where(id: part.flatten.map(&:id))
    else
      q = geographic_item_ids.flatten.collect { |geographic_item_id|
        # discover the item types, and convert type to database type for 'multi_'
        b = GeographicItem.where(id: geographic_item_id)
          .pluck(:type)[0].split(':')[2].downcase.gsub('lti', 'lti_')
        # a = GeographicItem.find(geographic_item_id).geo_object_type
        GeographicItem.containing_sql(column_name, geographic_item_id, b)
      }.join(' or ')
      q = 'FALSE' if q.blank? # this will prevent the invocation of *ALL* of the GeographicItems, if there are
      # no GeographicItems in the request (see CollectingEvent.name_hash(types)).
      where(q) # .not_including(geographic_items)
    end
  end

  # rubocop:enable Metrics/MethodLength

  # @param [String] column_name
  # @param [String] geometry of WKT
  # @return [Scope]
  # a single WKT geometry is compared against column or columns (except geometry_collection) to find geographic_items
  # which are contained in the WKT
  def are_contained_in_wkt(column_name, geometry)
    column_name.downcase!
    # column_name = 'point'
    case column_name
    when 'any'
      part = []
      DATA_TYPES.each { |column|
        unless column == :geometry_collection
          part.push(GeographicItem.are_contained_in_wkt(column.to_s, geometry).pluck(:id).to_a)
        end
      }
      # TODO: change 'id in (?)' to some other sql construct
      GeographicItem.where(id: part.flatten)
    when 'any_poly', 'any_line'
      part = []
      DATA_TYPES.each { |column|
        if column.to_s.index(column_name.gsub('any_', ''))
          part.push(GeographicItem.are_contained_in_wkt("#{column}", geometry).pluck(:id).to_a)
        end
      }
      # TODO: change 'id in (?)' to some other sql construct
      GeographicItem.where(id: part.flatten)
    else
      # column = points, geometry = square
      q = "ST_Contains(ST_GeomFromEWKT('srid=4326;#{geometry}'), #{column_name}::geometry)"
      where(q) # .not_including(geographic_items)
    end
  end

  # rubocop:disable Metrics/MethodLength
  #    containing the items the shape of which is contained in the geographic_item[s] supplied.
  # @param column_name [String] can be any of DATA_TYPES, or 'any' to check against all types, 'any_poly' to check
  # against 'polygon' or 'multi_polygon', or 'any_line' to check against 'line_string' or 'multi_line_string'.
  #  CANNOT be 'geometry_collection'.
  # @param geographic_items [GeographicItem] Can be a single GeographicItem, or an array of GeographicItem.
  # @return [Scope]
  def is_contained_by(column_name, *geographic_items)
    column_name.downcase!
    case column_name
    when 'any'
      part = []
      DATA_TYPES.each { |column|
        unless column == :geometry_collection
          part.push(GeographicItem.is_contained_by(column.to_s, geographic_items).to_a)
        end
      }
      # @TODO change 'id in (?)' to some other sql construct
      GeographicItem.where(id: part.flatten.map(&:id))

    when 'any_poly', 'any_line'
      part = []
      DATA_TYPES.each { |column|
        unless column == :geometry_collection
          if column.to_s.index(column_name.gsub('any_', ''))
            part.push(GeographicItem.is_contained_by(column.to_s, geographic_items).to_a)
          end
        end
      }
      # @TODO change 'id in (?)' to some other sql construct
      GeographicItem.where(id: part.flatten.map(&:id))

    else
      q = geographic_items.flatten.collect { |geographic_item|
        GeographicItem.reverse_containing_sql(column_name, geographic_item.to_param,
                                              geographic_item.geo_object_type)
      }.join(' or ')
      where(q) # .not_including(geographic_items)
    end
  end

  # rubocop:enable Metrics/MethodLength

  # @param [String, GeographicItem]
  # @return [Scope]
  def ordered_by_shortest_distance_from(column_name, geographic_item)
    if true # check_geo_params(column_name, geographic_item)
      select_distance_with_geo_object(column_name, geographic_item)
        .where_distance_greater_than_zero(column_name, geographic_item).order('distance')
    else
      where('false')
    end
  end

  # @param [String, GeographicItem]
  # @return [Scope]
  def ordered_by_longest_distance_from(column_name, geographic_item)
    if true # check_geo_params(column_name, geographic_item)
      q = select_distance_with_geo_object(column_name, geographic_item)
        .where_distance_greater_than_zero(column_name, geographic_item)
        .order('distance desc')
      q
    else
      where('false')
    end
  end

  # @param [String] column_name
  # @param [GeographicItem] geographic_item
  # @return [String]
  def select_distance_with_geo_object(column_name, geographic_item)
    select("*, ST_Distance(#{column_name}, GeomFromEWKT('srid=4326;#{geographic_item.geo_object}')) as distance")
  end

  # @param [String, GeographicItem]
  # @return [Scope]
  def where_distance_greater_than_zero(column_name, geographic_item)
    where("#{column_name} is not null and ST_Distance(#{column_name}, " \
          "GeomFromEWKT('srid=4326;#{geographic_item.geo_object}')) > 0")
  end

  # @param [GeographicItem]
  # @return [Scope]
  def not_including(geographic_items)
    where.not(id: geographic_items)
  end

  # @return [Scope]
  #   includes an 'is_valid' attribute (True/False) for the passed geographic_item.  Uses St_IsValid.
  # @param [RGeo object] geographic_item
  def with_is_valid_geometry_column(geographic_item)
    where(id: geographic_item.id).select("ST_IsValid(ST_AsBinary(#{geographic_item.geo_object_type})) is_valid")
  end

  #
  # Other
  #

  # @param [Integer] geographic_item_id1
  # @param [Integer] geographic_item_id2
  # @return [Float]
  def distance_between(geographic_item_id1, geographic_item_id2)
    q1 = "ST_Distance(#{GeographicItem::GEOGRAPHY_SQL}, " \
      "(#{select_geography_sql(geographic_item_id2)})) as distance"
    _q2 = ActiveRecord::Base.send(
      :sanitize_sql_array, ['ST_Distance(?, (?)) as distance',
                            GeographicItem::GEOGRAPHY_SQL,
                            select_geography_sql(geographic_item_id2)])
    GeographicItem.where(id: geographic_item_id1).pluck(Arel.sql(q1)).first
  end

  # @param [RGeo::Point] point
  # @return [Hash]
  #   as per #inferred_geographic_name_hierarchy but for Rgeo point
  def point_inferred_geographic_name_hierarchy(point)
    GeographicItem.containing_point(point).order(cached_total_area: :ASC).limit(1).first&.inferred_geographic_name_hierarchy
  end

  # @param [String] type_name ('polygon', 'point', 'line' [, 'circle'])
  # @return [String] if type
  def eval_for_type(type_name)
    retval = 'GeographicItem'
    case type_name.upcase
    when 'POLYGON'
      retval += '::Polygon'
    when 'LINESTRING'
      retval += '::LineString'
    when 'POINT'
      retval += '::Point'
    when 'MULTIPOLYGON'
      retval += '::MultiPolygon'
    when 'MULTILINESTRING'
      retval += '::MultiLineString'
    when 'MULTIPOINT'
      retval += '::MultiPoint'
    else
      retval = nil
    end
    retval
  end

  # example, not used
  # @param [Integer] geographic_item_id
  # @return [RGeo::Geographic object]
  def geometry_for(geographic_item_id)
    GeographicItem.select(GeographicItem::GEOMETRY_SQL.to_sql + ' AS geometry').find(geographic_item_id)['geometry']
  end

  # example, not used
  # @param [Integer, Array] geographic_item_ids
  # @return [Scope]
  def st_multi(*geographic_item_ids)
    GeographicItem.find_by_sql(
      "SELECT ST_Multi(ST_Collect(g.the_geom)) AS singlegeom
 FROM (
    SELECT (ST_DUMP(#{GeographicItem::GEOMETRY_SQL.to_sql})).geom AS the_geom
    FROM geographic_items
    WHERE id IN (?))
  AS g;", geographic_item_ids.flatten
    )
  end
end # class << self

# @return [Hash]
#    a geographic_name_classification or empty Hash
# This is a quick approach that works only when
# the geographic_item is linked explicitly to a GeographicArea.
#
# !! Note that it is not impossible for a GeographicItem to be linked
# to > 1 GeographicArea, in that case we are assuming that all are
# equally refined, this might not be the case in the future because
# of how the GeographicArea gazetteer is indexed.
def quick_geographic_name_hierarchy
  geographic_areas.order(:id).each do |ga|
    h = ga.geographic_name_classification # not quick enough !!
    return h if h.present?
  end
  return  {}
end

# @return [Hash]
#   a geographic_name_classification (see GeographicArea) inferred by
# finding the smallest area containing this GeographicItem, in the most accurate gazetteer
# and using it to return country/state/county. See also the logic in
# filling in missing levels in GeographicArea.
def inferred_geographic_name_hierarchy
  if small_area = containing_geographic_areas
    .joins(:geographic_areas_geographic_items)
    .merge(GeographicAreasGeographicItem.ordered_by_data_origin)
    .ordered_by_area
    .limit(1)
    .first
  return small_area.geographic_name_classification
  else
    {}
  end
end

def geographic_name_hierarchy
  a = quick_geographic_name_hierarchy # quick; almost never the case, UI not setup to do this
  return a if a.present?
  inferred_geographic_name_hierarchy # slow
end

# @return [Scope]
#   the Geographic Areas that contain (gis) this geographic item
def containing_geographic_areas
  GeographicArea.joins(:geographic_items).includes(:geographic_area_type)
    .joins("JOIN (#{GeographicItem.containing(id).to_sql}) j on geographic_items.id = j.id")
end

# @return [Boolean]
#   whether stored shape is ST_IsValid
def valid_geometry?
  GeographicItem.with_is_valid_geometry_column(self).first['is_valid']
end

# @return [Array of latitude, longitude]
#    the lat, lon of the first point in the GeoItem, see subclass for #st_start_point
def start_point
  o = st_start_point
  [o.y, o.x]
end

# @return [Array]
#   the lat, long, as STRINGs for the centroid of this geographic item
#   Meh- this: https://postgis.net/docs/en/ST_MinimumBoundingRadius.html
def center_coords
  r = GeographicItem.find_by_sql(
    "Select split_part(ST_AsLatLonText(ST_Centroid(#{GeographicItem::GEOMETRY_SQL.to_sql}), " \
    "'D.DDDDDD'), ' ', 1) latitude, split_part(ST_AsLatLonText(ST_Centroid" \
    "(#{GeographicItem::GEOMETRY_SQL.to_sql}), 'D.DDDDDD'), ' ', 2) " \
    "longitude from geographic_items where id = #{id};")[0]

  [r.latitude, r.longitude]
end

# @return [RGeo::Geographic::ProjectedPointImpl]
#    representing the centroid of this geographic item
def centroid
  # Gis::FACTORY.point(*center_coords.reverse)
  return geo_object if type == 'GeographicItem::Point'
  return Gis::FACTORY.parse_wkt(self.st_centroid)
end

# @param [Integer] geographic_item_id
# @return [Double] distance in meters (slower, more accurate)
def st_distance(geographic_item_id) # geo_object
  q1 = "ST_Distance((#{GeographicItem.select_geography_sql(id)}), " \
    "(#{GeographicItem.select_geography_sql(geographic_item_id)})) as d"
  _q2 = ActiveRecord::Base.send(:sanitize_sql_array, ['ST_Distance((?),(?)) as d',
                                                      GeographicItem.select_geography_sql(self.id),
                                                      GeographicItem.select_geography_sql(geographic_item_id)])
  deg = GeographicItem.where(id:).pluck(Arel.sql(q1)).first
  deg * Utilities::Geo::ONE_WEST
end

# @param [GeographicItem] geographic_item
# @return [Double] distance in meters
# Like st_distance but works with changed and non persisted objects
def st_distance_to_geographic_item(geographic_item)
  unless !persisted? || changed?
    a = "(#{GeographicItem.select_geography_sql(id)})"
  else
    a = "ST_GeographyFromText('#{geo_object}')"
  end

  unless !geographic_item.persisted? || geographic_item.changed?
    b = "(#{GeographicItem.select_geography_sql(geographic_item.id)})"
  else
    b = "ST_GeographyFromText('#{geographic_item.geo_object}')"
  end

  ActiveRecord::Base.connection.select_value("SELECT ST_Distance(#{a}, #{b})")
end

alias_method :distance_to, :st_distance

# @param [Integer] geographic_item_id
# @return [Double] distance in meters (faster, less accurate)
def st_distance_spheroid(geographic_item_id)
  q1 = "ST_DistanceSpheroid((#{GeographicItem.select_geometry_sql(id)})," \
    "(#{GeographicItem.select_geometry_sql(geographic_item_id)}),'#{Gis::SPHEROID}') as distance"
  _q2 = ActiveRecord::Base.send(:sanitize_sql_array,
                                ['ST_DistanceSpheroid((?),(?),?) as distance',
                                 GeographicItem.select_geometry_sql(id),
                                 GeographicItem.select_geometry_sql(geographic_item_id),
                                 Gis::SPHEROID])
  # TODO: what is _q2?
  GeographicItem.where(id:).pluck(Arel.sql(q1)).first
end

# @return [String]
#   a WKT POINT representing the centroid of the geographic item
def st_centroid
  GeographicItem.where(id: to_param).pluck(Arel.sql("ST_AsEWKT(ST_Centroid(#{GeographicItem::GEOMETRY_SQL.to_sql}))")).first.gsub(/SRID=\d*;/, '')
end

# @return [Integer]
#   the number of points in the geometry
def st_npoints
  GeographicItem.where(id:).pluck(Arel.sql("ST_NPoints(#{GeographicItem::GEOMETRY_SQL.to_sql}) as npoints")).first
end

# @return [Symbol]
#   the geo type (i.e. column like :point, :multipolygon).  References the first-found object,
# according to the list of DATA_TYPES, or nil
def geo_object_type
  if self.class.name == 'GeographicItem' # a proxy check for new records
    geo_type
  else
    self.class::SHAPE_COLUMN
  end
end

# !!TODO: migrate these to use native column calls

# @return [RGeo instance, nil]
#  the Rgeo shape (See http://rubydoc.info/github/dazuma/rgeo/RGeo/Feature)
def geo_object
  begin
    if r = geo_object_type # rubocop:disable Lint/AssignmentInCondition
      send(r)
    else
      false
    end
  rescue RGeo::Error::InvalidGeometry
    return nil # TODO: we need to render proper error for this!
  end
end

# @param [geo_object]
# @return [Boolean]
def contains?(target_geo_object)
  return nil if target_geo_object.nil?
  self.geo_object.contains?(target_geo_object)
end

# @param [geo_object]
# @return [Boolean]
def within?(target_geo_object)
  self.geo_object.within?(target_geo_object)
end

# @param [geo_object]
# @return [Boolean]
def intersects?(target_geo_object)
  self.geo_object.intersects?(target_geo_object)
end

# @param [geo_object, Double]
# @return [Boolean]
def near(target_geo_object, distance)
  self.geo_object.unsafe_buffer(distance).contains?(target_geo_object)
end

# @param [geo_object, Double]
# @return [Boolean]
def far(target_geo_object, distance)
  !near(target_geo_object, distance)
end

# @return [GeoJSON hash]
#    via Rgeo apparently necessary for GeometryCollection
def rgeo_to_geo_json
  RGeo::GeoJSON.encode(geo_object).to_json
end

# @return [Hash]
#   in GeoJSON format
#   Computed via "raw" PostGIS (much faster). This
#   requires the geo_object_type and id.
#
def to_geo_json
  JSON.parse(
    GeographicItem.connection.select_one(
      "SELECT ST_AsGeoJSON(#{geo_object_type}::geometry) a " \
      "FROM geographic_items WHERE id=#{id};")['a'])
end

# We don't need to serialize to/from JSON
def to_geo_json_string
  GeographicItem.connection.select_one(
    "SELECT ST_AsGeoJSON(#{geo_object_type}::geometry) a " \
    "FROM geographic_items WHERE id=#{id};")['a']
end

# @return [Hash]
#   the shape as a GeoJSON Feature with some item metadata
def to_geo_json_feature
  @geometry ||= to_geo_json
  {'type' => 'Feature',
   'geometry' => geometry,
   'properties' => {
     'geographic_item' => {
       'id' => id}
   }
  }
end

# @param value [String] like:
#   '{"type":"Feature","geometry":{"type":"Point","coordinates":[2.5,4.0]},"properties":{"color":"red"}}'
#
#   '{"type":"Feature","geometry":{"type":"Polygon","coordinates":"[[[-125.29394388198853, 48.584480409793],
#      [-67.11035013198853, 45.09937589848195],[-80.64550638198853, 25.01924647619111],[-117.55956888198853,
#      32.5591595028449],[-125.29394388198853, 48.584480409793]]]"},"properties":{}}'
#
#  '{"type":"Point","coordinates":[2.5,4.0]},"properties":{"color":"red"}}'
#
# @return [Boolean, RGeo object]
def shape=(value)

  if value.present?
    geom = RGeo::GeoJSON.decode(value, json_parser: :json, geo_factory: Gis::FACTORY)
    this_type = nil

    if geom.respond_to?(:geometry_type)
      this_type = geom.geometry_type.to_s
    elsif geom.respond_to?(:geometry)
      this_type = geom.geometry.geometry_type.to_s
    else
    end

    self.type = GeographicItem.eval_for_type(this_type) unless geom.nil?

    if type.blank?
      errors.add(:base, 'type is not set from shape')
      return
    end
    # raise('GeographicItem.type not set.') if type.blank?

    object = nil

    s = geom.respond_to?(:geometry) ? geom.geometry.to_s : geom.to_s

    begin
      object = Gis::FACTORY.parse_wkt(s)
    rescue RGeo::Error::InvalidGeometry
      errors.add(:self, 'Shape value is an Invalid Geometry')
    end

    write_attribute(this_type.underscore.to_sym, object)
    geom
  end
end

# @return [String]
def to_wkt
  #  10k  #<Benchmark::Tms:0x00007fb0dfd30fd0 @label="", @real=25.237487000005785, @cstime=0.0, @cutime=0.0, @stime=1.1704609999999995, @utime=5.507929999999988, @total=6.678390999999987>
  #  GeographicItem.select("ST_AsText( #{GeographicItem::GEOMETRY_SQL.to_sql}) wkt").where(id: id).first.wkt

  # 10k <Benchmark::Tms:0x00007fb0e02f7540 @label="", @real=21.619827999995323, @cstime=0.0, @cutime=0.0, @stime=0.8850890000000007, @utime=3.2958549999999605, @total=4.180943999999961>
  if a =  ApplicationRecord.connection.execute( "SELECT ST_AsText( #{GeographicItem::GEOMETRY_SQL.to_sql} ) wkt from geographic_items where geographic_items.id = #{id}").first
    return a['wkt']
  else
    return nil
  end
end

# @return  [Float] in meters, calculated
# TODO: share with world
#    Geographic item 96862 (Cajamar in Brazil) is the only(?) record to fail using `false` (quicker) method of everything we tested
def area
  a = GeographicItem.where(id:).select("ST_Area(#{GeographicItem::GEOGRAPHY_SQL}, true) as area_in_meters").first['area_in_meters']
  a = nil if a.nan?
  a
end

# @return [Float, false]
#    the value in square meters of the interesecting area of this and another GeographicItem
def intersecting_area(geographic_item_id)
  a = GeographicItem.aliased_geographic_sql('a')
  b = GeographicItem.aliased_geographic_sql('b')

  c = GeographicItem.connection.execute(
    "SELECT ST_Area(ST_Intersection(#{a}, #{b})) as intersecting_area
      FROM geographic_items a, geographic_items b
      WHERE a.id = #{id} AND b.id = #{geographic_item_id};"
  ).first
  c && c['intersecting_area'].to_f
end

# TODO: This is bad, while internal use of ONE_WEST_MEAN is consistent it is in-accurate given the vast differences of radius vs. lat/long position.
# When we strike the error-polygon from radius we should remove this
#
# Use case is returning the radius from a circle we calculated via buffer for error-polygon creation.
def radius
  r = ApplicationRecord.connection.execute( "SELECT ST_MinimumBoundingRadius( ST_Transform(  #{GeographicItem::GEOMETRY_SQL.to_sql}, 4326 )  ) AS radius from geographic_items where geographic_items.id = #{id}").first['radius'].split(',').last.chop.to_f
  r = (r * Utilities::Geo::ONE_WEST_MEAN).to_i
end


# Convention is to store in PostGIS in CCW
# @return Array [Boolean]
#   false - cw
#   true - ccw (preferred), except cee donuts
def orientations
  if multi_polygon.present?
    ApplicationRecord.connection.execute(" \
         SELECT ST_IsPolygonCCW(a.geom) as is_ccw
            FROM ( SELECT b.id, (ST_Dump(p_geom)).geom AS geom
               FROM (SELECT id, multi_polygon::geometry AS p_geom FROM geographic_items where id = #{id}) AS b \
          ) AS a;").collect{|a| a['is_ccw']}
  elsif polygon.present?
    ApplicationRecord.connection.execute("SELECT ST_IsPolygonCCW(polygon::geometry) as is_ccw \
            FROM geographic_items where  id = #{id};").collect{|a| a['is_ccw']}
  else
    []
  end
end

# @return Boolean
#   looks at all orientations
#   if they follow the pattern [true, false, ... <all false>] then `true`, else `false`
# !! Does not confirm that shapes are nested !!
def is_basic_donut?
  a = orientations
  b = a.shift
  return false unless b
  a.uniq!
  a == [false]
end

def st_isvalid
  r = ApplicationRecord.connection.execute( "SELECT ST_IsValid(  #{GeographicItem::GEOMETRY_SQL.to_sql }) from  geographic_items where geographic_items.id = #{id}").first['st_isvalid']
end

def st_isvalidreason
  r = ApplicationRecord.connection.execute( "SELECT ST_IsValidReason(  #{GeographicItem::GEOMETRY_SQL.to_sql }) from  geographic_items where geographic_items.id = #{id}").first['st_isvalidreason']
end

# !! Unused. Doesn't check Geometry collection
def has_polygons?
  ['GeographicItem::MultiPolygon', 'GeographicItem::Polygon'].include?(self.type)
end

private

def align_winding
  if orientations.flatten.include?(false)
    case type
    when 'multi_polygon'
      ApplicationRecord.connection.execute(
        "UPDATE geographic_items set multi_polygon = ST_ForcePolygonCCW(multi_polygon::geometry) 
          WHERE id = #{self.id};"
       )
    when 'polygon'
     ApplicationRecord.connection.execute(
        "UPDATE geographic_items set polygon = ST_ForcePolygonCCW(polygon::geometry) 
          WHERE id = #{self.id};"
       )
    end     
  end
  true
end

# Crude debuging helper, write the shapes
# to a png
def self.debug_draw(geographic_item_ids = [])
  return false if geographic_item_ids.empty?

  sql = "SELECT ST_AsPNG(
     ST_AsRaster(
        (SELECT ST_Union(multi_polygon::geometry) from geographic_items where id IN (" + geographic_item_ids.join(',') + ")), 1920, 1080
    )
   ) png;"

  # ST_Buffer( multi_polygon::geometry, 0, 'join=bevel'),
  #     1920,
  #     1080)


  result = ActiveRecord::Base.connection.execute(sql).first['png']
  r = ActiveRecord::Base.connection.unescape_bytea(result)

  prefix = if geographic_item_ids.size > 10
             'multiple'
           else
             geographic_item_ids.join('_') + '_debug.draw.png'
           end

  n = prefix + '_debug.draw.png'

  # Open the file in binary write mode ("wb")
  File.open(n, 'wb') do |file|
    # Write the binary data to the file
    file.write(r)
  end
end

# def png

#   if ids = Otu.joins(:cached_map_items).first.cached_map_items.pluck(:geographic_item_id)

#     sql = "SELECT ST_AsPNG(
#    ST_AsRaster(
#        ST_Buffer( multi_polygon::geometry, 0, 'join=bevel'),
#            1024,
#            768)
#     ) png
#        from geographic_items where id IN (" + ids.join(',') + ');'

#     # hack, not the best way to unpack result
#     result = ActiveRecord::Base.connection.execute(sql).first['png']
#     r = ActiveRecord::Base.connection.unescape_bytea(result)

#     send_data r, filename: 'foo.png', type: 'imnage/png'

#   else
#     render json: {foo: false}
#   end
# end

def set_cached
  update_column(:cached_total_area, area)
end

# @return [Symbol]
#   returns the attribute (column name) containing data
#   nearly all methods should use #geo_object_type, not geo_type
def geo_type
  DATA_TYPES.each { |item|
    return item if send(item)
  }
  nil
end

# @return [Boolean, String] false if already set, or type to which it was set
def set_type_if_geography_present
  if type.blank?
    column = geo_type
    self.type = "GeographicItem::#{column.to_s.camelize}" if column
  end
end

# @param [RGeo::Point] point
# @return [Array] of a point
#   Longitude |, Latitude -
def point_to_a(point)
  data = []
  data.push(point.x, point.y)
  data
end

# @param [RGeo::Point] point
# @return [Hash] of a point
def point_to_hash(point)
  {points: [point_to_a(point)]}
end

# @param [RGeo::MultiPoint] multi_point
# @return [Array] of points
def multi_point_to_a(multi_point)
  data = []
  multi_point.each { |point|
    data.push([point.x, point.y])
  }
  data
end

# @return [Hash] of points
def multi_point_to_hash(_multi_point)
  # when we encounter a multi_point type, we only stick the points into the array, NOT it's identity as a group
  {points: multi_point_to_a(multi_point)}
end

# @param [Reo::LineString] line_string
# @return [Array] of points in the line
def line_string_to_a(line_string)
  data = []
  line_string.points.each { |point|
    data.push([point.x, point.y])
  }
  data
end

# @param [Reo::LineString] line_string
# @return [Hash] of points in the line
def line_string_to_hash(line_string)
  {lines: [line_string_to_a(line_string)]}
end

# @param [RGeo::Polygon] polygon
# @return [Array] of points in the polygon (exterior_ring ONLY)
def polygon_to_a(polygon)
  # TODO: handle other parts of the polygon; i.e., the interior_rings (if they exist)
  data = []
  polygon.exterior_ring.points.each { |point|
    data.push([point.x, point.y])
  }
  data
end

# @param [RGeo::Polygon] polygon
# @return [Hash] of points in the polygon (exterior_ring ONLY)
def polygon_to_hash(polygon)
  {polygons: [polygon_to_a(polygon)]}
end

# @return [Array] of line_strings as arrays of points
# @param [RGeo::MultiLineString] multi_line_string
def multi_line_string_to_a(multi_line_string)
  data = []
  multi_line_string.each { |line_string|
    line_data = []
    line_string.points.each { |point|
      line_data.push([point.x, point.y])
    }
    data.push(line_data)
  }
  data
end

# @return [Hash] of line_strings as hashes of points
def multi_line_string_to_hash(_multi_line_string)
  {lines: to_a}
end

# @param [RGeo::MultiPolygon] multi_polygon
# @return [Array] of arrays of points in the polygons (exterior_ring ONLY)
def multi_polygon_to_a(multi_polygon)
  data = []
  multi_polygon.each { |polygon|
    polygon_data = []
    polygon.exterior_ring.points.each { |point|
      polygon_data.push([point.x, point.y])
    }
    data.push(polygon_data)
  }
  data
end

# @return [Hash] of hashes of points in the polygons (exterior_ring ONLY)
def multi_polygon_to_hash(_multi_polygon)
  {polygons: to_a}
end

# @return [Boolean] iff there is one and only one shape column set
def some_data_is_provided
  data = []

  DATA_TYPES.each do |item|
    data.push(item) if send(item).present?
  end

  case data.count
  when 0
    errors.add(:base, 'No shape provided or provided shape is invalid')
  when 1
    return true
  else
    data.each do |object|
      errors.add(object, 'More than one shape type provided')
    end
  end
  true
end
end

#multi_line_string ⇒ `RGeo::Geographic::ProjectedMultiLineStringImpl`

Returns:

(RGeo::Geographic::ProjectedMultiLineStringImpl)

# File 'app/models/geographic_item.rb', line 40

class GeographicItem < ApplicationRecord
  include Housekeeping::Users
  include Housekeeping::Timestamps
  include Shared::HasPapertrail
  include Shared::IsData
  include Shared::SharedAcrossProjects

  # @return [Hash, nil]
  #   An internal variable for use in super calls, holds a Hash in GeoJSON format (temporarily)
  attr_accessor :geometry

  # @return [Boolean, RGeo object]
  # @params value [Hash in GeoJSON format] ?!
  # TODO: WHY! boolean not nil, or object
  # Used to build geographic items from a shape [ of what class ] !?
  attr_accessor :shape

  # @return [Boolean]
  #   When true cached values are not built
  attr_accessor :no_cached

  DATA_TYPES = [
:point,
:line_string,
:polygon,
:multi_point,
:multi_line_string,
:multi_polygon,
:geometry_collection
  ].freeze

  GEOMETRY_SQL = Arel::Nodes::Case.new(arel_table[:type])
.when('GeographicItem::MultiPolygon').then(Arel::Nodes::NamedFunction.new('CAST', [arel_table[:multi_polygon].as('geometry')]))
.when('GeographicItem::Point').then(Arel::Nodes::NamedFunction.new('CAST', [arel_table[:point].as('geometry')]))
.when('GeographicItem::LineString').then(Arel::Nodes::NamedFunction.new('CAST', [arel_table[:line_string].as('geometry')]))
.when('GeographicItem::Polygon').then(Arel::Nodes::NamedFunction.new('CAST', [arel_table[:polygon].as('geometry')]))
.when('GeographicItem::MultiLineString').then(Arel::Nodes::NamedFunction.new('CAST', [arel_table[:multi_line_string].as('geometry')]))
.when('GeographicItem::MultiPoint').then(Arel::Nodes::NamedFunction.new('CAST', [arel_table[:multi_point].as('geometry')]))
.when('GeographicItem::GeometryCollection').then(Arel::Nodes::NamedFunction.new('CAST', [arel_table[:geometry_collection].as('geometry')]))
.freeze

  GEOGRAPHY_SQL = "CASE geographic_items.type
WHEN 'GeographicItem::MultiPolygon' THEN multi_polygon
WHEN 'GeographicItem::Point' THEN point
WHEN 'GeographicItem::LineString' THEN line_string
WHEN 'GeographicItem::Polygon' THEN polygon
WHEN 'GeographicItem::MultiLineString' THEN multi_line_string
WHEN 'GeographicItem::MultiPoint' THEN multi_point
WHEN 'GeographicItem::GeometryCollection' THEN geometry_collection
END".freeze

# ANTI_MERIDIAN = '0X0102000020E61000000200000000000000008066400000000000405640000000000080664000000000004056C0'
ANTI_MERIDIAN = 'LINESTRING (180 89.0, 180 -89)'.freeze

has_many :cached_map_items, inverse_of: :geographic_item

has_many :geographic_areas_geographic_items, dependent: :destroy, inverse_of: :geographic_item
has_many :geographic_areas, through: :geographic_areas_geographic_items
has_many :asserted_distributions, through: :geographic_areas
has_many :geographic_area_types, through: :geographic_areas
has_many :parent_geographic_areas, through: :geographic_areas, source: :parent

has_many :georeferences, inverse_of: :geographic_item
has_many :georeferences_through_error_geographic_item,
  class_name: 'Georeference', foreign_key: :error_geographic_item_id, inverse_of: :error_geographic_item
has_many :collecting_events_through_georeferences, through: :georeferences, source: :collecting_event
has_many :collecting_events_through_georeference_error_geographic_item,
  through: :georeferences_through_error_geographic_item, source: :collecting_event

# TODO: THIS IS NOT GOOD
before_validation :set_type_if_geography_present

validate :some_data_is_provided
validates :type, presence: true # not needed

scope :include_collecting_event, -> { includes(:collecting_events_through_georeferences) }
scope :geo_with_collecting_event, -> { joins(:collecting_events_through_georeferences) }
scope :err_with_collecting_event, -> { joins(:georeferences_through_error_geographic_item) }

after_save :set_cached, unless: Proc.new {|n| n.no_cached || errors.any? }
after_save :align_winding

class << self

  def aliased_geographic_sql(name = 'a')
    "CASE #{name}.type \
     WHEN 'GeographicItem::MultiPolygon' THEN #{name}.multi_polygon \
     WHEN 'GeographicItem::Point' THEN #{name}.point \
     WHEN 'GeographicItem::LineString' THEN #{name}.line_string \
     WHEN 'GeographicItem::Polygon' THEN #{name}.polygon \
     WHEN 'GeographicItem::MultiLineString' THEN #{name}.multi_line_string \
     WHEN 'GeographicItem::MultiPoint' THEN #{name}.multi_point \
     WHEN 'GeographicItem::GeometryCollection' THEN #{name}.geometry_collection \
     END"
  end

  def st_union(geographic_item_scope)
    GeographicItem.select("ST_Union(#{GeographicItem::GEOMETRY_SQL.to_sql}) as collection")
      .where(id: geographic_item_scope.pluck(:id))
  end

  def st_collect(geographic_item_scope)
    GeographicItem.select("ST_Collect(#{GeographicItem::GEOMETRY_SQL.to_sql}) as collection")
      .where(id: geographic_item_scope.pluck(:id))
  end

  # @return [GeographicItem::ActiveRecord_Relation]
  # @params [Array] array of geographic area ids
  def default_by_geographic_area_ids(geographic_area_ids = [])
    GeographicItem.
      joins(:geographic_areas_geographic_items).
      merge(::GeographicAreasGeographicItem.default_geographic_item_data).
      where(geographic_areas_geographic_items: {geographic_area_id: geographic_area_ids})
  end

  # @param [String] wkt
  # @return [Boolean]
  #   whether or not the wtk intersects with the anti-meridian
  #   !! StrongParams security considerations
  def crosses_anti_meridian?(wkt)
    GeographicItem.find_by_sql(
      ['SELECT ST_Intersects(ST_GeogFromText(?), ST_GeogFromText(?)) as r;', wkt, ANTI_MERIDIAN]
    ).first.r
  end

  # @param [Integer] ids
  # @return [Boolean]
  #   whether or not any GeographicItem passed intersects the anti-meridian
  #   !! StrongParams security considerations
  #   This is our first line of defense against queries that define multiple shapes, one or
  #   more of which crosses the anti-meridian.  In this case the current TW strategy within the
  #   UI is to abandon the search, and prompt the user to refactor the query.
  def crosses_anti_meridian_by_id?(*ids)
    q1 = ["SELECT ST_Intersects((SELECT single_geometry FROM (#{GeographicItem.single_geometry_sql(*ids)}) as " \
          'left_intersect), ST_GeogFromText(?)) as r;', ANTI_MERIDIAN]
    _q2 = ActiveRecord::Base.send(:sanitize_sql_array, ['SELECT ST_Intersects((SELECT single_geometry FROM (?) as ' \
                                                        'left_intersect), ST_GeogFromText(?)) as r;', GeographicItem.single_geometry_sql(*ids), ANTI_MERIDIAN])
    GeographicItem.find_by_sql(q1).first.r
  end

  #
  # SQL fragments
  #

  # @param [Integer, String]
  # @return [String]
  #   a SQL select statement that returns the *geometry* for the geographic_item with the specified id
  def select_geometry_sql(geographic_item_id)
    "SELECT #{GeographicItem::GEOMETRY_SQL.to_sql} from geographic_items where geographic_items.id = #{geographic_item_id}"
  end

  # @param [Integer, String]
  # @return [String]
  #   a SQL select statement that returns the geography for the geographic_item with the specified id
  def select_geography_sql(geographic_item_id)
    ActiveRecord::Base.send(:sanitize_sql_for_conditions, [
      "SELECT #{GeographicItem::GEOMETRY_SQL.to_sql} from geographic_items where geographic_items.id = ?",
      geographic_item_id])
  end

  # @param [Symbol] choice
  # @return [String]
  #   a fragment returning either latitude or longitude columns
  def lat_long_sql(choice)
    return nil unless [:latitude, :longitude].include?(choice)
    f = "'D.DDDDDD'" # TODO: probably a constant somewhere
    v = (choice == :latitude ? 1 : 2)
    "CASE geographic_items.type
  WHEN 'GeographicItem::GeometryCollection' THEN split_part(ST_AsLatLonText(ST_Centroid" \
  "(geometry_collection::geometry), #{f}), ' ', #{v})
  WHEN 'GeographicItem::LineString' THEN split_part(ST_AsLatLonText(ST_Centroid(line_string::geometry), " \
  "#{f}), ' ', #{v})
  WHEN 'GeographicItem::MultiPolygon' THEN split_part(ST_AsLatLonText(" \
  "ST_Centroid(multi_polygon::geometry), #{f}), ' ', #{v})
  WHEN 'GeographicItem::Point' THEN split_part(ST_AsLatLonText(" \
  "ST_Centroid(point::geometry), #{f}), ' ', #{v})
  WHEN 'GeographicItem::Polygon' THEN split_part(ST_AsLatLonText(" \
  "ST_Centroid(polygon::geometry), #{f}), ' ', #{v})
  WHEN 'GeographicItem::MultiLineString' THEN split_part(ST_AsLatLonText(" \
  "ST_Centroid(multi_line_string::geometry), #{f} ), ' ', #{v})
  WHEN 'GeographicItem::MultiPoint' THEN split_part(ST_AsLatLonText(" \
  "ST_Centroid(multi_point::geometry), #{f}), ' ', #{v})
END as #{choice}"
  end

  # @param [Integer] geographic_item_id
  # @param [Integer] distance
  # @return [String]
  def within_radius_of_item_sql(geographic_item_id, distance)
    "ST_DWithin((#{GeographicItem::GEOGRAPHY_SQL}), (#{select_geography_sql(geographic_item_id)}), #{distance})"
  end


  # @param [Integer] geographic_item_id
  # @param [Number] distance in meters to grow/shrink the shape (negative allowed)
  # @param [Number] distance (in meters) (positive only?!)
  # @return [String]
  def st_buffer_st_within(geographic_item_id, distance, buffer = 0)
    "ST_DWithin(
    ST_Buffer(#{GeographicItem::GEOGRAPHY_SQL}, #{buffer}),
    (#{select_geography_sql(geographic_item_id)}), #{distance}
   )"
  end


  # TODO: 3D is overkill here
  # @param [String] wkt
  # @param [Integer] distance (meters)
  # @return [String]
  # !! This is intersecting
  def intersecting_radius_of_wkt_sql(wkt, distance)
    "ST_DWithin((#{GeographicItem::GEOGRAPHY_SQL}), ST_Transform( ST_GeomFromText('#{wkt}', " \
      "4326), 4326), #{distance})"
  end

  # @param [String] wkt
  # @param [Integer] distance (meters)
  # @return [String]
  # !! This is fully covering
  def within_radius_of_wkt_sql(wkt, distance)
    "ST_Covers( ST_Buffer(ST_SetSRID( ST_GeomFromText('#{wkt}'), 4326)::geography, #{distance}), (#{GeographicItem::GEOGRAPHY_SQL}))"
  end

  # @param [String, Integer, String]
  # @return [String]
  #   a SQL fragment for ST_Contains() function, returns
  #   all geographic items which are contained in the item supplied
  def containing_sql(target_column_name = nil, geographic_item_id = nil, source_column_name = nil)
    return 'false' if geographic_item_id.nil? || source_column_name.nil? || target_column_name.nil?
    "ST_Contains(#{target_column_name}::geometry, (#{geometry_sql(geographic_item_id, source_column_name)}))"
  end

  # @param [String, Integer, String]
  # @return [String]
  #   a SQL fragment for ST_Contains(), returns
  #   all geographic_items which contain the supplied geographic_item
  def reverse_containing_sql(target_column_name = nil, geographic_item_id = nil, source_column_name = nil)
    return 'false' if geographic_item_id.nil? || source_column_name.nil? || target_column_name.nil?
    "ST_Contains((#{geometry_sql(geographic_item_id, source_column_name)}), #{target_column_name}::geometry)"
  end

  # @param [Integer, String]
  # @return [String]
  #   a SQL fragment that represents the geometry of the geographic item specified (which has data in the
  # source_column_name, i.e. geo_object_type)
  def geometry_sql(geographic_item_id = nil, source_column_name = nil)
    return 'false' if geographic_item_id.nil? || source_column_name.nil?
    "select geom_alias_tbl.#{source_column_name}::geometry from geographic_items geom_alias_tbl " \
      "where geom_alias_tbl.id = #{geographic_item_id}"
  end

  # rubocop:disable Metrics/MethodLength
  # @param [String] column_name
  # @param [GeographicItem] geographic_item
  # @return [String] of SQL
  def is_contained_by_sql(column_name, geographic_item)
    geo_id = geographic_item.id
    geo_type = geographic_item.geo_object_type
    template = '(ST_Contains((select geographic_items.%s::geometry from geographic_items where ' \
      'geographic_items.id = %d), %s::geometry))'
    retval = []
    column_name.downcase!
    case column_name
    when 'any'
      DATA_TYPES.each { |column|
        unless column == :geometry_collection
          retval.push(template % [geo_type, geo_id, column])
        end
      }
    when 'any_poly', 'any_line'
      DATA_TYPES.each { |column|
        unless column == :geometry_collection
          if column.to_s.index(column_name.gsub('any_', ''))
            retval.push(template % [geo_type, geo_id, column])
          end
        end
      }
    else
      retval = template % [geo_type, geo_id, column_name]
    end
    retval = retval.join(' OR ') if retval.instance_of?(Array)
    retval
  end

  # @param [Interger, Array of Integer] geographic_item_ids
  # @return [String]
  #   a select query that returns a single geometry (column name 'single_geometry' for the collection of ids
  # provided via ST_Collect)
  def st_collect_sql(*geographic_item_ids)
    geographic_item_ids.flatten!
    ActiveRecord::Base.send(:sanitize_sql_for_conditions, [
      "SELECT ST_Collect(f.the_geom) AS single_geometry
 FROM (
    SELECT (ST_DUMP(#{GeographicItem::GEOMETRY_SQL.to_sql})).geom as the_geom
    FROM geographic_items
    WHERE id in (?))
  AS f", geographic_item_ids])
  end

  # @param [Interger, Array of Integer] geographic_item_ids
  # @return [String]
  #    returns one or more geographic items combined as a single geometry in column 'single'
  def single_geometry_sql(*geographic_item_ids)
    a = GeographicItem.st_collect_sql(geographic_item_ids)
    '(SELECT single.single_geometry FROM (' + a + ' ) AS single)'
  end

  # @param [Interger, Array of Integer] geographic_item_ids
  # @return [String]
  #   returns a single geometry "column" (paren wrapped) as "single" for multiple geographic item ids, or the
  # geometry as 'geometry' for a single id
  def geometry_sql2(*geographic_item_ids)
    geographic_item_ids.flatten! # *ALWAYS* reduce the pile to a single level of ids
    if geographic_item_ids.count == 1
      "(#{GeographicItem.geometry_for_sql(geographic_item_ids.first)})"
    else
      GeographicItem.single_geometry_sql(geographic_item_ids)
    end
  end

  # @param [Interger, Array of Integer] geographic_item_ids
  # @return [String]
  def containing_where_sql(*geographic_item_ids)
    "ST_CoveredBy(
      #{GeographicItem.geometry_sql2(*geographic_item_ids)},
       CASE geographic_items.type
         WHEN 'GeographicItem::MultiPolygon' THEN multi_polygon::geometry
         WHEN 'GeographicItem::Point' THEN point::geometry
         WHEN 'GeographicItem::LineString' THEN line_string::geometry
         WHEN 'GeographicItem::Polygon' THEN polygon::geometry
         WHEN 'GeographicItem::MultiLineString' THEN multi_line_string::geometry
         WHEN 'GeographicItem::MultiPoint' THEN multi_point::geometry
      END)"
  end

  # @param [Interger, Array of Integer] geographic_item_ids
  # @return [String]
  def containing_where_sql_geog(*geographic_item_ids)
    "ST_CoveredBy(
      #{GeographicItem.geometry_sql2(*geographic_item_ids)},
       CASE geographic_items.type
         WHEN 'GeographicItem::MultiPolygon' THEN multi_polygon::geography
         WHEN 'GeographicItem::Point' THEN point::geography
         WHEN 'GeographicItem::LineString' THEN line_string::geography
         WHEN 'GeographicItem::Polygon' THEN polygon::geography
         WHEN 'GeographicItem::MultiLineString' THEN multi_line_string::geography
         WHEN 'GeographicItem::MultiPoint' THEN multi_point::geography
      END)"
  end

  # @param [Interger, Array of Integer] ids
  # @return [Array]
  #   If we detect that some query id has crossed the meridian, then loop through
  #   and "manually" build up a list of results.
  #   Should only be used if GeographicItem.crosses_anti_meridian_by_id? is true.
  #   Note that this does not return a Scope, so you can't chain it like contained_by?
  # TODO: test this
  def contained_by_with_antimeridian_check(*ids)
    ids.flatten! # make sure there is only one level of splat (*)
    results = []

    crossing_ids = []

    ids.each do |id|
      # push each which crosses
      crossing_ids.push(id) if GeographicItem.crosses_anti_meridian_by_id?(id)
    end

    non_crossing_ids = ids - crossing_ids
    results.push GeographicItem.contained_by(non_crossing_ids).to_a if non_crossing_ids.any?

    crossing_ids.each do |id|
      # [61666, 61661, 61659, 61654, 61639]
      q1 = ActiveRecord::Base.send(:sanitize_sql_array, ['SELECT ST_AsText((SELECT polygon FROM geographic_items ' \
                                                         'WHERE id = ?))', id])
      r = GeographicItem.where(
        # GeographicItem.contained_by_wkt_shifted_sql(GeographicItem.find(id).geo_object.to_s)
        GeographicItem.contained_by_wkt_shifted_sql(
          ApplicationRecord.connection.execute(q1).first['st_astext'])
      ).to_a
      results.push(r)
    end

    results.flatten.uniq
  end

  # @params [String] well known text
  # @return [String] the SQL fragment for the specific geometry type, shifted by longitude
  # Note: this routine is called when it is already known that the A argument crosses anti-meridian
  def contained_by_wkt_shifted_sql(wkt)
    "ST_Contains(ST_ShiftLongitude(ST_GeomFromText('#{wkt}', 4326)), (
    CASE geographic_items.type
       WHEN 'GeographicItem::MultiPolygon' THEN ST_ShiftLongitude(multi_polygon::geometry)
       WHEN 'GeographicItem::Point' THEN ST_ShiftLongitude(point::geometry)
       WHEN 'GeographicItem::LineString' THEN ST_ShiftLongitude(line_string::geometry)
       WHEN 'GeographicItem::Polygon' THEN ST_ShiftLongitude(polygon::geometry)
       WHEN 'GeographicItem::MultiLineString' THEN ST_ShiftLongitude(multi_line_string::geometry)
       WHEN 'GeographicItem::MultiPoint' THEN ST_ShiftLongitude(multi_point::geometry)
    END
    )
  )"
  end

  # TODO: Remove the hard coded 4326 reference
  # @params [String] wkt
  # @return [String] SQL fragment limiting geographics items to those in this WKT
  def contained_by_wkt_sql(wkt)
    if crosses_anti_meridian?(wkt)
      retval = contained_by_wkt_shifted_sql(wkt)
    else
      retval = "ST_Contains(ST_GeomFromText('#{wkt}', 4326), (
    CASE geographic_items.type
       WHEN 'GeographicItem::MultiPolygon' THEN multi_polygon::geometry
       WHEN 'GeographicItem::Point' THEN point::geometry
       WHEN 'GeographicItem::LineString' THEN line_string::geometry
       WHEN 'GeographicItem::Polygon' THEN polygon::geometry
       WHEN 'GeographicItem::MultiLineString' THEN multi_line_string::geometry
       WHEN 'GeographicItem::MultiPoint' THEN multi_point::geometry
    END
    )
  )"
    end
    retval
  end

  # @param [Interger, Array of Integer] geographic_item_ids
  # @return [String] sql for contained_by via ST_ContainsProperly
  # Note: Can not use GEOMETRY_SQL because geometry_collection is not supported in ST_ContainsProperly
  # Note: !! If the target GeographicItem#id crosses the anti-meridian then you may/will get unexpected results.
  def contained_by_where_sql(*geographic_item_ids)
    "ST_Contains(
    #{GeographicItem.geometry_sql2(*geographic_item_ids)},
    CASE geographic_items.type
      WHEN 'GeographicItem::MultiPolygon' THEN multi_polygon::geometry
      WHEN 'GeographicItem::Point' THEN point::geometry
      WHEN 'GeographicItem::LineString' THEN line_string::geometry
      WHEN 'GeographicItem::Polygon' THEN polygon::geometry
      WHEN 'GeographicItem::MultiLineString' THEN multi_line_string::geometry
      WHEN 'GeographicItem::MultiPoint' THEN multi_point::geometry
    END)"
  end

  # @param [RGeo:Point] rgeo_point
  # @return [String] sql for containing via ST_CoveredBy
  # TODO: Remove the hard coded 4326 reference
  # TODO: should this be wkt_point instead of rgeo_point?
  def containing_where_for_point_sql(rgeo_point)
    "ST_CoveredBy(
  ST_GeomFromText('#{rgeo_point}', 4326),
  #{GeographicItem::GEOMETRY_SQL.to_sql}
 )"
  end

  # @param [Interger] geographic_item_id
  # @return [String] SQL for geometries
  # example, not used
  def geometry_for_sql(geographic_item_id)
    'SELECT ' + GeographicItem::GEOMETRY_SQL.to_sql + ' AS geometry FROM geographic_items WHERE id = ' \
      "#{geographic_item_id} LIMIT 1"
  end

  # @param [Interger, Array of Integer] geographic_item_ids
  # @return [String] SQL for geometries
  # example, not used
  def geometry_for_collection_sql(*geographic_item_ids)
    'SELECT ' + GeographicItem::GEOMETRY_SQL.to_sql + ' AS geometry FROM geographic_items WHERE id IN ' \
      "( #{geographic_item_ids.join(',')} )"
  end

  #
  # Scopes
  #

  # @param [Interger, Array of Integer] geographic_item_ids
  # @return [Scope]
  #    the geographic items containing these collective geographic_item ids, not including self
  def containing(*geographic_item_ids)
    where(GeographicItem.containing_where_sql(geographic_item_ids)).not_ids(*geographic_item_ids)
  end

  # @param [Interger, Array of Integer] geographic_item_ids
  # @return [Scope]
  #    the geographic items contained by any of these geographic_item ids, not including self
  # (works via ST_ContainsProperly)
  def contained_by(*geographic_item_ids)
    where(GeographicItem.contained_by_where_sql(geographic_item_ids))
  end

  # @param [RGeo::Point] rgeo_point
  # @return [Scope]
  #    the geographic items containing this point
  # TODO: should be containing_wkt ?
  def containing_point(rgeo_point)
    where(GeographicItem.containing_where_for_point_sql(rgeo_point))
  end

  # @return [Scope]
  #   adds an area_in_meters field, with meters
  def with_area
    select("ST_Area(#{GeographicItem::GEOGRAPHY_SQL}, false) as area_in_meters")
  end

  # return [Scope]
  #   A scope that limits the result to those GeographicItems that have a collecting event
  #   through either the geographic_item or the error_geographic_item
  #
  # A raw SQL join approach for comparison
  #
  # GeographicItem.joins('LEFT JOIN georeferences g1 ON geographic_items.id = g1.geographic_item_id').
  #   joins('LEFT JOIN georeferences g2 ON geographic_items.id = g2.error_geographic_item_id').
  #   where("(g1.geographic_item_id IS NOT NULL OR g2.error_geographic_item_id IS NOT NULL)").uniq

  # @return [Scope] GeographicItem
  # This uses an Arel table approach, this is ultimately more decomposable if we need. Of use:
  #  http://danshultz.github.io/talks/mastering_activerecord_arel  <- best
  #  https://github.com/rails/arel
  #  http://stackoverflow.com/questions/4500629/use-arel-for-a-nested-set-join-query-and-convert-to-activerecordrelation
  #  http://rdoc.info/github/rails/arel/Arel/SelectManager
  #  http://stackoverflow.com/questions/7976358/activerecord-arel-or-condition
  #
  def with_collecting_event_through_georeferences
    geographic_items = GeographicItem.arel_table
    georeferences = Georeference.arel_table
    g1 = georeferences.alias('a')
    g2 = georeferences.alias('b')

    c = geographic_items.join(g1, Arel::Nodes::OuterJoin).on(geographic_items[:id].eq(g1[:geographic_item_id]))
      .join(g2, Arel::Nodes::OuterJoin).on(geographic_items[:id].eq(g2[:error_geographic_item_id]))

    GeographicItem.joins(# turn the Arel back into scope
                         c.join_sources # translate the Arel join to a join hash(?)
                        ).where(
                          g1[:id].not_eq(nil).or(g2[:id].not_eq(nil)) # returns a Arel::Nodes::Grouping
                        ).distinct
  end

  # @return [Scope] include a 'latitude' column
  def with_latitude
    select(lat_long_sql(:latitude))
  end

  # @return [Scope] include a 'longitude' column
  def with_longitude
    select(lat_long_sql(:longitude))
  end

  # @param [String, GeographicItems]
  # @return [Scope]
  def intersecting(column_name, *geographic_items)
    if column_name.downcase == 'any'
      pieces = []
      DATA_TYPES.each { |column|
        pieces.push(GeographicItem.intersecting(column.to_s, geographic_items).to_a)
      }

      # @TODO change 'id in (?)' to some other sql construct

      GeographicItem.where(id: pieces.flatten.map(&:id))
    else
      q = geographic_items.flatten.collect { |geographic_item|
        "ST_Intersects(#{column_name}, '#{geographic_item.geo_object}'    )" # seems like we want this: http://danshultz.github.io/talks/mastering_activerecord_arel/#/15/2
      }.join(' or ')

      where(q)
    end
  end

  # @param [GeographicItem#id] geographic_item_id
  # @param [Float] distance in meters ?!?!
  # @return [ActiveRecord::Relation]
  # !! should be distance, not radius?!
  def within_radius_of_item(geographic_item_id, distance)
    where(within_radius_of_item_sql(geographic_item_id, distance))
  end

  # @param [String, GeographicItem]
  # @return [Scope]
  #   a SQL fragment for ST_DISJOINT, specifies all geographic_items that have data in column_name
  #   that are disjoint from the passed geographic_items
  def disjoint_from(column_name, *geographic_items)
    q = geographic_items.flatten.collect { |geographic_item|
      "ST_DISJOINT(#{column_name}::geometry, (#{geometry_sql(geographic_item.to_param,
                                                         geographic_item.geo_object_type)}))"
    }.join(' and ')

    where(q)
  end

  # @return [Scope]
  #   see are_contained_in_item_by_id
  # @param [String] column_name
  # @param [GeographicItem, Array] geographic_items
  def are_contained_in_item(column_name, *geographic_items)
    are_contained_in_item_by_id(column_name, geographic_items.flatten.map(&:id))
  end

  # rubocop:disable Metrics/MethodLength
  # @param [String] column_name to search
  # @param [GeographicItem] geographic_item_ids or array of geographic_item_ids to be tested.
  # @return [Scope] of GeographicItems
  #
  # If this scope is given an Array of GeographicItems as a second parameter,
  # it will return the 'OR' of each of the objects against the table.
  # SELECT COUNT(*) FROM "geographic_items"
  #        WHERE (ST_Contains(polygon::geometry, GeomFromEWKT('srid=4326;POINT (0.0 0.0 0.0)'))
  #               OR ST_Contains(polygon::geometry, GeomFromEWKT('srid=4326;POINT (-9.8 5.0 0.0)')))
  #
  def are_contained_in_item_by_id(column_name, *geographic_item_ids) # = containing
    geographic_item_ids.flatten! # in case there is a array of arrays, or multiple objects
    column_name.downcase!
    case column_name
    when 'any'
      part = []
      DATA_TYPES.each { |column|
        unless column == :geometry_collection
          part.push(GeographicItem.are_contained_in_item_by_id(column.to_s, geographic_item_ids).to_a)
        end
      }
      # TODO: change 'id in (?)' to some other sql construct
      GeographicItem.where(id: part.flatten.map(&:id))
    when 'any_poly', 'any_line'
      part = []
      DATA_TYPES.each { |column|
        if column.to_s.index(column_name.gsub('any_', ''))
          part.push(GeographicItem.are_contained_in_item_by_id("#{column}", geographic_item_ids).to_a)
        end
      }
      # TODO: change 'id in (?)' to some other sql construct
      GeographicItem.where(id: part.flatten.map(&:id))
    else
      q = geographic_item_ids.flatten.collect { |geographic_item_id|
        # discover the item types, and convert type to database type for 'multi_'
        b = GeographicItem.where(id: geographic_item_id)
          .pluck(:type)[0].split(':')[2].downcase.gsub('lti', 'lti_')
        # a = GeographicItem.find(geographic_item_id).geo_object_type
        GeographicItem.containing_sql(column_name, geographic_item_id, b)
      }.join(' or ')
      q = 'FALSE' if q.blank? # this will prevent the invocation of *ALL* of the GeographicItems, if there are
      # no GeographicItems in the request (see CollectingEvent.name_hash(types)).
      where(q) # .not_including(geographic_items)
    end
  end

  # rubocop:enable Metrics/MethodLength

  # @param [String] column_name
  # @param [String] geometry of WKT
  # @return [Scope]
  # a single WKT geometry is compared against column or columns (except geometry_collection) to find geographic_items
  # which are contained in the WKT
  def are_contained_in_wkt(column_name, geometry)
    column_name.downcase!
    # column_name = 'point'
    case column_name
    when 'any'
      part = []
      DATA_TYPES.each { |column|
        unless column == :geometry_collection
          part.push(GeographicItem.are_contained_in_wkt(column.to_s, geometry).pluck(:id).to_a)
        end
      }
      # TODO: change 'id in (?)' to some other sql construct
      GeographicItem.where(id: part.flatten)
    when 'any_poly', 'any_line'
      part = []
      DATA_TYPES.each { |column|
        if column.to_s.index(column_name.gsub('any_', ''))
          part.push(GeographicItem.are_contained_in_wkt("#{column}", geometry).pluck(:id).to_a)
        end
      }
      # TODO: change 'id in (?)' to some other sql construct
      GeographicItem.where(id: part.flatten)
    else
      # column = points, geometry = square
      q = "ST_Contains(ST_GeomFromEWKT('srid=4326;#{geometry}'), #{column_name}::geometry)"
      where(q) # .not_including(geographic_items)
    end
  end

  # rubocop:disable Metrics/MethodLength
  #    containing the items the shape of which is contained in the geographic_item[s] supplied.
  # @param column_name [String] can be any of DATA_TYPES, or 'any' to check against all types, 'any_poly' to check
  # against 'polygon' or 'multi_polygon', or 'any_line' to check against 'line_string' or 'multi_line_string'.
  #  CANNOT be 'geometry_collection'.
  # @param geographic_items [GeographicItem] Can be a single GeographicItem, or an array of GeographicItem.
  # @return [Scope]
  def is_contained_by(column_name, *geographic_items)
    column_name.downcase!
    case column_name
    when 'any'
      part = []
      DATA_TYPES.each { |column|
        unless column == :geometry_collection
          part.push(GeographicItem.is_contained_by(column.to_s, geographic_items).to_a)
        end
      }
      # @TODO change 'id in (?)' to some other sql construct
      GeographicItem.where(id: part.flatten.map(&:id))

    when 'any_poly', 'any_line'
      part = []
      DATA_TYPES.each { |column|
        unless column == :geometry_collection
          if column.to_s.index(column_name.gsub('any_', ''))
            part.push(GeographicItem.is_contained_by(column.to_s, geographic_items).to_a)
          end
        end
      }
      # @TODO change 'id in (?)' to some other sql construct
      GeographicItem.where(id: part.flatten.map(&:id))

    else
      q = geographic_items.flatten.collect { |geographic_item|
        GeographicItem.reverse_containing_sql(column_name, geographic_item.to_param,
                                              geographic_item.geo_object_type)
      }.join(' or ')
      where(q) # .not_including(geographic_items)
    end
  end

  # rubocop:enable Metrics/MethodLength

  # @param [String, GeographicItem]
  # @return [Scope]
  def ordered_by_shortest_distance_from(column_name, geographic_item)
    if true # check_geo_params(column_name, geographic_item)
      select_distance_with_geo_object(column_name, geographic_item)
        .where_distance_greater_than_zero(column_name, geographic_item).order('distance')
    else
      where('false')
    end
  end

  # @param [String, GeographicItem]
  # @return [Scope]
  def ordered_by_longest_distance_from(column_name, geographic_item)
    if true # check_geo_params(column_name, geographic_item)
      q = select_distance_with_geo_object(column_name, geographic_item)
        .where_distance_greater_than_zero(column_name, geographic_item)
        .order('distance desc')
      q
    else
      where('false')
    end
  end

  # @param [String] column_name
  # @param [GeographicItem] geographic_item
  # @return [String]
  def select_distance_with_geo_object(column_name, geographic_item)
    select("*, ST_Distance(#{column_name}, GeomFromEWKT('srid=4326;#{geographic_item.geo_object}')) as distance")
  end

  # @param [String, GeographicItem]
  # @return [Scope]
  def where_distance_greater_than_zero(column_name, geographic_item)
    where("#{column_name} is not null and ST_Distance(#{column_name}, " \
          "GeomFromEWKT('srid=4326;#{geographic_item.geo_object}')) > 0")
  end

  # @param [GeographicItem]
  # @return [Scope]
  def not_including(geographic_items)
    where.not(id: geographic_items)
  end

  # @return [Scope]
  #   includes an 'is_valid' attribute (True/False) for the passed geographic_item.  Uses St_IsValid.
  # @param [RGeo object] geographic_item
  def with_is_valid_geometry_column(geographic_item)
    where(id: geographic_item.id).select("ST_IsValid(ST_AsBinary(#{geographic_item.geo_object_type})) is_valid")
  end

  #
  # Other
  #

  # @param [Integer] geographic_item_id1
  # @param [Integer] geographic_item_id2
  # @return [Float]
  def distance_between(geographic_item_id1, geographic_item_id2)
    q1 = "ST_Distance(#{GeographicItem::GEOGRAPHY_SQL}, " \
      "(#{select_geography_sql(geographic_item_id2)})) as distance"
    _q2 = ActiveRecord::Base.send(
      :sanitize_sql_array, ['ST_Distance(?, (?)) as distance',
                            GeographicItem::GEOGRAPHY_SQL,
                            select_geography_sql(geographic_item_id2)])
    GeographicItem.where(id: geographic_item_id1).pluck(Arel.sql(q1)).first
  end

  # @param [RGeo::Point] point
  # @return [Hash]
  #   as per #inferred_geographic_name_hierarchy but for Rgeo point
  def point_inferred_geographic_name_hierarchy(point)
    GeographicItem.containing_point(point).order(cached_total_area: :ASC).limit(1).first&.inferred_geographic_name_hierarchy
  end

  # @param [String] type_name ('polygon', 'point', 'line' [, 'circle'])
  # @return [String] if type
  def eval_for_type(type_name)
    retval = 'GeographicItem'
    case type_name.upcase
    when 'POLYGON'
      retval += '::Polygon'
    when 'LINESTRING'
      retval += '::LineString'
    when 'POINT'
      retval += '::Point'
    when 'MULTIPOLYGON'
      retval += '::MultiPolygon'
    when 'MULTILINESTRING'
      retval += '::MultiLineString'
    when 'MULTIPOINT'
      retval += '::MultiPoint'
    else
      retval = nil
    end
    retval
  end

  # example, not used
  # @param [Integer] geographic_item_id
  # @return [RGeo::Geographic object]
  def geometry_for(geographic_item_id)
    GeographicItem.select(GeographicItem::GEOMETRY_SQL.to_sql + ' AS geometry').find(geographic_item_id)['geometry']
  end

  # example, not used
  # @param [Integer, Array] geographic_item_ids
  # @return [Scope]
  def st_multi(*geographic_item_ids)
    GeographicItem.find_by_sql(
      "SELECT ST_Multi(ST_Collect(g.the_geom)) AS singlegeom
 FROM (
    SELECT (ST_DUMP(#{GeographicItem::GEOMETRY_SQL.to_sql})).geom AS the_geom
    FROM geographic_items
    WHERE id IN (?))
  AS g;", geographic_item_ids.flatten
    )
  end
end # class << self

# @return [Hash]
#    a geographic_name_classification or empty Hash
# This is a quick approach that works only when
# the geographic_item is linked explicitly to a GeographicArea.
#
# !! Note that it is not impossible for a GeographicItem to be linked
# to > 1 GeographicArea, in that case we are assuming that all are
# equally refined, this might not be the case in the future because
# of how the GeographicArea gazetteer is indexed.
def quick_geographic_name_hierarchy
  geographic_areas.order(:id).each do |ga|
    h = ga.geographic_name_classification # not quick enough !!
    return h if h.present?
  end
  return  {}
end

# @return [Hash]
#   a geographic_name_classification (see GeographicArea) inferred by
# finding the smallest area containing this GeographicItem, in the most accurate gazetteer
# and using it to return country/state/county. See also the logic in
# filling in missing levels in GeographicArea.
def inferred_geographic_name_hierarchy
  if small_area = containing_geographic_areas
    .joins(:geographic_areas_geographic_items)
    .merge(GeographicAreasGeographicItem.ordered_by_data_origin)
    .ordered_by_area
    .limit(1)
    .first
  return small_area.geographic_name_classification
  else
    {}
  end
end

def geographic_name_hierarchy
  a = quick_geographic_name_hierarchy # quick; almost never the case, UI not setup to do this
  return a if a.present?
  inferred_geographic_name_hierarchy # slow
end

# @return [Scope]
#   the Geographic Areas that contain (gis) this geographic item
def containing_geographic_areas
  GeographicArea.joins(:geographic_items).includes(:geographic_area_type)
    .joins("JOIN (#{GeographicItem.containing(id).to_sql}) j on geographic_items.id = j.id")
end

# @return [Boolean]
#   whether stored shape is ST_IsValid
def valid_geometry?
  GeographicItem.with_is_valid_geometry_column(self).first['is_valid']
end

# @return [Array of latitude, longitude]
#    the lat, lon of the first point in the GeoItem, see subclass for #st_start_point
def start_point
  o = st_start_point
  [o.y, o.x]
end

# @return [Array]
#   the lat, long, as STRINGs for the centroid of this geographic item
#   Meh- this: https://postgis.net/docs/en/ST_MinimumBoundingRadius.html
def center_coords
  r = GeographicItem.find_by_sql(
    "Select split_part(ST_AsLatLonText(ST_Centroid(#{GeographicItem::GEOMETRY_SQL.to_sql}), " \
    "'D.DDDDDD'), ' ', 1) latitude, split_part(ST_AsLatLonText(ST_Centroid" \
    "(#{GeographicItem::GEOMETRY_SQL.to_sql}), 'D.DDDDDD'), ' ', 2) " \
    "longitude from geographic_items where id = #{id};")[0]

  [r.latitude, r.longitude]
end

# @return [RGeo::Geographic::ProjectedPointImpl]
#    representing the centroid of this geographic item
def centroid
  # Gis::FACTORY.point(*center_coords.reverse)
  return geo_object if type == 'GeographicItem::Point'
  return Gis::FACTORY.parse_wkt(self.st_centroid)
end

# @param [Integer] geographic_item_id
# @return [Double] distance in meters (slower, more accurate)
def st_distance(geographic_item_id) # geo_object
  q1 = "ST_Distance((#{GeographicItem.select_geography_sql(id)}), " \
    "(#{GeographicItem.select_geography_sql(geographic_item_id)})) as d"
  _q2 = ActiveRecord::Base.send(:sanitize_sql_array, ['ST_Distance((?),(?)) as d',
                                                      GeographicItem.select_geography_sql(self.id),
                                                      GeographicItem.select_geography_sql(geographic_item_id)])
  deg = GeographicItem.where(id:).pluck(Arel.sql(q1)).first
  deg * Utilities::Geo::ONE_WEST
end

# @param [GeographicItem] geographic_item
# @return [Double] distance in meters
# Like st_distance but works with changed and non persisted objects
def st_distance_to_geographic_item(geographic_item)
  unless !persisted? || changed?
    a = "(#{GeographicItem.select_geography_sql(id)})"
  else
    a = "ST_GeographyFromText('#{geo_object}')"
  end

  unless !geographic_item.persisted? || geographic_item.changed?
    b = "(#{GeographicItem.select_geography_sql(geographic_item.id)})"
  else
    b = "ST_GeographyFromText('#{geographic_item.geo_object}')"
  end

  ActiveRecord::Base.connection.select_value("SELECT ST_Distance(#{a}, #{b})")
end

alias_method :distance_to, :st_distance

# @param [Integer] geographic_item_id
# @return [Double] distance in meters (faster, less accurate)
def st_distance_spheroid(geographic_item_id)
  q1 = "ST_DistanceSpheroid((#{GeographicItem.select_geometry_sql(id)})," \
    "(#{GeographicItem.select_geometry_sql(geographic_item_id)}),'#{Gis::SPHEROID}') as distance"
  _q2 = ActiveRecord::Base.send(:sanitize_sql_array,
                                ['ST_DistanceSpheroid((?),(?),?) as distance',
                                 GeographicItem.select_geometry_sql(id),
                                 GeographicItem.select_geometry_sql(geographic_item_id),
                                 Gis::SPHEROID])
  # TODO: what is _q2?
  GeographicItem.where(id:).pluck(Arel.sql(q1)).first
end

# @return [String]
#   a WKT POINT representing the centroid of the geographic item
def st_centroid
  GeographicItem.where(id: to_param).pluck(Arel.sql("ST_AsEWKT(ST_Centroid(#{GeographicItem::GEOMETRY_SQL.to_sql}))")).first.gsub(/SRID=\d*;/, '')
end

# @return [Integer]
#   the number of points in the geometry
def st_npoints
  GeographicItem.where(id:).pluck(Arel.sql("ST_NPoints(#{GeographicItem::GEOMETRY_SQL.to_sql}) as npoints")).first
end

# @return [Symbol]
#   the geo type (i.e. column like :point, :multipolygon).  References the first-found object,
# according to the list of DATA_TYPES, or nil
def geo_object_type
  if self.class.name == 'GeographicItem' # a proxy check for new records
    geo_type
  else
    self.class::SHAPE_COLUMN
  end
end

# !!TODO: migrate these to use native column calls

# @return [RGeo instance, nil]
#  the Rgeo shape (See http://rubydoc.info/github/dazuma/rgeo/RGeo/Feature)
def geo_object
  begin
    if r = geo_object_type # rubocop:disable Lint/AssignmentInCondition
      send(r)
    else
      false
    end
  rescue RGeo::Error::InvalidGeometry
    return nil # TODO: we need to render proper error for this!
  end
end

# @param [geo_object]
# @return [Boolean]
def contains?(target_geo_object)
  return nil if target_geo_object.nil?
  self.geo_object.contains?(target_geo_object)
end

# @param [geo_object]
# @return [Boolean]
def within?(target_geo_object)
  self.geo_object.within?(target_geo_object)
end

# @param [geo_object]
# @return [Boolean]
def intersects?(target_geo_object)
  self.geo_object.intersects?(target_geo_object)
end

# @param [geo_object, Double]
# @return [Boolean]
def near(target_geo_object, distance)
  self.geo_object.unsafe_buffer(distance).contains?(target_geo_object)
end

# @param [geo_object, Double]
# @return [Boolean]
def far(target_geo_object, distance)
  !near(target_geo_object, distance)
end

# @return [GeoJSON hash]
#    via Rgeo apparently necessary for GeometryCollection
def rgeo_to_geo_json
  RGeo::GeoJSON.encode(geo_object).to_json
end

# @return [Hash]
#   in GeoJSON format
#   Computed via "raw" PostGIS (much faster). This
#   requires the geo_object_type and id.
#
def to_geo_json
  JSON.parse(
    GeographicItem.connection.select_one(
      "SELECT ST_AsGeoJSON(#{geo_object_type}::geometry) a " \
      "FROM geographic_items WHERE id=#{id};")['a'])
end

# We don't need to serialize to/from JSON
def to_geo_json_string
  GeographicItem.connection.select_one(
    "SELECT ST_AsGeoJSON(#{geo_object_type}::geometry) a " \
    "FROM geographic_items WHERE id=#{id};")['a']
end

# @return [Hash]
#   the shape as a GeoJSON Feature with some item metadata
def to_geo_json_feature
  @geometry ||= to_geo_json
  {'type' => 'Feature',
   'geometry' => geometry,
   'properties' => {
     'geographic_item' => {
       'id' => id}
   }
  }
end

# @param value [String] like:
#   '{"type":"Feature","geometry":{"type":"Point","coordinates":[2.5,4.0]},"properties":{"color":"red"}}'
#
#   '{"type":"Feature","geometry":{"type":"Polygon","coordinates":"[[[-125.29394388198853, 48.584480409793],
#      [-67.11035013198853, 45.09937589848195],[-80.64550638198853, 25.01924647619111],[-117.55956888198853,
#      32.5591595028449],[-125.29394388198853, 48.584480409793]]]"},"properties":{}}'
#
#  '{"type":"Point","coordinates":[2.5,4.0]},"properties":{"color":"red"}}'
#
# @return [Boolean, RGeo object]
def shape=(value)

  if value.present?
    geom = RGeo::GeoJSON.decode(value, json_parser: :json, geo_factory: Gis::FACTORY)
    this_type = nil

    if geom.respond_to?(:geometry_type)
      this_type = geom.geometry_type.to_s
    elsif geom.respond_to?(:geometry)
      this_type = geom.geometry.geometry_type.to_s
    else
    end

    self.type = GeographicItem.eval_for_type(this_type) unless geom.nil?

    if type.blank?
      errors.add(:base, 'type is not set from shape')
      return
    end
    # raise('GeographicItem.type not set.') if type.blank?

    object = nil

    s = geom.respond_to?(:geometry) ? geom.geometry.to_s : geom.to_s

    begin
      object = Gis::FACTORY.parse_wkt(s)
    rescue RGeo::Error::InvalidGeometry
      errors.add(:self, 'Shape value is an Invalid Geometry')
    end

    write_attribute(this_type.underscore.to_sym, object)
    geom
  end
end

# @return [String]
def to_wkt
  #  10k  #<Benchmark::Tms:0x00007fb0dfd30fd0 @label="", @real=25.237487000005785, @cstime=0.0, @cutime=0.0, @stime=1.1704609999999995, @utime=5.507929999999988, @total=6.678390999999987>
  #  GeographicItem.select("ST_AsText( #{GeographicItem::GEOMETRY_SQL.to_sql}) wkt").where(id: id).first.wkt

  # 10k <Benchmark::Tms:0x00007fb0e02f7540 @label="", @real=21.619827999995323, @cstime=0.0, @cutime=0.0, @stime=0.8850890000000007, @utime=3.2958549999999605, @total=4.180943999999961>
  if a =  ApplicationRecord.connection.execute( "SELECT ST_AsText( #{GeographicItem::GEOMETRY_SQL.to_sql} ) wkt from geographic_items where geographic_items.id = #{id}").first
    return a['wkt']
  else
    return nil
  end
end

# @return  [Float] in meters, calculated
# TODO: share with world
#    Geographic item 96862 (Cajamar in Brazil) is the only(?) record to fail using `false` (quicker) method of everything we tested
def area
  a = GeographicItem.where(id:).select("ST_Area(#{GeographicItem::GEOGRAPHY_SQL}, true) as area_in_meters").first['area_in_meters']
  a = nil if a.nan?
  a
end

# @return [Float, false]
#    the value in square meters of the interesecting area of this and another GeographicItem
def intersecting_area(geographic_item_id)
  a = GeographicItem.aliased_geographic_sql('a')
  b = GeographicItem.aliased_geographic_sql('b')

  c = GeographicItem.connection.execute(
    "SELECT ST_Area(ST_Intersection(#{a}, #{b})) as intersecting_area
      FROM geographic_items a, geographic_items b
      WHERE a.id = #{id} AND b.id = #{geographic_item_id};"
  ).first
  c && c['intersecting_area'].to_f
end

# TODO: This is bad, while internal use of ONE_WEST_MEAN is consistent it is in-accurate given the vast differences of radius vs. lat/long position.
# When we strike the error-polygon from radius we should remove this
#
# Use case is returning the radius from a circle we calculated via buffer for error-polygon creation.
def radius
  r = ApplicationRecord.connection.execute( "SELECT ST_MinimumBoundingRadius( ST_Transform(  #{GeographicItem::GEOMETRY_SQL.to_sql}, 4326 )  ) AS radius from geographic_items where geographic_items.id = #{id}").first['radius'].split(',').last.chop.to_f
  r = (r * Utilities::Geo::ONE_WEST_MEAN).to_i
end


# Convention is to store in PostGIS in CCW
# @return Array [Boolean]
#   false - cw
#   true - ccw (preferred), except cee donuts
def orientations
  if multi_polygon.present?
    ApplicationRecord.connection.execute(" \
         SELECT ST_IsPolygonCCW(a.geom) as is_ccw
            FROM ( SELECT b.id, (ST_Dump(p_geom)).geom AS geom
               FROM (SELECT id, multi_polygon::geometry AS p_geom FROM geographic_items where id = #{id}) AS b \
          ) AS a;").collect{|a| a['is_ccw']}
  elsif polygon.present?
    ApplicationRecord.connection.execute("SELECT ST_IsPolygonCCW(polygon::geometry) as is_ccw \
            FROM geographic_items where  id = #{id};").collect{|a| a['is_ccw']}
  else
    []
  end
end

# @return Boolean
#   looks at all orientations
#   if they follow the pattern [true, false, ... <all false>] then `true`, else `false`
# !! Does not confirm that shapes are nested !!
def is_basic_donut?
  a = orientations
  b = a.shift
  return false unless b
  a.uniq!
  a == [false]
end

def st_isvalid
  r = ApplicationRecord.connection.execute( "SELECT ST_IsValid(  #{GeographicItem::GEOMETRY_SQL.to_sql }) from  geographic_items where geographic_items.id = #{id}").first['st_isvalid']
end

def st_isvalidreason
  r = ApplicationRecord.connection.execute( "SELECT ST_IsValidReason(  #{GeographicItem::GEOMETRY_SQL.to_sql }) from  geographic_items where geographic_items.id = #{id}").first['st_isvalidreason']
end

# !! Unused. Doesn't check Geometry collection
def has_polygons?
  ['GeographicItem::MultiPolygon', 'GeographicItem::Polygon'].include?(self.type)
end

private

def align_winding
  if orientations.flatten.include?(false)
    case type
    when 'multi_polygon'
      ApplicationRecord.connection.execute(
        "UPDATE geographic_items set multi_polygon = ST_ForcePolygonCCW(multi_polygon::geometry) 
          WHERE id = #{self.id};"
       )
    when 'polygon'
     ApplicationRecord.connection.execute(
        "UPDATE geographic_items set polygon = ST_ForcePolygonCCW(polygon::geometry) 
          WHERE id = #{self.id};"
       )
    end     
  end
  true
end

# Crude debuging helper, write the shapes
# to a png
def self.debug_draw(geographic_item_ids = [])
  return false if geographic_item_ids.empty?

  sql = "SELECT ST_AsPNG(
     ST_AsRaster(
        (SELECT ST_Union(multi_polygon::geometry) from geographic_items where id IN (" + geographic_item_ids.join(',') + ")), 1920, 1080
    )
   ) png;"

  # ST_Buffer( multi_polygon::geometry, 0, 'join=bevel'),
  #     1920,
  #     1080)


  result = ActiveRecord::Base.connection.execute(sql).first['png']
  r = ActiveRecord::Base.connection.unescape_bytea(result)

  prefix = if geographic_item_ids.size > 10
             'multiple'
           else
             geographic_item_ids.join('_') + '_debug.draw.png'
           end

  n = prefix + '_debug.draw.png'

  # Open the file in binary write mode ("wb")
  File.open(n, 'wb') do |file|
    # Write the binary data to the file
    file.write(r)
  end
end

# def png

#   if ids = Otu.joins(:cached_map_items).first.cached_map_items.pluck(:geographic_item_id)

#     sql = "SELECT ST_AsPNG(
#    ST_AsRaster(
#        ST_Buffer( multi_polygon::geometry, 0, 'join=bevel'),
#            1024,
#            768)
#     ) png
#        from geographic_items where id IN (" + ids.join(',') + ');'

#     # hack, not the best way to unpack result
#     result = ActiveRecord::Base.connection.execute(sql).first['png']
#     r = ActiveRecord::Base.connection.unescape_bytea(result)

#     send_data r, filename: 'foo.png', type: 'imnage/png'

#   else
#     render json: {foo: false}
#   end
# end

def set_cached
  update_column(:cached_total_area, area)
end

# @return [Symbol]
#   returns the attribute (column name) containing data
#   nearly all methods should use #geo_object_type, not geo_type
def geo_type
  DATA_TYPES.each { |item|
    return item if send(item)
  }
  nil
end

# @return [Boolean, String] false if already set, or type to which it was set
def set_type_if_geography_present
  if type.blank?
    column = geo_type
    self.type = "GeographicItem::#{column.to_s.camelize}" if column
  end
end

# @param [RGeo::Point] point
# @return [Array] of a point
#   Longitude |, Latitude -
def point_to_a(point)
  data = []
  data.push(point.x, point.y)
  data
end

# @param [RGeo::Point] point
# @return [Hash] of a point
def point_to_hash(point)
  {points: [point_to_a(point)]}
end

# @param [RGeo::MultiPoint] multi_point
# @return [Array] of points
def multi_point_to_a(multi_point)
  data = []
  multi_point.each { |point|
    data.push([point.x, point.y])
  }
  data
end

# @return [Hash] of points
def multi_point_to_hash(_multi_point)
  # when we encounter a multi_point type, we only stick the points into the array, NOT it's identity as a group
  {points: multi_point_to_a(multi_point)}
end

# @param [Reo::LineString] line_string
# @return [Array] of points in the line
def line_string_to_a(line_string)
  data = []
  line_string.points.each { |point|
    data.push([point.x, point.y])
  }
  data
end

# @param [Reo::LineString] line_string
# @return [Hash] of points in the line
def line_string_to_hash(line_string)
  {lines: [line_string_to_a(line_string)]}
end

# @param [RGeo::Polygon] polygon
# @return [Array] of points in the polygon (exterior_ring ONLY)
def polygon_to_a(polygon)
  # TODO: handle other parts of the polygon; i.e., the interior_rings (if they exist)
  data = []
  polygon.exterior_ring.points.each { |point|
    data.push([point.x, point.y])
  }
  data
end

# @param [RGeo::Polygon] polygon
# @return [Hash] of points in the polygon (exterior_ring ONLY)
def polygon_to_hash(polygon)
  {polygons: [polygon_to_a(polygon)]}
end

# @return [Array] of line_strings as arrays of points
# @param [RGeo::MultiLineString] multi_line_string
def multi_line_string_to_a(multi_line_string)
  data = []
  multi_line_string.each { |line_string|
    line_data = []
    line_string.points.each { |point|
      line_data.push([point.x, point.y])
    }
    data.push(line_data)
  }
  data
end

# @return [Hash] of line_strings as hashes of points
def multi_line_string_to_hash(_multi_line_string)
  {lines: to_a}
end

# @param [RGeo::MultiPolygon] multi_polygon
# @return [Array] of arrays of points in the polygons (exterior_ring ONLY)
def multi_polygon_to_a(multi_polygon)
  data = []
  multi_polygon.each { |polygon|
    polygon_data = []
    polygon.exterior_ring.points.each { |point|
      polygon_data.push([point.x, point.y])
    }
    data.push(polygon_data)
  }
  data
end

# @return [Hash] of hashes of points in the polygons (exterior_ring ONLY)
def multi_polygon_to_hash(_multi_polygon)
  {polygons: to_a}
end

# @return [Boolean] iff there is one and only one shape column set
def some_data_is_provided
  data = []

  DATA_TYPES.each do |item|
    data.push(item) if send(item).present?
  end

  case data.count
  when 0
    errors.add(:base, 'No shape provided or provided shape is invalid')
  when 1
    return true
  else
    data.each do |object|
      errors.add(object, 'More than one shape type provided')
    end
  end
  true
end
end

#multi_point ⇒ `RGeo::Geographic::ProjectedMultiPointImpl`

Returns:

(RGeo::Geographic::ProjectedMultiPointImpl)

# File 'app/models/geographic_item.rb', line 40

class GeographicItem < ApplicationRecord
  include Housekeeping::Users
  include Housekeeping::Timestamps
  include Shared::HasPapertrail
  include Shared::IsData
  include Shared::SharedAcrossProjects

  # @return [Hash, nil]
  #   An internal variable for use in super calls, holds a Hash in GeoJSON format (temporarily)
  attr_accessor :geometry

  # @return [Boolean, RGeo object]
  # @params value [Hash in GeoJSON format] ?!
  # TODO: WHY! boolean not nil, or object
  # Used to build geographic items from a shape [ of what class ] !?
  attr_accessor :shape

  # @return [Boolean]
  #   When true cached values are not built
  attr_accessor :no_cached

  DATA_TYPES = [
:point,
:line_string,
:polygon,
:multi_point,
:multi_line_string,
:multi_polygon,
:geometry_collection
  ].freeze

  GEOMETRY_SQL = Arel::Nodes::Case.new(arel_table[:type])
.when('GeographicItem::MultiPolygon').then(Arel::Nodes::NamedFunction.new('CAST', [arel_table[:multi_polygon].as('geometry')]))
.when('GeographicItem::Point').then(Arel::Nodes::NamedFunction.new('CAST', [arel_table[:point].as('geometry')]))
.when('GeographicItem::LineString').then(Arel::Nodes::NamedFunction.new('CAST', [arel_table[:line_string].as('geometry')]))
.when('GeographicItem::Polygon').then(Arel::Nodes::NamedFunction.new('CAST', [arel_table[:polygon].as('geometry')]))
.when('GeographicItem::MultiLineString').then(Arel::Nodes::NamedFunction.new('CAST', [arel_table[:multi_line_string].as('geometry')]))
.when('GeographicItem::MultiPoint').then(Arel::Nodes::NamedFunction.new('CAST', [arel_table[:multi_point].as('geometry')]))
.when('GeographicItem::GeometryCollection').then(Arel::Nodes::NamedFunction.new('CAST', [arel_table[:geometry_collection].as('geometry')]))
.freeze

  GEOGRAPHY_SQL = "CASE geographic_items.type
WHEN 'GeographicItem::MultiPolygon' THEN multi_polygon
WHEN 'GeographicItem::Point' THEN point
WHEN 'GeographicItem::LineString' THEN line_string
WHEN 'GeographicItem::Polygon' THEN polygon
WHEN 'GeographicItem::MultiLineString' THEN multi_line_string
WHEN 'GeographicItem::MultiPoint' THEN multi_point
WHEN 'GeographicItem::GeometryCollection' THEN geometry_collection
END".freeze

# ANTI_MERIDIAN = '0X0102000020E61000000200000000000000008066400000000000405640000000000080664000000000004056C0'
ANTI_MERIDIAN = 'LINESTRING (180 89.0, 180 -89)'.freeze

has_many :cached_map_items, inverse_of: :geographic_item

has_many :geographic_areas_geographic_items, dependent: :destroy, inverse_of: :geographic_item
has_many :geographic_areas, through: :geographic_areas_geographic_items
has_many :asserted_distributions, through: :geographic_areas
has_many :geographic_area_types, through: :geographic_areas
has_many :parent_geographic_areas, through: :geographic_areas, source: :parent

has_many :georeferences, inverse_of: :geographic_item
has_many :georeferences_through_error_geographic_item,
  class_name: 'Georeference', foreign_key: :error_geographic_item_id, inverse_of: :error_geographic_item
has_many :collecting_events_through_georeferences, through: :georeferences, source: :collecting_event
has_many :collecting_events_through_georeference_error_geographic_item,
  through: :georeferences_through_error_geographic_item, source: :collecting_event

# TODO: THIS IS NOT GOOD
before_validation :set_type_if_geography_present

validate :some_data_is_provided
validates :type, presence: true # not needed

scope :include_collecting_event, -> { includes(:collecting_events_through_georeferences) }
scope :geo_with_collecting_event, -> { joins(:collecting_events_through_georeferences) }
scope :err_with_collecting_event, -> { joins(:georeferences_through_error_geographic_item) }

after_save :set_cached, unless: Proc.new {|n| n.no_cached || errors.any? }
after_save :align_winding

class << self

  def aliased_geographic_sql(name = 'a')
    "CASE #{name}.type \
     WHEN 'GeographicItem::MultiPolygon' THEN #{name}.multi_polygon \
     WHEN 'GeographicItem::Point' THEN #{name}.point \
     WHEN 'GeographicItem::LineString' THEN #{name}.line_string \
     WHEN 'GeographicItem::Polygon' THEN #{name}.polygon \
     WHEN 'GeographicItem::MultiLineString' THEN #{name}.multi_line_string \
     WHEN 'GeographicItem::MultiPoint' THEN #{name}.multi_point \
     WHEN 'GeographicItem::GeometryCollection' THEN #{name}.geometry_collection \
     END"
  end

  def st_union(geographic_item_scope)
    GeographicItem.select("ST_Union(#{GeographicItem::GEOMETRY_SQL.to_sql}) as collection")
      .where(id: geographic_item_scope.pluck(:id))
  end

  def st_collect(geographic_item_scope)
    GeographicItem.select("ST_Collect(#{GeographicItem::GEOMETRY_SQL.to_sql}) as collection")
      .where(id: geographic_item_scope.pluck(:id))
  end

  # @return [GeographicItem::ActiveRecord_Relation]
  # @params [Array] array of geographic area ids
  def default_by_geographic_area_ids(geographic_area_ids = [])
    GeographicItem.
      joins(:geographic_areas_geographic_items).
      merge(::GeographicAreasGeographicItem.default_geographic_item_data).
      where(geographic_areas_geographic_items: {geographic_area_id: geographic_area_ids})
  end

  # @param [String] wkt
  # @return [Boolean]
  #   whether or not the wtk intersects with the anti-meridian
  #   !! StrongParams security considerations
  def crosses_anti_meridian?(wkt)
    GeographicItem.find_by_sql(
      ['SELECT ST_Intersects(ST_GeogFromText(?), ST_GeogFromText(?)) as r;', wkt, ANTI_MERIDIAN]
    ).first.r
  end

  # @param [Integer] ids
  # @return [Boolean]
  #   whether or not any GeographicItem passed intersects the anti-meridian
  #   !! StrongParams security considerations
  #   This is our first line of defense against queries that define multiple shapes, one or
  #   more of which crosses the anti-meridian.  In this case the current TW strategy within the
  #   UI is to abandon the search, and prompt the user to refactor the query.
  def crosses_anti_meridian_by_id?(*ids)
    q1 = ["SELECT ST_Intersects((SELECT single_geometry FROM (#{GeographicItem.single_geometry_sql(*ids)}) as " \
          'left_intersect), ST_GeogFromText(?)) as r;', ANTI_MERIDIAN]
    _q2 = ActiveRecord::Base.send(:sanitize_sql_array, ['SELECT ST_Intersects((SELECT single_geometry FROM (?) as ' \
                                                        'left_intersect), ST_GeogFromText(?)) as r;', GeographicItem.single_geometry_sql(*ids), ANTI_MERIDIAN])
    GeographicItem.find_by_sql(q1).first.r
  end

  #
  # SQL fragments
  #

  # @param [Integer, String]
  # @return [String]
  #   a SQL select statement that returns the *geometry* for the geographic_item with the specified id
  def select_geometry_sql(geographic_item_id)
    "SELECT #{GeographicItem::GEOMETRY_SQL.to_sql} from geographic_items where geographic_items.id = #{geographic_item_id}"
  end

  # @param [Integer, String]
  # @return [String]
  #   a SQL select statement that returns the geography for the geographic_item with the specified id
  def select_geography_sql(geographic_item_id)
    ActiveRecord::Base.send(:sanitize_sql_for_conditions, [
      "SELECT #{GeographicItem::GEOMETRY_SQL.to_sql} from geographic_items where geographic_items.id = ?",
      geographic_item_id])
  end

  # @param [Symbol] choice
  # @return [String]
  #   a fragment returning either latitude or longitude columns
  def lat_long_sql(choice)
    return nil unless [:latitude, :longitude].include?(choice)
    f = "'D.DDDDDD'" # TODO: probably a constant somewhere
    v = (choice == :latitude ? 1 : 2)
    "CASE geographic_items.type
  WHEN 'GeographicItem::GeometryCollection' THEN split_part(ST_AsLatLonText(ST_Centroid" \
  "(geometry_collection::geometry), #{f}), ' ', #{v})
  WHEN 'GeographicItem::LineString' THEN split_part(ST_AsLatLonText(ST_Centroid(line_string::geometry), " \
  "#{f}), ' ', #{v})
  WHEN 'GeographicItem::MultiPolygon' THEN split_part(ST_AsLatLonText(" \
  "ST_Centroid(multi_polygon::geometry), #{f}), ' ', #{v})
  WHEN 'GeographicItem::Point' THEN split_part(ST_AsLatLonText(" \
  "ST_Centroid(point::geometry), #{f}), ' ', #{v})
  WHEN 'GeographicItem::Polygon' THEN split_part(ST_AsLatLonText(" \
  "ST_Centroid(polygon::geometry), #{f}), ' ', #{v})
  WHEN 'GeographicItem::MultiLineString' THEN split_part(ST_AsLatLonText(" \
  "ST_Centroid(multi_line_string::geometry), #{f} ), ' ', #{v})
  WHEN 'GeographicItem::MultiPoint' THEN split_part(ST_AsLatLonText(" \
  "ST_Centroid(multi_point::geometry), #{f}), ' ', #{v})
END as #{choice}"
  end

  # @param [Integer] geographic_item_id
  # @param [Integer] distance
  # @return [String]
  def within_radius_of_item_sql(geographic_item_id, distance)
    "ST_DWithin((#{GeographicItem::GEOGRAPHY_SQL}), (#{select_geography_sql(geographic_item_id)}), #{distance})"
  end


  # @param [Integer] geographic_item_id
  # @param [Number] distance in meters to grow/shrink the shape (negative allowed)
  # @param [Number] distance (in meters) (positive only?!)
  # @return [String]
  def st_buffer_st_within(geographic_item_id, distance, buffer = 0)
    "ST_DWithin(
    ST_Buffer(#{GeographicItem::GEOGRAPHY_SQL}, #{buffer}),
    (#{select_geography_sql(geographic_item_id)}), #{distance}
   )"
  end


  # TODO: 3D is overkill here
  # @param [String] wkt
  # @param [Integer] distance (meters)
  # @return [String]
  # !! This is intersecting
  def intersecting_radius_of_wkt_sql(wkt, distance)
    "ST_DWithin((#{GeographicItem::GEOGRAPHY_SQL}), ST_Transform( ST_GeomFromText('#{wkt}', " \
      "4326), 4326), #{distance})"
  end

  # @param [String] wkt
  # @param [Integer] distance (meters)
  # @return [String]
  # !! This is fully covering
  def within_radius_of_wkt_sql(wkt, distance)
    "ST_Covers( ST_Buffer(ST_SetSRID( ST_GeomFromText('#{wkt}'), 4326)::geography, #{distance}), (#{GeographicItem::GEOGRAPHY_SQL}))"
  end

  # @param [String, Integer, String]
  # @return [String]
  #   a SQL fragment for ST_Contains() function, returns
  #   all geographic items which are contained in the item supplied
  def containing_sql(target_column_name = nil, geographic_item_id = nil, source_column_name = nil)
    return 'false' if geographic_item_id.nil? || source_column_name.nil? || target_column_name.nil?
    "ST_Contains(#{target_column_name}::geometry, (#{geometry_sql(geographic_item_id, source_column_name)}))"
  end

  # @param [String, Integer, String]
  # @return [String]
  #   a SQL fragment for ST_Contains(), returns
  #   all geographic_items which contain the supplied geographic_item
  def reverse_containing_sql(target_column_name = nil, geographic_item_id = nil, source_column_name = nil)
    return 'false' if geographic_item_id.nil? || source_column_name.nil? || target_column_name.nil?
    "ST_Contains((#{geometry_sql(geographic_item_id, source_column_name)}), #{target_column_name}::geometry)"
  end

  # @param [Integer, String]
  # @return [String]
  #   a SQL fragment that represents the geometry of the geographic item specified (which has data in the
  # source_column_name, i.e. geo_object_type)
  def geometry_sql(geographic_item_id = nil, source_column_name = nil)
    return 'false' if geographic_item_id.nil? || source_column_name.nil?
    "select geom_alias_tbl.#{source_column_name}::geometry from geographic_items geom_alias_tbl " \
      "where geom_alias_tbl.id = #{geographic_item_id}"
  end

  # rubocop:disable Metrics/MethodLength
  # @param [String] column_name
  # @param [GeographicItem] geographic_item
  # @return [String] of SQL
  def is_contained_by_sql(column_name, geographic_item)
    geo_id = geographic_item.id
    geo_type = geographic_item.geo_object_type
    template = '(ST_Contains((select geographic_items.%s::geometry from geographic_items where ' \
      'geographic_items.id = %d), %s::geometry))'
    retval = []
    column_name.downcase!
    case column_name
    when 'any'
      DATA_TYPES.each { |column|
        unless column == :geometry_collection
          retval.push(template % [geo_type, geo_id, column])
        end
      }
    when 'any_poly', 'any_line'
      DATA_TYPES.each { |column|
        unless column == :geometry_collection
          if column.to_s.index(column_name.gsub('any_', ''))
            retval.push(template % [geo_type, geo_id, column])
          end
        end
      }
    else
      retval = template % [geo_type, geo_id, column_name]
    end
    retval = retval.join(' OR ') if retval.instance_of?(Array)
    retval
  end

  # @param [Interger, Array of Integer] geographic_item_ids
  # @return [String]
  #   a select query that returns a single geometry (column name 'single_geometry' for the collection of ids
  # provided via ST_Collect)
  def st_collect_sql(*geographic_item_ids)
    geographic_item_ids.flatten!
    ActiveRecord::Base.send(:sanitize_sql_for_conditions, [
      "SELECT ST_Collect(f.the_geom) AS single_geometry
 FROM (
    SELECT (ST_DUMP(#{GeographicItem::GEOMETRY_SQL.to_sql})).geom as the_geom
    FROM geographic_items
    WHERE id in (?))
  AS f", geographic_item_ids])
  end

  # @param [Interger, Array of Integer] geographic_item_ids
  # @return [String]
  #    returns one or more geographic items combined as a single geometry in column 'single'
  def single_geometry_sql(*geographic_item_ids)
    a = GeographicItem.st_collect_sql(geographic_item_ids)
    '(SELECT single.single_geometry FROM (' + a + ' ) AS single)'
  end

  # @param [Interger, Array of Integer] geographic_item_ids
  # @return [String]
  #   returns a single geometry "column" (paren wrapped) as "single" for multiple geographic item ids, or the
  # geometry as 'geometry' for a single id
  def geometry_sql2(*geographic_item_ids)
    geographic_item_ids.flatten! # *ALWAYS* reduce the pile to a single level of ids
    if geographic_item_ids.count == 1
      "(#{GeographicItem.geometry_for_sql(geographic_item_ids.first)})"
    else
      GeographicItem.single_geometry_sql(geographic_item_ids)
    end
  end

  # @param [Interger, Array of Integer] geographic_item_ids
  # @return [String]
  def containing_where_sql(*geographic_item_ids)
    "ST_CoveredBy(
      #{GeographicItem.geometry_sql2(*geographic_item_ids)},
       CASE geographic_items.type
         WHEN 'GeographicItem::MultiPolygon' THEN multi_polygon::geometry
         WHEN 'GeographicItem::Point' THEN point::geometry
         WHEN 'GeographicItem::LineString' THEN line_string::geometry
         WHEN 'GeographicItem::Polygon' THEN polygon::geometry
         WHEN 'GeographicItem::MultiLineString' THEN multi_line_string::geometry
         WHEN 'GeographicItem::MultiPoint' THEN multi_point::geometry
      END)"
  end

  # @param [Interger, Array of Integer] geographic_item_ids
  # @return [String]
  def containing_where_sql_geog(*geographic_item_ids)
    "ST_CoveredBy(
      #{GeographicItem.geometry_sql2(*geographic_item_ids)},
       CASE geographic_items.type
         WHEN 'GeographicItem::MultiPolygon' THEN multi_polygon::geography
         WHEN 'GeographicItem::Point' THEN point::geography
         WHEN 'GeographicItem::LineString' THEN line_string::geography
         WHEN 'GeographicItem::Polygon' THEN polygon::geography
         WHEN 'GeographicItem::MultiLineString' THEN multi_line_string::geography
         WHEN 'GeographicItem::MultiPoint' THEN multi_point::geography
      END)"
  end

  # @param [Interger, Array of Integer] ids
  # @return [Array]
  #   If we detect that some query id has crossed the meridian, then loop through
  #   and "manually" build up a list of results.
  #   Should only be used if GeographicItem.crosses_anti_meridian_by_id? is true.
  #   Note that this does not return a Scope, so you can't chain it like contained_by?
  # TODO: test this
  def contained_by_with_antimeridian_check(*ids)
    ids.flatten! # make sure there is only one level of splat (*)
    results = []

    crossing_ids = []

    ids.each do |id|
      # push each which crosses
      crossing_ids.push(id) if GeographicItem.crosses_anti_meridian_by_id?(id)
    end

    non_crossing_ids = ids - crossing_ids
    results.push GeographicItem.contained_by(non_crossing_ids).to_a if non_crossing_ids.any?

    crossing_ids.each do |id|
      # [61666, 61661, 61659, 61654, 61639]
      q1 = ActiveRecord::Base.send(:sanitize_sql_array, ['SELECT ST_AsText((SELECT polygon FROM geographic_items ' \
                                                         'WHERE id = ?))', id])
      r = GeographicItem.where(
        # GeographicItem.contained_by_wkt_shifted_sql(GeographicItem.find(id).geo_object.to_s)
        GeographicItem.contained_by_wkt_shifted_sql(
          ApplicationRecord.connection.execute(q1).first['st_astext'])
      ).to_a
      results.push(r)
    end

    results.flatten.uniq
  end

  # @params [String] well known text
  # @return [String] the SQL fragment for the specific geometry type, shifted by longitude
  # Note: this routine is called when it is already known that the A argument crosses anti-meridian
  def contained_by_wkt_shifted_sql(wkt)
    "ST_Contains(ST_ShiftLongitude(ST_GeomFromText('#{wkt}', 4326)), (
    CASE geographic_items.type
       WHEN 'GeographicItem::MultiPolygon' THEN ST_ShiftLongitude(multi_polygon::geometry)
       WHEN 'GeographicItem::Point' THEN ST_ShiftLongitude(point::geometry)
       WHEN 'GeographicItem::LineString' THEN ST_ShiftLongitude(line_string::geometry)
       WHEN 'GeographicItem::Polygon' THEN ST_ShiftLongitude(polygon::geometry)
       WHEN 'GeographicItem::MultiLineString' THEN ST_ShiftLongitude(multi_line_string::geometry)
       WHEN 'GeographicItem::MultiPoint' THEN ST_ShiftLongitude(multi_point::geometry)
    END
    )
  )"
  end

  # TODO: Remove the hard coded 4326 reference
  # @params [String] wkt
  # @return [String] SQL fragment limiting geographics items to those in this WKT
  def contained_by_wkt_sql(wkt)
    if crosses_anti_meridian?(wkt)
      retval = contained_by_wkt_shifted_sql(wkt)
    else
      retval = "ST_Contains(ST_GeomFromText('#{wkt}', 4326), (
    CASE geographic_items.type
       WHEN 'GeographicItem::MultiPolygon' THEN multi_polygon::geometry
       WHEN 'GeographicItem::Point' THEN point::geometry
       WHEN 'GeographicItem::LineString' THEN line_string::geometry
       WHEN 'GeographicItem::Polygon' THEN polygon::geometry
       WHEN 'GeographicItem::MultiLineString' THEN multi_line_string::geometry
       WHEN 'GeographicItem::MultiPoint' THEN multi_point::geometry
    END
    )
  )"
    end
    retval
  end

  # @param [Interger, Array of Integer] geographic_item_ids
  # @return [String] sql for contained_by via ST_ContainsProperly
  # Note: Can not use GEOMETRY_SQL because geometry_collection is not supported in ST_ContainsProperly
  # Note: !! If the target GeographicItem#id crosses the anti-meridian then you may/will get unexpected results.
  def contained_by_where_sql(*geographic_item_ids)
    "ST_Contains(
    #{GeographicItem.geometry_sql2(*geographic_item_ids)},
    CASE geographic_items.type
      WHEN 'GeographicItem::MultiPolygon' THEN multi_polygon::geometry
      WHEN 'GeographicItem::Point' THEN point::geometry
      WHEN 'GeographicItem::LineString' THEN line_string::geometry
      WHEN 'GeographicItem::Polygon' THEN polygon::geometry
      WHEN 'GeographicItem::MultiLineString' THEN multi_line_string::geometry
      WHEN 'GeographicItem::MultiPoint' THEN multi_point::geometry
    END)"
  end

  # @param [RGeo:Point] rgeo_point
  # @return [String] sql for containing via ST_CoveredBy
  # TODO: Remove the hard coded 4326 reference
  # TODO: should this be wkt_point instead of rgeo_point?
  def containing_where_for_point_sql(rgeo_point)
    "ST_CoveredBy(
  ST_GeomFromText('#{rgeo_point}', 4326),
  #{GeographicItem::GEOMETRY_SQL.to_sql}
 )"
  end

  # @param [Interger] geographic_item_id
  # @return [String] SQL for geometries
  # example, not used
  def geometry_for_sql(geographic_item_id)
    'SELECT ' + GeographicItem::GEOMETRY_SQL.to_sql + ' AS geometry FROM geographic_items WHERE id = ' \
      "#{geographic_item_id} LIMIT 1"
  end

  # @param [Interger, Array of Integer] geographic_item_ids
  # @return [String] SQL for geometries
  # example, not used
  def geometry_for_collection_sql(*geographic_item_ids)
    'SELECT ' + GeographicItem::GEOMETRY_SQL.to_sql + ' AS geometry FROM geographic_items WHERE id IN ' \
      "( #{geographic_item_ids.join(',')} )"
  end

  #
  # Scopes
  #

  # @param [Interger, Array of Integer] geographic_item_ids
  # @return [Scope]
  #    the geographic items containing these collective geographic_item ids, not including self
  def containing(*geographic_item_ids)
    where(GeographicItem.containing_where_sql(geographic_item_ids)).not_ids(*geographic_item_ids)
  end

  # @param [Interger, Array of Integer] geographic_item_ids
  # @return [Scope]
  #    the geographic items contained by any of these geographic_item ids, not including self
  # (works via ST_ContainsProperly)
  def contained_by(*geographic_item_ids)
    where(GeographicItem.contained_by_where_sql(geographic_item_ids))
  end

  # @param [RGeo::Point] rgeo_point
  # @return [Scope]
  #    the geographic items containing this point
  # TODO: should be containing_wkt ?
  def containing_point(rgeo_point)
    where(GeographicItem.containing_where_for_point_sql(rgeo_point))
  end

  # @return [Scope]
  #   adds an area_in_meters field, with meters
  def with_area
    select("ST_Area(#{GeographicItem::GEOGRAPHY_SQL}, false) as area_in_meters")
  end

  # return [Scope]
  #   A scope that limits the result to those GeographicItems that have a collecting event
  #   through either the geographic_item or the error_geographic_item
  #
  # A raw SQL join approach for comparison
  #
  # GeographicItem.joins('LEFT JOIN georeferences g1 ON geographic_items.id = g1.geographic_item_id').
  #   joins('LEFT JOIN georeferences g2 ON geographic_items.id = g2.error_geographic_item_id').
  #   where("(g1.geographic_item_id IS NOT NULL OR g2.error_geographic_item_id IS NOT NULL)").uniq

  # @return [Scope] GeographicItem
  # This uses an Arel table approach, this is ultimately more decomposable if we need. Of use:
  #  http://danshultz.github.io/talks/mastering_activerecord_arel  <- best
  #  https://github.com/rails/arel
  #  http://stackoverflow.com/questions/4500629/use-arel-for-a-nested-set-join-query-and-convert-to-activerecordrelation
  #  http://rdoc.info/github/rails/arel/Arel/SelectManager
  #  http://stackoverflow.com/questions/7976358/activerecord-arel-or-condition
  #
  def with_collecting_event_through_georeferences
    geographic_items = GeographicItem.arel_table
    georeferences = Georeference.arel_table
    g1 = georeferences.alias('a')
    g2 = georeferences.alias('b')

    c = geographic_items.join(g1, Arel::Nodes::OuterJoin).on(geographic_items[:id].eq(g1[:geographic_item_id]))
      .join(g2, Arel::Nodes::OuterJoin).on(geographic_items[:id].eq(g2[:error_geographic_item_id]))

    GeographicItem.joins(# turn the Arel back into scope
                         c.join_sources # translate the Arel join to a join hash(?)
                        ).where(
                          g1[:id].not_eq(nil).or(g2[:id].not_eq(nil)) # returns a Arel::Nodes::Grouping
                        ).distinct
  end

  # @return [Scope] include a 'latitude' column
  def with_latitude
    select(lat_long_sql(:latitude))
  end

  # @return [Scope] include a 'longitude' column
  def with_longitude
    select(lat_long_sql(:longitude))
  end

  # @param [String, GeographicItems]
  # @return [Scope]
  def intersecting(column_name, *geographic_items)
    if column_name.downcase == 'any'
      pieces = []
      DATA_TYPES.each { |column|
        pieces.push(GeographicItem.intersecting(column.to_s, geographic_items).to_a)
      }

      # @TODO change 'id in (?)' to some other sql construct

      GeographicItem.where(id: pieces.flatten.map(&:id))
    else
      q = geographic_items.flatten.collect { |geographic_item|
        "ST_Intersects(#{column_name}, '#{geographic_item.geo_object}'    )" # seems like we want this: http://danshultz.github.io/talks/mastering_activerecord_arel/#/15/2
      }.join(' or ')

      where(q)
    end
  end

  # @param [GeographicItem#id] geographic_item_id
  # @param [Float] distance in meters ?!?!
  # @return [ActiveRecord::Relation]
  # !! should be distance, not radius?!
  def within_radius_of_item(geographic_item_id, distance)
    where(within_radius_of_item_sql(geographic_item_id, distance))
  end

  # @param [String, GeographicItem]
  # @return [Scope]
  #   a SQL fragment for ST_DISJOINT, specifies all geographic_items that have data in column_name
  #   that are disjoint from the passed geographic_items
  def disjoint_from(column_name, *geographic_items)
    q = geographic_items.flatten.collect { |geographic_item|
      "ST_DISJOINT(#{column_name}::geometry, (#{geometry_sql(geographic_item.to_param,
                                                         geographic_item.geo_object_type)}))"
    }.join(' and ')

    where(q)
  end

  # @return [Scope]
  #   see are_contained_in_item_by_id
  # @param [String] column_name
  # @param [GeographicItem, Array] geographic_items
  def are_contained_in_item(column_name, *geographic_items)
    are_contained_in_item_by_id(column_name, geographic_items.flatten.map(&:id))
  end

  # rubocop:disable Metrics/MethodLength
  # @param [String] column_name to search
  # @param [GeographicItem] geographic_item_ids or array of geographic_item_ids to be tested.
  # @return [Scope] of GeographicItems
  #
  # If this scope is given an Array of GeographicItems as a second parameter,
  # it will return the 'OR' of each of the objects against the table.
  # SELECT COUNT(*) FROM "geographic_items"
  #        WHERE (ST_Contains(polygon::geometry, GeomFromEWKT('srid=4326;POINT (0.0 0.0 0.0)'))
  #               OR ST_Contains(polygon::geometry, GeomFromEWKT('srid=4326;POINT (-9.8 5.0 0.0)')))
  #
  def are_contained_in_item_by_id(column_name, *geographic_item_ids) # = containing
    geographic_item_ids.flatten! # in case there is a array of arrays, or multiple objects
    column_name.downcase!
    case column_name
    when 'any'
      part = []
      DATA_TYPES.each { |column|
        unless column == :geometry_collection
          part.push(GeographicItem.are_contained_in_item_by_id(column.to_s, geographic_item_ids).to_a)
        end
      }
      # TODO: change 'id in (?)' to some other sql construct
      GeographicItem.where(id: part.flatten.map(&:id))
    when 'any_poly', 'any_line'
      part = []
      DATA_TYPES.each { |column|
        if column.to_s.index(column_name.gsub('any_', ''))
          part.push(GeographicItem.are_contained_in_item_by_id("#{column}", geographic_item_ids).to_a)
        end
      }
      # TODO: change 'id in (?)' to some other sql construct
      GeographicItem.where(id: part.flatten.map(&:id))
    else
      q = geographic_item_ids.flatten.collect { |geographic_item_id|
        # discover the item types, and convert type to database type for 'multi_'
        b = GeographicItem.where(id: geographic_item_id)
          .pluck(:type)[0].split(':')[2].downcase.gsub('lti', 'lti_')
        # a = GeographicItem.find(geographic_item_id).geo_object_type
        GeographicItem.containing_sql(column_name, geographic_item_id, b)
      }.join(' or ')
      q = 'FALSE' if q.blank? # this will prevent the invocation of *ALL* of the GeographicItems, if there are
      # no GeographicItems in the request (see CollectingEvent.name_hash(types)).
      where(q) # .not_including(geographic_items)
    end
  end

  # rubocop:enable Metrics/MethodLength

  # @param [String] column_name
  # @param [String] geometry of WKT
  # @return [Scope]
  # a single WKT geometry is compared against column or columns (except geometry_collection) to find geographic_items
  # which are contained in the WKT
  def are_contained_in_wkt(column_name, geometry)
    column_name.downcase!
    # column_name = 'point'
    case column_name
    when 'any'
      part = []
      DATA_TYPES.each { |column|
        unless column == :geometry_collection
          part.push(GeographicItem.are_contained_in_wkt(column.to_s, geometry).pluck(:id).to_a)
        end
      }
      # TODO: change 'id in (?)' to some other sql construct
      GeographicItem.where(id: part.flatten)
    when 'any_poly', 'any_line'
      part = []
      DATA_TYPES.each { |column|
        if column.to_s.index(column_name.gsub('any_', ''))
          part.push(GeographicItem.are_contained_in_wkt("#{column}", geometry).pluck(:id).to_a)
        end
      }
      # TODO: change 'id in (?)' to some other sql construct
      GeographicItem.where(id: part.flatten)
    else
      # column = points, geometry = square
      q = "ST_Contains(ST_GeomFromEWKT('srid=4326;#{geometry}'), #{column_name}::geometry)"
      where(q) # .not_including(geographic_items)
    end
  end

  # rubocop:disable Metrics/MethodLength
  #    containing the items the shape of which is contained in the geographic_item[s] supplied.
  # @param column_name [String] can be any of DATA_TYPES, or 'any' to check against all types, 'any_poly' to check
  # against 'polygon' or 'multi_polygon', or 'any_line' to check against 'line_string' or 'multi_line_string'.
  #  CANNOT be 'geometry_collection'.
  # @param geographic_items [GeographicItem] Can be a single GeographicItem, or an array of GeographicItem.
  # @return [Scope]
  def is_contained_by(column_name, *geographic_items)
    column_name.downcase!
    case column_name
    when 'any'
      part = []
      DATA_TYPES.each { |column|
        unless column == :geometry_collection
          part.push(GeographicItem.is_contained_by(column.to_s, geographic_items).to_a)
        end
      }
      # @TODO change 'id in (?)' to some other sql construct
      GeographicItem.where(id: part.flatten.map(&:id))

    when 'any_poly', 'any_line'
      part = []
      DATA_TYPES.each { |column|
        unless column == :geometry_collection
          if column.to_s.index(column_name.gsub('any_', ''))
            part.push(GeographicItem.is_contained_by(column.to_s, geographic_items).to_a)
          end
        end
      }
      # @TODO change 'id in (?)' to some other sql construct
      GeographicItem.where(id: part.flatten.map(&:id))

    else
      q = geographic_items.flatten.collect { |geographic_item|
        GeographicItem.reverse_containing_sql(column_name, geographic_item.to_param,
                                              geographic_item.geo_object_type)
      }.join(' or ')
      where(q) # .not_including(geographic_items)
    end
  end

  # rubocop:enable Metrics/MethodLength

  # @param [String, GeographicItem]
  # @return [Scope]
  def ordered_by_shortest_distance_from(column_name, geographic_item)
    if true # check_geo_params(column_name, geographic_item)
      select_distance_with_geo_object(column_name, geographic_item)
        .where_distance_greater_than_zero(column_name, geographic_item).order('distance')
    else
      where('false')
    end
  end

  # @param [String, GeographicItem]
  # @return [Scope]
  def ordered_by_longest_distance_from(column_name, geographic_item)
    if true # check_geo_params(column_name, geographic_item)
      q = select_distance_with_geo_object(column_name, geographic_item)
        .where_distance_greater_than_zero(column_name, geographic_item)
        .order('distance desc')
      q
    else
      where('false')
    end
  end

  # @param [String] column_name
  # @param [GeographicItem] geographic_item
  # @return [String]
  def select_distance_with_geo_object(column_name, geographic_item)
    select("*, ST_Distance(#{column_name}, GeomFromEWKT('srid=4326;#{geographic_item.geo_object}')) as distance")
  end

  # @param [String, GeographicItem]
  # @return [Scope]
  def where_distance_greater_than_zero(column_name, geographic_item)
    where("#{column_name} is not null and ST_Distance(#{column_name}, " \
          "GeomFromEWKT('srid=4326;#{geographic_item.geo_object}')) > 0")
  end

  # @param [GeographicItem]
  # @return [Scope]
  def not_including(geographic_items)
    where.not(id: geographic_items)
  end

  # @return [Scope]
  #   includes an 'is_valid' attribute (True/False) for the passed geographic_item.  Uses St_IsValid.
  # @param [RGeo object] geographic_item
  def with_is_valid_geometry_column(geographic_item)
    where(id: geographic_item.id).select("ST_IsValid(ST_AsBinary(#{geographic_item.geo_object_type})) is_valid")
  end

  #
  # Other
  #

  # @param [Integer] geographic_item_id1
  # @param [Integer] geographic_item_id2
  # @return [Float]
  def distance_between(geographic_item_id1, geographic_item_id2)
    q1 = "ST_Distance(#{GeographicItem::GEOGRAPHY_SQL}, " \
      "(#{select_geography_sql(geographic_item_id2)})) as distance"
    _q2 = ActiveRecord::Base.send(
      :sanitize_sql_array, ['ST_Distance(?, (?)) as distance',
                            GeographicItem::GEOGRAPHY_SQL,
                            select_geography_sql(geographic_item_id2)])
    GeographicItem.where(id: geographic_item_id1).pluck(Arel.sql(q1)).first
  end

  # @param [RGeo::Point] point
  # @return [Hash]
  #   as per #inferred_geographic_name_hierarchy but for Rgeo point
  def point_inferred_geographic_name_hierarchy(point)
    GeographicItem.containing_point(point).order(cached_total_area: :ASC).limit(1).first&.inferred_geographic_name_hierarchy
  end

  # @param [String] type_name ('polygon', 'point', 'line' [, 'circle'])
  # @return [String] if type
  def eval_for_type(type_name)
    retval = 'GeographicItem'
    case type_name.upcase
    when 'POLYGON'
      retval += '::Polygon'
    when 'LINESTRING'
      retval += '::LineString'
    when 'POINT'
      retval += '::Point'
    when 'MULTIPOLYGON'
      retval += '::MultiPolygon'
    when 'MULTILINESTRING'
      retval += '::MultiLineString'
    when 'MULTIPOINT'
      retval += '::MultiPoint'
    else
      retval = nil
    end
    retval
  end

  # example, not used
  # @param [Integer] geographic_item_id
  # @return [RGeo::Geographic object]
  def geometry_for(geographic_item_id)
    GeographicItem.select(GeographicItem::GEOMETRY_SQL.to_sql + ' AS geometry').find(geographic_item_id)['geometry']
  end

  # example, not used
  # @param [Integer, Array] geographic_item_ids
  # @return [Scope]
  def st_multi(*geographic_item_ids)
    GeographicItem.find_by_sql(
      "SELECT ST_Multi(ST_Collect(g.the_geom)) AS singlegeom
 FROM (
    SELECT (ST_DUMP(#{GeographicItem::GEOMETRY_SQL.to_sql})).geom AS the_geom
    FROM geographic_items
    WHERE id IN (?))
  AS g;", geographic_item_ids.flatten
    )
  end
end # class << self

# @return [Hash]
#    a geographic_name_classification or empty Hash
# This is a quick approach that works only when
# the geographic_item is linked explicitly to a GeographicArea.
#
# !! Note that it is not impossible for a GeographicItem to be linked
# to > 1 GeographicArea, in that case we are assuming that all are
# equally refined, this might not be the case in the future because
# of how the GeographicArea gazetteer is indexed.
def quick_geographic_name_hierarchy
  geographic_areas.order(:id).each do |ga|
    h = ga.geographic_name_classification # not quick enough !!
    return h if h.present?
  end
  return  {}
end

# @return [Hash]
#   a geographic_name_classification (see GeographicArea) inferred by
# finding the smallest area containing this GeographicItem, in the most accurate gazetteer
# and using it to return country/state/county. See also the logic in
# filling in missing levels in GeographicArea.
def inferred_geographic_name_hierarchy
  if small_area = containing_geographic_areas
    .joins(:geographic_areas_geographic_items)
    .merge(GeographicAreasGeographicItem.ordered_by_data_origin)
    .ordered_by_area
    .limit(1)
    .first
  return small_area.geographic_name_classification
  else
    {}
  end
end

def geographic_name_hierarchy
  a = quick_geographic_name_hierarchy # quick; almost never the case, UI not setup to do this
  return a if a.present?
  inferred_geographic_name_hierarchy # slow
end

# @return [Scope]
#   the Geographic Areas that contain (gis) this geographic item
def containing_geographic_areas
  GeographicArea.joins(:geographic_items).includes(:geographic_area_type)
    .joins("JOIN (#{GeographicItem.containing(id).to_sql}) j on geographic_items.id = j.id")
end

# @return [Boolean]
#   whether stored shape is ST_IsValid
def valid_geometry?
  GeographicItem.with_is_valid_geometry_column(self).first['is_valid']
end

# @return [Array of latitude, longitude]
#    the lat, lon of the first point in the GeoItem, see subclass for #st_start_point
def start_point
  o = st_start_point
  [o.y, o.x]
end

# @return [Array]
#   the lat, long, as STRINGs for the centroid of this geographic item
#   Meh- this: https://postgis.net/docs/en/ST_MinimumBoundingRadius.html
def center_coords
  r = GeographicItem.find_by_sql(
    "Select split_part(ST_AsLatLonText(ST_Centroid(#{GeographicItem::GEOMETRY_SQL.to_sql}), " \
    "'D.DDDDDD'), ' ', 1) latitude, split_part(ST_AsLatLonText(ST_Centroid" \
    "(#{GeographicItem::GEOMETRY_SQL.to_sql}), 'D.DDDDDD'), ' ', 2) " \
    "longitude from geographic_items where id = #{id};")[0]

  [r.latitude, r.longitude]
end

# @return [RGeo::Geographic::ProjectedPointImpl]
#    representing the centroid of this geographic item
def centroid
  # Gis::FACTORY.point(*center_coords.reverse)
  return geo_object if type == 'GeographicItem::Point'
  return Gis::FACTORY.parse_wkt(self.st_centroid)
end

# @param [Integer] geographic_item_id
# @return [Double] distance in meters (slower, more accurate)
def st_distance(geographic_item_id) # geo_object
  q1 = "ST_Distance((#{GeographicItem.select_geography_sql(id)}), " \
    "(#{GeographicItem.select_geography_sql(geographic_item_id)})) as d"
  _q2 = ActiveRecord::Base.send(:sanitize_sql_array, ['ST_Distance((?),(?)) as d',
                                                      GeographicItem.select_geography_sql(self.id),
                                                      GeographicItem.select_geography_sql(geographic_item_id)])
  deg = GeographicItem.where(id:).pluck(Arel.sql(q1)).first
  deg * Utilities::Geo::ONE_WEST
end

# @param [GeographicItem] geographic_item
# @return [Double] distance in meters
# Like st_distance but works with changed and non persisted objects
def st_distance_to_geographic_item(geographic_item)
  unless !persisted? || changed?
    a = "(#{GeographicItem.select_geography_sql(id)})"
  else
    a = "ST_GeographyFromText('#{geo_object}')"
  end

  unless !geographic_item.persisted? || geographic_item.changed?
    b = "(#{GeographicItem.select_geography_sql(geographic_item.id)})"
  else
    b = "ST_GeographyFromText('#{geographic_item.geo_object}')"
  end

  ActiveRecord::Base.connection.select_value("SELECT ST_Distance(#{a}, #{b})")
end

alias_method :distance_to, :st_distance

# @param [Integer] geographic_item_id
# @return [Double] distance in meters (faster, less accurate)
def st_distance_spheroid(geographic_item_id)
  q1 = "ST_DistanceSpheroid((#{GeographicItem.select_geometry_sql(id)})," \
    "(#{GeographicItem.select_geometry_sql(geographic_item_id)}),'#{Gis::SPHEROID}') as distance"
  _q2 = ActiveRecord::Base.send(:sanitize_sql_array,
                                ['ST_DistanceSpheroid((?),(?),?) as distance',
                                 GeographicItem.select_geometry_sql(id),
                                 GeographicItem.select_geometry_sql(geographic_item_id),
                                 Gis::SPHEROID])
  # TODO: what is _q2?
  GeographicItem.where(id:).pluck(Arel.sql(q1)).first
end

# @return [String]
#   a WKT POINT representing the centroid of the geographic item
def st_centroid
  GeographicItem.where(id: to_param).pluck(Arel.sql("ST_AsEWKT(ST_Centroid(#{GeographicItem::GEOMETRY_SQL.to_sql}))")).first.gsub(/SRID=\d*;/, '')
end

# @return [Integer]
#   the number of points in the geometry
def st_npoints
  GeographicItem.where(id:).pluck(Arel.sql("ST_NPoints(#{GeographicItem::GEOMETRY_SQL.to_sql}) as npoints")).first
end

# @return [Symbol]
#   the geo type (i.e. column like :point, :multipolygon).  References the first-found object,
# according to the list of DATA_TYPES, or nil
def geo_object_type
  if self.class.name == 'GeographicItem' # a proxy check for new records
    geo_type
  else
    self.class::SHAPE_COLUMN
  end
end

# !!TODO: migrate these to use native column calls

# @return [RGeo instance, nil]
#  the Rgeo shape (See http://rubydoc.info/github/dazuma/rgeo/RGeo/Feature)
def geo_object
  begin
    if r = geo_object_type # rubocop:disable Lint/AssignmentInCondition
      send(r)
    else
      false
    end
  rescue RGeo::Error::InvalidGeometry
    return nil # TODO: we need to render proper error for this!
  end
end

# @param [geo_object]
# @return [Boolean]
def contains?(target_geo_object)
  return nil if target_geo_object.nil?
  self.geo_object.contains?(target_geo_object)
end

# @param [geo_object]
# @return [Boolean]
def within?(target_geo_object)
  self.geo_object.within?(target_geo_object)
end

# @param [geo_object]
# @return [Boolean]
def intersects?(target_geo_object)
  self.geo_object.intersects?(target_geo_object)
end

# @param [geo_object, Double]
# @return [Boolean]
def near(target_geo_object, distance)
  self.geo_object.unsafe_buffer(distance).contains?(target_geo_object)
end

# @param [geo_object, Double]
# @return [Boolean]
def far(target_geo_object, distance)
  !near(target_geo_object, distance)
end

# @return [GeoJSON hash]
#    via Rgeo apparently necessary for GeometryCollection
def rgeo_to_geo_json
  RGeo::GeoJSON.encode(geo_object).to_json
end

# @return [Hash]
#   in GeoJSON format
#   Computed via "raw" PostGIS (much faster). This
#   requires the geo_object_type and id.
#
def to_geo_json
  JSON.parse(
    GeographicItem.connection.select_one(
      "SELECT ST_AsGeoJSON(#{geo_object_type}::geometry) a " \
      "FROM geographic_items WHERE id=#{id};")['a'])
end

# We don't need to serialize to/from JSON
def to_geo_json_string
  GeographicItem.connection.select_one(
    "SELECT ST_AsGeoJSON(#{geo_object_type}::geometry) a " \
    "FROM geographic_items WHERE id=#{id};")['a']
end

# @return [Hash]
#   the shape as a GeoJSON Feature with some item metadata
def to_geo_json_feature
  @geometry ||= to_geo_json
  {'type' => 'Feature',
   'geometry' => geometry,
   'properties' => {
     'geographic_item' => {
       'id' => id}
   }
  }
end

# @param value [String] like:
#   '{"type":"Feature","geometry":{"type":"Point","coordinates":[2.5,4.0]},"properties":{"color":"red"}}'
#
#   '{"type":"Feature","geometry":{"type":"Polygon","coordinates":"[[[-125.29394388198853, 48.584480409793],
#      [-67.11035013198853, 45.09937589848195],[-80.64550638198853, 25.01924647619111],[-117.55956888198853,
#      32.5591595028449],[-125.29394388198853, 48.584480409793]]]"},"properties":{}}'
#
#  '{"type":"Point","coordinates":[2.5,4.0]},"properties":{"color":"red"}}'
#
# @return [Boolean, RGeo object]
def shape=(value)

  if value.present?
    geom = RGeo::GeoJSON.decode(value, json_parser: :json, geo_factory: Gis::FACTORY)
    this_type = nil

    if geom.respond_to?(:geometry_type)
      this_type = geom.geometry_type.to_s
    elsif geom.respond_to?(:geometry)
      this_type = geom.geometry.geometry_type.to_s
    else
    end

    self.type = GeographicItem.eval_for_type(this_type) unless geom.nil?

    if type.blank?
      errors.add(:base, 'type is not set from shape')
      return
    end
    # raise('GeographicItem.type not set.') if type.blank?

    object = nil

    s = geom.respond_to?(:geometry) ? geom.geometry.to_s : geom.to_s

    begin
      object = Gis::FACTORY.parse_wkt(s)
    rescue RGeo::Error::InvalidGeometry
      errors.add(:self, 'Shape value is an Invalid Geometry')
    end

    write_attribute(this_type.underscore.to_sym, object)
    geom
  end
end

# @return [String]
def to_wkt
  #  10k  #<Benchmark::Tms:0x00007fb0dfd30fd0 @label="", @real=25.237487000005785, @cstime=0.0, @cutime=0.0, @stime=1.1704609999999995, @utime=5.507929999999988, @total=6.678390999999987>
  #  GeographicItem.select("ST_AsText( #{GeographicItem::GEOMETRY_SQL.to_sql}) wkt").where(id: id).first.wkt

  # 10k <Benchmark::Tms:0x00007fb0e02f7540 @label="", @real=21.619827999995323, @cstime=0.0, @cutime=0.0, @stime=0.8850890000000007, @utime=3.2958549999999605, @total=4.180943999999961>
  if a =  ApplicationRecord.connection.execute( "SELECT ST_AsText( #{GeographicItem::GEOMETRY_SQL.to_sql} ) wkt from geographic_items where geographic_items.id = #{id}").first
    return a['wkt']
  else
    return nil
  end
end

# @return  [Float] in meters, calculated
# TODO: share with world
#    Geographic item 96862 (Cajamar in Brazil) is the only(?) record to fail using `false` (quicker) method of everything we tested
def area
  a = GeographicItem.where(id:).select("ST_Area(#{GeographicItem::GEOGRAPHY_SQL}, true) as area_in_meters").first['area_in_meters']
  a = nil if a.nan?
  a
end

# @return [Float, false]
#    the value in square meters of the interesecting area of this and another GeographicItem
def intersecting_area(geographic_item_id)
  a = GeographicItem.aliased_geographic_sql('a')
  b = GeographicItem.aliased_geographic_sql('b')

  c = GeographicItem.connection.execute(
    "SELECT ST_Area(ST_Intersection(#{a}, #{b})) as intersecting_area
      FROM geographic_items a, geographic_items b
      WHERE a.id = #{id} AND b.id = #{geographic_item_id};"
  ).first
  c && c['intersecting_area'].to_f
end

# TODO: This is bad, while internal use of ONE_WEST_MEAN is consistent it is in-accurate given the vast differences of radius vs. lat/long position.
# When we strike the error-polygon from radius we should remove this
#
# Use case is returning the radius from a circle we calculated via buffer for error-polygon creation.
def radius
  r = ApplicationRecord.connection.execute( "SELECT ST_MinimumBoundingRadius( ST_Transform(  #{GeographicItem::GEOMETRY_SQL.to_sql}, 4326 )  ) AS radius from geographic_items where geographic_items.id = #{id}").first['radius'].split(',').last.chop.to_f
  r = (r * Utilities::Geo::ONE_WEST_MEAN).to_i
end


# Convention is to store in PostGIS in CCW
# @return Array [Boolean]
#   false - cw
#   true - ccw (preferred), except cee donuts
def orientations
  if multi_polygon.present?
    ApplicationRecord.connection.execute(" \
         SELECT ST_IsPolygonCCW(a.geom) as is_ccw
            FROM ( SELECT b.id, (ST_Dump(p_geom)).geom AS geom
               FROM (SELECT id, multi_polygon::geometry AS p_geom FROM geographic_items where id = #{id}) AS b \
          ) AS a;").collect{|a| a['is_ccw']}
  elsif polygon.present?
    ApplicationRecord.connection.execute("SELECT ST_IsPolygonCCW(polygon::geometry) as is_ccw \
            FROM geographic_items where  id = #{id};").collect{|a| a['is_ccw']}
  else
    []
  end
end

# @return Boolean
#   looks at all orientations
#   if they follow the pattern [true, false, ... <all false>] then `true`, else `false`
# !! Does not confirm that shapes are nested !!
def is_basic_donut?
  a = orientations
  b = a.shift
  return false unless b
  a.uniq!
  a == [false]
end

def st_isvalid
  r = ApplicationRecord.connection.execute( "SELECT ST_IsValid(  #{GeographicItem::GEOMETRY_SQL.to_sql }) from  geographic_items where geographic_items.id = #{id}").first['st_isvalid']
end

def st_isvalidreason
  r = ApplicationRecord.connection.execute( "SELECT ST_IsValidReason(  #{GeographicItem::GEOMETRY_SQL.to_sql }) from  geographic_items where geographic_items.id = #{id}").first['st_isvalidreason']
end

# !! Unused. Doesn't check Geometry collection
def has_polygons?
  ['GeographicItem::MultiPolygon', 'GeographicItem::Polygon'].include?(self.type)
end

private

def align_winding
  if orientations.flatten.include?(false)
    case type
    when 'multi_polygon'
      ApplicationRecord.connection.execute(
        "UPDATE geographic_items set multi_polygon = ST_ForcePolygonCCW(multi_polygon::geometry) 
          WHERE id = #{self.id};"
       )
    when 'polygon'
     ApplicationRecord.connection.execute(
        "UPDATE geographic_items set polygon = ST_ForcePolygonCCW(polygon::geometry) 
          WHERE id = #{self.id};"
       )
    end     
  end
  true
end

# Crude debuging helper, write the shapes
# to a png
def self.debug_draw(geographic_item_ids = [])
  return false if geographic_item_ids.empty?

  sql = "SELECT ST_AsPNG(
     ST_AsRaster(
        (SELECT ST_Union(multi_polygon::geometry) from geographic_items where id IN (" + geographic_item_ids.join(',') + ")), 1920, 1080
    )
   ) png;"

  # ST_Buffer( multi_polygon::geometry, 0, 'join=bevel'),
  #     1920,
  #     1080)


  result = ActiveRecord::Base.connection.execute(sql).first['png']
  r = ActiveRecord::Base.connection.unescape_bytea(result)

  prefix = if geographic_item_ids.size > 10
             'multiple'
           else
             geographic_item_ids.join('_') + '_debug.draw.png'
           end

  n = prefix + '_debug.draw.png'

  # Open the file in binary write mode ("wb")
  File.open(n, 'wb') do |file|
    # Write the binary data to the file
    file.write(r)
  end
end

# def png

#   if ids = Otu.joins(:cached_map_items).first.cached_map_items.pluck(:geographic_item_id)

#     sql = "SELECT ST_AsPNG(
#    ST_AsRaster(
#        ST_Buffer( multi_polygon::geometry, 0, 'join=bevel'),
#            1024,
#            768)
#     ) png
#        from geographic_items where id IN (" + ids.join(',') + ');'

#     # hack, not the best way to unpack result
#     result = ActiveRecord::Base.connection.execute(sql).first['png']
#     r = ActiveRecord::Base.connection.unescape_bytea(result)

#     send_data r, filename: 'foo.png', type: 'imnage/png'

#   else
#     render json: {foo: false}
#   end
# end

def set_cached
  update_column(:cached_total_area, area)
end

# @return [Symbol]
#   returns the attribute (column name) containing data
#   nearly all methods should use #geo_object_type, not geo_type
def geo_type
  DATA_TYPES.each { |item|
    return item if send(item)
  }
  nil
end

# @return [Boolean, String] false if already set, or type to which it was set
def set_type_if_geography_present
  if type.blank?
    column = geo_type
    self.type = "GeographicItem::#{column.to_s.camelize}" if column
  end
end

# @param [RGeo::Point] point
# @return [Array] of a point
#   Longitude |, Latitude -
def point_to_a(point)
  data = []
  data.push(point.x, point.y)
  data
end

# @param [RGeo::Point] point
# @return [Hash] of a point
def point_to_hash(point)
  {points: [point_to_a(point)]}
end

# @param [RGeo::MultiPoint] multi_point
# @return [Array] of points
def multi_point_to_a(multi_point)
  data = []
  multi_point.each { |point|
    data.push([point.x, point.y])
  }
  data
end

# @return [Hash] of points
def multi_point_to_hash(_multi_point)
  # when we encounter a multi_point type, we only stick the points into the array, NOT it's identity as a group
  {points: multi_point_to_a(multi_point)}
end

# @param [Reo::LineString] line_string
# @return [Array] of points in the line
def line_string_to_a(line_string)
  data = []
  line_string.points.each { |point|
    data.push([point.x, point.y])
  }
  data
end

# @param [Reo::LineString] line_string
# @return [Hash] of points in the line
def line_string_to_hash(line_string)
  {lines: [line_string_to_a(line_string)]}
end

# @param [RGeo::Polygon] polygon
# @return [Array] of points in the polygon (exterior_ring ONLY)
def polygon_to_a(polygon)
  # TODO: handle other parts of the polygon; i.e., the interior_rings (if they exist)
  data = []
  polygon.exterior_ring.points.each { |point|
    data.push([point.x, point.y])
  }
  data
end

# @param [RGeo::Polygon] polygon
# @return [Hash] of points in the polygon (exterior_ring ONLY)
def polygon_to_hash(polygon)
  {polygons: [polygon_to_a(polygon)]}
end

# @return [Array] of line_strings as arrays of points
# @param [RGeo::MultiLineString] multi_line_string
def multi_line_string_to_a(multi_line_string)
  data = []
  multi_line_string.each { |line_string|
    line_data = []
    line_string.points.each { |point|
      line_data.push([point.x, point.y])
    }
    data.push(line_data)
  }
  data
end

# @return [Hash] of line_strings as hashes of points
def multi_line_string_to_hash(_multi_line_string)
  {lines: to_a}
end

# @param [RGeo::MultiPolygon] multi_polygon
# @return [Array] of arrays of points in the polygons (exterior_ring ONLY)
def multi_polygon_to_a(multi_polygon)
  data = []
  multi_polygon.each { |polygon|
    polygon_data = []
    polygon.exterior_ring.points.each { |point|
      polygon_data.push([point.x, point.y])
    }
    data.push(polygon_data)
  }
  data
end

# @return [Hash] of hashes of points in the polygons (exterior_ring ONLY)
def multi_polygon_to_hash(_multi_polygon)
  {polygons: to_a}
end

# @return [Boolean] iff there is one and only one shape column set
def some_data_is_provided
  data = []

  DATA_TYPES.each do |item|
    data.push(item) if send(item).present?
  end

  case data.count
  when 0
    errors.add(:base, 'No shape provided or provided shape is invalid')
  when 1
    return true
  else
    data.each do |object|
      errors.add(object, 'More than one shape type provided')
    end
  end
  true
end
end

#multi_polygon ⇒ `RGeo::Geographic::ProjectedMultiPolygonImpl`

CCW orientation is applied

Returns:

(RGeo::Geographic::ProjectedMultiPolygonImpl)

# File 'app/models/geographic_item.rb', line 40

class GeographicItem < ApplicationRecord
  include Housekeeping::Users
  include Housekeeping::Timestamps
  include Shared::HasPapertrail
  include Shared::IsData
  include Shared::SharedAcrossProjects

  # @return [Hash, nil]
  #   An internal variable for use in super calls, holds a Hash in GeoJSON format (temporarily)
  attr_accessor :geometry

  # @return [Boolean, RGeo object]
  # @params value [Hash in GeoJSON format] ?!
  # TODO: WHY! boolean not nil, or object
  # Used to build geographic items from a shape [ of what class ] !?
  attr_accessor :shape

  # @return [Boolean]
  #   When true cached values are not built
  attr_accessor :no_cached

  DATA_TYPES = [
:point,
:line_string,
:polygon,
:multi_point,
:multi_line_string,
:multi_polygon,
:geometry_collection
  ].freeze

  GEOMETRY_SQL = Arel::Nodes::Case.new(arel_table[:type])
.when('GeographicItem::MultiPolygon').then(Arel::Nodes::NamedFunction.new('CAST', [arel_table[:multi_polygon].as('geometry')]))
.when('GeographicItem::Point').then(Arel::Nodes::NamedFunction.new('CAST', [arel_table[:point].as('geometry')]))
.when('GeographicItem::LineString').then(Arel::Nodes::NamedFunction.new('CAST', [arel_table[:line_string].as('geometry')]))
.when('GeographicItem::Polygon').then(Arel::Nodes::NamedFunction.new('CAST', [arel_table[:polygon].as('geometry')]))
.when('GeographicItem::MultiLineString').then(Arel::Nodes::NamedFunction.new('CAST', [arel_table[:multi_line_string].as('geometry')]))
.when('GeographicItem::MultiPoint').then(Arel::Nodes::NamedFunction.new('CAST', [arel_table[:multi_point].as('geometry')]))
.when('GeographicItem::GeometryCollection').then(Arel::Nodes::NamedFunction.new('CAST', [arel_table[:geometry_collection].as('geometry')]))
.freeze

  GEOGRAPHY_SQL = "CASE geographic_items.type
WHEN 'GeographicItem::MultiPolygon' THEN multi_polygon
WHEN 'GeographicItem::Point' THEN point
WHEN 'GeographicItem::LineString' THEN line_string
WHEN 'GeographicItem::Polygon' THEN polygon
WHEN 'GeographicItem::MultiLineString' THEN multi_line_string
WHEN 'GeographicItem::MultiPoint' THEN multi_point
WHEN 'GeographicItem::GeometryCollection' THEN geometry_collection
END".freeze

# ANTI_MERIDIAN = '0X0102000020E61000000200000000000000008066400000000000405640000000000080664000000000004056C0'
ANTI_MERIDIAN = 'LINESTRING (180 89.0, 180 -89)'.freeze

has_many :cached_map_items, inverse_of: :geographic_item

has_many :geographic_areas_geographic_items, dependent: :destroy, inverse_of: :geographic_item
has_many :geographic_areas, through: :geographic_areas_geographic_items
has_many :asserted_distributions, through: :geographic_areas
has_many :geographic_area_types, through: :geographic_areas
has_many :parent_geographic_areas, through: :geographic_areas, source: :parent

has_many :georeferences, inverse_of: :geographic_item
has_many :georeferences_through_error_geographic_item,
  class_name: 'Georeference', foreign_key: :error_geographic_item_id, inverse_of: :error_geographic_item
has_many :collecting_events_through_georeferences, through: :georeferences, source: :collecting_event
has_many :collecting_events_through_georeference_error_geographic_item,
  through: :georeferences_through_error_geographic_item, source: :collecting_event

# TODO: THIS IS NOT GOOD
before_validation :set_type_if_geography_present

validate :some_data_is_provided
validates :type, presence: true # not needed

scope :include_collecting_event, -> { includes(:collecting_events_through_georeferences) }
scope :geo_with_collecting_event, -> { joins(:collecting_events_through_georeferences) }
scope :err_with_collecting_event, -> { joins(:georeferences_through_error_geographic_item) }

after_save :set_cached, unless: Proc.new {|n| n.no_cached || errors.any? }
after_save :align_winding

class << self

  def aliased_geographic_sql(name = 'a')
    "CASE #{name}.type \
     WHEN 'GeographicItem::MultiPolygon' THEN #{name}.multi_polygon \
     WHEN 'GeographicItem::Point' THEN #{name}.point \
     WHEN 'GeographicItem::LineString' THEN #{name}.line_string \
     WHEN 'GeographicItem::Polygon' THEN #{name}.polygon \
     WHEN 'GeographicItem::MultiLineString' THEN #{name}.multi_line_string \
     WHEN 'GeographicItem::MultiPoint' THEN #{name}.multi_point \
     WHEN 'GeographicItem::GeometryCollection' THEN #{name}.geometry_collection \
     END"
  end

  def st_union(geographic_item_scope)
    GeographicItem.select("ST_Union(#{GeographicItem::GEOMETRY_SQL.to_sql}) as collection")
      .where(id: geographic_item_scope.pluck(:id))
  end

  def st_collect(geographic_item_scope)
    GeographicItem.select("ST_Collect(#{GeographicItem::GEOMETRY_SQL.to_sql}) as collection")
      .where(id: geographic_item_scope.pluck(:id))
  end

  # @return [GeographicItem::ActiveRecord_Relation]
  # @params [Array] array of geographic area ids
  def default_by_geographic_area_ids(geographic_area_ids = [])
    GeographicItem.
      joins(:geographic_areas_geographic_items).
      merge(::GeographicAreasGeographicItem.default_geographic_item_data).
      where(geographic_areas_geographic_items: {geographic_area_id: geographic_area_ids})
  end

  # @param [String] wkt
  # @return [Boolean]
  #   whether or not the wtk intersects with the anti-meridian
  #   !! StrongParams security considerations
  def crosses_anti_meridian?(wkt)
    GeographicItem.find_by_sql(
      ['SELECT ST_Intersects(ST_GeogFromText(?), ST_GeogFromText(?)) as r;', wkt, ANTI_MERIDIAN]
    ).first.r
  end

  # @param [Integer] ids
  # @return [Boolean]
  #   whether or not any GeographicItem passed intersects the anti-meridian
  #   !! StrongParams security considerations
  #   This is our first line of defense against queries that define multiple shapes, one or
  #   more of which crosses the anti-meridian.  In this case the current TW strategy within the
  #   UI is to abandon the search, and prompt the user to refactor the query.
  def crosses_anti_meridian_by_id?(*ids)
    q1 = ["SELECT ST_Intersects((SELECT single_geometry FROM (#{GeographicItem.single_geometry_sql(*ids)}) as " \
          'left_intersect), ST_GeogFromText(?)) as r;', ANTI_MERIDIAN]
    _q2 = ActiveRecord::Base.send(:sanitize_sql_array, ['SELECT ST_Intersects((SELECT single_geometry FROM (?) as ' \
                                                        'left_intersect), ST_GeogFromText(?)) as r;', GeographicItem.single_geometry_sql(*ids), ANTI_MERIDIAN])
    GeographicItem.find_by_sql(q1).first.r
  end

  #
  # SQL fragments
  #

  # @param [Integer, String]
  # @return [String]
  #   a SQL select statement that returns the *geometry* for the geographic_item with the specified id
  def select_geometry_sql(geographic_item_id)
    "SELECT #{GeographicItem::GEOMETRY_SQL.to_sql} from geographic_items where geographic_items.id = #{geographic_item_id}"
  end

  # @param [Integer, String]
  # @return [String]
  #   a SQL select statement that returns the geography for the geographic_item with the specified id
  def select_geography_sql(geographic_item_id)
    ActiveRecord::Base.send(:sanitize_sql_for_conditions, [
      "SELECT #{GeographicItem::GEOMETRY_SQL.to_sql} from geographic_items where geographic_items.id = ?",
      geographic_item_id])
  end

  # @param [Symbol] choice
  # @return [String]
  #   a fragment returning either latitude or longitude columns
  def lat_long_sql(choice)
    return nil unless [:latitude, :longitude].include?(choice)
    f = "'D.DDDDDD'" # TODO: probably a constant somewhere
    v = (choice == :latitude ? 1 : 2)
    "CASE geographic_items.type
  WHEN 'GeographicItem::GeometryCollection' THEN split_part(ST_AsLatLonText(ST_Centroid" \
  "(geometry_collection::geometry), #{f}), ' ', #{v})
  WHEN 'GeographicItem::LineString' THEN split_part(ST_AsLatLonText(ST_Centroid(line_string::geometry), " \
  "#{f}), ' ', #{v})
  WHEN 'GeographicItem::MultiPolygon' THEN split_part(ST_AsLatLonText(" \
  "ST_Centroid(multi_polygon::geometry), #{f}), ' ', #{v})
  WHEN 'GeographicItem::Point' THEN split_part(ST_AsLatLonText(" \
  "ST_Centroid(point::geometry), #{f}), ' ', #{v})
  WHEN 'GeographicItem::Polygon' THEN split_part(ST_AsLatLonText(" \
  "ST_Centroid(polygon::geometry), #{f}), ' ', #{v})
  WHEN 'GeographicItem::MultiLineString' THEN split_part(ST_AsLatLonText(" \
  "ST_Centroid(multi_line_string::geometry), #{f} ), ' ', #{v})
  WHEN 'GeographicItem::MultiPoint' THEN split_part(ST_AsLatLonText(" \
  "ST_Centroid(multi_point::geometry), #{f}), ' ', #{v})
END as #{choice}"
  end

  # @param [Integer] geographic_item_id
  # @param [Integer] distance
  # @return [String]
  def within_radius_of_item_sql(geographic_item_id, distance)
    "ST_DWithin((#{GeographicItem::GEOGRAPHY_SQL}), (#{select_geography_sql(geographic_item_id)}), #{distance})"
  end


  # @param [Integer] geographic_item_id
  # @param [Number] distance in meters to grow/shrink the shape (negative allowed)
  # @param [Number] distance (in meters) (positive only?!)
  # @return [String]
  def st_buffer_st_within(geographic_item_id, distance, buffer = 0)
    "ST_DWithin(
    ST_Buffer(#{GeographicItem::GEOGRAPHY_SQL}, #{buffer}),
    (#{select_geography_sql(geographic_item_id)}), #{distance}
   )"
  end


  # TODO: 3D is overkill here
  # @param [String] wkt
  # @param [Integer] distance (meters)
  # @return [String]
  # !! This is intersecting
  def intersecting_radius_of_wkt_sql(wkt, distance)
    "ST_DWithin((#{GeographicItem::GEOGRAPHY_SQL}), ST_Transform( ST_GeomFromText('#{wkt}', " \
      "4326), 4326), #{distance})"
  end

  # @param [String] wkt
  # @param [Integer] distance (meters)
  # @return [String]
  # !! This is fully covering
  def within_radius_of_wkt_sql(wkt, distance)
    "ST_Covers( ST_Buffer(ST_SetSRID( ST_GeomFromText('#{wkt}'), 4326)::geography, #{distance}), (#{GeographicItem::GEOGRAPHY_SQL}))"
  end

  # @param [String, Integer, String]
  # @return [String]
  #   a SQL fragment for ST_Contains() function, returns
  #   all geographic items which are contained in the item supplied
  def containing_sql(target_column_name = nil, geographic_item_id = nil, source_column_name = nil)
    return 'false' if geographic_item_id.nil? || source_column_name.nil? || target_column_name.nil?
    "ST_Contains(#{target_column_name}::geometry, (#{geometry_sql(geographic_item_id, source_column_name)}))"
  end

  # @param [String, Integer, String]
  # @return [String]
  #   a SQL fragment for ST_Contains(), returns
  #   all geographic_items which contain the supplied geographic_item
  def reverse_containing_sql(target_column_name = nil, geographic_item_id = nil, source_column_name = nil)
    return 'false' if geographic_item_id.nil? || source_column_name.nil? || target_column_name.nil?
    "ST_Contains((#{geometry_sql(geographic_item_id, source_column_name)}), #{target_column_name}::geometry)"
  end

  # @param [Integer, String]
  # @return [String]
  #   a SQL fragment that represents the geometry of the geographic item specified (which has data in the
  # source_column_name, i.e. geo_object_type)
  def geometry_sql(geographic_item_id = nil, source_column_name = nil)
    return 'false' if geographic_item_id.nil? || source_column_name.nil?
    "select geom_alias_tbl.#{source_column_name}::geometry from geographic_items geom_alias_tbl " \
      "where geom_alias_tbl.id = #{geographic_item_id}"
  end

  # rubocop:disable Metrics/MethodLength
  # @param [String] column_name
  # @param [GeographicItem] geographic_item
  # @return [String] of SQL
  def is_contained_by_sql(column_name, geographic_item)
    geo_id = geographic_item.id
    geo_type = geographic_item.geo_object_type
    template = '(ST_Contains((select geographic_items.%s::geometry from geographic_items where ' \
      'geographic_items.id = %d), %s::geometry))'
    retval = []
    column_name.downcase!
    case column_name
    when 'any'
      DATA_TYPES.each { |column|
        unless column == :geometry_collection
          retval.push(template % [geo_type, geo_id, column])
        end
      }
    when 'any_poly', 'any_line'
      DATA_TYPES.each { |column|
        unless column == :geometry_collection
          if column.to_s.index(column_name.gsub('any_', ''))
            retval.push(template % [geo_type, geo_id, column])
          end
        end
      }
    else
      retval = template % [geo_type, geo_id, column_name]
    end
    retval = retval.join(' OR ') if retval.instance_of?(Array)
    retval
  end

  # @param [Interger, Array of Integer] geographic_item_ids
  # @return [String]
  #   a select query that returns a single geometry (column name 'single_geometry' for the collection of ids
  # provided via ST_Collect)
  def st_collect_sql(*geographic_item_ids)
    geographic_item_ids.flatten!
    ActiveRecord::Base.send(:sanitize_sql_for_conditions, [
      "SELECT ST_Collect(f.the_geom) AS single_geometry
 FROM (
    SELECT (ST_DUMP(#{GeographicItem::GEOMETRY_SQL.to_sql})).geom as the_geom
    FROM geographic_items
    WHERE id in (?))
  AS f", geographic_item_ids])
  end

  # @param [Interger, Array of Integer] geographic_item_ids
  # @return [String]
  #    returns one or more geographic items combined as a single geometry in column 'single'
  def single_geometry_sql(*geographic_item_ids)
    a = GeographicItem.st_collect_sql(geographic_item_ids)
    '(SELECT single.single_geometry FROM (' + a + ' ) AS single)'
  end

  # @param [Interger, Array of Integer] geographic_item_ids
  # @return [String]
  #   returns a single geometry "column" (paren wrapped) as "single" for multiple geographic item ids, or the
  # geometry as 'geometry' for a single id
  def geometry_sql2(*geographic_item_ids)
    geographic_item_ids.flatten! # *ALWAYS* reduce the pile to a single level of ids
    if geographic_item_ids.count == 1
      "(#{GeographicItem.geometry_for_sql(geographic_item_ids.first)})"
    else
      GeographicItem.single_geometry_sql(geographic_item_ids)
    end
  end

  # @param [Interger, Array of Integer] geographic_item_ids
  # @return [String]
  def containing_where_sql(*geographic_item_ids)
    "ST_CoveredBy(
      #{GeographicItem.geometry_sql2(*geographic_item_ids)},
       CASE geographic_items.type
         WHEN 'GeographicItem::MultiPolygon' THEN multi_polygon::geometry
         WHEN 'GeographicItem::Point' THEN point::geometry
         WHEN 'GeographicItem::LineString' THEN line_string::geometry
         WHEN 'GeographicItem::Polygon' THEN polygon::geometry
         WHEN 'GeographicItem::MultiLineString' THEN multi_line_string::geometry
         WHEN 'GeographicItem::MultiPoint' THEN multi_point::geometry
      END)"
  end

  # @param [Interger, Array of Integer] geographic_item_ids
  # @return [String]
  def containing_where_sql_geog(*geographic_item_ids)
    "ST_CoveredBy(
      #{GeographicItem.geometry_sql2(*geographic_item_ids)},
       CASE geographic_items.type
         WHEN 'GeographicItem::MultiPolygon' THEN multi_polygon::geography
         WHEN 'GeographicItem::Point' THEN point::geography
         WHEN 'GeographicItem::LineString' THEN line_string::geography
         WHEN 'GeographicItem::Polygon' THEN polygon::geography
         WHEN 'GeographicItem::MultiLineString' THEN multi_line_string::geography
         WHEN 'GeographicItem::MultiPoint' THEN multi_point::geography
      END)"
  end

  # @param [Interger, Array of Integer] ids
  # @return [Array]
  #   If we detect that some query id has crossed the meridian, then loop through
  #   and "manually" build up a list of results.
  #   Should only be used if GeographicItem.crosses_anti_meridian_by_id? is true.
  #   Note that this does not return a Scope, so you can't chain it like contained_by?
  # TODO: test this
  def contained_by_with_antimeridian_check(*ids)
    ids.flatten! # make sure there is only one level of splat (*)
    results = []

    crossing_ids = []

    ids.each do |id|
      # push each which crosses
      crossing_ids.push(id) if GeographicItem.crosses_anti_meridian_by_id?(id)
    end

    non_crossing_ids = ids - crossing_ids
    results.push GeographicItem.contained_by(non_crossing_ids).to_a if non_crossing_ids.any?

    crossing_ids.each do |id|
      # [61666, 61661, 61659, 61654, 61639]
      q1 = ActiveRecord::Base.send(:sanitize_sql_array, ['SELECT ST_AsText((SELECT polygon FROM geographic_items ' \
                                                         'WHERE id = ?))', id])
      r = GeographicItem.where(
        # GeographicItem.contained_by_wkt_shifted_sql(GeographicItem.find(id).geo_object.to_s)
        GeographicItem.contained_by_wkt_shifted_sql(
          ApplicationRecord.connection.execute(q1).first['st_astext'])
      ).to_a
      results.push(r)
    end

    results.flatten.uniq
  end

  # @params [String] well known text
  # @return [String] the SQL fragment for the specific geometry type, shifted by longitude
  # Note: this routine is called when it is already known that the A argument crosses anti-meridian
  def contained_by_wkt_shifted_sql(wkt)
    "ST_Contains(ST_ShiftLongitude(ST_GeomFromText('#{wkt}', 4326)), (
    CASE geographic_items.type
       WHEN 'GeographicItem::MultiPolygon' THEN ST_ShiftLongitude(multi_polygon::geometry)
       WHEN 'GeographicItem::Point' THEN ST_ShiftLongitude(point::geometry)
       WHEN 'GeographicItem::LineString' THEN ST_ShiftLongitude(line_string::geometry)
       WHEN 'GeographicItem::Polygon' THEN ST_ShiftLongitude(polygon::geometry)
       WHEN 'GeographicItem::MultiLineString' THEN ST_ShiftLongitude(multi_line_string::geometry)
       WHEN 'GeographicItem::MultiPoint' THEN ST_ShiftLongitude(multi_point::geometry)
    END
    )
  )"
  end

  # TODO: Remove the hard coded 4326 reference
  # @params [String] wkt
  # @return [String] SQL fragment limiting geographics items to those in this WKT
  def contained_by_wkt_sql(wkt)
    if crosses_anti_meridian?(wkt)
      retval = contained_by_wkt_shifted_sql(wkt)
    else
      retval = "ST_Contains(ST_GeomFromText('#{wkt}', 4326), (
    CASE geographic_items.type
       WHEN 'GeographicItem::MultiPolygon' THEN multi_polygon::geometry
       WHEN 'GeographicItem::Point' THEN point::geometry
       WHEN 'GeographicItem::LineString' THEN line_string::geometry
       WHEN 'GeographicItem::Polygon' THEN polygon::geometry
       WHEN 'GeographicItem::MultiLineString' THEN multi_line_string::geometry
       WHEN 'GeographicItem::MultiPoint' THEN multi_point::geometry
    END
    )
  )"
    end
    retval
  end

  # @param [Interger, Array of Integer] geographic_item_ids
  # @return [String] sql for contained_by via ST_ContainsProperly
  # Note: Can not use GEOMETRY_SQL because geometry_collection is not supported in ST_ContainsProperly
  # Note: !! If the target GeographicItem#id crosses the anti-meridian then you may/will get unexpected results.
  def contained_by_where_sql(*geographic_item_ids)
    "ST_Contains(
    #{GeographicItem.geometry_sql2(*geographic_item_ids)},
    CASE geographic_items.type
      WHEN 'GeographicItem::MultiPolygon' THEN multi_polygon::geometry
      WHEN 'GeographicItem::Point' THEN point::geometry
      WHEN 'GeographicItem::LineString' THEN line_string::geometry
      WHEN 'GeographicItem::Polygon' THEN polygon::geometry
      WHEN 'GeographicItem::MultiLineString' THEN multi_line_string::geometry
      WHEN 'GeographicItem::MultiPoint' THEN multi_point::geometry
    END)"
  end

  # @param [RGeo:Point] rgeo_point
  # @return [String] sql for containing via ST_CoveredBy
  # TODO: Remove the hard coded 4326 reference
  # TODO: should this be wkt_point instead of rgeo_point?
  def containing_where_for_point_sql(rgeo_point)
    "ST_CoveredBy(
  ST_GeomFromText('#{rgeo_point}', 4326),
  #{GeographicItem::GEOMETRY_SQL.to_sql}
 )"
  end

  # @param [Interger] geographic_item_id
  # @return [String] SQL for geometries
  # example, not used
  def geometry_for_sql(geographic_item_id)
    'SELECT ' + GeographicItem::GEOMETRY_SQL.to_sql + ' AS geometry FROM geographic_items WHERE id = ' \
      "#{geographic_item_id} LIMIT 1"
  end

  # @param [Interger, Array of Integer] geographic_item_ids
  # @return [String] SQL for geometries
  # example, not used
  def geometry_for_collection_sql(*geographic_item_ids)
    'SELECT ' + GeographicItem::GEOMETRY_SQL.to_sql + ' AS geometry FROM geographic_items WHERE id IN ' \
      "( #{geographic_item_ids.join(',')} )"
  end

  #
  # Scopes
  #

  # @param [Interger, Array of Integer] geographic_item_ids
  # @return [Scope]
  #    the geographic items containing these collective geographic_item ids, not including self
  def containing(*geographic_item_ids)
    where(GeographicItem.containing_where_sql(geographic_item_ids)).not_ids(*geographic_item_ids)
  end

  # @param [Interger, Array of Integer] geographic_item_ids
  # @return [Scope]
  #    the geographic items contained by any of these geographic_item ids, not including self
  # (works via ST_ContainsProperly)
  def contained_by(*geographic_item_ids)
    where(GeographicItem.contained_by_where_sql(geographic_item_ids))
  end

  # @param [RGeo::Point] rgeo_point
  # @return [Scope]
  #    the geographic items containing this point
  # TODO: should be containing_wkt ?
  def containing_point(rgeo_point)
    where(GeographicItem.containing_where_for_point_sql(rgeo_point))
  end

  # @return [Scope]
  #   adds an area_in_meters field, with meters
  def with_area
    select("ST_Area(#{GeographicItem::GEOGRAPHY_SQL}, false) as area_in_meters")
  end

  # return [Scope]
  #   A scope that limits the result to those GeographicItems that have a collecting event
  #   through either the geographic_item or the error_geographic_item
  #
  # A raw SQL join approach for comparison
  #
  # GeographicItem.joins('LEFT JOIN georeferences g1 ON geographic_items.id = g1.geographic_item_id').
  #   joins('LEFT JOIN georeferences g2 ON geographic_items.id = g2.error_geographic_item_id').
  #   where("(g1.geographic_item_id IS NOT NULL OR g2.error_geographic_item_id IS NOT NULL)").uniq

  # @return [Scope] GeographicItem
  # This uses an Arel table approach, this is ultimately more decomposable if we need. Of use:
  #  http://danshultz.github.io/talks/mastering_activerecord_arel  <- best
  #  https://github.com/rails/arel
  #  http://stackoverflow.com/questions/4500629/use-arel-for-a-nested-set-join-query-and-convert-to-activerecordrelation
  #  http://rdoc.info/github/rails/arel/Arel/SelectManager
  #  http://stackoverflow.com/questions/7976358/activerecord-arel-or-condition
  #
  def with_collecting_event_through_georeferences
    geographic_items = GeographicItem.arel_table
    georeferences = Georeference.arel_table
    g1 = georeferences.alias('a')
    g2 = georeferences.alias('b')

    c = geographic_items.join(g1, Arel::Nodes::OuterJoin).on(geographic_items[:id].eq(g1[:geographic_item_id]))
      .join(g2, Arel::Nodes::OuterJoin).on(geographic_items[:id].eq(g2[:error_geographic_item_id]))

    GeographicItem.joins(# turn the Arel back into scope
                         c.join_sources # translate the Arel join to a join hash(?)
                        ).where(
                          g1[:id].not_eq(nil).or(g2[:id].not_eq(nil)) # returns a Arel::Nodes::Grouping
                        ).distinct
  end

  # @return [Scope] include a 'latitude' column
  def with_latitude
    select(lat_long_sql(:latitude))
  end

  # @return [Scope] include a 'longitude' column
  def with_longitude
    select(lat_long_sql(:longitude))
  end

  # @param [String, GeographicItems]
  # @return [Scope]
  def intersecting(column_name, *geographic_items)
    if column_name.downcase == 'any'
      pieces = []
      DATA_TYPES.each { |column|
        pieces.push(GeographicItem.intersecting(column.to_s, geographic_items).to_a)
      }

      # @TODO change 'id in (?)' to some other sql construct

      GeographicItem.where(id: pieces.flatten.map(&:id))
    else
      q = geographic_items.flatten.collect { |geographic_item|
        "ST_Intersects(#{column_name}, '#{geographic_item.geo_object}'    )" # seems like we want this: http://danshultz.github.io/talks/mastering_activerecord_arel/#/15/2
      }.join(' or ')

      where(q)
    end
  end

  # @param [GeographicItem#id] geographic_item_id
  # @param [Float] distance in meters ?!?!
  # @return [ActiveRecord::Relation]
  # !! should be distance, not radius?!
  def within_radius_of_item(geographic_item_id, distance)
    where(within_radius_of_item_sql(geographic_item_id, distance))
  end

  # @param [String, GeographicItem]
  # @return [Scope]
  #   a SQL fragment for ST_DISJOINT, specifies all geographic_items that have data in column_name
  #   that are disjoint from the passed geographic_items
  def disjoint_from(column_name, *geographic_items)
    q = geographic_items.flatten.collect { |geographic_item|
      "ST_DISJOINT(#{column_name}::geometry, (#{geometry_sql(geographic_item.to_param,
                                                         geographic_item.geo_object_type)}))"
    }.join(' and ')

    where(q)
  end

  # @return [Scope]
  #   see are_contained_in_item_by_id
  # @param [String] column_name
  # @param [GeographicItem, Array] geographic_items
  def are_contained_in_item(column_name, *geographic_items)
    are_contained_in_item_by_id(column_name, geographic_items.flatten.map(&:id))
  end

  # rubocop:disable Metrics/MethodLength
  # @param [String] column_name to search
  # @param [GeographicItem] geographic_item_ids or array of geographic_item_ids to be tested.
  # @return [Scope] of GeographicItems
  #
  # If this scope is given an Array of GeographicItems as a second parameter,
  # it will return the 'OR' of each of the objects against the table.
  # SELECT COUNT(*) FROM "geographic_items"
  #        WHERE (ST_Contains(polygon::geometry, GeomFromEWKT('srid=4326;POINT (0.0 0.0 0.0)'))
  #               OR ST_Contains(polygon::geometry, GeomFromEWKT('srid=4326;POINT (-9.8 5.0 0.0)')))
  #
  def are_contained_in_item_by_id(column_name, *geographic_item_ids) # = containing
    geographic_item_ids.flatten! # in case there is a array of arrays, or multiple objects
    column_name.downcase!
    case column_name
    when 'any'
      part = []
      DATA_TYPES.each { |column|
        unless column == :geometry_collection
          part.push(GeographicItem.are_contained_in_item_by_id(column.to_s, geographic_item_ids).to_a)
        end
      }
      # TODO: change 'id in (?)' to some other sql construct
      GeographicItem.where(id: part.flatten.map(&:id))
    when 'any_poly', 'any_line'
      part = []
      DATA_TYPES.each { |column|
        if column.to_s.index(column_name.gsub('any_', ''))
          part.push(GeographicItem.are_contained_in_item_by_id("#{column}", geographic_item_ids).to_a)
        end
      }
      # TODO: change 'id in (?)' to some other sql construct
      GeographicItem.where(id: part.flatten.map(&:id))
    else
      q = geographic_item_ids.flatten.collect { |geographic_item_id|
        # discover the item types, and convert type to database type for 'multi_'
        b = GeographicItem.where(id: geographic_item_id)
          .pluck(:type)[0].split(':')[2].downcase.gsub('lti', 'lti_')
        # a = GeographicItem.find(geographic_item_id).geo_object_type
        GeographicItem.containing_sql(column_name, geographic_item_id, b)
      }.join(' or ')
      q = 'FALSE' if q.blank? # this will prevent the invocation of *ALL* of the GeographicItems, if there are
      # no GeographicItems in the request (see CollectingEvent.name_hash(types)).
      where(q) # .not_including(geographic_items)
    end
  end

  # rubocop:enable Metrics/MethodLength

  # @param [String] column_name
  # @param [String] geometry of WKT
  # @return [Scope]
  # a single WKT geometry is compared against column or columns (except geometry_collection) to find geographic_items
  # which are contained in the WKT
  def are_contained_in_wkt(column_name, geometry)
    column_name.downcase!
    # column_name = 'point'
    case column_name
    when 'any'
      part = []
      DATA_TYPES.each { |column|
        unless column == :geometry_collection
          part.push(GeographicItem.are_contained_in_wkt(column.to_s, geometry).pluck(:id).to_a)
        end
      }
      # TODO: change 'id in (?)' to some other sql construct
      GeographicItem.where(id: part.flatten)
    when 'any_poly', 'any_line'
      part = []
      DATA_TYPES.each { |column|
        if column.to_s.index(column_name.gsub('any_', ''))
          part.push(GeographicItem.are_contained_in_wkt("#{column}", geometry).pluck(:id).to_a)
        end
      }
      # TODO: change 'id in (?)' to some other sql construct
      GeographicItem.where(id: part.flatten)
    else
      # column = points, geometry = square
      q = "ST_Contains(ST_GeomFromEWKT('srid=4326;#{geometry}'), #{column_name}::geometry)"
      where(q) # .not_including(geographic_items)
    end
  end

  # rubocop:disable Metrics/MethodLength
  #    containing the items the shape of which is contained in the geographic_item[s] supplied.
  # @param column_name [String] can be any of DATA_TYPES, or 'any' to check against all types, 'any_poly' to check
  # against 'polygon' or 'multi_polygon', or 'any_line' to check against 'line_string' or 'multi_line_string'.
  #  CANNOT be 'geometry_collection'.
  # @param geographic_items [GeographicItem] Can be a single GeographicItem, or an array of GeographicItem.
  # @return [Scope]
  def is_contained_by(column_name, *geographic_items)
    column_name.downcase!
    case column_name
    when 'any'
      part = []
      DATA_TYPES.each { |column|
        unless column == :geometry_collection
          part.push(GeographicItem.is_contained_by(column.to_s, geographic_items).to_a)
        end
      }
      # @TODO change 'id in (?)' to some other sql construct
      GeographicItem.where(id: part.flatten.map(&:id))

    when 'any_poly', 'any_line'
      part = []
      DATA_TYPES.each { |column|
        unless column == :geometry_collection
          if column.to_s.index(column_name.gsub('any_', ''))
            part.push(GeographicItem.is_contained_by(column.to_s, geographic_items).to_a)
          end
        end
      }
      # @TODO change 'id in (?)' to some other sql construct
      GeographicItem.where(id: part.flatten.map(&:id))

    else
      q = geographic_items.flatten.collect { |geographic_item|
        GeographicItem.reverse_containing_sql(column_name, geographic_item.to_param,
                                              geographic_item.geo_object_type)
      }.join(' or ')
      where(q) # .not_including(geographic_items)
    end
  end

  # rubocop:enable Metrics/MethodLength

  # @param [String, GeographicItem]
  # @return [Scope]
  def ordered_by_shortest_distance_from(column_name, geographic_item)
    if true # check_geo_params(column_name, geographic_item)
      select_distance_with_geo_object(column_name, geographic_item)
        .where_distance_greater_than_zero(column_name, geographic_item).order('distance')
    else
      where('false')
    end
  end

  # @param [String, GeographicItem]
  # @return [Scope]
  def ordered_by_longest_distance_from(column_name, geographic_item)
    if true # check_geo_params(column_name, geographic_item)
      q = select_distance_with_geo_object(column_name, geographic_item)
        .where_distance_greater_than_zero(column_name, geographic_item)
        .order('distance desc')
      q
    else
      where('false')
    end
  end

  # @param [String] column_name
  # @param [GeographicItem] geographic_item
  # @return [String]
  def select_distance_with_geo_object(column_name, geographic_item)
    select("*, ST_Distance(#{column_name}, GeomFromEWKT('srid=4326;#{geographic_item.geo_object}')) as distance")
  end

  # @param [String, GeographicItem]
  # @return [Scope]
  def where_distance_greater_than_zero(column_name, geographic_item)
    where("#{column_name} is not null and ST_Distance(#{column_name}, " \
          "GeomFromEWKT('srid=4326;#{geographic_item.geo_object}')) > 0")
  end

  # @param [GeographicItem]
  # @return [Scope]
  def not_including(geographic_items)
    where.not(id: geographic_items)
  end

  # @return [Scope]
  #   includes an 'is_valid' attribute (True/False) for the passed geographic_item.  Uses St_IsValid.
  # @param [RGeo object] geographic_item
  def with_is_valid_geometry_column(geographic_item)
    where(id: geographic_item.id).select("ST_IsValid(ST_AsBinary(#{geographic_item.geo_object_type})) is_valid")
  end

  #
  # Other
  #

  # @param [Integer] geographic_item_id1
  # @param [Integer] geographic_item_id2
  # @return [Float]
  def distance_between(geographic_item_id1, geographic_item_id2)
    q1 = "ST_Distance(#{GeographicItem::GEOGRAPHY_SQL}, " \
      "(#{select_geography_sql(geographic_item_id2)})) as distance"
    _q2 = ActiveRecord::Base.send(
      :sanitize_sql_array, ['ST_Distance(?, (?)) as distance',
                            GeographicItem::GEOGRAPHY_SQL,
                            select_geography_sql(geographic_item_id2)])
    GeographicItem.where(id: geographic_item_id1).pluck(Arel.sql(q1)).first
  end

  # @param [RGeo::Point] point
  # @return [Hash]
  #   as per #inferred_geographic_name_hierarchy but for Rgeo point
  def point_inferred_geographic_name_hierarchy(point)
    GeographicItem.containing_point(point).order(cached_total_area: :ASC).limit(1).first&.inferred_geographic_name_hierarchy
  end

  # @param [String] type_name ('polygon', 'point', 'line' [, 'circle'])
  # @return [String] if type
  def eval_for_type(type_name)
    retval = 'GeographicItem'
    case type_name.upcase
    when 'POLYGON'
      retval += '::Polygon'
    when 'LINESTRING'
      retval += '::LineString'
    when 'POINT'
      retval += '::Point'
    when 'MULTIPOLYGON'
      retval += '::MultiPolygon'
    when 'MULTILINESTRING'
      retval += '::MultiLineString'
    when 'MULTIPOINT'
      retval += '::MultiPoint'
    else
      retval = nil
    end
    retval
  end

  # example, not used
  # @param [Integer] geographic_item_id
  # @return [RGeo::Geographic object]
  def geometry_for(geographic_item_id)
    GeographicItem.select(GeographicItem::GEOMETRY_SQL.to_sql + ' AS geometry').find(geographic_item_id)['geometry']
  end

  # example, not used
  # @param [Integer, Array] geographic_item_ids
  # @return [Scope]
  def st_multi(*geographic_item_ids)
    GeographicItem.find_by_sql(
      "SELECT ST_Multi(ST_Collect(g.the_geom)) AS singlegeom
 FROM (
    SELECT (ST_DUMP(#{GeographicItem::GEOMETRY_SQL.to_sql})).geom AS the_geom
    FROM geographic_items
    WHERE id IN (?))
  AS g;", geographic_item_ids.flatten
    )
  end
end # class << self

# @return [Hash]
#    a geographic_name_classification or empty Hash
# This is a quick approach that works only when
# the geographic_item is linked explicitly to a GeographicArea.
#
# !! Note that it is not impossible for a GeographicItem to be linked
# to > 1 GeographicArea, in that case we are assuming that all are
# equally refined, this might not be the case in the future because
# of how the GeographicArea gazetteer is indexed.
def quick_geographic_name_hierarchy
  geographic_areas.order(:id).each do |ga|
    h = ga.geographic_name_classification # not quick enough !!
    return h if h.present?
  end
  return  {}
end

# @return [Hash]
#   a geographic_name_classification (see GeographicArea) inferred by
# finding the smallest area containing this GeographicItem, in the most accurate gazetteer
# and using it to return country/state/county. See also the logic in
# filling in missing levels in GeographicArea.
def inferred_geographic_name_hierarchy
  if small_area = containing_geographic_areas
    .joins(:geographic_areas_geographic_items)
    .merge(GeographicAreasGeographicItem.ordered_by_data_origin)
    .ordered_by_area
    .limit(1)
    .first
  return small_area.geographic_name_classification
  else
    {}
  end
end

def geographic_name_hierarchy
  a = quick_geographic_name_hierarchy # quick; almost never the case, UI not setup to do this
  return a if a.present?
  inferred_geographic_name_hierarchy # slow
end

# @return [Scope]
#   the Geographic Areas that contain (gis) this geographic item
def containing_geographic_areas
  GeographicArea.joins(:geographic_items).includes(:geographic_area_type)
    .joins("JOIN (#{GeographicItem.containing(id).to_sql}) j on geographic_items.id = j.id")
end

# @return [Boolean]
#   whether stored shape is ST_IsValid
def valid_geometry?
  GeographicItem.with_is_valid_geometry_column(self).first['is_valid']
end

# @return [Array of latitude, longitude]
#    the lat, lon of the first point in the GeoItem, see subclass for #st_start_point
def start_point
  o = st_start_point
  [o.y, o.x]
end

# @return [Array]
#   the lat, long, as STRINGs for the centroid of this geographic item
#   Meh- this: https://postgis.net/docs/en/ST_MinimumBoundingRadius.html
def center_coords
  r = GeographicItem.find_by_sql(
    "Select split_part(ST_AsLatLonText(ST_Centroid(#{GeographicItem::GEOMETRY_SQL.to_sql}), " \
    "'D.DDDDDD'), ' ', 1) latitude, split_part(ST_AsLatLonText(ST_Centroid" \
    "(#{GeographicItem::GEOMETRY_SQL.to_sql}), 'D.DDDDDD'), ' ', 2) " \
    "longitude from geographic_items where id = #{id};")[0]

  [r.latitude, r.longitude]
end

# @return [RGeo::Geographic::ProjectedPointImpl]
#    representing the centroid of this geographic item
def centroid
  # Gis::FACTORY.point(*center_coords.reverse)
  return geo_object if type == 'GeographicItem::Point'
  return Gis::FACTORY.parse_wkt(self.st_centroid)
end

# @param [Integer] geographic_item_id
# @return [Double] distance in meters (slower, more accurate)
def st_distance(geographic_item_id) # geo_object
  q1 = "ST_Distance((#{GeographicItem.select_geography_sql(id)}), " \
    "(#{GeographicItem.select_geography_sql(geographic_item_id)})) as d"
  _q2 = ActiveRecord::Base.send(:sanitize_sql_array, ['ST_Distance((?),(?)) as d',
                                                      GeographicItem.select_geography_sql(self.id),
                                                      GeographicItem.select_geography_sql(geographic_item_id)])
  deg = GeographicItem.where(id:).pluck(Arel.sql(q1)).first
  deg * Utilities::Geo::ONE_WEST
end

# @param [GeographicItem] geographic_item
# @return [Double] distance in meters
# Like st_distance but works with changed and non persisted objects
def st_distance_to_geographic_item(geographic_item)
  unless !persisted? || changed?
    a = "(#{GeographicItem.select_geography_sql(id)})"
  else
    a = "ST_GeographyFromText('#{geo_object}')"
  end

  unless !geographic_item.persisted? || geographic_item.changed?
    b = "(#{GeographicItem.select_geography_sql(geographic_item.id)})"
  else
    b = "ST_GeographyFromText('#{geographic_item.geo_object}')"
  end

  ActiveRecord::Base.connection.select_value("SELECT ST_Distance(#{a}, #{b})")
end

alias_method :distance_to, :st_distance

# @param [Integer] geographic_item_id
# @return [Double] distance in meters (faster, less accurate)
def st_distance_spheroid(geographic_item_id)
  q1 = "ST_DistanceSpheroid((#{GeographicItem.select_geometry_sql(id)})," \
    "(#{GeographicItem.select_geometry_sql(geographic_item_id)}),'#{Gis::SPHEROID}') as distance"
  _q2 = ActiveRecord::Base.send(:sanitize_sql_array,
                                ['ST_DistanceSpheroid((?),(?),?) as distance',
                                 GeographicItem.select_geometry_sql(id),
                                 GeographicItem.select_geometry_sql(geographic_item_id),
                                 Gis::SPHEROID])
  # TODO: what is _q2?
  GeographicItem.where(id:).pluck(Arel.sql(q1)).first
end

# @return [String]
#   a WKT POINT representing the centroid of the geographic item
def st_centroid
  GeographicItem.where(id: to_param).pluck(Arel.sql("ST_AsEWKT(ST_Centroid(#{GeographicItem::GEOMETRY_SQL.to_sql}))")).first.gsub(/SRID=\d*;/, '')
end

# @return [Integer]
#   the number of points in the geometry
def st_npoints
  GeographicItem.where(id:).pluck(Arel.sql("ST_NPoints(#{GeographicItem::GEOMETRY_SQL.to_sql}) as npoints")).first
end

# @return [Symbol]
#   the geo type (i.e. column like :point, :multipolygon).  References the first-found object,
# according to the list of DATA_TYPES, or nil
def geo_object_type
  if self.class.name == 'GeographicItem' # a proxy check for new records
    geo_type
  else
    self.class::SHAPE_COLUMN
  end
end

# !!TODO: migrate these to use native column calls

# @return [RGeo instance, nil]
#  the Rgeo shape (See http://rubydoc.info/github/dazuma/rgeo/RGeo/Feature)
def geo_object
  begin
    if r = geo_object_type # rubocop:disable Lint/AssignmentInCondition
      send(r)
    else
      false
    end
  rescue RGeo::Error::InvalidGeometry
    return nil # TODO: we need to render proper error for this!
  end
end

# @param [geo_object]
# @return [Boolean]
def contains?(target_geo_object)
  return nil if target_geo_object.nil?
  self.geo_object.contains?(target_geo_object)
end

# @param [geo_object]
# @return [Boolean]
def within?(target_geo_object)
  self.geo_object.within?(target_geo_object)
end

# @param [geo_object]
# @return [Boolean]
def intersects?(target_geo_object)
  self.geo_object.intersects?(target_geo_object)
end

# @param [geo_object, Double]
# @return [Boolean]
def near(target_geo_object, distance)
  self.geo_object.unsafe_buffer(distance).contains?(target_geo_object)
end

# @param [geo_object, Double]
# @return [Boolean]
def far(target_geo_object, distance)
  !near(target_geo_object, distance)
end

# @return [GeoJSON hash]
#    via Rgeo apparently necessary for GeometryCollection
def rgeo_to_geo_json
  RGeo::GeoJSON.encode(geo_object).to_json
end

# @return [Hash]
#   in GeoJSON format
#   Computed via "raw" PostGIS (much faster). This
#   requires the geo_object_type and id.
#
def to_geo_json
  JSON.parse(
    GeographicItem.connection.select_one(
      "SELECT ST_AsGeoJSON(#{geo_object_type}::geometry) a " \
      "FROM geographic_items WHERE id=#{id};")['a'])
end

# We don't need to serialize to/from JSON
def to_geo_json_string
  GeographicItem.connection.select_one(
    "SELECT ST_AsGeoJSON(#{geo_object_type}::geometry) a " \
    "FROM geographic_items WHERE id=#{id};")['a']
end

# @return [Hash]
#   the shape as a GeoJSON Feature with some item metadata
def to_geo_json_feature
  @geometry ||= to_geo_json
  {'type' => 'Feature',
   'geometry' => geometry,
   'properties' => {
     'geographic_item' => {
       'id' => id}
   }
  }
end

# @param value [String] like:
#   '{"type":"Feature","geometry":{"type":"Point","coordinates":[2.5,4.0]},"properties":{"color":"red"}}'
#
#   '{"type":"Feature","geometry":{"type":"Polygon","coordinates":"[[[-125.29394388198853, 48.584480409793],
#      [-67.11035013198853, 45.09937589848195],[-80.64550638198853, 25.01924647619111],[-117.55956888198853,
#      32.5591595028449],[-125.29394388198853, 48.584480409793]]]"},"properties":{}}'
#
#  '{"type":"Point","coordinates":[2.5,4.0]},"properties":{"color":"red"}}'
#
# @return [Boolean, RGeo object]
def shape=(value)

  if value.present?
    geom = RGeo::GeoJSON.decode(value, json_parser: :json, geo_factory: Gis::FACTORY)
    this_type = nil

    if geom.respond_to?(:geometry_type)
      this_type = geom.geometry_type.to_s
    elsif geom.respond_to?(:geometry)
      this_type = geom.geometry.geometry_type.to_s
    else
    end

    self.type = GeographicItem.eval_for_type(this_type) unless geom.nil?

    if type.blank?
      errors.add(:base, 'type is not set from shape')
      return
    end
    # raise('GeographicItem.type not set.') if type.blank?

    object = nil

    s = geom.respond_to?(:geometry) ? geom.geometry.to_s : geom.to_s

    begin
      object = Gis::FACTORY.parse_wkt(s)
    rescue RGeo::Error::InvalidGeometry
      errors.add(:self, 'Shape value is an Invalid Geometry')
    end

    write_attribute(this_type.underscore.to_sym, object)
    geom
  end
end

# @return [String]
def to_wkt
  #  10k  #<Benchmark::Tms:0x00007fb0dfd30fd0 @label="", @real=25.237487000005785, @cstime=0.0, @cutime=0.0, @stime=1.1704609999999995, @utime=5.507929999999988, @total=6.678390999999987>
  #  GeographicItem.select("ST_AsText( #{GeographicItem::GEOMETRY_SQL.to_sql}) wkt").where(id: id).first.wkt

  # 10k <Benchmark::Tms:0x00007fb0e02f7540 @label="", @real=21.619827999995323, @cstime=0.0, @cutime=0.0, @stime=0.8850890000000007, @utime=3.2958549999999605, @total=4.180943999999961>
  if a =  ApplicationRecord.connection.execute( "SELECT ST_AsText( #{GeographicItem::GEOMETRY_SQL.to_sql} ) wkt from geographic_items where geographic_items.id = #{id}").first
    return a['wkt']
  else
    return nil
  end
end

# @return  [Float] in meters, calculated
# TODO: share with world
#    Geographic item 96862 (Cajamar in Brazil) is the only(?) record to fail using `false` (quicker) method of everything we tested
def area
  a = GeographicItem.where(id:).select("ST_Area(#{GeographicItem::GEOGRAPHY_SQL}, true) as area_in_meters").first['area_in_meters']
  a = nil if a.nan?
  a
end

# @return [Float, false]
#    the value in square meters of the interesecting area of this and another GeographicItem
def intersecting_area(geographic_item_id)
  a = GeographicItem.aliased_geographic_sql('a')
  b = GeographicItem.aliased_geographic_sql('b')

  c = GeographicItem.connection.execute(
    "SELECT ST_Area(ST_Intersection(#{a}, #{b})) as intersecting_area
      FROM geographic_items a, geographic_items b
      WHERE a.id = #{id} AND b.id = #{geographic_item_id};"
  ).first
  c && c['intersecting_area'].to_f
end

# TODO: This is bad, while internal use of ONE_WEST_MEAN is consistent it is in-accurate given the vast differences of radius vs. lat/long position.
# When we strike the error-polygon from radius we should remove this
#
# Use case is returning the radius from a circle we calculated via buffer for error-polygon creation.
def radius
  r = ApplicationRecord.connection.execute( "SELECT ST_MinimumBoundingRadius( ST_Transform(  #{GeographicItem::GEOMETRY_SQL.to_sql}, 4326 )  ) AS radius from geographic_items where geographic_items.id = #{id}").first['radius'].split(',').last.chop.to_f
  r = (r * Utilities::Geo::ONE_WEST_MEAN).to_i
end


# Convention is to store in PostGIS in CCW
# @return Array [Boolean]
#   false - cw
#   true - ccw (preferred), except cee donuts
def orientations
  if multi_polygon.present?
    ApplicationRecord.connection.execute(" \
         SELECT ST_IsPolygonCCW(a.geom) as is_ccw
            FROM ( SELECT b.id, (ST_Dump(p_geom)).geom AS geom
               FROM (SELECT id, multi_polygon::geometry AS p_geom FROM geographic_items where id = #{id}) AS b \
          ) AS a;").collect{|a| a['is_ccw']}
  elsif polygon.present?
    ApplicationRecord.connection.execute("SELECT ST_IsPolygonCCW(polygon::geometry) as is_ccw \
            FROM geographic_items where  id = #{id};").collect{|a| a['is_ccw']}
  else
    []
  end
end

# @return Boolean
#   looks at all orientations
#   if they follow the pattern [true, false, ... <all false>] then `true`, else `false`
# !! Does not confirm that shapes are nested !!
def is_basic_donut?
  a = orientations
  b = a.shift
  return false unless b
  a.uniq!
  a == [false]
end

def st_isvalid
  r = ApplicationRecord.connection.execute( "SELECT ST_IsValid(  #{GeographicItem::GEOMETRY_SQL.to_sql }) from  geographic_items where geographic_items.id = #{id}").first['st_isvalid']
end

def st_isvalidreason
  r = ApplicationRecord.connection.execute( "SELECT ST_IsValidReason(  #{GeographicItem::GEOMETRY_SQL.to_sql }) from  geographic_items where geographic_items.id = #{id}").first['st_isvalidreason']
end

# !! Unused. Doesn't check Geometry collection
def has_polygons?
  ['GeographicItem::MultiPolygon', 'GeographicItem::Polygon'].include?(self.type)
end

private

def align_winding
  if orientations.flatten.include?(false)
    case type
    when 'multi_polygon'
      ApplicationRecord.connection.execute(
        "UPDATE geographic_items set multi_polygon = ST_ForcePolygonCCW(multi_polygon::geometry) 
          WHERE id = #{self.id};"
       )
    when 'polygon'
     ApplicationRecord.connection.execute(
        "UPDATE geographic_items set polygon = ST_ForcePolygonCCW(polygon::geometry) 
          WHERE id = #{self.id};"
       )
    end     
  end
  true
end

# Crude debuging helper, write the shapes
# to a png
def self.debug_draw(geographic_item_ids = [])
  return false if geographic_item_ids.empty?

  sql = "SELECT ST_AsPNG(
     ST_AsRaster(
        (SELECT ST_Union(multi_polygon::geometry) from geographic_items where id IN (" + geographic_item_ids.join(',') + ")), 1920, 1080
    )
   ) png;"

  # ST_Buffer( multi_polygon::geometry, 0, 'join=bevel'),
  #     1920,
  #     1080)


  result = ActiveRecord::Base.connection.execute(sql).first['png']
  r = ActiveRecord::Base.connection.unescape_bytea(result)

  prefix = if geographic_item_ids.size > 10
             'multiple'
           else
             geographic_item_ids.join('_') + '_debug.draw.png'
           end

  n = prefix + '_debug.draw.png'

  # Open the file in binary write mode ("wb")
  File.open(n, 'wb') do |file|
    # Write the binary data to the file
    file.write(r)
  end
end

# def png

#   if ids = Otu.joins(:cached_map_items).first.cached_map_items.pluck(:geographic_item_id)

#     sql = "SELECT ST_AsPNG(
#    ST_AsRaster(
#        ST_Buffer( multi_polygon::geometry, 0, 'join=bevel'),
#            1024,
#            768)
#     ) png
#        from geographic_items where id IN (" + ids.join(',') + ');'

#     # hack, not the best way to unpack result
#     result = ActiveRecord::Base.connection.execute(sql).first['png']
#     r = ActiveRecord::Base.connection.unescape_bytea(result)

#     send_data r, filename: 'foo.png', type: 'imnage/png'

#   else
#     render json: {foo: false}
#   end
# end

def set_cached
  update_column(:cached_total_area, area)
end

# @return [Symbol]
#   returns the attribute (column name) containing data
#   nearly all methods should use #geo_object_type, not geo_type
def geo_type
  DATA_TYPES.each { |item|
    return item if send(item)
  }
  nil
end

# @return [Boolean, String] false if already set, or type to which it was set
def set_type_if_geography_present
  if type.blank?
    column = geo_type
    self.type = "GeographicItem::#{column.to_s.camelize}" if column
  end
end

# @param [RGeo::Point] point
# @return [Array] of a point
#   Longitude |, Latitude -
def point_to_a(point)
  data = []
  data.push(point.x, point.y)
  data
end

# @param [RGeo::Point] point
# @return [Hash] of a point
def point_to_hash(point)
  {points: [point_to_a(point)]}
end

# @param [RGeo::MultiPoint] multi_point
# @return [Array] of points
def multi_point_to_a(multi_point)
  data = []
  multi_point.each { |point|
    data.push([point.x, point.y])
  }
  data
end

# @return [Hash] of points
def multi_point_to_hash(_multi_point)
  # when we encounter a multi_point type, we only stick the points into the array, NOT it's identity as a group
  {points: multi_point_to_a(multi_point)}
end

# @param [Reo::LineString] line_string
# @return [Array] of points in the line
def line_string_to_a(line_string)
  data = []
  line_string.points.each { |point|
    data.push([point.x, point.y])
  }
  data
end

# @param [Reo::LineString] line_string
# @return [Hash] of points in the line
def line_string_to_hash(line_string)
  {lines: [line_string_to_a(line_string)]}
end

# @param [RGeo::Polygon] polygon
# @return [Array] of points in the polygon (exterior_ring ONLY)
def polygon_to_a(polygon)
  # TODO: handle other parts of the polygon; i.e., the interior_rings (if they exist)
  data = []
  polygon.exterior_ring.points.each { |point|
    data.push([point.x, point.y])
  }
  data
end

# @param [RGeo::Polygon] polygon
# @return [Hash] of points in the polygon (exterior_ring ONLY)
def polygon_to_hash(polygon)
  {polygons: [polygon_to_a(polygon)]}
end

# @return [Array] of line_strings as arrays of points
# @param [RGeo::MultiLineString] multi_line_string
def multi_line_string_to_a(multi_line_string)
  data = []
  multi_line_string.each { |line_string|
    line_data = []
    line_string.points.each { |point|
      line_data.push([point.x, point.y])
    }
    data.push(line_data)
  }
  data
end

# @return [Hash] of line_strings as hashes of points
def multi_line_string_to_hash(_multi_line_string)
  {lines: to_a}
end

# @param [RGeo::MultiPolygon] multi_polygon
# @return [Array] of arrays of points in the polygons (exterior_ring ONLY)
def multi_polygon_to_a(multi_polygon)
  data = []
  multi_polygon.each { |polygon|
    polygon_data = []
    polygon.exterior_ring.points.each { |point|
      polygon_data.push([point.x, point.y])
    }
    data.push(polygon_data)
  }
  data
end

# @return [Hash] of hashes of points in the polygons (exterior_ring ONLY)
def multi_polygon_to_hash(_multi_polygon)
  {polygons: to_a}
end

# @return [Boolean] iff there is one and only one shape column set
def some_data_is_provided
  data = []

  DATA_TYPES.each do |item|
    data.push(item) if send(item).present?
  end

  case data.count
  when 0
    errors.add(:base, 'No shape provided or provided shape is invalid')
  when 1
    return true
  else
    data.each do |object|
      errors.add(object, 'More than one shape type provided')
    end
  end
  true
end
end

#no_cached ⇒ `Boolean`

Returns When true cached values are not built.

Returns:

(Boolean) —

When true cached values are not built



59
60
61

# File 'app/models/geographic_item.rb', line 59

def no_cached
  @no_cached
end

#point ⇒ `RGeo::Geographic::ProjectedPointImpl`

Returns:

(RGeo::Geographic::ProjectedPointImpl)

# File 'app/models/geographic_item.rb', line 40

class GeographicItem < ApplicationRecord
  include Housekeeping::Users
  include Housekeeping::Timestamps
  include Shared::HasPapertrail
  include Shared::IsData
  include Shared::SharedAcrossProjects

  # @return [Hash, nil]
  #   An internal variable for use in super calls, holds a Hash in GeoJSON format (temporarily)
  attr_accessor :geometry

  # @return [Boolean, RGeo object]
  # @params value [Hash in GeoJSON format] ?!
  # TODO: WHY! boolean not nil, or object
  # Used to build geographic items from a shape [ of what class ] !?
  attr_accessor :shape

  # @return [Boolean]
  #   When true cached values are not built
  attr_accessor :no_cached

  DATA_TYPES = [
:point,
:line_string,
:polygon,
:multi_point,
:multi_line_string,
:multi_polygon,
:geometry_collection
  ].freeze

  GEOMETRY_SQL = Arel::Nodes::Case.new(arel_table[:type])
.when('GeographicItem::MultiPolygon').then(Arel::Nodes::NamedFunction.new('CAST', [arel_table[:multi_polygon].as('geometry')]))
.when('GeographicItem::Point').then(Arel::Nodes::NamedFunction.new('CAST', [arel_table[:point].as('geometry')]))
.when('GeographicItem::LineString').then(Arel::Nodes::NamedFunction.new('CAST', [arel_table[:line_string].as('geometry')]))
.when('GeographicItem::Polygon').then(Arel::Nodes::NamedFunction.new('CAST', [arel_table[:polygon].as('geometry')]))
.when('GeographicItem::MultiLineString').then(Arel::Nodes::NamedFunction.new('CAST', [arel_table[:multi_line_string].as('geometry')]))
.when('GeographicItem::MultiPoint').then(Arel::Nodes::NamedFunction.new('CAST', [arel_table[:multi_point].as('geometry')]))
.when('GeographicItem::GeometryCollection').then(Arel::Nodes::NamedFunction.new('CAST', [arel_table[:geometry_collection].as('geometry')]))
.freeze

  GEOGRAPHY_SQL = "CASE geographic_items.type
WHEN 'GeographicItem::MultiPolygon' THEN multi_polygon
WHEN 'GeographicItem::Point' THEN point
WHEN 'GeographicItem::LineString' THEN line_string
WHEN 'GeographicItem::Polygon' THEN polygon
WHEN 'GeographicItem::MultiLineString' THEN multi_line_string
WHEN 'GeographicItem::MultiPoint' THEN multi_point
WHEN 'GeographicItem::GeometryCollection' THEN geometry_collection
END".freeze

# ANTI_MERIDIAN = '0X0102000020E61000000200000000000000008066400000000000405640000000000080664000000000004056C0'
ANTI_MERIDIAN = 'LINESTRING (180 89.0, 180 -89)'.freeze

has_many :cached_map_items, inverse_of: :geographic_item

has_many :geographic_areas_geographic_items, dependent: :destroy, inverse_of: :geographic_item
has_many :geographic_areas, through: :geographic_areas_geographic_items
has_many :asserted_distributions, through: :geographic_areas
has_many :geographic_area_types, through: :geographic_areas
has_many :parent_geographic_areas, through: :geographic_areas, source: :parent

has_many :georeferences, inverse_of: :geographic_item
has_many :georeferences_through_error_geographic_item,
  class_name: 'Georeference', foreign_key: :error_geographic_item_id, inverse_of: :error_geographic_item
has_many :collecting_events_through_georeferences, through: :georeferences, source: :collecting_event
has_many :collecting_events_through_georeference_error_geographic_item,
  through: :georeferences_through_error_geographic_item, source: :collecting_event

# TODO: THIS IS NOT GOOD
before_validation :set_type_if_geography_present

validate :some_data_is_provided
validates :type, presence: true # not needed

scope :include_collecting_event, -> { includes(:collecting_events_through_georeferences) }
scope :geo_with_collecting_event, -> { joins(:collecting_events_through_georeferences) }
scope :err_with_collecting_event, -> { joins(:georeferences_through_error_geographic_item) }

after_save :set_cached, unless: Proc.new {|n| n.no_cached || errors.any? }
after_save :align_winding

class << self

  def aliased_geographic_sql(name = 'a')
    "CASE #{name}.type \
     WHEN 'GeographicItem::MultiPolygon' THEN #{name}.multi_polygon \
     WHEN 'GeographicItem::Point' THEN #{name}.point \
     WHEN 'GeographicItem::LineString' THEN #{name}.line_string \
     WHEN 'GeographicItem::Polygon' THEN #{name}.polygon \
     WHEN 'GeographicItem::MultiLineString' THEN #{name}.multi_line_string \
     WHEN 'GeographicItem::MultiPoint' THEN #{name}.multi_point \
     WHEN 'GeographicItem::GeometryCollection' THEN #{name}.geometry_collection \
     END"
  end

  def st_union(geographic_item_scope)
    GeographicItem.select("ST_Union(#{GeographicItem::GEOMETRY_SQL.to_sql}) as collection")
      .where(id: geographic_item_scope.pluck(:id))
  end

  def st_collect(geographic_item_scope)
    GeographicItem.select("ST_Collect(#{GeographicItem::GEOMETRY_SQL.to_sql}) as collection")
      .where(id: geographic_item_scope.pluck(:id))
  end

  # @return [GeographicItem::ActiveRecord_Relation]
  # @params [Array] array of geographic area ids
  def default_by_geographic_area_ids(geographic_area_ids = [])
    GeographicItem.
      joins(:geographic_areas_geographic_items).
      merge(::GeographicAreasGeographicItem.default_geographic_item_data).
      where(geographic_areas_geographic_items: {geographic_area_id: geographic_area_ids})
  end

  # @param [String] wkt
  # @return [Boolean]
  #   whether or not the wtk intersects with the anti-meridian
  #   !! StrongParams security considerations
  def crosses_anti_meridian?(wkt)
    GeographicItem.find_by_sql(
      ['SELECT ST_Intersects(ST_GeogFromText(?), ST_GeogFromText(?)) as r;', wkt, ANTI_MERIDIAN]
    ).first.r
  end

  # @param [Integer] ids
  # @return [Boolean]
  #   whether or not any GeographicItem passed intersects the anti-meridian
  #   !! StrongParams security considerations
  #   This is our first line of defense against queries that define multiple shapes, one or
  #   more of which crosses the anti-meridian.  In this case the current TW strategy within the
  #   UI is to abandon the search, and prompt the user to refactor the query.
  def crosses_anti_meridian_by_id?(*ids)
    q1 = ["SELECT ST_Intersects((SELECT single_geometry FROM (#{GeographicItem.single_geometry_sql(*ids)}) as " \
          'left_intersect), ST_GeogFromText(?)) as r;', ANTI_MERIDIAN]
    _q2 = ActiveRecord::Base.send(:sanitize_sql_array, ['SELECT ST_Intersects((SELECT single_geometry FROM (?) as ' \
                                                        'left_intersect), ST_GeogFromText(?)) as r;', GeographicItem.single_geometry_sql(*ids), ANTI_MERIDIAN])
    GeographicItem.find_by_sql(q1).first.r
  end

  #
  # SQL fragments
  #

  # @param [Integer, String]
  # @return [String]
  #   a SQL select statement that returns the *geometry* for the geographic_item with the specified id
  def select_geometry_sql(geographic_item_id)
    "SELECT #{GeographicItem::GEOMETRY_SQL.to_sql} from geographic_items where geographic_items.id = #{geographic_item_id}"
  end

  # @param [Integer, String]
  # @return [String]
  #   a SQL select statement that returns the geography for the geographic_item with the specified id
  def select_geography_sql(geographic_item_id)
    ActiveRecord::Base.send(:sanitize_sql_for_conditions, [
      "SELECT #{GeographicItem::GEOMETRY_SQL.to_sql} from geographic_items where geographic_items.id = ?",
      geographic_item_id])
  end

  # @param [Symbol] choice
  # @return [String]
  #   a fragment returning either latitude or longitude columns
  def lat_long_sql(choice)
    return nil unless [:latitude, :longitude].include?(choice)
    f = "'D.DDDDDD'" # TODO: probably a constant somewhere
    v = (choice == :latitude ? 1 : 2)
    "CASE geographic_items.type
  WHEN 'GeographicItem::GeometryCollection' THEN split_part(ST_AsLatLonText(ST_Centroid" \
  "(geometry_collection::geometry), #{f}), ' ', #{v})
  WHEN 'GeographicItem::LineString' THEN split_part(ST_AsLatLonText(ST_Centroid(line_string::geometry), " \
  "#{f}), ' ', #{v})
  WHEN 'GeographicItem::MultiPolygon' THEN split_part(ST_AsLatLonText(" \
  "ST_Centroid(multi_polygon::geometry), #{f}), ' ', #{v})
  WHEN 'GeographicItem::Point' THEN split_part(ST_AsLatLonText(" \
  "ST_Centroid(point::geometry), #{f}), ' ', #{v})
  WHEN 'GeographicItem::Polygon' THEN split_part(ST_AsLatLonText(" \
  "ST_Centroid(polygon::geometry), #{f}), ' ', #{v})
  WHEN 'GeographicItem::MultiLineString' THEN split_part(ST_AsLatLonText(" \
  "ST_Centroid(multi_line_string::geometry), #{f} ), ' ', #{v})
  WHEN 'GeographicItem::MultiPoint' THEN split_part(ST_AsLatLonText(" \
  "ST_Centroid(multi_point::geometry), #{f}), ' ', #{v})
END as #{choice}"
  end

  # @param [Integer] geographic_item_id
  # @param [Integer] distance
  # @return [String]
  def within_radius_of_item_sql(geographic_item_id, distance)
    "ST_DWithin((#{GeographicItem::GEOGRAPHY_SQL}), (#{select_geography_sql(geographic_item_id)}), #{distance})"
  end


  # @param [Integer] geographic_item_id
  # @param [Number] distance in meters to grow/shrink the shape (negative allowed)
  # @param [Number] distance (in meters) (positive only?!)
  # @return [String]
  def st_buffer_st_within(geographic_item_id, distance, buffer = 0)
    "ST_DWithin(
    ST_Buffer(#{GeographicItem::GEOGRAPHY_SQL}, #{buffer}),
    (#{select_geography_sql(geographic_item_id)}), #{distance}
   )"
  end


  # TODO: 3D is overkill here
  # @param [String] wkt
  # @param [Integer] distance (meters)
  # @return [String]
  # !! This is intersecting
  def intersecting_radius_of_wkt_sql(wkt, distance)
    "ST_DWithin((#{GeographicItem::GEOGRAPHY_SQL}), ST_Transform( ST_GeomFromText('#{wkt}', " \
      "4326), 4326), #{distance})"
  end

  # @param [String] wkt
  # @param [Integer] distance (meters)
  # @return [String]
  # !! This is fully covering
  def within_radius_of_wkt_sql(wkt, distance)
    "ST_Covers( ST_Buffer(ST_SetSRID( ST_GeomFromText('#{wkt}'), 4326)::geography, #{distance}), (#{GeographicItem::GEOGRAPHY_SQL}))"
  end

  # @param [String, Integer, String]
  # @return [String]
  #   a SQL fragment for ST_Contains() function, returns
  #   all geographic items which are contained in the item supplied
  def containing_sql(target_column_name = nil, geographic_item_id = nil, source_column_name = nil)
    return 'false' if geographic_item_id.nil? || source_column_name.nil? || target_column_name.nil?
    "ST_Contains(#{target_column_name}::geometry, (#{geometry_sql(geographic_item_id, source_column_name)}))"
  end

  # @param [String, Integer, String]
  # @return [String]
  #   a SQL fragment for ST_Contains(), returns
  #   all geographic_items which contain the supplied geographic_item
  def reverse_containing_sql(target_column_name = nil, geographic_item_id = nil, source_column_name = nil)
    return 'false' if geographic_item_id.nil? || source_column_name.nil? || target_column_name.nil?
    "ST_Contains((#{geometry_sql(geographic_item_id, source_column_name)}), #{target_column_name}::geometry)"
  end

  # @param [Integer, String]
  # @return [String]
  #   a SQL fragment that represents the geometry of the geographic item specified (which has data in the
  # source_column_name, i.e. geo_object_type)
  def geometry_sql(geographic_item_id = nil, source_column_name = nil)
    return 'false' if geographic_item_id.nil? || source_column_name.nil?
    "select geom_alias_tbl.#{source_column_name}::geometry from geographic_items geom_alias_tbl " \
      "where geom_alias_tbl.id = #{geographic_item_id}"
  end

  # rubocop:disable Metrics/MethodLength
  # @param [String] column_name
  # @param [GeographicItem] geographic_item
  # @return [String] of SQL
  def is_contained_by_sql(column_name, geographic_item)
    geo_id = geographic_item.id
    geo_type = geographic_item.geo_object_type
    template = '(ST_Contains((select geographic_items.%s::geometry from geographic_items where ' \
      'geographic_items.id = %d), %s::geometry))'
    retval = []
    column_name.downcase!
    case column_name
    when 'any'
      DATA_TYPES.each { |column|
        unless column == :geometry_collection
          retval.push(template % [geo_type, geo_id, column])
        end
      }
    when 'any_poly', 'any_line'
      DATA_TYPES.each { |column|
        unless column == :geometry_collection
          if column.to_s.index(column_name.gsub('any_', ''))
            retval.push(template % [geo_type, geo_id, column])
          end
        end
      }
    else
      retval = template % [geo_type, geo_id, column_name]
    end
    retval = retval.join(' OR ') if retval.instance_of?(Array)
    retval
  end

  # @param [Interger, Array of Integer] geographic_item_ids
  # @return [String]
  #   a select query that returns a single geometry (column name 'single_geometry' for the collection of ids
  # provided via ST_Collect)
  def st_collect_sql(*geographic_item_ids)
    geographic_item_ids.flatten!
    ActiveRecord::Base.send(:sanitize_sql_for_conditions, [
      "SELECT ST_Collect(f.the_geom) AS single_geometry
 FROM (
    SELECT (ST_DUMP(#{GeographicItem::GEOMETRY_SQL.to_sql})).geom as the_geom
    FROM geographic_items
    WHERE id in (?))
  AS f", geographic_item_ids])
  end

  # @param [Interger, Array of Integer] geographic_item_ids
  # @return [String]
  #    returns one or more geographic items combined as a single geometry in column 'single'
  def single_geometry_sql(*geographic_item_ids)
    a = GeographicItem.st_collect_sql(geographic_item_ids)
    '(SELECT single.single_geometry FROM (' + a + ' ) AS single)'
  end

  # @param [Interger, Array of Integer] geographic_item_ids
  # @return [String]
  #   returns a single geometry "column" (paren wrapped) as "single" for multiple geographic item ids, or the
  # geometry as 'geometry' for a single id
  def geometry_sql2(*geographic_item_ids)
    geographic_item_ids.flatten! # *ALWAYS* reduce the pile to a single level of ids
    if geographic_item_ids.count == 1
      "(#{GeographicItem.geometry_for_sql(geographic_item_ids.first)})"
    else
      GeographicItem.single_geometry_sql(geographic_item_ids)
    end
  end

  # @param [Interger, Array of Integer] geographic_item_ids
  # @return [String]
  def containing_where_sql(*geographic_item_ids)
    "ST_CoveredBy(
      #{GeographicItem.geometry_sql2(*geographic_item_ids)},
       CASE geographic_items.type
         WHEN 'GeographicItem::MultiPolygon' THEN multi_polygon::geometry
         WHEN 'GeographicItem::Point' THEN point::geometry
         WHEN 'GeographicItem::LineString' THEN line_string::geometry
         WHEN 'GeographicItem::Polygon' THEN polygon::geometry
         WHEN 'GeographicItem::MultiLineString' THEN multi_line_string::geometry
         WHEN 'GeographicItem::MultiPoint' THEN multi_point::geometry
      END)"
  end

  # @param [Interger, Array of Integer] geographic_item_ids
  # @return [String]
  def containing_where_sql_geog(*geographic_item_ids)
    "ST_CoveredBy(
      #{GeographicItem.geometry_sql2(*geographic_item_ids)},
       CASE geographic_items.type
         WHEN 'GeographicItem::MultiPolygon' THEN multi_polygon::geography
         WHEN 'GeographicItem::Point' THEN point::geography
         WHEN 'GeographicItem::LineString' THEN line_string::geography
         WHEN 'GeographicItem::Polygon' THEN polygon::geography
         WHEN 'GeographicItem::MultiLineString' THEN multi_line_string::geography
         WHEN 'GeographicItem::MultiPoint' THEN multi_point::geography
      END)"
  end

  # @param [Interger, Array of Integer] ids
  # @return [Array]
  #   If we detect that some query id has crossed the meridian, then loop through
  #   and "manually" build up a list of results.
  #   Should only be used if GeographicItem.crosses_anti_meridian_by_id? is true.
  #   Note that this does not return a Scope, so you can't chain it like contained_by?
  # TODO: test this
  def contained_by_with_antimeridian_check(*ids)
    ids.flatten! # make sure there is only one level of splat (*)
    results = []

    crossing_ids = []

    ids.each do |id|
      # push each which crosses
      crossing_ids.push(id) if GeographicItem.crosses_anti_meridian_by_id?(id)
    end

    non_crossing_ids = ids - crossing_ids
    results.push GeographicItem.contained_by(non_crossing_ids).to_a if non_crossing_ids.any?

    crossing_ids.each do |id|
      # [61666, 61661, 61659, 61654, 61639]
      q1 = ActiveRecord::Base.send(:sanitize_sql_array, ['SELECT ST_AsText((SELECT polygon FROM geographic_items ' \
                                                         'WHERE id = ?))', id])
      r = GeographicItem.where(
        # GeographicItem.contained_by_wkt_shifted_sql(GeographicItem.find(id).geo_object.to_s)
        GeographicItem.contained_by_wkt_shifted_sql(
          ApplicationRecord.connection.execute(q1).first['st_astext'])
      ).to_a
      results.push(r)
    end

    results.flatten.uniq
  end

  # @params [String] well known text
  # @return [String] the SQL fragment for the specific geometry type, shifted by longitude
  # Note: this routine is called when it is already known that the A argument crosses anti-meridian
  def contained_by_wkt_shifted_sql(wkt)
    "ST_Contains(ST_ShiftLongitude(ST_GeomFromText('#{wkt}', 4326)), (
    CASE geographic_items.type
       WHEN 'GeographicItem::MultiPolygon' THEN ST_ShiftLongitude(multi_polygon::geometry)
       WHEN 'GeographicItem::Point' THEN ST_ShiftLongitude(point::geometry)
       WHEN 'GeographicItem::LineString' THEN ST_ShiftLongitude(line_string::geometry)
       WHEN 'GeographicItem::Polygon' THEN ST_ShiftLongitude(polygon::geometry)
       WHEN 'GeographicItem::MultiLineString' THEN ST_ShiftLongitude(multi_line_string::geometry)
       WHEN 'GeographicItem::MultiPoint' THEN ST_ShiftLongitude(multi_point::geometry)
    END
    )
  )"
  end

  # TODO: Remove the hard coded 4326 reference
  # @params [String] wkt
  # @return [String] SQL fragment limiting geographics items to those in this WKT
  def contained_by_wkt_sql(wkt)
    if crosses_anti_meridian?(wkt)
      retval = contained_by_wkt_shifted_sql(wkt)
    else
      retval = "ST_Contains(ST_GeomFromText('#{wkt}', 4326), (
    CASE geographic_items.type
       WHEN 'GeographicItem::MultiPolygon' THEN multi_polygon::geometry
       WHEN 'GeographicItem::Point' THEN point::geometry
       WHEN 'GeographicItem::LineString' THEN line_string::geometry
       WHEN 'GeographicItem::Polygon' THEN polygon::geometry
       WHEN 'GeographicItem::MultiLineString' THEN multi_line_string::geometry
       WHEN 'GeographicItem::MultiPoint' THEN multi_point::geometry
    END
    )
  )"
    end
    retval
  end

  # @param [Interger, Array of Integer] geographic_item_ids
  # @return [String] sql for contained_by via ST_ContainsProperly
  # Note: Can not use GEOMETRY_SQL because geometry_collection is not supported in ST_ContainsProperly
  # Note: !! If the target GeographicItem#id crosses the anti-meridian then you may/will get unexpected results.
  def contained_by_where_sql(*geographic_item_ids)
    "ST_Contains(
    #{GeographicItem.geometry_sql2(*geographic_item_ids)},
    CASE geographic_items.type
      WHEN 'GeographicItem::MultiPolygon' THEN multi_polygon::geometry
      WHEN 'GeographicItem::Point' THEN point::geometry
      WHEN 'GeographicItem::LineString' THEN line_string::geometry
      WHEN 'GeographicItem::Polygon' THEN polygon::geometry
      WHEN 'GeographicItem::MultiLineString' THEN multi_line_string::geometry
      WHEN 'GeographicItem::MultiPoint' THEN multi_point::geometry
    END)"
  end

  # @param [RGeo:Point] rgeo_point
  # @return [String] sql for containing via ST_CoveredBy
  # TODO: Remove the hard coded 4326 reference
  # TODO: should this be wkt_point instead of rgeo_point?
  def containing_where_for_point_sql(rgeo_point)
    "ST_CoveredBy(
  ST_GeomFromText('#{rgeo_point}', 4326),
  #{GeographicItem::GEOMETRY_SQL.to_sql}
 )"
  end

  # @param [Interger] geographic_item_id
  # @return [String] SQL for geometries
  # example, not used
  def geometry_for_sql(geographic_item_id)
    'SELECT ' + GeographicItem::GEOMETRY_SQL.to_sql + ' AS geometry FROM geographic_items WHERE id = ' \
      "#{geographic_item_id} LIMIT 1"
  end

  # @param [Interger, Array of Integer] geographic_item_ids
  # @return [String] SQL for geometries
  # example, not used
  def geometry_for_collection_sql(*geographic_item_ids)
    'SELECT ' + GeographicItem::GEOMETRY_SQL.to_sql + ' AS geometry FROM geographic_items WHERE id IN ' \
      "( #{geographic_item_ids.join(',')} )"
  end

  #
  # Scopes
  #

  # @param [Interger, Array of Integer] geographic_item_ids
  # @return [Scope]
  #    the geographic items containing these collective geographic_item ids, not including self
  def containing(*geographic_item_ids)
    where(GeographicItem.containing_where_sql(geographic_item_ids)).not_ids(*geographic_item_ids)
  end

  # @param [Interger, Array of Integer] geographic_item_ids
  # @return [Scope]
  #    the geographic items contained by any of these geographic_item ids, not including self
  # (works via ST_ContainsProperly)
  def contained_by(*geographic_item_ids)
    where(GeographicItem.contained_by_where_sql(geographic_item_ids))
  end

  # @param [RGeo::Point] rgeo_point
  # @return [Scope]
  #    the geographic items containing this point
  # TODO: should be containing_wkt ?
  def containing_point(rgeo_point)
    where(GeographicItem.containing_where_for_point_sql(rgeo_point))
  end

  # @return [Scope]
  #   adds an area_in_meters field, with meters
  def with_area
    select("ST_Area(#{GeographicItem::GEOGRAPHY_SQL}, false) as area_in_meters")
  end

  # return [Scope]
  #   A scope that limits the result to those GeographicItems that have a collecting event
  #   through either the geographic_item or the error_geographic_item
  #
  # A raw SQL join approach for comparison
  #
  # GeographicItem.joins('LEFT JOIN georeferences g1 ON geographic_items.id = g1.geographic_item_id').
  #   joins('LEFT JOIN georeferences g2 ON geographic_items.id = g2.error_geographic_item_id').
  #   where("(g1.geographic_item_id IS NOT NULL OR g2.error_geographic_item_id IS NOT NULL)").uniq

  # @return [Scope] GeographicItem
  # This uses an Arel table approach, this is ultimately more decomposable if we need. Of use:
  #  http://danshultz.github.io/talks/mastering_activerecord_arel  <- best
  #  https://github.com/rails/arel
  #  http://stackoverflow.com/questions/4500629/use-arel-for-a-nested-set-join-query-and-convert-to-activerecordrelation
  #  http://rdoc.info/github/rails/arel/Arel/SelectManager
  #  http://stackoverflow.com/questions/7976358/activerecord-arel-or-condition
  #
  def with_collecting_event_through_georeferences
    geographic_items = GeographicItem.arel_table
    georeferences = Georeference.arel_table
    g1 = georeferences.alias('a')
    g2 = georeferences.alias('b')

    c = geographic_items.join(g1, Arel::Nodes::OuterJoin).on(geographic_items[:id].eq(g1[:geographic_item_id]))
      .join(g2, Arel::Nodes::OuterJoin).on(geographic_items[:id].eq(g2[:error_geographic_item_id]))

    GeographicItem.joins(# turn the Arel back into scope
                         c.join_sources # translate the Arel join to a join hash(?)
                        ).where(
                          g1[:id].not_eq(nil).or(g2[:id].not_eq(nil)) # returns a Arel::Nodes::Grouping
                        ).distinct
  end

  # @return [Scope] include a 'latitude' column
  def with_latitude
    select(lat_long_sql(:latitude))
  end

  # @return [Scope] include a 'longitude' column
  def with_longitude
    select(lat_long_sql(:longitude))
  end

  # @param [String, GeographicItems]
  # @return [Scope]
  def intersecting(column_name, *geographic_items)
    if column_name.downcase == 'any'
      pieces = []
      DATA_TYPES.each { |column|
        pieces.push(GeographicItem.intersecting(column.to_s, geographic_items).to_a)
      }

      # @TODO change 'id in (?)' to some other sql construct

      GeographicItem.where(id: pieces.flatten.map(&:id))
    else
      q = geographic_items.flatten.collect { |geographic_item|
        "ST_Intersects(#{column_name}, '#{geographic_item.geo_object}'    )" # seems like we want this: http://danshultz.github.io/talks/mastering_activerecord_arel/#/15/2
      }.join(' or ')

      where(q)
    end
  end

  # @param [GeographicItem#id] geographic_item_id
  # @param [Float] distance in meters ?!?!
  # @return [ActiveRecord::Relation]
  # !! should be distance, not radius?!
  def within_radius_of_item(geographic_item_id, distance)
    where(within_radius_of_item_sql(geographic_item_id, distance))
  end

  # @param [String, GeographicItem]
  # @return [Scope]
  #   a SQL fragment for ST_DISJOINT, specifies all geographic_items that have data in column_name
  #   that are disjoint from the passed geographic_items
  def disjoint_from(column_name, *geographic_items)
    q = geographic_items.flatten.collect { |geographic_item|
      "ST_DISJOINT(#{column_name}::geometry, (#{geometry_sql(geographic_item.to_param,
                                                         geographic_item.geo_object_type)}))"
    }.join(' and ')

    where(q)
  end

  # @return [Scope]
  #   see are_contained_in_item_by_id
  # @param [String] column_name
  # @param [GeographicItem, Array] geographic_items
  def are_contained_in_item(column_name, *geographic_items)
    are_contained_in_item_by_id(column_name, geographic_items.flatten.map(&:id))
  end

  # rubocop:disable Metrics/MethodLength
  # @param [String] column_name to search
  # @param [GeographicItem] geographic_item_ids or array of geographic_item_ids to be tested.
  # @return [Scope] of GeographicItems
  #
  # If this scope is given an Array of GeographicItems as a second parameter,
  # it will return the 'OR' of each of the objects against the table.
  # SELECT COUNT(*) FROM "geographic_items"
  #        WHERE (ST_Contains(polygon::geometry, GeomFromEWKT('srid=4326;POINT (0.0 0.0 0.0)'))
  #               OR ST_Contains(polygon::geometry, GeomFromEWKT('srid=4326;POINT (-9.8 5.0 0.0)')))
  #
  def are_contained_in_item_by_id(column_name, *geographic_item_ids) # = containing
    geographic_item_ids.flatten! # in case there is a array of arrays, or multiple objects
    column_name.downcase!
    case column_name
    when 'any'
      part = []
      DATA_TYPES.each { |column|
        unless column == :geometry_collection
          part.push(GeographicItem.are_contained_in_item_by_id(column.to_s, geographic_item_ids).to_a)
        end
      }
      # TODO: change 'id in (?)' to some other sql construct
      GeographicItem.where(id: part.flatten.map(&:id))
    when 'any_poly', 'any_line'
      part = []
      DATA_TYPES.each { |column|
        if column.to_s.index(column_name.gsub('any_', ''))
          part.push(GeographicItem.are_contained_in_item_by_id("#{column}", geographic_item_ids).to_a)
        end
      }
      # TODO: change 'id in (?)' to some other sql construct
      GeographicItem.where(id: part.flatten.map(&:id))
    else
      q = geographic_item_ids.flatten.collect { |geographic_item_id|
        # discover the item types, and convert type to database type for 'multi_'
        b = GeographicItem.where(id: geographic_item_id)
          .pluck(:type)[0].split(':')[2].downcase.gsub('lti', 'lti_')
        # a = GeographicItem.find(geographic_item_id).geo_object_type
        GeographicItem.containing_sql(column_name, geographic_item_id, b)
      }.join(' or ')
      q = 'FALSE' if q.blank? # this will prevent the invocation of *ALL* of the GeographicItems, if there are
      # no GeographicItems in the request (see CollectingEvent.name_hash(types)).
      where(q) # .not_including(geographic_items)
    end
  end

  # rubocop:enable Metrics/MethodLength

  # @param [String] column_name
  # @param [String] geometry of WKT
  # @return [Scope]
  # a single WKT geometry is compared against column or columns (except geometry_collection) to find geographic_items
  # which are contained in the WKT
  def are_contained_in_wkt(column_name, geometry)
    column_name.downcase!
    # column_name = 'point'
    case column_name
    when 'any'
      part = []
      DATA_TYPES.each { |column|
        unless column == :geometry_collection
          part.push(GeographicItem.are_contained_in_wkt(column.to_s, geometry).pluck(:id).to_a)
        end
      }
      # TODO: change 'id in (?)' to some other sql construct
      GeographicItem.where(id: part.flatten)
    when 'any_poly', 'any_line'
      part = []
      DATA_TYPES.each { |column|
        if column.to_s.index(column_name.gsub('any_', ''))
          part.push(GeographicItem.are_contained_in_wkt("#{column}", geometry).pluck(:id).to_a)
        end
      }
      # TODO: change 'id in (?)' to some other sql construct
      GeographicItem.where(id: part.flatten)
    else
      # column = points, geometry = square
      q = "ST_Contains(ST_GeomFromEWKT('srid=4326;#{geometry}'), #{column_name}::geometry)"
      where(q) # .not_including(geographic_items)
    end
  end

  # rubocop:disable Metrics/MethodLength
  #    containing the items the shape of which is contained in the geographic_item[s] supplied.
  # @param column_name [String] can be any of DATA_TYPES, or 'any' to check against all types, 'any_poly' to check
  # against 'polygon' or 'multi_polygon', or 'any_line' to check against 'line_string' or 'multi_line_string'.
  #  CANNOT be 'geometry_collection'.
  # @param geographic_items [GeographicItem] Can be a single GeographicItem, or an array of GeographicItem.
  # @return [Scope]
  def is_contained_by(column_name, *geographic_items)
    column_name.downcase!
    case column_name
    when 'any'
      part = []
      DATA_TYPES.each { |column|
        unless column == :geometry_collection
          part.push(GeographicItem.is_contained_by(column.to_s, geographic_items).to_a)
        end
      }
      # @TODO change 'id in (?)' to some other sql construct
      GeographicItem.where(id: part.flatten.map(&:id))

    when 'any_poly', 'any_line'
      part = []
      DATA_TYPES.each { |column|
        unless column == :geometry_collection
          if column.to_s.index(column_name.gsub('any_', ''))
            part.push(GeographicItem.is_contained_by(column.to_s, geographic_items).to_a)
          end
        end
      }
      # @TODO change 'id in (?)' to some other sql construct
      GeographicItem.where(id: part.flatten.map(&:id))

    else
      q = geographic_items.flatten.collect { |geographic_item|
        GeographicItem.reverse_containing_sql(column_name, geographic_item.to_param,
                                              geographic_item.geo_object_type)
      }.join(' or ')
      where(q) # .not_including(geographic_items)
    end
  end

  # rubocop:enable Metrics/MethodLength

  # @param [String, GeographicItem]
  # @return [Scope]
  def ordered_by_shortest_distance_from(column_name, geographic_item)
    if true # check_geo_params(column_name, geographic_item)
      select_distance_with_geo_object(column_name, geographic_item)
        .where_distance_greater_than_zero(column_name, geographic_item).order('distance')
    else
      where('false')
    end
  end

  # @param [String, GeographicItem]
  # @return [Scope]
  def ordered_by_longest_distance_from(column_name, geographic_item)
    if true # check_geo_params(column_name, geographic_item)
      q = select_distance_with_geo_object(column_name, geographic_item)
        .where_distance_greater_than_zero(column_name, geographic_item)
        .order('distance desc')
      q
    else
      where('false')
    end
  end

  # @param [String] column_name
  # @param [GeographicItem] geographic_item
  # @return [String]
  def select_distance_with_geo_object(column_name, geographic_item)
    select("*, ST_Distance(#{column_name}, GeomFromEWKT('srid=4326;#{geographic_item.geo_object}')) as distance")
  end

  # @param [String, GeographicItem]
  # @return [Scope]
  def where_distance_greater_than_zero(column_name, geographic_item)
    where("#{column_name} is not null and ST_Distance(#{column_name}, " \
          "GeomFromEWKT('srid=4326;#{geographic_item.geo_object}')) > 0")
  end

  # @param [GeographicItem]
  # @return [Scope]
  def not_including(geographic_items)
    where.not(id: geographic_items)
  end

  # @return [Scope]
  #   includes an 'is_valid' attribute (True/False) for the passed geographic_item.  Uses St_IsValid.
  # @param [RGeo object] geographic_item
  def with_is_valid_geometry_column(geographic_item)
    where(id: geographic_item.id).select("ST_IsValid(ST_AsBinary(#{geographic_item.geo_object_type})) is_valid")
  end

  #
  # Other
  #

  # @param [Integer] geographic_item_id1
  # @param [Integer] geographic_item_id2
  # @return [Float]
  def distance_between(geographic_item_id1, geographic_item_id2)
    q1 = "ST_Distance(#{GeographicItem::GEOGRAPHY_SQL}, " \
      "(#{select_geography_sql(geographic_item_id2)})) as distance"
    _q2 = ActiveRecord::Base.send(
      :sanitize_sql_array, ['ST_Distance(?, (?)) as distance',
                            GeographicItem::GEOGRAPHY_SQL,
                            select_geography_sql(geographic_item_id2)])
    GeographicItem.where(id: geographic_item_id1).pluck(Arel.sql(q1)).first
  end

  # @param [RGeo::Point] point
  # @return [Hash]
  #   as per #inferred_geographic_name_hierarchy but for Rgeo point
  def point_inferred_geographic_name_hierarchy(point)
    GeographicItem.containing_point(point).order(cached_total_area: :ASC).limit(1).first&.inferred_geographic_name_hierarchy
  end

  # @param [String] type_name ('polygon', 'point', 'line' [, 'circle'])
  # @return [String] if type
  def eval_for_type(type_name)
    retval = 'GeographicItem'
    case type_name.upcase
    when 'POLYGON'
      retval += '::Polygon'
    when 'LINESTRING'
      retval += '::LineString'
    when 'POINT'
      retval += '::Point'
    when 'MULTIPOLYGON'
      retval += '::MultiPolygon'
    when 'MULTILINESTRING'
      retval += '::MultiLineString'
    when 'MULTIPOINT'
      retval += '::MultiPoint'
    else
      retval = nil
    end
    retval
  end

  # example, not used
  # @param [Integer] geographic_item_id
  # @return [RGeo::Geographic object]
  def geometry_for(geographic_item_id)
    GeographicItem.select(GeographicItem::GEOMETRY_SQL.to_sql + ' AS geometry').find(geographic_item_id)['geometry']
  end

  # example, not used
  # @param [Integer, Array] geographic_item_ids
  # @return [Scope]
  def st_multi(*geographic_item_ids)
    GeographicItem.find_by_sql(
      "SELECT ST_Multi(ST_Collect(g.the_geom)) AS singlegeom
 FROM (
    SELECT (ST_DUMP(#{GeographicItem::GEOMETRY_SQL.to_sql})).geom AS the_geom
    FROM geographic_items
    WHERE id IN (?))
  AS g;", geographic_item_ids.flatten
    )
  end
end # class << self

# @return [Hash]
#    a geographic_name_classification or empty Hash
# This is a quick approach that works only when
# the geographic_item is linked explicitly to a GeographicArea.
#
# !! Note that it is not impossible for a GeographicItem to be linked
# to > 1 GeographicArea, in that case we are assuming that all are
# equally refined, this might not be the case in the future because
# of how the GeographicArea gazetteer is indexed.
def quick_geographic_name_hierarchy
  geographic_areas.order(:id).each do |ga|
    h = ga.geographic_name_classification # not quick enough !!
    return h if h.present?
  end
  return  {}
end

# @return [Hash]
#   a geographic_name_classification (see GeographicArea) inferred by
# finding the smallest area containing this GeographicItem, in the most accurate gazetteer
# and using it to return country/state/county. See also the logic in
# filling in missing levels in GeographicArea.
def inferred_geographic_name_hierarchy
  if small_area = containing_geographic_areas
    .joins(:geographic_areas_geographic_items)
    .merge(GeographicAreasGeographicItem.ordered_by_data_origin)
    .ordered_by_area
    .limit(1)
    .first
  return small_area.geographic_name_classification
  else
    {}
  end
end

def geographic_name_hierarchy
  a = quick_geographic_name_hierarchy # quick; almost never the case, UI not setup to do this
  return a if a.present?
  inferred_geographic_name_hierarchy # slow
end

# @return [Scope]
#   the Geographic Areas that contain (gis) this geographic item
def containing_geographic_areas
  GeographicArea.joins(:geographic_items).includes(:geographic_area_type)
    .joins("JOIN (#{GeographicItem.containing(id).to_sql}) j on geographic_items.id = j.id")
end

# @return [Boolean]
#   whether stored shape is ST_IsValid
def valid_geometry?
  GeographicItem.with_is_valid_geometry_column(self).first['is_valid']
end

# @return [Array of latitude, longitude]
#    the lat, lon of the first point in the GeoItem, see subclass for #st_start_point
def start_point
  o = st_start_point
  [o.y, o.x]
end

# @return [Array]
#   the lat, long, as STRINGs for the centroid of this geographic item
#   Meh- this: https://postgis.net/docs/en/ST_MinimumBoundingRadius.html
def center_coords
  r = GeographicItem.find_by_sql(
    "Select split_part(ST_AsLatLonText(ST_Centroid(#{GeographicItem::GEOMETRY_SQL.to_sql}), " \
    "'D.DDDDDD'), ' ', 1) latitude, split_part(ST_AsLatLonText(ST_Centroid" \
    "(#{GeographicItem::GEOMETRY_SQL.to_sql}), 'D.DDDDDD'), ' ', 2) " \
    "longitude from geographic_items where id = #{id};")[0]

  [r.latitude, r.longitude]
end

# @return [RGeo::Geographic::ProjectedPointImpl]
#    representing the centroid of this geographic item
def centroid
  # Gis::FACTORY.point(*center_coords.reverse)
  return geo_object if type == 'GeographicItem::Point'
  return Gis::FACTORY.parse_wkt(self.st_centroid)
end

# @param [Integer] geographic_item_id
# @return [Double] distance in meters (slower, more accurate)
def st_distance(geographic_item_id) # geo_object
  q1 = "ST_Distance((#{GeographicItem.select_geography_sql(id)}), " \
    "(#{GeographicItem.select_geography_sql(geographic_item_id)})) as d"
  _q2 = ActiveRecord::Base.send(:sanitize_sql_array, ['ST_Distance((?),(?)) as d',
                                                      GeographicItem.select_geography_sql(self.id),
                                                      GeographicItem.select_geography_sql(geographic_item_id)])
  deg = GeographicItem.where(id:).pluck(Arel.sql(q1)).first
  deg * Utilities::Geo::ONE_WEST
end

# @param [GeographicItem] geographic_item
# @return [Double] distance in meters
# Like st_distance but works with changed and non persisted objects
def st_distance_to_geographic_item(geographic_item)
  unless !persisted? || changed?
    a = "(#{GeographicItem.select_geography_sql(id)})"
  else
    a = "ST_GeographyFromText('#{geo_object}')"
  end

  unless !geographic_item.persisted? || geographic_item.changed?
    b = "(#{GeographicItem.select_geography_sql(geographic_item.id)})"
  else
    b = "ST_GeographyFromText('#{geographic_item.geo_object}')"
  end

  ActiveRecord::Base.connection.select_value("SELECT ST_Distance(#{a}, #{b})")
end

alias_method :distance_to, :st_distance

# @param [Integer] geographic_item_id
# @return [Double] distance in meters (faster, less accurate)
def st_distance_spheroid(geographic_item_id)
  q1 = "ST_DistanceSpheroid((#{GeographicItem.select_geometry_sql(id)})," \
    "(#{GeographicItem.select_geometry_sql(geographic_item_id)}),'#{Gis::SPHEROID}') as distance"
  _q2 = ActiveRecord::Base.send(:sanitize_sql_array,
                                ['ST_DistanceSpheroid((?),(?),?) as distance',
                                 GeographicItem.select_geometry_sql(id),
                                 GeographicItem.select_geometry_sql(geographic_item_id),
                                 Gis::SPHEROID])
  # TODO: what is _q2?
  GeographicItem.where(id:).pluck(Arel.sql(q1)).first
end

# @return [String]
#   a WKT POINT representing the centroid of the geographic item
def st_centroid
  GeographicItem.where(id: to_param).pluck(Arel.sql("ST_AsEWKT(ST_Centroid(#{GeographicItem::GEOMETRY_SQL.to_sql}))")).first.gsub(/SRID=\d*;/, '')
end

# @return [Integer]
#   the number of points in the geometry
def st_npoints
  GeographicItem.where(id:).pluck(Arel.sql("ST_NPoints(#{GeographicItem::GEOMETRY_SQL.to_sql}) as npoints")).first
end

# @return [Symbol]
#   the geo type (i.e. column like :point, :multipolygon).  References the first-found object,
# according to the list of DATA_TYPES, or nil
def geo_object_type
  if self.class.name == 'GeographicItem' # a proxy check for new records
    geo_type
  else
    self.class::SHAPE_COLUMN
  end
end

# !!TODO: migrate these to use native column calls

# @return [RGeo instance, nil]
#  the Rgeo shape (See http://rubydoc.info/github/dazuma/rgeo/RGeo/Feature)
def geo_object
  begin
    if r = geo_object_type # rubocop:disable Lint/AssignmentInCondition
      send(r)
    else
      false
    end
  rescue RGeo::Error::InvalidGeometry
    return nil # TODO: we need to render proper error for this!
  end
end

# @param [geo_object]
# @return [Boolean]
def contains?(target_geo_object)
  return nil if target_geo_object.nil?
  self.geo_object.contains?(target_geo_object)
end

# @param [geo_object]
# @return [Boolean]
def within?(target_geo_object)
  self.geo_object.within?(target_geo_object)
end

# @param [geo_object]
# @return [Boolean]
def intersects?(target_geo_object)
  self.geo_object.intersects?(target_geo_object)
end

# @param [geo_object, Double]
# @return [Boolean]
def near(target_geo_object, distance)
  self.geo_object.unsafe_buffer(distance).contains?(target_geo_object)
end

# @param [geo_object, Double]
# @return [Boolean]
def far(target_geo_object, distance)
  !near(target_geo_object, distance)
end

# @return [GeoJSON hash]
#    via Rgeo apparently necessary for GeometryCollection
def rgeo_to_geo_json
  RGeo::GeoJSON.encode(geo_object).to_json
end

# @return [Hash]
#   in GeoJSON format
#   Computed via "raw" PostGIS (much faster). This
#   requires the geo_object_type and id.
#
def to_geo_json
  JSON.parse(
    GeographicItem.connection.select_one(
      "SELECT ST_AsGeoJSON(#{geo_object_type}::geometry) a " \
      "FROM geographic_items WHERE id=#{id};")['a'])
end

# We don't need to serialize to/from JSON
def to_geo_json_string
  GeographicItem.connection.select_one(
    "SELECT ST_AsGeoJSON(#{geo_object_type}::geometry) a " \
    "FROM geographic_items WHERE id=#{id};")['a']
end

# @return [Hash]
#   the shape as a GeoJSON Feature with some item metadata
def to_geo_json_feature
  @geometry ||= to_geo_json
  {'type' => 'Feature',
   'geometry' => geometry,
   'properties' => {
     'geographic_item' => {
       'id' => id}
   }
  }
end

# @param value [String] like:
#   '{"type":"Feature","geometry":{"type":"Point","coordinates":[2.5,4.0]},"properties":{"color":"red"}}'
#
#   '{"type":"Feature","geometry":{"type":"Polygon","coordinates":"[[[-125.29394388198853, 48.584480409793],
#      [-67.11035013198853, 45.09937589848195],[-80.64550638198853, 25.01924647619111],[-117.55956888198853,
#      32.5591595028449],[-125.29394388198853, 48.584480409793]]]"},"properties":{}}'
#
#  '{"type":"Point","coordinates":[2.5,4.0]},"properties":{"color":"red"}}'
#
# @return [Boolean, RGeo object]
def shape=(value)

  if value.present?
    geom = RGeo::GeoJSON.decode(value, json_parser: :json, geo_factory: Gis::FACTORY)
    this_type = nil

    if geom.respond_to?(:geometry_type)
      this_type = geom.geometry_type.to_s
    elsif geom.respond_to?(:geometry)
      this_type = geom.geometry.geometry_type.to_s
    else
    end

    self.type = GeographicItem.eval_for_type(this_type) unless geom.nil?

    if type.blank?
      errors.add(:base, 'type is not set from shape')
      return
    end
    # raise('GeographicItem.type not set.') if type.blank?

    object = nil

    s = geom.respond_to?(:geometry) ? geom.geometry.to_s : geom.to_s

    begin
      object = Gis::FACTORY.parse_wkt(s)
    rescue RGeo::Error::InvalidGeometry
      errors.add(:self, 'Shape value is an Invalid Geometry')
    end

    write_attribute(this_type.underscore.to_sym, object)
    geom
  end
end

# @return [String]
def to_wkt
  #  10k  #<Benchmark::Tms:0x00007fb0dfd30fd0 @label="", @real=25.237487000005785, @cstime=0.0, @cutime=0.0, @stime=1.1704609999999995, @utime=5.507929999999988, @total=6.678390999999987>
  #  GeographicItem.select("ST_AsText( #{GeographicItem::GEOMETRY_SQL.to_sql}) wkt").where(id: id).first.wkt

  # 10k <Benchmark::Tms:0x00007fb0e02f7540 @label="", @real=21.619827999995323, @cstime=0.0, @cutime=0.0, @stime=0.8850890000000007, @utime=3.2958549999999605, @total=4.180943999999961>
  if a =  ApplicationRecord.connection.execute( "SELECT ST_AsText( #{GeographicItem::GEOMETRY_SQL.to_sql} ) wkt from geographic_items where geographic_items.id = #{id}").first
    return a['wkt']
  else
    return nil
  end
end

# @return  [Float] in meters, calculated
# TODO: share with world
#    Geographic item 96862 (Cajamar in Brazil) is the only(?) record to fail using `false` (quicker) method of everything we tested
def area
  a = GeographicItem.where(id:).select("ST_Area(#{GeographicItem::GEOGRAPHY_SQL}, true) as area_in_meters").first['area_in_meters']
  a = nil if a.nan?
  a
end

# @return [Float, false]
#    the value in square meters of the interesecting area of this and another GeographicItem
def intersecting_area(geographic_item_id)
  a = GeographicItem.aliased_geographic_sql('a')
  b = GeographicItem.aliased_geographic_sql('b')

  c = GeographicItem.connection.execute(
    "SELECT ST_Area(ST_Intersection(#{a}, #{b})) as intersecting_area
      FROM geographic_items a, geographic_items b
      WHERE a.id = #{id} AND b.id = #{geographic_item_id};"
  ).first
  c && c['intersecting_area'].to_f
end

# TODO: This is bad, while internal use of ONE_WEST_MEAN is consistent it is in-accurate given the vast differences of radius vs. lat/long position.
# When we strike the error-polygon from radius we should remove this
#
# Use case is returning the radius from a circle we calculated via buffer for error-polygon creation.
def radius
  r = ApplicationRecord.connection.execute( "SELECT ST_MinimumBoundingRadius( ST_Transform(  #{GeographicItem::GEOMETRY_SQL.to_sql}, 4326 )  ) AS radius from geographic_items where geographic_items.id = #{id}").first['radius'].split(',').last.chop.to_f
  r = (r * Utilities::Geo::ONE_WEST_MEAN).to_i
end


# Convention is to store in PostGIS in CCW
# @return Array [Boolean]
#   false - cw
#   true - ccw (preferred), except cee donuts
def orientations
  if multi_polygon.present?
    ApplicationRecord.connection.execute(" \
         SELECT ST_IsPolygonCCW(a.geom) as is_ccw
            FROM ( SELECT b.id, (ST_Dump(p_geom)).geom AS geom
               FROM (SELECT id, multi_polygon::geometry AS p_geom FROM geographic_items where id = #{id}) AS b \
          ) AS a;").collect{|a| a['is_ccw']}
  elsif polygon.present?
    ApplicationRecord.connection.execute("SELECT ST_IsPolygonCCW(polygon::geometry) as is_ccw \
            FROM geographic_items where  id = #{id};").collect{|a| a['is_ccw']}
  else
    []
  end
end

# @return Boolean
#   looks at all orientations
#   if they follow the pattern [true, false, ... <all false>] then `true`, else `false`
# !! Does not confirm that shapes are nested !!
def is_basic_donut?
  a = orientations
  b = a.shift
  return false unless b
  a.uniq!
  a == [false]
end

def st_isvalid
  r = ApplicationRecord.connection.execute( "SELECT ST_IsValid(  #{GeographicItem::GEOMETRY_SQL.to_sql }) from  geographic_items where geographic_items.id = #{id}").first['st_isvalid']
end

def st_isvalidreason
  r = ApplicationRecord.connection.execute( "SELECT ST_IsValidReason(  #{GeographicItem::GEOMETRY_SQL.to_sql }) from  geographic_items where geographic_items.id = #{id}").first['st_isvalidreason']
end

# !! Unused. Doesn't check Geometry collection
def has_polygons?
  ['GeographicItem::MultiPolygon', 'GeographicItem::Polygon'].include?(self.type)
end

private

def align_winding
  if orientations.flatten.include?(false)
    case type
    when 'multi_polygon'
      ApplicationRecord.connection.execute(
        "UPDATE geographic_items set multi_polygon = ST_ForcePolygonCCW(multi_polygon::geometry) 
          WHERE id = #{self.id};"
       )
    when 'polygon'
     ApplicationRecord.connection.execute(
        "UPDATE geographic_items set polygon = ST_ForcePolygonCCW(polygon::geometry) 
          WHERE id = #{self.id};"
       )
    end     
  end
  true
end

# Crude debuging helper, write the shapes
# to a png
def self.debug_draw(geographic_item_ids = [])
  return false if geographic_item_ids.empty?

  sql = "SELECT ST_AsPNG(
     ST_AsRaster(
        (SELECT ST_Union(multi_polygon::geometry) from geographic_items where id IN (" + geographic_item_ids.join(',') + ")), 1920, 1080
    )
   ) png;"

  # ST_Buffer( multi_polygon::geometry, 0, 'join=bevel'),
  #     1920,
  #     1080)


  result = ActiveRecord::Base.connection.execute(sql).first['png']
  r = ActiveRecord::Base.connection.unescape_bytea(result)

  prefix = if geographic_item_ids.size > 10
             'multiple'
           else
             geographic_item_ids.join('_') + '_debug.draw.png'
           end

  n = prefix + '_debug.draw.png'

  # Open the file in binary write mode ("wb")
  File.open(n, 'wb') do |file|
    # Write the binary data to the file
    file.write(r)
  end
end

# def png

#   if ids = Otu.joins(:cached_map_items).first.cached_map_items.pluck(:geographic_item_id)

#     sql = "SELECT ST_AsPNG(
#    ST_AsRaster(
#        ST_Buffer( multi_polygon::geometry, 0, 'join=bevel'),
#            1024,
#            768)
#     ) png
#        from geographic_items where id IN (" + ids.join(',') + ');'

#     # hack, not the best way to unpack result
#     result = ActiveRecord::Base.connection.execute(sql).first['png']
#     r = ActiveRecord::Base.connection.unescape_bytea(result)

#     send_data r, filename: 'foo.png', type: 'imnage/png'

#   else
#     render json: {foo: false}
#   end
# end

def set_cached
  update_column(:cached_total_area, area)
end

# @return [Symbol]
#   returns the attribute (column name) containing data
#   nearly all methods should use #geo_object_type, not geo_type
def geo_type
  DATA_TYPES.each { |item|
    return item if send(item)
  }
  nil
end

# @return [Boolean, String] false if already set, or type to which it was set
def set_type_if_geography_present
  if type.blank?
    column = geo_type
    self.type = "GeographicItem::#{column.to_s.camelize}" if column
  end
end

# @param [RGeo::Point] point
# @return [Array] of a point
#   Longitude |, Latitude -
def point_to_a(point)
  data = []
  data.push(point.x, point.y)
  data
end

# @param [RGeo::Point] point
# @return [Hash] of a point
def point_to_hash(point)
  {points: [point_to_a(point)]}
end

# @param [RGeo::MultiPoint] multi_point
# @return [Array] of points
def multi_point_to_a(multi_point)
  data = []
  multi_point.each { |point|
    data.push([point.x, point.y])
  }
  data
end

# @return [Hash] of points
def multi_point_to_hash(_multi_point)
  # when we encounter a multi_point type, we only stick the points into the array, NOT it's identity as a group
  {points: multi_point_to_a(multi_point)}
end

# @param [Reo::LineString] line_string
# @return [Array] of points in the line
def line_string_to_a(line_string)
  data = []
  line_string.points.each { |point|
    data.push([point.x, point.y])
  }
  data
end

# @param [Reo::LineString] line_string
# @return [Hash] of points in the line
def line_string_to_hash(line_string)
  {lines: [line_string_to_a(line_string)]}
end

# @param [RGeo::Polygon] polygon
# @return [Array] of points in the polygon (exterior_ring ONLY)
def polygon_to_a(polygon)
  # TODO: handle other parts of the polygon; i.e., the interior_rings (if they exist)
  data = []
  polygon.exterior_ring.points.each { |point|
    data.push([point.x, point.y])
  }
  data
end

# @param [RGeo::Polygon] polygon
# @return [Hash] of points in the polygon (exterior_ring ONLY)
def polygon_to_hash(polygon)
  {polygons: [polygon_to_a(polygon)]}
end

# @return [Array] of line_strings as arrays of points
# @param [RGeo::MultiLineString] multi_line_string
def multi_line_string_to_a(multi_line_string)
  data = []
  multi_line_string.each { |line_string|
    line_data = []
    line_string.points.each { |point|
      line_data.push([point.x, point.y])
    }
    data.push(line_data)
  }
  data
end

# @return [Hash] of line_strings as hashes of points
def multi_line_string_to_hash(_multi_line_string)
  {lines: to_a}
end

# @param [RGeo::MultiPolygon] multi_polygon
# @return [Array] of arrays of points in the polygons (exterior_ring ONLY)
def multi_polygon_to_a(multi_polygon)
  data = []
  multi_polygon.each { |polygon|
    polygon_data = []
    polygon.exterior_ring.points.each { |point|
      polygon_data.push([point.x, point.y])
    }
    data.push(polygon_data)
  }
  data
end

# @return [Hash] of hashes of points in the polygons (exterior_ring ONLY)
def multi_polygon_to_hash(_multi_polygon)
  {polygons: to_a}
end

# @return [Boolean] iff there is one and only one shape column set
def some_data_is_provided
  data = []

  DATA_TYPES.each do |item|
    data.push(item) if send(item).present?
  end

  case data.count
  when 0
    errors.add(:base, 'No shape provided or provided shape is invalid')
  when 1
    return true
  else
    data.each do |object|
      errors.add(object, 'More than one shape type provided')
    end
  end
  true
end
end

#polygon ⇒ `RGeo::Geographic::ProjectedPolygonImpl`

CCW orientation is applied

Returns:

(RGeo::Geographic::ProjectedPolygonImpl)

# File 'app/models/geographic_item.rb', line 40

class GeographicItem < ApplicationRecord
  include Housekeeping::Users
  include Housekeeping::Timestamps
  include Shared::HasPapertrail
  include Shared::IsData
  include Shared::SharedAcrossProjects

  # @return [Hash, nil]
  #   An internal variable for use in super calls, holds a Hash in GeoJSON format (temporarily)
  attr_accessor :geometry

  # @return [Boolean, RGeo object]
  # @params value [Hash in GeoJSON format] ?!
  # TODO: WHY! boolean not nil, or object
  # Used to build geographic items from a shape [ of what class ] !?
  attr_accessor :shape

  # @return [Boolean]
  #   When true cached values are not built
  attr_accessor :no_cached

  DATA_TYPES = [
:point,
:line_string,
:polygon,
:multi_point,
:multi_line_string,
:multi_polygon,
:geometry_collection
  ].freeze

  GEOMETRY_SQL = Arel::Nodes::Case.new(arel_table[:type])
.when('GeographicItem::MultiPolygon').then(Arel::Nodes::NamedFunction.new('CAST', [arel_table[:multi_polygon].as('geometry')]))
.when('GeographicItem::Point').then(Arel::Nodes::NamedFunction.new('CAST', [arel_table[:point].as('geometry')]))
.when('GeographicItem::LineString').then(Arel::Nodes::NamedFunction.new('CAST', [arel_table[:line_string].as('geometry')]))
.when('GeographicItem::Polygon').then(Arel::Nodes::NamedFunction.new('CAST', [arel_table[:polygon].as('geometry')]))
.when('GeographicItem::MultiLineString').then(Arel::Nodes::NamedFunction.new('CAST', [arel_table[:multi_line_string].as('geometry')]))
.when('GeographicItem::MultiPoint').then(Arel::Nodes::NamedFunction.new('CAST', [arel_table[:multi_point].as('geometry')]))
.when('GeographicItem::GeometryCollection').then(Arel::Nodes::NamedFunction.new('CAST', [arel_table[:geometry_collection].as('geometry')]))
.freeze

  GEOGRAPHY_SQL = "CASE geographic_items.type
WHEN 'GeographicItem::MultiPolygon' THEN multi_polygon
WHEN 'GeographicItem::Point' THEN point
WHEN 'GeographicItem::LineString' THEN line_string
WHEN 'GeographicItem::Polygon' THEN polygon
WHEN 'GeographicItem::MultiLineString' THEN multi_line_string
WHEN 'GeographicItem::MultiPoint' THEN multi_point
WHEN 'GeographicItem::GeometryCollection' THEN geometry_collection
END".freeze

# ANTI_MERIDIAN = '0X0102000020E61000000200000000000000008066400000000000405640000000000080664000000000004056C0'
ANTI_MERIDIAN = 'LINESTRING (180 89.0, 180 -89)'.freeze

has_many :cached_map_items, inverse_of: :geographic_item

has_many :geographic_areas_geographic_items, dependent: :destroy, inverse_of: :geographic_item
has_many :geographic_areas, through: :geographic_areas_geographic_items
has_many :asserted_distributions, through: :geographic_areas
has_many :geographic_area_types, through: :geographic_areas
has_many :parent_geographic_areas, through: :geographic_areas, source: :parent

has_many :georeferences, inverse_of: :geographic_item
has_many :georeferences_through_error_geographic_item,
  class_name: 'Georeference', foreign_key: :error_geographic_item_id, inverse_of: :error_geographic_item
has_many :collecting_events_through_georeferences, through: :georeferences, source: :collecting_event
has_many :collecting_events_through_georeference_error_geographic_item,
  through: :georeferences_through_error_geographic_item, source: :collecting_event

# TODO: THIS IS NOT GOOD
before_validation :set_type_if_geography_present

validate :some_data_is_provided
validates :type, presence: true # not needed

scope :include_collecting_event, -> { includes(:collecting_events_through_georeferences) }
scope :geo_with_collecting_event, -> { joins(:collecting_events_through_georeferences) }
scope :err_with_collecting_event, -> { joins(:georeferences_through_error_geographic_item) }

after_save :set_cached, unless: Proc.new {|n| n.no_cached || errors.any? }
after_save :align_winding

class << self

  def aliased_geographic_sql(name = 'a')
    "CASE #{name}.type \
     WHEN 'GeographicItem::MultiPolygon' THEN #{name}.multi_polygon \
     WHEN 'GeographicItem::Point' THEN #{name}.point \
     WHEN 'GeographicItem::LineString' THEN #{name}.line_string \
     WHEN 'GeographicItem::Polygon' THEN #{name}.polygon \
     WHEN 'GeographicItem::MultiLineString' THEN #{name}.multi_line_string \
     WHEN 'GeographicItem::MultiPoint' THEN #{name}.multi_point \
     WHEN 'GeographicItem::GeometryCollection' THEN #{name}.geometry_collection \
     END"
  end

  def st_union(geographic_item_scope)
    GeographicItem.select("ST_Union(#{GeographicItem::GEOMETRY_SQL.to_sql}) as collection")
      .where(id: geographic_item_scope.pluck(:id))
  end

  def st_collect(geographic_item_scope)
    GeographicItem.select("ST_Collect(#{GeographicItem::GEOMETRY_SQL.to_sql}) as collection")
      .where(id: geographic_item_scope.pluck(:id))
  end

  # @return [GeographicItem::ActiveRecord_Relation]
  # @params [Array] array of geographic area ids
  def default_by_geographic_area_ids(geographic_area_ids = [])
    GeographicItem.
      joins(:geographic_areas_geographic_items).
      merge(::GeographicAreasGeographicItem.default_geographic_item_data).
      where(geographic_areas_geographic_items: {geographic_area_id: geographic_area_ids})
  end

  # @param [String] wkt
  # @return [Boolean]
  #   whether or not the wtk intersects with the anti-meridian
  #   !! StrongParams security considerations
  def crosses_anti_meridian?(wkt)
    GeographicItem.find_by_sql(
      ['SELECT ST_Intersects(ST_GeogFromText(?), ST_GeogFromText(?)) as r;', wkt, ANTI_MERIDIAN]
    ).first.r
  end

  # @param [Integer] ids
  # @return [Boolean]
  #   whether or not any GeographicItem passed intersects the anti-meridian
  #   !! StrongParams security considerations
  #   This is our first line of defense against queries that define multiple shapes, one or
  #   more of which crosses the anti-meridian.  In this case the current TW strategy within the
  #   UI is to abandon the search, and prompt the user to refactor the query.
  def crosses_anti_meridian_by_id?(*ids)
    q1 = ["SELECT ST_Intersects((SELECT single_geometry FROM (#{GeographicItem.single_geometry_sql(*ids)}) as " \
          'left_intersect), ST_GeogFromText(?)) as r;', ANTI_MERIDIAN]
    _q2 = ActiveRecord::Base.send(:sanitize_sql_array, ['SELECT ST_Intersects((SELECT single_geometry FROM (?) as ' \
                                                        'left_intersect), ST_GeogFromText(?)) as r;', GeographicItem.single_geometry_sql(*ids), ANTI_MERIDIAN])
    GeographicItem.find_by_sql(q1).first.r
  end

  #
  # SQL fragments
  #

  # @param [Integer, String]
  # @return [String]
  #   a SQL select statement that returns the *geometry* for the geographic_item with the specified id
  def select_geometry_sql(geographic_item_id)
    "SELECT #{GeographicItem::GEOMETRY_SQL.to_sql} from geographic_items where geographic_items.id = #{geographic_item_id}"
  end

  # @param [Integer, String]
  # @return [String]
  #   a SQL select statement that returns the geography for the geographic_item with the specified id
  def select_geography_sql(geographic_item_id)
    ActiveRecord::Base.send(:sanitize_sql_for_conditions, [
      "SELECT #{GeographicItem::GEOMETRY_SQL.to_sql} from geographic_items where geographic_items.id = ?",
      geographic_item_id])
  end

  # @param [Symbol] choice
  # @return [String]
  #   a fragment returning either latitude or longitude columns
  def lat_long_sql(choice)
    return nil unless [:latitude, :longitude].include?(choice)
    f = "'D.DDDDDD'" # TODO: probably a constant somewhere
    v = (choice == :latitude ? 1 : 2)
    "CASE geographic_items.type
  WHEN 'GeographicItem::GeometryCollection' THEN split_part(ST_AsLatLonText(ST_Centroid" \
  "(geometry_collection::geometry), #{f}), ' ', #{v})
  WHEN 'GeographicItem::LineString' THEN split_part(ST_AsLatLonText(ST_Centroid(line_string::geometry), " \
  "#{f}), ' ', #{v})
  WHEN 'GeographicItem::MultiPolygon' THEN split_part(ST_AsLatLonText(" \
  "ST_Centroid(multi_polygon::geometry), #{f}), ' ', #{v})
  WHEN 'GeographicItem::Point' THEN split_part(ST_AsLatLonText(" \
  "ST_Centroid(point::geometry), #{f}), ' ', #{v})
  WHEN 'GeographicItem::Polygon' THEN split_part(ST_AsLatLonText(" \
  "ST_Centroid(polygon::geometry), #{f}), ' ', #{v})
  WHEN 'GeographicItem::MultiLineString' THEN split_part(ST_AsLatLonText(" \
  "ST_Centroid(multi_line_string::geometry), #{f} ), ' ', #{v})
  WHEN 'GeographicItem::MultiPoint' THEN split_part(ST_AsLatLonText(" \
  "ST_Centroid(multi_point::geometry), #{f}), ' ', #{v})
END as #{choice}"
  end

  # @param [Integer] geographic_item_id
  # @param [Integer] distance
  # @return [String]
  def within_radius_of_item_sql(geographic_item_id, distance)
    "ST_DWithin((#{GeographicItem::GEOGRAPHY_SQL}), (#{select_geography_sql(geographic_item_id)}), #{distance})"
  end


  # @param [Integer] geographic_item_id
  # @param [Number] distance in meters to grow/shrink the shape (negative allowed)
  # @param [Number] distance (in meters) (positive only?!)
  # @return [String]
  def st_buffer_st_within(geographic_item_id, distance, buffer = 0)
    "ST_DWithin(
    ST_Buffer(#{GeographicItem::GEOGRAPHY_SQL}, #{buffer}),
    (#{select_geography_sql(geographic_item_id)}), #{distance}
   )"
  end


  # TODO: 3D is overkill here
  # @param [String] wkt
  # @param [Integer] distance (meters)
  # @return [String]
  # !! This is intersecting
  def intersecting_radius_of_wkt_sql(wkt, distance)
    "ST_DWithin((#{GeographicItem::GEOGRAPHY_SQL}), ST_Transform( ST_GeomFromText('#{wkt}', " \
      "4326), 4326), #{distance})"
  end

  # @param [String] wkt
  # @param [Integer] distance (meters)
  # @return [String]
  # !! This is fully covering
  def within_radius_of_wkt_sql(wkt, distance)
    "ST_Covers( ST_Buffer(ST_SetSRID( ST_GeomFromText('#{wkt}'), 4326)::geography, #{distance}), (#{GeographicItem::GEOGRAPHY_SQL}))"
  end

  # @param [String, Integer, String]
  # @return [String]
  #   a SQL fragment for ST_Contains() function, returns
  #   all geographic items which are contained in the item supplied
  def containing_sql(target_column_name = nil, geographic_item_id = nil, source_column_name = nil)
    return 'false' if geographic_item_id.nil? || source_column_name.nil? || target_column_name.nil?
    "ST_Contains(#{target_column_name}::geometry, (#{geometry_sql(geographic_item_id, source_column_name)}))"
  end

  # @param [String, Integer, String]
  # @return [String]
  #   a SQL fragment for ST_Contains(), returns
  #   all geographic_items which contain the supplied geographic_item
  def reverse_containing_sql(target_column_name = nil, geographic_item_id = nil, source_column_name = nil)
    return 'false' if geographic_item_id.nil? || source_column_name.nil? || target_column_name.nil?
    "ST_Contains((#{geometry_sql(geographic_item_id, source_column_name)}), #{target_column_name}::geometry)"
  end

  # @param [Integer, String]
  # @return [String]
  #   a SQL fragment that represents the geometry of the geographic item specified (which has data in the
  # source_column_name, i.e. geo_object_type)
  def geometry_sql(geographic_item_id = nil, source_column_name = nil)
    return 'false' if geographic_item_id.nil? || source_column_name.nil?
    "select geom_alias_tbl.#{source_column_name}::geometry from geographic_items geom_alias_tbl " \
      "where geom_alias_tbl.id = #{geographic_item_id}"
  end

  # rubocop:disable Metrics/MethodLength
  # @param [String] column_name
  # @param [GeographicItem] geographic_item
  # @return [String] of SQL
  def is_contained_by_sql(column_name, geographic_item)
    geo_id = geographic_item.id
    geo_type = geographic_item.geo_object_type
    template = '(ST_Contains((select geographic_items.%s::geometry from geographic_items where ' \
      'geographic_items.id = %d), %s::geometry))'
    retval = []
    column_name.downcase!
    case column_name
    when 'any'
      DATA_TYPES.each { |column|
        unless column == :geometry_collection
          retval.push(template % [geo_type, geo_id, column])
        end
      }
    when 'any_poly', 'any_line'
      DATA_TYPES.each { |column|
        unless column == :geometry_collection
          if column.to_s.index(column_name.gsub('any_', ''))
            retval.push(template % [geo_type, geo_id, column])
          end
        end
      }
    else
      retval = template % [geo_type, geo_id, column_name]
    end
    retval = retval.join(' OR ') if retval.instance_of?(Array)
    retval
  end

  # @param [Interger, Array of Integer] geographic_item_ids
  # @return [String]
  #   a select query that returns a single geometry (column name 'single_geometry' for the collection of ids
  # provided via ST_Collect)
  def st_collect_sql(*geographic_item_ids)
    geographic_item_ids.flatten!
    ActiveRecord::Base.send(:sanitize_sql_for_conditions, [
      "SELECT ST_Collect(f.the_geom) AS single_geometry
 FROM (
    SELECT (ST_DUMP(#{GeographicItem::GEOMETRY_SQL.to_sql})).geom as the_geom
    FROM geographic_items
    WHERE id in (?))
  AS f", geographic_item_ids])
  end

  # @param [Interger, Array of Integer] geographic_item_ids
  # @return [String]
  #    returns one or more geographic items combined as a single geometry in column 'single'
  def single_geometry_sql(*geographic_item_ids)
    a = GeographicItem.st_collect_sql(geographic_item_ids)
    '(SELECT single.single_geometry FROM (' + a + ' ) AS single)'
  end

  # @param [Interger, Array of Integer] geographic_item_ids
  # @return [String]
  #   returns a single geometry "column" (paren wrapped) as "single" for multiple geographic item ids, or the
  # geometry as 'geometry' for a single id
  def geometry_sql2(*geographic_item_ids)
    geographic_item_ids.flatten! # *ALWAYS* reduce the pile to a single level of ids
    if geographic_item_ids.count == 1
      "(#{GeographicItem.geometry_for_sql(geographic_item_ids.first)})"
    else
      GeographicItem.single_geometry_sql(geographic_item_ids)
    end
  end

  # @param [Interger, Array of Integer] geographic_item_ids
  # @return [String]
  def containing_where_sql(*geographic_item_ids)
    "ST_CoveredBy(
      #{GeographicItem.geometry_sql2(*geographic_item_ids)},
       CASE geographic_items.type
         WHEN 'GeographicItem::MultiPolygon' THEN multi_polygon::geometry
         WHEN 'GeographicItem::Point' THEN point::geometry
         WHEN 'GeographicItem::LineString' THEN line_string::geometry
         WHEN 'GeographicItem::Polygon' THEN polygon::geometry
         WHEN 'GeographicItem::MultiLineString' THEN multi_line_string::geometry
         WHEN 'GeographicItem::MultiPoint' THEN multi_point::geometry
      END)"
  end

  # @param [Interger, Array of Integer] geographic_item_ids
  # @return [String]
  def containing_where_sql_geog(*geographic_item_ids)
    "ST_CoveredBy(
      #{GeographicItem.geometry_sql2(*geographic_item_ids)},
       CASE geographic_items.type
         WHEN 'GeographicItem::MultiPolygon' THEN multi_polygon::geography
         WHEN 'GeographicItem::Point' THEN point::geography
         WHEN 'GeographicItem::LineString' THEN line_string::geography
         WHEN 'GeographicItem::Polygon' THEN polygon::geography
         WHEN 'GeographicItem::MultiLineString' THEN multi_line_string::geography
         WHEN 'GeographicItem::MultiPoint' THEN multi_point::geography
      END)"
  end

  # @param [Interger, Array of Integer] ids
  # @return [Array]
  #   If we detect that some query id has crossed the meridian, then loop through
  #   and "manually" build up a list of results.
  #   Should only be used if GeographicItem.crosses_anti_meridian_by_id? is true.
  #   Note that this does not return a Scope, so you can't chain it like contained_by?
  # TODO: test this
  def contained_by_with_antimeridian_check(*ids)
    ids.flatten! # make sure there is only one level of splat (*)
    results = []

    crossing_ids = []

    ids.each do |id|
      # push each which crosses
      crossing_ids.push(id) if GeographicItem.crosses_anti_meridian_by_id?(id)
    end

    non_crossing_ids = ids - crossing_ids
    results.push GeographicItem.contained_by(non_crossing_ids).to_a if non_crossing_ids.any?

    crossing_ids.each do |id|
      # [61666, 61661, 61659, 61654, 61639]
      q1 = ActiveRecord::Base.send(:sanitize_sql_array, ['SELECT ST_AsText((SELECT polygon FROM geographic_items ' \
                                                         'WHERE id = ?))', id])
      r = GeographicItem.where(
        # GeographicItem.contained_by_wkt_shifted_sql(GeographicItem.find(id).geo_object.to_s)
        GeographicItem.contained_by_wkt_shifted_sql(
          ApplicationRecord.connection.execute(q1).first['st_astext'])
      ).to_a
      results.push(r)
    end

    results.flatten.uniq
  end

  # @params [String] well known text
  # @return [String] the SQL fragment for the specific geometry type, shifted by longitude
  # Note: this routine is called when it is already known that the A argument crosses anti-meridian
  def contained_by_wkt_shifted_sql(wkt)
    "ST_Contains(ST_ShiftLongitude(ST_GeomFromText('#{wkt}', 4326)), (
    CASE geographic_items.type
       WHEN 'GeographicItem::MultiPolygon' THEN ST_ShiftLongitude(multi_polygon::geometry)
       WHEN 'GeographicItem::Point' THEN ST_ShiftLongitude(point::geometry)
       WHEN 'GeographicItem::LineString' THEN ST_ShiftLongitude(line_string::geometry)
       WHEN 'GeographicItem::Polygon' THEN ST_ShiftLongitude(polygon::geometry)
       WHEN 'GeographicItem::MultiLineString' THEN ST_ShiftLongitude(multi_line_string::geometry)
       WHEN 'GeographicItem::MultiPoint' THEN ST_ShiftLongitude(multi_point::geometry)
    END
    )
  )"
  end

  # TODO: Remove the hard coded 4326 reference
  # @params [String] wkt
  # @return [String] SQL fragment limiting geographics items to those in this WKT
  def contained_by_wkt_sql(wkt)
    if crosses_anti_meridian?(wkt)
      retval = contained_by_wkt_shifted_sql(wkt)
    else
      retval = "ST_Contains(ST_GeomFromText('#{wkt}', 4326), (
    CASE geographic_items.type
       WHEN 'GeographicItem::MultiPolygon' THEN multi_polygon::geometry
       WHEN 'GeographicItem::Point' THEN point::geometry
       WHEN 'GeographicItem::LineString' THEN line_string::geometry
       WHEN 'GeographicItem::Polygon' THEN polygon::geometry
       WHEN 'GeographicItem::MultiLineString' THEN multi_line_string::geometry
       WHEN 'GeographicItem::MultiPoint' THEN multi_point::geometry
    END
    )
  )"
    end
    retval
  end

  # @param [Interger, Array of Integer] geographic_item_ids
  # @return [String] sql for contained_by via ST_ContainsProperly
  # Note: Can not use GEOMETRY_SQL because geometry_collection is not supported in ST_ContainsProperly
  # Note: !! If the target GeographicItem#id crosses the anti-meridian then you may/will get unexpected results.
  def contained_by_where_sql(*geographic_item_ids)
    "ST_Contains(
    #{GeographicItem.geometry_sql2(*geographic_item_ids)},
    CASE geographic_items.type
      WHEN 'GeographicItem::MultiPolygon' THEN multi_polygon::geometry
      WHEN 'GeographicItem::Point' THEN point::geometry
      WHEN 'GeographicItem::LineString' THEN line_string::geometry
      WHEN 'GeographicItem::Polygon' THEN polygon::geometry
      WHEN 'GeographicItem::MultiLineString' THEN multi_line_string::geometry
      WHEN 'GeographicItem::MultiPoint' THEN multi_point::geometry
    END)"
  end

  # @param [RGeo:Point] rgeo_point
  # @return [String] sql for containing via ST_CoveredBy
  # TODO: Remove the hard coded 4326 reference
  # TODO: should this be wkt_point instead of rgeo_point?
  def containing_where_for_point_sql(rgeo_point)
    "ST_CoveredBy(
  ST_GeomFromText('#{rgeo_point}', 4326),
  #{GeographicItem::GEOMETRY_SQL.to_sql}
 )"
  end

  # @param [Interger] geographic_item_id
  # @return [String] SQL for geometries
  # example, not used
  def geometry_for_sql(geographic_item_id)
    'SELECT ' + GeographicItem::GEOMETRY_SQL.to_sql + ' AS geometry FROM geographic_items WHERE id = ' \
      "#{geographic_item_id} LIMIT 1"
  end

  # @param [Interger, Array of Integer] geographic_item_ids
  # @return [String] SQL for geometries
  # example, not used
  def geometry_for_collection_sql(*geographic_item_ids)
    'SELECT ' + GeographicItem::GEOMETRY_SQL.to_sql + ' AS geometry FROM geographic_items WHERE id IN ' \
      "( #{geographic_item_ids.join(',')} )"
  end

  #
  # Scopes
  #

  # @param [Interger, Array of Integer] geographic_item_ids
  # @return [Scope]
  #    the geographic items containing these collective geographic_item ids, not including self
  def containing(*geographic_item_ids)
    where(GeographicItem.containing_where_sql(geographic_item_ids)).not_ids(*geographic_item_ids)
  end

  # @param [Interger, Array of Integer] geographic_item_ids
  # @return [Scope]
  #    the geographic items contained by any of these geographic_item ids, not including self
  # (works via ST_ContainsProperly)
  def contained_by(*geographic_item_ids)
    where(GeographicItem.contained_by_where_sql(geographic_item_ids))
  end

  # @param [RGeo::Point] rgeo_point
  # @return [Scope]
  #    the geographic items containing this point
  # TODO: should be containing_wkt ?
  def containing_point(rgeo_point)
    where(GeographicItem.containing_where_for_point_sql(rgeo_point))
  end

  # @return [Scope]
  #   adds an area_in_meters field, with meters
  def with_area
    select("ST_Area(#{GeographicItem::GEOGRAPHY_SQL}, false) as area_in_meters")
  end

  # return [Scope]
  #   A scope that limits the result to those GeographicItems that have a collecting event
  #   through either the geographic_item or the error_geographic_item
  #
  # A raw SQL join approach for comparison
  #
  # GeographicItem.joins('LEFT JOIN georeferences g1 ON geographic_items.id = g1.geographic_item_id').
  #   joins('LEFT JOIN georeferences g2 ON geographic_items.id = g2.error_geographic_item_id').
  #   where("(g1.geographic_item_id IS NOT NULL OR g2.error_geographic_item_id IS NOT NULL)").uniq

  # @return [Scope] GeographicItem
  # This uses an Arel table approach, this is ultimately more decomposable if we need. Of use:
  #  http://danshultz.github.io/talks/mastering_activerecord_arel  <- best
  #  https://github.com/rails/arel
  #  http://stackoverflow.com/questions/4500629/use-arel-for-a-nested-set-join-query-and-convert-to-activerecordrelation
  #  http://rdoc.info/github/rails/arel/Arel/SelectManager
  #  http://stackoverflow.com/questions/7976358/activerecord-arel-or-condition
  #
  def with_collecting_event_through_georeferences
    geographic_items = GeographicItem.arel_table
    georeferences = Georeference.arel_table
    g1 = georeferences.alias('a')
    g2 = georeferences.alias('b')

    c = geographic_items.join(g1, Arel::Nodes::OuterJoin).on(geographic_items[:id].eq(g1[:geographic_item_id]))
      .join(g2, Arel::Nodes::OuterJoin).on(geographic_items[:id].eq(g2[:error_geographic_item_id]))

    GeographicItem.joins(# turn the Arel back into scope
                         c.join_sources # translate the Arel join to a join hash(?)
                        ).where(
                          g1[:id].not_eq(nil).or(g2[:id].not_eq(nil)) # returns a Arel::Nodes::Grouping
                        ).distinct
  end

  # @return [Scope] include a 'latitude' column
  def with_latitude
    select(lat_long_sql(:latitude))
  end

  # @return [Scope] include a 'longitude' column
  def with_longitude
    select(lat_long_sql(:longitude))
  end

  # @param [String, GeographicItems]
  # @return [Scope]
  def intersecting(column_name, *geographic_items)
    if column_name.downcase == 'any'
      pieces = []
      DATA_TYPES.each { |column|
        pieces.push(GeographicItem.intersecting(column.to_s, geographic_items).to_a)
      }

      # @TODO change 'id in (?)' to some other sql construct

      GeographicItem.where(id: pieces.flatten.map(&:id))
    else
      q = geographic_items.flatten.collect { |geographic_item|
        "ST_Intersects(#{column_name}, '#{geographic_item.geo_object}'    )" # seems like we want this: http://danshultz.github.io/talks/mastering_activerecord_arel/#/15/2
      }.join(' or ')

      where(q)
    end
  end

  # @param [GeographicItem#id] geographic_item_id
  # @param [Float] distance in meters ?!?!
  # @return [ActiveRecord::Relation]
  # !! should be distance, not radius?!
  def within_radius_of_item(geographic_item_id, distance)
    where(within_radius_of_item_sql(geographic_item_id, distance))
  end

  # @param [String, GeographicItem]
  # @return [Scope]
  #   a SQL fragment for ST_DISJOINT, specifies all geographic_items that have data in column_name
  #   that are disjoint from the passed geographic_items
  def disjoint_from(column_name, *geographic_items)
    q = geographic_items.flatten.collect { |geographic_item|
      "ST_DISJOINT(#{column_name}::geometry, (#{geometry_sql(geographic_item.to_param,
                                                         geographic_item.geo_object_type)}))"
    }.join(' and ')

    where(q)
  end

  # @return [Scope]
  #   see are_contained_in_item_by_id
  # @param [String] column_name
  # @param [GeographicItem, Array] geographic_items
  def are_contained_in_item(column_name, *geographic_items)
    are_contained_in_item_by_id(column_name, geographic_items.flatten.map(&:id))
  end

  # rubocop:disable Metrics/MethodLength
  # @param [String] column_name to search
  # @param [GeographicItem] geographic_item_ids or array of geographic_item_ids to be tested.
  # @return [Scope] of GeographicItems
  #
  # If this scope is given an Array of GeographicItems as a second parameter,
  # it will return the 'OR' of each of the objects against the table.
  # SELECT COUNT(*) FROM "geographic_items"
  #        WHERE (ST_Contains(polygon::geometry, GeomFromEWKT('srid=4326;POINT (0.0 0.0 0.0)'))
  #               OR ST_Contains(polygon::geometry, GeomFromEWKT('srid=4326;POINT (-9.8 5.0 0.0)')))
  #
  def are_contained_in_item_by_id(column_name, *geographic_item_ids) # = containing
    geographic_item_ids.flatten! # in case there is a array of arrays, or multiple objects
    column_name.downcase!
    case column_name
    when 'any'
      part = []
      DATA_TYPES.each { |column|
        unless column == :geometry_collection
          part.push(GeographicItem.are_contained_in_item_by_id(column.to_s, geographic_item_ids).to_a)
        end
      }
      # TODO: change 'id in (?)' to some other sql construct
      GeographicItem.where(id: part.flatten.map(&:id))
    when 'any_poly', 'any_line'
      part = []
      DATA_TYPES.each { |column|
        if column.to_s.index(column_name.gsub('any_', ''))
          part.push(GeographicItem.are_contained_in_item_by_id("#{column}", geographic_item_ids).to_a)
        end
      }
      # TODO: change 'id in (?)' to some other sql construct
      GeographicItem.where(id: part.flatten.map(&:id))
    else
      q = geographic_item_ids.flatten.collect { |geographic_item_id|
        # discover the item types, and convert type to database type for 'multi_'
        b = GeographicItem.where(id: geographic_item_id)
          .pluck(:type)[0].split(':')[2].downcase.gsub('lti', 'lti_')
        # a = GeographicItem.find(geographic_item_id).geo_object_type
        GeographicItem.containing_sql(column_name, geographic_item_id, b)
      }.join(' or ')
      q = 'FALSE' if q.blank? # this will prevent the invocation of *ALL* of the GeographicItems, if there are
      # no GeographicItems in the request (see CollectingEvent.name_hash(types)).
      where(q) # .not_including(geographic_items)
    end
  end

  # rubocop:enable Metrics/MethodLength

  # @param [String] column_name
  # @param [String] geometry of WKT
  # @return [Scope]
  # a single WKT geometry is compared against column or columns (except geometry_collection) to find geographic_items
  # which are contained in the WKT
  def are_contained_in_wkt(column_name, geometry)
    column_name.downcase!
    # column_name = 'point'
    case column_name
    when 'any'
      part = []
      DATA_TYPES.each { |column|
        unless column == :geometry_collection
          part.push(GeographicItem.are_contained_in_wkt(column.to_s, geometry).pluck(:id).to_a)
        end
      }
      # TODO: change 'id in (?)' to some other sql construct
      GeographicItem.where(id: part.flatten)
    when 'any_poly', 'any_line'
      part = []
      DATA_TYPES.each { |column|
        if column.to_s.index(column_name.gsub('any_', ''))
          part.push(GeographicItem.are_contained_in_wkt("#{column}", geometry).pluck(:id).to_a)
        end
      }
      # TODO: change 'id in (?)' to some other sql construct
      GeographicItem.where(id: part.flatten)
    else
      # column = points, geometry = square
      q = "ST_Contains(ST_GeomFromEWKT('srid=4326;#{geometry}'), #{column_name}::geometry)"
      where(q) # .not_including(geographic_items)
    end
  end

  # rubocop:disable Metrics/MethodLength
  #    containing the items the shape of which is contained in the geographic_item[s] supplied.
  # @param column_name [String] can be any of DATA_TYPES, or 'any' to check against all types, 'any_poly' to check
  # against 'polygon' or 'multi_polygon', or 'any_line' to check against 'line_string' or 'multi_line_string'.
  #  CANNOT be 'geometry_collection'.
  # @param geographic_items [GeographicItem] Can be a single GeographicItem, or an array of GeographicItem.
  # @return [Scope]
  def is_contained_by(column_name, *geographic_items)
    column_name.downcase!
    case column_name
    when 'any'
      part = []
      DATA_TYPES.each { |column|
        unless column == :geometry_collection
          part.push(GeographicItem.is_contained_by(column.to_s, geographic_items).to_a)
        end
      }
      # @TODO change 'id in (?)' to some other sql construct
      GeographicItem.where(id: part.flatten.map(&:id))

    when 'any_poly', 'any_line'
      part = []
      DATA_TYPES.each { |column|
        unless column == :geometry_collection
          if column.to_s.index(column_name.gsub('any_', ''))
            part.push(GeographicItem.is_contained_by(column.to_s, geographic_items).to_a)
          end
        end
      }
      # @TODO change 'id in (?)' to some other sql construct
      GeographicItem.where(id: part.flatten.map(&:id))

    else
      q = geographic_items.flatten.collect { |geographic_item|
        GeographicItem.reverse_containing_sql(column_name, geographic_item.to_param,
                                              geographic_item.geo_object_type)
      }.join(' or ')
      where(q) # .not_including(geographic_items)
    end
  end

  # rubocop:enable Metrics/MethodLength

  # @param [String, GeographicItem]
  # @return [Scope]
  def ordered_by_shortest_distance_from(column_name, geographic_item)
    if true # check_geo_params(column_name, geographic_item)
      select_distance_with_geo_object(column_name, geographic_item)
        .where_distance_greater_than_zero(column_name, geographic_item).order('distance')
    else
      where('false')
    end
  end

  # @param [String, GeographicItem]
  # @return [Scope]
  def ordered_by_longest_distance_from(column_name, geographic_item)
    if true # check_geo_params(column_name, geographic_item)
      q = select_distance_with_geo_object(column_name, geographic_item)
        .where_distance_greater_than_zero(column_name, geographic_item)
        .order('distance desc')
      q
    else
      where('false')
    end
  end

  # @param [String] column_name
  # @param [GeographicItem] geographic_item
  # @return [String]
  def select_distance_with_geo_object(column_name, geographic_item)
    select("*, ST_Distance(#{column_name}, GeomFromEWKT('srid=4326;#{geographic_item.geo_object}')) as distance")
  end

  # @param [String, GeographicItem]
  # @return [Scope]
  def where_distance_greater_than_zero(column_name, geographic_item)
    where("#{column_name} is not null and ST_Distance(#{column_name}, " \
          "GeomFromEWKT('srid=4326;#{geographic_item.geo_object}')) > 0")
  end

  # @param [GeographicItem]
  # @return [Scope]
  def not_including(geographic_items)
    where.not(id: geographic_items)
  end

  # @return [Scope]
  #   includes an 'is_valid' attribute (True/False) for the passed geographic_item.  Uses St_IsValid.
  # @param [RGeo object] geographic_item
  def with_is_valid_geometry_column(geographic_item)
    where(id: geographic_item.id).select("ST_IsValid(ST_AsBinary(#{geographic_item.geo_object_type})) is_valid")
  end

  #
  # Other
  #

  # @param [Integer] geographic_item_id1
  # @param [Integer] geographic_item_id2
  # @return [Float]
  def distance_between(geographic_item_id1, geographic_item_id2)
    q1 = "ST_Distance(#{GeographicItem::GEOGRAPHY_SQL}, " \
      "(#{select_geography_sql(geographic_item_id2)})) as distance"
    _q2 = ActiveRecord::Base.send(
      :sanitize_sql_array, ['ST_Distance(?, (?)) as distance',
                            GeographicItem::GEOGRAPHY_SQL,
                            select_geography_sql(geographic_item_id2)])
    GeographicItem.where(id: geographic_item_id1).pluck(Arel.sql(q1)).first
  end

  # @param [RGeo::Point] point
  # @return [Hash]
  #   as per #inferred_geographic_name_hierarchy but for Rgeo point
  def point_inferred_geographic_name_hierarchy(point)
    GeographicItem.containing_point(point).order(cached_total_area: :ASC).limit(1).first&.inferred_geographic_name_hierarchy
  end

  # @param [String] type_name ('polygon', 'point', 'line' [, 'circle'])
  # @return [String] if type
  def eval_for_type(type_name)
    retval = 'GeographicItem'
    case type_name.upcase
    when 'POLYGON'
      retval += '::Polygon'
    when 'LINESTRING'
      retval += '::LineString'
    when 'POINT'
      retval += '::Point'
    when 'MULTIPOLYGON'
      retval += '::MultiPolygon'
    when 'MULTILINESTRING'
      retval += '::MultiLineString'
    when 'MULTIPOINT'
      retval += '::MultiPoint'
    else
      retval = nil
    end
    retval
  end

  # example, not used
  # @param [Integer] geographic_item_id
  # @return [RGeo::Geographic object]
  def geometry_for(geographic_item_id)
    GeographicItem.select(GeographicItem::GEOMETRY_SQL.to_sql + ' AS geometry').find(geographic_item_id)['geometry']
  end

  # example, not used
  # @param [Integer, Array] geographic_item_ids
  # @return [Scope]
  def st_multi(*geographic_item_ids)
    GeographicItem.find_by_sql(
      "SELECT ST_Multi(ST_Collect(g.the_geom)) AS singlegeom
 FROM (
    SELECT (ST_DUMP(#{GeographicItem::GEOMETRY_SQL.to_sql})).geom AS the_geom
    FROM geographic_items
    WHERE id IN (?))
  AS g;", geographic_item_ids.flatten
    )
  end
end # class << self

# @return [Hash]
#    a geographic_name_classification or empty Hash
# This is a quick approach that works only when
# the geographic_item is linked explicitly to a GeographicArea.
#
# !! Note that it is not impossible for a GeographicItem to be linked
# to > 1 GeographicArea, in that case we are assuming that all are
# equally refined, this might not be the case in the future because
# of how the GeographicArea gazetteer is indexed.
def quick_geographic_name_hierarchy
  geographic_areas.order(:id).each do |ga|
    h = ga.geographic_name_classification # not quick enough !!
    return h if h.present?
  end
  return  {}
end

# @return [Hash]
#   a geographic_name_classification (see GeographicArea) inferred by
# finding the smallest area containing this GeographicItem, in the most accurate gazetteer
# and using it to return country/state/county. See also the logic in
# filling in missing levels in GeographicArea.
def inferred_geographic_name_hierarchy
  if small_area = containing_geographic_areas
    .joins(:geographic_areas_geographic_items)
    .merge(GeographicAreasGeographicItem.ordered_by_data_origin)
    .ordered_by_area
    .limit(1)
    .first
  return small_area.geographic_name_classification
  else
    {}
  end
end

def geographic_name_hierarchy
  a = quick_geographic_name_hierarchy # quick; almost never the case, UI not setup to do this
  return a if a.present?
  inferred_geographic_name_hierarchy # slow
end

# @return [Scope]
#   the Geographic Areas that contain (gis) this geographic item
def containing_geographic_areas
  GeographicArea.joins(:geographic_items).includes(:geographic_area_type)
    .joins("JOIN (#{GeographicItem.containing(id).to_sql}) j on geographic_items.id = j.id")
end

# @return [Boolean]
#   whether stored shape is ST_IsValid
def valid_geometry?
  GeographicItem.with_is_valid_geometry_column(self).first['is_valid']
end

# @return [Array of latitude, longitude]
#    the lat, lon of the first point in the GeoItem, see subclass for #st_start_point
def start_point
  o = st_start_point
  [o.y, o.x]
end

# @return [Array]
#   the lat, long, as STRINGs for the centroid of this geographic item
#   Meh- this: https://postgis.net/docs/en/ST_MinimumBoundingRadius.html
def center_coords
  r = GeographicItem.find_by_sql(
    "Select split_part(ST_AsLatLonText(ST_Centroid(#{GeographicItem::GEOMETRY_SQL.to_sql}), " \
    "'D.DDDDDD'), ' ', 1) latitude, split_part(ST_AsLatLonText(ST_Centroid" \
    "(#{GeographicItem::GEOMETRY_SQL.to_sql}), 'D.DDDDDD'), ' ', 2) " \
    "longitude from geographic_items where id = #{id};")[0]

  [r.latitude, r.longitude]
end

# @return [RGeo::Geographic::ProjectedPointImpl]
#    representing the centroid of this geographic item
def centroid
  # Gis::FACTORY.point(*center_coords.reverse)
  return geo_object if type == 'GeographicItem::Point'
  return Gis::FACTORY.parse_wkt(self.st_centroid)
end

# @param [Integer] geographic_item_id
# @return [Double] distance in meters (slower, more accurate)
def st_distance(geographic_item_id) # geo_object
  q1 = "ST_Distance((#{GeographicItem.select_geography_sql(id)}), " \
    "(#{GeographicItem.select_geography_sql(geographic_item_id)})) as d"
  _q2 = ActiveRecord::Base.send(:sanitize_sql_array, ['ST_Distance((?),(?)) as d',
                                                      GeographicItem.select_geography_sql(self.id),
                                                      GeographicItem.select_geography_sql(geographic_item_id)])
  deg = GeographicItem.where(id:).pluck(Arel.sql(q1)).first
  deg * Utilities::Geo::ONE_WEST
end

# @param [GeographicItem] geographic_item
# @return [Double] distance in meters
# Like st_distance but works with changed and non persisted objects
def st_distance_to_geographic_item(geographic_item)
  unless !persisted? || changed?
    a = "(#{GeographicItem.select_geography_sql(id)})"
  else
    a = "ST_GeographyFromText('#{geo_object}')"
  end

  unless !geographic_item.persisted? || geographic_item.changed?
    b = "(#{GeographicItem.select_geography_sql(geographic_item.id)})"
  else
    b = "ST_GeographyFromText('#{geographic_item.geo_object}')"
  end

  ActiveRecord::Base.connection.select_value("SELECT ST_Distance(#{a}, #{b})")
end

alias_method :distance_to, :st_distance

# @param [Integer] geographic_item_id
# @return [Double] distance in meters (faster, less accurate)
def st_distance_spheroid(geographic_item_id)
  q1 = "ST_DistanceSpheroid((#{GeographicItem.select_geometry_sql(id)})," \
    "(#{GeographicItem.select_geometry_sql(geographic_item_id)}),'#{Gis::SPHEROID}') as distance"
  _q2 = ActiveRecord::Base.send(:sanitize_sql_array,
                                ['ST_DistanceSpheroid((?),(?),?) as distance',
                                 GeographicItem.select_geometry_sql(id),
                                 GeographicItem.select_geometry_sql(geographic_item_id),
                                 Gis::SPHEROID])
  # TODO: what is _q2?
  GeographicItem.where(id:).pluck(Arel.sql(q1)).first
end

# @return [String]
#   a WKT POINT representing the centroid of the geographic item
def st_centroid
  GeographicItem.where(id: to_param).pluck(Arel.sql("ST_AsEWKT(ST_Centroid(#{GeographicItem::GEOMETRY_SQL.to_sql}))")).first.gsub(/SRID=\d*;/, '')
end

# @return [Integer]
#   the number of points in the geometry
def st_npoints
  GeographicItem.where(id:).pluck(Arel.sql("ST_NPoints(#{GeographicItem::GEOMETRY_SQL.to_sql}) as npoints")).first
end

# @return [Symbol]
#   the geo type (i.e. column like :point, :multipolygon).  References the first-found object,
# according to the list of DATA_TYPES, or nil
def geo_object_type
  if self.class.name == 'GeographicItem' # a proxy check for new records
    geo_type
  else
    self.class::SHAPE_COLUMN
  end
end

# !!TODO: migrate these to use native column calls

# @return [RGeo instance, nil]
#  the Rgeo shape (See http://rubydoc.info/github/dazuma/rgeo/RGeo/Feature)
def geo_object
  begin
    if r = geo_object_type # rubocop:disable Lint/AssignmentInCondition
      send(r)
    else
      false
    end
  rescue RGeo::Error::InvalidGeometry
    return nil # TODO: we need to render proper error for this!
  end
end

# @param [geo_object]
# @return [Boolean]
def contains?(target_geo_object)
  return nil if target_geo_object.nil?
  self.geo_object.contains?(target_geo_object)
end

# @param [geo_object]
# @return [Boolean]
def within?(target_geo_object)
  self.geo_object.within?(target_geo_object)
end

# @param [geo_object]
# @return [Boolean]
def intersects?(target_geo_object)
  self.geo_object.intersects?(target_geo_object)
end

# @param [geo_object, Double]
# @return [Boolean]
def near(target_geo_object, distance)
  self.geo_object.unsafe_buffer(distance).contains?(target_geo_object)
end

# @param [geo_object, Double]
# @return [Boolean]
def far(target_geo_object, distance)
  !near(target_geo_object, distance)
end

# @return [GeoJSON hash]
#    via Rgeo apparently necessary for GeometryCollection
def rgeo_to_geo_json
  RGeo::GeoJSON.encode(geo_object).to_json
end

# @return [Hash]
#   in GeoJSON format
#   Computed via "raw" PostGIS (much faster). This
#   requires the geo_object_type and id.
#
def to_geo_json
  JSON.parse(
    GeographicItem.connection.select_one(
      "SELECT ST_AsGeoJSON(#{geo_object_type}::geometry) a " \
      "FROM geographic_items WHERE id=#{id};")['a'])
end

# We don't need to serialize to/from JSON
def to_geo_json_string
  GeographicItem.connection.select_one(
    "SELECT ST_AsGeoJSON(#{geo_object_type}::geometry) a " \
    "FROM geographic_items WHERE id=#{id};")['a']
end

# @return [Hash]
#   the shape as a GeoJSON Feature with some item metadata
def to_geo_json_feature
  @geometry ||= to_geo_json
  {'type' => 'Feature',
   'geometry' => geometry,
   'properties' => {
     'geographic_item' => {
       'id' => id}
   }
  }
end

# @param value [String] like:
#   '{"type":"Feature","geometry":{"type":"Point","coordinates":[2.5,4.0]},"properties":{"color":"red"}}'
#
#   '{"type":"Feature","geometry":{"type":"Polygon","coordinates":"[[[-125.29394388198853, 48.584480409793],
#      [-67.11035013198853, 45.09937589848195],[-80.64550638198853, 25.01924647619111],[-117.55956888198853,
#      32.5591595028449],[-125.29394388198853, 48.584480409793]]]"},"properties":{}}'
#
#  '{"type":"Point","coordinates":[2.5,4.0]},"properties":{"color":"red"}}'
#
# @return [Boolean, RGeo object]
def shape=(value)

  if value.present?
    geom = RGeo::GeoJSON.decode(value, json_parser: :json, geo_factory: Gis::FACTORY)
    this_type = nil

    if geom.respond_to?(:geometry_type)
      this_type = geom.geometry_type.to_s
    elsif geom.respond_to?(:geometry)
      this_type = geom.geometry.geometry_type.to_s
    else
    end

    self.type = GeographicItem.eval_for_type(this_type) unless geom.nil?

    if type.blank?
      errors.add(:base, 'type is not set from shape')
      return
    end
    # raise('GeographicItem.type not set.') if type.blank?

    object = nil

    s = geom.respond_to?(:geometry) ? geom.geometry.to_s : geom.to_s

    begin
      object = Gis::FACTORY.parse_wkt(s)
    rescue RGeo::Error::InvalidGeometry
      errors.add(:self, 'Shape value is an Invalid Geometry')
    end

    write_attribute(this_type.underscore.to_sym, object)
    geom
  end
end

# @return [String]
def to_wkt
  #  10k  #<Benchmark::Tms:0x00007fb0dfd30fd0 @label="", @real=25.237487000005785, @cstime=0.0, @cutime=0.0, @stime=1.1704609999999995, @utime=5.507929999999988, @total=6.678390999999987>
  #  GeographicItem.select("ST_AsText( #{GeographicItem::GEOMETRY_SQL.to_sql}) wkt").where(id: id).first.wkt

  # 10k <Benchmark::Tms:0x00007fb0e02f7540 @label="", @real=21.619827999995323, @cstime=0.0, @cutime=0.0, @stime=0.8850890000000007, @utime=3.2958549999999605, @total=4.180943999999961>
  if a =  ApplicationRecord.connection.execute( "SELECT ST_AsText( #{GeographicItem::GEOMETRY_SQL.to_sql} ) wkt from geographic_items where geographic_items.id = #{id}").first
    return a['wkt']
  else
    return nil
  end
end

# @return  [Float] in meters, calculated
# TODO: share with world
#    Geographic item 96862 (Cajamar in Brazil) is the only(?) record to fail using `false` (quicker) method of everything we tested
def area
  a = GeographicItem.where(id:).select("ST_Area(#{GeographicItem::GEOGRAPHY_SQL}, true) as area_in_meters").first['area_in_meters']
  a = nil if a.nan?
  a
end

# @return [Float, false]
#    the value in square meters of the interesecting area of this and another GeographicItem
def intersecting_area(geographic_item_id)
  a = GeographicItem.aliased_geographic_sql('a')
  b = GeographicItem.aliased_geographic_sql('b')

  c = GeographicItem.connection.execute(
    "SELECT ST_Area(ST_Intersection(#{a}, #{b})) as intersecting_area
      FROM geographic_items a, geographic_items b
      WHERE a.id = #{id} AND b.id = #{geographic_item_id};"
  ).first
  c && c['intersecting_area'].to_f
end

# TODO: This is bad, while internal use of ONE_WEST_MEAN is consistent it is in-accurate given the vast differences of radius vs. lat/long position.
# When we strike the error-polygon from radius we should remove this
#
# Use case is returning the radius from a circle we calculated via buffer for error-polygon creation.
def radius
  r = ApplicationRecord.connection.execute( "SELECT ST_MinimumBoundingRadius( ST_Transform(  #{GeographicItem::GEOMETRY_SQL.to_sql}, 4326 )  ) AS radius from geographic_items where geographic_items.id = #{id}").first['radius'].split(',').last.chop.to_f
  r = (r * Utilities::Geo::ONE_WEST_MEAN).to_i
end


# Convention is to store in PostGIS in CCW
# @return Array [Boolean]
#   false - cw
#   true - ccw (preferred), except cee donuts
def orientations
  if multi_polygon.present?
    ApplicationRecord.connection.execute(" \
         SELECT ST_IsPolygonCCW(a.geom) as is_ccw
            FROM ( SELECT b.id, (ST_Dump(p_geom)).geom AS geom
               FROM (SELECT id, multi_polygon::geometry AS p_geom FROM geographic_items where id = #{id}) AS b \
          ) AS a;").collect{|a| a['is_ccw']}
  elsif polygon.present?
    ApplicationRecord.connection.execute("SELECT ST_IsPolygonCCW(polygon::geometry) as is_ccw \
            FROM geographic_items where  id = #{id};").collect{|a| a['is_ccw']}
  else
    []
  end
end

# @return Boolean
#   looks at all orientations
#   if they follow the pattern [true, false, ... <all false>] then `true`, else `false`
# !! Does not confirm that shapes are nested !!
def is_basic_donut?
  a = orientations
  b = a.shift
  return false unless b
  a.uniq!
  a == [false]
end

def st_isvalid
  r = ApplicationRecord.connection.execute( "SELECT ST_IsValid(  #{GeographicItem::GEOMETRY_SQL.to_sql }) from  geographic_items where geographic_items.id = #{id}").first['st_isvalid']
end

def st_isvalidreason
  r = ApplicationRecord.connection.execute( "SELECT ST_IsValidReason(  #{GeographicItem::GEOMETRY_SQL.to_sql }) from  geographic_items where geographic_items.id = #{id}").first['st_isvalidreason']
end

# !! Unused. Doesn't check Geometry collection
def has_polygons?
  ['GeographicItem::MultiPolygon', 'GeographicItem::Polygon'].include?(self.type)
end

private

def align_winding
  if orientations.flatten.include?(false)
    case type
    when 'multi_polygon'
      ApplicationRecord.connection.execute(
        "UPDATE geographic_items set multi_polygon = ST_ForcePolygonCCW(multi_polygon::geometry) 
          WHERE id = #{self.id};"
       )
    when 'polygon'
     ApplicationRecord.connection.execute(
        "UPDATE geographic_items set polygon = ST_ForcePolygonCCW(polygon::geometry) 
          WHERE id = #{self.id};"
       )
    end     
  end
  true
end

# Crude debuging helper, write the shapes
# to a png
def self.debug_draw(geographic_item_ids = [])
  return false if geographic_item_ids.empty?

  sql = "SELECT ST_AsPNG(
     ST_AsRaster(
        (SELECT ST_Union(multi_polygon::geometry) from geographic_items where id IN (" + geographic_item_ids.join(',') + ")), 1920, 1080
    )
   ) png;"

  # ST_Buffer( multi_polygon::geometry, 0, 'join=bevel'),
  #     1920,
  #     1080)


  result = ActiveRecord::Base.connection.execute(sql).first['png']
  r = ActiveRecord::Base.connection.unescape_bytea(result)

  prefix = if geographic_item_ids.size > 10
             'multiple'
           else
             geographic_item_ids.join('_') + '_debug.draw.png'
           end

  n = prefix + '_debug.draw.png'

  # Open the file in binary write mode ("wb")
  File.open(n, 'wb') do |file|
    # Write the binary data to the file
    file.write(r)
  end
end

# def png

#   if ids = Otu.joins(:cached_map_items).first.cached_map_items.pluck(:geographic_item_id)

#     sql = "SELECT ST_AsPNG(
#    ST_AsRaster(
#        ST_Buffer( multi_polygon::geometry, 0, 'join=bevel'),
#            1024,
#            768)
#     ) png
#        from geographic_items where id IN (" + ids.join(',') + ');'

#     # hack, not the best way to unpack result
#     result = ActiveRecord::Base.connection.execute(sql).first['png']
#     r = ActiveRecord::Base.connection.unescape_bytea(result)

#     send_data r, filename: 'foo.png', type: 'imnage/png'

#   else
#     render json: {foo: false}
#   end
# end

def set_cached
  update_column(:cached_total_area, area)
end

# @return [Symbol]
#   returns the attribute (column name) containing data
#   nearly all methods should use #geo_object_type, not geo_type
def geo_type
  DATA_TYPES.each { |item|
    return item if send(item)
  }
  nil
end

# @return [Boolean, String] false if already set, or type to which it was set
def set_type_if_geography_present
  if type.blank?
    column = geo_type
    self.type = "GeographicItem::#{column.to_s.camelize}" if column
  end
end

# @param [RGeo::Point] point
# @return [Array] of a point
#   Longitude |, Latitude -
def point_to_a(point)
  data = []
  data.push(point.x, point.y)
  data
end

# @param [RGeo::Point] point
# @return [Hash] of a point
def point_to_hash(point)
  {points: [point_to_a(point)]}
end

# @param [RGeo::MultiPoint] multi_point
# @return [Array] of points
def multi_point_to_a(multi_point)
  data = []
  multi_point.each { |point|
    data.push([point.x, point.y])
  }
  data
end

# @return [Hash] of points
def multi_point_to_hash(_multi_point)
  # when we encounter a multi_point type, we only stick the points into the array, NOT it's identity as a group
  {points: multi_point_to_a(multi_point)}
end

# @param [Reo::LineString] line_string
# @return [Array] of points in the line
def line_string_to_a(line_string)
  data = []
  line_string.points.each { |point|
    data.push([point.x, point.y])
  }
  data
end

# @param [Reo::LineString] line_string
# @return [Hash] of points in the line
def line_string_to_hash(line_string)
  {lines: [line_string_to_a(line_string)]}
end

# @param [RGeo::Polygon] polygon
# @return [Array] of points in the polygon (exterior_ring ONLY)
def polygon_to_a(polygon)
  # TODO: handle other parts of the polygon; i.e., the interior_rings (if they exist)
  data = []
  polygon.exterior_ring.points.each { |point|
    data.push([point.x, point.y])
  }
  data
end

# @param [RGeo::Polygon] polygon
# @return [Hash] of points in the polygon (exterior_ring ONLY)
def polygon_to_hash(polygon)
  {polygons: [polygon_to_a(polygon)]}
end

# @return [Array] of line_strings as arrays of points
# @param [RGeo::MultiLineString] multi_line_string
def multi_line_string_to_a(multi_line_string)
  data = []
  multi_line_string.each { |line_string|
    line_data = []
    line_string.points.each { |point|
      line_data.push([point.x, point.y])
    }
    data.push(line_data)
  }
  data
end

# @return [Hash] of line_strings as hashes of points
def multi_line_string_to_hash(_multi_line_string)
  {lines: to_a}
end

# @param [RGeo::MultiPolygon] multi_polygon
# @return [Array] of arrays of points in the polygons (exterior_ring ONLY)
def multi_polygon_to_a(multi_polygon)
  data = []
  multi_polygon.each { |polygon|
    polygon_data = []
    polygon.exterior_ring.points.each { |point|
      polygon_data.push([point.x, point.y])
    }
    data.push(polygon_data)
  }
  data
end

# @return [Hash] of hashes of points in the polygons (exterior_ring ONLY)
def multi_polygon_to_hash(_multi_polygon)
  {polygons: to_a}
end

# @return [Boolean] iff there is one and only one shape column set
def some_data_is_provided
  data = []

  DATA_TYPES.each do |item|
    data.push(item) if send(item).present?
  end

  case data.count
  when 0
    errors.add(:base, 'No shape provided or provided shape is invalid')
  when 1
    return true
  else
    data.each do |object|
      errors.add(object, 'More than one shape type provided')
    end
  end
  true
end
end

#shape ⇒ `Boolean`, `RGeo object`

TODO: WHY! boolean not nil, or object Used to build geographic items from a shape [ of what class ] !?

Returns:

(Boolean, RGeo object)



55
56
57

# File 'app/models/geographic_item.rb', line 55

def shape
  @shape
end

#type ⇒ `String`

Returns Rails STI, determines the geography column as well.

Returns:

(String) —

Rails STI, determines the geography column as well

# File 'app/models/geographic_item.rb', line 40

class GeographicItem < ApplicationRecord
  include Housekeeping::Users
  include Housekeeping::Timestamps
  include Shared::HasPapertrail
  include Shared::IsData
  include Shared::SharedAcrossProjects

  # @return [Hash, nil]
  #   An internal variable for use in super calls, holds a Hash in GeoJSON format (temporarily)
  attr_accessor :geometry

  # @return [Boolean, RGeo object]
  # @params value [Hash in GeoJSON format] ?!
  # TODO: WHY! boolean not nil, or object
  # Used to build geographic items from a shape [ of what class ] !?
  attr_accessor :shape

  # @return [Boolean]
  #   When true cached values are not built
  attr_accessor :no_cached

  DATA_TYPES = [
:point,
:line_string,
:polygon,
:multi_point,
:multi_line_string,
:multi_polygon,
:geometry_collection
  ].freeze

  GEOMETRY_SQL = Arel::Nodes::Case.new(arel_table[:type])
.when('GeographicItem::MultiPolygon').then(Arel::Nodes::NamedFunction.new('CAST', [arel_table[:multi_polygon].as('geometry')]))
.when('GeographicItem::Point').then(Arel::Nodes::NamedFunction.new('CAST', [arel_table[:point].as('geometry')]))
.when('GeographicItem::LineString').then(Arel::Nodes::NamedFunction.new('CAST', [arel_table[:line_string].as('geometry')]))
.when('GeographicItem::Polygon').then(Arel::Nodes::NamedFunction.new('CAST', [arel_table[:polygon].as('geometry')]))
.when('GeographicItem::MultiLineString').then(Arel::Nodes::NamedFunction.new('CAST', [arel_table[:multi_line_string].as('geometry')]))
.when('GeographicItem::MultiPoint').then(Arel::Nodes::NamedFunction.new('CAST', [arel_table[:multi_point].as('geometry')]))
.when('GeographicItem::GeometryCollection').then(Arel::Nodes::NamedFunction.new('CAST', [arel_table[:geometry_collection].as('geometry')]))
.freeze

  GEOGRAPHY_SQL = "CASE geographic_items.type
WHEN 'GeographicItem::MultiPolygon' THEN multi_polygon
WHEN 'GeographicItem::Point' THEN point
WHEN 'GeographicItem::LineString' THEN line_string
WHEN 'GeographicItem::Polygon' THEN polygon
WHEN 'GeographicItem::MultiLineString' THEN multi_line_string
WHEN 'GeographicItem::MultiPoint' THEN multi_point
WHEN 'GeographicItem::GeometryCollection' THEN geometry_collection
END".freeze

# ANTI_MERIDIAN = '0X0102000020E61000000200000000000000008066400000000000405640000000000080664000000000004056C0'
ANTI_MERIDIAN = 'LINESTRING (180 89.0, 180 -89)'.freeze

has_many :cached_map_items, inverse_of: :geographic_item

has_many :geographic_areas_geographic_items, dependent: :destroy, inverse_of: :geographic_item
has_many :geographic_areas, through: :geographic_areas_geographic_items
has_many :asserted_distributions, through: :geographic_areas
has_many :geographic_area_types, through: :geographic_areas
has_many :parent_geographic_areas, through: :geographic_areas, source: :parent

has_many :georeferences, inverse_of: :geographic_item
has_many :georeferences_through_error_geographic_item,
  class_name: 'Georeference', foreign_key: :error_geographic_item_id, inverse_of: :error_geographic_item
has_many :collecting_events_through_georeferences, through: :georeferences, source: :collecting_event
has_many :collecting_events_through_georeference_error_geographic_item,
  through: :georeferences_through_error_geographic_item, source: :collecting_event

# TODO: THIS IS NOT GOOD
before_validation :set_type_if_geography_present

validate :some_data_is_provided
validates :type, presence: true # not needed

scope :include_collecting_event, -> { includes(:collecting_events_through_georeferences) }
scope :geo_with_collecting_event, -> { joins(:collecting_events_through_georeferences) }
scope :err_with_collecting_event, -> { joins(:georeferences_through_error_geographic_item) }

after_save :set_cached, unless: Proc.new {|n| n.no_cached || errors.any? }
after_save :align_winding

class << self

  def aliased_geographic_sql(name = 'a')
    "CASE #{name}.type \
     WHEN 'GeographicItem::MultiPolygon' THEN #{name}.multi_polygon \
     WHEN 'GeographicItem::Point' THEN #{name}.point \
     WHEN 'GeographicItem::LineString' THEN #{name}.line_string \
     WHEN 'GeographicItem::Polygon' THEN #{name}.polygon \
     WHEN 'GeographicItem::MultiLineString' THEN #{name}.multi_line_string \
     WHEN 'GeographicItem::MultiPoint' THEN #{name}.multi_point \
     WHEN 'GeographicItem::GeometryCollection' THEN #{name}.geometry_collection \
     END"
  end

  def st_union(geographic_item_scope)
    GeographicItem.select("ST_Union(#{GeographicItem::GEOMETRY_SQL.to_sql}) as collection")
      .where(id: geographic_item_scope.pluck(:id))
  end

  def st_collect(geographic_item_scope)
    GeographicItem.select("ST_Collect(#{GeographicItem::GEOMETRY_SQL.to_sql}) as collection")
      .where(id: geographic_item_scope.pluck(:id))
  end

  # @return [GeographicItem::ActiveRecord_Relation]
  # @params [Array] array of geographic area ids
  def default_by_geographic_area_ids(geographic_area_ids = [])
    GeographicItem.
      joins(:geographic_areas_geographic_items).
      merge(::GeographicAreasGeographicItem.default_geographic_item_data).
      where(geographic_areas_geographic_items: {geographic_area_id: geographic_area_ids})
  end

  # @param [String] wkt
  # @return [Boolean]
  #   whether or not the wtk intersects with the anti-meridian
  #   !! StrongParams security considerations
  def crosses_anti_meridian?(wkt)
    GeographicItem.find_by_sql(
      ['SELECT ST_Intersects(ST_GeogFromText(?), ST_GeogFromText(?)) as r;', wkt, ANTI_MERIDIAN]
    ).first.r
  end

  # @param [Integer] ids
  # @return [Boolean]
  #   whether or not any GeographicItem passed intersects the anti-meridian
  #   !! StrongParams security considerations
  #   This is our first line of defense against queries that define multiple shapes, one or
  #   more of which crosses the anti-meridian.  In this case the current TW strategy within the
  #   UI is to abandon the search, and prompt the user to refactor the query.
  def crosses_anti_meridian_by_id?(*ids)
    q1 = ["SELECT ST_Intersects((SELECT single_geometry FROM (#{GeographicItem.single_geometry_sql(*ids)}) as " \
          'left_intersect), ST_GeogFromText(?)) as r;', ANTI_MERIDIAN]
    _q2 = ActiveRecord::Base.send(:sanitize_sql_array, ['SELECT ST_Intersects((SELECT single_geometry FROM (?) as ' \
                                                        'left_intersect), ST_GeogFromText(?)) as r;', GeographicItem.single_geometry_sql(*ids), ANTI_MERIDIAN])
    GeographicItem.find_by_sql(q1).first.r
  end

  #
  # SQL fragments
  #

  # @param [Integer, String]
  # @return [String]
  #   a SQL select statement that returns the *geometry* for the geographic_item with the specified id
  def select_geometry_sql(geographic_item_id)
    "SELECT #{GeographicItem::GEOMETRY_SQL.to_sql} from geographic_items where geographic_items.id = #{geographic_item_id}"
  end

  # @param [Integer, String]
  # @return [String]
  #   a SQL select statement that returns the geography for the geographic_item with the specified id
  def select_geography_sql(geographic_item_id)
    ActiveRecord::Base.send(:sanitize_sql_for_conditions, [
      "SELECT #{GeographicItem::GEOMETRY_SQL.to_sql} from geographic_items where geographic_items.id = ?",
      geographic_item_id])
  end

  # @param [Symbol] choice
  # @return [String]
  #   a fragment returning either latitude or longitude columns
  def lat_long_sql(choice)
    return nil unless [:latitude, :longitude].include?(choice)
    f = "'D.DDDDDD'" # TODO: probably a constant somewhere
    v = (choice == :latitude ? 1 : 2)
    "CASE geographic_items.type
  WHEN 'GeographicItem::GeometryCollection' THEN split_part(ST_AsLatLonText(ST_Centroid" \
  "(geometry_collection::geometry), #{f}), ' ', #{v})
  WHEN 'GeographicItem::LineString' THEN split_part(ST_AsLatLonText(ST_Centroid(line_string::geometry), " \
  "#{f}), ' ', #{v})
  WHEN 'GeographicItem::MultiPolygon' THEN split_part(ST_AsLatLonText(" \
  "ST_Centroid(multi_polygon::geometry), #{f}), ' ', #{v})
  WHEN 'GeographicItem::Point' THEN split_part(ST_AsLatLonText(" \
  "ST_Centroid(point::geometry), #{f}), ' ', #{v})
  WHEN 'GeographicItem::Polygon' THEN split_part(ST_AsLatLonText(" \
  "ST_Centroid(polygon::geometry), #{f}), ' ', #{v})
  WHEN 'GeographicItem::MultiLineString' THEN split_part(ST_AsLatLonText(" \
  "ST_Centroid(multi_line_string::geometry), #{f} ), ' ', #{v})
  WHEN 'GeographicItem::MultiPoint' THEN split_part(ST_AsLatLonText(" \
  "ST_Centroid(multi_point::geometry), #{f}), ' ', #{v})
END as #{choice}"
  end

  # @param [Integer] geographic_item_id
  # @param [Integer] distance
  # @return [String]
  def within_radius_of_item_sql(geographic_item_id, distance)
    "ST_DWithin((#{GeographicItem::GEOGRAPHY_SQL}), (#{select_geography_sql(geographic_item_id)}), #{distance})"
  end


  # @param [Integer] geographic_item_id
  # @param [Number] distance in meters to grow/shrink the shape (negative allowed)
  # @param [Number] distance (in meters) (positive only?!)
  # @return [String]
  def st_buffer_st_within(geographic_item_id, distance, buffer = 0)
    "ST_DWithin(
    ST_Buffer(#{GeographicItem::GEOGRAPHY_SQL}, #{buffer}),
    (#{select_geography_sql(geographic_item_id)}), #{distance}
   )"
  end


  # TODO: 3D is overkill here
  # @param [String] wkt
  # @param [Integer] distance (meters)
  # @return [String]
  # !! This is intersecting
  def intersecting_radius_of_wkt_sql(wkt, distance)
    "ST_DWithin((#{GeographicItem::GEOGRAPHY_SQL}), ST_Transform( ST_GeomFromText('#{wkt}', " \
      "4326), 4326), #{distance})"
  end

  # @param [String] wkt
  # @param [Integer] distance (meters)
  # @return [String]
  # !! This is fully covering
  def within_radius_of_wkt_sql(wkt, distance)
    "ST_Covers( ST_Buffer(ST_SetSRID( ST_GeomFromText('#{wkt}'), 4326)::geography, #{distance}), (#{GeographicItem::GEOGRAPHY_SQL}))"
  end

  # @param [String, Integer, String]
  # @return [String]
  #   a SQL fragment for ST_Contains() function, returns
  #   all geographic items which are contained in the item supplied
  def containing_sql(target_column_name = nil, geographic_item_id = nil, source_column_name = nil)
    return 'false' if geographic_item_id.nil? || source_column_name.nil? || target_column_name.nil?
    "ST_Contains(#{target_column_name}::geometry, (#{geometry_sql(geographic_item_id, source_column_name)}))"
  end

  # @param [String, Integer, String]
  # @return [String]
  #   a SQL fragment for ST_Contains(), returns
  #   all geographic_items which contain the supplied geographic_item
  def reverse_containing_sql(target_column_name = nil, geographic_item_id = nil, source_column_name = nil)
    return 'false' if geographic_item_id.nil? || source_column_name.nil? || target_column_name.nil?
    "ST_Contains((#{geometry_sql(geographic_item_id, source_column_name)}), #{target_column_name}::geometry)"
  end

  # @param [Integer, String]
  # @return [String]
  #   a SQL fragment that represents the geometry of the geographic item specified (which has data in the
  # source_column_name, i.e. geo_object_type)
  def geometry_sql(geographic_item_id = nil, source_column_name = nil)
    return 'false' if geographic_item_id.nil? || source_column_name.nil?
    "select geom_alias_tbl.#{source_column_name}::geometry from geographic_items geom_alias_tbl " \
      "where geom_alias_tbl.id = #{geographic_item_id}"
  end

  # rubocop:disable Metrics/MethodLength
  # @param [String] column_name
  # @param [GeographicItem] geographic_item
  # @return [String] of SQL
  def is_contained_by_sql(column_name, geographic_item)
    geo_id = geographic_item.id
    geo_type = geographic_item.geo_object_type
    template = '(ST_Contains((select geographic_items.%s::geometry from geographic_items where ' \
      'geographic_items.id = %d), %s::geometry))'
    retval = []
    column_name.downcase!
    case column_name
    when 'any'
      DATA_TYPES.each { |column|
        unless column == :geometry_collection
          retval.push(template % [geo_type, geo_id, column])
        end
      }
    when 'any_poly', 'any_line'
      DATA_TYPES.each { |column|
        unless column == :geometry_collection
          if column.to_s.index(column_name.gsub('any_', ''))
            retval.push(template % [geo_type, geo_id, column])
          end
        end
      }
    else
      retval = template % [geo_type, geo_id, column_name]
    end
    retval = retval.join(' OR ') if retval.instance_of?(Array)
    retval
  end

  # @param [Interger, Array of Integer] geographic_item_ids
  # @return [String]
  #   a select query that returns a single geometry (column name 'single_geometry' for the collection of ids
  # provided via ST_Collect)
  def st_collect_sql(*geographic_item_ids)
    geographic_item_ids.flatten!
    ActiveRecord::Base.send(:sanitize_sql_for_conditions, [
      "SELECT ST_Collect(f.the_geom) AS single_geometry
 FROM (
    SELECT (ST_DUMP(#{GeographicItem::GEOMETRY_SQL.to_sql})).geom as the_geom
    FROM geographic_items
    WHERE id in (?))
  AS f", geographic_item_ids])
  end

  # @param [Interger, Array of Integer] geographic_item_ids
  # @return [String]
  #    returns one or more geographic items combined as a single geometry in column 'single'
  def single_geometry_sql(*geographic_item_ids)
    a = GeographicItem.st_collect_sql(geographic_item_ids)
    '(SELECT single.single_geometry FROM (' + a + ' ) AS single)'
  end

  # @param [Interger, Array of Integer] geographic_item_ids
  # @return [String]
  #   returns a single geometry "column" (paren wrapped) as "single" for multiple geographic item ids, or the
  # geometry as 'geometry' for a single id
  def geometry_sql2(*geographic_item_ids)
    geographic_item_ids.flatten! # *ALWAYS* reduce the pile to a single level of ids
    if geographic_item_ids.count == 1
      "(#{GeographicItem.geometry_for_sql(geographic_item_ids.first)})"
    else
      GeographicItem.single_geometry_sql(geographic_item_ids)
    end
  end

  # @param [Interger, Array of Integer] geographic_item_ids
  # @return [String]
  def containing_where_sql(*geographic_item_ids)
    "ST_CoveredBy(
      #{GeographicItem.geometry_sql2(*geographic_item_ids)},
       CASE geographic_items.type
         WHEN 'GeographicItem::MultiPolygon' THEN multi_polygon::geometry
         WHEN 'GeographicItem::Point' THEN point::geometry
         WHEN 'GeographicItem::LineString' THEN line_string::geometry
         WHEN 'GeographicItem::Polygon' THEN polygon::geometry
         WHEN 'GeographicItem::MultiLineString' THEN multi_line_string::geometry
         WHEN 'GeographicItem::MultiPoint' THEN multi_point::geometry
      END)"
  end

  # @param [Interger, Array of Integer] geographic_item_ids
  # @return [String]
  def containing_where_sql_geog(*geographic_item_ids)
    "ST_CoveredBy(
      #{GeographicItem.geometry_sql2(*geographic_item_ids)},
       CASE geographic_items.type
         WHEN 'GeographicItem::MultiPolygon' THEN multi_polygon::geography
         WHEN 'GeographicItem::Point' THEN point::geography
         WHEN 'GeographicItem::LineString' THEN line_string::geography
         WHEN 'GeographicItem::Polygon' THEN polygon::geography
         WHEN 'GeographicItem::MultiLineString' THEN multi_line_string::geography
         WHEN 'GeographicItem::MultiPoint' THEN multi_point::geography
      END)"
  end

  # @param [Interger, Array of Integer] ids
  # @return [Array]
  #   If we detect that some query id has crossed the meridian, then loop through
  #   and "manually" build up a list of results.
  #   Should only be used if GeographicItem.crosses_anti_meridian_by_id? is true.
  #   Note that this does not return a Scope, so you can't chain it like contained_by?
  # TODO: test this
  def contained_by_with_antimeridian_check(*ids)
    ids.flatten! # make sure there is only one level of splat (*)
    results = []

    crossing_ids = []

    ids.each do |id|
      # push each which crosses
      crossing_ids.push(id) if GeographicItem.crosses_anti_meridian_by_id?(id)
    end

    non_crossing_ids = ids - crossing_ids
    results.push GeographicItem.contained_by(non_crossing_ids).to_a if non_crossing_ids.any?

    crossing_ids.each do |id|
      # [61666, 61661, 61659, 61654, 61639]
      q1 = ActiveRecord::Base.send(:sanitize_sql_array, ['SELECT ST_AsText((SELECT polygon FROM geographic_items ' \
                                                         'WHERE id = ?))', id])
      r = GeographicItem.where(
        # GeographicItem.contained_by_wkt_shifted_sql(GeographicItem.find(id).geo_object.to_s)
        GeographicItem.contained_by_wkt_shifted_sql(
          ApplicationRecord.connection.execute(q1).first['st_astext'])
      ).to_a
      results.push(r)
    end

    results.flatten.uniq
  end

  # @params [String] well known text
  # @return [String] the SQL fragment for the specific geometry type, shifted by longitude
  # Note: this routine is called when it is already known that the A argument crosses anti-meridian
  def contained_by_wkt_shifted_sql(wkt)
    "ST_Contains(ST_ShiftLongitude(ST_GeomFromText('#{wkt}', 4326)), (
    CASE geographic_items.type
       WHEN 'GeographicItem::MultiPolygon' THEN ST_ShiftLongitude(multi_polygon::geometry)
       WHEN 'GeographicItem::Point' THEN ST_ShiftLongitude(point::geometry)
       WHEN 'GeographicItem::LineString' THEN ST_ShiftLongitude(line_string::geometry)
       WHEN 'GeographicItem::Polygon' THEN ST_ShiftLongitude(polygon::geometry)
       WHEN 'GeographicItem::MultiLineString' THEN ST_ShiftLongitude(multi_line_string::geometry)
       WHEN 'GeographicItem::MultiPoint' THEN ST_ShiftLongitude(multi_point::geometry)
    END
    )
  )"
  end

  # TODO: Remove the hard coded 4326 reference
  # @params [String] wkt
  # @return [String] SQL fragment limiting geographics items to those in this WKT
  def contained_by_wkt_sql(wkt)
    if crosses_anti_meridian?(wkt)
      retval = contained_by_wkt_shifted_sql(wkt)
    else
      retval = "ST_Contains(ST_GeomFromText('#{wkt}', 4326), (
    CASE geographic_items.type
       WHEN 'GeographicItem::MultiPolygon' THEN multi_polygon::geometry
       WHEN 'GeographicItem::Point' THEN point::geometry
       WHEN 'GeographicItem::LineString' THEN line_string::geometry
       WHEN 'GeographicItem::Polygon' THEN polygon::geometry
       WHEN 'GeographicItem::MultiLineString' THEN multi_line_string::geometry
       WHEN 'GeographicItem::MultiPoint' THEN multi_point::geometry
    END
    )
  )"
    end
    retval
  end

  # @param [Interger, Array of Integer] geographic_item_ids
  # @return [String] sql for contained_by via ST_ContainsProperly
  # Note: Can not use GEOMETRY_SQL because geometry_collection is not supported in ST_ContainsProperly
  # Note: !! If the target GeographicItem#id crosses the anti-meridian then you may/will get unexpected results.
  def contained_by_where_sql(*geographic_item_ids)
    "ST_Contains(
    #{GeographicItem.geometry_sql2(*geographic_item_ids)},
    CASE geographic_items.type
      WHEN 'GeographicItem::MultiPolygon' THEN multi_polygon::geometry
      WHEN 'GeographicItem::Point' THEN point::geometry
      WHEN 'GeographicItem::LineString' THEN line_string::geometry
      WHEN 'GeographicItem::Polygon' THEN polygon::geometry
      WHEN 'GeographicItem::MultiLineString' THEN multi_line_string::geometry
      WHEN 'GeographicItem::MultiPoint' THEN multi_point::geometry
    END)"
  end

  # @param [RGeo:Point] rgeo_point
  # @return [String] sql for containing via ST_CoveredBy
  # TODO: Remove the hard coded 4326 reference
  # TODO: should this be wkt_point instead of rgeo_point?
  def containing_where_for_point_sql(rgeo_point)
    "ST_CoveredBy(
  ST_GeomFromText('#{rgeo_point}', 4326),
  #{GeographicItem::GEOMETRY_SQL.to_sql}
 )"
  end

  # @param [Interger] geographic_item_id
  # @return [String] SQL for geometries
  # example, not used
  def geometry_for_sql(geographic_item_id)
    'SELECT ' + GeographicItem::GEOMETRY_SQL.to_sql + ' AS geometry FROM geographic_items WHERE id = ' \
      "#{geographic_item_id} LIMIT 1"
  end

  # @param [Interger, Array of Integer] geographic_item_ids
  # @return [String] SQL for geometries
  # example, not used
  def geometry_for_collection_sql(*geographic_item_ids)
    'SELECT ' + GeographicItem::GEOMETRY_SQL.to_sql + ' AS geometry FROM geographic_items WHERE id IN ' \
      "( #{geographic_item_ids.join(',')} )"
  end

  #
  # Scopes
  #

  # @param [Interger, Array of Integer] geographic_item_ids
  # @return [Scope]
  #    the geographic items containing these collective geographic_item ids, not including self
  def containing(*geographic_item_ids)
    where(GeographicItem.containing_where_sql(geographic_item_ids)).not_ids(*geographic_item_ids)
  end

  # @param [Interger, Array of Integer] geographic_item_ids
  # @return [Scope]
  #    the geographic items contained by any of these geographic_item ids, not including self
  # (works via ST_ContainsProperly)
  def contained_by(*geographic_item_ids)
    where(GeographicItem.contained_by_where_sql(geographic_item_ids))
  end

  # @param [RGeo::Point] rgeo_point
  # @return [Scope]
  #    the geographic items containing this point
  # TODO: should be containing_wkt ?
  def containing_point(rgeo_point)
    where(GeographicItem.containing_where_for_point_sql(rgeo_point))
  end

  # @return [Scope]
  #   adds an area_in_meters field, with meters
  def with_area
    select("ST_Area(#{GeographicItem::GEOGRAPHY_SQL}, false) as area_in_meters")
  end

  # return [Scope]
  #   A scope that limits the result to those GeographicItems that have a collecting event
  #   through either the geographic_item or the error_geographic_item
  #
  # A raw SQL join approach for comparison
  #
  # GeographicItem.joins('LEFT JOIN georeferences g1 ON geographic_items.id = g1.geographic_item_id').
  #   joins('LEFT JOIN georeferences g2 ON geographic_items.id = g2.error_geographic_item_id').
  #   where("(g1.geographic_item_id IS NOT NULL OR g2.error_geographic_item_id IS NOT NULL)").uniq

  # @return [Scope] GeographicItem
  # This uses an Arel table approach, this is ultimately more decomposable if we need. Of use:
  #  http://danshultz.github.io/talks/mastering_activerecord_arel  <- best
  #  https://github.com/rails/arel
  #  http://stackoverflow.com/questions/4500629/use-arel-for-a-nested-set-join-query-and-convert-to-activerecordrelation
  #  http://rdoc.info/github/rails/arel/Arel/SelectManager
  #  http://stackoverflow.com/questions/7976358/activerecord-arel-or-condition
  #
  def with_collecting_event_through_georeferences
    geographic_items = GeographicItem.arel_table
    georeferences = Georeference.arel_table
    g1 = georeferences.alias('a')
    g2 = georeferences.alias('b')

    c = geographic_items.join(g1, Arel::Nodes::OuterJoin).on(geographic_items[:id].eq(g1[:geographic_item_id]))
      .join(g2, Arel::Nodes::OuterJoin).on(geographic_items[:id].eq(g2[:error_geographic_item_id]))

    GeographicItem.joins(# turn the Arel back into scope
                         c.join_sources # translate the Arel join to a join hash(?)
                        ).where(
                          g1[:id].not_eq(nil).or(g2[:id].not_eq(nil)) # returns a Arel::Nodes::Grouping
                        ).distinct
  end

  # @return [Scope] include a 'latitude' column
  def with_latitude
    select(lat_long_sql(:latitude))
  end

  # @return [Scope] include a 'longitude' column
  def with_longitude
    select(lat_long_sql(:longitude))
  end

  # @param [String, GeographicItems]
  # @return [Scope]
  def intersecting(column_name, *geographic_items)
    if column_name.downcase == 'any'
      pieces = []
      DATA_TYPES.each { |column|
        pieces.push(GeographicItem.intersecting(column.to_s, geographic_items).to_a)
      }

      # @TODO change 'id in (?)' to some other sql construct

      GeographicItem.where(id: pieces.flatten.map(&:id))
    else
      q = geographic_items.flatten.collect { |geographic_item|
        "ST_Intersects(#{column_name}, '#{geographic_item.geo_object}'    )" # seems like we want this: http://danshultz.github.io/talks/mastering_activerecord_arel/#/15/2
      }.join(' or ')

      where(q)
    end
  end

  # @param [GeographicItem#id] geographic_item_id
  # @param [Float] distance in meters ?!?!
  # @return [ActiveRecord::Relation]
  # !! should be distance, not radius?!
  def within_radius_of_item(geographic_item_id, distance)
    where(within_radius_of_item_sql(geographic_item_id, distance))
  end

  # @param [String, GeographicItem]
  # @return [Scope]
  #   a SQL fragment for ST_DISJOINT, specifies all geographic_items that have data in column_name
  #   that are disjoint from the passed geographic_items
  def disjoint_from(column_name, *geographic_items)
    q = geographic_items.flatten.collect { |geographic_item|
      "ST_DISJOINT(#{column_name}::geometry, (#{geometry_sql(geographic_item.to_param,
                                                         geographic_item.geo_object_type)}))"
    }.join(' and ')

    where(q)
  end

  # @return [Scope]
  #   see are_contained_in_item_by_id
  # @param [String] column_name
  # @param [GeographicItem, Array] geographic_items
  def are_contained_in_item(column_name, *geographic_items)
    are_contained_in_item_by_id(column_name, geographic_items.flatten.map(&:id))
  end

  # rubocop:disable Metrics/MethodLength
  # @param [String] column_name to search
  # @param [GeographicItem] geographic_item_ids or array of geographic_item_ids to be tested.
  # @return [Scope] of GeographicItems
  #
  # If this scope is given an Array of GeographicItems as a second parameter,
  # it will return the 'OR' of each of the objects against the table.
  # SELECT COUNT(*) FROM "geographic_items"
  #        WHERE (ST_Contains(polygon::geometry, GeomFromEWKT('srid=4326;POINT (0.0 0.0 0.0)'))
  #               OR ST_Contains(polygon::geometry, GeomFromEWKT('srid=4326;POINT (-9.8 5.0 0.0)')))
  #
  def are_contained_in_item_by_id(column_name, *geographic_item_ids) # = containing
    geographic_item_ids.flatten! # in case there is a array of arrays, or multiple objects
    column_name.downcase!
    case column_name
    when 'any'
      part = []
      DATA_TYPES.each { |column|
        unless column == :geometry_collection
          part.push(GeographicItem.are_contained_in_item_by_id(column.to_s, geographic_item_ids).to_a)
        end
      }
      # TODO: change 'id in (?)' to some other sql construct
      GeographicItem.where(id: part.flatten.map(&:id))
    when 'any_poly', 'any_line'
      part = []
      DATA_TYPES.each { |column|
        if column.to_s.index(column_name.gsub('any_', ''))
          part.push(GeographicItem.are_contained_in_item_by_id("#{column}", geographic_item_ids).to_a)
        end
      }
      # TODO: change 'id in (?)' to some other sql construct
      GeographicItem.where(id: part.flatten.map(&:id))
    else
      q = geographic_item_ids.flatten.collect { |geographic_item_id|
        # discover the item types, and convert type to database type for 'multi_'
        b = GeographicItem.where(id: geographic_item_id)
          .pluck(:type)[0].split(':')[2].downcase.gsub('lti', 'lti_')
        # a = GeographicItem.find(geographic_item_id).geo_object_type
        GeographicItem.containing_sql(column_name, geographic_item_id, b)
      }.join(' or ')
      q = 'FALSE' if q.blank? # this will prevent the invocation of *ALL* of the GeographicItems, if there are
      # no GeographicItems in the request (see CollectingEvent.name_hash(types)).
      where(q) # .not_including(geographic_items)
    end
  end

  # rubocop:enable Metrics/MethodLength

  # @param [String] column_name
  # @param [String] geometry of WKT
  # @return [Scope]
  # a single WKT geometry is compared against column or columns (except geometry_collection) to find geographic_items
  # which are contained in the WKT
  def are_contained_in_wkt(column_name, geometry)
    column_name.downcase!
    # column_name = 'point'
    case column_name
    when 'any'
      part = []
      DATA_TYPES.each { |column|
        unless column == :geometry_collection
          part.push(GeographicItem.are_contained_in_wkt(column.to_s, geometry).pluck(:id).to_a)
        end
      }
      # TODO: change 'id in (?)' to some other sql construct
      GeographicItem.where(id: part.flatten)
    when 'any_poly', 'any_line'
      part = []
      DATA_TYPES.each { |column|
        if column.to_s.index(column_name.gsub('any_', ''))
          part.push(GeographicItem.are_contained_in_wkt("#{column}", geometry).pluck(:id).to_a)
        end
      }
      # TODO: change 'id in (?)' to some other sql construct
      GeographicItem.where(id: part.flatten)
    else
      # column = points, geometry = square
      q = "ST_Contains(ST_GeomFromEWKT('srid=4326;#{geometry}'), #{column_name}::geometry)"
      where(q) # .not_including(geographic_items)
    end
  end

  # rubocop:disable Metrics/MethodLength
  #    containing the items the shape of which is contained in the geographic_item[s] supplied.
  # @param column_name [String] can be any of DATA_TYPES, or 'any' to check against all types, 'any_poly' to check
  # against 'polygon' or 'multi_polygon', or 'any_line' to check against 'line_string' or 'multi_line_string'.
  #  CANNOT be 'geometry_collection'.
  # @param geographic_items [GeographicItem] Can be a single GeographicItem, or an array of GeographicItem.
  # @return [Scope]
  def is_contained_by(column_name, *geographic_items)
    column_name.downcase!
    case column_name
    when 'any'
      part = []
      DATA_TYPES.each { |column|
        unless column == :geometry_collection
          part.push(GeographicItem.is_contained_by(column.to_s, geographic_items).to_a)
        end
      }
      # @TODO change 'id in (?)' to some other sql construct
      GeographicItem.where(id: part.flatten.map(&:id))

    when 'any_poly', 'any_line'
      part = []
      DATA_TYPES.each { |column|
        unless column == :geometry_collection
          if column.to_s.index(column_name.gsub('any_', ''))
            part.push(GeographicItem.is_contained_by(column.to_s, geographic_items).to_a)
          end
        end
      }
      # @TODO change 'id in (?)' to some other sql construct
      GeographicItem.where(id: part.flatten.map(&:id))

    else
      q = geographic_items.flatten.collect { |geographic_item|
        GeographicItem.reverse_containing_sql(column_name, geographic_item.to_param,
                                              geographic_item.geo_object_type)
      }.join(' or ')
      where(q) # .not_including(geographic_items)
    end
  end

  # rubocop:enable Metrics/MethodLength

  # @param [String, GeographicItem]
  # @return [Scope]
  def ordered_by_shortest_distance_from(column_name, geographic_item)
    if true # check_geo_params(column_name, geographic_item)
      select_distance_with_geo_object(column_name, geographic_item)
        .where_distance_greater_than_zero(column_name, geographic_item).order('distance')
    else
      where('false')
    end
  end

  # @param [String, GeographicItem]
  # @return [Scope]
  def ordered_by_longest_distance_from(column_name, geographic_item)
    if true # check_geo_params(column_name, geographic_item)
      q = select_distance_with_geo_object(column_name, geographic_item)
        .where_distance_greater_than_zero(column_name, geographic_item)
        .order('distance desc')
      q
    else
      where('false')
    end
  end

  # @param [String] column_name
  # @param [GeographicItem] geographic_item
  # @return [String]
  def select_distance_with_geo_object(column_name, geographic_item)
    select("*, ST_Distance(#{column_name}, GeomFromEWKT('srid=4326;#{geographic_item.geo_object}')) as distance")
  end

  # @param [String, GeographicItem]
  # @return [Scope]
  def where_distance_greater_than_zero(column_name, geographic_item)
    where("#{column_name} is not null and ST_Distance(#{column_name}, " \
          "GeomFromEWKT('srid=4326;#{geographic_item.geo_object}')) > 0")
  end

  # @param [GeographicItem]
  # @return [Scope]
  def not_including(geographic_items)
    where.not(id: geographic_items)
  end

  # @return [Scope]
  #   includes an 'is_valid' attribute (True/False) for the passed geographic_item.  Uses St_IsValid.
  # @param [RGeo object] geographic_item
  def with_is_valid_geometry_column(geographic_item)
    where(id: geographic_item.id).select("ST_IsValid(ST_AsBinary(#{geographic_item.geo_object_type})) is_valid")
  end

  #
  # Other
  #

  # @param [Integer] geographic_item_id1
  # @param [Integer] geographic_item_id2
  # @return [Float]
  def distance_between(geographic_item_id1, geographic_item_id2)
    q1 = "ST_Distance(#{GeographicItem::GEOGRAPHY_SQL}, " \
      "(#{select_geography_sql(geographic_item_id2)})) as distance"
    _q2 = ActiveRecord::Base.send(
      :sanitize_sql_array, ['ST_Distance(?, (?)) as distance',
                            GeographicItem::GEOGRAPHY_SQL,
                            select_geography_sql(geographic_item_id2)])
    GeographicItem.where(id: geographic_item_id1).pluck(Arel.sql(q1)).first
  end

  # @param [RGeo::Point] point
  # @return [Hash]
  #   as per #inferred_geographic_name_hierarchy but for Rgeo point
  def point_inferred_geographic_name_hierarchy(point)
    GeographicItem.containing_point(point).order(cached_total_area: :ASC).limit(1).first&.inferred_geographic_name_hierarchy
  end

  # @param [String] type_name ('polygon', 'point', 'line' [, 'circle'])
  # @return [String] if type
  def eval_for_type(type_name)
    retval = 'GeographicItem'
    case type_name.upcase
    when 'POLYGON'
      retval += '::Polygon'
    when 'LINESTRING'
      retval += '::LineString'
    when 'POINT'
      retval += '::Point'
    when 'MULTIPOLYGON'
      retval += '::MultiPolygon'
    when 'MULTILINESTRING'
      retval += '::MultiLineString'
    when 'MULTIPOINT'
      retval += '::MultiPoint'
    else
      retval = nil
    end
    retval
  end

  # example, not used
  # @param [Integer] geographic_item_id
  # @return [RGeo::Geographic object]
  def geometry_for(geographic_item_id)
    GeographicItem.select(GeographicItem::GEOMETRY_SQL.to_sql + ' AS geometry').find(geographic_item_id)['geometry']
  end

  # example, not used
  # @param [Integer, Array] geographic_item_ids
  # @return [Scope]
  def st_multi(*geographic_item_ids)
    GeographicItem.find_by_sql(
      "SELECT ST_Multi(ST_Collect(g.the_geom)) AS singlegeom
 FROM (
    SELECT (ST_DUMP(#{GeographicItem::GEOMETRY_SQL.to_sql})).geom AS the_geom
    FROM geographic_items
    WHERE id IN (?))
  AS g;", geographic_item_ids.flatten
    )
  end
end # class << self

# @return [Hash]
#    a geographic_name_classification or empty Hash
# This is a quick approach that works only when
# the geographic_item is linked explicitly to a GeographicArea.
#
# !! Note that it is not impossible for a GeographicItem to be linked
# to > 1 GeographicArea, in that case we are assuming that all are
# equally refined, this might not be the case in the future because
# of how the GeographicArea gazetteer is indexed.
def quick_geographic_name_hierarchy
  geographic_areas.order(:id).each do |ga|
    h = ga.geographic_name_classification # not quick enough !!
    return h if h.present?
  end
  return  {}
end

# @return [Hash]
#   a geographic_name_classification (see GeographicArea) inferred by
# finding the smallest area containing this GeographicItem, in the most accurate gazetteer
# and using it to return country/state/county. See also the logic in
# filling in missing levels in GeographicArea.
def inferred_geographic_name_hierarchy
  if small_area = containing_geographic_areas
    .joins(:geographic_areas_geographic_items)
    .merge(GeographicAreasGeographicItem.ordered_by_data_origin)
    .ordered_by_area
    .limit(1)
    .first
  return small_area.geographic_name_classification
  else
    {}
  end
end

def geographic_name_hierarchy
  a = quick_geographic_name_hierarchy # quick; almost never the case, UI not setup to do this
  return a if a.present?
  inferred_geographic_name_hierarchy # slow
end

# @return [Scope]
#   the Geographic Areas that contain (gis) this geographic item
def containing_geographic_areas
  GeographicArea.joins(:geographic_items).includes(:geographic_area_type)
    .joins("JOIN (#{GeographicItem.containing(id).to_sql}) j on geographic_items.id = j.id")
end

# @return [Boolean]
#   whether stored shape is ST_IsValid
def valid_geometry?
  GeographicItem.with_is_valid_geometry_column(self).first['is_valid']
end

# @return [Array of latitude, longitude]
#    the lat, lon of the first point in the GeoItem, see subclass for #st_start_point
def start_point
  o = st_start_point
  [o.y, o.x]
end

# @return [Array]
#   the lat, long, as STRINGs for the centroid of this geographic item
#   Meh- this: https://postgis.net/docs/en/ST_MinimumBoundingRadius.html
def center_coords
  r = GeographicItem.find_by_sql(
    "Select split_part(ST_AsLatLonText(ST_Centroid(#{GeographicItem::GEOMETRY_SQL.to_sql}), " \
    "'D.DDDDDD'), ' ', 1) latitude, split_part(ST_AsLatLonText(ST_Centroid" \
    "(#{GeographicItem::GEOMETRY_SQL.to_sql}), 'D.DDDDDD'), ' ', 2) " \
    "longitude from geographic_items where id = #{id};")[0]

  [r.latitude, r.longitude]
end

# @return [RGeo::Geographic::ProjectedPointImpl]
#    representing the centroid of this geographic item
def centroid
  # Gis::FACTORY.point(*center_coords.reverse)
  return geo_object if type == 'GeographicItem::Point'
  return Gis::FACTORY.parse_wkt(self.st_centroid)
end

# @param [Integer] geographic_item_id
# @return [Double] distance in meters (slower, more accurate)
def st_distance(geographic_item_id) # geo_object
  q1 = "ST_Distance((#{GeographicItem.select_geography_sql(id)}), " \
    "(#{GeographicItem.select_geography_sql(geographic_item_id)})) as d"
  _q2 = ActiveRecord::Base.send(:sanitize_sql_array, ['ST_Distance((?),(?)) as d',
                                                      GeographicItem.select_geography_sql(self.id),
                                                      GeographicItem.select_geography_sql(geographic_item_id)])
  deg = GeographicItem.where(id:).pluck(Arel.sql(q1)).first
  deg * Utilities::Geo::ONE_WEST
end

# @param [GeographicItem] geographic_item
# @return [Double] distance in meters
# Like st_distance but works with changed and non persisted objects
def st_distance_to_geographic_item(geographic_item)
  unless !persisted? || changed?
    a = "(#{GeographicItem.select_geography_sql(id)})"
  else
    a = "ST_GeographyFromText('#{geo_object}')"
  end

  unless !geographic_item.persisted? || geographic_item.changed?
    b = "(#{GeographicItem.select_geography_sql(geographic_item.id)})"
  else
    b = "ST_GeographyFromText('#{geographic_item.geo_object}')"
  end

  ActiveRecord::Base.connection.select_value("SELECT ST_Distance(#{a}, #{b})")
end

alias_method :distance_to, :st_distance

# @param [Integer] geographic_item_id
# @return [Double] distance in meters (faster, less accurate)
def st_distance_spheroid(geographic_item_id)
  q1 = "ST_DistanceSpheroid((#{GeographicItem.select_geometry_sql(id)})," \
    "(#{GeographicItem.select_geometry_sql(geographic_item_id)}),'#{Gis::SPHEROID}') as distance"
  _q2 = ActiveRecord::Base.send(:sanitize_sql_array,
                                ['ST_DistanceSpheroid((?),(?),?) as distance',
                                 GeographicItem.select_geometry_sql(id),
                                 GeographicItem.select_geometry_sql(geographic_item_id),
                                 Gis::SPHEROID])
  # TODO: what is _q2?
  GeographicItem.where(id:).pluck(Arel.sql(q1)).first
end

# @return [String]
#   a WKT POINT representing the centroid of the geographic item
def st_centroid
  GeographicItem.where(id: to_param).pluck(Arel.sql("ST_AsEWKT(ST_Centroid(#{GeographicItem::GEOMETRY_SQL.to_sql}))")).first.gsub(/SRID=\d*;/, '')
end

# @return [Integer]
#   the number of points in the geometry
def st_npoints
  GeographicItem.where(id:).pluck(Arel.sql("ST_NPoints(#{GeographicItem::GEOMETRY_SQL.to_sql}) as npoints")).first
end

# @return [Symbol]
#   the geo type (i.e. column like :point, :multipolygon).  References the first-found object,
# according to the list of DATA_TYPES, or nil
def geo_object_type
  if self.class.name == 'GeographicItem' # a proxy check for new records
    geo_type
  else
    self.class::SHAPE_COLUMN
  end
end

# !!TODO: migrate these to use native column calls

# @return [RGeo instance, nil]
#  the Rgeo shape (See http://rubydoc.info/github/dazuma/rgeo/RGeo/Feature)
def geo_object
  begin
    if r = geo_object_type # rubocop:disable Lint/AssignmentInCondition
      send(r)
    else
      false
    end
  rescue RGeo::Error::InvalidGeometry
    return nil # TODO: we need to render proper error for this!
  end
end

# @param [geo_object]
# @return [Boolean]
def contains?(target_geo_object)
  return nil if target_geo_object.nil?
  self.geo_object.contains?(target_geo_object)
end

# @param [geo_object]
# @return [Boolean]
def within?(target_geo_object)
  self.geo_object.within?(target_geo_object)
end

# @param [geo_object]
# @return [Boolean]
def intersects?(target_geo_object)
  self.geo_object.intersects?(target_geo_object)
end

# @param [geo_object, Double]
# @return [Boolean]
def near(target_geo_object, distance)
  self.geo_object.unsafe_buffer(distance).contains?(target_geo_object)
end

# @param [geo_object, Double]
# @return [Boolean]
def far(target_geo_object, distance)
  !near(target_geo_object, distance)
end

# @return [GeoJSON hash]
#    via Rgeo apparently necessary for GeometryCollection
def rgeo_to_geo_json
  RGeo::GeoJSON.encode(geo_object).to_json
end

# @return [Hash]
#   in GeoJSON format
#   Computed via "raw" PostGIS (much faster). This
#   requires the geo_object_type and id.
#
def to_geo_json
  JSON.parse(
    GeographicItem.connection.select_one(
      "SELECT ST_AsGeoJSON(#{geo_object_type}::geometry) a " \
      "FROM geographic_items WHERE id=#{id};")['a'])
end

# We don't need to serialize to/from JSON
def to_geo_json_string
  GeographicItem.connection.select_one(
    "SELECT ST_AsGeoJSON(#{geo_object_type}::geometry) a " \
    "FROM geographic_items WHERE id=#{id};")['a']
end

# @return [Hash]
#   the shape as a GeoJSON Feature with some item metadata
def to_geo_json_feature
  @geometry ||= to_geo_json
  {'type' => 'Feature',
   'geometry' => geometry,
   'properties' => {
     'geographic_item' => {
       'id' => id}
   }
  }
end

# @param value [String] like:
#   '{"type":"Feature","geometry":{"type":"Point","coordinates":[2.5,4.0]},"properties":{"color":"red"}}'
#
#   '{"type":"Feature","geometry":{"type":"Polygon","coordinates":"[[[-125.29394388198853, 48.584480409793],
#      [-67.11035013198853, 45.09937589848195],[-80.64550638198853, 25.01924647619111],[-117.55956888198853,
#      32.5591595028449],[-125.29394388198853, 48.584480409793]]]"},"properties":{}}'
#
#  '{"type":"Point","coordinates":[2.5,4.0]},"properties":{"color":"red"}}'
#
# @return [Boolean, RGeo object]
def shape=(value)

  if value.present?
    geom = RGeo::GeoJSON.decode(value, json_parser: :json, geo_factory: Gis::FACTORY)
    this_type = nil

    if geom.respond_to?(:geometry_type)
      this_type = geom.geometry_type.to_s
    elsif geom.respond_to?(:geometry)
      this_type = geom.geometry.geometry_type.to_s
    else
    end

    self.type = GeographicItem.eval_for_type(this_type) unless geom.nil?

    if type.blank?
      errors.add(:base, 'type is not set from shape')
      return
    end
    # raise('GeographicItem.type not set.') if type.blank?

    object = nil

    s = geom.respond_to?(:geometry) ? geom.geometry.to_s : geom.to_s

    begin
      object = Gis::FACTORY.parse_wkt(s)
    rescue RGeo::Error::InvalidGeometry
      errors.add(:self, 'Shape value is an Invalid Geometry')
    end

    write_attribute(this_type.underscore.to_sym, object)
    geom
  end
end

# @return [String]
def to_wkt
  #  10k  #<Benchmark::Tms:0x00007fb0dfd30fd0 @label="", @real=25.237487000005785, @cstime=0.0, @cutime=0.0, @stime=1.1704609999999995, @utime=5.507929999999988, @total=6.678390999999987>
  #  GeographicItem.select("ST_AsText( #{GeographicItem::GEOMETRY_SQL.to_sql}) wkt").where(id: id).first.wkt

  # 10k <Benchmark::Tms:0x00007fb0e02f7540 @label="", @real=21.619827999995323, @cstime=0.0, @cutime=0.0, @stime=0.8850890000000007, @utime=3.2958549999999605, @total=4.180943999999961>
  if a =  ApplicationRecord.connection.execute( "SELECT ST_AsText( #{GeographicItem::GEOMETRY_SQL.to_sql} ) wkt from geographic_items where geographic_items.id = #{id}").first
    return a['wkt']
  else
    return nil
  end
end

# @return  [Float] in meters, calculated
# TODO: share with world
#    Geographic item 96862 (Cajamar in Brazil) is the only(?) record to fail using `false` (quicker) method of everything we tested
def area
  a = GeographicItem.where(id:).select("ST_Area(#{GeographicItem::GEOGRAPHY_SQL}, true) as area_in_meters").first['area_in_meters']
  a = nil if a.nan?
  a
end

# @return [Float, false]
#    the value in square meters of the interesecting area of this and another GeographicItem
def intersecting_area(geographic_item_id)
  a = GeographicItem.aliased_geographic_sql('a')
  b = GeographicItem.aliased_geographic_sql('b')

  c = GeographicItem.connection.execute(
    "SELECT ST_Area(ST_Intersection(#{a}, #{b})) as intersecting_area
      FROM geographic_items a, geographic_items b
      WHERE a.id = #{id} AND b.id = #{geographic_item_id};"
  ).first
  c && c['intersecting_area'].to_f
end

# TODO: This is bad, while internal use of ONE_WEST_MEAN is consistent it is in-accurate given the vast differences of radius vs. lat/long position.
# When we strike the error-polygon from radius we should remove this
#
# Use case is returning the radius from a circle we calculated via buffer for error-polygon creation.
def radius
  r = ApplicationRecord.connection.execute( "SELECT ST_MinimumBoundingRadius( ST_Transform(  #{GeographicItem::GEOMETRY_SQL.to_sql}, 4326 )  ) AS radius from geographic_items where geographic_items.id = #{id}").first['radius'].split(',').last.chop.to_f
  r = (r * Utilities::Geo::ONE_WEST_MEAN).to_i
end


# Convention is to store in PostGIS in CCW
# @return Array [Boolean]
#   false - cw
#   true - ccw (preferred), except cee donuts
def orientations
  if multi_polygon.present?
    ApplicationRecord.connection.execute(" \
         SELECT ST_IsPolygonCCW(a.geom) as is_ccw
            FROM ( SELECT b.id, (ST_Dump(p_geom)).geom AS geom
               FROM (SELECT id, multi_polygon::geometry AS p_geom FROM geographic_items where id = #{id}) AS b \
          ) AS a;").collect{|a| a['is_ccw']}
  elsif polygon.present?
    ApplicationRecord.connection.execute("SELECT ST_IsPolygonCCW(polygon::geometry) as is_ccw \
            FROM geographic_items where  id = #{id};").collect{|a| a['is_ccw']}
  else
    []
  end
end

# @return Boolean
#   looks at all orientations
#   if they follow the pattern [true, false, ... <all false>] then `true`, else `false`
# !! Does not confirm that shapes are nested !!
def is_basic_donut?
  a = orientations
  b = a.shift
  return false unless b
  a.uniq!
  a == [false]
end

def st_isvalid
  r = ApplicationRecord.connection.execute( "SELECT ST_IsValid(  #{GeographicItem::GEOMETRY_SQL.to_sql }) from  geographic_items where geographic_items.id = #{id}").first['st_isvalid']
end

def st_isvalidreason
  r = ApplicationRecord.connection.execute( "SELECT ST_IsValidReason(  #{GeographicItem::GEOMETRY_SQL.to_sql }) from  geographic_items where geographic_items.id = #{id}").first['st_isvalidreason']
end

# !! Unused. Doesn't check Geometry collection
def has_polygons?
  ['GeographicItem::MultiPolygon', 'GeographicItem::Polygon'].include?(self.type)
end

private

def align_winding
  if orientations.flatten.include?(false)
    case type
    when 'multi_polygon'
      ApplicationRecord.connection.execute(
        "UPDATE geographic_items set multi_polygon = ST_ForcePolygonCCW(multi_polygon::geometry) 
          WHERE id = #{self.id};"
       )
    when 'polygon'
     ApplicationRecord.connection.execute(
        "UPDATE geographic_items set polygon = ST_ForcePolygonCCW(polygon::geometry) 
          WHERE id = #{self.id};"
       )
    end     
  end
  true
end

# Crude debuging helper, write the shapes
# to a png
def self.debug_draw(geographic_item_ids = [])
  return false if geographic_item_ids.empty?

  sql = "SELECT ST_AsPNG(
     ST_AsRaster(
        (SELECT ST_Union(multi_polygon::geometry) from geographic_items where id IN (" + geographic_item_ids.join(',') + ")), 1920, 1080
    )
   ) png;"

  # ST_Buffer( multi_polygon::geometry, 0, 'join=bevel'),
  #     1920,
  #     1080)


  result = ActiveRecord::Base.connection.execute(sql).first['png']
  r = ActiveRecord::Base.connection.unescape_bytea(result)

  prefix = if geographic_item_ids.size > 10
             'multiple'
           else
             geographic_item_ids.join('_') + '_debug.draw.png'
           end

  n = prefix + '_debug.draw.png'

  # Open the file in binary write mode ("wb")
  File.open(n, 'wb') do |file|
    # Write the binary data to the file
    file.write(r)
  end
end

# def png

#   if ids = Otu.joins(:cached_map_items).first.cached_map_items.pluck(:geographic_item_id)

#     sql = "SELECT ST_AsPNG(
#    ST_AsRaster(
#        ST_Buffer( multi_polygon::geometry, 0, 'join=bevel'),
#            1024,
#            768)
#     ) png
#        from geographic_items where id IN (" + ids.join(',') + ');'

#     # hack, not the best way to unpack result
#     result = ActiveRecord::Base.connection.execute(sql).first['png']
#     r = ActiveRecord::Base.connection.unescape_bytea(result)

#     send_data r, filename: 'foo.png', type: 'imnage/png'

#   else
#     render json: {foo: false}
#   end
# end

def set_cached
  update_column(:cached_total_area, area)
end

# @return [Symbol]
#   returns the attribute (column name) containing data
#   nearly all methods should use #geo_object_type, not geo_type
def geo_type
  DATA_TYPES.each { |item|
    return item if send(item)
  }
  nil
end

# @return [Boolean, String] false if already set, or type to which it was set
def set_type_if_geography_present
  if type.blank?
    column = geo_type
    self.type = "GeographicItem::#{column.to_s.camelize}" if column
  end
end

# @param [RGeo::Point] point
# @return [Array] of a point
#   Longitude |, Latitude -
def point_to_a(point)
  data = []
  data.push(point.x, point.y)
  data
end

# @param [RGeo::Point] point
# @return [Hash] of a point
def point_to_hash(point)
  {points: [point_to_a(point)]}
end

# @param [RGeo::MultiPoint] multi_point
# @return [Array] of points
def multi_point_to_a(multi_point)
  data = []
  multi_point.each { |point|
    data.push([point.x, point.y])
  }
  data
end

# @return [Hash] of points
def multi_point_to_hash(_multi_point)
  # when we encounter a multi_point type, we only stick the points into the array, NOT it's identity as a group
  {points: multi_point_to_a(multi_point)}
end

# @param [Reo::LineString] line_string
# @return [Array] of points in the line
def line_string_to_a(line_string)
  data = []
  line_string.points.each { |point|
    data.push([point.x, point.y])
  }
  data
end

# @param [Reo::LineString] line_string
# @return [Hash] of points in the line
def line_string_to_hash(line_string)
  {lines: [line_string_to_a(line_string)]}
end

# @param [RGeo::Polygon] polygon
# @return [Array] of points in the polygon (exterior_ring ONLY)
def polygon_to_a(polygon)
  # TODO: handle other parts of the polygon; i.e., the interior_rings (if they exist)
  data = []
  polygon.exterior_ring.points.each { |point|
    data.push([point.x, point.y])
  }
  data
end

# @param [RGeo::Polygon] polygon
# @return [Hash] of points in the polygon (exterior_ring ONLY)
def polygon_to_hash(polygon)
  {polygons: [polygon_to_a(polygon)]}
end

# @return [Array] of line_strings as arrays of points
# @param [RGeo::MultiLineString] multi_line_string
def multi_line_string_to_a(multi_line_string)
  data = []
  multi_line_string.each { |line_string|
    line_data = []
    line_string.points.each { |point|
      line_data.push([point.x, point.y])
    }
    data.push(line_data)
  }
  data
end

# @return [Hash] of line_strings as hashes of points
def multi_line_string_to_hash(_multi_line_string)
  {lines: to_a}
end

# @param [RGeo::MultiPolygon] multi_polygon
# @return [Array] of arrays of points in the polygons (exterior_ring ONLY)
def multi_polygon_to_a(multi_polygon)
  data = []
  multi_polygon.each { |polygon|
    polygon_data = []
    polygon.exterior_ring.points.each { |point|
      polygon_data.push([point.x, point.y])
    }
    data.push(polygon_data)
  }
  data
end

# @return [Hash] of hashes of points in the polygons (exterior_ring ONLY)
def multi_polygon_to_hash(_multi_polygon)
  {polygons: to_a}
end

# @return [Boolean] iff there is one and only one shape column set
def some_data_is_provided
  data = []

  DATA_TYPES.each do |item|
    data.push(item) if send(item).present?
  end

  case data.count
  when 0
    errors.add(:base, 'No shape provided or provided shape is invalid')
  when 1
    return true
  else
    data.each do |object|
      errors.add(object, 'More than one shape type provided')
    end
  end
  true
end
end

Class Method Details

.aliased_geographic_sql(name = 'a') ⇒ `Object`

# File 'app/models/geographic_item.rb', line 124

def aliased_geographic_sql(name = 'a')
  "CASE #{name}.type \
   WHEN 'GeographicItem::MultiPolygon' THEN #{name}.multi_polygon \
   WHEN 'GeographicItem::Point' THEN #{name}.point \
   WHEN 'GeographicItem::LineString' THEN #{name}.line_string \
   WHEN 'GeographicItem::Polygon' THEN #{name}.polygon \
   WHEN 'GeographicItem::MultiLineString' THEN #{name}.multi_line_string \
   WHEN 'GeographicItem::MultiPoint' THEN #{name}.multi_point \
   WHEN 'GeographicItem::GeometryCollection' THEN #{name}.geometry_collection \
   END"
end

.are_contained_in_item(column_name, *geographic_items) ⇒ `Scope`

Returns see are_contained_in_item_by_id.

Parameters:

column_name (String)
geographic_items (GeographicItem, Array)

Returns:

(Scope) —

see are_contained_in_item_by_id



632
633
634

# File 'app/models/geographic_item.rb', line 632

def are_contained_in_item(column_name, *geographic_items)
  are_contained_in_item_by_id(column_name, geographic_items.flatten.map(&:id))
end

.are_contained_in_item_by_id(column_name, *geographic_item_ids) ⇒ `Scope`

rubocop:disable Metrics/MethodLength If this scope is given an Array of GeographicItems as a second parameter, it will return the ‘OR’ of each of the objects against the table. SELECT COUNT(*) FROM “geographic_items”

WHERE (ST_Contains(polygon::geometry, GeomFromEWKT('srid=4326;POINT (0.0 0.0 0.0)'))
       OR ST_Contains(polygon::geometry, GeomFromEWKT('srid=4326;POINT (-9.8 5.0 0.0)')))

Parameters:

column_name (String) —

to search
geographic_item_ids (GeographicItem) —

or array of geographic_item_ids to be tested.

Returns:

(Scope) —

of GeographicItems

# File 'app/models/geographic_item.rb', line 647

def are_contained_in_item_by_id(column_name, *geographic_item_ids) # = containing
  geographic_item_ids.flatten! # in case there is a array of arrays, or multiple objects
  column_name.downcase!
  case column_name
  when 'any'
    part = []
    DATA_TYPES.each { |column|
      unless column == :geometry_collection
        part.push(GeographicItem.are_contained_in_item_by_id(column.to_s, geographic_item_ids).to_a)
      end
    }
    # TODO: change 'id in (?)' to some other sql construct
    GeographicItem.where(id: part.flatten.map(&:id))
  when 'any_poly', 'any_line'
    part = []
    DATA_TYPES.each { |column|
      if column.to_s.index(column_name.gsub('any_', ''))
        part.push(GeographicItem.are_contained_in_item_by_id("#{column}", geographic_item_ids).to_a)
      end
    }
    # TODO: change 'id in (?)' to some other sql construct
    GeographicItem.where(id: part.flatten.map(&:id))
  else
    q = geographic_item_ids.flatten.collect { |geographic_item_id|
      # discover the item types, and convert type to database type for 'multi_'
      b = GeographicItem.where(id: geographic_item_id)
        .pluck(:type)[0].split(':')[2].downcase.gsub('lti', 'lti_')
      # a = GeographicItem.find(geographic_item_id).geo_object_type
      GeographicItem.containing_sql(column_name, geographic_item_id, b)
    }.join(' or ')
    q = 'FALSE' if q.blank? # this will prevent the invocation of *ALL* of the GeographicItems, if there are
    # no GeographicItems in the request (see CollectingEvent.name_hash(types)).
    where(q) # .not_including(geographic_items)
  end
end

.are_contained_in_wkt(column_name, geometry) ⇒ `Scope`

a single WKT geometry is compared against column or columns (except geometry_collection) to find geographic_items which are contained in the WKT

Parameters:

column_name (String)
geometry (String) —

of WKT

Returns:

(Scope)

# File 'app/models/geographic_item.rb', line 690

def are_contained_in_wkt(column_name, geometry)
  column_name.downcase!
  # column_name = 'point'
  case column_name
  when 'any'
    part = []
    DATA_TYPES.each { |column|
      unless column == :geometry_collection
        part.push(GeographicItem.are_contained_in_wkt(column.to_s, geometry).pluck(:id).to_a)
      end
    }
    # TODO: change 'id in (?)' to some other sql construct
    GeographicItem.where(id: part.flatten)
  when 'any_poly', 'any_line'
    part = []
    DATA_TYPES.each { |column|
      if column.to_s.index(column_name.gsub('any_', ''))
        part.push(GeographicItem.are_contained_in_wkt("#{column}", geometry).pluck(:id).to_a)
      end
    }
    # TODO: change 'id in (?)' to some other sql construct
    GeographicItem.where(id: part.flatten)
  else
    # column = points, geometry = square
    q = "ST_Contains(ST_GeomFromEWKT('srid=4326;#{geometry}'), #{column_name}::geometry)"
    where(q) # .not_including(geographic_items)
  end
end

.contained_by(*geographic_item_ids) ⇒ `Scope`

(works via ST_ContainsProperly)

Parameters:

geographic_item_ids (Interger, Array of Integer)

Returns:

(Scope) —

the geographic items contained by any of these geographic_item ids, not including self



524
525
526

# File 'app/models/geographic_item.rb', line 524

def contained_by(*geographic_item_ids)
  where(GeographicItem.contained_by_where_sql(geographic_item_ids))
end

.contained_by_where_sql(*geographic_item_ids) ⇒ `String`

Note: Can not use GEOMETRY_SQL because geometry_collection is not supported in ST_ContainsProperly Note: !! If the target GeographicItem#id crosses the anti-meridian then you may/will get unexpected results.

Parameters:

geographic_item_ids (Interger, Array of Integer)

Returns:

(String) —

sql for contained_by via ST_ContainsProperly

# File 'app/models/geographic_item.rb', line 469

def contained_by_where_sql(*geographic_item_ids)
  "ST_Contains(
  #{GeographicItem.geometry_sql2(*geographic_item_ids)},
  CASE geographic_items.type
    WHEN 'GeographicItem::MultiPolygon' THEN multi_polygon::geometry
    WHEN 'GeographicItem::Point' THEN point::geometry
    WHEN 'GeographicItem::LineString' THEN line_string::geometry
    WHEN 'GeographicItem::Polygon' THEN polygon::geometry
    WHEN 'GeographicItem::MultiLineString' THEN multi_line_string::geometry
    WHEN 'GeographicItem::MultiPoint' THEN multi_point::geometry
  END)"
end

.contained_by_with_antimeridian_check(*ids) ⇒ `Array`

TODO: test this

Parameters:

ids (Interger, Array of Integer)

Returns:

(Array) —

If we detect that some query id has crossed the meridian, then loop through and “manually” build up a list of results. Should only be used if GeographicItem.crosses_anti_meridian_by_id? is true. Note that this does not return a Scope, so you can’t chain it like contained_by?

# File 'app/models/geographic_item.rb', line 397

def contained_by_with_antimeridian_check(*ids)
  ids.flatten! # make sure there is only one level of splat (*)
  results = []

  crossing_ids = []

  ids.each do |id|
    # push each which crosses
    crossing_ids.push(id) if GeographicItem.crosses_anti_meridian_by_id?(id)
  end

  non_crossing_ids = ids - crossing_ids
  results.push GeographicItem.contained_by(non_crossing_ids).to_a if non_crossing_ids.any?

  crossing_ids.each do |id|
    # [61666, 61661, 61659, 61654, 61639]
    q1 = ActiveRecord::Base.send(:sanitize_sql_array, ['SELECT ST_AsText((SELECT polygon FROM geographic_items ' \
                                                       'WHERE id = ?))', id])
    r = GeographicItem.where(
      # GeographicItem.contained_by_wkt_shifted_sql(GeographicItem.find(id).geo_object.to_s)
      GeographicItem.contained_by_wkt_shifted_sql(
        ApplicationRecord.connection.execute(q1).first['st_astext'])
    ).to_a
    results.push(r)
  end

  results.flatten.uniq
end

.contained_by_wkt_shifted_sql(wkt) ⇒ `String`

Note: this routine is called when it is already known that the A argument crosses anti-meridian

Returns:

(String) —

the SQL fragment for the specific geometry type, shifted by longitude

# File 'app/models/geographic_item.rb', line 429

def contained_by_wkt_shifted_sql(wkt)
  "ST_Contains(ST_ShiftLongitude(ST_GeomFromText('#{wkt}', 4326)), (
  CASE geographic_items.type
     WHEN 'GeographicItem::MultiPolygon' THEN ST_ShiftLongitude(multi_polygon::geometry)
     WHEN 'GeographicItem::Point' THEN ST_ShiftLongitude(point::geometry)
     WHEN 'GeographicItem::LineString' THEN ST_ShiftLongitude(line_string::geometry)
     WHEN 'GeographicItem::Polygon' THEN ST_ShiftLongitude(polygon::geometry)
     WHEN 'GeographicItem::MultiLineString' THEN ST_ShiftLongitude(multi_line_string::geometry)
     WHEN 'GeographicItem::MultiPoint' THEN ST_ShiftLongitude(multi_point::geometry)
  END
  )
)"
end

.contained_by_wkt_sql(wkt) ⇒ `String`

TODO: Remove the hard coded 4326 reference

Returns:

(String) —

SQL fragment limiting geographics items to those in this WKT

# File 'app/models/geographic_item.rb', line 446

def contained_by_wkt_sql(wkt)
  if crosses_anti_meridian?(wkt)
    retval = contained_by_wkt_shifted_sql(wkt)
  else
    retval = "ST_Contains(ST_GeomFromText('#{wkt}', 4326), (
  CASE geographic_items.type
     WHEN 'GeographicItem::MultiPolygon' THEN multi_polygon::geometry
     WHEN 'GeographicItem::Point' THEN point::geometry
     WHEN 'GeographicItem::LineString' THEN line_string::geometry
     WHEN 'GeographicItem::Polygon' THEN polygon::geometry
     WHEN 'GeographicItem::MultiLineString' THEN multi_line_string::geometry
     WHEN 'GeographicItem::MultiPoint' THEN multi_point::geometry
  END
  )
)"
  end
  retval
end

.containing(*geographic_item_ids) ⇒ `Scope`

Returns the geographic items containing these collective geographic_item ids, not including self.

Parameters:

geographic_item_ids (Interger, Array of Integer)

Returns:

(Scope) —

the geographic items containing these collective geographic_item ids, not including self



516
517
518

# File 'app/models/geographic_item.rb', line 516

def containing(*geographic_item_ids)
  where(GeographicItem.containing_where_sql(geographic_item_ids)).not_ids(*geographic_item_ids)
end

.containing_point(rgeo_point) ⇒ `Scope`

TODO: should be containing_wkt ?

Parameters:

rgeo_point (RGeo::Point)

Returns:

(Scope) —

the geographic items containing this point



532
533
534

# File 'app/models/geographic_item.rb', line 532

def containing_point(rgeo_point)
  where(GeographicItem.containing_where_for_point_sql(rgeo_point))
end

.containing_sql(target_column_name = nil, geographic_item_id = nil, source_column_name = nil) ⇒ `String`

Returns a SQL fragment for ST_Contains() function, returns all geographic items which are contained in the item supplied.

Parameters:

(String, Integer, String)

Returns:

(String) —

a SQL fragment for ST_Contains() function, returns all geographic items which are contained in the item supplied

# File 'app/models/geographic_item.rb', line 267

def containing_sql(target_column_name = nil, geographic_item_id = nil, source_column_name = nil)
  return 'false' if geographic_item_id.nil? || source_column_name.nil? || target_column_name.nil?
  "ST_Contains(#{target_column_name}::geometry, (#{geometry_sql(geographic_item_id, source_column_name)}))"
end

.containing_where_for_point_sql(rgeo_point) ⇒ `String`

TODO: Remove the hard coded 4326 reference TODO: should this be wkt_point instead of rgeo_point?

Parameters:

rgeo_point (RGeo:Point)

Returns:

(String) —

sql for containing via ST_CoveredBy

# File 'app/models/geographic_item.rb', line 486

def containing_where_for_point_sql(rgeo_point)
  "ST_CoveredBy(
ST_GeomFromText('#{rgeo_point}', 4326),
#{GeographicItem::GEOMETRY_SQL.to_sql}
     )"
end

.containing_where_sql(*geographic_item_ids) ⇒ `String`

Parameters:

geographic_item_ids (Interger, Array of Integer)

Returns:

(String)

# File 'app/models/geographic_item.rb', line 362

def containing_where_sql(*geographic_item_ids)
  "ST_CoveredBy(
    #{GeographicItem.geometry_sql2(*geographic_item_ids)},
     CASE geographic_items.type
       WHEN 'GeographicItem::MultiPolygon' THEN multi_polygon::geometry
       WHEN 'GeographicItem::Point' THEN point::geometry
       WHEN 'GeographicItem::LineString' THEN line_string::geometry
       WHEN 'GeographicItem::Polygon' THEN polygon::geometry
       WHEN 'GeographicItem::MultiLineString' THEN multi_line_string::geometry
       WHEN 'GeographicItem::MultiPoint' THEN multi_point::geometry
    END)"
end

.containing_where_sql_geog(*geographic_item_ids) ⇒ `String`

Parameters:

geographic_item_ids (Interger, Array of Integer)

Returns:

(String)

# File 'app/models/geographic_item.rb', line 377

def containing_where_sql_geog(*geographic_item_ids)
  "ST_CoveredBy(
    #{GeographicItem.geometry_sql2(*geographic_item_ids)},
     CASE geographic_items.type
       WHEN 'GeographicItem::MultiPolygon' THEN multi_polygon::geography
       WHEN 'GeographicItem::Point' THEN point::geography
       WHEN 'GeographicItem::LineString' THEN line_string::geography
       WHEN 'GeographicItem::Polygon' THEN polygon::geography
       WHEN 'GeographicItem::MultiLineString' THEN multi_line_string::geography
       WHEN 'GeographicItem::MultiPoint' THEN multi_point::geography
    END)"
end

.crosses_anti_meridian?(wkt) ⇒ `Boolean`

Returns whether or not the wtk intersects with the anti-meridian !! StrongParams security considerations.

Parameters:

wkt (String)

Returns:

(Boolean) —

whether or not the wtk intersects with the anti-meridian !! StrongParams security considerations

# File 'app/models/geographic_item.rb', line 159

def crosses_anti_meridian?(wkt)
  GeographicItem.find_by_sql(
    ['SELECT ST_Intersects(ST_GeogFromText(?), ST_GeogFromText(?)) as r;', wkt, ANTI_MERIDIAN]
  ).first.r
end

.crosses_anti_meridian_by_id?(*ids) ⇒ `Boolean`

Returns whether or not any GeographicItem passed intersects the anti-meridian !! StrongParams security considerations This is our first line of defense against queries that define multiple shapes, one or more of which crosses the anti-meridian. In this case the current TW strategy within the UI is to abandon the search, and prompt the user to refactor the query.

Parameters:

ids (Integer)

Returns:

(Boolean) —

whether or not any GeographicItem passed intersects the anti-meridian !! StrongParams security considerations This is our first line of defense against queries that define multiple shapes, one or more of which crosses the anti-meridian. In this case the current TW strategy within the UI is to abandon the search, and prompt the user to refactor the query.

# File 'app/models/geographic_item.rb', line 172

def crosses_anti_meridian_by_id?(*ids)
  q1 = ["SELECT ST_Intersects((SELECT single_geometry FROM (#{GeographicItem.single_geometry_sql(*ids)}) as " \
        'left_intersect), ST_GeogFromText(?)) as r;', ANTI_MERIDIAN]
  _q2 = ActiveRecord::Base.send(:sanitize_sql_array, ['SELECT ST_Intersects((SELECT single_geometry FROM (?) as ' \
                                                      'left_intersect), ST_GeogFromText(?)) as r;', GeographicItem.single_geometry_sql(*ids), ANTI_MERIDIAN])
  GeographicItem.find_by_sql(q1).first.r
end

.debug_draw(geographic_item_ids = []) ⇒ `Object` (private)

Crude debuging helper, write the shapes to a png

# File 'app/models/geographic_item.rb', line 1277

def self.debug_draw(geographic_item_ids = [])
  return false if geographic_item_ids.empty?

  sql = "SELECT ST_AsPNG(
     ST_AsRaster(
        (SELECT ST_Union(multi_polygon::geometry) from geographic_items where id IN (" + geographic_item_ids.join(',') + ")), 1920, 1080
    )
   ) png;"

  # ST_Buffer( multi_polygon::geometry, 0, 'join=bevel'),
  #     1920,
  #     1080)


  result = ActiveRecord::Base.connection.execute(sql).first['png']
  r = ActiveRecord::Base.connection.unescape_bytea(result)

  prefix = if geographic_item_ids.size > 10
             'multiple'
           else
             geographic_item_ids.join('_') + '_debug.draw.png'
           end

  n = prefix + '_debug.draw.png'

  # Open the file in binary write mode ("wb")
  File.open(n, 'wb') do |file|
    # Write the binary data to the file
    file.write(r)
  end
end

.default_by_geographic_area_ids(geographic_area_ids = []) ⇒ `GeographicItem::ActiveRecord_Relation`

Returns:

(GeographicItem::ActiveRecord_Relation)

# File 'app/models/geographic_item.rb', line 148

def default_by_geographic_area_ids(geographic_area_ids = [])
  GeographicItem.
    joins(:geographic_areas_geographic_items).
    merge(::GeographicAreasGeographicItem.default_geographic_item_data).
    where(geographic_areas_geographic_items: {geographic_area_id: geographic_area_ids})
end

.disjoint_from(column_name, *geographic_items) ⇒ `Scope`

Returns a SQL fragment for ST_DISJOINT, specifies all geographic_items that have data in column_name that are disjoint from the passed geographic_items.

Parameters:

(String, GeographicItem)

Returns:

(Scope) —

a SQL fragment for ST_DISJOINT, specifies all geographic_items that have data in column_name that are disjoint from the passed geographic_items

# File 'app/models/geographic_item.rb', line 619

def disjoint_from(column_name, *geographic_items)
  q = geographic_items.flatten.collect { |geographic_item|
    "ST_DISJOINT(#{column_name}::geometry, (#{geometry_sql(geographic_item.to_param,
                                                       geographic_item.geo_object_type)}))"
  }.join(' and ')

  where(q)
end

.distance_between(geographic_item_id1, geographic_item_id2) ⇒ `Float`

Parameters:

geographic_item_id1 (Integer)
geographic_item_id2 (Integer)

Returns:

(Float)

# File 'app/models/geographic_item.rb', line 820

def distance_between(geographic_item_id1, geographic_item_id2)
  q1 = "ST_Distance(#{GeographicItem::GEOGRAPHY_SQL}, " \
    "(#{select_geography_sql(geographic_item_id2)})) as distance"
  _q2 = ActiveRecord::Base.send(
    :sanitize_sql_array, ['ST_Distance(?, (?)) as distance',
                          GeographicItem::GEOGRAPHY_SQL,
                          select_geography_sql(geographic_item_id2)])
  GeographicItem.where(id: geographic_item_id1).pluck(Arel.sql(q1)).first
end

.eval_for_type(type_name) ⇒ `String`

Returns if type.

Parameters:

type_name (String) —

(‘polygon’, ‘point’, ‘line’ [, ‘circle’])

Returns:

(String) —

if type

# File 'app/models/geographic_item.rb', line 839

def eval_for_type(type_name)
  retval = 'GeographicItem'
  case type_name.upcase
  when 'POLYGON'
    retval += '::Polygon'
  when 'LINESTRING'
    retval += '::LineString'
  when 'POINT'
    retval += '::Point'
  when 'MULTIPOLYGON'
    retval += '::MultiPolygon'
  when 'MULTILINESTRING'
    retval += '::MultiLineString'
  when 'MULTIPOINT'
    retval += '::MultiPoint'
  else
    retval = nil
  end
  retval
end

.geometry_for(geographic_item_id) ⇒ `RGeo::Geographic object`

example, not used

Parameters:

geographic_item_id (Integer)

Returns:

(RGeo::Geographic object)



863
864
865

# File 'app/models/geographic_item.rb', line 863

def geometry_for(geographic_item_id)
  GeographicItem.select(GeographicItem::GEOMETRY_SQL.to_sql + ' AS geometry').find(geographic_item_id)['geometry']
end

.geometry_for_collection_sql(*geographic_item_ids) ⇒ `String`

example, not used

Parameters:

geographic_item_ids (Interger, Array of Integer)

Returns:

(String) —

SQL for geometries

# File 'app/models/geographic_item.rb', line 504

def geometry_for_collection_sql(*geographic_item_ids)
  'SELECT ' + GeographicItem::GEOMETRY_SQL.to_sql + ' AS geometry FROM geographic_items WHERE id IN ' \
    "( #{geographic_item_ids.join(',')} )"
end

.geometry_for_sql(geographic_item_id) ⇒ `String`

example, not used

Parameters:

geographic_item_id (Interger)

Returns:

(String) —

SQL for geometries

# File 'app/models/geographic_item.rb', line 496

def geometry_for_sql(geographic_item_id)
  'SELECT ' + GeographicItem::GEOMETRY_SQL.to_sql + ' AS geometry FROM geographic_items WHERE id = ' \
    "#{geographic_item_id} LIMIT 1"
end

.geometry_sql(geographic_item_id = nil, source_column_name = nil) ⇒ `String`

source_column_name, i.e. geo_object_type)

Parameters:

(Integer, String)

Returns:

(String) —

a SQL fragment that represents the geometry of the geographic item specified (which has data in the

# File 'app/models/geographic_item.rb', line 285

def geometry_sql(geographic_item_id = nil, source_column_name = nil)
  return 'false' if geographic_item_id.nil? || source_column_name.nil?
  "select geom_alias_tbl.#{source_column_name}::geometry from geographic_items geom_alias_tbl " \
    "where geom_alias_tbl.id = #{geographic_item_id}"
end

.geometry_sql2(*geographic_item_ids) ⇒ `String`

geometry as ‘geometry’ for a single id

Parameters:

geographic_item_ids (Interger, Array of Integer)

Returns:

(String) —

returns a single geometry “column” (paren wrapped) as “single” for multiple geographic item ids, or the

# File 'app/models/geographic_item.rb', line 351

def geometry_sql2(*geographic_item_ids)
  geographic_item_ids.flatten! # *ALWAYS* reduce the pile to a single level of ids
  if geographic_item_ids.count == 1
    "(#{GeographicItem.geometry_for_sql(geographic_item_ids.first)})"
  else
    GeographicItem.single_geometry_sql(geographic_item_ids)
  end
end

.intersecting(column_name, *geographic_items) ⇒ `Scope`

Parameters:

(String, GeographicItems)

Returns:

(Scope)

# File 'app/models/geographic_item.rb', line 588

def intersecting(column_name, *geographic_items)
  if column_name.downcase == 'any'
    pieces = []
    DATA_TYPES.each { |column|
      pieces.push(GeographicItem.intersecting(column.to_s, geographic_items).to_a)
    }

    # @TODO change 'id in (?)' to some other sql construct

    GeographicItem.where(id: pieces.flatten.map(&:id))
  else
    q = geographic_items.flatten.collect { |geographic_item|
      "ST_Intersects(#{column_name}, '#{geographic_item.geo_object}'    )" # seems like we want this: http://danshultz.github.io/talks/mastering_activerecord_arel/#/15/2
    }.join(' or ')

    where(q)
  end
end

.intersecting_radius_of_wkt_sql(wkt, distance) ⇒ `String`

TODO: 3D is overkill here !! This is intersecting

Parameters:

wkt (String)
distance (Integer) —

(meters)

Returns:

(String)

# File 'app/models/geographic_item.rb', line 250

def intersecting_radius_of_wkt_sql(wkt, distance)
  "ST_DWithin((#{GeographicItem::GEOGRAPHY_SQL}), ST_Transform( ST_GeomFromText('#{wkt}', " \
    "4326), 4326), #{distance})"
end

.is_contained_by(column_name, *geographic_items) ⇒ `Scope`

rubocop:disable Metrics/MethodLength

containing the items the shape of which is contained in the geographic_item[s] supplied.

against ‘polygon’ or ‘multi_polygon’, or ‘any_line’ to check against ‘line_string’ or ‘multi_line_string’.

CANNOT be 'geometry_collection'.

Parameters:

column_name (String) —

can be any of DATA_TYPES, or ‘any’ to check against all types, ‘any_poly’ to check
geographic_items (GeographicItem) —

Can be a single GeographicItem, or an array of GeographicItem.

Returns:

(Scope)

# File 'app/models/geographic_item.rb', line 726

def is_contained_by(column_name, *geographic_items)
  column_name.downcase!
  case column_name
  when 'any'
    part = []
    DATA_TYPES.each { |column|
      unless column == :geometry_collection
        part.push(GeographicItem.is_contained_by(column.to_s, geographic_items).to_a)
      end
    }
    # @TODO change 'id in (?)' to some other sql construct
    GeographicItem.where(id: part.flatten.map(&:id))

  when 'any_poly', 'any_line'
    part = []
    DATA_TYPES.each { |column|
      unless column == :geometry_collection
        if column.to_s.index(column_name.gsub('any_', ''))
          part.push(GeographicItem.is_contained_by(column.to_s, geographic_items).to_a)
        end
      end
    }
    # @TODO change 'id in (?)' to some other sql construct
    GeographicItem.where(id: part.flatten.map(&:id))

  else
    q = geographic_items.flatten.collect { |geographic_item|
      GeographicItem.reverse_containing_sql(column_name, geographic_item.to_param,
                                            geographic_item.geo_object_type)
    }.join(' or ')
    where(q) # .not_including(geographic_items)
  end
end

.is_contained_by_sql(column_name, geographic_item) ⇒ `String`

rubocop:disable Metrics/MethodLength

Parameters:

column_name (String)
geographic_item (GeographicItem)

Returns:

(String) —

of SQL

# File 'app/models/geographic_item.rb', line 295

def is_contained_by_sql(column_name, geographic_item)
  geo_id = geographic_item.id
  geo_type = geographic_item.geo_object_type
  template = '(ST_Contains((select geographic_items.%s::geometry from geographic_items where ' \
    'geographic_items.id = %d), %s::geometry))'
  retval = []
  column_name.downcase!
  case column_name
  when 'any'
    DATA_TYPES.each { |column|
      unless column == :geometry_collection
        retval.push(template % [geo_type, geo_id, column])
      end
    }
  when 'any_poly', 'any_line'
    DATA_TYPES.each { |column|
      unless column == :geometry_collection
        if column.to_s.index(column_name.gsub('any_', ''))
          retval.push(template % [geo_type, geo_id, column])
        end
      end
    }
  else
    retval = template % [geo_type, geo_id, column_name]
  end
  retval = retval.join(' OR ') if retval.instance_of?(Array)
  retval
end

.lat_long_sql(choice) ⇒ `String`

Returns a fragment returning either latitude or longitude columns.

Parameters:

choice (Symbol)

Returns:

(String) —

a fragment returning either latitude or longitude columns

# File 'app/models/geographic_item.rb', line 203

def lat_long_sql(choice)
  return nil unless [:latitude, :longitude].include?(choice)
  f = "'D.DDDDDD'" # TODO: probably a constant somewhere
  v = (choice == :latitude ? 1 : 2)
  "CASE geographic_items.type
WHEN 'GeographicItem::GeometryCollection' THEN split_part(ST_AsLatLonText(ST_Centroid" \
"(geometry_collection::geometry), #{f}), ' ', #{v})
WHEN 'GeographicItem::LineString' THEN split_part(ST_AsLatLonText(ST_Centroid(line_string::geometry), " \
"#{f}), ' ', #{v})
WHEN 'GeographicItem::MultiPolygon' THEN split_part(ST_AsLatLonText(" \
"ST_Centroid(multi_polygon::geometry), #{f}), ' ', #{v})
WHEN 'GeographicItem::Point' THEN split_part(ST_AsLatLonText(" \
"ST_Centroid(point::geometry), #{f}), ' ', #{v})
WHEN 'GeographicItem::Polygon' THEN split_part(ST_AsLatLonText(" \
"ST_Centroid(polygon::geometry), #{f}), ' ', #{v})
WHEN 'GeographicItem::MultiLineString' THEN split_part(ST_AsLatLonText(" \
"ST_Centroid(multi_line_string::geometry), #{f} ), ' ', #{v})
WHEN 'GeographicItem::MultiPoint' THEN split_part(ST_AsLatLonText(" \
"ST_Centroid(multi_point::geometry), #{f}), ' ', #{v})
    END as #{choice}"
end

.not_including(geographic_items) ⇒ `Scope`

Parameters:

(GeographicItem)

Returns:

(Scope)



802
803
804

# File 'app/models/geographic_item.rb', line 802

def not_including(geographic_items)
  where.not(id: geographic_items)
end

.ordered_by_longest_distance_from(column_name, geographic_item) ⇒ `Scope`

Parameters:

(String, GeographicItem)

Returns:

(Scope)

# File 'app/models/geographic_item.rb', line 775

def ordered_by_longest_distance_from(column_name, geographic_item)
  if true # check_geo_params(column_name, geographic_item)
    q = select_distance_with_geo_object(column_name, geographic_item)
      .where_distance_greater_than_zero(column_name, geographic_item)
      .order('distance desc')
    q
  else
    where('false')
  end
end

.ordered_by_shortest_distance_from(column_name, geographic_item) ⇒ `Scope`

Parameters:

(String, GeographicItem)

Returns:

(Scope)

# File 'app/models/geographic_item.rb', line 764

def ordered_by_shortest_distance_from(column_name, geographic_item)
  if true # check_geo_params(column_name, geographic_item)
    select_distance_with_geo_object(column_name, geographic_item)
      .where_distance_greater_than_zero(column_name, geographic_item).order('distance')
  else
    where('false')
  end
end

.point_inferred_geographic_name_hierarchy(point) ⇒ `Hash`

Returns as per #inferred_geographic_name_hierarchy but for Rgeo point.

Parameters:

point (RGeo::Point)

Returns:

(Hash) —

as per #inferred_geographic_name_hierarchy but for Rgeo point



833
834
835

# File 'app/models/geographic_item.rb', line 833

def point_inferred_geographic_name_hierarchy(point)
  GeographicItem.containing_point(point).order(cached_total_area: :ASC).limit(1).first&.inferred_geographic_name_hierarchy
end

.reverse_containing_sql(target_column_name = nil, geographic_item_id = nil, source_column_name = nil) ⇒ `String`

Returns a SQL fragment for ST_Contains(), returns all geographic_items which contain the supplied geographic_item.

Parameters:

(String, Integer, String)

Returns:

(String) —

a SQL fragment for ST_Contains(), returns all geographic_items which contain the supplied geographic_item

# File 'app/models/geographic_item.rb', line 276

def reverse_containing_sql(target_column_name = nil, geographic_item_id = nil, source_column_name = nil)
  return 'false' if geographic_item_id.nil? || source_column_name.nil? || target_column_name.nil?
  "ST_Contains((#{geometry_sql(geographic_item_id, source_column_name)}), #{target_column_name}::geometry)"
end

.select_distance_with_geo_object(column_name, geographic_item) ⇒ `String`

Parameters:

column_name (String)
geographic_item (GeographicItem)

Returns:

(String)



789
790
791

# File 'app/models/geographic_item.rb', line 789

def select_distance_with_geo_object(column_name, geographic_item)
  select("*, ST_Distance(#{column_name}, GeomFromEWKT('srid=4326;#{geographic_item.geo_object}')) as distance")
end

.select_geography_sql(geographic_item_id) ⇒ `String`

Returns a SQL select statement that returns the geography for the geographic_item with the specified id.

Parameters:

(Integer, String)

Returns:

(String) —

a SQL select statement that returns the geography for the geographic_item with the specified id

# File 'app/models/geographic_item.rb', line 194

def select_geography_sql(geographic_item_id)
  ActiveRecord::Base.send(:sanitize_sql_for_conditions, [
    "SELECT #{GeographicItem::GEOMETRY_SQL.to_sql} from geographic_items where geographic_items.id = ?",
    geographic_item_id])
end

.select_geometry_sql(geographic_item_id) ⇒ `String`

Returns a SQL select statement that returns the geometry for the geographic_item with the specified id.

Parameters:

(Integer, String)

Returns:

(String) —

a SQL select statement that returns the geometry for the geographic_item with the specified id



187
188
189

# File 'app/models/geographic_item.rb', line 187

def select_geometry_sql(geographic_item_id)
  "SELECT #{GeographicItem::GEOMETRY_SQL.to_sql} from geographic_items where geographic_items.id = #{geographic_item_id}"
end

.single_geometry_sql(*geographic_item_ids) ⇒ `String`

Returns one or more geographic items combined as a single geometry in column ‘single’

Parameters:

geographic_item_ids (Interger, Array of Integer)

Returns:

(String) —

returns one or more geographic items combined as a single geometry in column ‘single’

# File 'app/models/geographic_item.rb', line 342

def single_geometry_sql(*geographic_item_ids)
  a = GeographicItem.st_collect_sql(geographic_item_ids)
  '(SELECT single.single_geometry FROM (' + a + ' ) AS single)'
end

.st_buffer_st_within(geographic_item_id, distance, buffer = 0) ⇒ `String`

Parameters:

geographic_item_id (Integer)
distance (Number) —

in meters to grow/shrink the shape (negative allowed)
distance (Number) —

(in meters) (positive only?!)

Returns:

(String)

# File 'app/models/geographic_item.rb', line 237

def st_buffer_st_within(geographic_item_id, distance, buffer = 0)
  "ST_DWithin(
  ST_Buffer(#{GeographicItem::GEOGRAPHY_SQL}, #{buffer}),
  (#{select_geography_sql(geographic_item_id)}), #{distance}
 )"
end

.st_collect(geographic_item_scope) ⇒ `Object`

# File 'app/models/geographic_item.rb', line 141

def st_collect(geographic_item_scope)
  GeographicItem.select("ST_Collect(#{GeographicItem::GEOMETRY_SQL.to_sql}) as collection")
    .where(id: geographic_item_scope.pluck(:id))
end

.st_collect_sql(*geographic_item_ids) ⇒ `String`

provided via ST_Collect)

Parameters:

geographic_item_ids (Interger, Array of Integer)

Returns:

(String) —

a select query that returns a single geometry (column name ‘single_geometry’ for the collection of ids

# File 'app/models/geographic_item.rb', line 328

def st_collect_sql(*geographic_item_ids)
  geographic_item_ids.flatten!
  ActiveRecord::Base.send(:sanitize_sql_for_conditions, [
    "SELECT ST_Collect(f.the_geom) AS single_geometry
     FROM (
  SELECT (ST_DUMP(#{GeographicItem::GEOMETRY_SQL.to_sql})).geom as the_geom
  FROM geographic_items
  WHERE id in (?))
AS f", geographic_item_ids])
end

.st_multi(*geographic_item_ids) ⇒ `Scope`

example, not used

Parameters:

geographic_item_ids (Integer, Array)

Returns:

(Scope)

# File 'app/models/geographic_item.rb', line 870

def st_multi(*geographic_item_ids)
  GeographicItem.find_by_sql(
    "SELECT ST_Multi(ST_Collect(g.the_geom)) AS singlegeom
     FROM (
  SELECT (ST_DUMP(#{GeographicItem::GEOMETRY_SQL.to_sql})).geom AS the_geom
  FROM geographic_items
  WHERE id IN (?))
AS g;", geographic_item_ids.flatten
  )
end

.st_union(geographic_item_scope) ⇒ `Object`

# File 'app/models/geographic_item.rb', line 136

def st_union(geographic_item_scope)
  GeographicItem.select("ST_Union(#{GeographicItem::GEOMETRY_SQL.to_sql}) as collection")
    .where(id: geographic_item_scope.pluck(:id))
end

.where_distance_greater_than_zero(column_name, geographic_item) ⇒ `Scope`

Parameters:

(String, GeographicItem)

Returns:

(Scope)

# File 'app/models/geographic_item.rb', line 795

def where_distance_greater_than_zero(column_name, geographic_item)
  where("#{column_name} is not null and ST_Distance(#{column_name}, " \
        "GeomFromEWKT('srid=4326;#{geographic_item.geo_object}')) > 0")
end

.with_area ⇒ `Scope`

Returns adds an area_in_meters field, with meters.

Returns:

(Scope) —

adds an area_in_meters field, with meters



538
539
540

# File 'app/models/geographic_item.rb', line 538

def with_area
  select("ST_Area(#{GeographicItem::GEOGRAPHY_SQL}, false) as area_in_meters")
end

.with_collecting_event_through_georeferences ⇒ `Scope`

This uses an Arel table approach, this is ultimately more decomposable if we need. Of use:

http://danshultz.github.io/talks/mastering_activerecord_arel  <- best
https://github.com/rails/arel
http://stackoverflow.com/questions/4500629/use-arel-for-a-nested-set-join-query-and-convert-to-activerecordrelation
http://rdoc.info/github/rails/arel/Arel/SelectManager
http://stackoverflow.com/questions/7976358/activerecord-arel-or-condition

Returns:

(Scope) —

GeographicItem

# File 'app/models/geographic_item.rb', line 560

def with_collecting_event_through_georeferences
  geographic_items = GeographicItem.arel_table
  georeferences = Georeference.arel_table
  g1 = georeferences.alias('a')
  g2 = georeferences.alias('b')

  c = geographic_items.join(g1, Arel::Nodes::OuterJoin).on(geographic_items[:id].eq(g1[:geographic_item_id]))
    .join(g2, Arel::Nodes::OuterJoin).on(geographic_items[:id].eq(g2[:error_geographic_item_id]))

  GeographicItem.joins(# turn the Arel back into scope
                       c.join_sources # translate the Arel join to a join hash(?)
                      ).where(
                        g1[:id].not_eq(nil).or(g2[:id].not_eq(nil)) # returns a Arel::Nodes::Grouping
                      ).distinct
end

.with_is_valid_geometry_column(geographic_item) ⇒ `Scope`

Returns includes an ‘is_valid’ attribute (True/False) for the passed geographic_item. Uses St_IsValid.

Parameters:

geographic_item (RGeo object)

Returns:

(Scope) —

includes an ‘is_valid’ attribute (True/False) for the passed geographic_item. Uses St_IsValid.



809
810
811

# File 'app/models/geographic_item.rb', line 809

def with_is_valid_geometry_column(geographic_item)
  where(id: geographic_item.id).select("ST_IsValid(ST_AsBinary(#{geographic_item.geo_object_type})) is_valid")
end

.with_latitude ⇒ `Scope`

Returns include a ‘latitude’ column.

Returns:

(Scope) —

include a ‘latitude’ column



577
578
579

# File 'app/models/geographic_item.rb', line 577

def with_latitude
  select(lat_long_sql(:latitude))
end

.with_longitude ⇒ `Scope`

Returns include a ‘longitude’ column.

Returns:

(Scope) —

include a ‘longitude’ column



582
583
584

# File 'app/models/geographic_item.rb', line 582

def with_longitude
  select(lat_long_sql(:longitude))
end

.within_radius_of_item(geographic_item_id, distance) ⇒ `ActiveRecord::Relation`

!! should be distance, not radius?!

Parameters:

geographic_item_id (GeographicItem#id)
distance (Float) —

in meters ?!?!

Returns:

(ActiveRecord::Relation)



611
612
613

# File 'app/models/geographic_item.rb', line 611

def within_radius_of_item(geographic_item_id, distance)
  where(within_radius_of_item_sql(geographic_item_id, distance))
end

.within_radius_of_item_sql(geographic_item_id, distance) ⇒ `String`

Parameters:

geographic_item_id (Integer)
distance (Integer)

Returns:

(String)



228
229
230

# File 'app/models/geographic_item.rb', line 228

def within_radius_of_item_sql(geographic_item_id, distance)
  "ST_DWithin((#{GeographicItem::GEOGRAPHY_SQL}), (#{select_geography_sql(geographic_item_id)}), #{distance})"
end

.within_radius_of_wkt_sql(wkt, distance) ⇒ `String`

!! This is fully covering

Parameters:

wkt (String)
distance (Integer) —

(meters)

Returns:

(String)



259
260
261

# File 'app/models/geographic_item.rb', line 259

def within_radius_of_wkt_sql(wkt, distance)
  "ST_Covers( ST_Buffer(ST_SetSRID( ST_GeomFromText('#{wkt}'), 4326)::geography, #{distance}), (#{GeographicItem::GEOGRAPHY_SQL}))"
end

Instance Method Details

#align_winding ⇒ `Object` (private)

# File 'app/models/geographic_item.rb', line 1257

def align_winding
  if orientations.flatten.include?(false)
    case type
    when 'multi_polygon'
      ApplicationRecord.connection.execute(
        "UPDATE geographic_items set multi_polygon = ST_ForcePolygonCCW(multi_polygon::geometry) 
          WHERE id = #{self.id};"
       )
    when 'polygon'
     ApplicationRecord.connection.execute(
        "UPDATE geographic_items set polygon = ST_ForcePolygonCCW(polygon::geometry) 
          WHERE id = #{self.id};"
       )
    end     
  end
  true
end

#area ⇒ `Float`

TODO: share with world

Geographic item 96862 (Cajamar in Brazil) is the only(?) record to fail using `false` (quicker) method of everything we tested

Returns:

(Float) —

in meters, calculated

# File 'app/models/geographic_item.rb', line 1181

def area
  a = GeographicItem.where(id:).select("ST_Area(#{GeographicItem::GEOGRAPHY_SQL}, true) as area_in_meters").first['area_in_meters']
  a = nil if a.nan?
  a
end

#center_coords ⇒ `Array`

Returns the lat, long, as STRINGs for the centroid of this geographic item Meh- this: postgis.net/docs/en/ST_MinimumBoundingRadius.html.

Returns:

(Array) —

the lat, long, as STRINGs for the centroid of this geographic item Meh- this: postgis.net/docs/en/ST_MinimumBoundingRadius.html

# File 'app/models/geographic_item.rb', line 946

def center_coords
  r = GeographicItem.find_by_sql(
    "Select split_part(ST_AsLatLonText(ST_Centroid(#{GeographicItem::GEOMETRY_SQL.to_sql}), " \
    "'D.DDDDDD'), ' ', 1) latitude, split_part(ST_AsLatLonText(ST_Centroid" \
    "(#{GeographicItem::GEOMETRY_SQL.to_sql}), 'D.DDDDDD'), ' ', 2) " \
    "longitude from geographic_items where id = #{id};")[0]

  [r.latitude, r.longitude]
end

#centroid ⇒ `RGeo::Geographic::ProjectedPointImpl`

Returns representing the centroid of this geographic item.

Returns:

(RGeo::Geographic::ProjectedPointImpl) —

representing the centroid of this geographic item

# File 'app/models/geographic_item.rb', line 958

def centroid
  # Gis::FACTORY.point(*center_coords.reverse)
  return geo_object if type == 'GeographicItem::Point'
  return Gis::FACTORY.parse_wkt(self.st_centroid)
end

#containing_geographic_areas ⇒ `Scope`

Returns the Geographic Areas that contain (gis) this geographic item.

Returns:

(Scope) —

the Geographic Areas that contain (gis) this geographic item

# File 'app/models/geographic_item.rb', line 925

def containing_geographic_areas
  GeographicArea.joins(:geographic_items).includes(:geographic_area_type)
    .joins("JOIN (#{GeographicItem.containing(id).to_sql}) j on geographic_items.id = j.id")
end

#contains?(target_geo_object) ⇒ `Boolean`

Parameters:

(geo_object)

Returns:

(Boolean)

# File 'app/models/geographic_item.rb', line 1052

def contains?(target_geo_object)
  return nil if target_geo_object.nil?
  self.geo_object.contains?(target_geo_object)
end

#far(target_geo_object, distance) ⇒ `Boolean`

Parameters:

(geo_object, Double)

Returns:

(Boolean)



1077
1078
1079

# File 'app/models/geographic_item.rb', line 1077

def far(target_geo_object, distance)
  !near(target_geo_object, distance)
end

#geo_object ⇒ `RGeo instance`^?

Returns the Rgeo shape (See rubydoc.info/github/dazuma/rgeo/RGeo/Feature).

Returns:

(RGeo instance, nil) —

the Rgeo shape (See rubydoc.info/github/dazuma/rgeo/RGeo/Feature)

# File 'app/models/geographic_item.rb', line 1038

def geo_object
  begin
    if r = geo_object_type # rubocop:disable Lint/AssignmentInCondition
      send(r)
    else
      false
    end
  rescue RGeo::Error::InvalidGeometry
    return nil # TODO: we need to render proper error for this!
  end
end

#geo_object_type ⇒ `Symbol`

according to the list of DATA_TYPES, or nil

Returns:

(Symbol) —

the geo type (i.e. column like :point, :multipolygon). References the first-found object,

# File 'app/models/geographic_item.rb', line 1026

def geo_object_type
  if self.class.name == 'GeographicItem' # a proxy check for new records
    geo_type
  else
    self.class::SHAPE_COLUMN
  end
end

#geo_type ⇒ `Symbol` (private)

Returns the attribute (column name) containing data nearly all methods should use #geo_object_type, not geo_type

Returns:

(Symbol) —

returns the attribute (column name) containing data nearly all methods should use #geo_object_type, not geo_type

# File 'app/models/geographic_item.rb', line 1339

def geo_type
  DATA_TYPES.each { |item|
    return item if send(item)
  }
  nil
end

#geographic_name_hierarchy ⇒ `Object`

# File 'app/models/geographic_item.rb', line 917

def geographic_name_hierarchy
  a = quick_geographic_name_hierarchy # quick; almost never the case, UI not setup to do this
  return a if a.present?
  inferred_geographic_name_hierarchy # slow
end

#has_polygons? ⇒ `Boolean`

!! Unused. Doesn’t check Geometry collection

Returns:

(Boolean)



1251
1252
1253

# File 'app/models/geographic_item.rb', line 1251

def has_polygons?
  ['GeographicItem::MultiPolygon', 'GeographicItem::Polygon'].include?(self.type)
end

#inferred_geographic_name_hierarchy ⇒ `Hash`

finding the smallest area containing this GeographicItem, in the most accurate gazetteer and using it to return country/state/county. See also the logic in filling in missing levels in GeographicArea.

Returns:

(Hash) —

a geographic_name_classification (see GeographicArea) inferred by

# File 'app/models/geographic_item.rb', line 904

def inferred_geographic_name_hierarchy
  if small_area = containing_geographic_areas
    .joins(:geographic_areas_geographic_items)
    .merge(GeographicAreasGeographicItem.ordered_by_data_origin)
    .ordered_by_area
    .limit(1)
    .first
  return small_area.geographic_name_classification
  else
    {}
  end
end

#intersecting_area(geographic_item_id) ⇒ `Float`, `false`

Returns the value in square meters of the interesecting area of this and another GeographicItem.

Returns:

(Float, false) —

the value in square meters of the interesecting area of this and another GeographicItem

# File 'app/models/geographic_item.rb', line 1189

def intersecting_area(geographic_item_id)
  a = GeographicItem.aliased_geographic_sql('a')
  b = GeographicItem.aliased_geographic_sql('b')

  c = GeographicItem.connection.execute(
    "SELECT ST_Area(ST_Intersection(#{a}, #{b})) as intersecting_area
      FROM geographic_items a, geographic_items b
      WHERE a.id = #{id} AND b.id = #{geographic_item_id};"
  ).first
  c && c['intersecting_area'].to_f
end

#intersects?(target_geo_object) ⇒ `Boolean`

Parameters:

(geo_object)

Returns:

(Boolean)



1065
1066
1067

# File 'app/models/geographic_item.rb', line 1065

def intersects?(target_geo_object)
  self.geo_object.intersects?(target_geo_object)
end

#is_basic_donut? ⇒ `Boolean`

!! Does not confirm that shapes are nested !!

Returns:

(Boolean) —

Boolean looks at all orientations if they follow the pattern [true, false, … <all false>] then ‘true`, else `false`

# File 'app/models/geographic_item.rb', line 1234

def is_basic_donut?
  a = orientations
  b = a.shift
  return false unless b
  a.uniq!
  a == [false]
end

#line_string_to_a(line_string) ⇒ `Array` (private)

Returns of points in the line.

Parameters:

line_string (Reo::LineString)

Returns:

(Array) —

of points in the line

# File 'app/models/geographic_item.rb', line 1387

def line_string_to_a(line_string)
  data = []
  line_string.points.each { |point|
    data.push([point.x, point.y])
  }
  data
end

#line_string_to_hash(line_string) ⇒ `Hash` (private)

Returns of points in the line.

Parameters:

line_string (Reo::LineString)

Returns:

(Hash) —

of points in the line



1397
1398
1399

# File 'app/models/geographic_item.rb', line 1397

def line_string_to_hash(line_string)
  {lines: [line_string_to_a(line_string)]}
end

#multi_line_string_to_a(multi_line_string) ⇒ `Array` (private)

Returns of line_strings as arrays of points.

Parameters:

multi_line_string (RGeo::MultiLineString)

Returns:

(Array) —

of line_strings as arrays of points

# File 'app/models/geographic_item.rb', line 1420

def multi_line_string_to_a(multi_line_string)
  data = []
  multi_line_string.each { |line_string|
    line_data = []
    line_string.points.each { |point|
      line_data.push([point.x, point.y])
    }
    data.push(line_data)
  }
  data
end

#multi_line_string_to_hash(_multi_line_string) ⇒ `Hash` (private)

Returns of line_strings as hashes of points.

Returns:

(Hash) —

of line_strings as hashes of points



1433
1434
1435

# File 'app/models/geographic_item.rb', line 1433

def multi_line_string_to_hash(_multi_line_string)
  {lines: to_a}
end

#multi_point_to_a(multi_point) ⇒ `Array` (private)

Returns of points.

Parameters:

multi_point (RGeo::MultiPoint)

Returns:

(Array) —

of points

# File 'app/models/geographic_item.rb', line 1371

def multi_point_to_a(multi_point)
  data = []
  multi_point.each { |point|
    data.push([point.x, point.y])
  }
  data
end

#multi_point_to_hash(_multi_point) ⇒ `Hash` (private)

Returns of points.

Returns:

(Hash) —

of points

# File 'app/models/geographic_item.rb', line 1380

def multi_point_to_hash(_multi_point)
  # when we encounter a multi_point type, we only stick the points into the array, NOT it's identity as a group
  {points: multi_point_to_a(multi_point)}
end

#multi_polygon_to_a(multi_polygon) ⇒ `Array` (private)

Returns of arrays of points in the polygons (exterior_ring ONLY).

Parameters:

multi_polygon (RGeo::MultiPolygon)

Returns:

(Array) —

of arrays of points in the polygons (exterior_ring ONLY)

# File 'app/models/geographic_item.rb', line 1439

def multi_polygon_to_a(multi_polygon)
  data = []
  multi_polygon.each { |polygon|
    polygon_data = []
    polygon.exterior_ring.points.each { |point|
      polygon_data.push([point.x, point.y])
    }
    data.push(polygon_data)
  }
  data
end

#multi_polygon_to_hash(_multi_polygon) ⇒ `Hash` (private)

Returns of hashes of points in the polygons (exterior_ring ONLY).

Returns:

(Hash) —

of hashes of points in the polygons (exterior_ring ONLY)



1452
1453
1454

# File 'app/models/geographic_item.rb', line 1452

def multi_polygon_to_hash(_multi_polygon)
  {polygons: to_a}
end

#near(target_geo_object, distance) ⇒ `Boolean`

Parameters:

(geo_object, Double)

Returns:

(Boolean)



1071
1072
1073

# File 'app/models/geographic_item.rb', line 1071

def near(target_geo_object, distance)
  self.geo_object.unsafe_buffer(distance).contains?(target_geo_object)
end

#orientations ⇒ `Object`

Convention is to store in PostGIS in CCW

# File 'app/models/geographic_item.rb', line 1215

def orientations
  if multi_polygon.present?
    ApplicationRecord.connection.execute(" \
         SELECT ST_IsPolygonCCW(a.geom) as is_ccw
            FROM ( SELECT b.id, (ST_Dump(p_geom)).geom AS geom
               FROM (SELECT id, multi_polygon::geometry AS p_geom FROM geographic_items where id = #{id}) AS b \
          ) AS a;").collect{|a| a['is_ccw']}
  elsif polygon.present?
    ApplicationRecord.connection.execute("SELECT ST_IsPolygonCCW(polygon::geometry) as is_ccw \
            FROM geographic_items where  id = #{id};").collect{|a| a['is_ccw']}
  else
    []
  end
end

#point_to_a(point) ⇒ `Array` (private)

Returns of a point Longitude |, Latitude -.

Parameters:

point (RGeo::Point)

Returns:

(Array) —

of a point Longitude |, Latitude -

# File 'app/models/geographic_item.rb', line 1357

def point_to_a(point)
  data = []
  data.push(point.x, point.y)
  data
end

#point_to_hash(point) ⇒ `Hash` (private)

Returns of a point.

Parameters:

point (RGeo::Point)

Returns:

(Hash) —

of a point



1365
1366
1367

# File 'app/models/geographic_item.rb', line 1365

def point_to_hash(point)
  {points: [point_to_a(point)]}
end

#polygon_to_a(polygon) ⇒ `Array` (private)

Returns of points in the polygon (exterior_ring ONLY).

Parameters:

polygon (RGeo::Polygon)

Returns:

(Array) —

of points in the polygon (exterior_ring ONLY)

# File 'app/models/geographic_item.rb', line 1403

def polygon_to_a(polygon)
  # TODO: handle other parts of the polygon; i.e., the interior_rings (if they exist)
  data = []
  polygon.exterior_ring.points.each { |point|
    data.push([point.x, point.y])
  }
  data
end

#polygon_to_hash(polygon) ⇒ `Hash` (private)

Returns of points in the polygon (exterior_ring ONLY).

Parameters:

polygon (RGeo::Polygon)

Returns:

(Hash) —

of points in the polygon (exterior_ring ONLY)



1414
1415
1416

# File 'app/models/geographic_item.rb', line 1414

def polygon_to_hash(polygon)
  {polygons: [polygon_to_a(polygon)]}
end

#quick_geographic_name_hierarchy ⇒ `Hash`

This is a quick approach that works only when the geographic_item is linked explicitly to a GeographicArea.

!! Note that it is not impossible for a GeographicItem to be linked to > 1 GeographicArea, in that case we are assuming that all are equally refined, this might not be the case in the future because of how the GeographicArea gazetteer is indexed.

Returns:

(Hash) —

a geographic_name_classification or empty Hash

# File 'app/models/geographic_item.rb', line 891

def quick_geographic_name_hierarchy
  geographic_areas.order(:id).each do |ga|
    h = ga.geographic_name_classification # not quick enough !!
    return h if h.present?
  end
  return  {}
end

#radius ⇒ `Object`

TODO: This is bad, while internal use of ONE_WEST_MEAN is consistent it is in-accurate given the vast differences of radius vs. lat/long position. When we strike the error-polygon from radius we should remove this

Use case is returning the radius from a circle we calculated via buffer for error-polygon creation.

# File 'app/models/geographic_item.rb', line 1205

def radius
  r = ApplicationRecord.connection.execute( "SELECT ST_MinimumBoundingRadius( ST_Transform(  #{GeographicItem::GEOMETRY_SQL.to_sql}, 4326 )  ) AS radius from geographic_items where geographic_items.id = #{id}").first['radius'].split(',').last.chop.to_f
  r = (r * Utilities::Geo::ONE_WEST_MEAN).to_i
end

#rgeo_to_geo_json ⇒ `GeoJSON hash`

Returns via Rgeo apparently necessary for GeometryCollection.

Returns:

(GeoJSON hash) —

via Rgeo apparently necessary for GeometryCollection



1083
1084
1085

# File 'app/models/geographic_item.rb', line 1083

def rgeo_to_geo_json
  RGeo::GeoJSON.encode(geo_object).to_json
end

#set_cached ⇒ `Object` (private)

else

  render json: {foo: false}
end

end



1332
1333
1334

# File 'app/models/geographic_item.rb', line 1332

def set_cached
  update_column(:cached_total_area, area)
end

#set_type_if_geography_present ⇒ `Boolean`, `String` (private)

Returns false if already set, or type to which it was set.

Returns:

(Boolean, String) —

false if already set, or type to which it was set

# File 'app/models/geographic_item.rb', line 1347

def set_type_if_geography_present
  if type.blank?
    column = geo_type
    self.type = "GeographicItem::#{column.to_s.camelize}" if column
  end
end

#some_data_is_provided ⇒ `Boolean` (private)

Returns iff there is one and only one shape column set.

Returns:

(Boolean) —

iff there is one and only one shape column set

# File 'app/models/geographic_item.rb', line 1457

def some_data_is_provided
  data = []

  DATA_TYPES.each do |item|
    data.push(item) if send(item).present?
  end

  case data.count
  when 0
    errors.add(:base, 'No shape provided or provided shape is invalid')
  when 1
    return true
  else
    data.each do |object|
      errors.add(object, 'More than one shape type provided')
    end
  end
  true
end

#st_centroid ⇒ `String`

Returns a WKT POINT representing the centroid of the geographic item.

Returns:

(String) —

a WKT POINT representing the centroid of the geographic item



1013
1014
1015

# File 'app/models/geographic_item.rb', line 1013

def st_centroid
  GeographicItem.where(id: to_param).pluck(Arel.sql("ST_AsEWKT(ST_Centroid(#{GeographicItem::GEOMETRY_SQL.to_sql}))")).first.gsub(/SRID=\d*;/, '')
end

#st_distance(geographic_item_id) ⇒ `Double` Also known as: distance_to

Returns distance in meters (slower, more accurate).

Parameters:

geographic_item_id (Integer)

Returns:

(Double) —

distance in meters (slower, more accurate)

# File 'app/models/geographic_item.rb', line 966

def st_distance(geographic_item_id) # geo_object
  q1 = "ST_Distance((#{GeographicItem.select_geography_sql(id)}), " \
    "(#{GeographicItem.select_geography_sql(geographic_item_id)})) as d"
  _q2 = ActiveRecord::Base.send(:sanitize_sql_array, ['ST_Distance((?),(?)) as d',
                                                      GeographicItem.select_geography_sql(self.id),
                                                      GeographicItem.select_geography_sql(geographic_item_id)])
  deg = GeographicItem.where(id:).pluck(Arel.sql(q1)).first
  deg * Utilities::Geo::ONE_WEST
end

#st_distance_spheroid(geographic_item_id) ⇒ `Double`

Returns distance in meters (faster, less accurate).

Parameters:

geographic_item_id (Integer)

Returns:

(Double) —

distance in meters (faster, less accurate)

# File 'app/models/geographic_item.rb', line 999

def st_distance_spheroid(geographic_item_id)
  q1 = "ST_DistanceSpheroid((#{GeographicItem.select_geometry_sql(id)})," \
    "(#{GeographicItem.select_geometry_sql(geographic_item_id)}),'#{Gis::SPHEROID}') as distance"
  _q2 = ActiveRecord::Base.send(:sanitize_sql_array,
                                ['ST_DistanceSpheroid((?),(?),?) as distance',
                                 GeographicItem.select_geometry_sql(id),
                                 GeographicItem.select_geometry_sql(geographic_item_id),
                                 Gis::SPHEROID])
  # TODO: what is _q2?
  GeographicItem.where(id:).pluck(Arel.sql(q1)).first
end

#st_distance_to_geographic_item(geographic_item) ⇒ `Double`

Like st_distance but works with changed and non persisted objects

Parameters:

geographic_item (GeographicItem)

Returns:

(Double) —

distance in meters

# File 'app/models/geographic_item.rb', line 979

def st_distance_to_geographic_item(geographic_item)
  unless !persisted? || changed?
    a = "(#{GeographicItem.select_geography_sql(id)})"
  else
    a = "ST_GeographyFromText('#{geo_object}')"
  end

  unless !geographic_item.persisted? || geographic_item.changed?
    b = "(#{GeographicItem.select_geography_sql(geographic_item.id)})"
  else
    b = "ST_GeographyFromText('#{geographic_item.geo_object}')"
  end

  ActiveRecord::Base.connection.select_value("SELECT ST_Distance(#{a}, #{b})")
end

#st_isvalid ⇒ `Object`



1242
1243
1244

# File 'app/models/geographic_item.rb', line 1242

def st_isvalid
  r = ApplicationRecord.connection.execute( "SELECT ST_IsValid(  #{GeographicItem::GEOMETRY_SQL.to_sql }) from  geographic_items where geographic_items.id = #{id}").first['st_isvalid']
end

#st_isvalidreason ⇒ `Object`



1246
1247
1248

# File 'app/models/geographic_item.rb', line 1246

def st_isvalidreason
  r = ApplicationRecord.connection.execute( "SELECT ST_IsValidReason(  #{GeographicItem::GEOMETRY_SQL.to_sql }) from  geographic_items where geographic_items.id = #{id}").first['st_isvalidreason']
end

#st_npoints ⇒ `Integer`

Returns the number of points in the geometry.

Returns:

(Integer) —

the number of points in the geometry



1019
1020
1021

# File 'app/models/geographic_item.rb', line 1019

def st_npoints
  GeographicItem.where(id:).pluck(Arel.sql("ST_NPoints(#{GeographicItem::GEOMETRY_SQL.to_sql}) as npoints")).first
end

#start_point ⇒ `Array of latitude`, `longitude`

Returns the lat, lon of the first point in the GeoItem, see subclass for #st_start_point.

Returns:

(Array of latitude, longitude) —

the lat, lon of the first point in the GeoItem, see subclass for #st_start_point

# File 'app/models/geographic_item.rb', line 938

def start_point
  o = st_start_point
  [o.y, o.x]
end

#to_geo_json ⇒ `Hash`

Returns in GeoJSON format Computed via “raw” PostGIS (much faster). This requires the geo_object_type and id.

Returns:

(Hash) —

in GeoJSON format Computed via “raw” PostGIS (much faster). This requires the geo_object_type and id.

# File 'app/models/geographic_item.rb', line 1092

def to_geo_json
  JSON.parse(
    GeographicItem.connection.select_one(
      "SELECT ST_AsGeoJSON(#{geo_object_type}::geometry) a " \
      "FROM geographic_items WHERE id=#{id};")['a'])
end

#to_geo_json_feature ⇒ `Hash`

Returns the shape as a GeoJSON Feature with some item metadata.

Returns:

(Hash) —

the shape as a GeoJSON Feature with some item metadata

# File 'app/models/geographic_item.rb', line 1108

def to_geo_json_feature
  @geometry ||= to_geo_json
  {'type' => 'Feature',
   'geometry' => geometry,
   'properties' => {
     'geographic_item' => {
       'id' => id}
   }
  }
end

#to_geo_json_string ⇒ `Object`

We don’t need to serialize to/from JSON

# File 'app/models/geographic_item.rb', line 1100

def to_geo_json_string
  GeographicItem.connection.select_one(
    "SELECT ST_AsGeoJSON(#{geo_object_type}::geometry) a " \
    "FROM geographic_items WHERE id=#{id};")['a']
end

#to_wkt ⇒ `String`

Returns:

(String)

# File 'app/models/geographic_item.rb', line 1166

def to_wkt
  #  10k  #<Benchmark::Tms:0x00007fb0dfd30fd0 @label="", @real=25.237487000005785, @cstime=0.0, @cutime=0.0, @stime=1.1704609999999995, @utime=5.507929999999988, @total=6.678390999999987>
  #  GeographicItem.select("ST_AsText( #{GeographicItem::GEOMETRY_SQL.to_sql}) wkt").where(id: id).first.wkt

  # 10k <Benchmark::Tms:0x00007fb0e02f7540 @label="", @real=21.619827999995323, @cstime=0.0, @cutime=0.0, @stime=0.8850890000000007, @utime=3.2958549999999605, @total=4.180943999999961>
  if a =  ApplicationRecord.connection.execute( "SELECT ST_AsText( #{GeographicItem::GEOMETRY_SQL.to_sql} ) wkt from geographic_items where geographic_items.id = #{id}").first
    return a['wkt']
  else
    return nil
  end
end

#valid_geometry? ⇒ `Boolean`

Returns whether stored shape is ST_IsValid.

Returns:

(Boolean) —

whether stored shape is ST_IsValid



932
933
934

# File 'app/models/geographic_item.rb', line 932

def valid_geometry?
  GeographicItem.with_is_valid_geometry_column(self).first['is_valid']
end

#within?(target_geo_object) ⇒ `Boolean`

Parameters:

(geo_object)

Returns:

(Boolean)



1059
1060
1061

# File 'app/models/geographic_item.rb', line 1059

def within?(target_geo_object)
  self.geo_object.within?(target_geo_object)
end

Class: GeographicItem

Overview

Direct Known Subclasses

Defined Under Namespace

Constant Summary collapse

Instance Attribute Summary collapse

Attributes included from Housekeeping::Users

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Shared::IsData

Methods included from Shared::HasPapertrail

Methods included from Housekeeping::Timestamps

Methods included from Housekeeping::Users

Methods inherited from ApplicationRecord

Instance Attribute Details

#cached_total_area ⇒ Numeric

#geometry ⇒ Hash?

#line_string ⇒ RGeo::Geographic::ProjectedLineStringImpl

#multi_line_string ⇒ RGeo::Geographic::ProjectedMultiLineStringImpl

#multi_point ⇒ RGeo::Geographic::ProjectedMultiPointImpl

#multi_polygon ⇒ RGeo::Geographic::ProjectedMultiPolygonImpl

#no_cached ⇒ Boolean

#point ⇒ RGeo::Geographic::ProjectedPointImpl

#polygon ⇒ RGeo::Geographic::ProjectedPolygonImpl

#shape ⇒ Boolean, RGeo object

#type ⇒ String

Class Method Details

.aliased_geographic_sql(name = 'a') ⇒ Object

.are_contained_in_item(column_name, *geographic_items) ⇒ Scope

.are_contained_in_item_by_id(column_name, *geographic_item_ids) ⇒ Scope

.are_contained_in_wkt(column_name, geometry) ⇒ Scope

.contained_by(*geographic_item_ids) ⇒ Scope

.contained_by_where_sql(*geographic_item_ids) ⇒ String

.contained_by_with_antimeridian_check(*ids) ⇒ Array

.contained_by_wkt_shifted_sql(wkt) ⇒ String

.contained_by_wkt_sql(wkt) ⇒ String

.containing(*geographic_item_ids) ⇒ Scope

.containing_point(rgeo_point) ⇒ Scope

.containing_sql(target_column_name = nil, geographic_item_id = nil, source_column_name = nil) ⇒ String

.containing_where_for_point_sql(rgeo_point) ⇒ String

.containing_where_sql(*geographic_item_ids) ⇒ String

.containing_where_sql_geog(*geographic_item_ids) ⇒ String

.crosses_anti_meridian?(wkt) ⇒ Boolean

.crosses_anti_meridian_by_id?(*ids) ⇒ Boolean

.debug_draw(geographic_item_ids = []) ⇒ Object (private)

.default_by_geographic_area_ids(geographic_area_ids = []) ⇒ GeographicItem::ActiveRecord_Relation

.disjoint_from(column_name, *geographic_items) ⇒ Scope

.distance_between(geographic_item_id1, geographic_item_id2) ⇒ Float

.eval_for_type(type_name) ⇒ String

.geometry_for(geographic_item_id) ⇒ RGeo::Geographic object

.geometry_for_collection_sql(*geographic_item_ids) ⇒ String

.geometry_for_sql(geographic_item_id) ⇒ String

.geometry_sql(geographic_item_id = nil, source_column_name = nil) ⇒ String

.geometry_sql2(*geographic_item_ids) ⇒ String

.intersecting(column_name, *geographic_items) ⇒ Scope

.intersecting_radius_of_wkt_sql(wkt, distance) ⇒ String

.is_contained_by(column_name, *geographic_items) ⇒ Scope

.is_contained_by_sql(column_name, geographic_item) ⇒ String

.lat_long_sql(choice) ⇒ String

.not_including(geographic_items) ⇒ Scope

.ordered_by_longest_distance_from(column_name, geographic_item) ⇒ Scope

.ordered_by_shortest_distance_from(column_name, geographic_item) ⇒ Scope

.point_inferred_geographic_name_hierarchy(point) ⇒ Hash

.reverse_containing_sql(target_column_name = nil, geographic_item_id = nil, source_column_name = nil) ⇒ String

.select_distance_with_geo_object(column_name, geographic_item) ⇒ String

.select_geography_sql(geographic_item_id) ⇒ String

.select_geometry_sql(geographic_item_id) ⇒ String

.single_geometry_sql(*geographic_item_ids) ⇒ String

.st_buffer_st_within(geographic_item_id, distance, buffer = 0) ⇒ String

.st_collect(geographic_item_scope) ⇒ Object

.st_collect_sql(*geographic_item_ids) ⇒ String

.st_multi(*geographic_item_ids) ⇒ Scope

.st_union(geographic_item_scope) ⇒ Object

.where_distance_greater_than_zero(column_name, geographic_item) ⇒ Scope

.with_area ⇒ Scope

.with_collecting_event_through_georeferences ⇒ Scope

.with_is_valid_geometry_column(geographic_item) ⇒ Scope

.with_latitude ⇒ Scope

.with_longitude ⇒ Scope

.within_radius_of_item(geographic_item_id, distance) ⇒ ActiveRecord::Relation

#cached_total_area ⇒ `Numeric`

#geometry ⇒ `Hash`^?

#line_string ⇒ `RGeo::Geographic::ProjectedLineStringImpl`

#multi_line_string ⇒ `RGeo::Geographic::ProjectedMultiLineStringImpl`

#multi_point ⇒ `RGeo::Geographic::ProjectedMultiPointImpl`

#multi_polygon ⇒ `RGeo::Geographic::ProjectedMultiPolygonImpl`

#no_cached ⇒ `Boolean`

#point ⇒ `RGeo::Geographic::ProjectedPointImpl`

#polygon ⇒ `RGeo::Geographic::ProjectedPolygonImpl`

#shape ⇒ `Boolean`, `RGeo object`

#type ⇒ `String`

.aliased_geographic_sql(name = 'a') ⇒ `Object`

.are_contained_in_item(column_name, *geographic_items) ⇒ `Scope`

.are_contained_in_item_by_id(column_name, *geographic_item_ids) ⇒ `Scope`

.are_contained_in_wkt(column_name, geometry) ⇒ `Scope`

.contained_by(*geographic_item_ids) ⇒ `Scope`

.contained_by_where_sql(*geographic_item_ids) ⇒ `String`

.contained_by_with_antimeridian_check(*ids) ⇒ `Array`

.contained_by_wkt_shifted_sql(wkt) ⇒ `String`

.contained_by_wkt_sql(wkt) ⇒ `String`

.containing(*geographic_item_ids) ⇒ `Scope`

.containing_point(rgeo_point) ⇒ `Scope`

.containing_sql(target_column_name = nil, geographic_item_id = nil, source_column_name = nil) ⇒ `String`

.containing_where_for_point_sql(rgeo_point) ⇒ `String`

.containing_where_sql(*geographic_item_ids) ⇒ `String`

.containing_where_sql_geog(*geographic_item_ids) ⇒ `String`

.crosses_anti_meridian?(wkt) ⇒ `Boolean`

.crosses_anti_meridian_by_id?(*ids) ⇒ `Boolean`

.debug_draw(geographic_item_ids = []) ⇒ `Object` (private)

.default_by_geographic_area_ids(geographic_area_ids = []) ⇒ `GeographicItem::ActiveRecord_Relation`

.disjoint_from(column_name, *geographic_items) ⇒ `Scope`

.distance_between(geographic_item_id1, geographic_item_id2) ⇒ `Float`

.eval_for_type(type_name) ⇒ `String`

.geometry_for(geographic_item_id) ⇒ `RGeo::Geographic object`

.geometry_for_collection_sql(*geographic_item_ids) ⇒ `String`

.geometry_for_sql(geographic_item_id) ⇒ `String`

.geometry_sql(geographic_item_id = nil, source_column_name = nil) ⇒ `String`

.geometry_sql2(*geographic_item_ids) ⇒ `String`

.intersecting(column_name, *geographic_items) ⇒ `Scope`

.intersecting_radius_of_wkt_sql(wkt, distance) ⇒ `String`

.is_contained_by(column_name, *geographic_items) ⇒ `Scope`

.is_contained_by_sql(column_name, geographic_item) ⇒ `String`

.lat_long_sql(choice) ⇒ `String`

.not_including(geographic_items) ⇒ `Scope`

.ordered_by_longest_distance_from(column_name, geographic_item) ⇒ `Scope`

.ordered_by_shortest_distance_from(column_name, geographic_item) ⇒ `Scope`

.point_inferred_geographic_name_hierarchy(point) ⇒ `Hash`

.reverse_containing_sql(target_column_name = nil, geographic_item_id = nil, source_column_name = nil) ⇒ `String`

.select_distance_with_geo_object(column_name, geographic_item) ⇒ `String`

.select_geography_sql(geographic_item_id) ⇒ `String`

.select_geometry_sql(geographic_item_id) ⇒ `String`

.single_geometry_sql(*geographic_item_ids) ⇒ `String`

.st_buffer_st_within(geographic_item_id, distance, buffer = 0) ⇒ `String`

.st_collect(geographic_item_scope) ⇒ `Object`

.st_collect_sql(*geographic_item_ids) ⇒ `String`

.st_multi(*geographic_item_ids) ⇒ `Scope`

.st_union(geographic_item_scope) ⇒ `Object`

.where_distance_greater_than_zero(column_name, geographic_item) ⇒ `Scope`

.with_area ⇒ `Scope`

.with_collecting_event_through_georeferences ⇒ `Scope`

.with_is_valid_geometry_column(geographic_item) ⇒ `Scope`

.with_latitude ⇒ `Scope`

.with_longitude ⇒ `Scope`

.within_radius_of_item(geographic_item_id, distance) ⇒ `ActiveRecord::Relation`

.within_radius_of_item_sql(geographic_item_id, distance) ⇒ `String`

.within_radius_of_wkt_sql(wkt, distance) ⇒ `String`

#align_winding ⇒ `Object` (private)

#area ⇒ `Float`

#center_coords ⇒ `Array`

#centroid ⇒ `RGeo::Geographic::ProjectedPointImpl`

#containing_geographic_areas ⇒ `Scope`

#contains?(target_geo_object) ⇒ `Boolean`

#far(target_geo_object, distance) ⇒ `Boolean`

#geo_object ⇒ `RGeo instance`^?

#geo_object_type ⇒ `Symbol`

#geo_type ⇒ `Symbol` (private)

#geographic_name_hierarchy ⇒ `Object`

#has_polygons? ⇒ `Boolean`

#inferred_geographic_name_hierarchy ⇒ `Hash`

#intersecting_area(geographic_item_id) ⇒ `Float`, `false`