arrayfields 3.5.0 → 3.6.0

data/README

@@ -0,0 +1,127 @@
+URLS:
+
+  - http://raa.ruby-lang.org/project/arrayfields/
+  - http://www.codeforpeople.com/lib/ruby/arrayfields/
+  - http://rubyforge.org/projects/arrayfields/
+
+SYNOPSIS:
+
+  allow keyword access to arrays:
+
+    require 'arrayfields'  
+
+    fields = 'name', 'age'
+    row = [ 'bob', 30 ]
+
+    row.fields = fields
+
+    row[ 'name' ]                #=> 'bob'
+    row.indices 'name', 'age'    #=> [ 'bob', 30 ]
+
+  assigning to un-named fields appends:
+
+    stack = []
+    stack.fields = %w(zero one)            
+    stack['zero'] = 'zero'
+    stack['one'] = 'one'
+    stack                        #=> [ 'zero', 'one' ]
+
+  useful for database work:
+
+    relation = pgconn.query sql
+    relation.size                #=> 65536
+
+    # yikes! do we really want to re-construct a hash for for each tuple when
+    # we already have Arrays?
+
+    fields = %w(ssn name position)
+    table.each{|tuple| tuple.fields = fields}
+
+    tuples[34578]['ssn']         #=> 574865032
+
+LIST OF OVERRIDDEN METHODS:
+  
+  - Array#[]
+  - Array#[]=
+  - Array#at
+  - Array#delete_at
+  - Array#fill
+  - Array#values_at
+  - Array#indices
+  - Array#indexes
+  - Array#slice
+  - Array#slice!
+
+LIST OF NEW Array METHODS:
+
+  - Array#fields=
+  - Array#each_with_field
+
+DOCS/USAGE/SAMPLE:
+
+  - lib/arrayfields.rb
+  - test/arrayfields.rb
+
+AUTHOR:
+
+  ara.t.howard@noaa.gov        
+
+HISTORY:
+
+  3.5.0:
+    - added more hash-like methods
+      - update
+      - replace
+      - invert
+
+  3.4.0:
+    - added FieldedArray[] ctor
+    - added methods to make Arrays with fields set behave more closely to Hashes
+      - each_pair 
+      - each_key
+      - each_value
+      - fetch
+      - has_key?
+      - member?
+      - key?
+      - has_value?
+      - value?
+      - keys?
+      - store
+      - values
+
+  3.3.0:
+    - added gemspec file - thnx Assaph Mehr
+    - added FieldedArray proxy class which minimizes modifications to class
+      Array and allow ArrayFields to work (potientially) other arraylike object.
+      thnks Sean O'Dell
+    - added ArrayFields#to_hash method - this seems like an obvious one to add!
+    - remedied bug where using append feature of assigning with unknow field
+      appedended but did not append to acutal fields
+    - added samples
+    - created rubyforge accnt @ http://rubyforge.org/projects/arrayfields/ 
+
+  3.2.0:
+    - precedence fix in many methods - thnx. nobu
+    - test for #slice! were not being run - corrected
+    - added test for appeding via "a['new_field'] = 42"
+
+  3.1.0:
+    - added FieldSet class to reduce ram - thnx. Kirk Haines for profiliing
+      memory and prompting this change
+
+    - interface changed every so slightly so
+
+        a.fields = 'a', 'b', 'c'
+
+      is not allowed.  use
+
+        a.fields = %w(a b c) 
+
+      or
+
+        a.fields = ['a', 'b', 'c']
+
+
+  3.0.0:
+    - added unit tests

data/VERSION

@@ -0,0 +1 @@
+3.6.0

data/gemspec.rb

@@ -0,0 +1,23 @@
+lib, version = File::basename(File::dirname(File::expand_path(__FILE__))).split %r/-/, 2
+
+require 'rubygems'
+
+Gem::Specification::new do |spec|
+  spec.name = lib 
+  spec.version = version 
+  spec.platform = Gem::Platform::RUBY
+  spec.summary = lib 
+
+  spec.files = Dir::glob "**/**"
+  spec.executables = Dir::glob("bin/*").map{|exe| File::basename exe}
+  
+  spec.require_path = "lib" 
+  spec.autorequire = lib
+
+  spec.has_rdoc = File::exist? "doc" 
+  spec.test_suite_file = "test/#{ lib }.rb" if File::directory? "test"
+
+  spec.author = "Ara T. Howard"
+  spec.email = "ara.t.howard@noaa.gov"
+  spec.homepage = "http://codeforpeople.com/lib/ruby/#{ lib }/"
+end

data/install.rb

@@ -0,0 +1,206 @@
+#!/usr/bin/env ruby
+require 'rbconfig'
+require 'find'
+require 'ftools'
+require 'tempfile'
+include Config
+
+LIBDIR      = "lib"
+LIBDIR_MODE = 0644
+
+BINDIR      = "bin"
+BINDIR_MODE = 0755
+
+
+$srcdir            = CONFIG["srcdir"]
+$version           = CONFIG["MAJOR"]+"."+CONFIG["MINOR"]
+$libdir            = File.join(CONFIG["libdir"], "ruby", $version)
+$archdir           = File.join($libdir, CONFIG["arch"])
+$site_libdir       = $:.find {|x| x =~ /site_ruby$/}
+$bindir            = CONFIG["bindir"] || CONFIG['BINDIR']
+$ruby_install_name = CONFIG['ruby_install_name'] || CONFIG['RUBY_INSTALL_NAME'] || 'ruby'
+$ruby_ext          = CONFIG['EXEEXT'] || ''
+$ruby              = File.join($bindir, ($ruby_install_name + $ruby_ext))
+
+if !$site_libdir
+  $site_libdir = File.join($libdir, "site_ruby")
+elsif $site_libdir !~ %r/#{Regexp.quote($version)}/
+  $site_libdir = File.join($site_libdir, $version)
+end
+
+def install_rb(srcdir=nil, destdir=nil, mode=nil, bin=nil)
+#{{{
+  path   = []
+  dir    = []
+  Find.find(srcdir) do |f|
+    next unless FileTest.file?(f)
+    next if (f = f[srcdir.length+1..-1]) == nil
+    next if (/CVS$/ =~ File.dirname(f))
+    next if f =~ %r/\.lnk/
+    path.push f
+    dir |= [File.dirname(f)]
+  end
+  for f in dir
+    next if f == "."
+    next if f == "CVS"
+    File::makedirs(File.join(destdir, f))
+  end
+  for f in path
+    next if (/\~$/ =~ f)
+    next if (/^\./ =~ File.basename(f))
+    unless bin
+      File::install(File.join(srcdir, f), File.join(destdir, f), mode, true)
+    else
+      from = File.join(srcdir, f)
+      to = File.join(destdir, f)
+      shebangify(from) do |sf|
+        $deferr.print from, " -> ", File::catname(from, to), "\n"
+        $deferr.printf "chmod %04o %s\n", mode, to 
+        File::install(sf, to, mode, false)
+      end
+    end
+  end
+#}}}
+end
+def shebangify f
+#{{{
+  open(f) do |fd|
+    buf = fd.read 42 
+    if buf =~ %r/^\s*#\s*!.*ruby/o
+      ftmp = Tempfile::new("#{ $$ }_#{ File::basename(f) }")
+      begin
+        fd.rewind
+        ftmp.puts "#!#{ $ruby  }"
+        while((buf = fd.read(8192)))
+          ftmp.write buf
+        end
+        ftmp.close
+        yield ftmp.path
+      ensure
+        ftmp.close!
+      end
+    else
+      yield f
+    end
+  end
+#}}}
+end
+def ARGV.switch
+#{{{
+  return nil if self.empty?
+  arg = self.shift
+  return nil if arg == '--'
+  if arg =~ /^-(.)(.*)/
+    return arg if $1 == '-'
+    raise 'unknown switch "-"' if $2.index('-')
+    self.unshift "-#{$2}" if $2.size > 0
+    "-#{$1}"
+  else
+    self.unshift arg
+    nil
+  end
+#}}}
+end
+def ARGV.req_arg
+#{{{
+  self.shift || raise('missing argument')
+#}}}
+end
+def linkify d, linked = []
+#--{{{
+  if test ?d, d
+    versioned = Dir[ File::join(d, "*-[0-9].[0-9].[0-9].rb") ]
+    versioned.each do |v| 
+      src, dst = v, v.gsub(%r/\-[\d\.]+\.rb$/, '.rb')
+      lnk = nil
+      begin
+        if test ?l, dst
+          lnk = "#{ dst }.lnk"
+          puts "#{ dst } -> #{ lnk }"
+          File::rename dst, lnk
+        end
+        unless test ?e, dst
+          puts "#{ src } -> #{ dst }"
+          File::copy src, dst 
+          linked << dst
+        end
+      ensure
+        if lnk
+          at_exit do
+            puts "#{ lnk } -> #{ dst }"
+            File::rename lnk, dst
+          end
+        end
+      end
+    end
+  end
+  linked
+#--}}}
+end
+
+
+#
+# main program
+#
+
+libdir = $site_libdir
+bindir = $bindir
+no_linkify = false
+linked = nil
+help = false
+
+usage = <<-usage
+  #{ File::basename $0 }
+    -d, --destdir    <destdir>
+    -l, --libdir     <libdir>
+    -b, --bindir     <bindir>
+    -r, --ruby       <ruby>
+    -n, --no_linkify
+    -s, --sudo
+    -h, --help
+usage
+
+begin
+  while switch = ARGV.switch
+    case switch
+    when '-d', '--destdir'
+      libdir = ARGV.req_arg
+    when '-l', '--libdir'
+      libdir = ARGV.req_arg
+    when '-b', '--bindir'
+      bindir = ARGV.req_arg
+    when '-r', '--ruby'
+      $ruby = ARGV.req_arg
+    when '-n', '--no_linkify'
+      no_linkify = true
+    when '-s', '--sudo'
+      sudo = 'sudo' 
+    when '-h', '--help'
+      help = true
+    else
+      raise "unknown switch #{switch.dump}"
+    end
+  end
+rescue
+  STDERR.puts $!.to_s
+  STDERR.puts usage
+  exit 1
+end    
+
+if help
+  STDOUT.puts usage
+  exit
+end
+
+unless no_linkify
+  linked = linkify('lib') + linkify('bin')
+end
+
+system "#{ $ruby } extconf.rb && make && #{ sudo } make install" if test(?s, 'extconf.rb')
+
+install_rb(LIBDIR, libdir, LIBDIR_MODE)
+install_rb(BINDIR, bindir, BINDIR_MODE, bin=true)
+
+if linked
+  linked.each{|path| File::rm_f path}
+end

