fattr 1.0.1

data/README

@@ -0,0 +1,252 @@
+NAME
+  fattr.rb
+
+INSTALL
+  gem install fattrs
+
+URIS
+  http://codeforpeople.com/lib/ruby
+  http://rubyforge.org/projects/codeforpeople/
+  http://codeforpeople.rubyforge.org/svn/
+
+SYNOPSIS
+  fattr.rb is a "fatter attr" for ruby.  fattr.rb supercedes attributes.rb as
+  that library, even though it added only one method to the global namespace,
+  collided too frequently with user code - in particular rails' code.
+
+  the implementation of fattr.rb borrows many of the best ideas from the
+  metakoans.rb ruby quiz
+
+    http://www.rubyquiz.com/quiz67.html
+
+  in particular the solutions of Christian Neukirchen and Florian Gross along
+  with concepts from the original traits.rb lib
+
+  key features provided by fattrs are
+
+    - ability to specify default values for attrs and definition time.  values
+      can be literal objects or blocks, which are evaluated in the context of
+      self to initialize the variable
+
+    - classes remember which fattrs they've defined and this information is
+     available to client code
+
+    - a whole suite of methods is defined by calls to #fattrs including
+     getter, setter, query (var?) and banger (var! - which forces
+     re-initialization from the default value/block)
+
+    - ability to define multiple fattrs at once using key => value pairs
+
+    - fast lookup of whether or not a class has defined a certain fattr
+
+    - fattrs can be defined on objects on a per singleton basis
+
+    - getters acts as setters if an argument is given to them
+
+    - block caching, calling an fattr with a block sets the instance
+      variable to that block
+
+  all this in < 100 lines of code
+
+HISTORY
+  5.0.0:
+    port from attributes.rb retaining all the same features of that version of
+    attributes.rb
+
+SAMPLES
+
+  <========< samples/a.rb >========>
+
+  ~ > cat samples/a.rb
+
+    #
+    # basic usage is like attr, but note that fattr defines a suite of methods
+    #
+      require 'fattr'
+    
+      class C
+        fattr 'a'
+      end
+    
+      c = C.new
+    
+      c.a = 42
+      p c.a                 #=> 42
+      p 'forty-two' if c.a? #=> 'forty-two'
+    
+    #
+    # fattrs works on object too 
+    #
+      o = Object.new
+      o.fattr 'answer' => 42
+      p o.answer           #=> 42
+
+  ~ > ruby samples/a.rb
+
+    42
+    "forty-two"
+    42
+
+
+  <========< samples/b.rb >========>
+
+  ~ > cat samples/b.rb
+
+    #
+    # default values may be given either directly or as a block which will be
+    # evaluated in the context of self.  in both cases (value or block) the
+    # default is set only once and only if needed - it's a lazy evaluation.  the
+    # 'banger' method can be used to re-initialize a variable at any point whether
+    # or not it's already been initialized.
+    #
+      require 'fattr'
+    
+      class C
+        fattr :a => 42
+        fattr(:b){ Float a }
+      end
+    
+      c = C.new
+      p c.a #=> 42
+      p c.b #=> 42.0
+    
+      c.a = 43
+      p c.a #=> 43
+      c.a!
+      p c.a #=> 42
+
+  ~ > ruby samples/b.rb
+
+    42
+    42.0
+    43
+    42
+
+
+  <========< samples/c.rb >========>
+
+  ~ > cat samples/c.rb
+
+    #
+    # multiple values may by given, plain names and key/val pairs may be mixed.
+    #
+      require 'fattr'
+    
+      class C
+        fattrs 'x', 'y' => 0b101000, 'z' => 0b10
+      end
+    
+      c = C.new
+      c.x = c.y + c.z
+      p c.x #=> 42
+
+  ~ > ruby samples/c.rb
+
+    42
+
+
+  <========< samples/d.rb >========>
+
+  ~ > cat samples/d.rb
+
+    #
+    # a nice feature is that all fattrs are enumerated in the class.  this,
+    # combined with the fact that the getter method is defined so as to delegate
+    # to the setter when an argument is given, means bulk initialization and/or
+    # fattr traversal is very easy.
+    #
+      require 'fattr'
+    
+      class C
+        fattrs %w( x y z )
+    
+        def fattrs
+          self.class.fattrs
+        end
+    
+        def initialize
+          fattrs.each_with_index{|a,i| send a, i}
+        end
+    
+        def to_hash
+          fattrs.inject({}){|h,a| h.update a => send(a)}
+        end
+    
+        def inspect
+          to_hash.inspect
+        end
+      end
+    
+      c = C.new
+      p c.fattrs 
+      p c 
+    
+      c.x 'forty-two' 
+      p c.x
+
+  ~ > ruby samples/d.rb
+
+    ["x", "y", "z"]
+    {"x"=>0, "y"=>1, "z"=>2}
+    "forty-two"
+
+
+  <========< samples/e.rb >========>
+
+  ~ > cat samples/e.rb
+
+    #
+    # my favourite element of fattrs is that getters can also be setters.
+    # this allows incredibly clean looking code like
+    #
+      require 'fattr'
+    
+      class Config
+        fattrs %w( host port)
+        def initialize(&block) instance_eval &block end
+      end
+    
+      conf = Config.new{
+        host 'codeforpeople.org'
+    
+        port 80
+      }
+    
+      p conf
+
+  ~ > ruby samples/e.rb
+
+    #<Config:0x22ab0 @port=80, @host="codeforpeople.org">
+
+
+  <========< samples/f.rb >========>
+
+  ~ > cat samples/f.rb
+
+    #
+    # of course fattrs works as well at class/module level as at instance
+    # level
+    #
+      require 'fattr'
+    
+      module Logging 
+        Level_names = {
+          0 => 'INFO',
+          # ...
+          42 => 'DEBUG',
+        }
+    
+        class << self
+          fattr 'level' => 42
+          fattr('level_name'){ Level_names[level] }
+        end
+      end
+    
+    p Logging.level
+    p Logging.level_name
+
+  ~ > ruby samples/f.rb
+
+    42
+    "DEBUG"
+

data/README.tmpl

@@ -0,0 +1,57 @@
+NAME
+  fattr.rb
+
+INSTALL
+  gem install fattrs
+
+URIS
+  http://codeforpeople.com/lib/ruby
+  http://rubyforge.org/projects/codeforpeople/
+  http://codeforpeople.rubyforge.org/svn/
+
+SYNOPSIS
+  fattr.rb is a "fatter attr" for ruby.  fattr.rb supercedes attributes.rb as
+  that library, even though it added only one method to the global namespace,
+  collided too frequently with user code - in particular rails' code.
+
+  the implementation of fattr.rb borrows many of the best ideas from the
+  metakoans.rb ruby quiz
+
+    http://www.rubyquiz.com/quiz67.html
+
+  in particular the solutions of Christian Neukirchen and Florian Gross along
+  with concepts from the original traits.rb lib
+
+  key features provided by fattrs are
+
+    - ability to specify default values for attrs and definition time.  values
+      can be literal objects or blocks, which are evaluated in the context of
+      self to initialize the variable
+
+    - classes remember which fattrs they've defined and this information is
+     available to client code
+
+    - a whole suite of methods is defined by calls to #fattrs including
+     getter, setter, query (var?) and banger (var! - which forces
+     re-initialization from the default value/block)
+
+    - ability to define multiple fattrs at once using key => value pairs
+
+    - fast lookup of whether or not a class has defined a certain fattr
+
+    - fattrs can be defined on objects on a per singleton basis
+
+    - getters acts as setters if an argument is given to them
+
+    - block caching, calling an fattr with a block sets the instance
+      variable to that block
+
+  all this in < 100 lines of code
+
+HISTORY
+  5.0.0:
+    port from attributes.rb retaining all the same features of that version of
+    attributes.rb
+
+SAMPLES
+  @samples

data/gemspec.rb

@@ -0,0 +1,28 @@
+
+lib, version = File::basename(File::dirname(File::expand_path(__FILE__))).split %r/-/, 2
+
+require 'rubygems'
+
+Gem::Specification::new do |spec|
+  $VERBOSE = nil
+  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.add_dependency 'pervasives', '>= 1.0'
+
+  spec.extensions << "extconf.rb" if File::exists? "extconf.rb"
+
+  spec.author = "Ara T. Howard"
+  spec.email = "ara.t.howard@gmail.com"
+  spec.homepage = "http://codeforpeople.com/lib/ruby/#{ lib }/"
+end

