rp_clustering-rgeo-activerecord 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YjAzODU1ZmI0ZjZlMDdlODlmYjA0NTBiOGRmMjQyMDViZGNjZDAzMw==
+  data.tar.gz: !binary |-
+    ZTk2ZTk4NTc4YjU3M2MxZjc5ZDdlMjdhNzk1NjBhMGJjM2I4MTRjMg==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    YTQ0OGI2Y2I0NWEyMGVlN2FlZmQ0Mzc4ZDc0N2FhMjMwNGQwNjNjZDI5NzZl
+    ZjNhNWNmNjc5YjY4ODJjMmZkZmYwOTYwN2EzNTU5NTU3YjRlNmQ2NmUwYjkw
+    YTc3ZDc5NGVjNzAyMjM3MDEzNGRhNWM5ZGZjZDhiNDRmZTk5Mzc=
+  data.tar.gz: !binary |-
+    OTcxZjBjYTViYjU2ZTdjMjIwZjdkNGRjN2NiODFjOWM4ZjRiNjIzOWIyMTc5
+    YzE1ZWUwOTllZjUzNjcxYjg4YzA3MzU5ZDVkNWY0YjBlOGVhMmEzYzRiNWE3
+    NTJiYTVmZGMzNjVhMTkxNGZkY2U4NzljMzYyNzc3Nzc5MThiMTA=

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/database_local.yml
+test/version_tmp
+tmp
+

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rp_clustering-rgeo-activerecord.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Robert Pyke
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,80 @@
+# RPClustering::RGeo::ActiveRecord
+
+A RGeo PostGIS extension to provide Active Record (Model) clustering functionality.
+
+The intention is that this Gem will eventually provide abstracted methods for
+both "on the fly" clustering, as well as cached clustering (including associated generators).
+
+If you find a problem with this Gem, please don't hesitate to raise an [issue](https://github.com/robertpyke/rp_clustering-rgeo-activerecord/issues).
+
+## Installation
+
+Note: This gem provides extensions for [activerecord-postgis-adapter](https://github.com/dazuma/activerecord-postgis-adapter).
+Please see [activerecord-postgis-adapter](https://github.com/dazuma/activerecord-postgis-adapter)
+for its install instructions. Once you've got
+it working, then simply add this gem to your Gemfile to enable these extensions.
+
+Add this line to your application's Gemfile:
+
+    gem 'rp_clustering-rgeo-activerecord'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rp_clustering-rgeo-activerecord
+
+
+## Usage
+
+### Added in Version 0.0.1
+
+This version allows for hand-coded low-level clustering via the Arel interface.
+
+e.g.
+
+```ruby
+
+    # Get the Arel handle for the model
+
+    arel_table = MyModel.arel_table
+
+    # Our cluster grid size.
+    # Smaller grid_size means more clusters.
+    # Larger grid_size means less clusters (cluster covers a larger area).
+    # See http://www.postgis.org/docs/ST_SnapToGrid.html for more info.
+
+    grid_size = 0.1
+
+    # Cluster against our model's :latlon attribute with a grid size of '0.1'.
+    # Return the centroid of each cluster as "cluster_centroid".
+
+    query = MyModel.select(
+      arel_table.st_astext(
+        arel_table.st_centroid(arel_table.st_collect(attr))
+      ).as("cluster_centroid")
+    ).group(arel_table[:latlon].st_snaptogrid(0.1))
+
+    # Iterate over our clusters
+    query.all.each do |cluster|
+
+      # print the cluster_centroid (a point) as WKT
+      puts cluster["cluster_centroid"]
+
+      # convert the WKT into a RGeo Geometry (a point)
+      geographic_factory.parse_wkt(cluster["cluster_centroid")
+
+      # ...
+    end
+
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,12 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/test*.rb']
+  t.verbose = true
+end
+
+task :default => [:test]
+

data/lib/rp_clustering-rgeo-activerecord.rb

@@ -0,0 +1,39 @@
+require "rp_clustering-rgeo-activerecord/version"
+require "rp_clustering-rgeo-activerecord/arel_attribute_spatial_expressions"
+require "rp_clustering-rgeo-activerecord/arel_table_spatial_expressions"
+
+module RPClustering
+
+  module RGeo
+
+    module ActiveRecord
+
+      # Spatial Expressions to be attached directly to Arel Attributes (DB columns)
+
+      module ArelAttributeSpatialExpressions
+      end
+
+      # Attach our Spatial Expression methods onto the Arel::Attribute class.
+      #
+      # i.e. As stated in the RGeo::ActiveRecord docs.. Allow chaining of spatial expressions from attributes
+
+      ::Arel::Attribute.class_eval do
+        include ::RPClustering::RGeo::ActiveRecord::ArelAttributeSpatialExpressions
+      end
+
+      # Spatial Expressions to be attached to Arel Table (DB tables)
+
+      module ArelTableSpatialExpressions
+      end
+
+      # Attach our Spatial Expression methods onto the Arel::Table class.
+
+      ::Arel::Table.class_eval do
+        include ::RPClustering::RGeo::ActiveRecord::ArelTableSpatialExpressions
+      end
+
+    end
+
+  end
+
+end

data/lib/rp_clustering-rgeo-activerecord/arel_attribute_spatial_expressions.rb

@@ -0,0 +1,66 @@
+# Author: Robert Pyke
+
+module RPClustering
+
+  module RGeo
+
+    module ActiveRecord
+
+      module ArelAttributeSpatialExpressions
+
+        # ST_SnapToGrid: http://www.postgis.org/docs/ST_SnapToGrid.html
+        #
+        # Implements postgis function variant:
+        #
+        #   geometry ST_SnapToGrid(geometry geomA, float size);
+        #
+        # Returns a geometry collection
+
+        def st_snaptogrid(grid_size)
+          args = [self, grid_size.to_s]
+
+          # SpatialNamedFunction takes the following args:
+          # * name
+          # * expr
+          # * spatial_flags
+          # * aliaz (defaults to nil)
+          #
+          #
+          # Understanding the spatial_flags argument
+          # -----------------------------------------
+          #
+          # A flag is true if the corresponding argument is spatial, else the
+          # flag is false.
+          # The first element is the spatial-ness result, the other args
+          # relate to our expression args
+
+          ::RGeo::ActiveRecord::SpatialNamedFunction.new(
+            'ST_SnapToGrid', args, [true, true, false]
+          )
+
+        end
+
+        # ST_Collect: http://www.postgis.org/docs/ST_Collect.html
+        #
+        # Implements postgis function variant:
+        #
+        #   geometry ST_Collect(geometry[] g1_array);
+        #
+        # Returns a geometry collection
+
+        def st_collect()
+          args = [self]
+
+          ::RGeo::ActiveRecord::SpatialNamedFunction.new(
+            'ST_Collect', args, [true, true]
+          )
+
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/lib/rp_clustering-rgeo-activerecord/arel_table_spatial_expressions.rb

@@ -0,0 +1,82 @@
+# Author: Robert Pyke
+
+module RPClustering
+
+  module RGeo
+
+    module ActiveRecord
+
+      module ArelTableSpatialExpressions
+
+        # ST_SnapToGrid: http://www.postgis.org/docs/ST_SnapToGrid.html
+        #
+        # Implements postgis function variant:
+        #
+        #   geometry ST_SnapToGrid(geometry geomA, float size);
+        #
+        # Returns a geometry collection
+
+        def st_snaptogrid(geom_a, grid_size)
+          args = [geom_a, grid_size.to_s]
+
+          ::RGeo::ActiveRecord::SpatialNamedFunction.new(
+            'ST_SnapToGrid', args, [true, true, false]
+          )
+
+        end
+
+        # ST_Collect: http://www.postgis.org/docs/ST_Collect.html
+        #
+        # Implements postgis function variant:
+        #
+        #   geometry ST_Collect(geometry[] g1_array);
+        #
+        # This variant is an aggregate, it operates on rows of data.
+        #
+        # Returns a geometry collection
+
+        def st_collect(g1_array)
+          args = [g1_array]
+
+          ::RGeo::ActiveRecord::SpatialNamedFunction.new(
+            'ST_Collect', args, [true, true]
+          )
+
+        end
+
+        # ST_AsText: http://www.postgis.org/docs/ST_AsText.html
+        #
+        # Returns a string (WKT)
+
+        def st_astext(g)
+          args = [g]
+
+          ::RGeo::ActiveRecord::SpatialNamedFunction.new(
+            'ST_AsText', args, [true, true]
+          )
+
+        end
+
+        # ST_Centroid: http://www.postgis.org/docs/ST_Centroid.html
+        #
+        # Implements postgis function variant:
+        #
+        #   geometry ST_Centroid(geometry g1);
+        #
+        # Returns a geometry
+
+        def st_centroid(g)
+          args = [g]
+
+          ::RGeo::ActiveRecord::SpatialNamedFunction.new(
+            'ST_Centroid', args, [true, true]
+          )
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/lib/rp_clustering-rgeo-activerecord/version.rb

@@ -0,0 +1,7 @@
+module RPClustering
+  module RGeo
+    module ActiveRecord
+      VERSION = "0.0.1"
+    end
+  end
+end

data/rp_clustering-rgeo-activerecord.gemspec

@@ -0,0 +1,36 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rp_clustering-rgeo-activerecord/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "rp_clustering-rgeo-activerecord"
+  gem.version       = RPClustering::RGeo::ActiveRecord::VERSION
+  gem.authors       = ["Robert Pyke"]
+  gem.email         = ["robert.j.pyke@gmail.com"]
+  gem.summary       = %q{RGeo PostGIS extension to provide clustering functionality}
+  gem.description   = %q{A RGeo PostGIS extension to provide Active Record (Model) clustering functionality}
+  gem.homepage      = "https://github.com/robertpyke/rp_clustering-rgeo-activerecord"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.license = 'MIT'
+
+  # Development Dependencies
+  gem.add_development_dependency('bundler', '>= 1.0.0')
+  gem.add_development_dependency('test-unit', '~> 2.5.4')
+  gem.add_development_dependency('rake')
+  gem.add_development_dependency('rdoc')
+  gem.add_development_dependency('pg')
+
+  # Deployed Gem Dependencies
+  gem.add_dependency('activerecord', '~> 3.0')
+  gem.add_dependency('arel', '~> 3.0.2')
+  gem.add_dependency('rgeo', '~> 0.3.20')
+  gem.add_dependency('rgeo-activerecord', '~> 0.4.6')
+  # This Gem is specific to postgis
+  gem.add_dependency('activerecord-postgis-adapter')
+end

data/test/database.yml

@@ -0,0 +1,7 @@
+adapter: postgis
+host: 127.0.0.1
+encoding: unicode
+pool: 5
+host: localhost
+port: 5432
+database: rp_clustering_test

data/test/test_unit.rb

@@ -0,0 +1,107 @@
+require 'test/unit'
+require 'rgeo/active_record/adapter_test_helper'
+require 'rp_clustering-rgeo-activerecord'
+
+module RPClustering
+  module RGeo
+    module ActiveRecord
+      module Tests
+        class MyUnitTest < Test::Unit::TestCase  # :nodoc:
+
+          # Use the RGEO active record adapter test helper
+
+          DATABASE_CONFIG_PATH = ::File.dirname(__FILE__)+'/database.yml'
+          OVERRIDE_DATABASE_CONFIG_PATH = ::File.dirname(__FILE__)+'/database_local.yml'
+          include ::RGeo::ActiveRecord::AdapterTestHelper
+
+
+          define_test_methods do
+
+            def populate_ar_class(content_)
+              klass_ = create_ar_class
+              case content_
+              when :latlon_point
+                klass_.connection.create_table(:spatial_test) do |t_|
+                  t_.column 'latlon', :point, :srid => 4326
+                end
+              end
+              klass_
+            end
+
+            # Confirm that everything is working as it should
+            def test_should_pass
+              assert(true)
+            end
+
+            def test_should_have_a_version
+              assert_not_nil(RPClustering::RGeo::ActiveRecord::VERSION)
+            end
+
+            # Test that the st_snaptogrid method exists on the Arel::Attribute
+            # and on the Arel::Table
+
+            def test_st_snaptogrid_method_should_exist
+              arel_klass = populate_ar_class(:latlon_point)
+              assert(
+                arel_klass.arel_table[:latlon_point].methods.include?(:st_snaptogrid),
+                "Active Record Arel::Attribute should now have a st_snaptogrid function. " +
+                "Found:\n#{arel_klass.arel_table[:latlon_point].methods.sort}"
+              )
+
+              assert(
+                arel_klass.arel_table.methods.include?(:st_snaptogrid),
+                "Active Record Arel::Table should now have a st_snaptogrid function. " +
+                "Found:\n#{arel_klass.arel_table.methods.sort}"
+              )
+            end
+
+            # Confirm that the st_snaptogrid function is producing the 
+            # expected results
+
+            def test_st_snap_to_grid
+              arel_klass = populate_ar_class(:latlon_point)
+
+              points_generated = 0
+              (-5..5).each do |lng|
+                (-5..5).each do |lat|
+                  obj = arel_klass.new
+                  obj.latlon = @geographic_factory.point(lng, lat)
+                  obj.save!
+                  points_generated+=1
+                end
+              end
+
+              # Sanity check, confirm that we have all the points we created.
+              count_res = arel_klass.count()
+              assert_equal(
+                points_generated,
+                count_res,
+                "The number of points generated doesn't match the number in the DB"
+              )
+
+              attr = arel_klass.arel_table[:latlon]
+              t = arel_klass.arel_table
+
+              q1 = arel_klass.select(t.st_astext(t.st_centroid(t.st_collect(attr))).as("cluster_centroid"))
+              q1 = q1.group(attr.st_snaptogrid(180))
+
+              assert_equal(1, q1.all.count(), "With a sufficiently large grid size, we would expect the st_snaptogrid to produce only a single point")
+
+
+              value = q1.first["cluster_centroid"]
+              compare_point = @geographic_factory.point(0,0)
+              assert_equal(@geographic_factory.parse_wkt(value), compare_point, "cluster centroid should be a valid point in the center of the earth")
+
+              q2 = arel_klass.select(t.st_astext(t.st_centroid(t.st_collect(attr))).as("cluster_centroid"))
+              q2 = q2.group(attr.st_snaptogrid(1))
+
+              assert_equal(points_generated, q2.all.count(), "With a small grid size, we would expect the st_snaptogrid to produce every single point")
+
+            end
+
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,199 @@
+--- !ruby/object:Gem::Specification
+name: rp_clustering-rgeo-activerecord
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Robert Pyke
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.5.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.5.4
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  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: arel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.2
+- !ruby/object:Gem::Dependency
+  name: rgeo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.20
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.20
+- !ruby/object:Gem::Dependency
+  name: rgeo-activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.6
+- !ruby/object:Gem::Dependency
+  name: activerecord-postgis-adapter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A RGeo PostGIS extension to provide Active Record (Model) clustering
+  functionality
+email:
+- robert.j.pyke@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rp_clustering-rgeo-activerecord.rb
+- lib/rp_clustering-rgeo-activerecord/arel_attribute_spatial_expressions.rb
+- lib/rp_clustering-rgeo-activerecord/arel_table_spatial_expressions.rb
+- lib/rp_clustering-rgeo-activerecord/version.rb
+- rp_clustering-rgeo-activerecord.gemspec
+- test/database.yml
+- test/test_unit.rb
+homepage: https://github.com/robertpyke/rp_clustering-rgeo-activerecord
+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.0.0
+signing_key: 
+specification_version: 4
+summary: RGeo PostGIS extension to provide clustering functionality
+test_files:
+- test/database.yml
+- test/test_unit.rb