ntable 0.1.3 → 0.1.4

data/History.rdoc

@@ -1,3 +1,8 @@
+=== 0.1.4 / 2012-09-24
+
+* NTable::Structure and NTable::AxisInfo are now Enumerable, letting you iterate over the axes and labels, respectively.
+* You can now postprocess the labels generated by NTable.from_nested_object. Useful for filling in labels missing in the data.
+
 === 0.1.3 / 2012-09-10
 
 * Creating a table from a nested object, using a label conversion procedure, tended to fail with NoSuchCellError. Fixed and added test cases.

data/Version

@@ -1 +1 @@
-0.1.3
+0.1.4

data/lib/ntable/axis.rb

@@ -131,40 +131,45 @@ module NTable
     end
 
 
+    # See EmptyAxis#eql?
     def eql?(obj_)
       obj_.is_a?(LabeledAxis) && @a.eql?(obj_.instance_variable_get(:@a))
     end
+    alias_method :==, :eql?
 
-    def ==(obj_)
-      obj_.is_a?(LabeledAxis) && @a == obj_.instance_variable_get(:@a)
-    end
-
+    # See EmptyAxis#hash
     def hash
       @a.hash
     end
 
+    # See EmptyAxis#inspect
     def inspect
       "#<#{self.class}:0x#{object_id.to_s(16)} #{@a.inspect}>"
     end
     alias_method :to_s, :inspect
 
 
+    # See EmptyAxis#size
     attr_reader :size
 
 
+    # See EmptyAxis#index
     def index(label_)
       @h[label_.to_s]
     end
 
+    # See EmptyAxis#label
     def label(index_)
       @a[index_]
     end
 
 
+    # See EmptyAxis#to_json_object
     def to_json_object(json_obj_)
       json_obj_['labels'] = @a
     end
 
+    # See EmptyAxis#from_json_object
     def from_json_object(json_obj_)
       initialize(json_obj_['labels'] || [])
     end
@@ -188,39 +193,49 @@ module NTable
     end
 
 
+    # See EmptyAxis#eql?
     def eql?(obj_)
       obj_.is_a?(IndexedAxis) && obj_.size.eql?(@size) && obj_.start.eql?(@start)
     end
     alias_method :==, :eql?
 
+    # See EmptyAxis#hash
     def hash
       @size.hash ^ @start.hash
     end
 
+    # See EmptyAxis#inspect
     def inspect
       "#<#{self.class}:0x#{object_id.to_s(16)} size=#{@size} start=#{@start}>"
     end
     alias_method :to_s, :inspect
 
 
+    # See EmptyAxis#size
     attr_reader :size
+
+    # Retrieve the number of the first row
     attr_reader :start
 
 
+    # See EmptyAxis#index
     def index(label_)
       label_ >= @start && label_ < @size + @start ? label_ - @start : nil
     end
 
+    # See EmptyAxis#label
     def label(index_)
       index_ >= 0 && index_ < @size ? index_ + @start : nil
     end
 
 
+    # See EmptyAxis#to_json_object
     def to_json_object(json_obj_)
       json_obj_['size'] = @size
       json_obj_['start'] = @start unless @start == 0
     end
 
+    # See EmptyAxis#from_json_object
     def from_json_object(json_obj_)
       initialize(json_obj_['size'], json_obj_['start'].to_i)
     end
@@ -245,40 +260,49 @@ module NTable
     end
 
 
+    # See EmptyAxis#eql?
     def eql?(obj_)
       obj_.is_a?(ObjectAxis) && @a.eql?(obj_.instance_variable_get(:@a))
     end
 
+    # See EmptyAxis#==
     def ==(obj_)
       obj_.is_a?(ObjectAxis) && @a == obj_.instance_variable_get(:@a)
     end
 
+    # See EmptyAxis#hash
     def hash
       @a.hash
     end
 
+    # See EmptyAxis#inspect
     def inspect
       "#<#{self.class}:0x#{object_id.to_s(16)} #{@a.inspect}>"
     end
     alias_method :to_s, :inspect
 
 
+    # See EmptyAxis#size
     attr_reader :size
 
 
+    # See EmptyAxis#index
     def index(label_)
       @h[label_]
     end
 
+    # See EmptyAxis#label
     def label(index_)
       @a[index_]
     end
 
 
+    # See EmptyAxis#to_json_object
     def to_json_object(json_obj_)
       raise "Unable to JSON serialize an ObjectAxis"
     end
 
+    # See EmptyAxis#from_json_object
     def from_json_object(json_obj_)
       raise "Unable to JSON serialize an ObjectAxis"
     end

data/lib/ntable/construction.rb

@@ -41,9 +41,9 @@ require 'json'
 module NTable
 
 
-  @numeric_sort = ::Proc.new{ |a_, b_| a_.to_f <=> b_.to_f }
-  @integer_sort = ::Proc.new{ |a_, b_| a_.to_i <=> b_.to_i }
-  @string_sort = ::Proc.new{ |a_, b_| a_.to_s <=> b_.to_s }
+  @numeric_sort = ->(a_, b_){ a_.to_f <=> b_.to_f }
+  @integer_sort = ->(a_, b_){ a_.to_i <=> b_.to_i }
+  @string_sort = ->(a_, b_){ a_.to_s <=> b_.to_s }
 
 
   class << self
@@ -119,6 +119,13 @@ module NTable
     #   proc is provided, the resulting axis will be a LabeledAxis.
     #   You can also pass true instead of a Proc; this will create an
     #   LabeledAxis and make the conversion a simple to_s.
+    # [<tt>:postprocess</tt>]
+    #   An optional Proc that postprocesses the final labels array.
+    #   It should take an array of labels and return a modified array
+    #   (which can be the original array modified in place). Called
+    #   after any sort has been completed.
+    #   You can use this, for example, to "fill in" labels that were
+    #   not present in the original data.
     #
     # The third argument is an optional hash of miscellaneous options.
     # The following keys are recognized:
@@ -188,6 +195,8 @@ module NTable
             end
             labels_.sort!(&func_)
           end
+          postprocess_ = field_[:postprocess]
+          labels_ = postprocess_.call(labels_) if postprocess_.respond_to?(:call)
           axis_ = klass_.new(labels_)
         when ::Array
           axis_ = IndexedAxis.new(ai_[1].to_i - ai_[0].to_i, ai_[0].to_i)

data/lib/ntable/index_wrapper.rb

@@ -42,24 +42,35 @@ module NTable
 
   class IndexWrapper
 
+
     # Create an IndexWrapper with the given integer index
 
     def initialize(val_)
       @value = val_.to_i
     end
 
+
+    # Standard equality checker
+
     def eql?(rhs_)
       rhs_.is_a?(IndexWrapper) && @value == @rhs_.value
     end
     alias_method :==, :eql?
 
+
+    # Standard hash value
+
     def hash
       @value.hash
     end
 
+
+    # Retrieve the actual index
+
     attr_reader :value
     alias_method :to_i, :value
 
+
   end
 
 

data/lib/ntable/structure.rb

@@ -104,6 +104,7 @@ module NTable
       def label(index_)
         @axis_object.label(index_)
       end
+      alias_method :[], :label
 
 
       # Return the number of rows along this axis.
@@ -114,10 +115,27 @@ module NTable
       end
 
 
-      def eql?(obj_)  # :nodoc:
+      # Iterate over the labels, in order.
+
+      def each
+        if block_given?
+          @axis_object.size.times do |i_|
+            yield @axis_object.label(i_)
+          end
+        else
+          to_enum
+        end
+      end
+
+      include ::Enumerable
+
+
+      # Standard equality check
+
+      def eql?(obj_)
         obj_.is_a?(AxisInfo) && @axis_object.eql?(obj_.axis_object) && @axis_name.eql?(obj_.axis_name)
       end
-      alias_method :==, :eql?  # :nodoc:
+      alias_method :==, :eql?
 
 
       def _set_axis(axis_)  # :nodoc:
@@ -133,7 +151,7 @@ module NTable
       end
 
 
-      def _compute_offset(v_)
+      def _compute_offset(v_)  # :nodoc:
         if v_.is_a?(::NTable::IndexWrapper)
           index_ = v_.to_i
           index_ = nil if index_ < 0 || index_ >= @axis_object.size
@@ -160,11 +178,21 @@ module NTable
       end
 
 
+      # Standard equality check
+
       def eql?(obj_)
         obj_.is_a?(Position) && obj_.structure.eql?(@structure) && obj_._offset.eql?(self._offset)
       end
       alias_method :==, :eql?
 
+
+      # Standard hash value
+
+      def hash
+        @structure.hash + @vector.hash
+      end
+
+
       attr_reader :structure  # :nodoc:
 
 
@@ -398,11 +426,21 @@ module NTable
         @names[axis_.to_s]
       end
     end
+    alias_method :[], :axis
+
+
+    # Iterate over the axes in order, yielding AxisInfo objects.
+
+    def each(&block_)
+      @indexes.each(&block_)
+    end
+
+    include ::Enumerable
 
 
     # Lock this structure, preventing further modification. Generally,
-    # this is done automatically when a structure is used by a table,
-    # and you do not need to call it yourself.
+    # this is done automatically when a structure is used by a table;
+    # you normally do not need to call it yourself.
 
     def lock!
       unless @locked

data/lib/ntable/table.rb

@@ -128,6 +128,13 @@ module NTable
     end
 
 
+    # Standard hash value
+
+    def hash
+      @structure.hash + @vals.hash + @offset.hash + @parent.hash
+    end
+
+
     # The Structure of this table
     attr_reader :structure
 
@@ -643,7 +650,7 @@ module NTable
     end
 
 
-    def _offset_for_args(args_)
+    def _offset_for_args(args_)  # :nodoc:
       if args_.size == 1
         first_ = args_.first
         args_ = first_ if first_.is_a?(::Hash) || first_.is_a?(::Array)

data/test/tc_nested_object.rb

@@ -47,6 +47,7 @@ module NTable
       def setup
         @labeled_axis_2 = LabeledAxis.new([:one, :two])
         @object_axis_2 = ObjectAxis.new([:one, :two])
+        @object_axis_3 = ObjectAxis.new([:one, :two, :three])
         @labeled_axis_3 = LabeledAxis.new([:blue, :red, :white])
         @indexed_axis_2 = IndexedAxis.new(2)
         @indexed_axis_10 = IndexedAxis.new(10, 1)
@@ -202,7 +203,7 @@ module NTable
       def test_from_level_1_labeled_with_objectify_conversion
         obj_ = {'one' => 1, 'two' => 2}
         t1_ = Table.from_nested_object(obj_,
-          [{:sort => true, :objectify => ::Proc.new{ |a_| a_.to_sym }}])
+          [{:sort => true, :objectify => ->(a_){ a_.to_sym }}])
         assert_equal(Table.new(Structure.add(@object_axis_2), :load => [1,2]), t1_)
       end
 
@@ -210,11 +211,20 @@ module NTable
       def test_from_level_1_labeled_with_stringify_conversion
         obj_ = {:one1 => 1, :two22 => 2}
         t1_ = Table.from_nested_object(obj_,
-          [{:sort => true, :stringify => ::Proc.new{ |a_| a_.to_s.gsub(/\d/, '') }}])
+          [{:sort => true, :stringify => ->(a_){ a_.to_s.gsub(/\d/, '') }}])
         assert_equal(Table.new(Structure.add(@labeled_axis_2), :load => [1,2]), t1_)
       end
 
 
+      def test_from_level_1_labeled_with_objectify_and_postprocess
+        obj_ = {:one => 1, :two => 2}
+        t1_ = Table.from_nested_object(obj_,
+          [{:sort => true, :objectify => true, :postprocess => ->(labels_){ labels_ << :three }}],
+          :fill => 0)
+        assert_equal(Table.new(Structure.add(@object_axis_3), :load => [1,2,0]), t1_)
+      end
+
+
     end
 
   end

data/test/tc_structure.rb

@@ -74,6 +74,13 @@ module NTable
       end
 
 
+      def test_axis_info_enumerable
+        s_ = Structure.new
+        s_.add(@indexed1, :first)
+        assert_equal(45, s_.axis(0).inject(:+))
+      end
+
+
       def test_add_multi_axis
         s_ = Structure.new
         s_.add(@labeled1, :first)
@@ -92,6 +99,15 @@ module NTable
       end
 
 
+      def test_structure_enumerable
+        s_ = Structure.new
+        s_.add(@labeled1, :first)
+        s_.add(@indexed1, :second)
+        s_.add(@indexed1)
+        assert_equal([LabeledAxis, IndexedAxis, IndexedAxis], s_.map{ |ai_| ai_.axis_object.class })
+      end
+
+
       def test_remove_axis
         s_ = Structure.new
         s_.add(@labeled1, :first)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ntable
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-10 00:00:00.000000000 Z
+date: 2012-09-24 00:00:00.000000000 Z
 dependencies: []
 description: NTable provides a convenient data structure for storing n-dimensional
   tabular data. It works with zero-dimensional scalar values, arrays, tables, and
@@ -64,7 +64,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: virtuoso
-rubygems_version: 1.8.21
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: NTable is an n-dimensional table data structure for Ruby.