data/gen_readme.rb

@@ -0,0 +1,32 @@
+require 'pathname'
+
+$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 -Ilib #{ 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,214 @@
+#!/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 (/\.svn/ =~ File.dirname(f))
+    next if f =~ %r/\.lnk/
+    next if f =~ %r/\.svn/
+    next if f =~ %r/\.swp/
+    next if f =~ %r/\.svn/
+    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
+
+system "#{ sudo } #{ $ruby } pre-install.rb" if test(?s, 'pre-install.rb')
+
+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
+
+system "#{ sudo } #{ $ruby } post-install.rb" if test(?s, 'post-install.rb')

data/lib/fattr.rb

@@ -0,0 +1,125 @@
+module Fattr
+  Fattr::VERSION = '1.0.1' unless Fattr.const_defined?(:VERSION)
+  def self.version() Fattr::VERSION end
+
+  class List < ::Array
+    def << element
+      super
+      self
+    ensure
+      uniq!
+      index!
+    end
+
+    def index!
+      @index ||= Hash.new
+      each{|element| @index[element] = true}
+    end
+
+    def include? element
+      @index ||= Hash.new
+      @index[element] ? true : false
+    end
+
+    def initializers
+      @initializers ||= Hash.new
+    end
+  end
+
+  def fattrs *a, &b
+    unless a.empty?
+      returned = Hash.new
+
+      hashes, names = a.partition{|x| Hash === x}
+      names_and_defaults = {}
+      hashes.each{|h| names_and_defaults.update h}
+      names.flatten.compact.each{|name| names_and_defaults.update name => nil}
+
+      initializers = __fattrs__.initializers
+
+      names_and_defaults.each do |name, default|
+        raise NameError, "bad instance variable name '@#{ name }'" if "@#{ name }" =~ %r/[!?=]$/o
+        name = name.to_s
+
+        initialize = b || lambda { default }
+        initializer = lambda do |this|
+          Object.instance_method('instance_eval').bind(this).call &initialize
+        end
+        initializer_id = initializer.object_id
+        __fattrs__.initializers[name] = initializer
+
+      # setter, block invocation caches block
+        module_eval <<-code
+          def #{ name }=(*value, &block)
+            value.unshift block if block
+            @#{ name } = value.first
+          end
+        code
+
+      # getter, providing a value or block causes it to acts as setter
+        module_eval <<-code
+          def #{ name }(*value, &block)
+            value.unshift block if block
+            return self.send('#{ name }=', value.first) unless value.empty?
+            #{ name }! unless defined? @#{ name }
+            @#{ name }
+          end
+        code
+
+      # bang method re-calls any initializer given at declaration time
+        module_eval <<-code
+          def #{ name }!
+            initializer = ObjectSpace._id2ref #{ initializer_id }
+            self.#{ name } = initializer.call(self)
+            @#{ name }
+          end
+        code
+
+      # query simply defers to getter - cast to bool
+        module_eval <<-code
+          def #{ name }?
+            #{ name }
+          end
+        code
+
+        fattrs << name
+        returned[name] = initializer 
+      end
+
+      returned
+    else
+      begin
+        __fattr_list__
+      rescue NameError
+        singleton_class =
+          class << self
+            self
+          end
+        klass = self
+        singleton_class.module_eval do
+          fattr_list = List.new 
+          define_method('fattr_list'){ klass == self ? fattr_list : raise(NameError) }
+          alias_method '__fattr_list__', 'fattr_list'
+        end
+        __fattr_list__
+      end
+    end
+  end
+
+  %w( __fattrs__ __fattr__ fattr ).each{|dst| alias_method dst, 'fattrs'}
+end
+
+class Module
+  include Fattr
+end
+
+class Object
+  def fattrs *a, &b
+    sc = 
+      class << self
+        self
+      end
+    sc.fattrs *a, &b
+  end
+  %w( __fattrs__ __fattr__ fattr ).each{|dst| alias_method dst, 'fattrs'}
+end

