geojson-diff 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fc1a1694621504685cf1d34a82bca93fc9e7716f
+  data.tar.gz: d62ceaf8a1ce1eb84c6737c139d594b144fe6b15
+SHA512:
+  metadata.gz: 676f81f290083fbb5b2870e23c42156c4774a03c8a59a90cfaa4b13ed180258f76f390ed3df0e1dc071d8a77e46b80e7c6d4cd5ddeadd21f885afc40d13fb326
+  data.tar.gz: e201fdb7c6897c8f3985757a98d40aa4830967eba25759b03fab89b05b8f16994fe31e966f6469297616dd3a6ff7838a329968fed2b1e2f09eaff42d8ee645d1

data/lib/geojson-diff.rb

@@ -0,0 +1,163 @@
+require 'rgeo'
+require 'rgeo/geo_json'
+require 'diffy'
+require 'json'
+require_relative 'rgeo/geojson'
+require_relative 'geojson-diff/property-diff'
+require_relative 'geojson-diff/version'
+
+ENV["GEOS_LIBRARY_PATH"] ||= File.expand_path("lib", `geos-config --prefix`.strip)
+
+class GeojsonDiff
+
+  META_KEY = '_geojson_diff'
+
+  def initialize(before, after)
+    @before = ensure_feature_collection(RGeo::GeoJSON.decode(before, :json_parser => :json))
+    @after = ensure_feature_collection(RGeo::GeoJSON.decode(after, :json_parser => :json))
+  end
+
+  attr_accessor :before, :after
+
+  def added
+    diff(@after,@before,"added")
+  end
+
+  def removed
+    diff(@before,@after,"removed")
+  end
+
+  def unchanged
+    diff(@before,@after,"unchanged")
+  end
+
+  private
+
+  # Given a geometry, ensures that it is represented as a feature collection
+  # This way diff logic can remain consistent between geometry types
+  # Rather than creating diff logic for each type
+  def ensure_feature_collection(geometry)
+    return geometry if geometry.class == RGeo::GeoJSON::FeatureCollection
+    return RGeo::GeoJSON::FeatureCollection.new([]) if geometry.nil?
+    geometry = RGeo::GeoJSON::Feature.new(geometry) unless geometry.class == RGeo::GeoJSON::Feature
+    RGeo::GeoJSON::FeatureCollection.new([geometry])
+  end
+
+  # Find index of indentical feature within a feature collection based on geometry
+  #
+  # from_feature - the needle feature
+  # to - the haystack featurecollection
+  #
+  # returns (int) the index of the identical feature, or nil
+  def match(before_feature,after_feature_collection)
+    after_feature_collection.find_index do |after_feature|
+      after_feature.geometry.rep_equals?(before_feature.geometry) ||
+      after_feature.geometry.equals?(before_feature.geometry)
+    end
+  end
+
+  # Given a feature (before and after), diffs the geometry and properties
+  #
+  # before_feature - Feature before the change
+  # after_feature  - Feature after the change
+  # type           - requested diff component, either added, removed, or unchanged
+  #
+  # Returns a feature representing the requested diff component
+  def diff_feature(before_feature, after_feature, type="difference")
+    geometry = diff_geometry(before_feature, after_feature, type)
+    return nil if geometry.nil? || geometry.is_empty?
+    properties = { META_KEY => {} }
+    properties.merge! diff_properties(before_feature, after_feature, type)
+    properties[META_KEY].merge!({type: type})
+    RGeo::GeoJSON::Feature.new(geometry,nil,properties)
+  end
+
+  # Diff the geometry of a given feature
+  #
+  # before_feature - Feature before the change
+  # after_feature  - Feature after the change
+  # type           - requested diff component, either added, removed, or unchanged
+  #
+  # Returns the resulting feature geometry
+  def diff_geometry(before_feature, after_feature, type)
+    if type == "unchanged"
+      command = "intersection"
+    else
+      command = "difference"
+    end
+
+    if after_feature.nil? && type == "unchanged"
+      nil # doesn't exist in other so can't intersect
+    elsif after_feature.nil? #added or removed
+      before_feature.geometry # pass through
+    else # true diff
+      before_feature.geometry.send(command, after_feature.geometry)
+    end
+  end
+
+  # Diff the properties of a given feature
+  #
+  # before_feature - Feature before the change
+  # after_feature  - Feature after the change
+  # type           - requested diff component, either added, removed, or unchanged
+  #
+  # Returns a JSON representation of the feature's diff'd properties
+  def diff_properties(before_feature, after_feature, type)
+    if after_feature.nil? && type == "unchanged"
+      {}
+    elsif type == "added" || type == "removed"
+      before_feature.properties
+    else
+      PropertyDiff.new(before_feature.properties, after_feature.properties).properties
+    end
+  end
+
+  # Generate a feature collection representing the requested diff
+  #
+  # before - starting decoded geojson
+  # after- end decoded geojson
+  # type - type of diff to perform, noted in each feature's properties
+  #
+  # For diffs, think of this as what's in #{before} that's not in #{after}
+  # For intersections, it's what's in both #{before} and {after}
+  #
+  # returns a feature collection of the diff
+  def diff(before, after, type="difference")
+    features = []
+    matched = []
+
+    # Don't mangle the true before and after instance variables
+    before_features = before.instance_variable_get("@features").clone
+    after_features = after.instance_variable_get("@features").clone
+
+    # Loop through once diffing the properties of any directly-matched geometries
+    # This helps eliminates edge cases where adding/removing a single element could
+    # break the entire diff, sans an LCS approach.
+    before_features.each_with_index do |feature, index|
+      next unless match_index = match(feature,after_features)
+
+      # direct match for a feature, on an unchanged diff, just diff properties
+      if type == "unchanged"
+        diffed_feature = diff_feature(feature, after_features[match_index], type)
+        features.push diffed_feature unless diffed_feature.nil?
+      end
+
+      # If they've matched, we know they can't be added or removed
+      after_features.delete_at(match_index)
+      matched.push feature
+    end
+
+    # You can't delete elements from an array while iterating over them
+    # So wait until we've matched everything, and delete those that have been matched
+    matched.each do |feature|
+      before_features.delete(feature)
+    end
+
+    # Loop through what's left, and perform a straight index->index geometry diff
+    before_features.each_with_index do |feature,index|
+      diffed_feature = diff_feature(feature, after_features[index], type)
+      features.push diffed_feature unless diffed_feature.nil?
+    end
+    RGeo::GeoJSON::FeatureCollection.new(features)
+  end
+end

