projects API: use ?include=geometry to get the geojson #94

- also: use ST_AsGeoJson(geom) to let the DB do the to-JSON conversion,
hoping that this is faster than RGeo. I also integrated that into the
issues API.

Author: jkraemer

app/views/issues/index.api.rsb

@@ -21,7 +21,7 @@ api.array :issues, api_meta(:total_count => @issue_count, :offset => @offset, :l
       api.estimated_hours issue.estimated_hours
 
       if issue.geom
-        api.geojson issue.geojson
+        api.geojson issue.geojson.to_json
       else
         api.geojson ""
       end

app/views/projects/index.api.rsb

@@ -9,10 +9,12 @@ api.array :projects, api_meta(:total_count => @project_count, :offset => @offset
       api.status      project.status
       api.is_public   project.is_public?
 
-      if project.geom
-        api.geojson project.geojson
-      else
-        api.geojson ""
+      if @include_geometry
+        if project.geom
+          api.geojson project.geojson.to_json
+        else
+          api.geojson ""
+        end
       end
 
       render_api_custom_values project.visible_custom_field_values, api

lib/redmine_gtt/conversions.rb

@@ -48,6 +48,14 @@ def call(wkb)
       end
     end
 
+    def self.to_feature(geometry, properties: {})
+      geometry = JSON.parse geometry if geometry.is_a?(String)
+      {
+        'type' => 'Feature',
+        'geometry' => geometry,
+        'properties' => properties
+      }
+    end
 
     # Turns database WKB into geometry attribute string
     def self.wkb_to_json(wkb, id: nil, properties: nil)

lib/redmine_gtt/patches/geojson_attribute.rb

@@ -7,18 +7,26 @@ module GeojsonAttribute
       def self.prepended(base)
         base.extend ClassMethods
         base.class_eval do
+          # if this wouldnt break count, this would be really nice:
+          #default_scope ->{ select "#{table_name}.*, ST_AsGeoJson(#{table_name}.geom) as geojson" }
           scope :geojson, ->(include_properties: false){
             data = []
             where.not(geom: nil).
-              find_in_batches.each{|group| group.each{|o|
+              select("#{table_name}.*, #{geojson_attribute_select}").
+              find_each{|o|
                 data << o.geojson_params(include_properties)
-              }}
+              }
             Conversions::GeomToJson.new.collection_to_json data
           }
         end
       end
 
       module ClassMethods
+
+        def geojson_attribute_select
+          "ST_AsGeoJson(#{table_name}.geom) as db_geojson"
+        end
+
         def array_to_geojson(array, include_properties: false)
           Conversions::GeomToJson.new.collection_to_json(
             array.map{ |o|
@@ -47,9 +55,12 @@ def geojson_additional_properties(include_properties = false)
 
       # returns the geojson attribute for reading / writing to the DB
       def geojson
-        @geojson ||= if geom.present?
-          Conversions.geom_to_json geom
-        end
+        @geojson ||= if respond_to?(:db_geojson) && db_geojson.present?
+                       # use the value returned by ST_AsGeoJson
+                       Conversions.to_feature db_geojson
+                     elsif geom.present?
+                       Conversions.geom_to_json geom
+                     end
       end
 
       # sets the geojson attribute for reading / writing to the DB

lib/redmine_gtt/patches/issue_patch.rb

@@ -7,13 +7,15 @@ def self.apply
         unless Issue < self
           Issue.prepend self
           Issue.prepend GeojsonAttribute
+          Issue.extend ClassMethods
           Issue.class_eval do
             attr_reader :distance
             safe_attributes "geojson",
               if: ->(issue, user){
                 perm = issue.new_record? ? :add_issues : :edit_issues
                 user.allowed_to? perm, issue.project
               }
+
           end
         end
       end
@@ -24,6 +26,23 @@ def map
           bounds: (new_record? ? project.map.json : json)
       end
 
+      module ClassMethods
+        def load_geojson(issues)
+          if issues.any?
+            geometries_by_id = Hash[
+              Issue.
+              where(id: issues.map(&:id)).
+              pluck(:id, Issue.geojson_attribute_select)
+            ]
+            issues.each do |issue|
+              issue.instance_variable_set(
+                "@geojson", Conversions.to_feature(geometries_by_id[issue.id])
+              )
+            end
+          end
+        end
+      end
+
     end
 
   end

lib/redmine_gtt/patches/issue_query_patch.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RedmineGtt
   module Patches
     module IssueQueryPatch
@@ -13,6 +15,9 @@ def self.prepended(base)
 
       def issues(*_)
         super.tap do |issues|
+          if load_geojson? || has_column?(:geom)
+            Issue.load_geojson(issues)
+          end
           if center = find_center_point
             load_distances(issues, center)
           end
@@ -21,6 +26,13 @@ def issues(*_)
         raise ::Query::StatementInvalid.new(e.message)
       end
 
+      def load_geojson
+        @load_geojson = true
+      end
+      def load_geojson?
+        !!@load_geojson
+      end
+
       def available_columns
         return @available_columns if @available_columns
 
@@ -75,7 +87,7 @@ def sql_for_distance_field(field, operator, value)
           # or ['meters_min', 'meters_max', 'lng', 'lat'] if op == '><'
           lng, lat = value.last(2).map(&:to_f)
           distance = value.first.to_i
-          sql = "ST_Distance_Sphere(#{Issue.table_name}.geom, ST_GeomFromText('POINT(#{lng} #{lat})',4326))"
+          sql = +"ST_Distance_Sphere(#{Issue.table_name}.geom, ST_GeomFromText('POINT(#{lng} #{lat})',4326))"
           if operator == '><'
             distance_max = value[1].to_i
             sql << " BETWEEN #{distance} AND #{distance_max}"

lib/redmine_gtt/patches/issues_controller_patch.rb

@@ -22,6 +22,11 @@ def show
         end
       end
 
+      def retrieve_query(*_)
+        return @query if @query
+        super
+      end
+      private :retrieve_query
 
       def index
         retrieve_query
@@ -36,6 +41,7 @@ def index
                 :filename => "issues.geojson"
               )
             }
+            format.api { @query.load_geojson; super }
             format.any { super }
           end
         else

lib/redmine_gtt/patches/projects_controller_patch.rb

@@ -10,11 +10,14 @@ def self.apply
       def index
         respond_to do |format|
           format.api {
-            scope = RedmineGtt::SpatialProjectsQuery.new(
+            @include_geometry = params[:include] == 'geometry'
+            query = RedmineGtt::SpatialProjectsQuery.new(
               contains: params[:contains],
+              geometry: @include_geometry,
               projects: Project.visible.sorted
-            ).scope
-            @project_count = scope.count
+            )
+            scope = query.scope
+            @project_count = query.count
             @offset, @limit = api_offset_and_limit
             @projects = scope.offset(@offset).limit(@limit).to_a
           }

lib/redmine_gtt/spatial_projects_query.rb

@@ -1,22 +1,43 @@
+# frozen_string_literal: true
+
 module RedmineGtt
   class SpatialProjectsQuery
-    def initialize(contains: nil, projects: Project.active.visible)
+    def initialize(contains: nil, projects: Project.active.visible, geometry: true)
       @contains = contains.presence
       @projects = projects
+      @include_geometry = geometry
     end
 
-    QUERY_SQL = (<<-SQL
+    QUERY_SQL = <<-SQL
       #{Project.table_name}.geom IS NOT NULL AND
       ST_Intersects(#{Project.table_name}.geom, ST_GeomFromText('%s', 4326))
     SQL
-                ).freeze
+
+    VIRTUAL_GEOJSON_ATTRIBUTE_SELECT = <<-SQL
+      #{Project.table_name}.*, #{Project.geojson_attribute_select}
+    SQL
+
+    def count
+      # we have to pass :all, otherwise we hit this rails issue due to the
+      # select call in build_scope: https://github.com/rails/rails/issues/15138
+      scope.count :all
+    end
 
     def scope
+      @scope ||= build_scope
+    end
+
+    private
+
+    def build_scope
       if @contains
         @projects = @projects.where(
           Project.send(:sanitize_sql_array, [ QUERY_SQL, @contains ])
         )
       end
+      if @include_geometry
+        @projects = @projects.select VIRTUAL_GEOJSON_ATTRIBUTE_SELECT
+      end
       @projects
     end
 

test/integration/projects_api_test.rb

@@ -47,9 +47,39 @@ class ProjectsApiTest < Redmine::IntegrationTest
     assert projects = xml.xpath('/projects/project')
     assert_equal 1, projects.size, xml.to_s
     assert_equal 'ecookbook', projects.xpath('identifier').text
+    assert_equal 0, projects.xpath('geojson').size, projects.to_s
 
   end
 
+  test 'should include geojson on demand' do
+    geo = {
+      'type' => 'Feature',
+      'geometry' => {
+        'type' => 'Polygon',
+        'coordinates' => [
+          [[123.269691,9.305099], [123.279691,9.305099],[123.279691,9.405099],[123.269691,9.405099], [123.269691,9.305099]]
+        ]
+      }
+    }
+    geojson = geo.to_json
+
+    @project.update_attribute :geojson, geojson
+    get '/projects.xml?include=geometry'
+    assert_response :success
+    xml = xml_data
+    assert projects = xml.xpath('/projects/project')
+    assert json = projects.xpath('geojson').text
+    assert json.present?
+    assert_match(/123\.269691/, json)
+    assert_equal geo['geometry'], JSON.parse(json)['geometry'], json
+
+    get '/projects.json?include=geometry'
+    assert_response :success
+    assert json = JSON.parse(@response.body)
+    hsh = JSON.parse json['projects'].detect{|p|p['id'] == @project.id}['geojson']
+    assert_equal geo['geometry'], hsh['geometry']
+  end
+
   def xml_data
     Nokogiri::XML(@response.body)
   end