ffi-ogr 0.1.0.pre → 0.1.0.pre2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4b9dde86c53cf560c92a01c1d443f9beac5ec1b5
-  data.tar.gz: ad9969a5ca379d9595dd13ae5428ca747718f2f3
+  metadata.gz: 05e06c17b1e9e0694b0ff9a7deb4308048ad9f6f
+  data.tar.gz: 89a97fbea029d509c949fc1d8ebd62c22b6a1f46
 SHA512:
-  metadata.gz: c83069cc2d02ec53ce2b9d6864aa79388044a68e65cd007fedfdbf3ef8a513be7b566fdec58357501681adf5eec5df3b5181dbfd02fc27e7ba26511f7a3bbcc1
-  data.tar.gz: efaa386893615bffed98d19ed34a31fd4ab1d5071c6137823e709652968d09b35d9540eb0144b2eb71db2211596ee048e187e420c22ca4ed267d0af9c08323b4
+  metadata.gz: fda92892f274226cce09ee1994aaa774a17dac70e1edcd720d879d872e9f86a70a0c2eae6723fe57cb5a93a0dae888b54aa8ebf96a3f370cdc342372890ac98f
+  data.tar.gz: 55759dbc143c2439baa0dda8e70ba5ac67bb5de3ddf86841c9ed6afecc77bbb9997b1c4524e42cee7220b3758ffce10813d28e3a6b681d53a5a6f296e3012200

data/README.md

