nobrainer_geospatial 1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a41dfb97afec3cc5eb575023b632cae745ac8617
+  data.tar.gz: 3ee068c97f4b579dc25a5f0630e68c1cdf90c33e
+SHA512:
+  metadata.gz: 9ec644dccb5c2d641cfc4dba206e30a8e77351d1dd15a0bbddf1d24ff39e2d6427e2057aab91bcfa57955b89fcf63a5020eea3bfcd59a69441a72eb621c5c05a
+  data.tar.gz: 1968ad7d0b8db40c4199c339bb84857d7ece50ea97bbab574b7e83d31b8d4d773a125dd44f8bac2e94e49b078cff7d229d70bf4ade1c85305b2829ebb13b3965

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Joshua Harding
+
+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,29 @@
+# NobrainerGeospatial
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'nobrainer_geospatial'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install nobrainer_geospatial
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/nobrainer_geospatial/fork )
+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 a new Pull Request

data/lib/nobrainer_geospatial.rb

@@ -0,0 +1,124 @@
+require 'nobrainer_geospatial/version'
+require 'nobrainer_geospatial/types/geo_point'
+require 'nobrainer_geospatial/types/geo_polygon'
+
+module NoBrainer
+  class GeoResultSet
+    attr_accessor :rql, :klass
+
+    def initialize(klass, rql)
+      self.rql = rql
+      self.klass = klass
+    end
+
+    def to_a
+      NoBrainer.run { self.rql }.to_a.map {|r| new_from_db(r) }
+    end
+
+    def all
+      to_a
+    end
+
+    def first
+      new_from_db NoBrainer.run { self.rql }.first
+    end
+
+    def each(&block)
+      NoBrainer.run { self.rql }.each do |result|
+        block.call(new_from_db result)
+      end
+    end
+
+    def count
+      NoBrainer.run { self.rql.count }
+    end
+
+    def where(args = nil, &block)
+      if block_given?
+        GeoResultSet.new(self.klass, self.rql.filter(block))
+      else
+        GeoResultSet.new(self.klass, self.rql.filter(args))
+      end
+    end
+
+    def limit(n)
+      GeoResultSet.new(self.klass, self.rql.limit(n))
+    end
+
+    def skip(n)
+      GeoResultSet.new(self.klass, self.rql.skip(n))
+    end
+
+    def order_by(args, order = :asc)
+
+      conditions = []
+
+      raise "Invalid sort order: #{order}" unless order == :asc || order == :desc
+
+      if args.class == Array
+        conditions = args.map do |arg|
+          if order == :asc
+            RethinkDB::RQL.new.asc(arg)
+          else
+            RethinkDB::RQL.new.desc(arg)
+          end
+        end
+      else
+        if order == :asc
+          conditions = RethinkDB::RQL.new.asc(args)
+        else
+          conditions = RethinkDB::RQL.new.desc(args)
+        end
+      end
+
+      GeoResultSet.new(self.klass, self.rql.order_by(*conditions))
+    end
+
+    def [](index)
+      to_a()[index]
+    end
+
+    def to_rql
+      self.rql
+    end
+
+    private
+    def new_from_db(result)
+      obj = klass.new_from_db(result)
+      if result['_distance']
+        obj.singleton_class.class_eval do
+          attr_accessor :distance
+        end
+        obj.distance = result['_distance']
+      end
+      return obj
+    end
+  end
+end
+
+module NoBrainer
+  module GeoQueries
+
+    def self.included base
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def nearest(point, options)
+        # if we get an array convert to RQL
+        if point.class == Array
+          point = RethinkDB::RQL.new.point(*point)
+        end
+        NoBrainer::GeoResultSet.new(self, self.rql_table.get_nearest(point, options).map {|result| result['doc'].merge({'_distance' => result['dist']})})
+      end
+
+      def intersecting(polygon, options)
+        if polygon.class == Array
+          polygon = RethinkDB::RQL.new.polygon(*polygon)
+        end
+        NoBrainer::GeoResultSet.new(self, self.rql_table.get_intersecting(polygon, options))
+      end
+    end
+
+  end
+end

data/lib/nobrainer_geospatial/types/geo_point.rb

