traits 0.9.0 → 0.9.1

data/README.tmpl

@@ -0,0 +1,136 @@
+URLS
+
+  http://rubyforge.org/projects/codeforpeople/
+  http://codeforpeople.com/lib/ruby/traits
+
+ABOUT
+
+  traits.rb is set of attr_* like methods on steroids, caffeine, and botox.  it
+  encourages better living through meta-programming and uniform access
+  priciples. traits.rb supports smart inheritence of class attributes and a
+  fistful of hooks for veryifying and munging attr values.
+
+VERSION
+
+  0.9.1
+
+HISTORY
+
+  0.9.0
+    - luke kaines made quite a few suggestions and bug reports that enabled this
+      release including making a few methods indifferent about string/symbol
+      args/keys and the introduction of a simple method 'trait_init' that can be
+      used to create keyword based initializers, eg:
+
+        require 'traits'
+
+        class C
+          include TraitInit
+
+          trait :a, :type => Integer
+          trait :b, :type => Integer
+
+          def initialize opts = {}
+            trait_init opts
+          end
+        end
+
+        C::new :a => 4, :b => 2
+
+  0.8.0
+    - traits now supports a whole slew of hooks that can be registered to fire
+      pre or post setting an attribute, to cast a value to another type, to
+      munge a value destructively, to require only certain types, to require a
+      certain ducktype signature, and to validate arguments passed.  check out
+      sample/m.rb, sample/n.rb, or sample.o.rb to see it in action.  the
+      mechanism is quite flexible allowing method names, lambdas of varying
+      arity, and lists of either/or to be passed to any hook.
+
+    - you can find a gem for trais on codeforpeople - but i've still not coded
+      up automated updating from codeforpeople to rubyforge so it won't show up
+      as a remote gem yet.
+
+  0.7.0
+   - patched in the support i had written eariler for 'hooks' to be called
+     pre/post setting a trait. plus shortcut to 'validate' traits which simply
+     sets up a 'pre' hook which is used as a predicate.  eg:
+
+        class C; trait 'number', 'validate' => proc{|n| Numeric === n}
+
+     pre and post hooks are used in the same way, eg:
+
+        class C
+          trait 'a', 
+            'pre' => proc{|val| p "#{ val } to set with"},
+            'post' => proc{|val| p "#{ val } set"},
+        end
+
+     but the really cool thing is that all of these blocks are both passed the
+     value in question but also evaluate with 'self' set appropriately.  eg
+
+        class Car
+          positive_int = lambda{|n| Fixnum === n and n > 0}
+          legal = proc{|s| s < speed_limit}
+
+          trait 'speed_limit', 'validate' => positive_int, 'default' => 42
+          trait 'speed', 'validate' => legal
+        end
+
+        c = Car::new
+        c.speed = 115
+
+      works as you'd expect:
+
+        (eval):14:in `speed=': validation of speed=(115) failed! (ArgumentError)
+                from a.rb:13
+
+  0.6.0
+    - fixed bug in where a default trait given as an empty array, eg:
+
+        class C;  has 'a' => [];  end
+
+      was exploded into the empty list when passed to the setter to initialize
+      the default value.
+
+  0.5.0
+    - general code cleanup
+
+  0.4.0
+    - tweaked writer code so multiple values can be passed to setters
+    - tweaked method of running blocks to use instance_eval so explicit 'this'
+      arg is no longer needed (though it can still be used)
+
+  0.3.0
+    added ability of default values to be specified with block for deferred
+    context sensitive initialization (see sample/c.rb)
+
+  0.1.0
+
+    completely reworked impl so NO parsing of inspect strings is required -
+    it's all straight methods (albeit quite confusing ones) now.  the
+    interface is unchanged.
+
+  0.0.0
+
+    initial version
+
+
+AUTHOR
+
+  ara [dot] t [dot] howard [at] noaa [dot] gov
+
+SAMPLES
+
+  @samples
+
+CAVEATS
+
+  this library is experimental and subject to change - though it has not for
+  several versions and much of my code hinges is on it now so you can expect the
+  interface to be stable in the near future - the only changes planned are those
+  that fix bugs or add features.
+
+LICENSE
+
+  same as ruby's
+

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/gen_readme.rb

@@ -0,0 +1,29 @@
+$VERBOSE=nil
+def indent s, n = 2
+  ws = ' ' * n
+  s.gsub %r/^/, ws 
+end
+
+template = IO::read 'README.tmpl'
+
+samples = ''
+prompt = '~ > '
+
+Dir['sample/*'].each do |sample|
+  samples << "\n" << "  <========< #{ sample } >========>" << "\n\n"
+
+  cmd = "cat #{ sample }" 
+  samples << indent(prompt + cmd, 2) << "\n\n" 
+  samples << indent(`#{ cmd }`, 4) << "\n" 
+
+  cmd = "ruby #{ sample }" 
+  samples << indent(prompt + cmd, 2) << "\n\n" 
+
+  cmd = "ruby -I ./lib -r ./lib/traits.rb #{ sample }" 
+  samples << indent(`#{ cmd } 2>&1`, 4) << "\n" 
+end
+
+#samples.gsub! %r/^/, '  '
+
+readme  = template.gsub %r/^\s*@samples\s*$/, samples
+print readme 

data/install.rb

@@ -0,0 +1,201 @@
+#!/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
+    -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 '-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
+
+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/{traits-0.9.0.rb → traits-0.9.1.rb}

@@ -1,5 +1,5 @@
 $__TRAIT_DEBUG__ = ENV['__TRAIT_DEBUG__'] || ENV['TRAIT_DEBUG'] || ENV['DEBUG']
-$__TRAIT_VERSION__ = "0.9.0" 
+$__TRAIT_VERSION__ = "0.9.1" 
 
 class Object
 #--{{{
@@ -670,18 +670,44 @@ end
 
 module TraitInit
 #--{{{
-  def trait_init opts = {}
-#--{{{
-    opts.each do |k,v| 
-      k = "#{ k }"
-      if respond_to? k
-        send k, v
-      else
-        raise ArgumentError, "invalid trait -- #{ self.class }##{ k }"
+  module InstaceMethods
+    def trait_init *argv
+#--{{{
+      args, opts = argv.partition{|arg| not Hash === arg}
+      args.flatten!
+      opts = opts.inject({}){|h,h2| h.update h2}
+      msgs = r_traits
+      args.each{|arg| send msgs.shift, v}
+      opts.each do |k,v| 
+        k = "#{ k }"
+        if respond_to? k
+          send k, v
+        else
+          raise ArgumentError, "invalid trait -- #{ self.class }##{ k }"
+        end
       end
+#--}}}
     end
+    alias_method "traitinit", "trait_init"
+  end
+  module ClassMethods
+    def trait_initialize *a, &b
+      traits *a unless a.empty?
+      module_eval{
+        def initialize(*a, &b)
+          super() if defined? super
+          trait_init *a
+        end
+      }
+    end
+    alias_method "traitinitialize", "trait_initialize"
+  end
+  def self.included other
+#--{{{
+    other.extend ClassMethods
+    other.module_eval{ include InstaceMethods }
+    super
 #--}}}
   end
-  alias_method "traitinit", "trait_init"
 #--}}}
 end