georuby_remake 1.0.0

data/.gitignore

@@ -0,0 +1,6 @@
+.DS_Store
+pkg/*.gem
+pkg/*.tgz
+pkg/**/*
+coverage/*
+doc/*

data/History.txt

@@ -0,0 +1,4 @@
+== 0.0.1 2008-08-14
+
+* 1 major enhancement:
+  * Initial release

data/LICENSE

@@ -0,0 +1,21 @@
+GeoRuby License
+
+Copyright (c) 2006 Guilhem Vellut <guilhem.vellut+georuby@gmail.com>
+
+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
+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.txt

@@ -0,0 +1,118 @@
+# GeoRuby
+
+This is a remake of [nofxx/georuby](http://github.com/nofxx/georuby), enabling autoloading
+
+It is intended as a holder for data returned from PostGIS and the Spatial Extensions of MySql. The data model roughly follows the OGC "Simple Features for SQL" specification (see http://www.opengis.org/docs/99-049.pdf), although without any kind of advanced functionalities (such as geometric operators or reprojections). It also supports various output and input formats (GeoRSS, KML, Shapefile).
+
+## Available data types
+
+The following geometric data types are provided :
+- Point
+- Line string
+- Linear ring
+- Polygon
+- Multi point
+- Multi line string
+- Multi polygon
+- Geometry collection
+
+They can be in 2D, 3DZ, 3DM, and 4D.
+
+On top of this an Envelope class is available, to contain the bounding box of a geometry.
+
+## Input and output
+
+These geometries can be input and output in WKB/EWKB/WKT/EWKT format (as well as the related HexWKB and HexEWKB formats). HexEWKB and WKB are the default form under which geometric data is returned respectively from PostGIS and MySql.
+
+GeoRSS Simple, GeoRSS W3CGeo, GeoRSS GML can also be input and output. Note that they will not output valid RSS, but just the part strictly concerning the geometry as outlined in http://www.georss.org/1/ . Since the model does not allow multiple geometries, for geometry collections, only the first geometry will be output. Similarly, for polygons, the GeoRSS output will only contain the outer ring. As for W3CGeo output, only points can be output, so the first point of the geometry is chosen. By default the Simple format is output. Envelope can also be output in these formats: The box geometric type is chosen (except for W3CGeo, where the center of the envelope is chose). These formats can also be input and a GeoRuby geometry will be created. Note that it will not read a valid RSS file, only a geometry string.
+
+On top of that, there is now support for KML output and input. As for GeoRSS, a valid KML file will not be output, but only the geometric data. Options <tt>:id</tt>, <tt>:extrude</tt>, <tt>:tesselate</tt> and <tt>:altitude_mode</tt> can be given. Note that if the <tt>:altitude_mode</tt> option is not passed or set to <tt>clampToGround</tt>, the altitude data will not be output even if present. Envelopes output a LatLonAltBox instead of a geometry. For the output, the following geometric types are supported : Point, LineString, Polygon.
+
+
+## SHP reading et writing
+
+Georuby has support for reading ESRI shapefiles (http://www.esri.com/library/whitepapers/pdfs/shapefile.pdf). A tool called <tt>shp2sql.rb</tt> is also provided : it shows how to use the SHP reading functionality together with the spatial adapter plugin for Rails to import spatial features into MySQL and PostGIS.
+
+Here is an example of Shapefile reading, that goes through all the geometries in a file and disaply the values of the attributes :
+
+      require 'geo_ruby/shp'
+																	 
+      ShpFile.open(shpfile) do |shp|
+        shp.each do |shape|
+          geom = shape.geometry #a GeoRuby SimpleFeature
+          att_data = shape.data #a Hash
+          shp.fields.each do |field|
+            puts att_data[field.name]
+          end
+        end
+      end
+
+Support for ESRI shapefile creation and modification has been added as well. New shapefiles can be created given a geometry type and specifications for the DBF fields. Data can be added and removed from an existing shapefile. An update operation is also provided for convenience : it just performs a 'delete' and an 'add', which means the index of the modified record will change. Note that once a shapefile has been created, GeoRuby does not allow the modification of the schema (it will probably be done in a subsequent version).
+
+Here is an example of how to create a new Shapefile with 2 fields :
+																	 
+      shpfile = ShpFile.create('hello.shp',ShpType::POINT,[Dbf::Field.new("Hoyoyo","C",10),Dbf::Field.new("Boyoul","N",10,0)])
+
+The file is then open for reading and writing.
+
+Here is an example of how to write to a shapefile (created or not with GeoRuby) :
+
+      shpfile = ShpFile.open('places.shp')
+      shpfile.transaction do |tr|
+        tr.add(ShpRecord.new(Point.from_x_y(123.4,123.4),'Hoyoyo' => "AEZ",'Bouyoul' => 45))
+        tr.update(4,ShpRecord.new(Point.from_x_y(-16.67,16.41),'Hoyoyo' => "EatMe",'Bouyoul' => 42))
+        tr.delete(1)
+      end
+      shpfile.close
+																	 
+Note the transaction is just there so the operations on the files can be buffered. Nothing happens on the original files until the block has finished executing. Calling <tt>tr.rollback</tt> at anytime during the execution will prevent the modifications.
+
+Also currently, error reporting is minimal and it has not been tested that thoroughly so caveat emptor and backup before performing any destructive operation.
+
+
+=== GPX Reading
+
+You can read and convert GPX Files to LineString/Polygon:
+
+     gpxfile = GpxFile.open(tour.gpx')
+     gpxfile.as_line_string
+     => GeoRuby::SimpleFeatures::LineString..
+
+
+=== Installation
+
+To install the latest version, just type :
+
+      gem install nofxx-georuby
+
+
+=== Changes since the last version
+
+- Writing of ESRI shapefiles
+- Reading of ESRI shapefiles
+- Addition of a small tool to import spatial features in MySQL and PostGIS from a SHP file
+
+
+=== Coming in the next versions
+
+- Schema modification of existing shapefiles
+- More error reporting when writing shapefiles
+- More tests on writing shapefiles ; tests on real-world shapefiles
+- Better shp2sql import tool
+- Documentation
+
+
+=== Acknowledgement
+
+The SHP reading part uses the DBF library (http://rubyforge.org/projects/dbf/) by Keith Morrison (http://infused.org).
+Thanks also to Pramukta Kumar and Pete Schwamb for their contributions.
+
+
+=== License
+
+GeoRuby is released under the MIT license.
+
+=== Support
+
+Any questions, enhancement proposals, bug notifications or corrections
+can be sent to mailto:guilhem.vellut@gmail.com.

data/Rakefile

@@ -0,0 +1,47 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "georuby_remake"
+    gem.summary = "Ruby data holder for OGC Simple Features"
+    gem.description = "GeoRuby provides geometric data types from the OGC 'Simple Features' specification."
+    gem.email = "juniorz@gmail.com"
+    gem.homepage = "http://github.com/juniorz/georuby_remake"
+    gem.authors = ["Guilhem Vellut", "Marcos Piccinini"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_development_dependency "dbf", ">= 1.1.2"
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+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 :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "geo_ruby #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/georuby_remake.gemspec

@@ -0,0 +1,132 @@
+# 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{georuby_remake}
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Guilhem Vellut", "Marcos Piccinini"]
+  s.date = %q{2010-09-20}
+  s.description = %q{GeoRuby provides geometric data types from the OGC 'Simple Features' specification.}
+  s.email = %q{juniorz@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.txt"
+  ]
+  s.files = [
+    ".gitignore",
+     "History.txt",
+     "LICENSE",
+     "README.txt",
+     "Rakefile",
+     "VERSION",
+     "georuby_remake.gemspec",
+     "lib/geo_ruby.rb",
+     "lib/geo_ruby/gpx4r.rb",
+     "lib/geo_ruby/gpx4r/gpx.rb",
+     "lib/geo_ruby/shp4r.rb",
+     "lib/geo_ruby/shp4r/dbf.rb",
+     "lib/geo_ruby/shp4r/shp_file.rb",
+     "lib/geo_ruby/shp4r/shp_record.rb",
+     "lib/geo_ruby/shp4r/shp_transaction.rb",
+     "lib/geo_ruby/simple_features.rb",
+     "lib/geo_ruby/simple_features/envelope.rb",
+     "lib/geo_ruby/simple_features/ewkb_parser.rb",
+     "lib/geo_ruby/simple_features/ewkt_parser.rb",
+     "lib/geo_ruby/simple_features/geometry.rb",
+     "lib/geo_ruby/simple_features/geometry_collection.rb",
+     "lib/geo_ruby/simple_features/geometry_factory.rb",
+     "lib/geo_ruby/simple_features/georss_parser.rb",
+     "lib/geo_ruby/simple_features/helper.rb",
+     "lib/geo_ruby/simple_features/line_string.rb",
+     "lib/geo_ruby/simple_features/linear_ring.rb",
+     "lib/geo_ruby/simple_features/multi_line_string.rb",
+     "lib/geo_ruby/simple_features/multi_point.rb",
+     "lib/geo_ruby/simple_features/multi_polygon.rb",
+     "lib/geo_ruby/simple_features/point.rb",
+     "lib/geo_ruby/simple_features/polygon.rb",
+     "spec/data/gpx/fells_loop.gpx",
+     "spec/data/gpx/long.gpx",
+     "spec/data/gpx/long.kml",
+     "spec/data/gpx/long.nmea",
+     "spec/data/gpx/short.gpx",
+     "spec/data/gpx/short.kml",
+     "spec/data/gpx/tracktreks.gpx",
+     "spec/data/multipoint.dbf",
+     "spec/data/multipoint.shp",
+     "spec/data/multipoint.shx",
+     "spec/data/point.dbf",
+     "spec/data/point.shp",
+     "spec/data/point.shx",
+     "spec/data/polygon.dbf",
+     "spec/data/polygon.shp",
+     "spec/data/polygon.shx",
+     "spec/data/polyline.dbf",
+     "spec/data/polyline.shp",
+     "spec/data/polyline.shx",
+     "spec/geo_ruby/gpx4r/gpx_spec.rb",
+     "spec/geo_ruby/shp4r/shp_spec.rb",
+     "spec/geo_ruby/simple_features/envelope_spec.rb",
+     "spec/geo_ruby/simple_features/ewkb_parser_spec.rb",
+     "spec/geo_ruby/simple_features/ewkt_parser_spec.rb",
+     "spec/geo_ruby/simple_features/geometry_collection_spec.rb",
+     "spec/geo_ruby/simple_features/geometry_factory_spec.rb",
+     "spec/geo_ruby/simple_features/geometry_spec.rb",
+     "spec/geo_ruby/simple_features/georss_parser_spec.rb",
+     "spec/geo_ruby/simple_features/line_string_spec.rb",
+     "spec/geo_ruby/simple_features/linear_ring_spec.rb",
+     "spec/geo_ruby/simple_features/multi_line_string_spec.rb",
+     "spec/geo_ruby/simple_features/multi_point_spec.rb",
+     "spec/geo_ruby/simple_features/multi_polygon_spec.rb",
+     "spec/geo_ruby/simple_features/point_spec.rb",
+     "spec/geo_ruby/simple_features/polygon_spec.rb",
+     "spec/geo_ruby_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/juniorz/georuby_remake}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Ruby data holder for OGC Simple Features}
+  s.test_files = [
+    "spec/geo_ruby_spec.rb",
+     "spec/spec_helper.rb",
+     "spec/geo_ruby/shp4r/shp_spec.rb",
+     "spec/geo_ruby/gpx4r/gpx_spec.rb",
+     "spec/geo_ruby/simple_features/geometry_factory_spec.rb",
+     "spec/geo_ruby/simple_features/multi_polygon_spec.rb",
+     "spec/geo_ruby/simple_features/multi_point_spec.rb",
+     "spec/geo_ruby/simple_features/geometry_collection_spec.rb",
+     "spec/geo_ruby/simple_features/multi_line_string_spec.rb",
+     "spec/geo_ruby/simple_features/envelope_spec.rb",
+     "spec/geo_ruby/simple_features/polygon_spec.rb",
+     "spec/geo_ruby/simple_features/geometry_spec.rb",
+     "spec/geo_ruby/simple_features/linear_ring_spec.rb",
+     "spec/geo_ruby/simple_features/point_spec.rb",
+     "spec/geo_ruby/simple_features/georss_parser_spec.rb",
+     "spec/geo_ruby/simple_features/ewkb_parser_spec.rb",
+     "spec/geo_ruby/simple_features/line_string_spec.rb",
+     "spec/geo_ruby/simple_features/ewkt_parser_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_development_dependency(%q<dbf>, [">= 1.1.2"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_dependency(%q<dbf>, [">= 1.1.2"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    s.add_dependency(%q<dbf>, [">= 1.1.2"])
+  end
+end
+

data/lib/geo_ruby.rb

@@ -0,0 +1,5 @@
+module GeoRuby
+  autoload :SimpleFeatures, 'geo_ruby/simple_features'
+  autoload :Shp4r,          'geo_ruby/shp4r'
+  autoload :Gpx4r,          'geo_ruby/gpx4r'
+end

data/lib/geo_ruby/gpx4r.rb

@@ -0,0 +1,9 @@
+require "rubygems"
+require "nokogiri"
+
+module GeoRuby::Gpx4r
+  autoload :GpxFile, 'geo_ruby/gpx4r/gpx'
+
+  class MalformedGpxException < StandardError
+  end
+end

data/lib/geo_ruby/gpx4r/gpx.rb

@@ -0,0 +1,104 @@
+#An interface to GPX files
+class GeoRuby::Gpx4r::GpxFile
+  attr_reader :record_count, :file_root #:xmin, :ymin, :xmax, :ymax, :zmin, :zmax, :mmin, :mmax, :file_length
+
+  include Enumerable
+
+  # Opens a GPX file. Both "abc.shp" and "abc" are accepted.
+  def initialize(file, *opts) #with_z = true, with_m = true)
+    @file_root = file.gsub(/\.gpx$/i,"")
+    raise MalformedGpxException.new("Missing GPX File") unless
+      File.exists? @file_root + ".gpx"
+    @points, @envelope = [], nil
+    @gpx = File.open(@file_root + ".gpx", "rb")
+    opt = opts.inject({}) { |o, h| h.merge(o) }
+    parse_file(opt[:with_z], opt[:with_m])
+  end
+
+  #force the reopening of the files compsing the shp. Close before calling this.
+  def reload!
+    initialize(@file_root)
+  end
+
+  #opens a GPX "file". If a block is given, the GpxFile object is yielded to it and is closed upon return. Else a call to <tt>open</tt> is equivalent to <tt>GpxFile.new(...)</tt>.
+  def self.open(file, *opts)
+    gpxfile = GpxFile.new(file, *opts)
+    if block_given?
+      yield gpxfile
+      gpxfile.close
+    else
+      gpxfile
+    end
+  end
+
+  #Closes a gpxfile
+  def close
+    @gpx.close
+  end
+
+  #Tests if the file has no record
+  def empty?
+    record_count == 0
+  end
+
+  #Goes through each record
+  def each
+    (0...record_count).each do |i|
+      yield get_record(i)
+    end
+  end
+  alias :each_record :each
+
+  #Returns record +i+
+  def [](i)
+    get_record(i)
+  end
+
+  #Returns all the records
+  def records
+    @points
+  end
+
+  # Return the GPX file as LineString
+  def as_line_string
+    LineString.from_points(@points)
+  end
+  alias :as_polyline :as_line_string
+
+  # Return the GPX file as a Polygon
+  # If the GPX isn't closed, a line from the first
+  # to the last point will be created to close it.
+  def as_polygon
+    Polygon.from_points([@points[0] == @points[-1] ?  @points : @points.push(@points[0].clone)])
+  end
+
+  # Return GPX Envelope
+  def envelope
+    @envelope ||= as_polygon.envelope
+  end
+
+  private
+
+  def get_record(i)
+    @points[i]
+  end
+
+  # wpt => waypoint => TODO?
+  # rte(pt) => route
+  # trk(pt) => track /
+  def parse_file(with_z, with_m)
+    data = @gpx.read
+    @file_mode = data =~ /trkpt/ ? "//trkpt" : "//rtept"
+    Nokogiri.HTML(data).search(@file_mode).each do |tp|
+      z = z.inner_text.to_i if with_z && z = tp.at("ele")
+      m = m.inner_text if with_m && m = tp.at("time")
+      @points << Point.from_coordinates([tp["lon"].to_f, tp["lat"].to_f, z, m],nil,with_z, with_m)
+    end
+    close
+    @record_count = @points.length
+  rescue => e
+    raise MalformedGpxException.new("Bad GPX. Error: #{e}")
+    # trackpoint.at("gpxdata:hr").nil? # heartrate
+  end
+
+end