easy_postgis 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b65ba19ced7e796800213e32ddb5f02efb3fdfbc
+  data.tar.gz: 4d95e9569baa4700a1d27dcc31a82e5024397341
+SHA512:
+  metadata.gz: b898a4b807458e2caa02e3b3da3584820e0ee9961401b35284e7f382a6b01c2df5aa68866ebb90760b48c8caf853e21ebd7b0666785f7ca0fe62244a2ccb99b6
+  data.tar.gz: 20c22c099fcdc1a2453eea974db9663be24818a91a35aa767e667f99a0d81926a588c94e3f41bb9370ab3d1facfb90fdfa43453ce06c3a2308a5ce7edbad242b

data/.gitignore

@@ -0,0 +1,13 @@
+/.idea/
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.ruby-version
+/.ruby-gemset
+scratch.*

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.12.5

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Kelly Felkins
+
+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 @@
+# EasyPostgis
+
+EasyPostgis is a gemification of the code described in Nick Gauthier's 2013 blog post 
+['PostGIS and Rails: A Simple Approach'][1]. 
+
+[1]: http://ngauthier.com/2013/08/postgis-and-rails-a-simple-approach.html
+
+It adds 2 scopes to your model: 
+
+* near(point, distance_in_meters)
+* with_distance(point)
+
+*near* filters the rows based on distance from the point.
+*with_distance* adds a distance column to the result.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'easy_postgis'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install easy_postgis
+
+## Usage
+
+```ruby
+  class Address
+    # has lat and lng attributes 
+    include EasyPostgis
+  end
+  
+  some_address = Address.first
+  near_by_addresses = Address.near(some_address, 500) # Addresses within 500 meters
+```
+
+## Development
+
+TODO:
+  
+  * you must create the test database: psql> create database easy_postgis_test;
+  * you must add gis: psql> create extension postgis;
+  
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/easy_postgis. 
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "easy_postgis"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/easy_postgis.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'easy_postgis/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "easy_postgis"
+  spec.version       = EasyPostgis::VERSION
+  spec.authors       = ["Kelly Felkins"]
+  spec.email         = ["kelly@restlater.com"]
+
+  spec.summary       = %q{Adds simple distance scopes that utilize PostGIS indexes to your Rails models.}
+  spec.homepage      = "https://github.com/kellyfelkins/easy_postgis"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "pg"
+  spec.add_dependency "activerecord"
+  spec.add_dependency "activesupport"
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "atv"
+end

data/lib/easy_postgis/version.rb

@@ -0,0 +1,3 @@
+module EasyPostgis
+  VERSION = "0.1.0"
+end

data/lib/easy_postgis.rb

@@ -0,0 +1,28 @@
+require "easy_postgis/version"
+
+module EasyPostgis
+  extend ActiveSupport::Concern
+
+  included do
+    scope :near, -> (other, distance_in_meters) { where(near_sql(other, distance_in_meters)) }
+    scope :with_distance, ->(point) { select("#{table_name}.*, #{distance_select_sql(point)}") }
+  end
+
+  class_methods do
+    def near_sql(other, distance_in_meters)
+      "ST_DWithin(#{geography_from_table}, #{geography_from_point(other.lng, other.lat)}, %d )" % [distance_in_meters]
+    end
+
+    def distance_select_sql(other)
+      "ST_Distance(#{geography_from_table}, #{geography_from_point(other.lng, other.lat)}) as distance"
+    end
+
+    def geography_from_table
+      "ST_GeographyFromText(' SRID=4326; POINT(' || #{table_name}.lng || ' ' || #{table_name}.lat || ') ')"
+    end
+
+    def geography_from_point(lon, lat)
+      "ST_GeographyFromText( 'SRID=4326; POINT(%f %f)' )" % [lon, lat]
+    end
+  end
+end

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: easy_postgis
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kelly Felkins
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: atv
+  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:
+- kelly@restlater.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- easy_postgis.gemspec
+- lib/easy_postgis.rb
+- lib/easy_postgis/version.rb
+homepage: https://github.com/kellyfelkins/easy_postgis
+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.8
+signing_key: 
+specification_version: 4
+summary: Adds simple distance scopes that utilize PostGIS indexes to your Rails models.
+test_files: []