tillless-core 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/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in tillless-core.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,24 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb|\.haml)$})                 { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+
+  # Capybara request specs
+  watch(%r{^app/views/(.+)/.*\.(erb|haml)$})          { |m| "spec/requests/#{m[1]}_spec.rb" }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$})   { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance' }
+end
+

data/README.md

@@ -0,0 +1,29 @@
+# Tillless::Core
+
+Utilities used across Tillless
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'tillless-core'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tillless-core
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/tillless-core.rb

@@ -0,0 +1,13 @@
+module Tillless
+  require 'tillless-core/version'
+  require 'tillless-core/location'
+end
+
+# This is only necessary for when the utilities are pulled into the RubyMotion app
+if defined?(Motion::Project::Config)
+  Motion::Project::App.setup do |app|
+    Dir.glob(File.join(File.dirname(__FILE__), 'tillless-core/*.rb')).each do |file|
+      app.files.unshift(file)
+    end
+  end
+end

data/lib/tillless-core/location.rb

@@ -0,0 +1,235 @@
+# tillless-core/lib/tillless-core/location.rb
+module Tillless
+  module Location
+
+    # Radius of the Earth in km
+    RADIUS_OF_EARTH = Float(6378.7)
+
+    # Minimum distance apart to be considered 'near' in km
+    MIN_DISTANCE_FOR_NEARBY_IN_KM = 0.2
+    MIN_DISTANCE_FOR_NEARBY_IN_M  = MIN_DISTANCE_FOR_NEARBY_IN_KM * 1000.0
+
+    # Shorthand for Pi Radians
+    PI_RADIANCE = (Math::PI / 180)
+
+    # Factor used in great circle calcs
+    GREAT_CIRCLE_FACTOR = 57.2958
+
+    # Class for raising exceptions
+    class LocationCalibrationException < Exception
+    end
+
+    def self.included(base)
+      base.send :include, InstanceMethods
+      base.send :extend, ClassMethods
+
+      # Set the right attr method if a rails environment (assuming it's an ActiveRecord model)
+      if defined?(Rails.env)
+        base.send :attr_accessible, :lat, :lon
+        base.send :validates_presence_of, :lat, :lon
+        # Always recalibrate on save
+        base.send :before_save, :calibrate
+        base.send :include, RailsInstanceMethods
+      else
+        base.send :include, RubyInstanceMethods
+
+        attr_accessor :lat, :lon
+
+        # true if calibrated, note: following lat= or lon= it will need to be re-calibrated
+        attr_accessor :calibrated
+
+        # These are used so that half of the Great Circle algorithm can be calculated on
+        # instantiation which makes any subsequent comparison check significantly faster.
+        # See calibrate() for more details.
+        attr_accessor :term1, :term2, :term3, :term4, :term5, :term6
+      end
+    end
+
+    module ClassMethods
+      # Empty at this stage
+    end
+
+    module RailsInstanceMethods
+      # updated setters to decalibrate if lan/lon attributes updated without save
+      def lat=(val)
+        self.calibrated = false
+        super(val)
+      end
+
+      def lon=(val)
+        self.calibrated = false
+        super(val)
+      end
+
+      def term1=(val)
+        self.calibrated = false
+        super(val)
+      end
+
+      def term2=(val)
+        self.calibrated = false
+        super(val)
+      end
+
+      def term3=(val)
+        self.calibrated = false
+        super(val)
+      end
+
+      def term4=(val)
+        self.calibrated = false
+        super(val)
+      end
+
+      def term5=(val)
+        self.calibrated = false
+        super(val)
+      end
+
+      def term6=(val)
+        self.calibrated = false
+        super(val)
+      end
+    end
+
+    module RubyInstanceMethods
+      # Assumes that :lat and :lon are Doubles / Floats
+      def initialize(hash = {})
+
+        # lat and lon coordinates of loation
+        @lat = hash[:lat]
+        @lon = hash[:lon]
+
+        # components of the Great Circle formula
+        @term1  = 0.0;
+        @term2  = 0.0;
+        @term3  = 0.0;
+        @term4  = 0.0;
+        @term5  = 0.0;
+        @term6  = 0.0;
+
+        # calibrate on creation to do first half of Great Circle calculation
+        calibrate
+      end
+
+      # These methods are only valid for a ruby class and will break an ActiveRecord model
+      # Set lat value for the location and mark the location as !calibrated
+      def lat=(_lat)
+        @lat = _lat
+        @calibrated = false
+      end
+
+      #Set lon value for the location and mark the location as !calibrated
+      def lon=(_lon)
+        @lon = lon
+        @calibrated = false
+      end
+
+      # private
+
+      # # Mark location as !calibrated if any changes are made to any of the terms
+      # def term1=(_lon)
+      #   @lon = lon
+      #   @calibrated = false
+      # end
+
+      # def term2=(_lon)
+      #   @lon = lon
+      #   @calibrated = false
+      # end
+
+      # def term3=(_lon)
+      #   @lon = lon
+      #   @calibrated = false
+      # end
+
+      # def term4=(_lon)
+      #   @lon = lon
+      #   @calibrated = false
+      # end
+
+      # def term5=(_lon)
+      #   @lon = lon
+      #   @calibrated = false
+      # end
+
+      # def term6=(_lon)
+      #   @lon = lon
+      #   @calibrated = false
+      # end
+
+      # def calibrated=(val)
+      #   @calibrated = val
+      # end
+    end
+
+    module InstanceMethods
+      # Set both lat and lon and recalibrate in the one go
+      def set_and_calibrate(_lat, _lon)
+        self.lat = _lat
+        self.lon = _lon
+        calibrate
+      end
+
+      # Pre-calculate the various terms of the Great Circle Distance Formula
+      #
+      #   Tillless::Location::RADIUS_OF_EARTH *                            # Radius of Earth in KM
+      #     acos[
+      #        sin(lat1/57.2958) *                     # term1
+      #        sin(lat2/57.2958) +                     # term2
+      #        cos(lat1/57.2958) *                     # term3
+      #        cos(lat2/57.2958) *                     # term4
+      #        cos(
+      #            lon2/57.2958  -                     # term5
+      #            lon1/57.2958)                       # term6
+      #     ]
+      def calibrate
+        self.term1 = Math.sin(self.lat/Tillless::Location::GREAT_CIRCLE_FACTOR)
+        self.term2 = Math.sin(self.lat/Tillless::Location::GREAT_CIRCLE_FACTOR)
+        self.term3 = Math.cos(self.lat/Tillless::Location::GREAT_CIRCLE_FACTOR)
+        self.term4 = Math.cos(self.lat/Tillless::Location::GREAT_CIRCLE_FACTOR)
+        self.term5 = self.lon/Tillless::Location::GREAT_CIRCLE_FACTOR
+        self.term6 = self.lon/Tillless::Location::GREAT_CIRCLE_FACTOR
+        self.calibrated = true
+      end
+
+      # Calculate the great circle distance between this GeoLocation
+      # and the specified other location. This uses the formula specified
+      # here: http://www.meridianworlddata.com/Distance-Calculation.asp
+      #
+      # The formula used to calculate the Great Circle Distance is:
+      #
+      # RADIUS_OF_EARTH * acos[sin(lat1/57.2958) * sin(lat2/57.2958) + cos(lat1/57.2958) * cos(lat2/57.2958) * cos(lon2/57.2958 - lon1/57.2958)]
+      #
+      # Where: lat1/lon1 is the lat and lon of this Location, and lat2/lon2 is the lat and lon of the other location.
+      #
+      # :otherloc  location to compare with
+      # return     great circle distance from here to otherloc
+      # raises     LocationCalibrationException if either self or otherloc are not calibrated
+      #
+      def great_circle_distance_from_here_to(otherloc)
+        raise Tillless::Location::LocationCalibrationException if ! (self.calibrated and otherloc.calibrated)
+        stage1 = self.term1 * otherloc.term2 +
+                 self.term3 * otherloc.term4 *
+                 Math.cos(self.term5 - otherloc.term6)
+        # fix floating point roudning error that manifests in ActiveRecord and Postgres
+        stage1 = stage1.round if stage1 < -1 or stage1 > 1
+        Tillless::Location::RADIUS_OF_EARTH * Math.acos(stage1)
+      end
+
+      # Test to see if the specified location is near this one, where
+      # 'near' means within 100 meters.
+      #
+      # :otherloc      location to check
+      # :min_distance  minimum distance for which to be considered 'nearby', default = Tillless::Location::MIN_DISTANCE_FOR_NEARBY_IN_KM
+      # return         true if the specified location is near this one
+      # raises         LocationCalibrationException if either self or otherloc are not calibrated
+      #
+      def nearby?(otherloc, min_distance = Tillless::Location::MIN_DISTANCE_FOR_NEARBY_IN_KM)
+        raise Tillless::Location::LocationCalibrationException if ! (self.calibrated and otherloc.calibrated)
+        ( (great_circle_distance_from_here_to(otherloc) - min_distance) <= 0.0)
+      end
+    end
+  end
+end
+

data/lib/tillless-core/version.rb

@@ -0,0 +1,3 @@
+module Tillless
+    VERSION = "0.0.1"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+# /tillless/server/tillless-core/spec/spec_helper.rb
+
+require 'tillless-core'
+
+
+RSpec.configure do |config|
+  # Use color in STDOUT
+  config.color_enabled = true
+
+  # Use color not only in STDOUT but also in pagers and files
+  config.tty = true
+
+  # Use the specified formatter
+  # config.formatter = :documentation # :documentation, :progress, :html, :textmate
+end

data/spec/tillless-core/location_spec.rb

@@ -0,0 +1,135 @@
+# tillless-core/spec/tillless-core/location_spec.rb
+
+require 'spec_helper'
+
+module Tillless
+  describe Location do
+
+    before(:all) do
+      # 127 Talga Road Rothbury NSW Australia
+      @talgard_lat = -32.73075
+      @talgard_lon = 151.37991
+
+      # North Sydney Post Office, North Sydney NSW Australia
+      @northsydpo_lat = -33.8384945
+      @northsydpo_lon = 151.2064807
+
+      # 2/10 Holdsworth Street Neutral Bay NSW Australia
+      @holdsworthst_lat = -33.838236
+      @holdsworthst_lon = 151.214478
+
+      # 34 Ryan Street Lilyfield NSW 2040 Australia
+      @ryanst_lat = -33.870203
+      @ryanst_lon = 151.167256
+
+      class MockLocation
+        include Location
+        # Create a new MockLocation
+      end
+    end
+
+    before(:each) do
+      @talgard      = MockLocation.new(lat: @talgard_lat,      lon: @talgard_lon)
+      @northsydpo   = MockLocation.new(lat: @northsydpo_lat,   lon: @northsydpo_lon)
+      @holdsworthst = MockLocation.new(lat: @holdsworthst_lat, lon: @holdsworthst_lon)
+      @ryanst       = MockLocation.new(lat: @ryanst_lat,       lon: @ryanst_lon)
+    end
+
+    it 'should have lattitude and longitude' do
+      @talgard.lat.should_not be nil
+      @talgard.lon.should_not be nil
+      @northsydpo.lat.should_not be nil
+      @northsydpo.lon.should_not be nil
+      @holdsworthst.lat.should_not be nil
+      @holdsworthst.lon.should_not be nil
+      @ryanst.lat.should_not be nil
+      @ryanst.lon.should_not be nil
+    end
+
+    it 'should be !calibrated if lat and/or lon change' do
+      @loc1 = MockLocation.new(lat: @talgard_lat, lon: @talgard_lon)
+      @loc1.lat = @holdsworthst_lat
+      @loc1.calibrated.should be false
+      @loc1.calibrate
+      @loc1.calibrated.should be true
+      @loc1.lon = @holdsworthst_lon
+      @loc1.calibrated.should be false
+      @loc1.calibrate
+      @loc1.calibrated.should be true
+    end
+
+    it 'should be calibrated if lat/lon set via set_and_calibrate' do
+      @loc1 = MockLocation.new(lat: @talgard_lat, lon: @talgard_lon)
+      @loc1.calibrated.should be true
+      @loc1.set_and_calibrate(@holdsworthst_lat, @holdsworthst_lon)
+      @loc1.calibrated.should be true
+    end
+
+    it 'should raise an exception if nearby? used on uncalibrated locations' do
+      @loc1 = MockLocation.new(lat: @talgard_lat, lon: @talgard_lon)
+      @loc1.lat = @holdsworthst_lat
+      @loc1.calibrated.should be false
+      expect { @loc1.nearby?(nil) }.to raise_error(Tillless::Location::LocationCalibrationException)
+      @loc1.calibrate
+      @loc1.lon = @holdsworthst_lon
+      @loc1.calibrated.should be false
+      expect { @loc1.nearby?(nil) }.to raise_error(Tillless::Location::LocationCalibrationException)
+    end
+
+    it 'should raise an exception if great_circle_distance_from_here_to used on uncalibrated locations' do
+      @loc1 = MockLocation.new(lat: @talgard_lat, lon: @talgard_lon)
+      @loc1.lat = @holdsworthst_lat
+      @loc1.calibrated.should be false
+      expect { @loc1.great_circle_distance_from_here_to(nil) }.to raise_error(Tillless::Location::LocationCalibrationException)
+      @loc1.calibrate
+      @loc1.lon = @holdsworthst_lon
+      @loc1.calibrated.should be false
+      expect { @loc1.great_circle_distance_from_here_to(nil) }.to raise_error(Tillless::Location::LocationCalibrationException)
+    end
+
+    it 'should be nearby if lat/lon are identical' do
+      @loc1 = MockLocation.new(lat: @talgard_lat, lon: @talgard_lon)
+      @loc2 = MockLocation.new(lat: @talgard_lat, lon: @talgard_lon)
+      @loc1.lat.should == @loc2.lat
+      @loc2.lat.should == @loc1.lat
+      @loc1.lon.should == @loc2.lon
+      @loc2.lon.should == @loc1.lon
+      @loc1.nearby?(@loc2).should == true
+      @loc2.nearby?(@loc1).should == true
+    end
+
+    it 'should not be nearby if lat/lon are different' do
+      @loc1 = MockLocation.new(lat: @talgard_lat,      lon: @talgard_lon)
+      @loc2 = MockLocation.new(lat: @holdsworthst_lat, lon: @holdsworthst_lon)
+      @loc1.lat.should_not eq(@loc2.lat)
+      @loc2.lat.should_not eq(@loc1.lat)
+      @loc1.lon.should_not eq(@loc2.lon)
+      @loc2.lon.should_not eq(@loc1.lon)
+      @loc1.nearby?(@loc2).should == false
+      @loc2.nearby?(@loc1).should == false
+    end
+
+    it 'should be nearby if loc within min_distance for nearby?' do
+      @loc1 = MockLocation.new(lat: @talgard_lat,      lon: @talgard_lon)
+      @loc2 = MockLocation.new(lat: @holdsworthst_lat, lon: @holdsworthst_lon)
+      distance1 = @loc1.great_circle_distance_from_here_to(@loc2)
+      distance2 = @loc2.great_circle_distance_from_here_to(@loc1)
+      distance1.should == distance2
+      distance2.should == distance1
+      @loc1.nearby?(@loc2, distance1+1).should == true
+      @loc2.nearby?(@loc1, distance1+1).should == true
+    end
+
+    it 'should not be nearby if loc greater than min_distance for nearby?' do
+      @loc1 = MockLocation.new(lat: @talgard_lat,      lon: @talgard_lon)
+      @loc2 = MockLocation.new(lat: @holdsworthst_lat, lon: @holdsworthst_lon)
+      distance1 = @loc1.great_circle_distance_from_here_to(@loc2)
+      distance2 = @loc2.great_circle_distance_from_here_to(@loc1)
+      distance1.should == distance2
+      distance2.should == distance1
+      @loc1.nearby?(@loc2, distance1-1).should == false
+      @loc2.nearby?(@loc1, distance1-1).should == false
+    end
+
+  end
+end

data/tillless-core.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/tillless-core/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Matthew Sinclair", "Jason Elston"]
+  gem.email         = ["info@tillless.com"]
+  gem.description   = %q{Tillless utilities}
+  gem.summary       = %q{Gem for core utilities used across Tillless}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "tillless-core"
+  gem.require_paths = ["lib"]
+  gem.version       = Tillless::VERSION
+
+  gem.add_development_dependency 'rspec', '~> 2'
+  gem.add_development_dependency 'factory_girl', '~> 4.1.0'
+  gem.add_development_dependency 'rb-fsevent', '~> 0.9.1'
+  gem.add_development_dependency 'guard-rspec'
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: tillless-core
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Matthew Sinclair
+- Jason Elston
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+- !ruby/object:Gem::Dependency
+  name: rb-fsevent
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  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'
+description: Tillless utilities
+email:
+- info@tillless.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Guardfile
+- README.md
+- Rakefile
+- lib/tillless-core.rb
+- lib/tillless-core/location.rb
+- lib/tillless-core/version.rb
+- spec/spec_helper.rb
+- spec/tillless-core/location_spec.rb
+- tillless-core.gemspec
+homepage: ''
+licenses: []
+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.23
+signing_key: 
+specification_version: 3
+summary: Gem for core utilities used across Tillless
+test_files:
+- spec/spec_helper.rb
+- spec/tillless-core/location_spec.rb
+has_rdoc: