geos-extensions 0.0.2

data/MIT-LICENSE

@@ -0,0 +1,23 @@
+Copyright (c) 2011 2167961 Ontario Inc., Zoocasa <code@zoocasa.com>
+
+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.rdoc

@@ -0,0 +1,99 @@
+
+== Zoocasa GEOS Extensions
+
+The Zoocasa GEOS Extensions library (ZGEL) is a set of utilities and tools that
+extend the GEOS Ruby bindings module. From http://geos.refractions.net/ ...
+
+  GEOS (Geometry Engine - Open Source) is a C++ port of the  Java Topology
+  Suite (JTS). As such, it aims to contain the complete functionality of JTS
+  in C++. This includes all the OpenGIS Simple Features for SQL spatial
+  predicate functions and spatial operators, as well as specific JTS
+  enhanced topology functions.
+
+The GEOS bindings for Ruby can be installed by installing the GEOS library
+itself using the --enable-ruby switch during configure or can often be
+installed via package managers. There is also an FFI-based Ruby gem being
+written available at https://github.com/dark-panda/ffi-geos .
+
+ZGEL contains a number of enhancements to the GEOS Ruby library:
+
+* a host of helper methods to make reading and writing to and from WKT
+  and WKB easier. For instance, rather than
+
+    Geos::WktReader.new.read('POINT(0 0')
+
+  you can quickly use
+
+    Geos.read('POINT(0 0)')
+
+  The Geos.read method also works with WKB in both binary and hex,
+  recognizes EWKB and EWKT and can read several of Google Maps
+  JavaScript output formats that we use for our applications. There are
+  also similar methods for outputting to WKT and WKB such as
+  Geos::Geometry#to_wkt, #to_kml, #to_georss and a number of methods to
+  output to Google Maps API v2-style JavaScript.
+
+* a bunch of helper methods to quickly grab some information from
+  geometries like Geos::Point#lat and Geos::Point#lng.
+
+* in all, some 70+ helper methods have been added to Geos::Geometry types.
+
+* Geos::GeometryCollection has been made an Enumerable.
+
+We've also included some Rails integration for PostGIS, including:
+
+* automatic detection of geometry columns and just-in-time conversions
+  for input and output to and from WKB when using PostGIS. This allows
+  you to do stuff like this with your ActiveRecord models:
+
+    m = MyModel.find(12345)
+    m.the_geom # => spits out the untouched geometry value as a string in WKB
+    m.the_geom_geos # => spits out the geometry wrapped in a Geos::Geometry object
+    m.the_geom = 'POINT(0 0)' # => setters will automatically make
+    conversions from any of the formats that the Geos.read can recognize,
+    so Google Maps formats, WKT, WKB, etc. are all converted
+    automatically.
+    m.the_geom_wkt # => automatically converts to a WKT string
+    m.the_geom_wkb_bin # => automatically converts to WKB in binary
+
+  There's also some funky SRID handling code that will automatically
+  look in the geometry_columns table to make conversions for you when
+  necessary. Saving WKT as "SRID=default; POINT(0 0)" for instance will
+  automatically set the SRID when saving the ActiveRecord, or the SRID
+  can be specified manually.
+
+* multiple geometry columns are supported and detected for
+  automatically. These column accessors are all generated dynamically at
+  run time.
+
+* automatic generation of named scopes for ActiveRecord models. The
+  usual suspects are supported:
+
+  * st_contains
+  * st_containsproperly
+  * st_covers
+  * st_coveredby
+  * st_crosses
+  * st_disjoint
+  * st_equals
+  * st_intersects
+  * st_orderingequals
+  * st_overlaps
+  * st_touches
+  * st_within
+  * st_dwithin
+
+  These let you chain together scopes to build geospatial queries:
+
+    neighbourhood = Neighbourhood.find(12345)
+    my_model = MyModel.active.
+      recent.
+      st_within(neighbourhood.the_geom_geos.envelope).
+      st_dwithin(point, 0.1).
+      all(
+        :limit => 10
+      )
+
+We wrote this code for Rails 2.3 and are currently testing on Rails
+3, but it appears that everything is working as expected and is
+working with Arel. (Things are looking good so far!)

data/Rakefile

