esri_shapefile 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1eea7f296a0ef93cc09b8fe87fa30a3c01c67e61
-  data.tar.gz: 5f2f82a3facd9330fde2125598c443c529103551
+  metadata.gz: fb1817abc87ffd5412b71bd0bb63bf45b2b139d2
+  data.tar.gz: 56eb64d557473ecb32f2f1b95597795ad8dd46b7
 SHA512:
-  metadata.gz: a5e5a80ef2d2665e3f608229da92f49ae671d29dc74f2e9b222fb9eacb48f93eddcfd5b4edda8c4e9ff3328d013590fee16bc2bd2a09cf6b4dc0b5e8db308108
-  data.tar.gz: 53354693c75d1f5f68c040462b343456d598eae0bbcd603373a1a0f20c3c6b2c29b89a9a8a8f1cfb29a4bbd1bbdb4823730cbd25c4cb413e393cc39a5d3a3848
+  metadata.gz: 0258bfab1a89bcde50fface153b299bb623a12e9494bcc093c3bda6ee70cbdbb6c66a357260cfce9c5abda4d3306551908d5e1efdf90c4d0fdb2f9c5f7e40a6b
+  data.tar.gz: 8348c2c65807999818dcfca9879f5baed08ef5f3e565970ee9690b987ba01c2f6649254a42a7d62945ff024d6b9b5f292da488fd4f7ff45708e137069a4f5ca1

data/lib/esri_shapefile.rb

@@ -2,6 +2,8 @@ require "esri_shapefile/version"
 require "esri_shapefile/byte_model"
 require "esri_shapefile/byte_model/field"
 
+require "esri_shapefile/models/utils/ring"
+
 require "esri_shapefile/models/shapes/null"
 require "esri_shapefile/models/shapes/point"
 require "esri_shapefile/models/shapes/point_m"
@@ -22,8 +24,9 @@ require "esri_shapefile/models/main_file_header"
 require "esri_shapefile/models/record_header"
 
 require "esri_shapefile/reader"
+require "esri_shapefile/converter/svg"
+require "esri_shapefile/converter/svg/polygon"
 
 module EsriShapefile
-  # Your code goes here...
 end
 

data/lib/esri_shapefile/byte_model.rb

@@ -1,41 +1,55 @@
 module EsriShapefile
   module ByteModel
 
-    def field(name, number: nil, position:, type:, byte_order:)
-      attr_accessor name unless name == :unused
-      fields << Field.new(name, position: position, type: type, byte_order: byte_order, number: number)
+    attr_accessor :metadata
+
+    def self.included(model)
+      model.extend(ClassMethods)
     end
 
-    def fields
-      @fields ||= []
+    def self.extended(model)
+      error_message = "\nInvalid ByteModel usage: `extend EsriShapefile::ByteModel`\n"
+      error_message << "Please change the syntax to `include EsriShapefile::ByteModel'"
+      raise error_message
     end
 
-    def from_bytes(bytes)
-      field_values = {}
-      fields.reduce(0) do |offset, field|
-        if !field.unused?
-          unpack_format = field.unpack_format(field_values)
-          field_value = bytes.unpack("@#{offset}#{unpack_format}")
-
-          if field.type == :point
-            field_value = field_value.each_slice(2).map do |x, y|
-              point = Shapes::Point.new
-              point.x = x
-              point.y = y
-              point
+    module ClassMethods
+      def field(name, number: nil, position:, type:, byte_order:)
+        attr_accessor name unless name == :unused
+        fields << Field.new(name, position: position, type: type, byte_order: byte_order, number: number)
+      end
+
+      def fields
+        @fields ||= []
+      end
+
+      def from_bytes(bytes)
+        field_values = {}
+        fields.reduce(0) do |offset, field|
+          if !field.unused?
+            unpack_format = field.unpack_format(field_values)
+            field_value = bytes.unpack("@#{offset}#{unpack_format}")
+
+            if field.type == :point
+              field_value = field_value.each_slice(2).map do |x, y|
+                point = Shapes::Point.new
+                point.x = x
+                point.y = y
+                point
+              end
             end
