on_the_map 0.1.0 → 0.1.1

data/Changelog.md

@@ -0,0 +1,8 @@
+## 0.1.1
+
+- Fixed geolocatable_spec
+- Delegate #geolocatable? to #address
+
+## 0.1.0
+
+First release

data/README.md

@@ -11,42 +11,67 @@ Contains various useful concern modules for:
 * geo spatial indexing of position
 * geo spatial searching on position
 
-* Adressable
+The code examples below use the concerned gem to include the concern modules into a class.
+You can use a simple `include OnTheMap::XXXX` in its place or some other concern related API of your choice.
 
 ### Adressable
 
-* embeds an address on the model
-* adds delegate methods to all embedded address fields
+* embeds an `address` on the model
+* adds delegate methods to all embedded address fields (setters/getters)
 * adds `full_address` method that returns full adress from concatenation of all fields
 
+Address fields: `city, state, state_code, province, province_code, postal_code, country, country_code`
+
+```ruby
+class MyModel
+  include Mongoid::Document
+
+  include_concern :addressable, from: :on_the_map
+end
+```
+
 ### GeoLocatable
 
 * includes `addressable` and `positionable` concerns
-* performs geocoding after an address is created or updated
-* adds `latitude` and `longitude` methods to model
+* performs geocoding to calculate new position after an address is created or updated
+* adds `latitude` and `longitude` to model
+
+```ruby
+class MyModel
+  include Mongoid::Document
+
+  include_concerns :geo_locatable, from: 'OnTheMap'
+end
+```
 
 ### Mappable
 
 * include `Gmaps4rails::ActsAsGmappable`
-* adds field `normalized_address` to store address calculated and returned by Google Maps geo-coding
-* adds method `gmaps4rails_address` which returns main adress for use in geo-coding
+* adds field `normalized_address` to store full address calculated and returned by Google Maps geo-coding
+* adds method `gmaps4rails_address` which returns adress used in gmaps geo-coding (if enabled)
+* includes `geo_locatable` and `positionable` concerns.
+
+```ruby
+class MyModel
+  include Mongoid::Document
+
+  include_concerns :mappable, from: 'OnTheMap'
+end
+```
 
 ### Positionable
 
-* includes `Mongoid::Geospatial` into the model to make GeoSpatial helpers available directly on the model
+* includes `Mongoid::Geospatial` into the model to make GeoSpatial methods available
 * Adds geo_field `position` (macro from Mongoid GeoSpatial)
 * adds spatial indexing for position field
-
 * positon field is indexed and used in geo-searches (fx find points near a point)
 
-## Usage
-
 ```ruby
-  include_concerns :addressable,    from: :on_the_map
-  include_concerns :mappable,       from: :on_the_map
-  include_concerns :positionable,   from: :on_the_map
+class MyModel
+  include Mongoid::Document
 
-  include_concerns :geo_locatable,  from: :on_the_map
+  include_concerns :positionable, from: 'OnTheMap'
+end
 ```
 
 See the specs for examples on how to use these concerns. 

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/lib/address.rb

@@ -1,7 +1,7 @@
 class Address
   # include BasicDocument
   include Mongoid::Document
-  include Mongoid::Dirty
+  # include Mongoid::Dirty
 
   after_update :perform_geocoding
 

data/lib/on_the_map/addressable.rb

@@ -30,7 +30,7 @@ module OnTheMap
         end
       end
 
-      delegate :region, to: :address              
+      delegate :region, :geolocatable?, to: :address              
     end
 
     def perform_geocoding? name

data/lib/on_the_map/geo_locatable.rb

@@ -30,9 +30,10 @@ module OnTheMap
 
             obj.geocoded = true
 
-            if obj.respond_to? :gmaps
-              obj.gmaps = true 
-            end
+            # apparently not needed! (according to author of gmaps4rails)
+            # if obj.respond_to? :gmaps
+            #   obj.gmaps = true 
+            # end
 
             obj.send(:geocoding_done!)
           end

data/on_the_map.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "on_the_map"
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kristian Mandrup"]
-  s.date = "2013-03-04"
+  s.date = "2013-03-11"
   s.description = "Makes it easy to add functionality to models related to geocoding, addressing and placing them as pins on a map"
   s.email = "kmandrup@gmail.com"
   s.extra_rdoc_files = [
@@ -19,6 +19,7 @@ Gem::Specification.new do |s|
   s.files = [
     ".document",
     ".rspec",
+    "Changelog.md",
     "Gemfile",
     "Gemfile.lock",
     "LICENSE.txt",

data/spec/on_the_map/addressable_spec.rb

@@ -18,7 +18,7 @@ describe OnTheMap::Addressable do
   subject { address }
 
   context 'blank/empty address' do
-    let(:address) { MyGeoCodableAddress.create street: '', city: ''  }
+    let(:address) { MyGeoCodedAddress.create street: '', city: ''  }
 
     it 'should have a blank full address' do
       expect(subject.address.full).to be_blank

data/spec/on_the_map/mappable_spec.rb

@@ -77,8 +77,9 @@ describe OnTheMap::Mappable do
       # leave geocoding to geocoder!
       its(:gmaps_geocode?)  { should be_false }    
 
-      # geocoder sets gmaps when position has been calculated
-      its(:gmaps)   { should be_true }
+      # geocoder sets gmaps when position has been calculated?
+      # Note: not done anymore
+      its(:gmaps)   { should be_false }
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: on_the_map
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-04 00:00:00.000000000 Z
+date: 2013-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongoid
@@ -166,6 +166,7 @@ extra_rdoc_files:
 files:
 - .document
 - .rspec
+- Changelog.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -203,7 +204,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4362256846175368484
+      hash: -3810047604221837472
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: