attributes 3.7.0 → 4.0.0

data/README

@@ -11,17 +11,45 @@ URIS
 SYNOPSIS
   attributes.rb provides a set of attr_* like method with several user
   friendly additions.  attributes.rb is similar to the traits.rb package but
-  sacrifices a few features for simplicity of implementation: attributes.rb is
-  only 42 lines of code.
+  sacrifices a few features for simplicity of implementation.
 
-  the implimentation of attributes.rb borrows many of the best ideas from the
+  the implementation of attributes.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.
+  in particular the solutions of Christian Neukirchen and Florian Gross along
+  with concepts from the original traits lib
+
+  key features provided by attributes 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 attributes they've defined and this information is
+     available to client code
+
+    - a whole suite of methods is defined by calls to #attributes including
+     getter, setter, query (var?) and banger (var! - which forces
+     re-initialization from the default value)
+
+    - ability to define multiple attributes at once using key => value pairs
+
+    - fast lookup of whether or not a class has defined a certain attribute
+
+    - attributes can be defined on objects on a per singleton basis as well
+
+    - getters acts as setters if an argument is given to them
+
+  all this in < 100 lines of code
 
 HISTORY
+  4.0.0
+    - removed dependancy on, and bundle of, pervasives
+    - faster.  as fast as normal method definition.
+    - faster lookup for MyClass.attributes.include?('foobar')
+
   3.7.0
     small patch to use 'instance_variable_defined?' instead of defined?
     keyword
@@ -42,8 +70,7 @@ SAMPLES
   ~ > cat samples/a.rb
 
     #
-    # basic usage is like attr, but note that attribute defines three methods,
-    # getter, setter, and query
+    # basic usage is like attr, but note that attribute defines a suite of methods
     #
       require 'attributes'
     
@@ -53,16 +80,16 @@ SAMPLES
     
       c = C.new
     
-      c.a = 42              # setter
-      p c.a                 # getter
-      p 'forty-two' if c.a? # query
+      c.a = 42
+      p c.a                 #=> 42
+      p 'forty-two' if c.a? #=> 'forty-two'
     
     #
-    # also not that attribute(s) works as well for objects as classes
+    # attributes works on object too 
     #
       o = Object.new
       o.attribute 'answer' => 42
-      p o.answer
+      p o.answer           #=> 42
 
   ~ > ruby samples/a.rb
 
@@ -78,7 +105,9 @@ SAMPLES
     #
     # 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.
+    # 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 'attributes'
     
@@ -88,14 +117,20 @@ SAMPLES
       end
     
       c = C.new
+      p c.a #=> 42
+      p c.b #=> 42.0
     
-      p c.a
-      p c.b
+      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 >========>
@@ -113,7 +148,7 @@ SAMPLES
     
       c = C.new
       c.x = c.y + c.z
-      p c.x
+      p c.x #=> 42
 
   ~ > ruby samples/c.rb
 
@@ -191,5 +226,5 @@ SAMPLES
 
   ~ > ruby samples/e.rb
 
-    #<Config:0x1e834 @port=80, @host="codeforpeople.org">
+    #<Config:0x20080 @port=80, @host="codeforpeople.org">
 

data/README.tmpl

@@ -11,17 +11,45 @@ URIS
 SYNOPSIS
   attributes.rb provides a set of attr_* like method with several user
   friendly additions.  attributes.rb is similar to the traits.rb package but
-  sacrifices a few features for simplicity of implementation: attributes.rb is
-  only 42 lines of code.
+  sacrifices a few features for simplicity of implementation.
 
-  the implimentation of attributes.rb borrows many of the best ideas from the
+  the implementation of attributes.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.
+  in particular the solutions of Christian Neukirchen and Florian Gross along
+  with concepts from the original traits lib
+
+  key features provided by attributes 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 attributes they've defined and this information is
+     available to client code
+
+    - a whole suite of methods is defined by calls to #attributes including
+     getter, setter, query (var?) and banger (var! - which forces
+     re-initialization from the default value)
+
+    - ability to define multiple attributes at once using key => value pairs
+
+    - fast lookup of whether or not a class has defined a certain attribute
+
+    - attributes can be defined on objects on a per singleton basis as well
+
+    - getters acts as setters if an argument is given to them
+
+  all this in < 100 lines of code
 
 HISTORY
+  4.0.0
+    - removed dependancy on, and bundle of, pervasives
+    - faster.  as fast as normal method definition.
+    - faster lookup for MyClass.attributes.include?('foobar')
+
   3.7.0
     small patch to use 'instance_variable_defined?' instead of defined?
     keyword

data/a.rb

@@ -0,0 +1,29 @@
+require 'attributes'
+
+module M
+  p(( attribute 'a' => 42 ))
+  p(( attribute('b'){ "forty-two (#{ self })" } ))
+end
+p M.attributes
+p M.attributes.include?('a')
+p M.attributes.include?('b')
+p M.attributes.include?('c')
+
+class C
+  include M
+end
+p C.new.a
+p C.new.b
+p C.attributes
+p C.attributes.include?('a')
+p C.attributes.include?('b')
+p C.attributes.include?('c')
+
+class B < C
+end
+p B.new.a
+p B.new.b
+p B.attributes
+p B.attributes.include?('a')
+p B.attributes.include?('b')
+p B.attributes.include?('c')

data/lib/attributes-4.0.0.rb

@@ -0,0 +1,110 @@
+module Attributes
+  Attributes::VERSION = '4.0.0' unless defined? Attributes::VERSION
+  def self.version() Attributes::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 attributes *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 = __attributes__.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
+        __attributes__.initializers[name] = initializer
+
+        module_eval <<-code
+          def #{ name }=(value)
+            @#{ name } = value
+          end
+
+          def #{ name }(*value)
+            return self.#{ name } = value.first unless value.empty?
+            #{ name }! unless defined? @#{ name }
+            @#{ name }
+          end
+
+          def #{ name }!
+            initializer = ObjectSpace._id2ref #{ initializer_id }
+            self.#{ name } = initializer.call(self)
+            @#{ name }
+          end
+
+          def #{ name }?
+            defined? @#{ name } and #{ name }
+          end
+        code
+
+        attributes << name
+        returned[name] = initializer 
+      end
+
+      returned
+    else
+      begin
+        __attribute_list__
+      rescue NameError
+        singleton_class =
+          class << self
+            self
+          end
+        klass = self
+        singleton_class.module_eval do
+          attribute_list = List.new 
+          define_method('attribute_list'){ klass == self ? attribute_list : raise(NameError) }
+          alias_method '__attribute_list__', 'attribute_list'
+        end
+        __attribute_list__
+      end
+    end
+  end
+
+  %w( __attributes__ __attribute__ attribute ).each{|dst| alias_method dst, 'attributes'}
+end
+
+class Object
+  def attributes *a, &b
+    sc = 
+      class << self
+        self
+      end
+    sc.attributes *a, &b
+  end
+  %w( __attributes__ __attribute__ attribute ).each{|dst| alias_method dst, 'attributes'}
+end
+
+class Module
+  include Attributes
+end

data/lib/attributes.rb

@@ -1,46 +1,77 @@
 module Attributes
-  VERSION = '3.7.0'
-  def self.version() VERSION end
+  Attributes::VERSION = '4.0.0' unless defined? Attributes::VERSION
+  def self.version() Attributes::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 attributes *a, &b
     unless a.empty?
-      hashes, names = a.partition{|x| Hash === x}
+      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}
 
-      names_and_defaults.each do |name, default|
-        init = b || lambda { default }
-        ivar, getter, setter, query, banger =
-          "@#{ name }", "#{ name }", "#{ name }=", "#{ name }?", "#{ name }!"
+      initializers = __attributes__.initializers
 
-        raise NameError, "bad instance variable name '#{ ivar }'" if ivar =~ %r/[!?=]$/o
+      names_and_defaults.each do |name, default|
+        raise NameError, "bad instance variable name '@#{ name }'" if "@#{ name }" =~ %r/[!?=]$/o
+        name = name.to_s
 
-        define_method(setter) do |value|
-          __pervasive__('instance_variable_set', ivar, value)
+        initialize = b || lambda { default }
+        initializer = lambda do |this|
+          Object.instance_method('instance_eval').bind(this).call &initialize
         end
