fattr 1.1.0 → 2.0.0

data/README

@@ -5,15 +5,12 @@ INSTALL
   gem install fattrs
 
 URIS
-  http://codeforpeople.com/lib/ruby
+  http://github.com/ahoward/fattr
   http://rubyforge.org/projects/codeforpeople/
+  http://codeforpeople.com/
 
 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.
+  fattr.rb is a "fatter attr" for ruby
 
   the implementation of fattr.rb borrows many of the best ideas from the
   metakoans.rb ruby quiz
@@ -21,7 +18,7 @@ SYNOPSIS
     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
+  with concepts from my original traits.rb lib
 
   key features provided by fattrs are
 
@@ -49,7 +46,9 @@ SYNOPSIS
 
     - shortcuts for adding class/module level fattrs
 
-  all this in < 100 lines of code
+    - class inheritable attributes
+
+  all this in 156 lines of code
 
 SAMPLES
 
@@ -126,17 +125,17 @@ SAMPLES
   ~ > cat samples/c.rb
 
     #
-    # multiple values may by given, plain names and key/val pairs may be mixed.
+    # multiple name=>default pairs can be given 
     #
       require 'fattr'
     
       class C
-        fattrs 'x', 'y' => 0b101000, 'z' => 0b10
+        fattrs 'x' => 0b101000, 'y' => 0b10
       end
     
       c = C.new
-      c.x = c.y + c.z
-      p c.x #=> 42
+      z = c.x + c.y
+      p z #=> 42
 
   ~ > ruby samples/c.rb
 
@@ -206,7 +205,6 @@ SAMPLES
     
       conf = Config.new{
         host 'codeforpeople.org'
-    
         port 80
       }
     
@@ -214,7 +212,7 @@ SAMPLES
 
   ~ > ruby samples/e.rb
 
-    #<Config:0x2de88 @port=80, @host="codeforpeople.org">
+    #<Config:0x2cd1c @port=80, @host="codeforpeople.org">
 
 
   <========< samples/f.rb >========>
@@ -234,7 +232,7 @@ SAMPLES
           42 => 'DEBUG',
         }
     
-        class << self
+        class << Logging
           fattr 'level' => 42
           fattr('level_name'){ Level_names[level] }
         end
@@ -260,7 +258,7 @@ SAMPLES
       require 'fattr'
     
       class C
-        class << self
+        class << C
           fattr 'a' => 4
         end
     
@@ -274,8 +272,56 @@ SAMPLES
     "42"
 
 
+  <========< samples/h.rb >========>
+
+  ~ > cat samples/h.rb
+
+    #
+    # class variable inheritance is supported simply
+    #
+      require 'fattr'
+    
+      class A
+        Fattr :x, :default => 42, :inheritable => true
+      end
+    
+      class B < A
+      end
+    
+      class C < B
+      end
+    
+      p C.x #=> 42
+    
+      A.x = 42.0
+      B.x = 'forty-two'
+    
+      p A.x #=> 42.0
+      p B.x #=> 'forty-two'
+      p C.x #=> 42
+    
+      C.x! # re-initialize from closest ancestor (B)
+    
+      p A.x #=> 42.0
+      p B.x #=> 'forty-two'
+      p C.x #=> 'forty-two'
+
+  ~ > ruby samples/h.rb
+
+    42
+    42.0
+    "forty-two"
+    42
+    42.0
+    "forty-two"
+    "forty-two"
+
+
 
 HISTORY
+  2.0.0:
+    support class/module inheritable attributes
+
   1.1.0:
     ruby19 testing.  move to github.
 

data/README.erb

@@ -5,15 +5,12 @@ INSTALL
   gem install fattrs
 
 URIS
-  http://codeforpeople.com/lib/ruby
+  http://github.com/ahoward/fattr
   http://rubyforge.org/projects/codeforpeople/
+  http://codeforpeople.com/
 
 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.
+  fattr.rb is a "fatter attr" for ruby
 
   the implementation of fattr.rb borrows many of the best ideas from the
   metakoans.rb ruby quiz
@@ -21,7 +18,7 @@ SYNOPSIS
     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
+  with concepts from my original traits.rb lib
 
   key features provided by fattrs are
 
@@ -49,12 +46,17 @@ SYNOPSIS
 
     - shortcuts for adding class/module level fattrs
 
-  all this in < 100 lines of code
+    - class inheritable attributes
+
+  all this in 156 lines of code
 
 SAMPLES
 <%= samples %>
 
 HISTORY
+  2.0.0:
+    support class/module inheritable attributes
+
   1.1.0:
     ruby19 testing.  move to github.
 

data/Rakefile

@@ -64,6 +64,7 @@ task :gemspec do
 
           Gem::Specification::new do |spec|
             spec.name = #{ lib.inspect }
+            spec.description = 'fattr.rb is a "fatter attr" for ruby'  
             spec.version = #{ version.inspect }
             spec.platform = Gem::Platform::RUBY
             spec.summary = #{ lib.inspect }

