ffi-gdal 1.0.0.beta3 → 1.0.0.beta4

data/spec/unit/ogr/feature_definition_spec.rb

@@ -0,0 +1,313 @@
+require 'spec_helper'
+require 'ogr/feature_definition'
+
+RSpec.describe OGR::FeatureDefinition do
+  subject(:feature_definition) do
+    fd = described_class.new('spec feature definition')
+    fd.geometry_type = :wkbMultiPolygon
+    fd
+  end
+
+  let(:field) { OGR::FieldDefinition.new('test field', :OFTString) }
+
+  describe '#name' do
+    it 'returns the name given to it' do
+      expect(subject.name).to eq 'spec feature definition'
+    end
+  end
+
+  describe '#field_count' do
+    context 'no fields' do
+      subject { feature_definition.field_count }
+      it { is_expected.to be_zero }
+    end
+
+    context 'with fields' do
+      before { feature_definition.add_field_definition(field) }
+
+      it 'returns the number of fields that have been added' do
+        expect(subject.field_count).to eq 1
+      end
+    end
+  end
+
+  describe '#field_definition' do
+    context 'field definition at the given index does not exist' do
+      it 'raises a RuntimeError' do
+        expect { subject.field_definition(0) }.to raise_exception RuntimeError
+      end
+    end
+
+    context 'field definition at the given index exists' do
+      before { subject.add_field_definition(field) }
+
+      it 'returns the Field' do
+        expect(subject.field_definition(0)).to be_a OGR::FieldDefinition
+      end
+    end
+  end
+
+  describe '#add_field_definition + #field_definition' do
+    context 'param is not a FieldDefinition' do
+      it 'raises' do
+        expect do
+          subject.add_field_definition('not a pointer')
+        end.to raise_exception OGR::InvalidFieldDefinition
+      end
+    end
+
+    context 'param is a FieldDefinition' do
+      let(:field) { OGR::FieldDefinition.new('test field', :OFTString) }
+
+      it 'adds the field' do
+        subject.add_field_definition(field)
+        expect(subject.field_definition(0)).to be_a OGR::FieldDefinition
+      end
+    end
+  end
+
+  describe '#delete_field_definition' do
+    context 'no fields' do
+      it 'raises an OGR::Failure' do
+        expect do
+          subject.delete_field_definition(0)
+        end.to raise_exception OGR::Failure
+      end
+    end
+
+    context 'valid field' do
+      before { subject.add_field_definition(field) }
+
+      it 'deletes the field' do
+        subject.delete_field_definition(0)
+
+        expect do
+          subject.delete_field_definition(0)
+        end.to raise_exception OGR::Failure
+      end
+    end
+  end
+
+  describe '#field_index' do
+    context 'field with requested name does not exist' do
+      it 'returns nil' do
+        expect(subject.field_index('things')).to be_nil
+      end
+    end
+
+    context 'field with requested name exists' do
+      let(:field) { OGR::FieldDefinition.new('test field', :OFTString) }
+      before { subject.add_field_definition(field) }
+
+      it "returns the FieldDefinition's index" do
+        expect(subject.field_index('test field')).to be_zero
+      end
+    end
+  end
+
+  describe '#geometry_type' do
+    context 'default' do
+      subject(:feature_definition) do
+        described_class.new('spec feature definition')
+      end
+
+      it 'is :wkbUnknown' do
+        expect(subject.geometry_type).to eq :wkbUnknown
+      end
+    end
+  end
+
+  describe '#geometry_type= + #geometry_type' do
+    context 'valid geometry type' do
+      it 'assigns the new geometry type' do
+        subject.geometry_type = :wkbPoint
+        expect(subject.geometry_type).to eq :wkbPoint
+      end
+    end
+
+    context 'invalid geometry type' do
+      it 'raises an ArgumenError' do
+        expect { subject.geometry_type = :bubbles }.
+          to raise_exception ArgumentError
+      end
+    end
+  end
+
+  describe '#geometry_ignored?' do
+    context 'default' do
+      subject { feature_definition.geometry_ignored? }
+      it { is_expected.to eq false }
+    end
+  end
+
+  describe '#ignore_geometry! + #geometry_ignored?' do
+    context 'set to ignore' do
+      it 'causes the geometry to be ignored' do
+        subject.ignore_geometry!
+        expect(subject.geometry_ignored?).to eq true
+      end
+    end
+
+    context 'set to not ignore' do
+      it 'causes the geometry to be ignored' do
+        subject.ignore_geometry! false
+        expect(subject.geometry_ignored?).to eq false
+      end
+    end
+  end
+
+  describe '#style_ignored?' do
+    context 'default' do
+      subject { feature_definition.style_ignored? }
+      it { is_expected.to eq false }
+    end
+  end
+
+  describe '#ignore_style! + #style_ignored?' do
+    context 'set to ignore' do
+      it 'causes the style to be ignored' do
+        subject.ignore_style!
+        expect(subject.style_ignored?).to eq true
+      end
+    end
+
+    context 'set to not ignore' do
+      it 'causes the style to be ignored' do
+        subject.ignore_style! false
+        expect(subject.style_ignored?).to eq false
+      end
+    end
+  end
+
+  describe '#geometry_field_count' do
+    context 'default' do
+      subject { feature_definition.geometry_field_count }
+      it { is_expected.to eq 1 }
+    end
+  end
+
+  describe '#geometry_field_definition' do
+    context 'default, at 0' do
+      it 'returns an OGR::GeometryFieldDefinition' do
+        expect(subject.geometry_field_definition(0)).
+          to be_a OGR::GeometryFieldDefinition
+      end
+
+      it 'has a type that is the same as the feature' do
+        gfd = subject.geometry_field_definition(0)
+        expect(subject.geometry_type).to eq gfd.type
+      end
+    end
+  end
+
+  describe '#add_geometry_field_definition + #geometry_field_definition' do
+    let(:geometry_field_definition) do
+      OGR::GeometryFieldDefinition.new('test1', :wkbPolygon)
+    end
+
+    it 'adds the geometry_field_definition' do
+      expect do
+        subject.add_geometry_field_definition geometry_field_definition
+      end.to change { subject.geometry_field_count }.by 1
+    end
+  end
+
+  describe '#delete_geometry_field_definition' do
+    context 'no geometry field definition at given index' do
+      it 'raises an OGR::Failure' do
+        expect do
+          subject.delete_geometry_field_definition(123)
+        end.to raise_exception OGR::Failure
+      end
+    end
+
+    context 'geometry field definition exists at given index' do
+      let(:geometry_field_definition) do
+        OGR::GeometryFieldDefinition.new('test1', :wkbPolygon)
+      end
+
+      before { subject.add_geometry_field_definition(geometry_field_definition) }
+
+      it 'deletes the gfld' do
+        expect do
+          subject.delete_geometry_field_definition(1)
+        end.to change { subject.geometry_field_count }.by(-1)
+      end
+    end
+  end
+
+  describe '#field_definitions' do
+    it 'returns an array of size field_count' do
+      expect(subject.field_definitions).to be_an Array
+      expect(subject.field_definitions.size).to eq subject.field_count
+    end
+  end
+
+  describe '#field_definition_by_name' do
+    context 'field with name does not exist' do
+      it 'returns nil' do
+        expect(subject.field_definition_by_name('asdfasdfasdf')).to be_nil
+      end
+    end
+  end
+
+  describe '#geometry_field_definition_by_name' do
+    context 'field with name does not exist' do
+      it 'returns nil' do
+        subject.geometry_field_definition(0).name
+        expect(subject.geometry_field_definition_by_name('asdfasdf')).to be_nil
+      end
+    end
+
+    context 'field with name exists' do
+      it 'returns the OGR::GeometryFieldDefinition' do
+        name = subject.geometry_field_definition(0).name
+        expect(subject.geometry_field_definition_by_name(name)).
+          to be_a OGR::GeometryFieldDefinition
+      end
+    end
+  end
+
+  describe '#same?' do
+    context 'is the same as the other' do
+      let(:other_feature_definition) do
+        df = described_class.new('spec feature definition')
+        df.geometry_type = :wkbMultiPolygon
+        df
+      end
+
+      it 'returns true' do
+        expect(subject.same?(other_feature_definition)).to eq true
+      end
+    end
+
+    context 'not the same as the other' do
+      let(:other_feature_definition) do
+        described_class.new('other feature definition')
+      end
+
+      it 'returns false' do
+        expect(subject.same?(other_feature_definition)).to eq false
+      end
+    end
+  end
+
+  describe '#as_json' do
+    it 'returns a Hash of all attributes and values' do
+      expect(subject.as_json).to eq(field_count: 0,
+                                    field_definitions: [],
+                                    geometry_field_count: 1,
+                                    geometry_type: :wkbMultiPolygon,
+                                    is_geometry_ignored: false,
+                                    is_style_ignored: false,
+                                    name: 'spec feature definition')
+    end
+  end
+
+  describe '#to_json' do
+    it 'is a String' do
+      expect(subject.to_json).to be_a String
+      expect(subject.to_json).to_not be_empty
+    end
+  end
+end