+        initializer_id = initializer.object_id
+        __attributes__.initializers[name] = initializer
 
-        define_method(getter) do |*value|
-          unless value.empty?
-            __pervasive__('send', setter, value.shift)
-          else
-            defined = __pervasive__('instance_variable_defined?', "#{ ivar }")
-            __pervasive__('send', setter, __pervasive__('instance_eval', &init)) unless defined
-            __pervasive__('instance_variable_get', ivar)
+        module_eval <<-code
+          def #{ name }=(value)
+            @#{ name } = value
           end
-        end
 
-        define_method(banger) do
-          __pervasive__('send', setter, __pervasive__('instance_eval', &init))
-          __pervasive__('instance_variable_get', ivar)
-        end
+          def #{ name }(*value)
+            return self.#{ name } = value.first unless value.empty?
+            #{ name }! unless defined? @#{ name }
+            @#{ name }
+          end
+
+          def #{ name }!
+            initializer = ObjectSpace._id2ref #{ initializer_id }
+            self.#{ name } = initializer.call(self)
+            @#{ name }
+          end
 
-        alias_method query, getter
+          def #{ name }?
+            defined? @#{ name } and #{ name }
+          end
+        code
 
-        (attributes << name.to_s).uniq!
-        attributes
+        attributes << name
+        returned[name] = initializer 
       end
+
+      returned
     else
       begin
         __attribute_list__
@@ -51,7 +82,7 @@ module Attributes
           end
         klass = self
         singleton_class.module_eval do
-          attribute_list = []
+          attribute_list = List.new 
           define_method('attribute_list'){ klass == self ? attribute_list : raise(NameError) }
           alias_method '__attribute_list__', 'attribute_list'
         end
@@ -77,47 +108,3 @@ end
 class Module
   include Attributes
 end
-
-BEGIN {
-  unless defined? Pervasives
-    begin
-      require 'pervasives'
-    rescue LoadError
-      module Pervasives
-        VERSION = "1.0.0"
-        def self.version() VERSION end
-        class ::Class 
-          def __pervasive__ m, *a, &b
-            (( Class.instance_method(m) rescue 
-               Module.instance_method(m) rescue 
-               Object.instance_method(m) )).bind(self).call(*a, &b)
-          end
-        end
-        class ::Module 
-          def __pervasive__ m, *a, &b
-            (( Module.instance_method(m) rescue 
-               Object.instance_method(m) )).bind(self).call(*a, &b)
-          end
-        end
-        class ::Object
-          def __pervasive__ m, *a, &b
-            (( Object.instance_method(m) )).bind(self).call(*a, &b)
-          end
-        end
-
-        class Proxy
-          instance_methods.each{|m| undef_method m unless m[%r/__/]}
-          def initialize obj
-            @obj = obj
-          end
-          def method_missing m, *a, &b
-            @obj.__pervasive__ m, *a, &b
-          end
-          def __obj__
-            @obj
-          end
-        end
-      end
-    end
-  end
-}

data/samples/a.rb

@@ -1,6 +1,5 @@
 #
-# basic usage is like attr, but note that attribute defines three methods,
-# getter, setter, and query
+# basic usage is like attr, but note that attribute defines a suite of methods
 #
   require 'attributes'
 
@@ -10,13 +9,13 @@
 
   c = C.new
 
-  c.a = 42              # setter
-  p c.a                 # getter
-  p 'forty-two' if c.a? # query
+  c.a = 42
+  p c.a                 #=> 42
+  p 'forty-two' if c.a? #=> 'forty-two'
 
 #
-# also not that attribute(s) works as well for objects as classes
+# attributes works on object too 
 #
   o = Object.new
   o.attribute 'answer' => 42
-  p o.answer
+  p o.answer           #=> 42

data/samples/b.rb

@@ -1,7 +1,9 @@
 #
 # 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.
+# 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 'attributes'
 
@@ -11,6 +13,10 @@
   end
 
   c = C.new
+  p c.a #=> 42
+  p c.b #=> 42.0
 
-  p c.a
-  p c.b
+  c.a = 43
+  p c.a #=> 43
+  c.a!
+  p c.a #=> 42

data/samples/c.rb

