arrayfields 3.5.0

data/lib/arrayfields-3.5.0.rb

@@ -0,0 +1,342 @@
+#
+# The ArrayFields module implements methods which allow an Array to be indexed
+# by String or Symbol. It is not required to manually use this module to extend
+# Array's - they are auto-extended when Array#fields= is called
+#
+  module ArrayFields 
+#{{{
+    VERSION = '3.5.0'
+  #
+  # multiton cache of fields - wraps fields and fieldpos map to save memory
+  #
+    class FieldSet
+#{{{
+      class << self
+#{{{
+        def new fields
+#{{{
+          @sets ||= {}
+          obj = @sets[fields]
+          unless obj
+            obj = super  
+            @sets[fields] = obj
+          end
+          obj
+#}}}
+        end
+#}}}
+      end
+      attr :fields
+      attr :fieldpos
+      def initialize fields
+#{{{
+        raise ArgumentError, "<#{ fields.inspect }> not inject-able" unless
+          fields.respond_to? :inject
+
+        @fieldpos =
+          fields.inject({}) do |h, f|
+            unless String === f or Symbol === f
+              raise ArgumentError, "<#{ f.inspect }> neither String nor Symbol"
+            end
+            h[f] = h.size
+            h
+          end
+
+        @fields = fields
+#}}}
+      end
+      def pos field
+#{{{
+        @fieldpos[field]
+#}}}
+      end
+#}}}
+    end
+  #
+  # methods redefined to work with fields as well as numeric indexes
+  #
+    def [](idx, *args) 
+#{{{
+      if @fieldset and (String === idx or Symbol === idx)
+        pos = @fieldset.pos idx
+        return nil unless pos
+        super(pos, *args)
+      else
+        super
+      end
+#}}}
+    end
+    alias slice []
+    def []=(idx, *args) 
+#{{{
+      if @fieldset and (String === idx or Symbol === idx) 
+        pos = @fieldset.pos idx
+        unless pos
+          @fieldset.fields << idx
+          @fieldset.fieldpos[idx] = pos = size
+        end
+        super(pos, *args)
+      else
+        super
+      end
+#}}}
+    end
+    def at idx
+#{{{
+      if @fieldset and (String === idx or Symbol === idx)
+        pos = @fieldset.pos idx
+        return nil unless pos
+        super pos
+      else
+        super
+      end
+#}}}
+    end
+    def delete_at idx
+#{{{
+      if @fieldset and (String === idx or Symbol === idx)
+        pos = @fieldset.pos idx
+        return nil unless pos
+        super pos
+      else
+        super
+      end
+#}}}
+    end
+    def fill(obj, *args)
+#{{{
+      idx = args.first
+      if idx and @fieldset and (String === idx or Symbol === idx)
+        idx = args.shift
+        pos = @fieldset.pos idx
+        super(obj, pos, *args)
+      else
+        super
+      end
+#}}}
+    end
+    def values_at(*idxs)
+#{{{
+      idxs.flatten!
+      if @fieldset
+        idxs.map!{|i| (String === i or Symbol === i) ? @fieldset.pos(i) : i}
+      end
+      super(*idxs)
+#}}}
+    end
+    alias indices values_at
+    alias indexes values_at 
+    def slice!(*args)
+#{{{
+      ret = self[*args]
+      self[*args] = nil
+      ret
+#}}}
+    end
+    def each_with_field
+#{{{
+      each_with_index do |elem, i|
+        yield elem, @fieldset.fields[i]
+      end
+#}}}
+    end
+  #
+  # methods which give a hash-like interface 
+  #
+    def each_pair
+#{{{
+      each_with_index do |elem, i|
+        yield @fieldset.fields[i], elem
+      end
+#}}}
+    end
+    def each_key
+#{{{
+      @fieldset.each{|field| yield field}
+#}}}
+    end
+    def each_value(*args, &block)
+#{{{
+      each(*args, &block)
+#}}}
+    end
+    def fetch key
+#{{{
+      self[key] or raise IndexError, 'key not found'
+#}}}
+    end
+    def has_key? key
+#{{{
+      @fieldset.fields.include? key
+#}}}
+    end
+    alias member? has_key?
+    alias key? has_key?
+    def has_value? value
+#{{{
+      if respond_to? 'include?'
+        self.include? value
+      else
+        a = []
+        each{|val| a << val}
+        a.include? value
+      end
+#}}}
+    end
+    alias value? has_value?
+    def keys
+#{{{
+      fields
+#}}}
+    end
+    def store key, value
+#{{{
+      self[key] = value
+#}}}
+    end
+    def values
+#{{{
+      if respond_to? 'to_ary'
+        self.to_ary
+      else
+        a = []
+        each{|val| a << val}
+        a
+      end
+#}}}
+    end
+    def to_hash
+#{{{
+      if respond_to? 'to_ary'
+        h = {}
+        @fieldset.fields.zip(to_ary){|f,e| h[f] = e}
+        h
+      else
+        a = []
+        each{|val| a << val}
+        h = {}
+        @fieldset.fields.zip(a){|f,e| h[f] = e}
+        h
+      end
+#}}}
+    end
+    alias to_h to_hash
+    def update other
+#--{{{
+      other.each{|k,v| self[k] = v}
+      to_hash
+#--}}}
+    end
+    def replace other
+#--{{{
+      Hash === other ? update(other) : super
+#--}}}
+    end
+    def invert
+#--{{{
+      to_hash.invert
+#--}}}
+    end
+#}}}
+  end
+#
+# Fieldable encapsulates methods in common for classes which may have their
+# fields set
+#
+  module Fieldable
+#{{{
+  #
+  # sets fields an dynamically extends this Array instance with methods for
+  # keyword access
+  #
+    def fields= fields
+#{{{
+      extend ArrayFields unless defined? @fieldset 
+
+      @fieldset = 
+        if ArrayFields::FieldSet === fields
+          fields
+        else
+          ArrayFields::FieldSet.new fields
+        end
+#}}}
+    end
+  #
+  # access to fieldset
+  #
+    attr_reader :fieldset
+  #
+  # access to field list
+  #
+    def fields
+#{{{
+      @fieldset and @fieldset.fields
+#}}}
+    end
+#}}}
+  end
+#
+# The Array class is extened with a methods to allow keyword access 
+#
+  class Array
+#{{{
+    include Fieldable
+#}}}
+  end
+#
+# proxy class that allows an array to be wrapped in a way that still allows #
+# keyword access.  also facilitate usage of ArrayFields with arraylike objects.
+# thnx to Sean O'Dell for the suggestion.
+#
+# sample usage
+#
+# fa = FieldedArray.new %w(zero one two), [0,1,2]
+# p fa['zero']   #=> 0
+#
+#
+  class FieldedArray
+#{{{
+    include Fieldable
+    class << self
+
+      def [](*pairs)
+#{{{
+        pairs.flatten!
+        raise ArgumentError, "argument must be key/val paris" unless 
+          (pairs.size % 2 == 0 and pairs.size >= 2)
+        fields, elements = [], []
+        #pairs.each do |f,e| 
+        while((f = pairs.shift) and (e = pairs.shift)) 
+          raise ArgumentError, "field must be String or Symbol" unless
+            (String === f or Symbol === f)
+          fields << f and elements << e
+        end
+        new fields, elements
+#}}}
+      end
+
+    end
+    def initialize fields, array
+#{{{
+      @a = array
+      self.fields = fields
+#}}}
+    end
+    def method_missing(meth, *args, &block)
+#{{{
+      @a.send(meth, *args, &block)
+#}}}
+    end
+    delegates =
+#{{{
+      %w(
+        to_s
+        to_str
+        inspect
+      )
+#}}}
+    delegates.each do |meth| 
+      class_eval "def #{ meth }(*a,&b); @a.#{ meth }(*a,&b);end"
+    end
+#}}}
+  end