@@ -0,0 +1,36 @@
+module NoBrainer::GeoSpatial
+  class Point < Struct.new(:longitude, :latitude)
+
+    def to_rql
+      RethinkDB::RQL.new.point(self.longitude, self.latitude)
+    end
+
+    class << self
+      def nobrainer_cast_user_to_model(value)
+        case value
+        when NoBrainer::GeoSpatial::Point then value
+        when Array then
+             new(value[0], value[1])
+        when Hash then
+            longitude = value[:longitude] ||= value[:long] ||= value['longitude'] ||= value['long']
+            latitude = value[:latitude] ||= value[:lat] ||= value['latitude'] ||= value['latitude']
+            raise NoBrainer::Error::InvalidType.new('longitude out of range') if longitude < -180 || longitude > 180
+            raise NoBrainer::Error::InvalidType.new('latitude out of range') if latitude < -90 || latitude > 90
+            raise 'You must supply :longitude and :latitude!' unless latitude && longitude
+            new(longitude, latitude)
+        else raise NoBrainer::Error::InvalidType
+        end
+      end
+
+      def nobrainer_cast_model_to_db(value)
+        RethinkDB::RQL.new.point(value.longitude, value.latitude)
+      end
+
+      # This class method translates a value from the database to the proper type.
+      # It is used when reading from the database.
+      def nobrainer_cast_db_to_model(value)
+        NoBrainer::GeoSpatial::Point.new(value['coordinates'][0], value['coordinates'][1])
+      end
+    end
+  end
+end

data/lib/nobrainer_geospatial/types/geo_polygon.rb

@@ -0,0 +1,71 @@
+module NoBrainer::GeoSpatial
+  class Polygon
+
+    attr_accessor :coordinates
+
+    def initialize(values)
+      # OK, values is either going to be a pair of coords like:
+      #    [ [lon1, lat1], [lon2, lat2] ], ...
+      #              OR
+      #    [point1, point2], ...
+      # so we should have either all numeric or an array of arrays...
+      raise NoBrainer::Error::InvalidType.new('You must supply at least 4 coordinates') if values.length < 4
+
+      # check to make sure we're not getting invalid parameters or mixed parameters...
+      unless values.all? {|c| c.is_a? Numeric} || values.all? {|c| c.is_a? Array}
+        raise NoBrainer::Error::InvalidType.new('Points must be an Array or list of numeric')
+      end
+
+      self.coordinates = []
+
+      # convert from list of coords to a paired list...
+      if values.all? {|c| c.is_a? Numeric}
+        raise NoBrainer::Error::InvalidType.new('Must have even number of coordinates!') if values.length.odd?
+        values.each_slice(2) do |coords|
+          self.coordinates << [coords[0], coords[1]]
+        end
+      else
+        # we already had a paired list... just assign it straight across...
+        self.coordinates = values
+      end
+
+      check_coordinates(self.coordinates)
+
+    end
+
+    private
+    def check_coordinates(points)
+      points.each do |point|
+        longitude = point[0]
+        latitude = point[1]
+        if longitude < -180 || longitude > 180
+          raise NoBrainer::Error::InvalidType.new('Longitude is out of bounds')
+        end
+        if latitude < -90 || latitude > 90
+          raise NoBrainer::Error::InvalidType.new('Latitude is out of bounds')
+        end
+      end
+    end
+
+    class << self
+      def nobrainer_cast_user_to_model(value)
+        case value
+          when NoBrainer::GeoSpatial::Polygon then value
+          when Array then
+            new(value)
+          else raise NoBrainer::Error::InvalidType
+        end
+      end
+
+      def nobrainer_cast_model_to_db(value)
+        RethinkDB::RQL.new.polygon(*value.coordinates)
+      end
+
+      # This class method translates a value from the database to the proper type.
+      # It is used when reading from the database.
+      def nobrainer_cast_db_to_model(value)
+        NoBrainer::GeoSpatial::Polygon.new(*value['coordinates'])
+      end
+    end
+  end
+end

data/lib/nobrainer_geospatial/version.rb

@@ -0,0 +1,5 @@
+module NoBrainer
+  module Geospatial
+    VERSION = '1.1'
+  end
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: nobrainer_geospatial
+version: !ruby/object:Gem::Version
+  version: '1.1'
+platform: ruby
+authors:
+- Joshua Harding
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2014-12-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: rake
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: nobrainer
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: pry
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: rspec
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :development
+description: Geospatial support for NoBrainer
+email:
+- josh@statewidesoftware.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/nobrainer_geospatial.rb
+- lib/nobrainer_geospatial/version.rb
+- lib/nobrainer_geospatial/types/geo_polygon.rb
+- lib/nobrainer_geospatial/types/geo_point.rb
+- LICENSE.txt
+- README.md
+homepage: ''
+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.1.9
+signing_key:
+specification_version: 4
+summary: Geospatial support for NoBrainer.
+test_files: []