data/lib/geojson-diff/property-diff.rb

@@ -0,0 +1,114 @@
+class GeojsonDiff
+  class PropertyDiff
+
+    # Creates a new PropertyDiff instance
+    #
+    # before - the property element of the starting geometry (as parsed JSON)
+    # after - the property element of the resulting geometry (as parsed JSON)
+    #
+    # returns the PropertyDiff instance
+    def initialize(before,after)
+      @before = before
+      @after = after
+      @meta = { :added => [], :removed => [], :changed => [] }
+      diff
+    end
+
+    # Checks if the given key has been added to the resulting geometry
+    #
+    # key - string the JSON property key to check
+    #
+    # Returns bool true if added, otherwise false
+    def added?(key)
+      !@before.key?(key) && @after.key?(key)
+    end
+
+    # Returns an array of all keys added to the resulting geometry
+    def added
+      @meta[:added]
+    end
+
+    # Checks if the given key has been removed from the resulting geometry
+    #
+    # key - string the JSON property key to check
+    #
+    # Returns bool true if removed, otherwise false
+    def removed?(key)
+      @before.key?(key) && !@after.key?(key)
+    end
+
+    # Returns an array of all keys removed from the resulting geometry
+    def removed
+      @meta[:removed]
+    end
+
+    # Checks if the given key has been modified in the resulting geometry
+    #
+    # key - string the JSON property key to check
+    #
+    # Returns bool true if modified, otherwise false
+    def changed?(key)
+      !added?(key) && !removed?(key) && @before[key] != @after[key]
+    end
+
+    # Returns an array of all keys modified in the resulting geometry
+    def changed
+      @meta[:changed]
+    end
+
+    # Returns the JSON representation of the diffed properties, including metadata
+    def to_json
+      diff.to_json
+    end
+
+    def to_s
+      diff.to_s
+    end
+
+    def inspect
+      "#<GeojsonDiff::PropertyDiff added=#{added.to_s} removed=#{removed.to_s} changed=#{changed.to_s}>"
+    end
+
+    # Returns a hash of the diffed properties, including metadata
+    def diff
+      @diff ||= begin
+        properties = {}
+        @before.merge(@after).each { |key,value| properties.merge! diffed_property(key) }
+        properties.merge({ GeojsonDiff::META_KEY => @meta })
+      end
+    end
+    alias_method :properties, :diff
+
+    private
+
+    # Diffs an individual key/value pair
+    # Also propegates @meta arrays
+    #
+    # key - the property key to diff
+    #
+    # Returns the resulting key/value pair, either before (removed), after (added), or diffed (changed)
+    def diffed_property(key)
+      if added? key
+        @meta[:added].push key
+        { key => @after[key] }
+      elsif removed? key
+        @meta[:removed].push key
+        { key => @before[key] }
+      elsif changed? key
+        @meta[:changed].push key
+        { key => diffed_value(key) }
+      else # unchanged
+        { key => @after[key] }
+      end
+    end
+
+    # Diffs an indivual changed value
+    #
+    # key - the property key to diff
+    #
+    # Returns (string) the Diffy representation of the changed property
+    def diffed_value(key)
+      Diffy::Diff.new(@before[key], @after[key]).to_s(:html)
+    end
+  end
+end

data/lib/geojson-diff/version.rb

@@ -0,0 +1,3 @@
+class GeojsonDiff
+  VERSION = '0.0.1'
+end

data/lib/rgeo/geojson.rb

@@ -0,0 +1,10 @@
+# monkey patch in a native to_json method for FeatureCollections
+module RGeo
+  module GeoJSON
+    class FeatureCollection
+      def to_json
+        RGeo::GeoJSON.encode(self).to_json
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: geojson-diff
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ben Balter
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rgeo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: rgeo-geojson
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: ffi-geos
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: diffy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: GeoJSON Diff takes two GeoJSON files representing the same geometry (or
+  geometries) at two points in time, and generates three GeoJSON files represented
+  the added, removed, and unchanged geometries.
+email: ben.balter@github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/geojson-diff.rb
+- lib/geojson-diff/property-diff.rb
+- lib/geojson-diff/version.rb
+- lib/rgeo/geojson.rb
+homepage: https://github.com/benbalter/geojson-diff
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A Ruby library for diffing GeoJSON files
+test_files: []