geopoint_factory 1.0.0

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Josh Avant
+
+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.
+
+If we meet some day, and you think this stuff is worth it, you can buy me a
+beer in return.

data/README.md

@@ -0,0 +1,62 @@
+# GeoPoint Factory
+**Generate useful, RGeo-compatible geographic points located within a supplied shapefile.**
+
+## Quick Start
+* Follow the [RGeo installation instructions](https://github.com/dazuma/rgeo) and install RGeo.
+
+* `gem install geopoint_factory`
+
+* Download an ESRI-compatible shapefile. ([Cartographic boundary files from the US Census](http://www.census.gov/geo/www/cob/bdy_files.html) are a convenient source for these.)
+
+* Initialize an instance of GeoPointFactory::Generator with a shapefile and generate points:
+
+```ruby
+require 'geopoint_factory'
+
+generator = GeoPointFactory::Generator.new("path/to/shapefile")
+point_inside = generator.generate
+different_point_inside = generator.generate
+yet_another_point_inside = generator.generate
+generator.finalize
+```
+
+## Discussion
+GeoPoint Factory was developed as a way to easily generate geographic coordinate data within a specific geographic area, while avoiding areas that may not be useful, such as in the ocean.
+
+For example, using the US Census-supplied shapefile of San Francisco's boundaries, GeoPoint Factory can generate random points specifically within San Francisco's borders and avoid generating points within the Pacific Ocean or San Francisco Bay.
+
+GeoPoint Factory was developed for use with the [RGeo](https://github.com/dazuma/rgeo) library.
+
+## Compatibility
+* Ruby 1.9.2+
+
+**Contributions, corrections, and improvements are always appreciated!**
+
+## Created By
+Josh Avant
+
+## License
+This is licensed under a MIT/Beerware License:
+
+    Copyright (c) 2012 Josh Avant
+
+    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.
+
+    If we meet some day, and you think this stuff is worth it, you can buy me a
+    beer in return.

data/Rakefile

@@ -0,0 +1,8 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec

data/geopoint_factory.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/geopoint_factory/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Josh Avant"]
+  gem.email         = ["joshavant@gmail.com"]
+  gem.description   = %q{Generate geographic points from a shapefile.}
+  gem.summary       = %q{Generate useful, RGeo-compatible geographic points located within a supplied shapefile.}
+  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          = "geopoint_factory"
+  gem.require_paths = ["lib"]
+  gem.version       = GeoPointFactory::VERSION
+  
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+  
+  gem.add_runtime_dependency     'rgeo'
+  gem.add_runtime_dependency     'rgeo-shapefile'
+end

data/lib/geopoint_factory.rb

@@ -0,0 +1,67 @@
+require "geopoint_factory/version"
+require "rgeo/shapefile"
+
+# USAGE NOTE:
+# '#finalize' should be called, whenever you're done with an instance
+# of GeoPointFactory::Generator
+
+module GeoPointFactory
+  class Generator
+    # omit file extensions for `path_to_shapefile`
+    def initialize(path_to_shapefile)
+      @factory = RGeo::Geographic.simple_mercator_factory
+      @shapefile = RGeo::Shapefile::Reader.open(path_to_shapefile, :factory => @factory)
+    end
+    
+    def generate
+      begin
+        generated_point = random_point_in_bounding_box
+      end while !@shapefile.get(0).geometry.contains?(generated_point)
+      generated_point
+    end
+    
+    def finalize
+      @shapefile.close
+    end
+    
+    private
+    def convert_to_rad(deg)
+      (deg / 360) * (2 * Math::PI)
+    end
+    
+    def convert_to_deg(rad)
+      (rad * 360) / (2 * Math::PI)
+    end
+    
+    def random_point_in_bounding_box
+      northlimit = convert_to_rad(@shapefile.ymax)
+      southlimit = convert_to_rad(@shapefile.ymin)
+      westlimit = convert_to_rad(@shapefile.xmin)
+      eastlimit = convert_to_rad(@shapefile.xmax)
+
+      # source:   http://www.geomidpoint.com/random/calculation.html
+      # section: 'Rectangular region calculation detail'
+      rand_lat = Math.asin(rand * (Math.sin(northlimit) - Math.sin(southlimit)) + Math.sin(southlimit))
+
+      width = eastlimit - westlimit
+      
+      if width < 0
+        width = width + (2 * Math::PI)
+      end
+      
+      rand_lon = westlimit + width * rand
+      
+      if rand_lon < -Math::PI
+        rand_lon = rand_lon + 2 * Math::PI
+      elsif rand_lon > Math::PI
+        rand_lon = rand_lon - 2 * Math::PI
+      end
+      
+      rand_lat = convert_to_deg(rand_lat)
+      rand_lon = convert_to_deg(rand_lon)
+            
+      @factory.point(rand_lon, rand_lat)
+    end
+    
+  end
+end

data/lib/geopoint_factory/version.rb

@@ -0,0 +1,3 @@
+module GeoPointFactory
+  VERSION = "1.0.0"
+end

data/spec/lib/geopoint_factory_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+PATH_TO_TEST_SHAPEFILE = "spec/support/sf_shapefile"
+
+describe GeoPointFactory::Generator do
+  before(:all) do
+    @point_generator = GeoPointFactory::Generator.new(PATH_TO_TEST_SHAPEFILE)
+    @point = @point_generator.generate
+  end
+
+  it "should generate a RGeo::Feature::Point module" do
+    RGeo::Feature::Point.check_type(@point).should be_true
+  end
+  
+  it "should generate random points with different locations" do
+    second_point = @point_generator.generate
+    @point.eql?(second_point).should be_false
+  end
+
+  it "should generate a point within the bounds of the supplied shapefile" do
+    factory = RGeo::Geographic.simple_mercator_factory
+    shapefile = RGeo::Shapefile::Reader.open(PATH_TO_TEST_SHAPEFILE, :factory => factory)
+    shapefile.get(0).geometry.contains?(@point).should be_true
+  end
+  
+  after(:all) do
+    @point_generator.finalize
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'geopoint_factory'

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: geopoint_factory
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Josh Avant
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: 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'
+- !ruby/object:Gem::Dependency
+  name: rgeo
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rgeo-shapefile
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Generate geographic points from a shapefile.
+email:
+- joshavant@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- geopoint_factory.gemspec
+- lib/geopoint_factory.rb
+- lib/geopoint_factory/version.rb
+- spec/lib/geopoint_factory_spec.rb
+- spec/spec_helper.rb
+- spec/support/sf_shapefile.dbf
+- spec/support/sf_shapefile.shp
+- spec/support/sf_shapefile.shx
+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.21
+signing_key: 
+specification_version: 3
+summary: Generate useful, RGeo-compatible geographic points located within a supplied
+  shapefile.
+test_files:
+- spec/lib/geopoint_factory_spec.rb
+- spec/spec_helper.rb
+- spec/support/sf_shapefile.dbf
+- spec/support/sf_shapefile.shp
+- spec/support/sf_shapefile.shx