+
+            field_values[field.name] = field.list? ? field_value : field_value.first
           end
 
-          field_values[field.name] = field.list? ? field_value : field_value.first
+          offset += field.bytesize(field_values)
+          (offset < bytes.size) ? offset : break
         end
 
-        offset += field.bytesize
-        (offset < bytes.size) ? offset : break
-      end
-
-      field_values.reduce(self.new) do |model, (field, value)|
-        model.send("#{field}=", value)
+        field_values.reduce(self.new) do |model, (field, value)|
+          model.send("#{field}=", value)
         model
+        end
       end
     end
 

data/lib/esri_shapefile/byte_model/field.rb

@@ -33,8 +33,16 @@ module EsriShapefile
         name == :unused
       end
 
-      def bytesize
-        TYPES[@type][:bytesize]
+      def bytesize(values = {})
+        size = TYPES[@type][:bytesize]
+
+        if number_depends_on_field?
+          multiplier = TYPES[@type][:unpack][:multiplier] || 1
+          number_of_consecutive_values = number_depends_on_field? ? values[number] : number
+          number_of_consecutive_values * multiplier * size
+        else
+          size
+        end
       end
 
       def unpack_format(values = {})

data/lib/esri_shapefile/converter/svg.rb

@@ -0,0 +1,56 @@
+module EsriShapefile
+  module Converter
+    class Svg
+
+      attr_reader :shapefile_path
+
+      def initialize(shapefile_path)
+        @shapefile_path = shapefile_path
+      end
+
+      def call(output_filepath)
+        File.open(output_filepath, "w") do |output_file|
+          reader = EsriShapefile::Reader.new(shapefile_path)
+          output_file.write(open_svg_header(reader.main_file_header))
+
+          reader.each_record do |record_header, shape|
+            shape_converter = get_shape_converter(shape)
+            output_file.write(shape_converter.to_svg(shape))
+          end
+
+          output_file.write(close_svg_header)
+        end
+      end
+
+      private
+
+      def get_shape_converter(shape)
+        case
+        when Shapes::Polygon then Svg::Polygon
+        else raise "Shape not supported"
+        end
+      end
+
+      def open_svg_header(main_file_header)
+        header =  '<!DOCTYPE html>'
+        header << '<html>'
+        header << '<body>'
+
+        height = main_file_header.y_max - main_file_header.y_min
+        width  = main_file_header.x_max - main_file_header.x_min
+
+        header << "<svg "
+        header << " height=\"100%\""
+        header << " width=\"100%\""
+        header << " viewbox=\"#{main_file_header.x_min} #{-main_file_header.y_max} #{width} #{height}\" >"
+        header
+      end
+
+      def close_svg_header
+        '</svg></body></html>'
+      end
+
+    end
+  end
+end
+

data/lib/esri_shapefile/converter/svg/polygon.rb

@@ -0,0 +1,25 @@
+module EsriShapefile
+  module Converter
+    class Svg::Polygon
+
+      def self.to_svg(polygon)
+        svg = '<g'
+        polygon.metadata.each do |key, value|
+          svg << " #{key}=\"#{value}\""
+        end
+        svg << '>'
+
+        polygon.rings.each do |ring|
+          svg << '<polygon points="'
+          ring.points.each do |ring|
+            svg << "#{ring.x},#{-ring.y} "
+          end
+          svg << '" />'
+        end
+
+        svg << "</g>"
+        svg
+      end
+    end
+  end
+end

data/lib/esri_shapefile/models/main_file_header.rb

@@ -7,7 +7,7 @@ module EsriShapefile
   # with respect to the start of the file.
   #
   class MainFileHeader
