loose_change 0.3.7 → 0.4.0

data/README.md

@@ -1,6 +1,6 @@
 # Loose Change is a Ruby ORM for CouchDB
 
-* where 'ORM' is as accurate as ['Holy Roman
+* where 'Object-Relational Mapper' is as accurate as ['Holy Roman
 Empire'](http://en.wikipedia.org/wiki/Holy_Roman_Empire#Analysis)
 
 ## Goals and Principles
@@ -10,11 +10,20 @@ Empire'](http://en.wikipedia.org/wiki/Holy_Roman_Empire#Analysis)
 * Make common tasks easy; get out of your way if you need the metal
 * Make working with [GeoCouch](http://github.com/vmx/couchdb) seamless
 
+## GeoCouch Support
+
+Documents with spatial properties are now supported if you are running
+the latest version of [GeoCouch from
+git](http://github.com/vmx/couchdb).  Only Point and MultiPoint
+geometries are currently supported and tested.
+
 ## Warnings
 
-* This is pretty alpha at this point.
 * Only tested on Ruby 1.9.2.  I'm not intentionally breaking 1.8.x, but neither do I guarantee anything.
-* The stuff about GeoCouch above was a goal I didn't get to yet.
+
+## Todo
+
+* Add Rake tasks to push complicated views from a JS directory
 
 ## Help
 

data/VERSION

@@ -1 +1 @@
-0.3.7
+0.4.0

data/lib/loose_change/base.rb

@@ -25,6 +25,7 @@ module LooseChange
     include PersistenceClassMethods
     extend Views
     extend Pagination
+    extend Spatial
     include Helpers
     extend Helpers
     

data/lib/loose_change/helpers.rb

@@ -1,5 +1,9 @@
 module LooseChange
   module Helpers
+    def design_document_uri(database, model_name)
+      "#{ database.uri }/_design/#{ CGI.escape(model_name) }"
+    end
+
     def default_headers
       {
         :content_type => :json,

data/lib/loose_change/spatial.rb

@@ -0,0 +1,47 @@
+module LooseChange
+  module Spatial
+    # To define a spatial geometry property on a CouchDB document, use
+    # the geo_* methods as following:
+    #
+    #   class Bar < LooseChange::Base
+    #     geo_point :location
+    #     geo_multipoint :catchment_area
+    #   end
+    #
+    #   bar = Bar.new(:location => [41.3913, 73.9813])
+    #
+    # For information on geometries see the GeoJSON documentation at
+    # http://geojson.org/geojson-spec.html
+    
+    GEOMETRIES = %w(Point MultiPoint)
+
+    GEOMETRIES.each do |type|
+      define_method("geo_#{type}".downcase.to_sym) do |name|
+        design_doc = JSON.parse(RestClient.get(design_document_uri(database, model_name)))
+        function =<<JS
+        function(doc) {
+          if (doc.#{name} && doc.model_name == "#{ model_name }") {
+            emit({ type: "#{type}",
+                   coordinates: doc.#{name} },
+                 [doc._id, doc.#{name}]); }
+        }
+JS
+        RestClient.put(design_document_uri(database, model_name),
+                       design_doc.merge({"spatial" => (design_doc["spatial"] || {}).merge({ name => function })}).to_json, default_headers)
+        property(name)
+      end
+    end
+    
+    # Locate documents with a bounding box (defined as two coordinate
+    # pairs, from lower-left to upper-right).  The <tt>:name</tt>
+    # parameter identifies which location property to search.
+    #
+    #   Bar.by_bounding_box(:location, 40, 72, 43, 74)
+    def by_bounding_box(name, lat1, lng1, lat2, lng2)
+      JSON.parse(RestClient.get("#{ design_document_uri(database, model_name) }/_spatial/#{name}?bbox=#{ [lat1,lng1,lat2,lng2].join(',') }", default_headers))['rows'].map do |row|
+        find(row['id'])
+      end
+    end
+    
+  end
+end

data/lib/loose_change/views.rb

@@ -57,7 +57,7 @@ module LooseChange
     def add_view(name, map, reduce = nil)
       design_doc = JSON.parse(RestClient.get("#{ self.database.uri }/_design/#{ CGI.escape(self.model_name) }"))
       current_views = design_doc['views'] || {}
-      JSON.parse(RestClient.put("#{ self.database.uri }/_design/#{ self.model_name }",
+      JSON.parse(RestClient.put("#{ self.database.uri }/_design/#{ CGI.escape(self.model_name) }",
                                 { '_id' => design_doc['_id'],
                                   '_rev' => design_doc['_rev'],
                                   'language' => 'javascript',

data/lib/loose_change.rb

@@ -20,4 +20,5 @@ module LooseChange
   autoload :Views, File.dirname(__FILE__) + '/loose_change/views'
   autoload :Pagination, File.dirname(__FILE__) + '/loose_change/pagination'
   autoload :Helpers, File.dirname(__FILE__) + '/loose_change/helpers'
+  autoload :Spatial, File.dirname(__FILE__) + '/loose_change/spatial'
 end

data/loose_change.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{loose_change}
-  s.version = "0.3.7"
+  s.version = "0.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Joshua Miller"]
-  s.date = %q{2010-12-16}
+  s.date = %q{2010-12-22}
   s.email = %q{josh@joshinharrisburg.com}
   s.extra_rdoc_files = [
     "LICENSE",
@@ -34,6 +34,7 @@ Gem::Specification.new do |s|
      "lib/loose_change/pagination.rb",
      "lib/loose_change/persistence.rb",
      "lib/loose_change/server.rb",
+     "lib/loose_change/spatial.rb",
      "lib/loose_change/views.rb",
      "loose_change.gemspec",
      "test/attachment_test.rb",
@@ -44,6 +45,7 @@ Gem::Specification.new do |s|
      "test/pagination_test.rb",
      "test/persistence_test.rb",
      "test/resources/couchdb.png",
+     "test/spatial_test.rb",
      "test/test_helper.rb",
      "test/view_test.rb"
   ]
@@ -60,6 +62,7 @@ Gem::Specification.new do |s|
      "test/inheritance_test.rb",
      "test/pagination_test.rb",
      "test/persistence_test.rb",
+     "test/spatial_test.rb",
      "test/test_helper.rb",
      "test/view_test.rb"
   ]

data/test/spatial_test.rb

@@ -0,0 +1,55 @@
+require './test/test_helper'
+
+class SpatialTest < ActiveSupport::TestCase
+
+  context "a basic spatial model with a point" do
+    
+    setup do
+      class PointModel < LooseChange::Base
+        use_database "test_db"
+        geo_point :loc
+      end
+
+      PointModel.all.each(&:destroy)
+      
+      @model = PointModel.new(:loc => [40.813874, 77.858219])
+      @model.save
+    end
+    
+    should "have a lat,lng pair as a location" do
+      assert_equal [40.813874, 77.858219], @model.loc
+    end
+    
+    should "be findable in a bounding box" do
+      assert_equal [@model], PointModel.by_bounding_box(:loc, 0, 0, 41, 80)
+    end
+
+  end
+  
+  context "a spatial model with a multipoint" do
+    
+    setup do
+      class MPModel < LooseChange::Base
+        use_database "test_db"
+        geo_multipoint :loc
+      end
+
+      MPModel.all.each(&:destroy)
+      
+      @model = MPModel.new(:loc => [[40.813874, 77.858219], [42.134, 79.23434]])
+      @model.save
+    end
+
+    should "return its multipoint data" do
+      assert_equal [[40.813874, 77.858219], [42.134, 79.23434]], @model.loc
+    end
+    
+    should "be findable in a bounding box" do
+      assert_equal [@model], MPModel.by_bounding_box(:loc, 0, 0, 43, 80)
+      assert_equal [], MPModel.by_bounding_box(:loc, 0, 0, 40, 80)
+    end
+  
+  end
+  
+end
+

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 3
-  - 7
-  version: 0.3.7
+  - 4
+  - 0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Joshua Miller
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-16 00:00:00 -05:00
+date: 2010-12-22 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -105,6 +105,7 @@ files:
 - lib/loose_change/pagination.rb
 - lib/loose_change/persistence.rb
 - lib/loose_change/server.rb
+- lib/loose_change/spatial.rb
 - lib/loose_change/views.rb
 - loose_change.gemspec
 - test/attachment_test.rb
@@ -115,6 +116,7 @@ files:
 - test/pagination_test.rb
 - test/persistence_test.rb
 - test/resources/couchdb.png
+- test/spatial_test.rb
 - test/test_helper.rb
 - test/view_test.rb
 has_rdoc: true
@@ -131,7 +133,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 383827445871452727
+      hash: -1403901373339618448
       segments: 
       - 0
       version: "0"
@@ -158,5 +160,6 @@ test_files:
 - test/inheritance_test.rb
 - test/pagination_test.rb
 - test/persistence_test.rb
+- test/spatial_test.rb
 - test/test_helper.rb
 - test/view_test.rb