attic 0.3.1 → 0.4.0

data/CHANGES.txt

@@ -1,10 +1,17 @@
 ATTIC, CHANGES
 
+
+#### 0.4.0 (2009-07-17) ###############################
+
+* ADDED: Support for objects that don't have metaclasses:
+  Currently: Symbols, Fixnum
+* CHANGE: Objects with no metaclass raise NoMetaClass exception. 
+
+
 #### 0.3.1 (2009-07-13) ###############################
 
 CRIPES! I'd forgotten to update the gemspec. 
 
-
 #### 0.3 (2009-07-11) ###############################
 
 NOTE: A complete re-write from 0.2
@@ -12,6 +19,7 @@ NOTE: A complete re-write from 0.2
 * FIXED: Now works on any Object except Symbol and Fixnum
 * ADDED: attic_vars method
 
+
 #### 0.2 (2009-07-08) ###############################
 
 NOTE: Initial public release

data/README.rdoc

@@ -1,12 +1,10 @@
-= Attic - v0.3 ALPHA
+= Attic - v0.4 ALPHA
 
 A place for Ruby objects to hide instance variables.
 
 == Alpha Notice
 
-This library is fresh (est 2009-07-06) and barely tested. It's fun to use but not reliable yet. In particular:
-
-* Does not work with Symbols or Fixnum object
+This library is fresh (est 2009-07-06) and barely tested. It's fun to use but not reliable yet.
 
 == Example
 
@@ -19,8 +17,13 @@ This library is fresh (est 2009-07-06) and barely tested. It's fun to use but no
     a.timestamp = "1980-11-18"
     a.instance_variables          # => []
     a.timestamp                   # 1980-11-18
-    
-    
+
+ 
+== Some objects have no metaclasses
+
+Symbol and Fixnum objects do not have metaclasses so instance variables are hidden in the object itself.
+
+
 == Installation
 
 Via Rubygems, one of:

data/Rakefile

@@ -1,7 +1,7 @@
 require 'rubygems'
 require 'rake/clean'
 require 'rake/gempackagetask'
-require 'rake/rdoctask'
+require 'hanna/rdoctask'
 require 'fileutils'
 include FileUtils
  

data/attic.gemspec

@@ -1,7 +1,7 @@
 @spec = Gem::Specification.new do |s|
 	s.name = "attic"
   s.rubyforge_project = "attic"
-	s.version = "0.3.1"
+	s.version = "0.4.0"
 	s.summary = "A place for Ruby objects to hide instance variables."
 	s.description = s.summary
 	s.author = "Delano Mandelbaum"
@@ -47,7 +47,6 @@
   try/20_accessing_tryouts.rb
   try/25_string_tryouts.rb
   try/30_nometaclass_tryouts.rb
-  try/metaclasses.rb
   )
   
   s.has_rdoc = true

data/lib/attic.rb

@@ -6,7 +6,7 @@ require 'attic/mixins'
 # A place to store instance variables. 
 #
 module Attic
-  VERSION = '0.3.1'
+  VERSION = '0.4.0'
   
   def self.included(o)
     raise "You probably meant to 'extend Attic' in #{o}"
@@ -27,6 +27,47 @@ module Attic
     end
   end
   
+  # Create instance methods that store variables in the metaclass. 
+  @@metaclass_proc = proc { |klass,name|
+    klass.class_eval do
+      # Add the attic variables named to the list. Notice that we
+      # cheakily store this in the metameta class so as to not 
+      # disturb the metaclass instance variables. 
+      vars = attic_vars << name
+      metametaclass.instance_variable_set("@attic", vars)
+      
+      define_method(name) do
+        metaclass.instance_variable_get("@#{name}")
+      end
+      define_method("#{name}=") do |val|
+        metaclass.instance_variable_set("@#{name}", val)
+      end
+    end
+  }
+  
+  # Create instance methods that store variables in unlikely instance vars.
+  @@nometaclass_proc = proc { |klass,name|
+    klass.class_eval do
+      # Add the attic variables named to the list. We use a 
+      # variable with 3 underscores to prevent collisions. 
+      vars = attic_vars << name
+      instance_variable_set("@___attic_vars", vars)
+      
+      define_method(name) do
+        instance_variable_get("@__attic_#{name}")
+      end
+      define_method("#{name}=") do |val|
+        instance_variable_set("@__attic_#{name}", val)
+      end
+      define_method :instance_variables do |*args|
+        ret = super *args
+        ret.reject! { |v| v.to_s =~ /^@___?attic/ }  # match 2 or 3 underscores
+        ret
+      end
+    end
+  }
+
+  
   # A class method for defining variables to store in the attic. 
   # * +junk+ is a list of variables names. Accessor methods are 
   #   created for each variable name in the list. 