-    extend EsriShapefile::ByteModel
+    include EsriShapefile::ByteModel
 
     field :file_code,   position:  0, type: :integer, byte_order: :big
     field :unused,      position:  4, type: :integer, byte_order: :big

data/lib/esri_shapefile/models/record_header.rb

@@ -9,7 +9,7 @@ module EsriShapefile
   # record.
   #
   class RecordHeader
-    extend EsriShapefile::ByteModel
+    include EsriShapefile::ByteModel
 
     # Record numbers begin at 1.
     field :record_number,  position: 0, type: :integer, byte_order: :big

data/lib/esri_shapefile/models/shapes/multi_patch.rb

@@ -6,7 +6,7 @@ module EsriShapefile
     #
     #
     class MultiPatch
-      extend EsriShapefile::ByteModel
+      include EsriShapefile::ByteModel
 
       field :shape_type, position: 0,  type: :integer, byte_order: :little
       field :x_min,      position: 4,  type: :double,  byte_order: :little

data/lib/esri_shapefile/models/shapes/multi_point.rb

@@ -6,7 +6,7 @@ module EsriShapefile
     # A MultiPoint represents a set of points.
     #
     class MultiPoint
-      extend EsriShapefile::ByteModel
+      include EsriShapefile::ByteModel
 
       field :shape_type, position: 0,  type: :integer, byte_order: :little
       field :x_min,      position: 4,  type: :double,  byte_order: :little

data/lib/esri_shapefile/models/shapes/multi_point_m.rb

@@ -6,7 +6,7 @@ module EsriShapefile
     # A MultiPoint represents a set of points.
     #
     class MultiPointM
-      extend EsriShapefile::ByteModel
+      include EsriShapefile::ByteModel
 
       field :shape_type, position: 0,  type: :integer, byte_order: :little
       field :x_min,      position: 4,  type: :double,  byte_order: :little

data/lib/esri_shapefile/models/shapes/multi_point_z.rb

@@ -6,7 +6,7 @@ module EsriShapefile
     # A MultiPoint represents a set of points.
     #
     class MultiPointZ
-      extend EsriShapefile::ByteModel
+      include EsriShapefile::ByteModel
 
       field :shape_type, position: 0,  type: :integer, byte_order: :little
       field :x_min,      position: 4,  type: :double,  byte_order: :little

data/lib/esri_shapefile/models/shapes/null.rb

@@ -10,7 +10,7 @@ module EsriShapefile
     # populated with geometric data soon after they are created.
     #
     class Null
-      extend EsriShapefile::ByteModel
+      include EsriShapefile::ByteModel
 
       field :shape_type, position: 0, type: :integer, byte_order: :little
     end

data/lib/esri_shapefile/models/shapes/point.rb

@@ -7,12 +7,24 @@ module EsriShapefile
     # in the order X,Y.
     #
     class Point
-      extend EsriShapefile::ByteModel
+      include EsriShapefile::ByteModel
 
       field :shape_type, position: 0,  type: :integer, byte_order: :little
       field :x,          position: 4,  type: :double,  byte_order: :little
       field :y,          position: 12, type: :double,  byte_order: :little
 
+      def self.at(x:, y:)
+        point = Point.new
+        point.x = x
+        point.y = y
+        point
+      end
+
+      def eql?(point)
+        point.is_a?(Point) && point.x == x && point.y == y
+      end
+      alias_method :==, :eql?
+
     end
   end
 end

data/lib/esri_shapefile/models/shapes/point_m.rb

@@ -7,7 +7,7 @@ module EsriShapefile
     # in the order X,Y,Z plus a measure.
     #
     class PointM
-      extend EsriShapefile::ByteModel
+      include EsriShapefile::ByteModel
 
       field :shape_type, position: 0,  type: :integer, byte_order: :little
       field :x,          position: 4,  type: :double,  byte_order: :little

data/lib/esri_shapefile/models/shapes/point_z.rb