data/lib/{arrayfields-3.5.0.rb → arrayfields-3.6.0.rb}

@@ -5,7 +5,7 @@
 #
   module ArrayFields 
 #{{{
-    VERSION = '3.5.0'
+    VERSION = '3.6.0'
   #
   # multiton cache of fields - wraps fields and fieldpos map to save memory
   #
@@ -45,9 +45,14 @@
         @fields = fields
 #}}}
       end
-      def pos field
-#{{{
-        @fieldpos[field]
+      def pos f
+#{{{
+        return @fieldpos[f] if @fieldpos.has_key? f 
+        f = f.to_s
+        return @fieldpos[f] if @fieldpos.has_key? f 
+        f = f.intern
+        return @fieldpos[f] if @fieldpos.has_key? f 
+        nil
 #}}}
       end
 #}}}

data/lib/arrayfields.rb

@@ -5,7 +5,7 @@
 #
   module ArrayFields 
 #{{{
-    VERSION = '3.5.0'
+    VERSION = '3.6.0'
   #
   # multiton cache of fields - wraps fields and fieldpos map to save memory
   #
@@ -45,9 +45,14 @@
         @fields = fields
 #}}}
       end
-      def pos field
-#{{{
-        @fieldpos[field]
+      def pos f
+#{{{
+        return @fieldpos[f] if @fieldpos.has_key? f 
+        f = f.to_s
+        return @fieldpos[f] if @fieldpos.has_key? f 
+        f = f.intern
+        return @fieldpos[f] if @fieldpos.has_key? f 
+        nil
 #}}}
       end
 #}}}

