refactoring - removes triplicate wkb/json conversion code #50

Author: jkraemer

lib/redmine_gtt/conversions.rb

@@ -0,0 +1,38 @@
+module RedmineGtt
+
+  # for some reason these conversions are not reversible, i.e. when I try to
+  # convert from json to wkb and back to json I get
+  #
+  # RGeo::Error::ParseError: Bad endian byte value: 123
+  #
+  # It appears to work when the wkb gets written to / read from database in
+  # between.
+  module Conversions
+
+    # 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)
+    end
+
+    # Turn geometry attribute string into WKB for database use
+    def self.to_wkb(geometry)
+      geojson = JSON.parse(geometry)
+      feature = RGeo::GeoJSON.decode(geojson, json_parser: :json)
+      ewkb = RGeo::WKRep::WKBGenerator.new(
+        type_format: :ewkb,
+        emit_ewkb_srid: true,
+        hex_format: true
+      )
+      ewkb.generate feature.geometry
+    rescue JSON::ParserError
+      # The Gemetry is likely to be already in WKB format
+      geometry
+    end
+
+  end
+end

lib/redmine_gtt/patches/geojson_attribute.rb

@@ -0,0 +1,29 @@
+module RedmineGtt
+  module Patches
+
+    # adds wkb/geojson conversion logic to the class it's included in
+    module GeojsonAttribute
+
+      def geojson_additional_properties
+        as_json except: [:geom]
+      end
+
+      def geojson
+        if geom.present?
+          Conversions.wkb_to_json(
+            geom, id: id, properties: geojson_additional_properties
+          )
+        end
+      end
+
+      def geom=(geometry)
+        if (geometry.present?)
+          self[:geom] = Conversions.to_wkb geometry
+        else
+          self[:geom] = nil
+        end
+      end
+
+    end
+  end
+end

lib/redmine_gtt/patches/issue_patch.rb

@@ -6,41 +6,14 @@ module IssuePatch
       def self.apply
         unless Issue < self
           Issue.prepend self
+          Issue.prepend GeojsonAttribute
           Issue.class_eval do
             safe_attributes "geom",
               if: ->(issue, user){ user.allowed_to?(:edit_issues, issue.project)}
           end
         end
       end
 
-      def geojson
-        unless self.geom.nil?
-          factory = RGeo::GeoJSON::EntityFactory.instance
-          wkb = RGeo::WKRep::WKBParser.new().parse(self.geom)
-          RGeo::GeoJSON.encode factory.feature(wkb, self.id, self.as_json)
-        else
-          nil
-        end
-      end
-
-      def geom=(g)
-        # Turn geometry attribute into WKB for database use
-        if (g.present?)
-          begin
-            geojson = JSON.parse(g)
-            feature = RGeo::GeoJSON.decode(geojson, json_parser: :json)
-            wkb = RGeo::WKRep::WKBGenerator.new(
-              :hex_format => true
-            )
-            self[:geom] = wkb.generate(feature.geometry)
-          rescue
-            # The Gemetry is likely to be already in WKB format
-            self[:geom] = g
-          end
-        else
-          self[:geom] = nil
-        end
-      end
     end
 
   end

lib/redmine_gtt/patches/project_patch.rb

@@ -2,9 +2,11 @@ module RedmineGtt
   module Patches
 
     module ProjectPatch
+
       def self.apply
         unless Project < self
           Project.prepend self
+          Project.prepend GeojsonAttribute
           Project.class_eval do
             safe_attributes "geom"
             has_and_belongs_to_many :gtt_tile_sources
@@ -13,37 +15,6 @@ def self.apply
         end
       end
 
-      def geojson
-        unless self.geom.nil?
-          factory = RGeo::GeoJSON::EntityFactory.instance
-          wkb = RGeo::WKRep::WKBParser.new(
-            :support_ewkb => true,
-            :default_srid => 4326
-          ).parse(self.geom)
-          properties = self.as_json({except: [ :geom ]})
-          RGeo::GeoJSON.encode factory.feature(wkb, self.id, properties)
-        else
-          nil
-        end
-      end
-
-      def geom=(g)
-        # Turn geometry attribute into WKB for database use
-        if (g.present?)
-          geojson = JSON.parse(g)
-          feature = RGeo::GeoJSON.decode(geojson, json_parser: :json)
-
-          ewkb = RGeo::WKRep::WKBGenerator.new(
-            :type_format => :ewkb,
-            :emit_ewkb_srid => true,
-            :hex_format => true
-          )
-          self[:geom] = ewkb.generate(feature.geometry)
-        else
-          self[:geom] = nil
-        end
-      end
-
       def enabled_module_names=(*_)
         super
         set_default_tile_sources
@@ -57,6 +28,7 @@ def set_default_tile_sources
       private :set_default_tile_sources
 
     end
+
   end
 end
 

lib/redmine_gtt/patches/user_patch.rb

@@ -4,45 +4,19 @@ module Patches
     module UserPatch
       def self.apply
         unless User < self
-          User.prepend self 
+          User.prepend GeojsonAttribute
+          User.prepend self
           User.class_eval do
             safe_attributes "geom"
           end
         end
       end
 
-      def geojson
-        unless self.geom.nil?
-          factory = RGeo::GeoJSON::EntityFactory.instance
-          wkb = RGeo::WKRep::WKBParser.new(
-            :support_ewkb => true,
-            :default_srid => 4326
-          ).parse(self.geom)
-          properties = self.as_json({except: [
-            :hashed_password, :hashed_password, :salt, :must_change_passwd,
-            :passwd_changed_on, :auth_source_id, :geom
-          ]})
-          RGeo::GeoJSON.encode factory.feature(wkb, self.id, properties)
-        else
-          nil
-        end
-      end
-
-      def geom=(g)
-        # Turn geometry attribute into WKB for database use
-        if (g.present?)
-          geojson = JSON.parse(g)
-          feature = RGeo::GeoJSON.decode(geojson, json_parser: :json)
-
-          ewkb = RGeo::WKRep::WKBGenerator.new(
-            :type_format => :ewkb,
-            :emit_ewkb_srid => true,
-            :hex_format => true
-          )
-          self[:geom] = ewkb.generate(feature.geometry)
-        else
-          self[:geom] = nil
-        end
+      def geojson_additional_properties
+        as_json except: %i(
+          hashed_password hashed_password salt must_change_passwd
+          passwd_changed_on auth_source_id geom
+        )
       end
 
     end