@@ -7,7 +7,7 @@ module EsriShapefile
     # in the order X,Y,Z plus a measure.
     #
     class PointZ
-      extend EsriShapefile::ByteModel
+      include EsriShapefile::ByteModel
 
       field :shape_type, position: 0,  type: :integer, byte_order: :little
       field :x,          position: 4,  type: :double,  byte_order: :little

data/lib/esri_shapefile/models/shapes/poly_line.rb

@@ -14,7 +14,7 @@ module EsriShapefile
     # allowed.
     #
     class PolyLine
-      extend EsriShapefile::ByteModel
+      include EsriShapefile::ByteModel
 
       field :shape_type, position: 0,  type: :integer, byte_order: :little
       field :x_min,      position: 4,  type: :double,  byte_order: :little

data/lib/esri_shapefile/models/shapes/poly_line_m.rb

@@ -8,7 +8,7 @@ module EsriShapefile
     # Parts may or may not intersect one another.
     #
     class PolyLineM
-      extend EsriShapefile::ByteModel
+      include EsriShapefile::ByteModel
 
       field :shape_type, position: 0,  type: :integer, byte_order: :little
       field :x_min,      position: 4,  type: :double,  byte_order: :little

data/lib/esri_shapefile/models/shapes/poly_line_z.rb

@@ -8,7 +8,7 @@ module EsriShapefile
     # Parts may or may not intersect one another.
     #
     class PolyLineZ
-      extend EsriShapefile::ByteModel
+      include EsriShapefile::ByteModel
 
       field :shape_type, position: 0,  type: :integer, byte_order: :little
       field :x_min,      position: 4,  type: :double,  byte_order: :little

data/lib/esri_shapefile/models/shapes/polygon.rb

@@ -21,7 +21,7 @@ module EsriShapefile
     # The Polygon structure is identical to the PolyLine structure.
     #
     class Polygon
-      extend EsriShapefile::ByteModel
+      include EsriShapefile::ByteModel
 
       field :shape_type, position: 0, type: :integer, byte_order: :little
       field :x_min,      position: 4,  type: :double,  byte_order: :little
@@ -32,6 +32,15 @@ module EsriShapefile
       field :num_points, position: 40, type: :integer, byte_order: :little
       field :parts,      position: 44, type: :integer, byte_order: :little, number: :num_parts
       field :points,     position: :x, type: :point,   byte_order: :little, number: :num_points
+
+      def rings
+        @rings ||= begin
+          ring_parts = (parts + [points.size])
+          ring_parts.each_cons(2).map do |ring_start_index, next_ring_index|
+            Ring.new(points[ring_start_index...next_ring_index])
+          end
+        end
+      end
     end
   end
 end

data/lib/esri_shapefile/models/shapes/polygon_m.rb

@@ -10,7 +10,7 @@ module EsriShapefile
     # The PolygonM structure is identical to the PolyLineM structure
     #
     class PolygonM
-      extend EsriShapefile::ByteModel
+      include EsriShapefile::ByteModel
 
       field :shape_type, position: 0,  type: :integer, byte_order: :little
       field :x_min,      position: 4,  type: :double,  byte_order: :little

data/lib/esri_shapefile/models/shapes/polygon_z.rb

@@ -10,7 +10,7 @@ module EsriShapefile
     # The PolygonZ structure is identical to the PolyLineZ structure
     #
     class PolygonZ
-      extend EsriShapefile::ByteModel
+      include EsriShapefile::ByteModel
 
       field :shape_type, position: 0,  type: :integer, byte_order: :little
       field :x_min,      position: 4,  type: :double,  byte_order: :little

data/lib/esri_shapefile/models/utils/ring.rb