@@ -1,23 +1,46 @@
+[![Build Status](https://travis-ci.org/scooterw/ffi-ogr.png?branch=master)](https://travis-ci.org/scooterw/ffi-ogr)
+[![Code Climate](https://codeclimate.com/github/scooterw/ffi-ogr.png)](https://codeclimate.com/github/scooterw/ffi-ogr)
+
+GDAL must be installed:
+
+Mac:
+```
+brew install gdal
+```
+
+Ubuntu:
+```
+sudo apt-key adv --recv-keys --keyserver keyserver.ubuntu.com 16126D3A3E5C1192
+sudo apt-get install python-software-properties -y
+sudo add-apt-repository ppa:ubuntugis/ppa -y
+sudo apt-get update -qq
+sudo apt-get install libgdal-dev
+```
+
 ffi-ogr
 ... for convenient access to OGR functionality from Ruby
 
 To run: `bin/ogr_console`
 
-To read from a known file type (currently SHP, JSON/GeoJSON, raw Github GeoJSON URL, Esri Feature Service URL):
+To read from a known file type (currently SHP, JSON/GeoJSON, CSV, raw Github GeoJSON URL, raw (spatial) CSV URL, Esri Feature Service URL):
 
 ```ruby
 data = OGR.read('https://raw.github.com/colemanm/hurricanes/master/fl_2004_hurricanes.geojson')
 => #<OGR::DataSource:0x007fb830aa3af8 @ptr=#<FFI::AutoPointer address=0x007fb8311ab990>>
 
 # output to SHP file
-data.to_shp '/~Desktop/github_to_shp.shp'
+data.to_shp '~/Desktop/github_to_shp.shp'
+=> nil
+
+# output to CSV file
+data.to_csv '~/Desktop/github_to_csv.csv'
 => nil
 ```
 
 To read a shapefile:
 
 ```ruby
-shp = OGR::ShpReader.new.read './spec/data/ne_110m_coastline/ne_110m_coastline.shp'
+shp = OGR.read './spec/data/ne_110m_coastline/ne_110m_coastline.shp'
 # => #<OGR::DataSource:0x007fba4d19c328 @ptr=#<FFI::AutoPointer address=0x007fba4c4cdc50>>
 
 shp.to_geojson '~/Desktop/output.geojson'
@@ -27,7 +50,7 @@ shp.to_geojson '~/Desktop/output.geojson'
 To reproject a shapefile:
 
 ```ruby
-shp = OGR::ShpReader.new.read './spec/data/ne_110m_coastline/ne_110m_coastline.shp'
+shp = OGR.read './spec/data/ne_110m_coastline/ne_110m_coastline.shp'
 # => #<OGR::DataSource:0x007fba4d19c328 @ptr=#<FFI::AutoPointer address=0x007fba4c4cdc50>>
 
 shp.to_json
@@ -44,17 +67,10 @@ shp.to_shp '~/Desktop/reprojected_shp.shp', {spatial_ref: new_sr}
 # => Output reprojected SHP to specified file
 ```
 
-A reader may also be inferred by file extension (currently works for shp and json/geojson):
-
-```ruby
-shp = OGR::Reader.from_file_type './spec/data/ne_110m_coastline/ne_110m_coastline.shp'
-```
-
 To create a shapefile:
 
 ```ruby
-writer = OGR::ShpWriter.new
-writer.set_output '~/Documents/shapefiles/my_new.shp'
+writer = OGR.create_writer '~/Documents/shapefiles/my_new.shp'
 
 shp = writer.ptr
 
@@ -84,10 +100,11 @@ layer.add_feature feature
 layer.sync
 ```
 
-A writer may also be inferred by file extension (currently works for shp and json/geojson):
+A writer may be fetched by driver type:
 
 ```ruby
-writer = OGR::Writer.from_file_type '~/Documents/shapefiles/my_new.shp'
+writer = OGR.get_writer 'shp'
+writer.set_output '~/Documents/shapefiles/my_new.shp'
 ```
 
-Tested on: MRI 1.9.3 / 2.0.0 and JRuby 1.7.3+
+Tested on: MRI (1.9/2.0), JRuby (1.9/2.0), and Rubinius (1.9/2.0)

data/lib/ffi-ogr.rb

@@ -6,23 +6,21 @@ module OGR
 
   DRIVER_TYPES = {
     'shapefile' => 'ESRI Shapefile',
-    'geojson' => 'GeoJSON'
+    'shp' => 'ESRI Shapefile',
+    'geojson' => 'GeoJSON',
+    'json' => 'GeoJSON',
+    'csv' => 'CSV',
+    'kml' => 'KML'
   }
 
   autoload :Reader, File.join(OGR_BASE, 'reader')
-  autoload :GenericReader, File.join(OGR_BASE, 'generic_reader')
-  autoload :ShpReader, File.join(OGR_BASE, 'shp_reader')
-  autoload :GeoJSONReader, File.join(OGR_BASE, 'geo_json_reader')
-  autoload :UrlGeoJSONReader, File.join(OGR_BASE, 'url_geo_json_reader')
-  autoload :FeatureServiceReader, File.join(OGR_BASE, 'feature_service_reader')
-  autoload :GithubReader, File.join(OGR_BASE, 'github_reader')
+  autoload :HttpReader, File.join(OGR_BASE, 'http_reader')
   autoload :Writer, File.join(OGR_BASE, 'writer')
-  autoload :GenericWriter, File.join(OGR_BASE, 'generic_writer')
-  autoload :ShpWriter, File.join(OGR_BASE, 'shp_writer')
-  autoload :GeoJSONWriter, File.join(OGR_BASE, 'geo_json_writer')
   autoload :DataSource, File.join(OGR_BASE, 'data_source')
   autoload :Shapefile, File.join(OGR_BASE, 'shapefile')
   autoload :GeoJSON, File.join(OGR_BASE, 'geo_json')
+  autoload :CSV, File.join(OGR_BASE, 'csv')
+  autoload :KML, File.join(OGR_BASE, 'kml')
   autoload :Tools, File.join(OGR_BASE, 'tools')
   autoload :Layer, File.join(OGR_BASE, 'layer')
   autoload :Feature, File.join(OGR_BASE, 'feature')
@@ -341,17 +339,36 @@ module OGR
       FFI::MemoryPointer.from_string(str)
     end
 
+    def get_writer(source)
+      extension = source.split('.').last
+      driver = DRIVER_TYPES[extension]
+
+      raise RuntimeError.new "Could not find appropriate driver" if driver.nil?
+
+      Writer.new(driver)
+    end
+
+    def create_writer(path)
+      raise RuntimeError.new "Path already exists: #{path}" if File.exists?(path)
+
+      writer = get_writer path
+      writer.set_output path
+      writer
+    end
+
     def read(source)
       case source
       when /http:|https:/
-        UrlGeoJSONReader.new.read source
-      when /.shp/
-        ShpReader.new.read source
-      when /.json|.geojson/
-        GeoJSONReader.new.read source
+        HttpReader.new.read source
       else
-        raise RuntimeError.new("Could not determine file type based on input")
+        extension = source.split('.').last
+        driver = DRIVER_TYPES[extension]
+
+        raise RuntimeError.new "Could not determine file type" if driver.nil?
+
+        Reader.new(driver).read source
       end
     end
   end
 end
+

data/lib/ffi-ogr/csv.rb

@@ -0,0 +1,3 @@
+module OGR
+  class CSV < DataSource;end
+end

data/lib/ffi-ogr/data_source.rb

@@ -129,18 +129,35 @@ module OGR
     end
     alias_method :fields, :get_fields
 
-    def to_shp(output_path, spatial_ref=nil)
+    def to_format(format, output_path, spatial_ref=nil)
       raise RuntimeError.new("Output path not specified.") if output_path.nil?
 
       # TODO: handle parsing of spatial_ref -> copy options
 
-      if spatial_ref.instance_of? OGR::SpatialReference
-        copy_with_transform('shapefile', output_path, spatial_ref)
-      elsif spatial_ref.nil?
-        copy('shapefile', output_path, spatial_ref)
+      unless spatial_ref
+        copy format, output_path, spatial_ref
+      else
+        if spatial_ref[:spatial_ref].instance_of? OGR::SpatialReference
+          copy_with_transform format, output_path, spatial_ref[:spatial_ref]
+        else
+          raise RuntimeError.new("Invalid spatial reference specified.")
+        end
       end
     end
 
+    def to_shp(output_path, spatial_ref=nil)
+      to_format('shapefile', output_path, spatial_ref)
+    end
+
+    def to_csv(output_path, spatial_ref=nil)
+      to_format('csv', output_path, spatial_ref)
+    end
+
+    def to_kml(output_path, spatial_ref=nil)
+      warn "KML output will always be in EPSG:4326" unless spatial_ref.nil?
+      to_format('kml', output_path, spatial_ref)
+    end
+
     def to_geojson(output_path, options=nil)
       raise RuntimeError.new("Output path not specified.") if output_path.nil?
 

data/lib/ffi-ogr/http_reader.rb

@@ -0,0 +1,37 @@
+require 'fileutils'
+require 'securerandom'
+require 'faraday'
+
+module OGR
+  class HttpReader
+    def read(url, writeable=false)
+      file_extension = url.split('.').last
+      driver = OGR::DRIVER_TYPES[file_extension]
+
+      if driver.nil?
+        unless url =~ /FeatureServer/
+          raise RuntimeError.new "File type not supported."
+        else
+          # ? assume Esri Feature Service ?
+          file_extension = 'json'
+          driver = OGR::DRIVER_TYPES[file_extension]
+        end
+      end
+
+      file_name = "#{SecureRandom.urlsafe_base64}.#{file_extension}"
+
+      http_resource = Faraday.get(url).body
+
+      File.open(file_name, 'wb') do |f|
+        f.write http_resource
+      end
+
+      ds = Reader.new(driver).read(file_name, writeable)
+
+      FileUtils.rm file_name
+
+      ds
+    end
+  end
+end
+

data/lib/ffi-ogr/kml.rb

@@ -0,0 +1,4 @@
+module OGR
+  class KML < DataSource;end
+end
+

data/lib/ffi-ogr/reader.rb

@@ -2,6 +2,8 @@ module OGR
   class Reader
     include OGR::FFIOGR
 
+    attr_accessor :type
+
     TF_MAP = {
       true => 1,
       false => 0,
@@ -9,20 +11,11 @@ module OGR
       0 => false
     }
 
-    # Reader Class NOT to be used directly
-    # Use subclasses e.g. ShpReader
-    def initialize;end
-
-    def self.from_file_type(path)
-      path = File.expand_path(path)
-
-      if path =~ /.shp/
-        ShpReader.new
-      elsif path =~ /.geojson|.json/
-        GeoJSONReader.new
-      else
-        raise RuntimeError.new("Could not determine appropriate reader for this file type")
-      end
+    def initialize(driver_name)
+      OGRRegisterAll()
+      @driver = OGRGetDriverByName(driver_name)
+      raise RuntimeError.new "Invalid driver name" if @driver.null?
+      @type = driver_name
     end
 
     def read(file_path, writeable=false)
@@ -31,3 +24,4 @@ module OGR
     end
   end
 end
+

data/lib/ffi-ogr/version.rb

@@ -1,3 +1,3 @@
 module OGR
-  VERSION = '0.1.0.pre'
+  VERSION = '0.1.0.pre2'
 end

data/lib/ffi-ogr/writer.rb

@@ -2,9 +2,14 @@ module OGR
   class Writer
     include OGR::FFIOGR
 
-    attr_accessor :ptr
+    attr_accessor :ptr, :type
 
-    def initialize;end
+    def initialize(driver_name)
+      OGRRegisterAll()
+      @driver = OGRGetDriverByName(driver_name)
+      raise RuntimeError.new "Invalid driver name" if @driver.null?
+      @type = driver_name
+    end
 
     def set_output(path, options={})
       path = File.expand_path(path)
@@ -12,31 +17,6 @@ module OGR
       @ptr = OGR::Tools.cast_data_source(ds)
       @ptr
     end
-
-    def self.from_file_type(path)
-      path = File.expand_path(path)
-
-      unless File.exists? path
-        if path =~ /.shp/
-          writer = ShpWriter.new
-        elsif path =~ /.geojson|.json/
-          writer = GeoJSONWriter.new
-        else
-          raise RuntimeError.new("Could not determine appropriate writer for this file type")
-        end
-
-        writer.set_output(path)
-        writer
-      else
-        raise RuntimeError.new("Path already exists: #{path}")
-      end
-    end
-
-    def export(output_path)
-      writer = Writer.from_file_type output_path
-      data_source = writer.ds
-
-      # @ptr -> data_source
-    end
   end
 end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ffi-ogr
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre
+  version: 0.1.0.pre2
 platform: ruby
 authors:
 - Scooter Wadsworth
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-01 00:00:00.000000000 Z
+date: 2013-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -80,6 +80,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: FFI wrapper for OGR
 email:
 - scooterwadsworth@gmail.com
@@ -91,19 +105,16 @@ files:
 - README.md
 - bin/ogr_console
 - lib/ffi-ogr/coordinate_transformation.rb
+- lib/ffi-ogr/csv.rb
 - lib/ffi-ogr/data_source.rb
 - lib/ffi-ogr/envelope.rb
 - lib/ffi-ogr/feature.rb
-- lib/ffi-ogr/feature_service_reader.rb
-- lib/ffi-ogr/generic_reader.rb
-- lib/ffi-ogr/generic_writer.rb
 - lib/ffi-ogr/geo_json.rb
-- lib/ffi-ogr/geo_json_reader.rb
-- lib/ffi-ogr/geo_json_writer.rb
 - lib/ffi-ogr/geometry.rb
 - lib/ffi-ogr/geometry_collection.rb
 - lib/ffi-ogr/geometry_collection_25d.rb
-- lib/ffi-ogr/github_reader.rb
+- lib/ffi-ogr/http_reader.rb
+- lib/ffi-ogr/kml.rb
 - lib/ffi-ogr/layer.rb
 - lib/ffi-ogr/line_string.rb
 - lib/ffi-ogr/line_string_25d.rb
@@ -121,11 +132,8 @@ files:
 - lib/ffi-ogr/polygon_25d.rb
 - lib/ffi-ogr/reader.rb
 - lib/ffi-ogr/shapefile.rb
-- lib/ffi-ogr/shp_reader.rb
-- lib/ffi-ogr/shp_writer.rb
 - lib/ffi-ogr/spatial_reference.rb
 - lib/ffi-ogr/tools.rb
-- lib/ffi-ogr/url_geo_json_reader.rb
 - lib/ffi-ogr/version.rb
 - lib/ffi-ogr/writer.rb
 - lib/ffi-ogr.rb

data/lib/ffi-ogr/feature_service_reader.rb

@@ -1,3 +0,0 @@
-module OGR
-  class FeatureServiceReader < UrlGeoJSONReader;end
-end

data/lib/ffi-ogr/generic_reader.rb

@@ -1,9 +0,0 @@
-module OGR
-  class GenericReader < Reader
-    def initialize(driver_name)
-      OGRRegisterAll()
-      @driver = OGRGetDriverByName(driver_name)
-      raise RuntimeError.new("Invalid driver name") if @driver.null?
-    end
-  end
-end

data/lib/ffi-ogr/generic_writer.rb

@@ -1,9 +0,0 @@
-module OGR
-  class GenericWriter < Writer
-    def initialize(driver_name)
-      OGRRegisterAll()
-      @driver = OGRGetDriverByName(driver_name)
-      raise RuntimeError.new("Invalid driver name") if @driver.null?
-    end
-  end
-end

data/lib/ffi-ogr/geo_json_reader.rb

@@ -1,8 +0,0 @@
-module OGR
-  class GeoJSONReader < Reader
-    def initialize
-      OGRRegisterAll()
-      @driver = OGRGetDriverByName("GeoJSON")
-    end
-  end
-end

data/lib/ffi-ogr/geo_json_writer.rb

@@ -1,8 +0,0 @@
-module OGR
-  class GeoJSONWriter < Writer
-    def initialize
-      OGRRegisterAll()
-      @driver = OGRGetDriverByName("GeoJSON")
-    end
-  end
-end

data/lib/ffi-ogr/github_reader.rb

@@ -1,3 +0,0 @@
-module OGR
-  class GithubReader < UrlGeoJSONReader;end
-end

data/lib/ffi-ogr/shp_reader.rb

@@ -1,8 +0,0 @@
-module OGR
-  class ShpReader < Reader
-    def initialize
-      OGRRegisterAll()
-      @driver = OGRGetDriverByName("ESRI Shapefile")
-    end
-  end
-end

data/lib/ffi-ogr/shp_writer.rb

@@ -1,8 +0,0 @@
-module OGR
-  class ShpWriter < Writer
-    def initialize
-      OGRRegisterAll()
-      @driver = OGRGetDriverByName("ESRI Shapefile")
-    end
-  end
-end

data/lib/ffi-ogr/url_geo_json_reader.rb

@@ -1,22 +0,0 @@
-require 'fileutils'
-require 'securerandom'
-require 'faraday'
-
-module OGR
-  class UrlGeoJSONReader < GeoJSONReader
-    def read(url, writeable=false)
-      file_name = "#{SecureRandom.urlsafe_base64}.json"
-      remote_json = Faraday.get(url).body
-
-      File.open(file_name, 'wb') do |f|
-        f.write(remote_json)
-      end
-
-      data_source = super(file_name, writeable)
-
-      FileUtils.rm(file_name)
-
-      data_source
-    end
-  end
-end