arrayfields 3.7.0 → 4.0.0

data/README

@@ -2,11 +2,29 @@ NAME
   arrayfields.rb
 
 URIS
-  http://rubyforge.org/projects/arrayfields/
-  http://www.codeforpeople.com/lib/ruby/arrayfields/
-  http://raa.ruby-lang.org/project/arrayfields/
+  http://www.codeforpeople.com/lib/ruby/
+  http://rubyforge.org/projects/codeforpeople/
 
 SYNOPSIS
+    require 'arrayfields'
+
+    a = Arrayfields.new :k, :v, :a, :b
+
+    p a[:k]        #=> :v
+    p a[:a]        #=> :b
+    p a.fields     #=> [:k, :a]
+    p a.values     #=> [:v, :b]
+    p a            #=> [:v, :b]
+    p a.to_hash    #=> {:k => :v, :a => :b} 
+    p a.pairs      #=> [[:k, :v], [:a, :b]]
+
+    a[:foo] = :bar
+
+    p a[:foo]      #=> :bar
+    p a.fields     #=> [:k, :a, :foo]
+
+ AND
+
     require 'arrayfields'  
 
     fields = 'name', 'age'
@@ -14,18 +32,18 @@ SYNOPSIS
 
     a.fields = fields
 
-    a[ 'name' ]                #=> 'zaphod'
-    a[ :name  ]                #=> 'zaphod'
-    a.indices 'name', 'age'    #=> [ 'zaphod', 42 ]
+    a['name']                #=> 'zaphod'
+    a[:name ]                #=> 'zaphod'
+    a.indices 'name', 'age'  #=> [ 'zaphod', 42 ]
 
 DESCRIPTION
   allow keyword access to array instances.  arrayfields works by adding only a
-  few methods to arrays, namely #fields= and fields, but the #fields= method
-  is hooked to extend arrays on a per object basis.  in otherwords __only__
-  those arrays whose fields are set will have auto-magical keyword access
-  bestowed on them - all other arrays remain unaffected.  arrays with keyword
-  access require much less memory when compared to hashes/objects and yet
-  still provide fast lookup.
+  few methods to arrays, namely #fields= and fields, but the #fields= method is
+  hooked to extend an array on a per object basis.  in otherwords __only__ those
+  arrays whose fields are set will have auto-magical keyword access bestowed on
+  them - all other arrays remain unaffected.  arrays with keyword access require
+  much less memory when compared to hashes/objects and yet still provide fast
+  lookup and preserve data order.
 
 LIST OF OVERRIDDEN METHODS
   Array#[]
@@ -58,6 +76,7 @@ LIST OF HASH-LIKE METHODS
   Array#update
   Array#replace
   Array#invert
+  Array#pairs
 
 LIST OF ADDED Array METHODS
   Array#fields=
@@ -136,11 +155,11 @@ SAMPLES
 
     require 'arrayfields'
     #
-    # the struct/fields factory method can be used in much the same way as ruby's
+    # the struct class factory method can be used in much the same way as ruby's
     # own struct generators and is useful when the fields for a set of arrays is
     # known apriori
     #
-      c = Array.fields :a, :b, :c  # same as Array.struct
+      c = Array.struct :a, :b, :c  # class generator 
       a = c.new [42, nil, nil]
       a[:c] = 42
       p a                          #=> [42, nil, 42]
@@ -158,13 +177,81 @@ SAMPLES
     [42, nil, 42, 42.0]
 
 