data/samples/a.rb

@@ -0,0 +1,21 @@
+#
+# basic usage is like attr, but note that fattr defines a suite of methods
+#
+  require 'fattr'
+
+  class C
+    fattr 'a'
+  end
+
+  c = C.new
+
+  c.a = 42
+  p c.a                 #=> 42
+  p 'forty-two' if c.a? #=> 'forty-two'
+
+#
+# fattrs works on object too 
+#
+  o = Object.new
+  o.fattr 'answer' => 42
+  p o.answer           #=> 42

data/samples/b.rb

@@ -0,0 +1,22 @@
+#
+# default values may be given either directly or as a block which will be
+# evaluated in the context of self.  in both cases (value or block) the
+# default is set only once and only if needed - it's a lazy evaluation.  the
+# 'banger' method can be used to re-initialize a variable at any point whether
+# or not it's already been initialized.
+#
+  require 'fattr'
+
+  class C
+    fattr :a => 42
+    fattr(:b){ Float a }
+  end
+
+  c = C.new
+  p c.a #=> 42
+  p c.b #=> 42.0
+
+  c.a = 43
+  p c.a #=> 43
+  c.a!
+  p c.a #=> 42

data/samples/c.rb

@@ -0,0 +1,12 @@
+#
+# multiple values may by given, plain names and key/val pairs may be mixed.
+#
+  require 'fattr'
+
+  class C
+    fattrs 'x', 'y' => 0b101000, 'z' => 0b10
+  end
+
+  c = C.new
+  c.x = c.y + c.z
+  p c.x #=> 42

data/samples/d.rb

@@ -0,0 +1,34 @@
+#
+# a nice feature is that all fattrs are enumerated in the class.  this,
+# combined with the fact that the getter method is defined so as to delegate
+# to the setter when an argument is given, means bulk initialization and/or
+# fattr traversal is very easy.
+#
+  require 'fattr'
+
+  class C
+    fattrs %w( x y z )
+
+    def fattrs
+      self.class.fattrs
+    end
+
+    def initialize
+      fattrs.each_with_index{|a,i| send a, i}
+    end
+
+    def to_hash
+      fattrs.inject({}){|h,a| h.update a => send(a)}
+    end
+
+    def inspect
+      to_hash.inspect
+    end
+  end
+
+  c = C.new
+  p c.fattrs 
+  p c 
+
+  c.x 'forty-two' 
+  p c.x

data/samples/e.rb

@@ -0,0 +1,18 @@
+#
+# my favourite element of fattrs is that getters can also be setters.
+# this allows incredibly clean looking code like
+#
+  require 'fattr'
+
+  class Config
+    fattrs %w( host port)
+    def initialize(&block) instance_eval &block end
+  end
+
+  conf = Config.new{
+    host 'codeforpeople.org'
+
+    port 80
+  }
+
+  p conf

data/samples/f.rb

@@ -0,0 +1,21 @@
+#
+# of course fattrs works as well at class/module level as at instance
+# level
+#
+  require 'fattr'
+
+  module Logging 
+    Level_names = {
+      0 => 'INFO',
+      # ...
+      42 => 'DEBUG',
+    }
+
+    class << self
+      fattr 'level' => 42
+      fattr('level_name'){ Level_names[level] }
+    end
+  end
+
+p Logging.level
+p Logging.level_name

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification 
+name: fattr
+version: !ruby/object:Gem::Version 
+  version: 1.0.1
+platform: ruby
+authors: 
+- Ara T. Howard
+autorequire: fattr
+bindir: bin
+cert_chain: []
+
+date: 2008-02-12 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: ara.t.howard@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- gemspec.rb
+- gen_readme.rb
+- install.rb
+- lib
+- lib/fattr.rb
+- README
+- README.tmpl
+- samples
+- samples/a.rb
+- samples/b.rb
+- samples/c.rb
+- samples/d.rb
+- samples/e.rb
+- samples/f.rb
+has_rdoc: false
+homepage: http://codeforpeople.com/lib/ruby/fattr/
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: fattr
+test_files: []
+