data/fattr.gemspec

@@ -3,11 +3,12 @@
 
 Gem::Specification::new do |spec|
   spec.name = "fattr"
-  spec.version = "1.1.0"
+  spec.description = 'fattr.rb is a "fatter attr" for ruby'  
+  spec.version = "2.0.0"
   spec.platform = Gem::Platform::RUBY
   spec.summary = "fattr"
 
-  spec.files = ["fattr.gemspec", "lib", "lib/fattr.rb", "Rakefile", "README", "README.erb", "samples", "samples/a.rb", "samples/b.rb", "samples/c.rb", "samples/d.rb", "samples/e.rb", "samples/f.rb", "samples/g.rb", "test", "test/fattr.rb"]
+  spec.files = ["fattr.gemspec", "lib", "lib/fattr.rb", "Rakefile", "README", "README.erb", "samples", "samples/a.rb", "samples/b.rb", "samples/c.rb", "samples/d.rb", "samples/e.rb", "samples/f.rb", "samples/g.rb", "samples/h.rb", "test", "test/fattr.rb"]
   spec.executables = []
   
   

data/lib/fattr.rb

@@ -1,6 +1,6 @@
 module Fattr
-  Fattr::VERSION = '1.1.0' unless Fattr.const_defined?(:VERSION)
-  def self.version() Fattr::VERSION end
+  Fattr::Version = '2.0.0' unless Fattr.const_defined?(:Version)
+  def self.version() Fattr::Version end
 
   class List < ::Array
     def << element
@@ -13,12 +13,12 @@ module Fattr
 
     def index!
       @index ||= Hash.new
-      each{|element| @index[element] = true}
+      each{|element| @index[element.to_s] = true}
     end
 
-    def include? element
+    def include?(element)
       @index ||= Hash.new
-      @index[element] ? true : false
+      @index[element.to_s] ? true : false
     end
 
     def initializers
@@ -26,33 +26,79 @@ module Fattr
     end
   end
 
-  def fattrs *a, &b
-    unless a.empty?
+  def fattrs(*args, &block)
+    unless args.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}
+      args.flatten!
+      args.compact!
+
+      all_hashes = args.all?{|arg| Hash===arg}
+
+      names_and_configs = {}
+
+      if all_hashes
+        args.each do |hash|
+          hash.each do |key, val|
+            name = key.to_s
+            config = Hash===val ? val : {:default => val}
+            names_and_configs[name] = config
+          end
+        end
+      else
+        config = Hash===args.last ? args.pop : {}
+        names = args.select{|arg| Symbol===arg or String===arg}.map{|arg| arg.to_s}
+        names.each do |name|
+          names_and_configs[name] = config
+        end
+      end
 
       initializers = __fattrs__.initializers
 
-      names_and_defaults.each do |name, default|
-        raise NameError, "bad instance variable name '@#{ name }'" if "@#{ name }" =~ %r/[!?=]$/o
+      names_and_configs.each do |name, config|
+        raise(NameError, "bad instance variable name '@#{ name }'") if("@#{ name }" =~ %r/[!?=]$/o)
+
         name = name.to_s
 
-        initialize = b || lambda { default }
+        default = nil
+        default = config[:default] if config.has_key?(:default)
+        default = config['default'] if config.has_key?('default')
+
+        inheritable = false
+        if Class===self
+          inheritable = config[:inheritable] if config.has_key?(:inheritable)
+          inheritable = config['inheritable'] if config.has_key?('inheritable')
+        end
+
+        initialize = (
+          block || (
+            unless inheritable
+              lambda{ default }
+            else
+              lambda do
+                if ancestors[1..-1].any?{|ancestor| ancestor.Fattrs.include?(name)}
+                  ancestors[1].send(name)
+                else
+                  default
+                end
+              end
+            end
+          )
+        )
+
         initializer = lambda do |this|
-          Object.instance_method('instance_eval').bind(this).call &initialize
+          Object.instance_method('instance_eval').bind(this).call(&initialize)
         end
+
         initializer_id = initializer.object_id
+
         __fattrs__.initializers[name] = initializer
 
         compile = lambda do |code|
           begin
-            module_eval code
+            module_eval(code)
           rescue SyntaxError
-            raise SyntaxError, "\n#{ code }\n"
+            raise(SyntaxError, "\n#{ code }\n")
           end
         end
 
@@ -118,36 +164,30 @@ module Fattr
     end
   end
 
-  %w( __fattrs__ __fattr__ fattr ).each{|dst| alias_method dst, 'fattrs'}
+  %w( __fattrs__ __fattr__ fattr ).each{|dst| alias_method(dst, 'fattrs')}
 end
 
 class Module
   include Fattr
 
-  def Fattrs(*a, &b)
+  def Fattrs(*args, &block)
     class << self
       self