data/lib/arrayfields.rb

@@ -0,0 +1,342 @@
+#
+# The ArrayFields module implements methods which allow an Array to be indexed
+# by String or Symbol. It is not required to manually use this module to extend
+# Array's - they are auto-extended when Array#fields= is called
+#
+  module ArrayFields 
+#{{{
+    VERSION = '3.5.0'
+  #
+  # multiton cache of fields - wraps fields and fieldpos map to save memory
+  #
+    class FieldSet
+#{{{
+      class << self
+#{{{
+        def new fields
+#{{{
+          @sets ||= {}
+          obj = @sets[fields]
+          unless obj
+            obj = super  
+            @sets[fields] = obj
+          end
+          obj
+#}}}
+        end
+#}}}
+      end
+      attr :fields
+      attr :fieldpos
+      def initialize fields
+#{{{
+        raise ArgumentError, "<#{ fields.inspect }> not inject-able" unless
+          fields.respond_to? :inject
+
+        @fieldpos =
+          fields.inject({}) do |h, f|
+            unless String === f or Symbol === f
+              raise ArgumentError, "<#{ f.inspect }> neither String nor Symbol"
+            end
+            h[f] = h.size
+            h
+          end
+
+        @fields = fields
+#}}}
+      end
+      def pos field
+#{{{
+        @fieldpos[field]
+#}}}
+      end
+#}}}
+    end
+  #
+  # methods redefined to work with fields as well as numeric indexes
+  #
+    def [](idx, *args) 
+#{{{
+      if @fieldset and (String === idx or Symbol === idx)
+        pos = @fieldset.pos idx
+        return nil unless pos
+        super(pos, *args)
+      else
+        super
+      end
+#}}}
+    end
+    alias slice []
+    def []=(idx, *args) 
+#{{{
+      if @fieldset and (String === idx or Symbol === idx) 
+        pos = @fieldset.pos idx
+        unless pos
+          @fieldset.fields << idx
+          @fieldset.fieldpos[idx] = pos = size
+        end
+        super(pos, *args)
+      else
+        super
+      end
+#}}}
+    end
+    def at idx
+#{{{
+      if @fieldset and (String === idx or Symbol === idx)
+        pos = @fieldset.pos idx
+        return nil unless pos
+        super pos
+      else
+        super
+      end
+#}}}
+    end
+    def delete_at idx
+#{{{
+      if @fieldset and (String === idx or Symbol === idx)
+        pos = @fieldset.pos idx
+        return nil unless pos
+        super pos
+      else
+        super
+      end
+#}}}
+    end
+    def fill(obj, *args)
+#{{{
+      idx = args.first
+      if idx and @fieldset and (String === idx or Symbol === idx)
+        idx = args.shift
+        pos = @fieldset.pos idx
+        super(obj, pos, *args)
+      else
+        super
+      end
+#}}}
+    end
+    def values_at(*idxs)
+#{{{
+      idxs.flatten!
+      if @fieldset
+        idxs.map!{|i| (String === i or Symbol === i) ? @fieldset.pos(i) : i}
+      end
+      super(*idxs)
+#}}}
+    end
+    alias indices values_at
+    alias indexes values_at 
+    def slice!(*args)
+#{{{
+      ret = self[*args]
+      self[*args] = nil
+      ret
+#}}}
+    end
+    def each_with_field
+#{{{
+      each_with_index do |elem, i|
+        yield elem, @fieldset.fields[i]
+      end
+#}}}
+    end
+  #
+  # methods which give a hash-like interface 
+  #
+    def each_pair
+#{{{
+      each_with_index do |elem, i|
+        yield @fieldset.fields[i], elem
+      end
+#}}}
+    end
+    def each_key
+#{{{
+      @fieldset.each{|field| yield field}
+#}}}
+    end
+    def each_value(*args, &block)
+#{{{
+      each(*args, &block)
+#}}}
+    end
+    def fetch key
+#{{{
+      self[key] or raise IndexError, 'key not found'
+#}}}
+    end
+    def has_key? key
+#{{{
+      @fieldset.fields.include? key
+#}}}
+    end
+    alias member? has_key?
+    alias key? has_key?
+    def has_value? value
+#{{{
+      if respond_to? 'include?'
+        self.include? value
+      else
+        a = []
+        each{|val| a << val}
+        a.include? value
+      end
+#}}}
+    end
+    alias value? has_value?
+    def keys
+#{{{
+      fields
+#}}}
+    end
+    def store key, value
+#{{{
+      self[key] = value
+#}}}
+    end
+    def values
+#{{{
+      if respond_to? 'to_ary'
+        self.to_ary
+      else
+        a = []
+        each{|val| a << val}
+        a
+      end
+#}}}
+    end
+    def to_hash
+#{{{
+      if respond_to? 'to_ary'
+        h = {}
+        @fieldset.fields.zip(to_ary){|f,e| h[f] = e}
+        h
+      else
+        a = []
+        each{|val| a << val}
+        h = {}
+        @fieldset.fields.zip(a){|f,e| h[f] = e}
+        h
+      end
+#}}}
+    end
+    alias to_h to_hash
+    def update other
+#--{{{
+      other.each{|k,v| self[k] = v}
+      to_hash
+#--}}}
+    end
+    def replace other
+#--{{{
+      Hash === other ? update(other) : super
+#--}}}
+    end
+    def invert
+#--{{{
+      to_hash.invert
+#--}}}
+    end
+#}}}
+  end
+#
+# Fieldable encapsulates methods in common for classes which may have their
+# fields set
+#
+  module Fieldable
+#{{{
+  #
+  # sets fields an dynamically extends this Array instance with methods for
+  # keyword access
+  #
+    def fields= fields
+#{{{
+      extend ArrayFields unless defined? @fieldset 
+
+      @fieldset = 
+        if ArrayFields::FieldSet === fields
+          fields
+        else
+          ArrayFields::FieldSet.new fields
+        end
+#}}}
+    end
+  #
+  # access to fieldset
+  #
+    attr_reader :fieldset
+  #
+  # access to field list
+  #
+    def fields
+#{{{
+      @fieldset and @fieldset.fields
+#}}}
+    end
+#}}}
+  end
+#
+# The Array class is extened with a methods to allow keyword access 
+#
+  class Array
+#{{{
+    include Fieldable
+#}}}
+  end
+#
+# proxy class that allows an array to be wrapped in a way that still allows #
+# keyword access.  also facilitate usage of ArrayFields with arraylike objects.
+# thnx to Sean O'Dell for the suggestion.
+#
+# sample usage
+#
+# fa = FieldedArray.new %w(zero one two), [0,1,2]
+# p fa['zero']   #=> 0
+#
+#
+  class FieldedArray
+#{{{
+    include Fieldable
+    class << self
+
+      def [](*pairs)
+#{{{
+        pairs.flatten!
+        raise ArgumentError, "argument must be key/val paris" unless 
+          (pairs.size % 2 == 0 and pairs.size >= 2)
+        fields, elements = [], []
+        #pairs.each do |f,e| 
+        while((f = pairs.shift) and (e = pairs.shift)) 
+          raise ArgumentError, "field must be String or Symbol" unless
+            (String === f or Symbol === f)
+          fields << f and elements << e
+        end
+        new fields, elements
+#}}}
+      end
+
+    end
+    def initialize fields, array
+#{{{
+      @a = array
+      self.fields = fields
+#}}}
+    end
+    def method_missing(meth, *args, &block)
+#{{{
+      @a.send(meth, *args, &block)
+#}}}
+    end
+    delegates =
+#{{{
+      %w(
+        to_s
+        to_str
+        inspect
+      )
+#}}}
+    delegates.each do |meth| 
+      class_eval "def #{ meth }(*a,&b); @a.#{ meth }(*a,&b);end"
+    end
+#}}}
+  end

