ffi-gdal 1.0.0.beta5 → 1.0.0.beta6

data/spec/integration/gdal/color_table_info_spec.rb

@@ -1,60 +1,76 @@
 require 'spec_helper'
-require 'support/integration_help'
 require 'ffi-gdal'
-require 'gdal/dataset'
+require 'gdal'
 
-TIF_FILES.each do |file|
-  dataset =  GDAL::Dataset.open(file, 'r')
+RSpec.describe 'GDAL Color Table access', type: :integration do
+  let(:dataset) { GDAL::Dataset.open(tmp_tiff, 'r') }
+  let(:tmp_tiff) { make_temp_test_file(original_tiff) }
+  after(:each) { dataset.close }
 
-  RSpec.describe 'Color Table Info' do
-    after :all do
-      dataset.close
-    end
+  subject(:color_table) do
+    band = dataset.raster_band(1)
+    band.color_table
+  end
 
-    # TODO: Test against each raster band
-    subject do
-      band = dataset.raster_band(1)
-      band.color_table
+  context 'file with color table' do
+    let(:original_tiff) do
+      path = '../../../spec/support/images/osgeo/geotiff/GeogToWGS84GeoKey/GeogToWGS84GeoKey5.tif'
+      File.expand_path(path, __dir__)
     end
 
     describe '#palette_interpretation' do
-      it 'returns a GDALPaletteInterp' do
-        next if subject.nil?
-
-        expect(subject.palette_interpretation).to eq :GPI_RGB
-      end
+      subject { color_table.palette_interpretation }
+      it { is_expected.to eq :GPI_RGB }
     end
 
     describe '#color_entry_count' do
-      it 'returns a Fixnum (256 with current test files)' do
-        next if subject.nil?
-
-        expect(subject.color_entry_count).to eq 256
-      end
+      subject { color_table.color_entry_count }
+      it { is_expected.to eq 256 }
     end
 
     describe '#color_entry' do
       it 'returns a GDAL::ColorEntry' do
-        next if subject.nil?
-
         expect(subject.color_entry(0)).to be_a GDAL::ColorEntry
       end
 
       it 'has 4 Fixnum values, >= 0' do
-        next if subject.nil?
+        expect(subject.color_entry(0).color1).to eq 0
+        expect(subject.color_entry(0).color2).to eq 0
+        expect(subject.color_entry(0).color3).to eq 0
+        expect(subject.color_entry(0).color4).to eq 255
 
-        expect(subject.color_entry(0).color1).to be_a Fixnum
-        expect(subject.color_entry(0).color1).to be >= 0
+        expect(subject.color_entry(1).color1).to eq 192
+        expect(subject.color_entry(1).color2).to eq 0
+        expect(subject.color_entry(1).color3).to eq 0
+        expect(subject.color_entry(1).color4).to eq 255
+      end
+    end
 
-        expect(subject.color_entry(0).color2).to be_a Fixnum
-        expect(subject.color_entry(0).color2).to be >= 0
+    describe '#color_entry_as_rgb' do
+      it 'returns a GDAL::ColorEntry' do
+        expect(subject.color_entry_as_rgb(0)).to be_a GDAL::ColorEntry
+      end
 
-        expect(subject.color_entry(0).color3).to be_a Fixnum
-        expect(subject.color_entry(0).color3).to be >= 0
+      it 'has 4 Fixnum values, >= 0' do
+        expect(subject.color_entry(0).color1).to eq 0
+        expect(subject.color_entry(0).color2).to eq 0
+        expect(subject.color_entry(0).color3).to eq 0
+        expect(subject.color_entry(0).color4).to eq 255
 
-        expect(subject.color_entry(0).color4).to be_a Fixnum
-        expect(subject.color_entry(0).color4).to be >= 0
+        expect(subject.color_entry(1).color1).to eq 192
+        expect(subject.color_entry(1).color2).to eq 0
+        expect(subject.color_entry(1).color3).to eq 0
+        expect(subject.color_entry(1).color4).to eq 255
       end
     end
   end
+
+  context 'file without color table' do
+    let(:original_tiff) do
+      path = '../../../spec/support/images/osgeo/geotiff/gdal_eg/cea.tif'
+      File.expand_path(path, __dir__)
+    end
+
+    it { is_expected.to be_nil }
+  end
 end

data/spec/integration/gdal/dataset_info_spec.rb

@@ -1,90 +1,339 @@
 require 'spec_helper'
