rgeo-activerecord 0.3.3 → 0.3.4

data/History.rdoc

@@ -1,3 +1,7 @@
+=== 0.3.4 / 2011-05-23
+
+* Uses the mixin feature of RGeo 0.3 to add an as_json method to all geometry objects. This should allow ActiveRecord's JSON serialization to function for models with geometry fields. (Reported by thenetduck and tonyc on github.)
+
 === 0.3.3 / 2011-04-11
 
 * A .gemspec file is now available for gem building and bundler git integration.

data/README.rdoc

@@ -16,14 +16,14 @@ along with a set of geometric analysis operations. See the README for the
 RGeo::ActiveRecord is an optional \RGeo add-on module providing spatial
 extensions for \ActiveRecord, as well as a set of helpers for writing
 spatial \ActiveRecord adapters based on \RGeo. Generally, you will not
-interact directly with this library
+need to interact directly with this library.
 
 === Installation
 
 RGeo::ActiveRecord has the following requirements:
 
 * Ruby 1.8.7 or later. Ruby 1.9.2 or later preferred.
-* \RGeo 0.2.8 or later.
+* \RGeo 0.3.0 or later.
 * \ActiveRecord 3.0.3 or later. Earlier versions will not work.
 * \Arel 2.0.6 or later. Earlier versions will not work.
 
@@ -39,10 +39,10 @@ installation information.
 
 === To-do list
 
-This gem has not yet been tested in a large variety of environments, and
-we are still rapidly fixing bugs. We still consider it to be in early
-alpha, but we are working toward an initial production deployment at
-GeoPage.
+We consider this gem to be in a late alpha state. There are a still a
+few holes in the intended functionality, but it is now being tested in a
+variety of contexts, and we know of several successful production
+deployments.
 
 We are also currently working on a mechanism for constructing complex
 spatial queries via extensions to Arel. This work is in the experimental

data/Version

@@ -1 +1 @@
-0.3.3
+0.3.4

data/lib/rgeo/active_record.rb

@@ -80,3 +80,4 @@ require 'rgeo/active_record/spatial_expressions.rb'
 require 'rgeo/active_record/arel_spatial_queries'
 require 'rgeo/active_record/common_adapter_elements.rb'
 require 'rgeo/active_record/ar_factory_settings'
+require 'rgeo/active_record/geometry_mixin'

data/lib/rgeo/active_record/geometry_mixin.rb

@@ -0,0 +1,108 @@
+# -----------------------------------------------------------------------------
+# 
+# Common tools for spatial adapters for ActiveRecord
+# 
+# -----------------------------------------------------------------------------
+# Copyright 2010 Daniel Azuma
+# 
+# All rights reserved.
+# 
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+# 
+# * Redistributions of source code must retain the above copyright notice,
+#   this list of conditions and the following disclaimer.
+# * Redistributions in binary form must reproduce the above copyright notice,
+#   this list of conditions and the following disclaimer in the documentation
+#   and/or other materials provided with the distribution.
+# * Neither the name of the copyright holder, nor the names of any other
+#   contributors to this software, may be used to endorse or promote products
+#   derived from this software without specific prior written permission.
+# 
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+# -----------------------------------------------------------------------------
+;
+
+
+module RGeo
+  
+  module ActiveRecord
+    
+    
+    # This module is mixed into all geometry objects. It provides an
+    # as_json method so that ActiveRecord knows how to generate JSON
+    # for a geometry-valued field.
+    
+    module GeometryMixin
+      
+      
+      # The default JSON generator Proc. Renders geometry fields as WKT.
+      DEFAULT_JSON_GENERATOR = ::Proc.new{ |geom_| geom_.to_s }
+      
+      @json_generator = DEFAULT_JSON_GENERATOR
+      
+      
+      # Set the style of JSON generation used for geometry fields in an
+      # ActiveRecord model by default. You may pass nil to use
+      # DEFAULT_JSON_GENERATOR, a proc that takes a geometry as the
+      # argument and returns an object that can be converted to JSON
+      # (i.e. usually a hash or string), or one of the following symbolic
+      # values:
+      # 
+      # <tt>:wkt</tt>::
+      #   Well-known text format. (Same as DEFAULT_JSON_GENERATOR.)
+      # <tt>:geojson</tt>::
+      #   GeoJSON format. Requires the rgeo-geojson gem.
+      
+      def self.set_json_generator(value_=nil, &block_)
+        if block_ && !value_
+          value_ = block_
+        elsif value_ == :geojson
+          require 'rgeo/geo_json'
+          value_ = ::Proc.new{ |geom_| ::RGeo::GeoJSON.encode(geom_) }
+        end
+        if value_.is_a?(::Proc)
+          @json_generator = value_
+        else
+          @json_generator = DEFAULT_JSON_GENERATOR
+        end
+      end
+      
+      
+      # Given a feature, returns an object that can be serialized as JSON
+      # (i.e. usually a hash or string), using the current json_generator.
+      # This is used to generate JSON for geometry-valued ActiveRecord
+      # fields by default.
+      
+      def self.generate_json(geom_)
+        @json_generator.call(geom_)
+      end
+      
+      
+      # Serializes this object as JSON for ActiveRecord.
+      
+      def as_json(opts_=nil)
+        GeometryMixin.generate_json(self)
+      end
+      
+      
+    end
+    
+    
+  end
+  
+end
+
+
+::RGeo::Feature::MixinCollection::GLOBAL.for_type(::RGeo::Feature::Geometry).
+  add(::RGeo::ActiveRecord::GeometryMixin)

data/test/tc_basic.rb

@@ -83,6 +83,22 @@ module RGeo
         end
         
         
+        def test_default_as_json_wkt
+          GeometryMixin.set_json_generator(nil)
+          factory_ = ::RGeo::Cartesian.preferred_factory
+          p_ = factory_.point(1, 2)
+          assert_equal("POINT (1.0 2.0)", p_.as_json)
+        end
+        
+        
+        def test_default_as_json_geojson
+          GeometryMixin.set_json_generator(:geojson)
+          factory_ = ::RGeo::Cartesian.preferred_factory
+          p_ = factory_.point(1, 2)
+          assert_equal({'type' => 'Point', 'coordinates' => [1.0, 2.0]}, p_.as_json)
+        end
+        
+        
       end
     
     end

metadata

@@ -2,7 +2,7 @@
 name: rgeo-activerecord
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.3.3
+  version: 0.3.4
 platform: ruby
 authors: 
 - Daniel Azuma
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-11 00:00:00 Z
+date: 2011-05-23 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rgeo
@@ -20,7 +20,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.2.8
+        version: 0.3.0
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -59,6 +59,7 @@ files:
 - lib/rgeo/active_record/ar_factory_settings.rb
 - lib/rgeo/active_record/arel_spatial_queries.rb
 - lib/rgeo/active_record/common_adapter_elements.rb
+- lib/rgeo/active_record/geometry_mixin.rb
 - lib/rgeo/active_record/spatial_expressions.rb
 - lib/rgeo/active_record/task_hacker.rb
 - lib/rgeo/active_record/version.rb
@@ -90,7 +91,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: virtuoso
-rubygems_version: 1.7.2
+rubygems_version: 1.8.2
 signing_key: 
 specification_version: 3
 summary: An RGeo module providing spatial extensions to ActiveRecord.