region_extractor 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,20 @@
+Copyright (c) 2009 Andrew Carpenter
+
+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.rdoc

@@ -0,0 +1,17 @@
+= region_extractor
+
+Description goes here.
+
+== 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 Andrew Carpenter. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,46 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "region_extractor"
+    gem.summary = %Q{Extract geographic regions from plain text}
+    gem.description = %Q{Attempts to extract geographic regions mentioned in txt/html documents.}
+    gem.email = "andrew.main@gmail.com"
+    gem.homepage = "http://github.com/andrewcarpenter/region_extractor"
+    gem.authors = ["Andrew Carpenter"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+    gem.add_dependency('proj4rb', '>= 0.3.1')
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "region_extractor #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

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

data/lib/region_extractor.rb

@@ -0,0 +1,55 @@
+require 'rubygems'
+require 'proj4'
+
+require "region_extractor/region"
+require "region_extractor/point"
+
+class RegionExtractor
+  attr_accessor :regions, :resulting_text
+  
+  def initialize(text, &region_transformer)
+    @text = text || ''
+    @regions = []
+    @resulting_text = text
+    @region_transformer = region_transformer
+    extract!
+  end
+  
+  private
+  
+  def extract!
+    @resulting_text = @text.gsub(/(?:excluding land bound by )?(?:\d{6,7}\s*,\s*\d{6,7};\s*){2,}\d{6,7}\s*,\s*\d{6,7}/) do |region_string|
+      match = @text.match(/UTM [z|Z]one (\d+)/)
+      zone = match ? match[1] : ''
+      
+      points = region_string.sub(/^excluding land bound by /,'').split(/\s*;\s*/).map do |c|
+        x , y = c.split(/\s*,\s*/)
+        Point.new(x.to_i,y.to_i)
+      end
+      
+      region = Region.new(:points => points, :zone => zone)
+      if region_string =~ /^excluding/
+        prior_region = @regions.last
+        prior_region.add_hole(region)
+        
+        region_string # don't modify the document
+      else
+        @regions << region
+
+        if @region_transformer
+          @region_transformer.call(region_string, region, @regions.size-1)
+        else
+          nil
+        end
+      end
+    end
+  end
+end
+
+# extractor = RegionExtractor.new("507093, 4879404; 507095, 4879401") do |region, i|
+#   "<div id=\"map_#{i}\"></div>"
+# 
+# end
+# 
+# extractor.regions
+# extractor.resulting_text

data/lib/region_extractor/point.rb

@@ -0,0 +1,16 @@
+class RegionExtractor
+  include Proj4
+  class Point
+    attr_accessor :x, :y
+    
+    def initialize(x,y)
+      @x = x
+      @y = y
+    end
+    
+    def self.tranform_point(point, origin_projection, destination_projection)
+      output = origin_projection.transform(destination_projection, point)
+      Point.new(output.x * Proj4::RAD_TO_DEG, output.y * Proj4::RAD_TO_DEG)
+    end
+  end
+end

data/lib/region_extractor/region.rb

@@ -0,0 +1,23 @@
+class RegionExtractor
+  class Region
+    attr_accessor :points, :zone, :holes
+    def initialize(options = {})
+      @points = options[:points]
+      @zone   = options[:zone]
+      @projection = Proj4::Projection.new( :proj => 'utm', :datum => "NAD83", :zone => @zone)
+      @holes = []
+    end
+    
+    def transformed_points(output_projection = Proj4::Projection.new( :proj => 'latlong', :datum => 'WGS84' ))
+      @points.map{|p| Point.tranform_point(p, @projection, output_projection) }
+    end
+    
+    def coordinates(output_projection = Proj4::Projection.new( :proj => 'latlong', :datum => 'WGS84' ))
+      transformed_points(output_projection).map{|p|"#{p.x},#{p.y},0.000000"}.join("\n")
+    end
+    
+    def add_hole(region)
+      @holes << region
+    end
+  end
+end

data/region_extractor.gemspec

@@ -0,0 +1,60 @@
+# 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{region_extractor}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Andrew Carpenter"]
+  s.date = %q{2010-06-12}
+  s.description = %q{Attempts to extract geographic regions mentioned in txt/html documents.}
+  s.email = %q{andrew.main@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/region_extractor.rb",
+     "lib/region_extractor/point.rb",
+     "lib/region_extractor/region.rb",
+     "region_extractor.gemspec",
+     "spec/region_extractor_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/andrewcarpenter/region_extractor}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Extract geographic regions from plain text}
+  s.test_files = [
+    "spec/region_extractor_spec.rb",
+     "spec/spec_helper.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
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_runtime_dependency(%q<proj4rb>, [">= 0.3.1"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_dependency(%q<proj4rb>, [">= 0.3.1"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    s.add_dependency(%q<proj4rb>, [">= 0.3.1"])
+  end
+end
+

data/spec/region_extractor_spec.rb

@@ -0,0 +1,94 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+describe "RegionExtractor" do
+  context "parsing text" do
+    context "with no regions present" do
+      before(:each) do
+        @texts = [
+          "",
+          "The brown cow.",
+          "10/15/1982",
+          "Portland, OR 97266; telephone 503-231-6179; facsimile 503-231-6195",
+          "<p>Optimal Oregon chub habitat provides 1 square meter (11 square feet) of aquatic surface area per adult, at depths between 0.5 m (1.6 ft) to 2 m (6.6 ft) (Scheerer 2008b).</p>"
+        ]
+      end
+      
+      it "returns no regions" do
+        @texts.each do |text|
+          RegionExtractor.new(text).regions.should == []
+        end
+      end
+      
+      it "does not modify the text" do
+        @texts.each do |text|
+          RegionExtractor.new(text).resulting_text.should == text
+        end
+      end
+    end
+    
+    context "with one simple region" do
+      before(:each) do
+        @extractor = RegionExtractor.new("Land bounded by the following UTM Zone 10, NAD83 coordinates (E,N): 557923, 4838857; 557919, 4838854; 557919, 4838854;")
+      end
+      
+      it "finds the correct number of regions" do
+        @extractor.regions.size.should == 1
+      end
+      
+      it "the region has the correct number of points" do
+        @extractor.regions.first.points.size.should == 3
+      end
+      
+      it "should determine the correct zone" do
+        @extractor.regions.first.zone.should == "10"
+      end
+      
+    end
+    
+    context "with more complex regions" do
+      before(:each) do
+        @extractor = RegionExtractor.new("<p>Unit 1A consists of boundary points with the following coordinates in UTM Zone 4, with the units in meters, using North American Datum of 1983 (Nad83):</p>
+      <p>(A) 451377, 2420941; 451318, 2421296; 451365, 2421383; 451432, 2421109; 451596, 2421040; 451959, 2421072.</p><p>(ii) Follow the approximate coordinates: 457583, 2422071; 457631, 2422040; 457702, 2421952; 457543, 2421778; 457490, 2421812; 457400, 2421778; 457352, 2421693; 457380, 2421601.</p>")
+      end
+      
+      it "finds the correct number of regions" do
+        @extractor.regions.size.should == 2
+      end
+      
+      it "the regions have the correct number of points" do
+        @extractor.regions[0].points.size.should == 6
+        @extractor.regions[1].points.size.should == 8
+      end
+      
+      it "should determine the correct zone" do
+        @extractor.regions[0].zone.should == "4"
+      end
+    end
+    
+    context "with regions to exclude" do
+      before(:each) do
+        @extractor = RegionExtractor.new("<p>UTM zone 4 451377, 2420941; 451318, 2421296; 451365, 2421383; 451432, 2421109 excluding land bound by 457490, 2421812; 457400, 2421778; 457352, 2421693") do |str, region, i|
+          "#{str}[POST]"
+        end
+      end
+      
+      it "should find the right number of regions" do
+        @extractor.regions.size.should == 1
+      end
+      
+      it "should not overwrite the exclude" do
+        @extractor.resulting_text.should == "<p>UTM zone 4 451377, 2420941; 451318, 2421296; 451365, 2421383; 451432, 2421109[POST] excluding land bound by 457490, 2421812; 457400, 2421778; 457352, 2421693"
+      end
+    end
+    
+    context "with a block" do
+      it "puts a replacement in for each region" do
+        extractor = RegionExtractor.new("UTM Zone 10 557923, 4838857; 557919, 4838854; 557919, 4838854. Then 457631, 2421540; 457678, 2421675; 457766, 2421821; 457637, 2421453.") do |str, region, i|
+          "#{str}[i=#{i}; points=#{region.points.size}]"
+        end
+        extractor.resulting_text.should == "UTM Zone 10 557923, 4838857; 557919, 4838854; 557919, 4838854[i=0; points=3]. Then 457631, 2421540; 457678, 2421675; 457766, 2421821; 457637, 2421453[i=1; points=4]."
+      end
+    end
+  end
+end
+
+# (ii) Starting on the coastline at approximately coordinates of: 458997, 2422152; follow: 458345, 2422341; 458686, 2422405; 458786, 2422373;458934, 2422253; 459001, 2422151; 458997, 2422152; 457589, 2420990; 457575, 2420975; 457511, 2420984; 457631, 2421127; 457738, 2421168; 457900, 2421206; 458023, 2421343; 458023, 2421417; 457895, 2421435; 457803, 2421394; 457686, 2421405; 457637, 2421453; 457631, 2421540; 457678, 2421675; 457766, 2421821; 457908, 2421944; 458069, 2421867; 458216, 2421849; 458244, 2421886; 458253, 2421996; 458235, 2422079; 458299, 2422272; 458345, 2422341; 457589, 2420990; to approximately: 457590, 2420991 (coastline); follow coastline to the approximate coordinates of: 458494, 2421794; then follow: 458494, 2421795; 458495, 2421795; 458502, 2421802, 458492, 2421904; 458483, 2421987; 458566, 2422060; 458559, 2422190; 458630, 2422263; 458718, 2422262; 458805, 2422159; 458777, 2422115; 458686, 2422119; 458658, 2422060; 458667, 2421987; 458702, 2421920; to the coastline, approximately at: 458702, 2421919; follow coastline to beginning point: 458997, 2422152.

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'region_extractor'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification 
+name: region_extractor
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Andrew Carpenter
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-12 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: proj4rb
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 3
+        - 1
+        version: 0.3.1
+  type: :runtime
+  version_requirements: *id002
+description: Attempts to extract geographic regions mentioned in txt/html documents.
+email: andrew.main@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/region_extractor.rb
+- lib/region_extractor/point.rb
+- lib/region_extractor/region.rb
+- region_extractor.gemspec
+- spec/region_extractor_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/andrewcarpenter/region_extractor
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Extract geographic regions from plain text
+test_files: 
+- spec/region_extractor_spec.rb
+- spec/spec_helper.rb