geo_foo 0.0.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,13 @@
+THE BEER-WARE LICENSE Copyright (c) 2010 hukl, agnat
+
+As long as you retain this notice you can do whatever you want with this stuff. 
+If we meet some day, and you think this stuff is worth it, you can buy us a beer
+in return.
+
+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.rdoc

@@ -0,0 +1,29 @@
+= geo_foo
+
+Run
+
+  rake build
+  rake install
+
+= Running the tests
+To run the tests you need a postgresql server with postgis extensions installed.
+
+* create an empty database +geo_foo_test+ from your postgis template 
+* set your settings in <tt>test_database.yml</tt>.
+
+Now run:
+  rake [test]
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 hukl, agnat. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "geo_foo"
+    gem.summary = %Q{An experimental and extensible Rails/Postgis library}
+    gem.description = %Q{Geo makes it easy to interact with Postgis without hacking too deep into AR. It is in a very early stage and should be considered experimental at most}
+    gem.email = "contact@smyck.org"
+    gem.homepage = "http://github.com/hukl/geo_foo"
+    gem.authors = ["agnat", "hukl"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "geo_foo #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/geo_foo.gemspec

@@ -0,0 +1,56 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{geo_foo}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["agnat", "hukl"]
+  s.date = %q{2010-03-12}
+  s.description = %q{Geo makes it easy to interact with Postgis without hacking too deep into AR. It is in a very early stage and should be considered experimental at most}
+  s.email = %q{contact@smyck.org}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "geo_foo.gemspec",
+     "lib/geo_foo.rb",
+     "lib/geo_foo/active_record.rb",
+     "lib/geo_foo/core.rb",
+     "lib/geo_foo/numeric.rb",
+     "lib/geo_foo/scope.rb",
+     "test/helper.rb",
+     "test/test_geo_foo.rb",
+     "test_database.yml"
+  ]
+  s.homepage = %q{http://github.com/hukl/geo_foo}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{An experimental and extensible Rails/Postgis library}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_geo_foo.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/lib/geo_foo/active_record.rb

@@ -0,0 +1,29 @@
+module GeoFoo
+  module ActiveRecord
+    def self.included(base)
+      base.extend ClassMethods
+    end
+  end
+  
+  module ClassMethods
+    def add_geo_foo
+      self.class_eval do
+        def self.within_radius lat, lon, radius
+          scoped(
+            :conditions => [
+              "ST_DWithin(#{GeoFoo::Core.as_point(lat,lon)}, "\
+              "point, #{bbox_size(lat, radius)}) AND ST_Distance_Sphere(" \
+              "point, #{GeoFoo::Core.as_point(lat,lon)}) < #{radius}"
+            ]
+          )
+        end
+      end
+    end
+    
+    # XXX handle case where lat is (close to) +-90deg (poles)
+    def bbox_size latitude, radius
+      (radius.to_f / (GeoFoo::Core::EarthRadius * Math.cos(latitude.to_rad))).to_deg
+    end
+  end
+end
+

data/lib/geo_foo/core.rb

@@ -0,0 +1,70 @@
+module GeoFoo
+  
+  module Core
+    SRID = 4326 # WGS-84
+    EarthRadius = 6370986.0 # meters (as used by postgis' ST_Distance_Sphere())
+    TableName = "locations"
+  
+    # execute an SQL query on the database 
+    def self.execute query
+      ActiveRecord::Base.connection.execute( query ).to_a
+    end
+  
+    # return a postgis string representation of the given coordinates
+    def self.as_point lat, lon
+      # Intentionally use (lat,lon) and not (lon,lat), because latitude is the
+      # 'horizontal' coordinate.
+      # See: http://archives.postgresql.org/pgsql-general/2008-02/msg01393.php
+      "ST_GeomFromText('POINT(#{lon} #{lat})', #{SRID})"
+    end
+  
+    # find all locations within a radius for a given location
+    def self.find_neighbours_by_coords lat, lon, radius=100.0
+      # compute an appropriate bounding box size for this latitude
+      # XXX handle case where lat is (close to) +-90deg (poles)
+      bbox_size= (radius.to_f / (EarthRadius * Math.cos(lat.to_rad))).to_deg
+      distance = "ST_Distance_Sphere(point, #{as_point(lat,lon)})"
+      (execute "SELECT (id) FROM #{TableName} "\
+               "WHERE ST_DWithin(#{as_point(lat,lon)}, point, #{bbox_size}) "\
+               "AND #{distance} < #{radius} "\
+               "ORDER BY #{distance}").map { |row| row["id"].to_i }
+    end
+  
+    # return latitude, longitude for a given id
+    def self.find_coords_by_id id
+      r = (execute "SELECT ST_Y(point), ST_X(point) FROM #{TableName} "\
+                   "WHERE id = #{id}")[0]
+      # Intentionally return (y,x) which corresponds to (lat,lon). See as_point().
+      [r["st_y"].to_f, r["st_x"].to_f]
+    end
+  
+    # store a point in the location table. returns the points id.
+    def self.store_location lat, lon
+      (execute "INSERT INTO #{TableName} (point) VALUES (#{as_point(lat,lon)})"\
+               "RETURNING id").first["id"].to_i
+    end
+  
+    # delete a location from the database
+    def self.delete_location id
+      execute "DELETE FROM #{TableName} WHERE id = #{id}"
+    end
+  
+    # returns the number of locations currently in the database
+    def self.location_count
+      (execute "SELECT count(*) FROM #{TableName}").first["count"].to_i
+    end
+  
+    # migration helper: create the database table
+    def self.create_table
+      execute "CREATE TABLE #{TableName} (id serial PRIMARY KEY)"
+      execute "SELECT AddGeometryColumn('#{TableName}', 'point', #{SRID}, 'POINT', 2)"
+      execute "CREATE INDEX #{TableName}_point_index ON #{TableName} USING GIST (point)"
+    end
+  
+    # migration helper: drop the database table
+    def self.drop_table
+      execute "DROP TABLE #{TableName}"
+    end
+  end
+  
+end

data/lib/geo_foo/numeric.rb

@@ -0,0 +1,8 @@
+class Numeric
+  def to_rad
+    self * (Math::PI / 180)
+  end
+  def to_deg
+    self * (180 / Math::PI)
+  end
+end

data/lib/geo_foo/scope.rb

@@ -0,0 +1,9 @@
+module GeoFoo
+  module Scope
+    
+    def self.hello
+      puts "hello"
+    end
+    
+  end
+end

data/lib/geo_foo.rb

@@ -0,0 +1,15 @@
+require 'geo_foo/scope'
+require 'geo_foo/active_record'
+require 'geo_foo/numeric'
+
+module GeoFoo
+
+end
+
+begin
+  ActiveRecord::Base.class_eval do
+    include GeoFoo::ActiveRecord
+  end
+rescue
+  true
+end

data/test/helper.rb

@@ -0,0 +1,31 @@
+require 'rubygems'
+require 'test/unit'
+require 'active_record'
+require 'active_support'
+require 'active_support/test_case'
+
+config_file = File.join(File.dirname(__FILE__), '..', 'test_database.yml')
+database_config = YAML.load_file config_file
+database_config[:adapter] = 'postgresql'
+ActiveRecord::Base.establish_connection database_config
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'geo_foo'
+
+class ActiveSupport::TestCase
+  
+  def execute sql
+    ActiveRecord::Base.connection.execute sql
+  end
+
+  def query sql
+    ActiveRecord::Base.connection.query sql
+  end
+
+  def query_scalar sql
+    query(sql).first.first
+  end
+  
+  
+end

data/test/test_geo_foo.rb

@@ -0,0 +1,25 @@
+require 'geo_foo/core'
+require 'helper'
+
+class TestGeoFoo < ActiveSupport::TestCase
+
+  test "database connection" do
+    # perform a query first to 'wake-up' the connection
+    assert_equal(query_scalar("SELECT 5").to_i, 5)
+    assert ActiveRecord::Base.connected?, "database connection esteblished"
+  end
+
+  test "postgis database is present" do
+    assert(query('SELECT count(*) FROM geometry_columns'))
+  end
+
+  test "as_point" do
+    latitude = 5
+    longitude = 42
+    point = GeoFoo::Core.as_point latitude, longitude
+    assert(query("SELECT #{point}"))
+    assert_equal(query_scalar("SELECT ST_X(#{point})").to_i, 42)
+    assert_equal(query_scalar("SELECT ST_Y(#{point})").to_i, 5)
+  end
+  
+end

data/test_database.yml

@@ -0,0 +1,3 @@
+# always use adapter: postgresql
+username: postgres
+database: geo_foo_test

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification 
+name: geo_foo
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- agnat
+- hukl
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-12 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: Geo makes it easy to interact with Postgis without hacking too deep into AR. It is in a very early stage and should be considered experimental at most
+email: contact@smyck.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- geo_foo.gemspec
+- lib/geo_foo.rb
+- lib/geo_foo/active_record.rb
+- lib/geo_foo/core.rb
+- lib/geo_foo/numeric.rb
+- lib/geo_foo/scope.rb
+- test/helper.rb
+- test/test_geo_foo.rb
+- test_database.yml
+has_rdoc: true
+homepage: http://github.com/hukl/geo_foo
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: An experimental and extensible Rails/Postgis library
+test_files: 
+- test/helper.rb
+- test/test_geo_foo.rb