@@ -9,4 +9,4 @@
 
   c = C.new
   c.x = c.y + c.z
-  p c.x
+  p c.x #=> 42

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.2
 specification_version: 1
 name: attributes
 version: !ruby/object:Gem::Version 
-  version: 3.7.0
-date: 2007-09-15 00:00:00 -06:00
+  version: 4.0.0
+date: 2007-10-10 00:00:00 -06:00
 summary: attributes
 require_paths: 
 - lib
@@ -29,11 +29,12 @@ post_install_message:
 authors: 
 - Ara T. Howard
 files: 
+- a.rb
 - gemspec.rb
 - gen_readme.rb
 - install.rb
 - lib
-- lib/attributes-3.7.0.rb
+- lib/attributes-4.0.0.rb
 - lib/attributes.rb
 - README
 - README.tmpl

data/lib/attributes-3.7.0.rb

@@ -1,123 +0,0 @@
-module Attributes
-  VERSION = '3.7.0'
-  def self.version() VERSION end
-
-  def attributes *a, &b
-    unless a.empty?
-      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}
-
-      names_and_defaults.each do |name, default|
-        init = b || lambda { default }
-        ivar, getter, setter, query, banger =
-          "@#{ name }", "#{ name }", "#{ name }=", "#{ name }?", "#{ name }!"
-
-        raise NameError, "bad instance variable name '#{ ivar }'" if ivar =~ %r/[!?=]$/o
-
-        define_method(setter) do |value|
-          __pervasive__('instance_variable_set', ivar, value)
-        end
-
-        define_method(getter) do |*value|
-          unless value.empty?
-            __pervasive__('send', setter, value.shift)
-          else
-            defined = __pervasive__('instance_variable_defined?', "#{ ivar }")
-            __pervasive__('send', setter, __pervasive__('instance_eval', &init)) unless defined
-            __pervasive__('instance_variable_get', ivar)
-          end
-        end
-
-        define_method(banger) do
-          __pervasive__('send', setter, __pervasive__('instance_eval', &init))
-          __pervasive__('instance_variable_get', ivar)
-        end
-
-        alias_method query, getter
-
-        (attributes << name.to_s).uniq!
-        attributes
-      end
-    else
-      begin
-        __attribute_list__
-      rescue NameError
-        singleton_class =
-          class << self
-            self
-          end
-        klass = self
-        singleton_class.module_eval do
-          attribute_list = []
-          define_method('attribute_list'){ klass == self ? attribute_list : raise(NameError) }
-          alias_method '__attribute_list__', 'attribute_list'
-        end
-        __attribute_list__
-      end
-    end
-  end
-
-  %w( __attributes__ __attribute__ attribute ).each{|dst| alias_method dst, 'attributes'}
-end
-
-class Object
-  def attributes *a, &b
-    sc = 
-      class << self
-        self
-      end
-    sc.attributes *a, &b
-  end
-  %w( __attributes__ __attribute__ attribute ).each{|dst| alias_method dst, 'attributes'}
-end
-
-class Module
-  include Attributes
-end
-
-BEGIN {
-  unless defined? Pervasives
-    begin
-      require 'pervasives'
-    rescue LoadError
-      module Pervasives
-        VERSION = "1.0.0"
-        def self.version() VERSION end
-        class ::Class 
-          def __pervasive__ m, *a, &b
-            (( Class.instance_method(m) rescue 
-               Module.instance_method(m) rescue 
-               Object.instance_method(m) )).bind(self).call(*a, &b)
-          end
-        end
-        class ::Module 
-          def __pervasive__ m, *a, &b
-            (( Module.instance_method(m) rescue 
-               Object.instance_method(m) )).bind(self).call(*a, &b)
-          end
-        end
-        class ::Object
-          def __pervasive__ m, *a, &b
-            (( Object.instance_method(m) )).bind(self).call(*a, &b)
-          end
-        end
-
-        class Proxy
-          instance_methods.each{|m| undef_method m unless m[%r/__/]}
-          def initialize obj
-            @obj = obj
-          end
-          def method_missing m, *a, &b
-            @obj.__pervasive__ m, *a, &b
-          end
-          def __obj__
-            @obj
-          end
-        end
-      end
-    end
-  end
-}