ohm-geoindex 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a5b65c68b782f3ddb94c7699e53c798dc576bb4f
-  data.tar.gz: b04e62c93ac40539b1768db926ec2c123dac4942
+  metadata.gz: b0df31f7ce55dccb5db41ff451c27b638b601697
+  data.tar.gz: da98c5300d8050312ad692499ec26d7d91d35c9d
 SHA512:
-  metadata.gz: c604e68cd439e13922f828b0d4661c8daabb5ef331be92c4d73f7f635637d537f8e58937b5e926d5907dcd879daaf820ec657ac3cdcfe6162a2b60c8eeea8c16
-  data.tar.gz: 67d6b3dfeacec7a30d7a1c7314227b81a0e3ffde14b875d92c027063493e40b383247f4837abe571d613797b36cc55c1f6a1727e4e45acbeab70881de7b33fa4
+  metadata.gz: da972d8ea43b074973b1c80e3ca08cd4acce50da15ddfe8b9c6ae5306952dfec8137cbfc972b9142e33600e58c01757bc4ca49213c487878e5eb14131fe2e76b
+  data.tar.gz: d333e5d8359ccc5e24684516633ab1ba2ae6396dcafa35e911caf167496289b47f7e2999d992aa18d681e6fa52d6f54229d7f9a0bc8f465151ece172b8920956

data/README.md

