geo_query 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 067870f16295abd5335d979eaff90afe4fc43193
+  data.tar.gz: f0b5a9c5ae41d5fc49b9cc548968b0356d652257
+SHA512:
+  metadata.gz: 8d0efcf1edb11f5276814a205e8787592bfc04d2ffb5b677c3afbaa53a554ca0a58c6fd69d480580021e1b8de584bfd45f862230bded6bcf9da469135b85a600
+  data.tar.gz: 440a3a9ab8c43cd7ff3270af33f9f7899d9166a173b7ec9bc1bd33600dc2c7bac9e0988a7e3748023dc01479d8db50a5ff618403bada00442d29817627dc0cac

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 William Porter
+
+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/Rakefile

@@ -0,0 +1,13 @@
+require "bundler"
+require 'rake'
+Bundler.setup
+Bundler::GemHelper.install_tasks
+
+def cmd(command)
+  puts command
+  raise unless system command
+end
+
+# Import all our rake tasks
+FileList['tasks/**/*.rake'].each { |task| import task }
+

data/config/routes.rb

@@ -0,0 +1,2 @@
+Rails.application.routes.draw do
+end

data/lib/generators/geo_query/resource/resource_generator.rb

@@ -0,0 +1,34 @@
+require 'rails/generators/active_record'
+
+class GeoQuery::ResourceGenerator < Rails::Generators::NamedBase
+  include Rails::Generators::Migration
+
+  source_root File.expand_path('../templates', __FILE__)
+
+  def copy_migrations
+    copy_migration("add_coordinates_to", name.underscore)
+
+    puts "added coordinates to #{name}"
+    puts "rake db:migrate"
+  end
+
+  def self.next_migration_number(dirname)
+    if ActiveRecord::Base.timestamped_migrations
+      Time.now.utc.strftime("%Y%m%d%H%M%S")
+    else
+      "%.3d" % (current_migration_number(dirname) + 1)
+    end
+  end
+
+  private
+
+  def copy_migration(file, name)
+    filename = "#{file}_#{name}"
+    if self.class.migration_exists?("db/migrate", "#{filename}")
+      say_status("skipped", "Migration #{filename}.rb already exists")
+    else
+      migration_template "#{file}.rb.erb", "db/migrate/#{filename}.rb"
+    end
+  end
+end
+

data/lib/generators/geo_query/resource/templates/add_coordinates_to.rb.erb

@@ -0,0 +1,6 @@
+class AddCoordinatesTo<%= name.camelize %> < ActiveRecord::Migration
+  def change
+    add_column <%= ":#{name.underscore.pluralize.to_sym}" %>, :coordinates, :st_point, geographic: true
+    add_index <%= ":#{name.underscore.pluralize.to_sym}" %>, :coordinates, using: :gist
+  end
+end

data/lib/geo_query/engine.rb

@@ -0,0 +1,14 @@
+require 'activerecord-postgis-adapter'
+
+module GeoQuery
+  class Engine < ::Rails::Engine
+    isolate_namespace GeoQuery
+
+    config.generators do |g|
+      g.test_framework      :rspec,        :fixture => false
+      g.fixture_replacement :factory_girl, :dir => 'spec/factories'
+      g.assets false
+      g.helper false
+    end
+  end
+end

data/lib/geo_query/geo_queryable.rb

@@ -0,0 +1,45 @@
+module GeoQuery
+  module GeoQueryable
+    extend ActiveSupport::Concern
+
+    included do
+      # Class vars
+      mattr_accessor :point_column
+      @@point_column = nil
+
+      # Validations
+      before_validation :save_coordinates
+
+      attr_accessor :lat, :lng
+
+      # Instance Methods
+      def save_coordinates
+        if lat.present? && lng.present?
+          self.coordinates = "POINT(#{lng} #{lat})"
+        end
+      end
+
+      # Class methods
+      ## Returns other objects within the given radius of a point
+      def self.near_lat_lng(lat, lng, radius=500) #radius in metres
+        select("#{self.base_class.table_name}.*, ST_Distance(#{self.base_class.point_column}, ST_GeographyFromText('POINT(#{lng} #{lat})')) AS distance")
+        .where("ST_DWithin(#{self.base_class.point_column} , ST_GeographyFromText('POINT(#{lng} #{lat})'), #{radius})")
+        .order("distance ASC")
+      end
+
+      ## Returns all objects within a bounding box
+      def self.within_bounding_box(min_lat, min_lng, max_lat, max_lng)
+        select("#{self.base_class.table_name}.*").
+        where("#{self.base_class.point_column} && ST_MakeEnvelope(?, ?, ?, ?, 4326)",
+          min_lng, min_lat, max_lng, max_lat)
+      end
+    end
+
+    module ClassMethods
+      # Init method
+      def geo_queryable(options = {})
+        self.base_class.point_column = options[:coordinates] || :coordinates
+      end
+    end
+  end
+end

data/lib/geo_query/version.rb

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

data/lib/geo_query.rb

@@ -0,0 +1,14 @@
+require "geo_query/engine"
+
+module GeoQuery
+  extend ActiveSupport::Autoload
+  autoload :GeoQueryable, 'geo_query/geo_queryable'
+
+
+end
+
+module ActiveRecord
+  class Base
+    include GeoQuery::GeoQueryable
+  end
+end

data/lib/tasks/geo_query_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :geo_query do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: geo_query
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- William Porter
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: activerecord-postgis-adapter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.0.beta5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.0.beta5
+- !ruby/object:Gem::Dependency
+  name: pg
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  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'
+- !ruby/object:Gem::Dependency
+  name: factory_girl_rails
+  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'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  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: Saves you the hassle of writing your own location queries and uses pre-built
+  and reusable methods.
+email:
+- wp@papercloud.com.au
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- Rakefile
+- config/routes.rb
+- lib/generators/geo_query/resource/resource_generator.rb
+- lib/generators/geo_query/resource/templates/add_coordinates_to.rb.erb
+- lib/geo_query.rb
+- lib/geo_query/engine.rb
+- lib/geo_query/geo_queryable.rb
+- lib/geo_query/version.rb
+- lib/tasks/geo_query_tasks.rake
+homepage: http://papercloud.com.au
+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: Query PostGIS coordinate objects on any model
+test_files: []