data/spec/unit/ogr/feature_spec.rb

@@ -0,0 +1,379 @@
+require 'spec_helper'
+require 'date'
+require 'ogr/feature'
+
+RSpec.describe OGR::Feature do
+  let(:integer_field) { OGR::FieldDefinition.new('test integer field', :OFTInteger) }
+  let(:integer_list_field) { OGR::FieldDefinition.new('test integer list field', :OFTIntegerList) }
+  let(:real_field) { OGR::FieldDefinition.new('test real field', :OFTReal) }
+  let(:real_list_field) { OGR::FieldDefinition.new('test real list field', :OFTRealList) }
+  let(:string_field) { OGR::FieldDefinition.new('test string field', :OFTString) }
+  let(:string_list_field) { OGR::FieldDefinition.new('test string list field', :OFTStringList) }
+  let(:binary_field) { OGR::FieldDefinition.new('test binary field', :OFTBinary) }
+  let(:date_field) { OGR::FieldDefinition.new('test date field', :OFTDate) }
+
+  let(:geometry_field_definition) do
+    OGR::GeometryFieldDefinition.new('test geometry', :wkbPoint)
+  end
+
+  let(:feature_definition) do
+    fd = OGR::FeatureDefinition.new('test FD')
+
+    fd.add_field_definition(integer_field)        # 0
+    fd.add_field_definition(integer_list_field)   # 1
+    fd.add_field_definition(real_field)           # 2
+    fd.add_field_definition(real_list_field)      # 3
+    fd.add_field_definition(string_field)         # 4
+    fd.add_field_definition(string_list_field)    # 5
+    fd.add_field_definition(binary_field)         # 6
+    fd.add_field_definition(date_field)           # 7
+
+    fd.add_geometry_field_definition(geometry_field_definition)
+
+    fd
+  end
+
+  let(:empty_feature_definition) do
+    OGR::FeatureDefinition.new('empty test FD')
+  end
+
+  describe '.new' do
+    context 'param is not a FeatureDefinition or pointer to a FeatureDefinition' do
+      it 'raises an OGR::InvalidFeature' do
+        expect do
+          described_class.new('not a pointer')
+        end.to raise_exception OGR::InvalidFeature
+      end
+    end
+  end
+
+  subject(:feature) { described_class.new(feature_definition) }
+
+  describe '#clone' do
+    it 'returns a new Feature' do
+      expect(subject.clone).to be_a OGR::Feature
+    end
+  end
+
+  describe '#field_count' do
+    context 'no fields' do
+      subject { empty_feature_definition.field_count }
+      it { is_expected.to be_zero }
+    end
+
+    context 'with fields' do
+      it 'returns the number of fields that have been added' do
+        expect(subject.field_count).to eq 8
+      end
+    end
+  end
+
+  describe '#set_field_integer + #field_as_integer' do
+    context 'to a valid index' do
+      it 'adds the field' do
+        subject.set_field_integer(0, 123)
+        expect(subject.field_as_integer(0)).to eq 123
+      end
+    end
+
+    context 'to an invalid valid index' do
+      it 'adds the field' do
+        expect do
+          subject.set_field_integer(100, 123)
+        end.to raise_exception GDAL::Error
+      end
+    end
+
+    context 'value is not an integer' do
+      it 'raises a TypeError' do
+        expect do
+          subject.set_field_integer(0, 'meow')
+        end.to raise_exception TypeError
+      end
+    end
+  end
+
+  describe '#set_field_integer_list + #field_as_integer_list' do
+    context 'to a valid index' do
+      it 'adds the integer list' do
+        subject.set_field_integer_list(1, [1, 2, 3])
+        expect(subject.field_as_integer_list(1)).to eq [1, 2, 3]
+      end
+    end
+
+    context 'to an invalid valid index' do
+      it 'adds the field' do
+        expect do
+          subject.set_field_integer_list(100, [1, 2, 3])
+        end.to raise_exception GDAL::Error
+      end
+    end
+
+    context 'value is not an array of integers' do
+      it 'raises a TypeError' do
+        expect do
+          subject.set_field_integer_list(1, ['meow'])
+        end.to raise_exception TypeError
+      end
+    end
+  end
+
+  describe '#set_field_double + #field_as_double' do
+    context 'to a valid index' do
+      it 'adds the field' do
+        subject.set_field_double(2, 123.123)
+        expect(subject.field_as_double(2)).to eq 123.123
+      end
+    end
+
+    context 'to an invalid valid index' do
+      it 'adds the field' do
+        expect do
+          subject.set_field_double(100, 123.123)
+        end.to raise_exception GDAL::Error
+      end
+    end
+
+    context 'value is not a float' do
+      it 'raises a TypeError' do
+        expect do
+          subject.set_field_double(2, 'meow')
+        end.to raise_exception TypeError
+      end
+    end
+  end
+
+  describe '#set_field_double_list + #field_as_double_list' do
+    context 'to a valid index' do
+      it 'adds the double list' do
+        subject.set_field_double_list(3, [1.1, 2.1, 3.1])
+        expect(subject.field_as_double_list(3)).to eq [1.1, 2.1, 3.1]
+      end
+    end
+
+    context 'to an invalid valid index' do
+      it 'adds the field' do
+        expect do
+          subject.set_field_double_list(100, [1.1, 2.1, 3.1])
+        end.to raise_exception GDAL::Error
+      end
+    end
+
+    context 'value is not an array of doubles' do
+      it 'raises a TypeError' do
+        expect do
+          subject.set_field_double_list(3, ['meow'])
+        end.to raise_exception TypeError
+      end
+    end
+  end
+
+  describe '#set_field_string + #field_as_string' do
+    context 'to a valid index' do
+      it 'adds the field' do
+        subject.set_field_string(4, 'test string')
+        expect(subject.field_as_string(4)).to eq 'test string'
+      end
+    end
+
+    context 'to an invalid valid index' do
+      it 'raises a GDAL::Error' do
+        expect do
+          subject.set_field_string(100, 'test string')
+        end.to raise_exception GDAL::Error
+      end
+    end
+
+    context 'value is not a string' do
+      it 'raises a TypeError' do
+        expect do
+          subject.set_field_string(4, 123)
+        end.to raise_exception TypeError
+      end
+    end
+  end
+
+  describe '#set_field_string_list' do
+    context 'to a valid index' do
+      it 'adds the string list' do
+        subject.set_field_string_list(5, %w[one two three])
+        expect(subject.field_as_string_list(5)).to eq %w[one two three]
+      end
+    end
+
+    context 'to an invalid valid index' do
+      it 'raises a GDAL::Error' do
+        expect do
+          subject.set_field_string_list(100, [1, 2, 3])
+        end.to raise_exception GDAL::Error, 'Invalid index : 100'
+      end
+    end
+
+    context 'value is not an array of strings' do
+      it 'returns an empty Array' do
+        subject.set_field_integer_list(5, [1, 2, 3])
+        expect(subject.field_as_string_list(5)).to eq []
+      end
+    end
+  end
+
+  describe '#set_field_raw + #field_as_raw' do
+    let(:integer_field_struct) do
+      f = FFI::OGR::Field.new
+      f[:integer] = 1
+      f
+    end
+
+    let(:integer_list_field_struct) do
+      f = FFI::OGR::Field.new
+      f[:integer_list] = [1, 2, 3]
+      f
+    end
+
+    context 'to a valid index' do
+      it 'adds the field' do
+        subject.set_field_raw(0, integer_field_struct)
+        expect(subject.field_as_integer(0)).to eq 1
+      end
+    end
+
+    context 'to an invalid valid index' do
+      it 'adds the field' do
+        expect do
+          subject.set_field_raw(100, integer_field_struct)
+        end.to raise_exception GDAL::Error
+      end
+    end
+
+    context 'raw field is not of the given type' do
+      let(:int_feature_definition) do
+        fd = OGR::FeatureDefinition.new('test FD')
+        fd.add_field_definition(integer_field)        # 0
+
+        fd
+      end
+
+      subject { described_class.new(int_feature_definition) }
+
+      it 'raises a TypeError' do
+        expect do
+          subject.set_field_raw(0, integer_list_field_struct)
+        end.to raise_exception TypeError
+      end
+    end
+  end
+
+  describe '#set_field_binary + #field_as_binary' do
+    context 'to a valid index' do
+      it 'adds the field' do
+        subject.set_field_binary(6, [65, 66, 67, 68, 69].pack('C*'))
+        expect(subject.field_as_binary(6)).to eq [65, 66, 67, 68, 69]
+      end
+    end
+
+    context 'to an invalid valid index' do
+      it 'adds the field' do
+        expect do
+          subject.set_field_binary(100, 123)
+        end.to raise_exception TypeError
+      end
+    end
+
+    context 'value is not binary' do
+      it 'raises a TypeError' do
+        expect do
+          subject.set_field_binary(6, 123)
+        end.to raise_exception TypeError
+      end
+    end
+  end
+
+  describe '#set_field_date_time + #field_as_date_time' do
+    let(:date_time) do
+      DateTime.now
+    end
+
+    context 'to a valid index' do
+      it 'adds the field' do
+        subject.set_field_date_time(7, date_time)
+        expect(subject.field_as_date_time(7).httpdate).to eq date_time.httpdate
+      end
+    end
+
+    context 'to an invalid valid index' do
+      it 'adds the field' do
+        expect do
+          subject.set_field_binary(100, 123)
+        end.to raise_exception TypeError
+      end
+    end
+
+    context 'value is not binary' do
+      it 'raises a TypeError' do
+        expect do
+          subject.set_field_binary(6, 123)
+        end.to raise_exception TypeError
+      end
+    end
+  end
+  describe '#field_definition' do
+    context 'field exists at the given index' do
+      it 'returns the FieldDefinition' do
+        expect(subject.field_definition(0)).to be_a OGR::FieldDefinition
+      end
+    end
+
+    context 'field does not exist at the given index' do
+      it 'raises a GDAL::Error' do
+        expect { subject.field_definition(123) }.to raise_exception GDAL::Error
+      end
+    end
+  end
+
+  describe 'field_index' do
+    context 'field exists with the given name' do
+      it "returns the FieldDefinition's index" do
+        expect(subject.field_index('test binary field')).to eq 6
+      end
+    end
+
+    context 'field does not exist with the given name' do
+      it 'returns nil' do
+        expect(subject.field_index('asdfadsasd')).to be_nil
+      end
+    end
+  end
+
+  describe '#field_set?' do
+    context 'field at the given index is not set' do
+      it 'returns false' do
+        expect(subject.field_set?(0)).to eq false
+      end
+    end
+
+    context 'field at the given index is set' do
+      before do
+        subject.set_field_string(0, 'Pants')
+      end
+
+      it 'returns true' do
+        expect(subject.field_set?(0)).to eq true
+      end
+    end
+  end
+
+  describe '#unset_field + #field_set?' do
+    context 'field is set' do
+      it 'removes the field' do
+        subject.unset_field(0)
+        expect(subject.field_set?(0)).to eq false
+      end
+    end
+
+    context 'field is not set' do
+      it 'raises a GDAL::Error' do
+        expect { subject.unset_field(100) }.to raise_exception GDAL::Error
+      end
+    end
+  end
+end