@@ -5,7 +5,7 @@ ohm-geoindex
 
 <!-- [![Build Status](https://travis-ci.org/slowernet/ohm-geoindex.png?branch=master)](https://travis-ci.org/slowernet/ohm-geoindex) -->
 
-A plugin for [Ohm](https://github.com/soveran/ohm) models which enables radius queries via the Redis geospatial API.
+A plugin for [Ohm](https://github.com/soveran/ohm) models which enables basic geospatial queries via the Redis [geohashing](http://redis.io/commands#geo) [API](http://cristian.regolo.cc/2015/07/07/introducing-the-geo-api-in-redis.html).
 
 Setup
 -----
@@ -13,50 +13,59 @@ Setup
 1. Add the gem:
 
 ```ruby
-gem 'ohm-geoindex'
+gem 'ohm-geoindex', require: 'ohm/geoindex'
 ````
 
-1. Include the module in your model:
+2. Include the module in your model and specify the attributes to be indexed. (Note that `(longitude, latitude)` is the ordering convention used throughout the geo API.)
 
 ```ruby
-include Ohm::Geoindex 
-```
-
-1. Add a geospatial index to your model with the following:
+class Beach < Ohm::Model
+  include Ohm::Geoindex 
 
-```ruby
-geoindex [:longitude, :latitude]	# :longitude, :latitude are attributes
+  attribute :latitude
+  attribute :longitude
+  geoindex [:longitude, :latitude]
+end
 ```
 
-Note that `(lon,lat)` is the universal ordering convention for the Redis geospatial API.
-
 Usage
 -----
 
 To perform a radius query, use the `within` class method.
 
 ```ruby
-@manly = Beach.create(latitude: -33.797948, longitude: 151.289414)
-@bondi = Beach.create(latitude: -33.891472, longitude: 151.277243)
-@coogee = Beach.create(latitude: -33.921017, longitude: 151.257566) # ~14km from manly
+>> @manly = Beach.create(latitude: -33.797948, longitude: 151.289414)
+>> @bondi = Beach.create(latitude: -33.891472, longitude: 151.277243)
+>> @coogee = Beach.create(latitude: -33.921017, longitude: 151.257566) # ~14km from manly
 
->> Beach.within(@coogee, '10 km', 'asc')
-=> [@coogee, @bondi]
->> Beach.within(@coogee, '10 mi', 'desc')
+>> Beach.within(@coogee, '10 mi', sort: 'desc')
 => [@manly, @bondi, @coogee]
->> Beach.within([151.257566, -33.921017], '10 mi', 'asc')	# coords are @coogee's
+>> Beach.within(@coogee, '10 km', sort: 'asc', withdist: true)
+=> [@coogee, @bondi]
+>> Beach.within([151.257566, -33.921017], '10 mi', sort: 'asc')	# coords are @coogee's
 => [@coogee, @bondi, @manly]
 ```
 
-See the Redis docs for [`GEORADIUS`](http://redis.io/commands/georadius) and [`GEOADD`](http://redis.io/commands/geoadd) for radius unit syntax.
+See the Redis docs for [`GEORADIUS`](http://redis.io/commands/georadius) and [`GEOADD`](http://redis.io/commands/geoadd) for allowed unit syntax.
 
 Tests
---------------
+-----
 
-`rake` will attempt to start a redis binary at ./test/redis-server at port 7771 for the duration of the test run.
+Because the geo API is only currently available in Redis' unstable branch, `rake test` attempts to start a local redis binary at ./test/redis-server port 7771 for the test run.
 
 Requirements
 ------------
 
 This plugin works with Ohm >= 2.2.0.
 
+Changelog
+---------
+
+0.0.2
+
+* Correct implicit expectation of indexed attribute names.
+
+0.0.1
+
+* Initial release
+

data/Rakefile

@@ -3,7 +3,7 @@ require "rake/testtask"
 
 REDIS_PID = File.join(File.dirname(__FILE__), "test", "tmp", "redis.pid")
 REDIS_LOG = File.join(File.dirname(__FILE__), "test", "tmp", "redis.log")
-REDIS_PORT = 7771
+REDIS_PORT = ENV['REDIS_PORT'] || 7771
 
 task :default => [:setup, :_test, :teardown]
 

data/lib/ohm/geoindex.rb

@@ -2,7 +2,7 @@ require 'ohm'
 
 module Ohm
   module Geoindex
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
     
     def self.included(model)
       begin
@@ -18,7 +18,8 @@ module Ohm
       super
       redis.queue('MULTI')
       redis.queue('ZREM', self.class.key[:geoindex], self.id)
-      redis.queue('GEOADD', self.class.key[:geoindex], self.longitude, self.latitude, self.id)
+      coordinates = self.class.instance_variable_get('@geoindex').map { |d| attributes[d] }
+      redis.queue('GEOADD', self.class.key[:geoindex], *coordinates, self.id)
       redis.queue('EXEC')
       redis.commit
       self
@@ -36,6 +37,8 @@ module Ohm
 
       def within(center, radius, withdist: nil, sort: nil)
         raise IndexNotFound unless @geoindex
+        raise raise ArgumentError, "center must be a set of coordinates or model already in the index." unless center
+
         args = center.is_a?(self.ancestors.first) ? ['GEORADIUSBYMEMBER', key[:geoindex], center.id] : ['GEORADIUS', key[:geoindex], *center]
         args << parse_radius(radius)
         args << sort if sort

data/ohm-geoindex.gemspec

@@ -3,7 +3,7 @@ require File.expand_path('../lib/ohm/geoindex', __FILE__)
 Gem::Specification.new do |s|
   s.name        = 'ohm-geoindex'
   s.version     = Ohm::Geoindex::VERSION
-  s.summary     = %q{Geoindices for Ohm (on Redis 3.2+)}
+  s.summary     = %q{Geoindices for Ohm::Model (on Redis 3.2+)}
   s.author      = "Eliot Shepard"
   s.email       = "eshepard@slower.net"
   s.files       = `git ls-files`.split("\n")

data/test/geoindex_test.rb

@@ -7,17 +7,17 @@ Ohm.redis = Redic.new(ENV["REDIS_URL"])
 class Beach < Ohm::Model
   include Ohm::Geoindex
 
-  attribute :longitude
-  attribute :latitude
-  geoindex [:longitude, :latitude]
+  attribute :lng
+  attribute :lat
+  geoindex [:lng, :lat]
 end
 
 class GeoindexTest < Test::Unit::TestCase
   def setup
     Ohm.flush
-    @manly = Beach.create(longitude: 151.289414, latitude: -33.797948)
-    @bondi = Beach.create(longitude: 151.277243, latitude: -33.891472)
-    @coogee = Beach.create(longitude: 151.257566, latitude: -33.921017) # ~14km from manly
+    @manly = Beach.create(lng: 151.289414, lat: -33.797948)
+    @bondi = Beach.create(lng: 151.277243, lat: -33.891472)
+    @coogee = Beach.create(lng: 151.257566, lat: -33.921017) # ~14km from manly
   end
 
   def test_without_sort
@@ -48,7 +48,7 @@ class GeoindexTest < Test::Unit::TestCase
 
   def test_index_update
     a = Ohm.redis.call('ZSCORE', @bondi.class.key[:geoindex], @bondi.id)
-    @bondi.update(latitude: -33.921017, longitude: 151.257566)  # bondi moves to coogee
+    @bondi.update(lat: -33.921017, lng: 151.257566)  # bondi moves to coogee
     b = Ohm.redis.call('ZSCORE', @bondi.class.key[:geoindex], @bondi.id)
     assert_not_equal(a, b)
     c = Ohm.redis.call('ZSCORE', @bondi.class.key[:geoindex], @coogee.id)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ohm-geoindex
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Eliot Shepard
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-18 00:00:00.000000000 Z
+date: 2015-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ohm
@@ -77,5 +77,5 @@ rubyforge_project:
 rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
-summary: Geoindices for Ohm (on Redis 3.2+)
+summary: Geoindices for Ohm::Model (on Redis 3.2+)
 test_files: []