has_distance 1.0.0 → 1.1.0

data/README.rdoc

@@ -1,11 +1,73 @@
 = has_distance
 
-A Ruby gem to add has_distance to your ActiveRecord Model.
-has_distance is used for latitude/longitude distance lookup.
-It also works with SQLite
+A Ruby gem to add distance values to your ActiveRecord Model records.
 
-== Usage
+has_distance is used to return nearby records given the records latitude/longitude as its origin.
 
+A big plus as it also works with SQLite.
+
+== Configure
+
+Install the gem:
+    
+    gem install has_distance
+    
+In your Gemfile add it:
+
+    gem 'has_distance'
+
+From the command line install via bundle:
+    
+    bundle install
+
+Your ActiveRecord Model should have has_distance, for example:
+
+    class Store < ActiveRecord::Base
+      has_distance :distance
+    end
+
+has_distance supports the following fields for configuration:
+
+    * column_name  # => Default 'distance'
+    * lat_name     # => Default 'latitude'
+    * lng_name     # => Default 'longitude'
+    * units        # => Default :miles, possible values are: :miles, :kms, :nms
+    * distance     # => Default 20
+    * limit        # => Default 12
+
+has_distance can be configured with a block, for example:
+
+    class Store < ActiveRecord::Base
+      has_distance :distance do |config|
+        config.lat_name = 'lat'
+        config.lng_name = 'lng'
+        config.units    = :kms
+        config.distance = 3
+        config.limit    = 6
+      end
+    end
+
+
+== Actual Usage
+
+To use has_distance your database table should have two fields, one for latitude and the second for longitude.
+
+has_distance will provide an instance method called 'nearby'.
+
+Example:
+    
+    Store.first.nearby # Would return nearby stores based on the first store's origin, latitude & longitude.
+    
+    Store.first.nearby.each do |store|
+      # has_distance uses the column_name given in the configuration for distance
+      # In this case :distance was given, store.distance will return the actual distance away from the first store
+      store.distance
+    end
+    
+    Store.first.nearby(limit: 3) # => will limit nearby results to 3
+    Store.first.nearby.limit(3)  # => will also limit nearby results to 3
+    
+    Store.first.nearby(distance: 1) # => will limit nearby results to distance less than equal to 1
 
 == Contributing to has_distance
  

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.1.0

data/has_distance.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{has_distance}
-  s.version = "1.0.0"
+  s.version = "1.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Fernando Barajas"]
-  s.date = %q{2011-08-09}
+  s.authors = [%q{Fernando Barajas}]
+  s.date = %q{2011-09-24}
   s.description = %q{Used to find nearby records via latitude/longitude}
   s.email = %q{fernyb@fernyb.net}
   s.extra_rdoc_files = [
@@ -36,13 +36,12 @@ Gem::Specification.new do |s|
     "spec/support/test.db"
   ]
   s.homepage = %q{http://github.com/fernyb/has_distance}
-  s.licenses = ["MIT"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.7}
+  s.licenses = [%q{MIT}]
+  s.require_paths = [%q{lib}]
+  s.rubygems_version = %q{1.8.7}
   s.summary = %q{Adds has_distance to ActiveRecord}
 
   if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then

data/lib/has_distance/distance.rb

@@ -28,6 +28,14 @@ module HasDistance
             block.call(self.distance_config)
           end
         end
+
+        def nearby(opts={})
+          _config = self.distance_config
+          _this = new
+          _this.send("#{_config.lat_name}=".to_sym, opts.delete(:lat))
+          _this.send("#{_config.lng_name}=".to_sym, opts.delete(:lng))
+          _this.nearby(opts)
+        end
       end # ClassMethods
 
       module InstanceMethods

data/spec/has_distance_spec.rb

@@ -180,4 +180,16 @@ describe "Store" do
     end
   end
 
+  describe :nearby do
+    it "returns nearby results" do
+      store = Store.first
+      results = Store.nearby( :lat => store.latitude,
+                              :lng => store.longitude)
+      results.to_sql.should == 'SELECT  *, 
+            (ACOS(least(1,COS(0.5953003919287299)*COS(-2.0620890579387803)*COS(RADIANS(latitude))*COS(RADIANS(longitude))+
+            COS(0.5953003919287299)*SIN(-2.0620890579387803)*COS(RADIANS(latitude))*SIN(RADIANS(longitude))+
+            SIN(0.5953003919287299)*SIN(RADIANS(latitude))))*3963.19)
+            AS distance FROM "stores" GROUP BY id HAVING distance <= 20 LIMIT 12'
+    end
+  end
 end

metadata

@@ -1,131 +1,101 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: has_distance
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 1
-  - 0
-  - 0
-  version: 1.0.0
+version: !ruby/object:Gem::Version
+  version: 1.1.0
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Fernando Barajas
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-08-09 00:00:00 -07:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-09-24 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rails
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &2152611300 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 3
-        - 0
-        - 0
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 3.0.0
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *2152611300
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2152609280 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 2
-        - 3
-        - 0
+      - !ruby/object:Gem::Version
         version: 2.3.0
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: bundler
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *2152609280
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &2152607800 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 0
-        - 0
+      - !ruby/object:Gem::Version
         version: 1.0.0
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: jeweler
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: *2152607800
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &2152606960 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 6
-        - 4
+      - !ruby/object:Gem::Version
         version: 1.6.4
   type: :development
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: rcov
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: *2152606960
+- !ruby/object:Gem::Dependency
+  name: rcov
+  requirement: &2152605760 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
-  name: sqlite3
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  version_requirements: *2152605760
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &2152603780 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id006
-- !ruby/object:Gem::Dependency 
-  name: csv-mapper
   prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  version_requirements: *2152603780
+- !ruby/object:Gem::Dependency
+  name: csv-mapper
+  requirement: &2152602640 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id007
+  prerelease: false
+  version_requirements: *2152602640
 description: Used to find nearby records via latitude/longitude
 email: fernyb@fernyb.net
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - LICENSE.txt
 - README.rdoc
-files: 
+files:
 - .document
 - .rspec
 - Gemfile
@@ -143,37 +113,29 @@ files:
 - spec/support/store.rb
 - spec/support/stores.csv
 - spec/support/test.db
-has_rdoc: true
 homepage: http://github.com/fernyb/has_distance
-licenses: 
+licenses:
 - MIT
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.8.7
 signing_key: 
 specification_version: 3
 summary: Adds has_distance to ActiveRecord
 test_files: []
-