-    end.module_eval do
-      fattrs(*a, &b)
-    end
+    end.module_eval{ __fattrs__(*args, &block) }
   end
 
-  def Fattr(*a, &b)
+  def Fattr(*args, &block)
     class << self
       self
-    end.module_eval do
-      fattr(*a, &b)
-    end
+    end.module_eval{ __fattr__(*args, &block) }
   end
 end
 
 class Object
-  def fattrs *a, &b
-    sc = 
-      class << self
-        self
-      end
-    sc.fattrs *a, &b
+  def fattrs(*args, &block)
+    class << self
+      self
+    end.__fattrs__(*args, &block)
   end
-  %w( __fattrs__ __fattr__ fattr ).each{|dst| alias_method dst, 'fattrs'}
+  %w( __fattrs__ __fattr__ fattr ).each{|dst| alias_method(dst, 'fattrs')}
 end

data/samples/c.rb

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

data/samples/e.rb

@@ -11,7 +11,6 @@
 
   conf = Config.new{
     host 'codeforpeople.org'
-
     port 80
   }
 

data/samples/f.rb

@@ -11,7 +11,7 @@
       42 => 'DEBUG',
     }
 
-    class << self
+    class << Logging
       fattr 'level' => 42
       fattr('level_name'){ Level_names[level] }
     end

data/samples/g.rb

@@ -5,7 +5,7 @@
   require 'fattr'
 
   class C
-    class << self
+    class << C
       fattr 'a' => 4
     end
 

data/samples/h.rb

@@ -0,0 +1,29 @@
+#
+# class variable inheritance is supported simply
+#
+  require 'fattr'
+
+  class A
+    Fattr :x, :default => 42, :inheritable => true
+  end
+
+  class B < A
+  end
+
+  class C < B
+  end
+
+  p C.x #=> 42
+
+  A.x = 42.0
+  B.x = 'forty-two'
+
+  p A.x #=> 42.0
+  p B.x #=> 'forty-two'
+  p C.x #=> 42
+
+  C.x! # re-initialize from closest ancestor (B)
+
+  p A.x #=> 42.0
+  p B.x #=> 'forty-two'
+  p C.x #=> 'forty-two'

data/test/fattr.rb

@@ -60,6 +60,38 @@ Testing Fattr do
     m = Module.new{ Fattr :a => 42 }
     assert{ m.a==42 }
   end
+
+  testing 'that fattrs support simple class inheritable attributes' do
+    a = Class.new{ Fattr :x, :default => 42, :inheritable => true }
+    b = Class.new(a)
+    c = Class.new(b)
+    def a.name() 'a' end
+    def b.name() 'b' end
+    def c.name() 'c' end
+    assert{ c.x==42 }
+    assert{ b.x==42 }
+    assert{ a.x==42 }
+    assert{ b.x=42.0 }
+    assert{ b.x==42.0 }
+    assert{ a.x==42 }
+    assert{ a.x='forty-two' }
+    assert{ a.x=='forty-two' }
+    assert{ b.x==42.0 }
+    assert{ b.x! }
+    assert{ b.x=='forty-two' }
+    assert{ b.x='FORTY-TWO' }
+    assert{ c.x! }
+    assert{ c.x=='FORTY-TWO' }
+  end
+
+  testing 'a list of fattrs can be declared at once' do
+    list = %w( a b c )
+    c = Class.new{ fattrs list }
+    list.each do |attr|
+      assert{ c.fattrs.include?(attr.to_s) }
+      assert{ c.fattrs.include?(attr.to_sym) }
+    end
+  end
 end
 
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: fattr
 version: !ruby/object:Gem::Version 
-  version: 1.1.0
+  version: 2.0.0
 platform: ruby
 authors: 
 - Ara T. Howard
@@ -9,11 +9,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-09-28 00:00:00 -06:00
+date: 2009-10-11 00:00:00 -06:00
 default_executable: 
 dependencies: []
 
-description: 
+description: fattr.rb is a "fatter attr" for ruby
 email: ara.t.howard@gmail.com
 executables: []
 
@@ -23,12 +23,10 @@ extra_rdoc_files: []
 
 files: 
 - fattr.gemspec
-- lib
 - lib/fattr.rb
 - Rakefile
 - README
 - README.erb
-- samples
 - samples/a.rb
 - samples/b.rb
 - samples/c.rb
@@ -36,10 +34,12 @@ files:
 - samples/e.rb
 - samples/f.rb
 - samples/g.rb
-- test
+- samples/h.rb
 - test/fattr.rb
 has_rdoc: true
 homepage: http://github.com/ahoward/fattr/tree/master
+licenses: []
+
 post_install_message: 
 rdoc_options: []
 
@@ -60,9 +60,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: codeforpeople
-rubygems_version: 1.3.1
+rubygems_version: 1.3.5
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: fattr
 test_files: 
 - test/fattr.rb