+  <========< sample/c.rb >========>
+
+  ~ > cat sample/c.rb
+
+    require 'arrayfields'
+    #
+    # the Array.fields methods generates an insance with those fields
+    #
+      a = Array.fields :a, :b, :c
+      a[:a] = a[:c] = 42
+      p a                           #=> [42, nil, 42]
+      p a.fields                    #=> [:a, :b, :c]
+      p a.values                    #=> [42, nil, 42]
+
+  ~ > ruby sample/c.rb
+
+    [42, nil, 42]
+    [:a, :b, :c]
+    [42, nil, 42]
+
+
+  <========< sample/d.rb >========>
+
+  ~ > cat sample/d.rb
+
+    require 'arrayfields'
+    #
+    # the Arrayfields.new method is a contruct that takes evenly numbered pairs of
+    # arbitrary objects and builds up and fielded array
+    #
+      a = Arrayfields.new :key, :value, :a, :b
+      p a.fields                                     #=> [:key, :a]
+      p a.values                                     #=> [:value, :b]
+    #
+    # you can use a hash - but of course the ordering gets lost in the initial
+    # hash creation.  aka the order of fields get horked by the unorderedness if
+    # the hash iteration.  it's okay for some purposed though
+    #
+      a = Arrayfields.new :key => :value, :a => :b
+      p a.fields                                     #=> [:key, :a]
+      p a.values                                     #=> [:value, :b]
+    #
+    # lists of pairs get flattened - the result simply has to be evenly numbered
+    #
+      a = Arrayfields.new [[:key, :value], [:a, :b]]
+      p a.fields                                     #=> [:key, :a]
+      p a.values                                     #=> [:value, :b]
+      p a.pairs                                      #=> [[:key, :value], [:a, :b]]
+      
+
+  ~ > ruby sample/d.rb
+
+    [:key, :a]
+    [:value, :b]
+    [:key, :a]
+    [:value, :b]
+    [:key, :a]
+    [:value, :b]
+    [[:key, :value], [:a, :b]]
+
+
 AUTHOR
   ara.t.howard@gmail.com
 
 HISTORY
+  4.0.0:
+    - added Arrayfields.new(*arbitrary_evenly_numbered_list_of_objects)
+    - added #to_pairs and #pairs
+    - tried but failed to recall what happend for version 3.8
+    - changed Array.fields to == Arrayfields.new (used to alias Array.struct)
+    - added impl of Fieldable#dup that sets fields in dupped object
+
   3.7.0:
-    - cleaned up multiton pattern in ArrayFields::FieldSet
-    - mods for ruby 1.8.6
+    - multiton pattern clean up, thanks gavin kistner!
+    - mods for ruby 1.8.6 (alias bug in 1.8.6 i think)
     - added PseudoHash class
     - added Array.struct/fields class generator
 

data/README.tmpl

@@ -2,11 +2,29 @@ NAME
   arrayfields.rb
 
 URIS
-  http://rubyforge.org/projects/arrayfields/
-  http://www.codeforpeople.com/lib/ruby/arrayfields/
-  http://raa.ruby-lang.org/project/arrayfields/
+  http://www.codeforpeople.com/lib/ruby/
+  http://rubyforge.org/projects/codeforpeople/
 
 SYNOPSIS
+    require 'arrayfields'
+
+    a = Arrayfields.new :k, :v, :a, :b
+
+    p a[:k]        #=> :v
+    p a[:a]        #=> :b
+    p a.fields     #=> [:k, :a]
+    p a.values     #=> [:v, :b]
+    p a            #=> [:v, :b]
+    p a.to_hash    #=> {:k => :v, :a => :b} 
+    p a.pairs      #=> [[:k, :v], [:a, :b]]
+
+    a[:foo] = :bar
+
+    p a[:foo]      #=> :bar
+    p a.fields     #=> [:k, :a, :foo]
+
+ AND
+
     require 'arrayfields'  
 
     fields = 'name', 'age'
@@ -14,18 +32,18 @@ SYNOPSIS
 
     a.fields = fields
 
-    a[ 'name' ]                #=> 'zaphod'
-    a[ :name  ]                #=> 'zaphod'
-    a.indices 'name', 'age'    #=> [ 'zaphod', 42 ]
+    a['name']                #=> 'zaphod'
+    a[:name ]                #=> 'zaphod'
+    a.indices 'name', 'age'  #=> [ 'zaphod', 42 ]
 
 DESCRIPTION
   allow keyword access to array instances.  arrayfields works by adding only a