@@ -0,0 +1,38 @@
+module EsriShapefile
+  class Ring
+    attr_reader :points, :direction
+
+    def initialize(points)
+      @points = points
+      @direction = determine_direction(points)
+    end
+
+    private
+
+    # Sum over the edges, (x2 − x1)(y2 + y1). If the result is positive the
+    # curve is clockwise, if it's negative the curve is counter-clockwise. (The
+    # result is twice the enclosed area, with a +/- convention.)
+    #
+    # point[0] = (5,0)   edge[0]: (6-5)(4+0) =   4
+    # point[1] = (6,4)   edge[1]: (4-6)(5+4) = -18
+    # point[2] = (4,5)   edge[2]: (1-4)(5+5) = -30
+    # point[3] = (1,5)   edge[3]: (1-1)(0+5) =   0
+    # point[4] = (1,0)   edge[4]: (5-1)(0+0) =   0
+    #                                          ---
+    #                                          -44 counter-clockwise
+    def determine_direction(points)
+      sum_over_edges = points.
+        each_cons(2).
+        reduce(0) { |sum, (p1, p2)| sum += ((p2.x - p1.x) * (p2.y + p1.y)) }
+
+      sum_over_edges < 0 ? :count_clockwise : :clockwise
+    end
+
+    def eql?(ring)
+      ring.is_a?(Ring) && ring.points == @points && ring.direction == @direction
+    end
+    alias_method :==, :eql?
+
+  end
+end
+

data/lib/esri_shapefile/reader.rb

@@ -1,3 +1,6 @@
+require 'pathname'
+require 'dbf'
+
 module EsriShapefile
   class Reader
 
@@ -7,15 +10,19 @@ module EsriShapefile
     attr_reader :main_file_header
 
     def initialize(path_to_shapefile)
-      @path_to_shapefile = path_to_shapefile
+      @path_to_shapefile = Pathname.new(path_to_shapefile)
+      @path_to_dbf = @path_to_shapefile.sub_ext(".dbf")
+
       @main_file_header = parse_main_file_header
     end
 
     def each_record
+      dbf = @path_to_dbf.file? ? DBF::Table.new(@path_to_dbf.to_s) : nil
+
       File.open(@path_to_shapefile) do |file|
         file.pos = MAIN_FILE_HEADER_BYTESIZE
 
-        (0..Float::INFINITY).lazy.reduce(file.pos) do |current_offset, number|
+        (0..Float::INFINITY).lazy.reduce(file.pos) do |current_offset, _|
           break if current_offset >= main_file_header.file_length_bytes
 
           record_header_bytes = file.read(RECORD_HEADER_BYTESIZE)
@@ -23,7 +30,9 @@ module EsriShapefile
 
           shape_bytes = file.read(record_header.content_length_bytes)
           shape_class = Shapes.find_by_bytes(shape_bytes)
+
           shape = shape_class.from_bytes(shape_bytes)
+          shape.metadata = get_record_metadata(dbf, record_header.record_number)
 
           yield record_header, shape
 
@@ -34,6 +43,13 @@ module EsriShapefile
 
     private
 
+    # Retrieve the metadata for the shape from the associated .dbf file.
+    # Record numbers are one based, while the dbf file reader is 0 based.
+    # So we subtract one from the record number when performing the lookup.
+    def get_record_metadata(dbf, record_number)
+      dbf.nil? ? {} : dbf.find(record_number - 1).attributes
+    end
+
     def parse_main_file_header
       main_file_header_bytes = File.binread(@path_to_shapefile, 100, 0)
       MainFileHeader.from_bytes(main_file_header_bytes)

data/lib/esri_shapefile/version.rb

@@ -1,3 +1,3 @@
 module EsriShapefile
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/esri_shapefile/model_spec.rb

@@ -5,7 +5,7 @@ describe EsriShapefile::ByteModel do
   describe "declaring fields" do
     let(:example_model) do
       Class.new do
-        extend EsriShapefile::ByteModel
+        include EsriShapefile::ByteModel
         field :foo, position: 0, type: :integer, byte_order: :little
       end
     end