-require 'support/integration_help'
 require 'ffi-gdal'
+require 'gdal'
 
-TIF_FILES.each do |file|
-  RSpec.describe 'Dataset Info' do
-    subject do
-      GDAL::Dataset.open(file, 'r')
+RSpec.describe 'Dataset Info', type: :integration do
+  let(:tmp_tiff) { make_temp_test_file(original_tiff) }
+
+  let(:original_tiff) do
+    path = '../../../spec/support/images/osgeo/geotiff/GeogToWGS84GeoKey/GeogToWGS84GeoKey5.tif'
+    File.expand_path(path, __dir__)
+  end
+
+  subject { GDAL::Dataset.open(tmp_tiff, 'r') }
+
+  after { subject.close if File.exist?(tmp_tiff) }
+
+  describe '#driver' do
+    it 'is a GDAL::Driver' do
+      expect(subject.driver).to be_a GDAL::Driver
+    end
+  end
+
+  describe '#file_list' do
+    it 'is a non-empty Array' do
+      expect(subject.file_list).to be_an Array
     end
 
-    it_behaves_like 'a major object'
+    it 'contains the file name' do
+      expect(subject.file_list).to include(File.expand_path(tmp_tiff))
+    end
+  end
 
-    describe '#driver' do
-      it 'is a GDAL::Driver' do
-        expect(subject.driver).to be_a GDAL::Driver
+  describe '#flush_cache' do
+    it 'is a GDAL::Driver' do
+      expect { subject.flush_cache }.to_not raise_exception
+    end
+  end
+
+  describe '#raster_x_size' do
+    it 'is a Fixnum' do
+      expect(subject.raster_x_size).to eq 101
+    end
+  end
+
+  describe '#raster_y_size' do
+    it 'is a Fixnum' do
+      expect(subject.raster_y_size).to eq 101
+    end
+  end
+
+  describe '#raster_count' do
+    it 'is a Fixnum' do
+      expect(subject.raster_count).to eq 1
+    end
+  end
+
+  describe '#raster_band' do
+    it 'each band is a GDAL::RasterBand' do
+      1.upto(subject.raster_count) do |i|
+        expect(subject.raster_band(i)).to be_a GDAL::RasterBand
       end
     end
+  end
+
+  describe '#projection' do
+    it 'is a String' do
+      expect(subject.projection).to be_a String
+    end
+  end
 
-    describe '#file_list' do
-      it 'is a non-empty Array' do
-        expect(subject.file_list).to be_an Array
+  describe '#projection=' do
+    context 'param is an invalid projection string' do
+      it 'raises a GDAL::Error' do
+        expect { subject.projection = 'meow' }.to raise_exception(GDAL::Error)
       end
+    end
 
-      it 'contains the file name' do
-        expect(subject.file_list).to include(File.expand_path(file))
+    context 'param is an valid projection string' do
+      let(:wkt) do
+        <<-WKT
+GEOGCS["WGS 84",
+  DATUM["WGS_1984",
+    SPHEROID["WGS 84",6378137,298.257223563,
+        AUTHORITY["EPSG",7030]],
+    TOWGS84[0,0,0,0,0,0,0],
+    AUTHORITY["EPSG",6326]],
+  PRIMEM["Greenwich",0,AUTHORITY["EPSG",8901]],
+  UNIT["DMSH",0.0174532925199433,AUTHORITY["EPSG",9108]],
+  AXIS["Lat",NORTH],
+  AXIS["Long",EAST],
+  AUTHORITY["EPSG",4326]]
+        WKT
+      end
+
+      it 'sets the projection' do
+        subject.projection = wkt
+        expect(subject.projection).to eq wkt
+      end
+    end
+
+    context 'param is not a string' do
+      it 'raises a GDAL::Error' do
+        expect { subject.projection = { one: 1 } }.to raise_exception(GDAL::Error)
+      end
+    end
+  end
+
+  describe '#access_flag' do
+    it 'is GA_ReadOnly' do
+      expect(subject.access_flag).to be :GA_ReadOnly
+    end
+  end
+
+  describe '#add_band' do
+    it 'raises a GDAL::UnsupportedOperation' do
+      expect { subject.add_band(:GDT_Byte) }.to raise_exception(GDAL::UnsupportedOperation)
+    end
+  end
+
+  describe '#create_mask_band' do
+    context ':GMF_ALL_VALID' do
+      it 'returns true' do
+        expect(subject.create_mask_band(:GMF_ALL_VALID)).to eq true
       end
     end
 