@@ -40,26 +81,17 @@ module Attic
   #     String.attic :timestamp
   #
   # In this example, attic created two instance methods:
-  # * +String#timestamp+ for getting the value
-  # * +String#timestamp+ for setting the value
+  # * <tt>String#timestamp</tt> for getting the value
+  # * <tt>String#timestamp</tt> for setting the value
   #
   def attic *junk
+    #p [:attic, self, metaclass?]
     return metaclass if junk.empty?
     
-    # Add the attic variables named to the list. Notice that we
-    # cheakily store this in the metameta class so as to not 
-    # disturb the metaclass instance variables. 
-    metametaclass.instance_variable_set("@attic", [attic_vars, *junk].flatten)
+    processor = metaclass? ? @@metaclass_proc : @@nometaclass_proc
     
-    junk.each do |name|
-      class_eval do
-        define_method(name) do
-          metaclass.instance_variable_get("@#{name}")
-        end
-        define_method("#{name}=") do |val|
-          metaclass.instance_variable_set("@#{name}", val)
-        end
-      end
+    junk.each do |var|
+      processor.call(self, var)
     end
     
     attic_vars
@@ -73,7 +105,11 @@ module Attic
   #     String.attic_vars           # => [:timestamp]
   #
   def attic_vars
-    metametaclass.instance_variable_get("@attic") || []
+    if metaclass?
+      metametaclass.instance_variable_get("@attic") || []
+    else
+      instance_variable_get("@___attic_vars") || []
+    end
   end
   
   

data/lib/attic/mixins/object.rb

@@ -1,3 +1,5 @@
+class NoMetaClass < RuntimeError
+end
 
 # = Object
 #
@@ -8,6 +10,13 @@ class Object
   # An Array of classes which do not have metaclasses.
   NOMETACLASS = [Symbol, Fixnum].freeze
   
+  def metaclass?
+    #p [:metaclass?, self, !NOMETACLASS.member?(self)]
+    !NOMETACLASS.member?(self)
+  end
+  
+  # FIX: metaclass should check self or self.class? ??? Check previous version
+  
   # A convenient method for getting the metaclass of the current object.
   # i.e.
   #
@@ -16,9 +25,10 @@ class Object
   # NOTE: Some Ruby class do not have meta classes (see: NOMETACLASS). 
   # For these classes, this method returns the class itself. That means
   # the instance variables will stored in the class itself. 
-  def metaclass;
-    if NOMETACLASS.member? self.class
-      self.class
+  def metaclass
+    #p [:metaclass, self, self.class, self.class.metaclass?]
+    if !self.class.metaclass?
+      raise NoMetaClass, self
     else
       class << self; self; end; 
     end

data/try/01_mixins_tryouts.rb

@@ -2,11 +2,12 @@ group "Mixins"
 library :attic, 'lib'
 
 tryouts "Object" do
-  drill "has metaclass", 'Object' do
-    Object.new.metaclass.superclass.to_s
-  end
-  
-  drill "has metametaclass", '#<Class:Object>' do
-    Object.new.metametaclass.superclass.to_s
+  if Tryouts.sysinfo.ruby == "1.9.1"
+    drill "has metaclass", 'Object' do
+      Object.new.metaclass.superclass.to_s
+    end
+    drill "has metametaclass", '#<Class:Object>' do
+      Object.new.metametaclass.superclass.to_s
+    end
   end
 end

data/try/10_attic_tryouts.rb

@@ -6,7 +6,8 @@ tryouts "Basics" do
     class ::Worker
       extend Attic
     end
-    Worker.methods.member? :attic
+    # 1.9                             # 1.8
+    Worker.methods.member?(:attic) || Worker.methods.member?('attic')
   end
   
   drill "can't include Attic raises exception", :exception, RuntimeError do
@@ -14,15 +15,16 @@ tryouts "Basics" do
       include Attic
     end
   end
-  
+
   drill "can define attic attribute", true do
     Worker.attic :size
     w = Worker.new
     #w.attic :size
-    stash :methods, w.methods.sort
+    stash :instance_methods, Worker.instance_methods(false)
     stash :metamethods, Worker.methods.sort
     w.respond_to? :size
   end
   
 end
 
