ffi-gdal 1.0.0.beta3 → 1.0.0.beta4

data/lib/gdal/raster_attribute_table.rb

@@ -1,17 +1,9 @@
 require_relative '../ffi/gdal'
-require_relative 'raster_attribute_table_extensions'
-
+require_relative 'raster_attribute_table_mixins/extensions'
 
 module GDAL
   class RasterAttributeTable
-    include RasterAttributeTableExtensions
-
-    # @return [GDAL::RasterAttributeTable]
-    def self.create
-      raster_attribute_table_ptr = FFI::GDAL.GDALCreateRasterAttributeTable
-
-      new(raster_attribute_table_ptr)
-    end
+    include RasterAttributeTableMixins::Extensions
 
     # Create an object from a ColorTable.
     #
@@ -20,30 +12,31 @@ module GDAL
     def self.from_color_table(color_table)
       color_table_ptr = GDAL._pointer(GDAL::ColorTable, color_table)
       rat_ptr = FFI::GDAL.GDALCreateRasterAttributeTable
-      cpl_err = FFI::GDAL.GDALRATInitializeFromColorTable(rat_ptr, color_table_ptr)
-      cpl_err.to_bool
+      FFI::GDAL.GDALRATInitializeFromColorTable(rat_ptr, color_table_ptr)
 
       new(rat_ptr)
     end
 
-    # @param raster_attribute_table [GDAL::RasterAttributeTable, FFI::Pointer]
-    def initialize(raster_attribute_table=nil)
-      @rat_pointer = GDAL._pointer(GDAL::RasterAttributeTable, raster_attribute_table)
+    # @return [FFI::Pointer] The C pointer that represents the C RAT.
+    attr_reader :c_pointer
+
+    # @param pointer [FFI::Pointer]
+    def initialize(pointer = nil)
+      @c_pointer = pointer || FFI::GDAL.GDALCreateRasterAttributeTable
     end
 
     def destroy!
-      FFI::GDAL.GDALDestroyRasterAttributeTable(@rat_pointer)
-    end
+      return unless @c_pointer
 
-    def c_pointer
-      @rat_pointer
+      FFI::GDAL.GDALDestroyRasterAttributeTable(@c_pointer)
+      @c_pointer = nil
     end
 
     # Clone using the C API.
     #
     # @return [GDAL::RasterAttributeTable]
     def clone
-      rat_ptr = FFI::GDAL.GDALRATClone(@rat_pointer)
+      rat_ptr = FFI::GDAL.GDALRATClone(@c_pointer)
       return nil if rat_ptr.null?
 
       self.class.new(rat_ptr)
@@ -54,36 +47,36 @@ module GDAL
     #
     # @return [Boolean]
     def changes_written_to_file?
-      FFI::GDAL.GDALRATChangesAreWrittenToFile(@rat_pointer)
+      FFI::GDAL.GDALRATChangesAreWrittenToFile(@c_pointer)
     end
 
     # @return [Fixnum]
     def column_count
-      FFI::GDAL.GDALRATGetColumnCount(@rat_pointer)
+      FFI::GDAL.GDALRATGetColumnCount(@c_pointer)
     end
 
     # @param index [Fixnum] The column number.
     # @return [String]
     def column_name(index)
-      FFI::GDAL.GDALRATGetNameOfCol(@rat_pointer, index)
+      FFI::GDAL.GDALRATGetNameOfCol(@c_pointer, index)
     end
 
     # @param index [Fixnum] The column number.
     # @return [GDALRATFieldUsage]
     def column_usage(index)
-      FFI::GDAL.GDALRATGetUsageOfCol(@rat_pointer, index)
+      FFI::GDAL.GDALRATGetUsageOfCol(@c_pointer, index)
     end
 
     # @param index [Fixnum] The column number.
     # @return [GDALRATFieldType]
     def column_type(index)
-      FFI::GDAL.GDALRATGetTypeOfCol(@rat_pointer, index)
+      FFI::GDAL.GDALRATGetTypeOfCol(@c_pointer, index)
     end
 
     # @param field_usage [GDALRATFieldUsage]
     # @return [Fixnum] The column number.
     def column_of_usage(field_usage)
-      FFI::GDAL.GDALRATGetColOfUsage(@rat_pointer, field_usage)
+      FFI::GDAL.GDALRATGetColOfUsage(@c_pointer, field_usage)
     end
 
     # @param name [String]
@@ -91,19 +84,17 @@ module GDAL
     # @param usage [FFI::GDALRATFieldUsage]
     # @return [Boolean]
     def create_column(name, type, usage)
-      cpl_err = FFI::GDAL.GDALRATCreateColumn(@rat_pointer, name, type, usage)
-
-      cpl_err.to_bool
+      !!FFI::GDAL.GDALRATCreateColumn(@c_pointer, name, type, usage)
     end
 
     # @return [Fixnum] The number of rows.
     def row_count
-      FFI::GDAL.GDALRATGetRowCount(@rat_pointer)
+      FFI::GDAL.GDALRATGetRowCount(@c_pointer)
     end
 
     # @return [Fixnum] The number of rows.
     def row_count=(count)