-  few methods to arrays, namely #fields= and fields, but the #fields= method
-  is hooked to extend arrays on a per object basis.  in otherwords __only__
-  those arrays whose fields are set will have auto-magical keyword access
-  bestowed on them - all other arrays remain unaffected.  arrays with keyword
-  access require much less memory when compared to hashes/objects and yet
-  still provide fast lookup.
+  few methods to arrays, namely #fields= and fields, but the #fields= method is
+  hooked to extend an array on a per object basis.  in otherwords __only__ those
+  arrays whose fields are set will have auto-magical keyword access bestowed on
+  them - all other arrays remain unaffected.  arrays with keyword access require
+  much less memory when compared to hashes/objects and yet still provide fast
+  lookup and preserve data order.
 
 LIST OF OVERRIDDEN METHODS
   Array#[]
@@ -58,6 +76,7 @@ LIST OF HASH-LIKE METHODS
   Array#update
   Array#replace
   Array#invert
+  Array#pairs
 
 LIST OF ADDED Array METHODS
   Array#fields=
@@ -73,6 +92,13 @@ AUTHOR
   ara.t.howard@gmail.com
 
 HISTORY
+  4.0.0:
+    - added Arrayfields.new(*arbitrary_evenly_numbered_list_of_objects)
+    - added #to_pairs and #pairs
+    - tried but failed to recall what happend for version 3.8
+    - changed Array.fields to == Arrayfields.new (used to alias Array.struct)
+    - added impl of Fieldable#dup that sets fields in dupped object
+
   3.7.0:
     - multiton pattern clean up, thanks gavin kistner!
     - mods for ruby 1.8.6 (alias bug in 1.8.6 i think)

data/lib/{arrayfields-3.7.0.rb → arrayfields-4.0.0.rb}

@@ -5,7 +5,7 @@
 # Array#fields= is called
 #
   module ArrayFields 
-    VERSION = '3.7.0' unless defined? VERSION
+    self::VERSION = '4.0.0' unless defined? self::VERSION
     def self.version() VERSION end
   #
   # multiton cache of fields - wraps fields and fieldpos map to save memory
@@ -154,8 +154,8 @@
     def each_key
       @fieldset.each{|field| yield field}
     end
-    def each_value(*args, &block)
-      each(*args, &block)
+    def each_value *args, &block
+      each *args, &block
     end
     def fetch key
       self[key] or raise IndexError, 'key not found'
@@ -243,7 +243,30 @@
     def invert
       to_hash.invert
     end
+
+    def to_pairs
+      fields.zip values
+    end
+    alias_method 'pairs', 'to_pairs'
+  end
+  Arrayfields = ArrayFields
+
+  module Arrayfields
+    def self.new *pairs
+      pairs = pairs.map{|pair| Enumerable === pair ? pair.to_a : pair}.flatten
+      raise ArgumentError, "pairs must be evenly sized" unless(pairs.size % 2 == 0)
+      (( array = [] )).fields = []
+      0.step(pairs.size - 2, 2) do |a|
+        b = a + 1
+        array[ pairs[a] ] = pairs[b]
+      end
+      array
+    end
+    def self.[] *pairs
+      new *pairs
+    end
   end
+  def Arrayfields(*a, &b) Arrayfields.new(*a, &b) end
 #
 # Fieldable encapsulates methods in common for classes which may have their
 # fields set and subsequently be auto-extended by ArrayFields
@@ -254,7 +277,7 @@
   # keyword access
   #
     def fields= fields
-      extend ArrayFields unless defined? @fieldset 
+      extend ArrayFields unless ArrayFields === self
 
       @fieldset = 
         if ArrayFields::FieldSet === fields
@@ -273,6 +296,15 @@
     def fields
       @fieldset and @fieldset.fields
     end
+  #
+  # override so dup takes a copy of @fieldset 
+  #
+    def dup
+      obj = super 
+      #obj.instance_eval{ remove_instance_variable '@fieldset' }
+      obj.fields = fields 
+      obj
+    end
   end
 #
 # Array instances are extened with two methods only: Fieldable#fields= and
@@ -284,7 +316,7 @@
     include Fieldable
 
     class << self
-      def fields *fields
+      def struct *fields
         Class.new(self) do
           const_set :FIELDS, ArrayFields::FieldSet.new(fields.flatten)
           include ArrayFields
@@ -295,7 +327,10 @@
           end
         end
       end