+

data/try/30_nometaclass_tryouts.rb

@@ -8,12 +8,13 @@ tryouts "Basics" do
     Object::NOMETACLASS
   end
   
-  drill "Symbol metaclass returns Symbol", Symbol do
-    :any.metaclass
+  dream :exception, NoMetaClass
+  drill "Symbol metaclass raises exception" do
+   :any.metaclass
   end
   
   ## NOTE: fails
-  drill "Symbol instances don't cross streams", true do
+  drill "Symbol instances don't cross streams", [:roger, nil] do
     Symbol.extend Attic
     Symbol.attic :name
     a = :any
@@ -21,4 +22,13 @@ tryouts "Basics" do
     [a.name, :another.name]
   end
   
+  drill "metaclass? method exists", true do
+    Symbol.extend Attic
+    :any.respond_to? :metaclass?
+  end
+  
+  drill "metaclass? method is false for a Symbol", false do
+    :any.class.metaclass?
+  end
+  
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: attic
 version: !ruby/object:Gem::Version 
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors: 
 - Delano Mandelbaum
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-13 00:00:00 -04:00
+date: 2009-07-17 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -37,7 +37,6 @@ files:
 - try/20_accessing_tryouts.rb
 - try/25_string_tryouts.rb
 - try/30_nometaclass_tryouts.rb
-- try/metaclasses.rb
 has_rdoc: true
 homepage: http://github.com/delano/attic
 licenses: []

data/try/metaclasses.rb

@@ -1,112 +0,0 @@
-# $ ruby tryouts/metaclasses.rb
-
-class Object
-  
-  # A convenient method for getting the metaclass of the current object.
-  # i.e.
-  #
-  #     class << self; self; end;
-  #
-  def metaclass; class << self; self; end; end
-
-  # Execute a block +&blk+ within the metaclass of the current object.
-  def meta_eval &blk; metaclass.instance_eval &blk; end
-  
-  # Add an instance method called +name+ to metaclass for the current object.
-  # This is useful because it will be available as a singleton method
-  # to all subclasses too. 
-  def meta_def name, &blk
-    meta_eval { define_method name, &blk }
-  end
-  
-  # Add a class method called +name+ for the current object's class. This
-  # isn't so special but it maintains consistency with meta_def. 
-  def class_def name, &blk
-    class_eval { define_method name, &blk }
-  end
-
-  
-  # A convenient method for getting the metaclass of the metaclass
-  # i.e.
-  #
-  #     self.metaclass.metaclass
-  #
-  def metametaclass; self.metaclass.metaclass; end
-
-  def metameta_eval &blk; metametaclass.instance_eval &blk; end
-
-  def metameta_def name, &blk
-    metameta_eval { define_method name, &blk }
-  end
-  
-end
-
-# Create an instance method
-class NamedArray1
-  class_eval do
-    define_method(:name) do
-      :roger
-    end
-  end
-end
-p [1, NamedArray1.new.name]
-
-# Create getter and setter instance methods
-class NamedArray2
-  class_eval do
-    define_method(:name) do
-      instance_variable_get("@name")
-    end
-    define_method(:name=) do |val|
-      instance_variable_set("@name", val)
-    end
-  end
-end
-a = NamedArray2.new
-a.name = :roger
-p [2, a.name, a.instance_variables]
-
-# Create getter and setter instance methods,
-# store instance variable in metaclass
-class NamedArray3
-  class_eval do
-    define_method(:name) do
-      metaclass.instance_variable_get("@name")
-    end
-    define_method(:name=) do |val|
-      metaclass.instance_variable_set("@name", val)
-    end
-  end
-end
-a = NamedArray3.new
-a.name = :roger
-p [3, a.name, a.instance_variables, a.metaclass.instance_variables]
-
-# Create a module with the which puts the functionality 
-# in NamedArray3 into a class method. 
-module StorageArea
-  def store *junk
-    junk.each do |name|
-      class_eval do
-        define_method(name) do
-          metaclass.instance_variable_get("@#{name}")
-        end
-        define_method("#{name}=") do |val|
-          metaclass.instance_variable_set("@#{name}", val)
-        end
-      end
-    end
-  end
-end
-class NamedArray4
-  extend StorageArea
-  store :name
-end
-a = NamedArray4.new
-a.name = :roger
-p [4, a.name, a.instance_variables, a.metaclass.instance_variables]
-
-
-
-
-