-      FFI::GDAL.GDALRATSetRowCount(@rat_pointer, count)
+      FFI::GDAL.GDALRATSetRowCount(@c_pointer, count)
     end
 
     # Get the row for a pixel value.
@@ -111,28 +102,28 @@ module GDAL
     # @param value [Float]
     # @return [Fixnum]
     def row_of_value(value)
-      FFI::GDAL.GDALRATGetRowOfValue(@rat_pointer, value)
+      FFI::GDAL.GDALRATGetRowOfValue(@c_pointer, value)
     end
 
     # @param row [Fixnum]
     # @param field [Fixnum]
     # @return [String]
     def value_to_s(row, field)
-      FFI::GDAL.GDALRATGetValueAsString(@rat_pointer, row, field)
+      FFI::GDAL.GDALRATGetValueAsString(@c_pointer, row, field)
     end
 
     # @param row [Fixnum]
     # @param field [Fixnum]
     # @return [Fixnum]
     def value_to_i(row, field)
-      FFI::GDAL.GDALRATGetValueAsInt(@rat_pointer, row, field)
+      FFI::GDAL.GDALRATGetValueAsInt(@c_pointer, row, field)
     end
 
     # @param row [Fixnum]
     # @param field [Fixnum]
     # @return [Float]
     def value_to_f(row, field)
-      FFI::GDAL.GDALRATGetValueAsDouble(@rat_pointer, row, field)
+      FFI::GDAL.GDALRATGetValueAsDouble(@c_pointer, row, field)
     end
 
     # @param row [Fixnum]
@@ -141,13 +132,13 @@ module GDAL
     def add_value(row, field, value)
       case value.class.name
       when 'String'
-        FFI::GDAL.GDALRATSetValueAsString(@rat_pointer, row, field, value)
+        FFI::GDAL.GDALRATSetValueAsString(@c_pointer, row, field, value)
       when 'Float'
-        FFI::GDAL.GDALRATSetValueAsDouble(@rat_pointer, row, field, value)
+        FFI::GDAL.GDALRATSetValueAsDouble(@c_pointer, row, field, value)
       when 'Fixnum'
-        FFI::GDAL.GDALRATSetValueAsInt(@rat_pointer, row, field, value)
+        FFI::GDAL.GDALRATSetValueAsInt(@c_pointer, row, field, value)
       else
-        raise "Unknown value type for value '#{value}'"
+        fail "Unknown value type for value '#{value}'"
       end
     end
 
@@ -155,7 +146,7 @@ module GDAL
     def linear_binning
       row_0_min_ptr = FFI::MemoryPointer.new(:double)
       bin_size_ptr = FFI::MemoryPointer.new(:double)
-      FFI::GDAL.GDALRATGetLinearBinning(@rat_pointer, row_0_min_ptr, bin_size_ptr)
+      FFI::GDAL.GDALRATGetLinearBinning(@c_pointer, row_0_min_ptr, bin_size_ptr)
 
       {
         row_0_minimum: row_0_min_ptr.read_double,
@@ -167,19 +158,19 @@ module GDAL
     #   will try to auto-determine the number.
     # @return [GDAL::ColorTable]
     def to_color_table(entry_count = -1)
-      color_table_pointer = FFI::GDAL.GDALRATTranslateToColorTable(@rat_pointer, entry_count)
+      color_table_pointer = FFI::GDAL.GDALRATTranslateToColorTable(@c_pointer, entry_count)
 
       GDAL::ColorTable.new(color_table_pointer)
     end
 
     # @param file_path [String]
-    def dump_readable(file_path=nil)
+    def dump_readable(file_path = nil)
       file = if file_path
-        File.open(file_path, 'r')
-      else
-        file_path
-      end
-      FFI::GDAL.GDALRATDumpReadable(@rat_pointer, file)
+               File.open(file_path, 'r')
+             else
+               file_path
+             end
+      FFI::GDAL.GDALRATDumpReadable(@c_pointer, file)
     end
   end
 end

data/lib/gdal/raster_attribute_table_mixins/extensions.rb

@@ -0,0 +1,41 @@
+require 'json'
+
+module GDAL
+  module RasterAttributeTableMixins
+    module Extensions
+      # Get +column_name+, +column_usage+, +column_type+ as a Hash.
+      #
+      # @param index [Fixnum]
+      # @return [Hash]
+      def column(index)
+        {
+          name: column_name(index),
+          usage: column_usage(index),
+          type: column_type(index)
+        }
+      end
+
+      # @return [Array<Hash>]
+      def columns
+        column_count.times.map do |i|
+          column(i)
+        end
+      end
+
+      # @return [Hash]
+      def as_json(_options = nil)
+        {
+          column_count: column_count,
+          columns: columns,
+          linear_binning: linear_binning,
+          row_count: row_count
+        }
+      end
+
+      # @return [String]
+      def to_json(options = nil)
+        as_json(options).to_json
+      end
+    end
+  end
+end