-      alias_method 'struct', 'fields'
+      def fields *fields, &block
+        (( array = new(&block) )).fields = fields.map{|x| Enumerable === x ? x.to_a : x}.flatten
+        array
+      end
     end
   end
 #
@@ -315,7 +350,7 @@
       def [](*pairs)
         pairs.flatten!
         raise ArgumentError, "argument must be key/val pairs" unless 
-          (pairs.size % 2 == 0 and pairs.size >= 2)
+          (pairs.size % 2 == 0)
         fields, elements = [], []
         while((f = pairs.shift) and (e = pairs.shift)) 
           fields << f and elements << e
@@ -340,6 +375,7 @@
       class_eval "def #{ meth }(*a,&b); @a.#{ meth }(*a,&b);end"
     end
   end
+  Fieldedarray = FieldedArray
 
   class PseudoHash < ::Array
     class << self
@@ -355,8 +391,8 @@
       end
     end
     def initialize keys = [], values = []
-      self.replace values
       self.fields = keys
+      self.replace values
     end
     def to_yaml opts = {}
       YAML::quick_emit object_id, opts do |out|
@@ -366,3 +402,4 @@
       end
    end 
   end
+  Pseudohash = PseudoHash

data/lib/arrayfields.rb

@@ -5,7 +5,7 @@
 # Array#fields= is called
 #
   module ArrayFields 
-    VERSION = '3.7.0' unless defined? VERSION
+    self::VERSION = '4.0.0' unless defined? self::VERSION
     def self.version() VERSION end
   #
   # multiton cache of fields - wraps fields and fieldpos map to save memory
@@ -154,8 +154,8 @@
     def each_key
       @fieldset.each{|field| yield field}
     end
-    def each_value(*args, &block)
-      each(*args, &block)
+    def each_value *args, &block
+      each *args, &block
     end
     def fetch key
       self[key] or raise IndexError, 'key not found'
@@ -243,7 +243,30 @@
     def invert
       to_hash.invert
     end
+
+    def to_pairs
+      fields.zip values
+    end
+    alias_method 'pairs', 'to_pairs'
+  end
+  Arrayfields = ArrayFields
+
+  module Arrayfields
+    def self.new *pairs
+      pairs = pairs.map{|pair| Enumerable === pair ? pair.to_a : pair}.flatten
+      raise ArgumentError, "pairs must be evenly sized" unless(pairs.size % 2 == 0)
+      (( array = [] )).fields = []
+      0.step(pairs.size - 2, 2) do |a|
+        b = a + 1
+        array[ pairs[a] ] = pairs[b]
+      end
+      array
+    end
+    def self.[] *pairs
+      new *pairs
+    end
   end
+  def Arrayfields(*a, &b) Arrayfields.new(*a, &b) end
 #
 # Fieldable encapsulates methods in common for classes which may have their
 # fields set and subsequently be auto-extended by ArrayFields
@@ -254,7 +277,7 @@
   # keyword access
   #
     def fields= fields
-      extend ArrayFields unless defined? @fieldset 
+      extend ArrayFields unless ArrayFields === self
 
       @fieldset = 
         if ArrayFields::FieldSet === fields
@@ -273,6 +296,15 @@
     def fields
       @fieldset and @fieldset.fields
     end
+  #
+  # override so dup takes a copy of @fieldset 
+  #
+    def dup
+      obj = super 
+      #obj.instance_eval{ remove_instance_variable '@fieldset' }
+      obj.fields = fields 
+      obj
+    end
   end
 #
 # Array instances are extened with two methods only: Fieldable#fields= and
@@ -284,7 +316,7 @@
     include Fieldable
 
     class << self
-      def fields *fields
+      def struct *fields
         Class.new(self) do
           const_set :FIELDS, ArrayFields::FieldSet.new(fields.flatten)
           include ArrayFields
@@ -295,7 +327,10 @@
           end
         end
       end
-      alias_method 'struct', 'fields'
+      def fields *fields, &block
+        (( array = new(&block) )).fields = fields.map{|x| Enumerable === x ? x.to_a : x}.flatten
+        array
+      end
     end
   end
 #
