separates the geojson attribute from geojson representations #50

- #geojson and #geojson= are used for reading / changing the geometry
- #as_geojson(...) to be used to get a geojson representation (optionally of
  the whole record or only including selected attributes)
- adds geojson conversion methods for scopes and issue arrays #50

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(simple: true)
+        api.geojson issue.geojson
       else
         api.geojson ""
       end

app/views/issues/index/_map.html.erb

@@ -1,19 +1,9 @@
-<% return '' if @project.nil? %>
-<% return '' unless User.current.allowed_to?(:view_issues, @project) %>
+<% if @project and @project.module_enabled?(:gtt) %>
 
-<% if @project.nil? or @project.module_enabled?(:gtt) %>
 <fieldset id="location" class="collapsible">
   <legend onclick="toggleFieldset(this);"><%= l(:field_location) %></legend>
 
-  <%= tag(:div, :data => {
-      # TODO: Don't know where to extend "Issues"
-      :geom => IssuesHelper.get_geojson(@issues),
-      :bounds => @project.geojson,
-      :layers => @project.gtt_tile_sources,
-      :popup => {
-        :href => '/issues/[id]'
-      }
-    }, :id => 'ol-' + rand(36**8).to_s(36), :class => 'ol-map')
-  %>
+  <%= map_tag map: @project.map, geom: Issue.array_to_geojson(@issues, include_properties: { only: %i(id subject) }), popup: { href: '/issues/[id]' } %>
 </fieldset>
+
 <% end %>

app/views/issues/show.api.rsb

@@ -24,7 +24,7 @@ api.issue do
   end
 
   if @issue.geom
-    api.geojson @issue.geojson(simple: true)
+    api.geojson @issue.geojson
   else
     api.geojson ""
   end

app/views/projects/index.api.rsb

@@ -10,7 +10,7 @@ api.array :projects, api_meta(:total_count => @project_count, :offset => @offset
       api.is_public   project.is_public?
 
       if project.geom
-        api.geojson project.geojson(simple: true)
+        api.geojson project.geojson
       else
         api.geojson ""
       end

app/views/projects/show.api.rsb

@@ -9,7 +9,7 @@ api.project do
   api.is_public   @project.is_public?
 
   if @project.geom
-    api.geojson @project.geojson(simple: true)
+    api.geojson @project.geojson
   else
     api.geojson ""
   end

app/views/users/index.api.rsb

@@ -10,7 +10,7 @@ api.array :users, api_meta(:total_count => @user_count, :offset => @offset, :lim
       api.last_login_on user.last_login_on
 
       if user.geom
-        api.geojson user.geojson(simple: true)
+        api.geojson user.geojson
       else
         api.geojson ""
       end

app/views/users/show.api.rsb

@@ -10,7 +10,7 @@ api.user do
   api.status     @user.status if User.current.admin?
 
   if @user.geom
-    api.geojson @user.geojson(simple: true)
+    api.geojson @user.geojson
   else
     api.geojson ""
   end

lib/redmine_gtt/conversions.rb

@@ -9,14 +9,36 @@ module RedmineGtt
   # between.
   module Conversions
 
+    class WkbToJson
+      def initialize()
+        @factory = RGeo::GeoJSON::EntityFactory.instance
+        @parser = RGeo::WKRep::WKBParser.new(
+          support_ewkb: true,
+          default_srid: 4326
+        )
+      end
+
+      def to_json(wkb, id: nil, properties: nil)
+        RGeo::GeoJSON.encode feature(wkb, id, properties)
+      end
+
+      def collection_to_json(data)
+        RGeo::GeoJSON.encode @factory.feature_collection(
+          data.map{|wkb, id, props| feature wkb, id, props}
+        )
+      end
+
+      private
+
+      def feature(wkb, id, properties = nil)
+        @factory.feature @parser.parse(wkb), id, (properties || {})
+      end
+
+    end
+
     # Turns database WKB into geometry attribute string
-    def self.wkb_to_json(wkb, id: nil, properties: {})
-      factory = RGeo::GeoJSON::EntityFactory.instance
-      geometry = RGeo::WKRep::WKBParser.new(
-        support_ewkb: true,
-        default_srid: 4326
-      ).parse(wkb)
-      RGeo::GeoJSON.encode factory.feature(geometry, id, properties)
+    def self.wkb_to_json(wkb, id: nil, properties: nil)
+      WkbToJson.new.to_json(wkb, id: id, properties: properties)
     end
 
     # Turn geometry attribute string into WKB for database use

lib/redmine_gtt/patches/geojson_attribute.rb

@@ -4,21 +4,55 @@ module Patches
     # adds wkb/geojson conversion logic to the class it's included in
     module GeojsonAttribute
 
-      def geojson_additional_properties
-        as_json except: [:geom]
+      def self.prepended(base)
+        base.extend ClassMethods
+        base.class_eval do
+          scope :geojson, ->(include_properties: false){
+            data = []
+            where.not(geom: nil).
+              find_in_batches.each{|group| group.each{|o|
+                data << o.geojson_params(include_properties)
+              }}
+            Conversions::WkbToJson.new.collection_to_json data
+          }
+        end
       end
 
-      # use simple: true to skip inclusion of record's properties
-      def geojson(simple: false)
-        @geojson ||= if geom.present?
-          Conversions.wkb_to_json(
-            geom,
-            id: id,
-            properties: (simple ? {} : geojson_additional_properties)
+      module ClassMethods
+        def array_to_geojson(array, include_properties: false)
+          Conversions::WkbToJson.new.collection_to_json(
+            array.map{ |o|
+              o.geojson_params(include_properties) if o.geom
+            }.compact
           )
         end
       end
 
+      def geojson_additional_properties(include_properties = false)
+        case include_properties
+        when Hash
+          if only = include_properties[:only]
+            as_json only: only
+          else
+            except = include_properties[:except] || []
+            except << :geom
+            as_json except: except
+          end
+        when TrueClass
+          as_json except: [:geom]
+        else
+          {}
+        end
+      end
+
+      # returns the geojson attribute for reading / writing to the DB
+      def geojson
+        @geojson ||= if geom.present?
+          Conversions.wkb_to_json geom
+        end
+      end
+
+      # sets the geojson attribute for reading / writing to the DB
       def geojson=(geometry)
         @geojson = geometry
         if (geometry.present?)
@@ -28,6 +62,29 @@ def geojson=(geometry)
         end
       end
 
+      # returns a GeoJSON representation of this record.
+      #
+      # Use include_properties: true to include all of the record's properties
+      # use include_properties: { only: [ :id, :subject ] } for a specific
+      # subset of properties
+      #
+      # Use this method and not #geojson for rendering maps
+      def as_geojson(include_properties: false)
+        return geojson unless include_properties
+
+        if geom.present?
+          Conversions.wkb_to_json(
+            geom,
+            id: id,
+            properties: geojson_additional_properties(include_properties)
+          )
+        end
+      end
+
+      def geojson_params(include_properties)
+        [ geom, id, geojson_additional_properties(include_properties) ]
+      end
+
     end
   end
 end

lib/redmine_gtt/patches/issue_patch.rb

@@ -18,8 +18,9 @@ def self.apply
       end
 
       def map
-        GttMap.new json: geojson, layers: project.gtt_tile_sources,
-          bounds: (new_record? ? project.map.json : geojson(simple: true))
+        json = as_geojson
+        GttMap.new json: json, layers: project.gtt_tile_sources,
+          bounds: (new_record? ? project.map.json : json)
       end
 
     end