-    describe '#raster_x_size' do
-      it 'is a Fixnum' do
-        expect(subject.raster_x_size).to be_a Fixnum
+    context ':GMF_PER_DATASET' do
+      it 'returns true' do
+        expect(subject.create_mask_band(:GMF_PER_DATASET)).to eq true
       end
     end
 
-    describe '#raster_y_size' do
-      it 'is a Fixnum' do
-        expect(subject.raster_y_size).to be_a Fixnum
+    context ':GMF_PER_ALPHA' do
+      it 'returns true' do
+        expect(subject.create_mask_band(:GMF_PER_ALPHA)).to eq true
       end
     end
 
-    describe '#raster_count' do
-      it 'is a Fixnum' do
-        expect(subject.raster_count).to be_a Fixnum
+    context ':GMF_NODATA' do
+      it 'returns true' do
+        expect(subject.create_mask_band(:GMF_NODATA)).to eq true
       end
     end
 
-    describe '#raster_band' do
-      it 'each band is a GDAL::RasterBand' do
-        1.upto(subject.raster_count) do |i|
-          expect(subject.raster_band(i)).to be_a GDAL::RasterBand
-        end
+    context 'all flags' do
+      it 'returns true' do
+        expect(subject.create_mask_band(:GMF_ALL_VALID, :GMF_PER_DATASET, :GMF_PER_ALPHA, :GMF_NODATA)).to eq true
       end
     end
+  end
+
+  describe '#geo_transform' do
+    it 'is a GDAL::GeoTransform' do
+      expect(subject.geo_transform).to be_a GDAL::GeoTransform
+    end
+  end
+
+  describe '#geo_transform=' do
+    let(:geo_transform) { GDAL::GeoTransform.new }
 
-    describe '#projection' do
-      it 'is a String' do
-        expect(subject.projection).to be_a String
+    context 'read-only dataset' do
+      it 'raises a GDAL::UnsupportedOperation' do
+        expect { subject.geo_transform = geo_transform }.to raise_exception GDAL::UnsupportedOperation
       end
     end
 
-    describe '#access_flag' do
-      it 'is GA_ReadOnly' do
-        expect(subject.access_flag).to be :GA_ReadOnly
+    context 'writable dataset, param is a valid GeoTransform' do
+      subject { GDAL::Dataset.open(tmp_tiff, 'w') }
+
+      it 'returns the same GDAL::GeoTransform' do
+        subject.geo_transform = geo_transform
+        expect(subject.geo_transform).to eq geo_transform
       end
     end
 
-    describe '#geo_transform' do
-      it 'is a GDAL::GeoTransform' do
+    context 'writable dataset, param is a pointer to a valid GeoTransform' do
+      subject { GDAL::Dataset.open(tmp_tiff, 'w') }
+
+      it 'returns the same GDAL::GeoTransform' do
+        subject.geo_transform = geo_transform.c_pointer
         expect(subject.geo_transform).to be_a GDAL::GeoTransform
       end
     end
+  end
+
+  describe '#gcp_count' do
+    it 'is a Fixnum' do
+      expect(subject.gcp_count).to be_a Fixnum
+    end
+  end
+
+  describe '#gcp_projection' do
+    it 'is a String' do
+      expect(subject.gcp_projection).to be_a String
+    end
+  end
+
+  describe '#gcps' do
+    it 'is a GDALGCP' do
+      expect(subject.gcps).to be_a FFI::GDAL::GCP
+    end
+  end
+
+  describe '#build_overviews' do
+    let(:ovr_file) { "#{tmp_tiff}.ovr" }
+    after { File.unlink(ovr_file) if File.exist?(ovr_file) }
+
+    context 'nearest neighbor resampling' do
+      it 'creates an .ovr file with the same base name as the dataset file' do
+        subject.build_overviews(:nearest, [2, 4, 8])
+        expect(File.exist?(ovr_file)).to eq true
+      end
+    end
 
-    describe '#gcp_count' do
-      it 'is a Fixnum' do
-        expect(subject.gcp_count).to be_a Fixnum
+    context 'Gauss resampling' do
+      it 'creates an .ovr file with the same base name as the dataset file' do
+        subject.build_overviews(:gauss, [2, 4, 8])
+        expect(File.exist?(ovr_file)).to eq true
       end
     end
 
