ohm-geoindex 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a5b65c68b782f3ddb94c7699e53c798dc576bb4f
+  data.tar.gz: b04e62c93ac40539b1768db926ec2c123dac4942
+SHA512:
+  metadata.gz: c604e68cd439e13922f828b0d4661c8daabb5ef331be92c4d73f7f635637d537f8e58937b5e926d5907dcd879daaf820ec657ac3cdcfe6162a2b60c8eeea8c16
+  data.tar.gz: 67d6b3dfeacec7a30d7a1c7314227b81a0e3ffde14b875d92c027063493e40b383247f4837abe571d613797b36cc55c1f6a1727e4e45acbeab70881de7b33fa4

data/.gitignore

@@ -0,0 +1,6 @@
+.DS_Store
+.bundle
+Gemfile.lock
+test/redis-server
+test/tmp
+vendor/*

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+script: 'rake test'
+env:
+  - REDIS_BRANCH=unstable
+services: 
+  - redis-server

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+# gem 'rake'
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Eliot Shepard
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,62 @@
+ohm-geoindex
+=============
+
+### In early development. Requires Redis >= 3.2.
+
+<!-- [![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.
+
+Setup
+-----
+
+1. Add the gem:
+
+```ruby
+gem 'ohm-geoindex'
+````
+
+1. Include the module in your model:
+
+```ruby
+include Ohm::Geoindex 
+```
+
+1. Add a geospatial index to your model with the following:
+
+```ruby
+geoindex [:longitude, :latitude]	# :longitude, :latitude are attributes
+```
+
+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
+
+>> Beach.within(@coogee, '10 km', 'asc')
+=> [@coogee, @bondi]
+>> Beach.within(@coogee, '10 mi', 'desc')
+=> [@manly, @bondi, @coogee]
+>> Beach.within([151.257566, -33.921017], '10 mi', '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.
+
+Tests
+--------------
+
+`rake` will attempt to start a redis binary at ./test/redis-server at port 7771 for the duration of the test run.
+
+Requirements
+------------
+
+This plugin works with Ohm >= 2.2.0.
+

data/Rakefile

@@ -0,0 +1,39 @@
+require "bundler/setup"
+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
+
+task :default => [:setup, :_test, :teardown]
+
+desc "Start the Redis server"
+task :setup do
+  unless File.exists?(REDIS_PID)
+    system "#{File.join(File.dirname(__FILE__), 'test', 'redis-server')} --port #{REDIS_PORT} --pidfile #{REDIS_PID} --logfile #{REDIS_LOG} --daemonize yes"
+  end
+end
+
+desc "Stop the Redis server"
+task :teardown do
+  if File.exists?(REDIS_PID)
+    system "kill #{File.read(REDIS_PID)}"
+    File.delete(REDIS_PID)
+  end
+end
+
+# wrap :test so that we can still teardown
+task :_test do
+  begin
+    Rake::Task[:test].invoke
+  rescue Exception => e
+    puts e
+  end
+end
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/*_test.rb']
+  # t.verbose = true
+  ENV["REDIS_URL"] = "redis://127.0.0.1:#{REDIS_PORT.to_s}/0"
+end

data/lib/ohm/geoindex.rb

@@ -0,0 +1,63 @@
+require 'ohm'
+
+module Ohm
+  module Geoindex
+    VERSION = "0.0.1"
+    
+    def self.included(model)
+      begin
+        Ohm.redis.call!('GEOADD')
+      rescue RuntimeError => e
+        raise "This version of Redis (#{Ohm.redis.url}) does not support the geospatial API." if e.message =~ /unknown command/
+      end
+
+      model.extend(ClassMethods)
+    end
+
+    def save
+      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)
+      redis.queue('EXEC')
+      redis.commit
+      self
+    end
+
+    def delete
+      redis.call('ZREM', self.class.key[:geoindex], self.id)
+      super
+    end
+
+    module ClassMethods
+      def geoindex(coords)
+        @geoindex = coords
+      end
+
+      def within(center, radius, withdist: nil, sort: nil)
+        raise IndexNotFound unless @geoindex
+        args = center.is_a?(self.ancestors.first) ? ['GEORADIUSBYMEMBER', key[:geoindex], center.id] : ['GEORADIUS', key[:geoindex], *center]
+        args << parse_radius(radius)
+        args << sort if sort
+        args << 'withdist' if withdist
+        results = redis.call(*args.flatten)
+
+        # extract ids so we can fetch all at once
+        # can be [:id, :id, ...] or [[:id, :dist], [:id, :dist], ...]
+        ids = results.map { |r| [*r][0] }
+        models = self.ancestors.first.fetch(ids)
+
+        if withdist
+          results.each_with_index.map { |r,i| [models[i], r[1].to_f] }
+        else
+          models
+        end
+      end
+
+      protected
+        def parse_radius(r)
+          r.downcase.strip.scan(/(\d+)\s*(\S+)/).flatten
+        end
+    end
+  end
+end

data/ohm-geoindex.gemspec

@@ -0,0 +1,15 @@
+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.author      = "Eliot Shepard"
+  s.email       = "eshepard@slower.net"
+  s.files       = `git ls-files`.split("\n")
+  s.homepage    = 'https://github.com/slowernet/ohm-geoindex'
+  s.license     = 'MIT'
+
+  s.add_dependency "ohm", '>= 2.2.0'
+  s.add_development_dependency 'test-unit'
+end

data/test/geoindex_test.rb

@@ -0,0 +1,81 @@
+require 'test/unit'
+require 'ohm'
+require 'ohm/geoindex'
+
+Ohm.redis = Redic.new(ENV["REDIS_URL"])
+
+class Beach < Ohm::Model
+  include Ohm::Geoindex
+
+  attribute :longitude
+  attribute :latitude
+  geoindex [:longitude, :latitude]
+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
+  end
+
+  def test_without_sort
+    a = Beach.within(@coogee, '10 km')
+    assert_equal(2, a.size)
+  end
+
+  def test_within_by_object
+    a = Beach.within(@coogee, '10 km', sort: 'asc')
+    assert_equal([@coogee, @bondi], a)
+    a = Beach.within(@coogee, '20 km', sort: 'asc')
+    assert_equal([@coogee, @bondi, @manly], a)
+  end
+
+  def test_within_by_coords
+    a = Beach.within([151.257566, -33.921017], '10 km', sort: 'desc') # coogee
+    assert_equal(2, a.size)
+    assert_equal(@coogee, a.last)
+  end
+
+  def test_within_with_distance
+    a = Beach.within(@coogee, '10 km', sort: 'asc', withdist: true)
+    assert_equal(2, a.size)
+    assert_equal([@bondi, 3.7550], a.last)
+    a = Beach.within(@coogee, '10 km', withdist: true)
+    assert_equal(2, a.size)
+  end
+
+  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
+    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)
+    assert_equal(b, c)    
+  end
+
+  def test_radius_parsing
+    a = Beach.within(@coogee, '10 km', sort: 'asc')
+    assert_equal([@coogee, @bondi], a)
+    a = Beach.within(@coogee, '10000m', sort: 'asc')
+    assert_equal([@coogee, @bondi], a)
+    assert_raise do
+      a = Beach.within(@coogee, 'one billion feet', 'asc')
+    end
+  end
+
+  def test_sort
+    a = Beach.within(@coogee, '10 km', sort: 'asc')
+    assert_equal([@coogee, @bondi], a)
+    a = Beach.within(@coogee, '10000m', sort: 'desc')
+    assert_equal([@bondi, @coogee], a)
+  end
+
+  def test_index_delete
+    [@bondi, @coogee, @manly].each_with_index do |b, i|
+      b.delete 
+      assert_equal(3-(i+1), Ohm.redis.call('ZCARD', Beach.key[:geoindex]))
+    end
+  end
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: ohm-geoindex
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Eliot Shepard
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ohm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email: eshepard@slower.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/ohm/geoindex.rb
+- ohm-geoindex.gemspec
+- test/geoindex_test.rb
+- test/tmp/.gitkeep
+homepage: https://github.com/slowernet/ohm-geoindex
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Geoindices for Ohm (on Redis 3.2+)
+test_files: []