arel-haversine 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 1.9.3
+before_script:
+  - mysql -e 'create database arel_haversine_test;'
+  - psql -c 'create database arel_haversine_test;' -U postgres
+script: bundle exec rspec spec

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jacob Swanner
+
+MIT License
+
+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,44 @@
+# Arel::Haversine [![Build Status](https://secure.travis-ci.org/jswanner/arel-haversine.png?branch=master)](https://travis-ci.org/jswanner/arel-haversine)
+
+Provides haversine formula, implemented with Arel.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'arel-haversine'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install arel-haversine
+
+## Usage
+
+``` ruby
+require 'arel/haversine'
+
+class Location < ActiveRecord::Base
+  def self.in_order_of_proximity_to(latitude, longitude)
+    order(
+      Arel::Nodes::Haversine.new(
+        arel_table[:latitude],
+        arel_table[:longitude],
+        latitude,
+        longitude
+      )
+    )
+  end
+end
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/arel-haversine.gemspec

@@ -0,0 +1,29 @@
+# encoding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'arel/haversine/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'arel-haversine'
+  spec.version       = Arel::Haversine::VERSION
+  spec.authors       = ['Jacob Swanner']
+  spec.email         = ['jacob@jacobswanner.com']
+  spec.description   = %q{Provides haversine formula, implemented with Arel; which could be added to ActiveRecord scope, for instance.}
+  spec.summary       = %q{Provides haversine formula, implemented with Arel.}
+  spec.homepage      = 'https://github.com/jswanner/arel-haversine'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'arel'
+
+  spec.add_development_dependency 'activerecord', '>= 3'
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'mysql2'
+  spec.add_development_dependency 'pg'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '~> 2.11'
+end

data/lib/arel/haversine.rb

@@ -0,0 +1,3 @@
+require 'arel'
+require 'arel/haversine/version'
+require 'arel/nodes/haversine'

data/lib/arel/haversine/version.rb

@@ -0,0 +1,5 @@
+module Arel
+  module Haversine
+    VERSION = '0.0.1'
+  end
+end

data/lib/arel/nodes/haversine.rb

@@ -0,0 +1,89 @@
+module Arel
+  module Nodes
+    class Haversine < Function
+      def initialize lat1, lng1, lat2, lng2, options = nil
+        super Multiplication.new(
+          Arcsine.new(
+            Sqrt.new(
+              Addition.new(
+                Pow.new(Sine.new(Division.new(Radians.new(lat1 - lat2), 2)), 2),
+                Multiplication.new(
+                  Pow.new(Sine.new(Division.new(Radians.new(lng1 - lng2), 2)), 2),
+                  Multiplication.new(
+                    Cosine.new(Radians.new(lat2)),
+                    Cosine.new(Radians.new(lat1))
+                  )
+                )
+              )
+            )
+          ), diameter(options)
+        )
+      end
+
+      private
+
+      def diameter options
+        (options || {})[:unit] == :mi ? 7917.5 : 12742
+      end
+    end
+
+    %w[
+      Arcsine
+      Cosine
+      Radians
+      Sine
+      Sqrt
+    ].each do |name|
+      const_set name, Class.new(Unary)
+    end
+    Pow = Class.new(Binary)
+  end
+
+  module Visitors
+    module CommonMathVisitors
+      private
+
+      def visit_Arel_Nodes_Arcsine o
+        "ASIN(#{visit o.expr})"
+      end
+
+      def visit_Arel_Nodes_Cosine o
+        "COS(#{visit o.expr})"
+      end
+
+      def visit_Arel_Nodes_Pow o
+        "POW(#{visit o.left}, #{visit o.right})"
+      end
+
+      def visit_Arel_Nodes_Radians o
+        "RADIANS(#{visit o.expr})"
+      end
+
+      def visit_Arel_Nodes_Sine o
+        "SIN(#{visit o.expr})"
+      end
+
+      def visit_Arel_Nodes_Sqrt o
+        "SQRT(#{visit o.expr})"
+      end
+    end
+
+    class MySQL
+      include CommonMathVisitors
+    end
+
+    class PostgreSQL
+      include CommonMathVisitors
+    end
+
+    class ToSql
+      private
+
+      def visit_Arel_Nodes_Haversine o
+        visit(o.expressions).tap do |sql|
+          sql << " AS #{o.alias}" if o.alias
+        end
+      end
+    end
+  end
+end

data/spec/mysql_spec.rb

@@ -0,0 +1,10 @@
+require 'mysql2'
+require 'spec_helper'
+
+describe 'Haversine in MySQL', :mysql do
+  def parse_results results
+    results.first.first
+  end
+
+  include_examples 'distance calculations'
+end

data/spec/postgres_spec.rb

@@ -0,0 +1,10 @@
+require 'pg'
+require 'spec_helper'
+
+describe 'Haversine in PostgreSQL', :postgres do
+  def parse_results results
+    results.first['distance'].to_f
+  end
+
+  include_examples 'distance calculations'
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'bundler/setup'
+require 'arel/haversine'
+require 'active_record'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.order = 'random'
+end
+
+Dir[File.expand_path('../support/*.rb', __FILE__)].each { |file| require file }

data/spec/support/shared_contexts.rb

@@ -0,0 +1,17 @@
+shared_context 'MySQL connection', :mysql do
+  before :all do
+    ActiveRecord::Base.establish_connection(
+      adapter: 'mysql2',
+      database: 'arel_haversine_test'
+    )
+  end
+end
+
+shared_context 'Postgres connection', :postgres do
+  before :all do
+    ActiveRecord::Base.establish_connection(
+      adapter: 'postgresql',
+      database: 'arel_haversine_test'
+    )
+  end
+end

data/spec/support/shared_examples.rb

@@ -0,0 +1,31 @@
+shared_examples 'distance calculations' do
+  let(:google) { [37.422045, -122.084347] }
+  let(:haversine) { Arel::Nodes::Haversine.new(*google, *san_francisco, unit: unit) }
+  let(:query) { project(haversine.as('distance')).to_sql }
+  let(:result) { parse_results(execute(query)) }
+  let(:san_francisco) { [37.77493, -122.419416] }
+
+  context 'default unit' do
+    let(:unit) { nil }
+
+    it 'returns distance between two coordinates in kilometers' do
+      expect(result).to be_within(0.000_001).of(49.103_006)
+    end
+  end
+
+  context 'in kilometers' do
+    let(:unit) { :km }
+
+    it 'returns distance between two coordinates' do
+      expect(result).to be_within(0.000_001).of(49.103_006)
+    end
+  end
+
+  context 'in miles' do
+    let(:unit) { :mi }
+
+    it 'returns distance between two coordinates' do
+      expect(result).to be_within(0.000_001).of(30.511_148)
+    end
+  end
+end

data/spec/support/sql_helpers.rb

@@ -0,0 +1,7 @@
+def execute query
+  ActiveRecord::Base.connection.execute query
+end
+
+def project clause
+  Arel::SelectManager.new(ActiveRecord::Base).project clause
+end

metadata

@@ -0,0 +1,182 @@
+--- !ruby/object:Gem::Specification
+name: arel-haversine
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jacob Swanner
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: arel
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+description: Provides haversine formula, implemented with Arel; which could be added
+  to ActiveRecord scope, for instance.
+email:
+- jacob@jacobswanner.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- arel-haversine.gemspec
+- lib/arel/haversine.rb
+- lib/arel/haversine/version.rb
+- lib/arel/nodes/haversine.rb
+- spec/mysql_spec.rb
+- spec/postgres_spec.rb
+- spec/spec_helper.rb
+- spec/support/shared_contexts.rb
+- spec/support/shared_examples.rb
+- spec/support/sql_helpers.rb
+homepage: https://github.com/jswanner/arel-haversine
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Provides haversine formula, implemented with Arel.
+test_files:
+- spec/mysql_spec.rb
+- spec/postgres_spec.rb
+- spec/spec_helper.rb
+- spec/support/shared_contexts.rb
+- spec/support/shared_examples.rb
+- spec/support/sql_helpers.rb