@@ -0,0 +1,40 @@
+
+# -*- ruby -*-
+
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+$:.push 'lib'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "geos-extensions"
+    gem.version = "0.0.2"
+    gem.summary = "Extensions for the GEOS library."
+    gem.description = gem.summary
+    gem.email = "code@zoocasa.com"
+    gem.homepage = "http://github.com/zoocasa/geos-extensions"
+    gem.authors =    [ "J Smith" ]
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+desc 'Test GEOS interface'
+Rake::TestTask.new(:test) do |t|
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+desc 'Build docs'
+Rake::RDocTask.new do |t|
+  require 'rdoc/rdoc'
+  t.main = 'README.rdoc'
+  t.rdoc_dir = 'doc'
+  t.rdoc_files.include('README.rdoc', 'MIT-LICENSE', 'lib/**/*.rb')
+end
+

data/geos-extensions.gemspec

@@ -0,0 +1,55 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{geos-extensions}
+  s.version = "0.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["J Smith"]
+  s.date = %q{2011-02-17}
+  s.description = %q{Extensions for the GEOS library.}
+  s.email = %q{code@zoocasa.com}
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    "MIT-LICENSE",
+    "README.rdoc",
+    "Rakefile",
+    "geos-extensions.gemspec",
+    "lib/active_record_extensions.rb",
+    "lib/active_record_extensions/connection_adapters/postgresql_adapter.rb",
+    "lib/active_record_extensions/geometry_columns.rb",
+    "lib/active_record_extensions/geospatial_scopes.rb",
+    "lib/geos-extensions.rb",
+    "lib/geos_extensions.rb",
+    "lib/geos_helper.rb",
+    "lib/google_maps.rb",
+    "lib/google_maps/polyline_encoder.rb",
+    "test/reader_test.rb",
+    "test/test_helper.rb",
+    "test/writer_test.rb"
+  ]
+  s.homepage = %q{http://github.com/zoocasa/geos-extensions}
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.5.2}
+  s.summary = %q{Extensions for the GEOS library.}
+  s.test_files = [
+    "test/reader_test.rb",
+    "test/test_helper.rb",
+    "test/writer_test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/lib/active_record_extensions.rb

@@ -0,0 +1,8 @@
+
+module Geos
+  module ActiveRecord
+    autoload :GeometryColumns, File.join(GEOS_EXTENSIONS_BASE, %w{ active_record_extensions geometry_columns })
+    autoload :GeospatialScopes, File.join(GEOS_EXTENSIONS_BASE, %w{ active_record_extensions geospatial_scopes })
+  end
+end
+

data/lib/active_record_extensions/connection_adapters/postgresql_adapter.rb

@@ -0,0 +1,39 @@
+
+module ActiveRecord
+  module ConnectionAdapters
+    # Allows access to the name, srid and coord_dimensions of a PostGIS
+    # geometry column in PostgreSQL.
+    class PostgreSQLGeometryColumn
+      attr_accessor :name, :srid, :coord_dimension
+
+      def initialize(name, srid = nil, coord_dimension = nil)
+        @name, @srid, @coord_dimension = name, srid, coord_dimension
+      end
+    end
+
+    class PostgreSQLAdapter < AbstractAdapter
+      # Returns the geometry columns for the table.
+      def geometry_columns(table_name, name = nil)
+        columns(table_name, name).select { |c| c.sql_type == 'geometry' }.collect do |c|
+          res = execute(
+            "SELECT * FROM geometry_columns WHERE f_table_name = #{quote(table_name)} AND f_geometry_column = #{quote(c.name)}",
+            "Geometry column load for #{table_name}"
+          )
+
+          returning(PostgreSQLGeometryColumn.new(c.name)) do |g|
+            # since we're too stupid at the moment to understand
+            # PostgreSQL schemas, let's just go with this:
+            if res.ntuples == 1
+              coord_dimension_idx, srid_idx =
+                res.fields.index('coord_dimension'),
+                res.fields.index('srid')
+
+              g.srid = res.getvalue(0, srid_idx).to_i
+              g.coord_dimension = res.getvalue(0, coord_dimension_idx).to_i
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/active_record_extensions/geometry_columns.rb

@@ -0,0 +1,252 @@
+
+if defined?(ActiveRecord::ConnectionAdapters::PostgreSQLAdapter)
+  require File.join(GEOS_EXTENSIONS_BASE, *%w{ active_record_extensions connection_adapters postgresql_adapter })
+end
+
+module Geos
+  module ActiveRecord #:nodoc:
+
+    # This little module helps us out with geometry columns. At least, in
+    # PostgreSQL it does.
+    #
+    # This module will add a method called geometry_columns to your model
+    # which will contain information that can be gleaned from the
+    # geometry_columns table that PostGIS creates.
+    #
+    # You can also have the module automagically create some accessor
+    # methods for you to make your life easier. These accessor methods will
+    # override the ActiveRecord defaults and allow you to set geometry
+    # column values using Geos geometry objects directly or with
+    # PostGIS-style extended WKT and such. See
+    # create_geometry_column_accessors! for details.
+    #
+    # === Caveats:
+    #
+    # * This module currently only works with PostGIS.
+    # * This module doesn't really "get" PostgreSQL catalogs and schemas
+    #   and such. That would be a little more involved but it would be
+    #   nice if Rails was aware of such things.
+    module GeometryColumns
+      GEOMETRY_COLUMN_OUTPUT_FORMATS = %{ geos wkt wkb ewkt ewkb wkb_bin ewkb_bin }.freeze
+
+      class InvalidGeometry < ::ActiveRecord::ActiveRecordError
+        def initialize(geom)
+          super("Invalid geometry: #{geom}")
+        end
+      end
+
+      class SRIDNotFound < ::ActiveRecord::ActiveRecordError
+        def initialize(table_name, column)
+          super("Couldn't find SRID for #{table_name}.#{column}")
+        end
+      end
+
+      def self.included(base) #:nodoc:
+        base.extend(ClassMethods)
+        base.send(:include, Geos::ActiveRecord::GeospatialScopes)
+      end
+
+      module ClassMethods
+        protected
+          @geometry_columns = nil
+
+        public
+          # Returns an Array of available geometry columns in the
+          # table. These are PostgreSQLColumns with values set for
+          # the srid and coord_dimensions properties.
+          def geometry_columns
+            if @geometry_columns.nil?
+              @geometry_columns = connection.geometry_columns(self.table_name)
+              @geometry_columns.freeze
+            end
+            @geometry_columns
+          end
+
+          # Grabs a geometry column based on name.
+          def geometry_column_by_name(name)
+            @geometry_column_by_name ||= self.geometry_columns.inject(HashWithIndifferentAccess.new) do |memo, obj|
+              memo[obj.name] = obj
+              memo
+            end
+            @geometry_column_by_name[name]
+          end
+
+          # Quickly grab the SRID for a geometry column.
+          def srid_for(column)
+            self.geometry_column_by_name(column).try(:srid) || -1
+          end
+
+          # Quickly grab the number of dimensions for a geometry column.
+          def coord_dimension_for(column)
+            self.geometry_column_by_name(column).coord_dimension
+          end
+
+        protected
+          # Sets up nifty setters and getters for geometry columns.
+          # The methods created look like this:
+          #
+          # * geometry_column_name_geos
+          # * geometry_column_name_wkb
+          # * geometry_column_name_wkb_bin
+          # * geometry_column_name_wkt
+          # * geometry_column_name_ewkb
+          # * geometry_column_name_ewkb_bin
+          # * geometry_column_name_ewkt
+          # * geometry_column_name=(geom)
+          # * geometry_column_name(options = {})
+          #
+          # Where "geometry_column_name" is the name of the actual
+          # column.
+          #
+          # You can specify which geometry columns you want to apply
+          # these accessors using the :only and :except options.
+          def create_geometry_column_accessors!(options = nil)
+            create_these = if options.nil?
+              self.geometry_columns
+            elsif options[:except] && options[:only]
+              raise ArgumentError, "You can only specify either :except or :only (#{options.keys.inspect})"
+            elsif options[:except]
+              except = Array(options[:except]).collect(&:to_s)
+              self.geometry_columns.reject { |c| except.include?(c) }
+            elsif options[:only]
+              only = Array(options[:only]).collect(&:to_s)
+              self.geometry_columns.select { |c| only.include?(c) }
+            end
+
+            create_these.each do |k|
+              src, line = <<-EOF, __LINE__ + 1
+                def #{k.name}=(geom)
+                  geos = case geom
+                    when /^SRID=default;/
+                      if #{k.srid.inspect}
+                        geom = geom.sub(/default/, #{k.srid.inspect}.to_s)
+                        Geos.from_wkt(geom)
+                      else
+                        raise SRIDNotFound.new(self.table_name, #{k.name})
+                      end
+                    else
+                      Geos.read(geom)
+                  end
+
+                  self['#{k.name}'] = if geos
+                    if geos.srid == 0
+                      geos.to_wkb
+                    else
+                      geos.to_ewkb
+                    end
+                  end
+
+                  GEOMETRY_COLUMN_OUTPUT_FORMATS.each do |f|
+                    instance_variable_set("@#{k.name}_\#{f}", nil)
+                  end
+                end
+
+                def #{k.name}_geos
+                  @#{k.name}_geos ||= Geos.from_wkb(self['#{k.name}'])
+                end
+
+                def #{k.name}(options = {})
+                  format = case options
+                    when String, Symbol
+                      options
+                    when Hash
+                      options = options.stringify_keys
+                      options['format'] if options['format']
+                  end
+
+                  if format
+                    if GEOMETRY_COLUMN_OUTPUT_FORMATS.include?(format)
+                      return self.send(:"#{k.name}_\#{format}")
+                    else
+                      raise ArgumentError, "Invalid option: \#{options[:format]}"
+                    end
+                  end
+
+                  self['#{k.name}']
+                end
+              EOF
+              self.class_eval(src, __FILE__, line)
+
+              GEOMETRY_COLUMN_OUTPUT_FORMATS.reject { |f| f == :geos }.each do |f|
+                src, line = <<-EOF, __LINE__ + 1
+                  def #{k.name}_#{f}
+                    @#{k.name}_#{f} ||= self.#{k.name}_geos.to_#{f} rescue nil
+                  end
+                EOF
+                self.class_eval(src, __FILE__, line)
+              end
+            end
+          end
+
+          # Stubs for documentation purposes:
+
+          # Returns a Geos geometry.
+          def __geometry_column_name_geos; end
+
+          # Returns a hex-encoded WKB String.
+          def __geometry_column_name_wkb; end
+
+          # Returns a WKB String in binary.
+          def __geometry_column_name_wkb_bin; end
+
+          # Returns a WKT String.
+          def __geometry_column_name_wkt; end
+
+          # Returns a hex-encoded EWKB String.
+          def __geometry_column_name_ewkb; end
+
+          # Returns an EWKB String in binary.
+          def __geometry_column_name_ewkb_bin; end
+
+          # Returns an EWKT String.
+          def __geometry_column_name_ewkt; end
+
+          # An enhanced setter that tries to deduce how you're
+          # setting the value. The setter can handle Geos::Geometry
+          # objects, WKT, EWKT and WKB and EWKB in both hex and
+          # binary.
+          #
+          # When dealing with SRIDs, you can have the SRID set
+          # automatically on WKT by setting the value as
+          # "SRID=default;GEOMETRY(...)", i.e.:
+          #
+          #  geometry_column_name = "SRID=default;POINT(1.0 1.0)"
+          #
+          # The SRID will be filled in automatically if available.
+          # Note that we're only setting the SRID on the geometry,
+          # but we're not doing any sort of re-projection or anything
+          # of the sort. If you need to convert from one SRID to
+          # another, you're stuck for the moment, but we'll be adding
+          # support for reprojections/transoformations via proj4rb
+          # soon.
+          #
+          # For WKB, you're better off manipulating the WKB directly
+          # or using proper Geos geometry objects.
+          def __geometry_column_name=(geom); end
+
+          # An enhanced getter that accepts an options Hash or
+          # String/Symbol that can be used to determine the output
+          # format. In the options Hash, use :format, or set the
+          # format directly as a String or Symbol.
+          #
+          # This basically allows you to do the following, which
+          # are equivalent:
+          #
+          #  geometry_column_name(:wkt)
+          #  geometry_column_name(:format => :wkt)
+          #  geometry_column_name_wkt
+          def __geometry_column_name(options = {}); end
+
+          undef __geometry_column_name_geos
+          undef __geometry_column_name_wkb
+          undef __geometry_column_name_wkb_bin
+          undef __geometry_column_name_wkt
+          undef __geometry_column_name_ewkb
+          undef __geometry_column_name_ewkb_bin
+          undef __geometry_column_name_ewkt
+          undef __geometry_column_name=
+          undef __geometry_column_name
+      end
+    end
+  end
+end