data/sample/a.rb

@@ -0,0 +1,66 @@
+#
+# you must require the arrayfields package
+#
+  $:.unshift 'lib'
+  $:.unshift '../lib'
+  $:.unshift '.'
+  require 'arrayfields'
+
+#
+# the class Array has only a few added method, one is for setting the fields,
+# when the fields are set for an array THIS INSTANCE ONLY will be modified to
+# allow keyword access.  other arrays will not be affected!
+#
+  a = [0,1,2]
+  fields = ['zero', 'one', 'two']
+  a.fields = fields                # ONLY the Array 'a' is affected!
+#
+# keyword access is now allowed for many methods
+#
+  p a['zero']                        #=> 0
+  p a['one']                         #=> 1
+  p a['two']                         #=> 2
+  p a.at('one')                      #=> 1
+  p a.values_at('zero', 'two')       #=> [0, 2]
+#
+# assigmnet is allowed
+#
+  a['zero'] = 42
+  p a['zero']                        #=> 0
+  a['zero'] = 0 
+#
+# assignment to non-fields results in the element being appended and the field
+# being added for future use (also appended)
+#
+  p(a.fields.join(','))                 #=> "zero, one, two"
+  p a['three']                          #=> nil
+  a['three'] = 3
+  p(a.fields.join(','))                 #=> "zero, one, two, three"
+  p a['three']                          #=> 3 
+#
+# other detructive methods are also keyword enabled
+#
+  a.fill 42, 'zero', len = a.size
+  p(a.values_at(a.fields))              #=> [42, 42, 42, 42]
+  a.replace [0,1,2,3]
+
+  a.slice! 'two', 2 
+  p a                                   #=> [0,1] 
+
+__END__
+
+the expected output of this program :
+
+0
+1
+2
+1
+[0, 2]
+42
+"zero,one,two"
+nil
+"zero,one,two,three"
+3
+[42, 42, 42, 42]
+[0, 1]
+

data/test/memtest.rb

@@ -0,0 +1,39 @@
+require 'lib/arrayfields'
+STDOUT.sync = true
+
+n = Integer((ARGV.shift or (2 ** 16)))
+
+#
+# hash mem usage - around 13016 on my machine
+#
+  fork do
+    a = []
+    n.times do  
+      a << {'a' => 0, 'b' => 1, 'c' => 2}
+    end
+
+    puts "pid <#{ Process.pid }>"
+    print "run top to examine mem usage of <#{ n }> hashes (enter when done) >"
+    STDIN.gets
+  end
+  Process.wait
+
+
+#
+# arrayfields mem usage - around 8752 on my machine
+#
+  fork do
+    fields = %w( a b c )
+    a = []
+    n.times do  
+      t = [0,1,2]
+      t.fields = fields
+      t.extend ArrayFields
+      a << [0,1,2]
+    end
+
+    puts "pid <#{ Process.pid }>"
+    print "run top to examine mem usage of <#{ n }> extended arrays (enter when done) >"
+    STDIN.gets
+  end
+  Process.wait

metadata

@@ -3,8 +3,8 @@ 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
+  version: 3.6.0
+date: 2006-08-23 00:00:00.000000 -06:00
 summary: arrayfields
 require_paths: 
   - lib
@@ -29,8 +29,18 @@ cert_chain:
 authors: 
   - Ara T. Howard
 files: 
+  - install.rb
+  - README
+  - VERSION
+  - gemspec.rb
+  - lib
+  - test
+  - sample
   - lib/arrayfields.rb
-  - lib/arrayfields-3.5.0.rb
+  - lib/arrayfields-3.6.0.rb
+  - test/arrayfields.rb
+  - test/memtest.rb
+  - sample/a.rb
 test_files: 
   - test/arrayfields.rb
 rdoc_options: []