-    describe '#gcp_projection' do
-      it 'is a String' do
-        expect(subject.gcp_projection).to be_a String
+    context 'Cubic resampling' do
+      it 'creates an .ovr file with the same base name as the dataset file' do
+        subject.build_overviews(:cubic, [2, 4, 8])
+        expect(File.exist?(ovr_file)).to eq true
+      end
+    end
+
+    context 'Average resampling' do
+      it 'creates an .ovr file with the same base name as the dataset file' do
+        subject.build_overviews(:average, [2, 4, 8])
+        expect(File.exist?(ovr_file)).to eq true
+      end
+    end
+
+    context 'Mode resampling' do
+      it 'creates an .ovr file with the same base name as the dataset file' do
+        subject.build_overviews(:mode, [2, 4, 8])
+        expect(File.exist?(ovr_file)).to eq true
+      end
+    end
+
+    context 'Average mag phase resampling' do
+      it 'creates an .ovr file with the same base name as the dataset file' do
+        subject.build_overviews(:average_magphase, [2, 4, 8])
+        expect(File.exist?(ovr_file)).to eq true
+      end
+    end
+
+    context 'no resampling' do
+      it 'creates an .ovr file with the same base name as the dataset file' do
+        subject.build_overviews(:none, [2, 4, 8])
+        expect(File.exist?(ovr_file)).to eq true
+      end
+    end
+
+    context 'unknown resampling algorithm' do
+      it 'creates an .ovr file with the same base name as the dataset file' do
+        expect { subject.build_overviews(:stuff, [2, 4, 8]) }.
+          to raise_exception(GDAL::Error)
+      end
+    end
+  end
+
+  describe '#raster_io' do
+    let(:write_buffer) do
+      buffer = GDAL._buffer_from_data_type(:GDT_Byte, 2)
+      buffer.write_array_of_uchar([1, 2])
+    end
+
+    let(:read_buffer) { GDAL._buffer_from_data_type(:GDT_Byte, 2) }
+
+    context 'write to read-only dataset' do
+      it 'raises a GDAL::Error when flushing the cache' do
+        expect do
+          subject.raster_io('w', write_buffer, x_size: 2, y_size: 1)
+          subject.flush_cache
+        end.to raise_exception(GDAL::Error)
+      end
+    end
+
+    context 'write using buffer that is too small for defaults' do
+      subject { GDAL::Dataset.open(tmp_tiff, 'w') }
+
+      it 'raises a GDAL::Error when flushing the cache' do
+        expect do
+          subject.raster_io('w', write_buffer)
+          subject.flush_cache
+        end.to raise_exception(GDAL::BufferTooSmall)
+      end
+    end
+
+    context 'write to writable dataset' do
+      subject { GDAL::Dataset.open(tmp_tiff, 'w') }
+
+      it 'writes the data' do
+        expect do
+          subject.raster_io('w', write_buffer, x_size: 2, y_size: 1)
+          subject.flush_cache
+        end.to_not raise_exception
+      end
+    end
+
+    context 'read, buffer size too small' do
+      it 'raises a GDAL::BufferTooSmall' do
+        expect { subject.raster_io('r', read_buffer) }.
+          to raise_exception GDAL::BufferTooSmall
+      end
+    end
+
+    context 'read, giving params that fulfil buffer size requirements' do
+      it 'reads the data' do
+        subject.raster_io('r', read_buffer, x_size: 2, y_size: 1)
+        expect(read_buffer.read_array_of_uchar(2)).to eq [2, 2]
+      end
+    end
+  end
+
+  describe '#valid_min_buffer_size' do
+    it 'returns the number of bytes for the GDT type * x buffer size * y buffer size' do
+      expect(subject.send(:valid_min_buffer_size, :GDT_Float32, 3, 4)).to eq 48
+    end
+  end
+
+  describe '#band_numbers_args' do
+    context 'param is nil' do
+      it 'returns no pointer and 0 band count' do
+        expect(subject.send(:band_numbers_args, nil)).to eq [nil, 0]
       end
     end
 
-    describe '#gcps' do
-      it 'is a GDALGCP' do
-        expect(subject.gcps).to be_a FFI::GDAL::GCP
+    context 'param is an array of numbers' do
+      it 'returns a pointer and the number of bands' do
+        result_ptr, band_count = subject.send(:band_numbers_args, [3, 4, 5])
+        expect(result_ptr).to be_a FFI::MemoryPointer
+        expect(band_count).to eq 3
       end
     end
   end