@@ -315,7 +350,7 @@
       def [](*pairs)
         pairs.flatten!
         raise ArgumentError, "argument must be key/val pairs" unless 
-          (pairs.size % 2 == 0 and pairs.size >= 2)
+          (pairs.size % 2 == 0)
         fields, elements = [], []
         while((f = pairs.shift) and (e = pairs.shift)) 
           fields << f and elements << e
@@ -340,6 +375,7 @@
       class_eval "def #{ meth }(*a,&b); @a.#{ meth }(*a,&b);end"
     end
   end
+  Fieldedarray = FieldedArray
 
   class PseudoHash < ::Array
     class << self
@@ -355,8 +391,8 @@
       end
     end
     def initialize keys = [], values = []
-      self.replace values
       self.fields = keys
+      self.replace values
     end
     def to_yaml opts = {}
       YAML::quick_emit object_id, opts do |out|
@@ -366,3 +402,4 @@
       end
    end 
   end
+  Pseudohash = PseudoHash

data/sample/b.rb

@@ -1,10 +1,10 @@
 require 'arrayfields'
 #
-# the struct/fields factory method can be used in much the same way as ruby's
+# the struct class factory method can be used in much the same way as ruby's
 # own struct generators and is useful when the fields for a set of arrays is
 # known apriori
 #
-  c = Array.fields :a, :b, :c  # same as Array.struct
+  c = Array.struct :a, :b, :c  # class generator 
   a = c.new [42, nil, nil]
   a[:c] = 42
   p a                          #=> [42, nil, 42]

data/sample/c.rb

@@ -0,0 +1,9 @@
+require 'arrayfields'
+#
+# the Array.fields methods generates an insance with those fields
+#
+  a = Array.fields :a, :b, :c
+  a[:a] = a[:c] = 42
+  p a                           #=> [42, nil, 42]
+  p a.fields                    #=> [:a, :b, :c]
+  p a.values                    #=> [42, nil, 42]

data/sample/d.rb

@@ -0,0 +1,24 @@
+require 'arrayfields'
+#
+# the Arrayfields.new method is a contruct that takes evenly numbered pairs of
+# arbitrary objects and builds up and fielded array
+#
+  a = Arrayfields.new :key, :value, :a, :b
+  p a.fields                                     #=> [:key, :a]
+  p a.values                                     #=> [:value, :b]
+#
+# you can use a hash - but of course the ordering gets lost in the initial
+# hash creation.  aka the order of fields get horked by the unorderedness if
+# the hash iteration.  it's okay for some purposed though
+#
+  a = Arrayfields.new :key => :value, :a => :b
+  p a.fields                                     #=> [:key, :a]
+  p a.values                                     #=> [:value, :b]
+#
+# lists of pairs get flattened - the result simply has to be evenly numbered
+#
+  a = Arrayfields.new [[:key, :value], [:a, :b]]
+  p a.fields                                     #=> [:key, :a]
+  p a.values                                     #=> [:value, :b]
+  p a.pairs                                      #=> [[:key, :value], [:a, :b]]
+  

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.2
 specification_version: 1
 name: arrayfields
 version: !ruby/object:Gem::Version 
-  version: 3.7.0
-date: 2007-04-03 00:00:00 -06:00
+  version: 4.0.0
+date: 2007-09-13 00:00:00 -06:00
 summary: arrayfields
 require_paths: 
 - lib
@@ -29,20 +29,22 @@ post_install_message:
 authors: 
 - Ara T. Howard
 files: 
-- install.rb
-- gen_readme.rb
 - gemspec.rb
-- README.tmpl
+- gen_readme.rb
+- install.rb
 - lib
+- lib/arrayfields-4.0.0.rb
 - lib/arrayfields.rb
-- lib/arrayfields-3.7.0.rb
-- test
-- test/arrayfields.rb
-- test/memtest.rb
+- README
+- README.tmpl
 - sample
 - sample/a.rb
 - sample/b.rb
-- README
+- sample/c.rb
+- sample/d.rb
+- test
+- test/arrayfields.rb
+- test/memtest.rb
 test_files: 
 - test/arrayfields.rb
 rdoc_options: []