data/spec/esri_shapefile/models/shapes/polygon_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+require 'pry'
+
+module EsriShapefile
+  module Shapes
+    describe Polygon do
+
+      let(:polygon) do
+        polygon = Shapes::Polygon.new
+        polygon.parts = [0,5]
+        polygon.points = [
+          Point.at(x: 200, y: 200),
+          Point.at(x: 250, y: 250),
+          Point.at(x: 300, y: 200),
+          Point.at(x: 250, y: 150),
+          Point.at(x: 200, y: 200),
+
+          Point.at(x: 100, y: 200),
+          Point.at(x: 250, y: 350),
+          Point.at(x: 400, y: 200),
+          Point.at(x: 250, y:  50),
+          Point.at(x: 100, y: 200),
+        ]
+        polygon
+      end
+
+      describe "#rings" do
+        it "foo" do
+          expect(polygon.rings).to eql([
+            Ring.new([
+              Point.at(x: 200, y: 200),
+              Point.at(x: 250, y: 250),
+              Point.at(x: 300, y: 200),
+              Point.at(x: 250, y: 150),
+              Point.at(x: 200, y: 200),
+            ]),
+            Ring.new([
+              Point.at(x: 100, y: 200),
+              Point.at(x: 250, y: 350),
+              Point.at(x: 400, y: 200),
+              Point.at(x: 250, y:  50),
+              Point.at(x: 100, y: 200),
+            ])
+          ])
+        end
+      end
+
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -47,7 +47,7 @@ RSpec.configure do |config|
   # compatibility in RSpec 3). It causes shared context metadata to be
   # inherited by the metadata hash of host groups and examples, rather than
   # triggering implicit auto-inclusion in groups with matching metadata.
-  config.shared_context_metadata_behavior = :apply_to_host_groups
+  # config.shared_context_metadata_behavior = :apply_to_host_groups
 
 # The settings below are suggested to provide a good initial experience
 # with RSpec, but feel free to customize to your heart's content.

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: esri_shapefile
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Joe Karayusuf
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-28 00:00:00.000000000 Z
+date: 2016-12-05 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: dbf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: Library to read and write ESRI Shapefiles
 email:
 - jkarayusuf@gmail.com
@@ -65,6 +93,8 @@ files:
 - lib/esri_shapefile.rb
 - lib/esri_shapefile/byte_model.rb
 - lib/esri_shapefile/byte_model/field.rb
+- lib/esri_shapefile/converter/svg.rb
+- lib/esri_shapefile/converter/svg/polygon.rb
 - lib/esri_shapefile/models/main_file_header.rb
 - lib/esri_shapefile/models/record_header.rb
 - lib/esri_shapefile/models/shapes.rb
@@ -82,6 +112,7 @@ files:
 - lib/esri_shapefile/models/shapes/polygon.rb
 - lib/esri_shapefile/models/shapes/polygon_m.rb
 - lib/esri_shapefile/models/shapes/polygon_z.rb
+- lib/esri_shapefile/models/utils/ring.rb
 - lib/esri_shapefile/reader.rb
 - lib/esri_shapefile/version.rb
 - spec/esri_shapefile/field_spec.rb
@@ -89,6 +120,7 @@ files:
 - spec/esri_shapefile/models/main_file_header_spec.rb
 - spec/esri_shapefile/models/record_header_spec.rb
 - spec/esri_shapefile/models/shapes/point_spec.rb
+- spec/esri_shapefile/models/shapes/polygon_spec.rb
 - spec/spec_helper.rb
 homepage: ''
 licenses:
@@ -110,7 +142,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Library to read and write ESRI Shapefiles
@@ -120,4 +152,5 @@ test_files:
 - spec/esri_shapefile/models/main_file_header_spec.rb
 - spec/esri_shapefile/models/record_header_spec.rb
 - spec/esri_shapefile/models/shapes/point_spec.rb
+- spec/esri_shapefile/models/shapes/polygon_spec.rb
 - spec/spec_helper.rb