data/test/arrayfields.rb

@@ -0,0 +1,323 @@
+require 'test/unit'
+STDOUT.sync = true
+$:.unshift 'lib'
+$:.unshift '../lib'
+$:.unshift '.'
+require 'arrayfields'
+
+class ArrayFieldsTest < Test::Unit::TestCase
+#{{{
+  def setup
+#{{{
+    @fields = %w(zero one two)
+    @str_fields = %w(zero one two)
+    @sym_fields = [:zero, :one, :two] 
+    @a = [0,1,2] 
+#}}}
+  end
+#
+# setting fields correctly
+#
+  def test_00
+#{{{
+    assert_nothing_raised do
+      @a.fields = @str_fields
+    end
+    assert_equal @a.fields, @str_fields
+#}}}
+  end
+  def test_01
+#{{{
+    assert_nothing_raised do
+      @a.fields = @sym_fields
+    end
+    assert_equal @a.fields, @sym_fields
+#}}}
+  end
+  def test_02
+#{{{
+    assert_nothing_raised do
+      a = ArrayFields::FieldSet.new @str_fields
+      b = ArrayFields::FieldSet.new @str_fields
+      assert_equal a, b 
+      assert_equal a.id, b.id 
+    end
+#}}}
+  end
+  def test_03
+#{{{
+    assert_nothing_raised do
+      a = ArrayFields::FieldSet.new @sym_fields
+      b = ArrayFields::FieldSet.new @sym_fields
+      c = ArrayFields::FieldSet.new @str_fields
+      d = ArrayFields::FieldSet.new @str_fields
+      assert_equal a, b 
+      assert_equal a.id, b.id 
+      assert_not_equal a, c
+      assert_not_equal a.id, c.id
+    end
+#}}}
+  end
+#
+# setting fields incorrectly
+#
+  def test_10
+#{{{
+    assert_raises(ArgumentError) do
+      @a.fields = nil 
+    end
+#}}}
+  end
+  def test_11
+#{{{
+    assert_raises(ArgumentError) do
+      @a.fields = []
+    end
+#}}}
+  end
+  def test_11
+#{{{
+    assert_raises(ArgumentError) do
+      @a.fields = [Hash.new]
+    end
+#}}}
+  end
+#
+# [] 
+#
+  def test_20
+#{{{
+    a, b, c = @a[0], @a[1,1].first, @a[2..2].first
+    assert_nothing_raised do
+      @a.fields = @str_fields
+    end
+    assert_nothing_raised do
+      assert_equal a, @a['zero']
+    end
+    assert_nothing_raised do
+      assert_equal b, @a['one']
+    end
+    assert_nothing_raised do
+      assert_equal c, @a['two']
+    end
+#}}}
+  end
+  def test_21
+#{{{
+    a = @a[0,@a.size]
+    assert_nothing_raised do
+      @a.fields = @str_fields
+    end
+    assert_nothing_raised do
+      assert_equal a, @a['zero', @a.size]
+    end
+#}}}
+  end
+#
+# []=
+#
+  def test_30
+#{{{
+    assert_nothing_raised do
+      @a.fields = @str_fields
+    end
+    value = 42 
+    assert_nothing_raised do
+      @a['zero'] = value
+      assert_equal value, @a['zero']
+      assert_equal @a[0], @a['zero']
+    end
+#}}}
+  end
+  def test_31
+#{{{
+    assert_nothing_raised do
+      @a.fields = @str_fields
+    end
+    value = 42 
+    assert_nothing_raised do
+      @a['zero', 1] = value
+      assert_equal value, @a['zero']
+      assert_equal @a[0,1], @a['zero',1]
+    end
+#}}}
+  end
+  def test_32
+#{{{
+    assert_nothing_raised do
+      @a.fields = @str_fields
+    end
+    value = 42 
+    assert_nothing_raised do
+      @a[0..0] = value
+      assert_equal value, @a['zero']
+      assert_equal @a[0,1], @a['zero',1]
+    end
+#}}}
+  end
+  def test_33
+#{{{
+    assert_nothing_raised do
+      @a.fields = @str_fields
+    end
+    assert_nothing_raised do
+      @a['zero', @a.size] = nil
+      assert_equal @a, []
+    end
+#}}}
+  end
+  def test_34
+#{{{
+    assert_nothing_raised do
+      @a.fields = @str_fields
+    end
+    assert_nothing_raised do
+      @a['three'] = 3
+      assert_equal 3, @a['three']
+      assert_equal 3, @a[3]
+    end
+#}}}
+  end
+  def test_35
+#{{{
+    assert_nothing_raised do
+      @a.fields = @str_fields
+      @a['three'] = 3
+    end
+    %w(zero one two three).inject(exp=[]){|ex,f| ex << [ex.size, f]}
+    actual = []
+    assert_nothing_raised do
+      @a.each_with_field{|e,f| actual << [e,f]}
+    end
+    assert_equal exp, actual
+#}}}
+  end
+  def test_36
+#{{{
+    assert_nothing_raised do
+      @a.fields = @str_fields
+      @a['three'] = 3
+    end
+    assert_equal %w(zero one two three), @a.fields
+#}}}
+  end
+#
+# at
+#
+  def test_40
+#{{{
+    assert_nothing_raised do
+      @a.fields = @str_fields
+    end
+    @str_fields.each_with_index do |f, i|
+      ret = nil
+      assert_nothing_raised do
+        ret = @a.at f
+      end
+      assert_equal ret, i
+    end
+#}}}
+  end
+#
+# delete_at
+#
+  def test_50
+#{{{
+    assert_nothing_raised do
+      @a.fields = @str_fields
+    end
+    assert_nothing_raised do
+      value = @a.delete_at 'zero'
+      assert_equal 0, value
+    end
+    assert_nothing_raised do
+      value = @a.delete_at 'three'
+      assert_equal nil, value
+    end
+#}}}
+  end
+#
+# fill 
+#
+  def test_60
+#{{{
+    assert_nothing_raised do
+      @a.fields = @str_fields
+    end
+    assert_nothing_raised do
+      @a.fill 42, 'zero', 1
+      assert_equal 42, @a[0] 
+    end
+#}}}
+  end
+  def test_61
+#{{{
+    assert_nothing_raised do
+      @a.fields = @str_fields
+    end
+    assert_nothing_raised do
+      @a.fill 42
+      assert_equal 42, @a[-1] 
+    end
+#}}}
+  end
+  def test_62
+#{{{
+    assert_nothing_raised do
+      @a.fields = @str_fields
+    end
+    assert_nothing_raised do
+      @a.fill 42, 0...@a.size
+      assert_equal(Array.new(@a.size, 42), @a)
+    end
+#}}}
+  end
+#
+# slice 
+#
+  def test_70
+#{{{
+    a, b, c = @a[0], @a[1,1].first, @a[2..2].first
+    assert_nothing_raised do
+      @a.fields = @str_fields
+    end
+    assert_nothing_raised do
+      assert_equal a, @a.slice('zero')
+    end
+    assert_nothing_raised do
+      assert_equal b, @a.slice('one')
+    end
+    assert_nothing_raised do
+      assert_equal c, @a.slice('two')
+    end
+#}}}
+  end
+#
+# slice!
+#
+  def test_80
+#{{{
+    assert_nothing_raised do
+      @a.fields = @str_fields
+    end
+    assert_nothing_raised do
+      @a.slice! 'zero', @a.size
+      assert_equal @a, []
+    end
+#}}}
+  end
+  def test_81
+#{{{
+    assert_nothing_raised do
+      @a.fields = @str_fields
+    end
+    assert_nothing_raised do
+      @a.slice! 0, @a.size
+      assert_equal @a, []
+    end
+#}}}
+  end
+if false
+end
+#}}}
+end

metadata

@@ -0,0 +1,41 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.8.11
+specification_version: 1
+name: arrayfields
+version: !ruby/object:Gem::Version 
+  version: 3.5.0
+date: 2005-11-01 00:00:00.000000 -07:00
+summary: arrayfields
+require_paths: 
+  - lib
+email: ara.t.howard@noaa.gov
+homepage: http://codeforpeople.com/lib/ruby/arrayfields/
+rubyforge_project: 
+description: 
+autorequire: arrayfields
+default_executable: 
+bindir: bin
+has_rdoc: false
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+    - 
+      - ">"
+      - !ruby/object:Gem::Version 
+        version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+authors: 
+  - Ara T. Howard
+files: 
+  - lib/arrayfields.rb
+  - lib/arrayfields-3.5.0.rb
+test_files: 
+  - test/arrayfields.rb
+rdoc_options: []
+extra_rdoc_files: []
+executables: []
+extensions: []
+requirements: []
+dependencies: []