attic 0.3 → 0.3.1

data/CHANGES.txt

@@ -1,5 +1,9 @@
 ATTIC, CHANGES
 
+#### 0.3.1 (2009-07-13) ###############################
+
+CRIPES! I'd forgotten to update the gemspec. 
+
 
 #### 0.3 (2009-07-11) ###############################
 

data/attic.gemspec

@@ -1,7 +1,7 @@
 @spec = Gem::Specification.new do |s|
 	s.name = "attic"
   s.rubyforge_project = "attic"
-	s.version = "0.3"
+	s.version = "0.3.1"
 	s.summary = "A place for Ruby objects to hide instance variables."
 	s.description = s.summary
 	s.author = "Delano Mandelbaum"
@@ -39,6 +39,15 @@
   README.rdoc
   Rakefile
   attic.gemspec
+  lib/attic.rb
+  lib/attic/mixins.rb
+  lib/attic/mixins/object.rb
+  try/01_mixins_tryouts.rb
+  try/10_attic_tryouts.rb
+  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

@@ -0,0 +1,83 @@
+
+require 'attic/mixins'
+
+# = Attic
+#
+# A place to store instance variables. 
+#
+module Attic
+  VERSION = '0.3.1'
+  
+  def self.included(o)
+    raise "You probably meant to 'extend Attic' in #{o}"
+  end
+  
+  def self.extended(o)
+    ## NOTE: This is just a reminder for a more descerning way to 
+    ## include the meta methods, instead of using a global mixin. 
+    ##o.class_eval do
+    ##  include ObjectHelpers
+    ##end
+    
+    # Create an instance method that returns the attic variables. 
+    o.class_eval do
+      define_method :attic_vars do
+        self.class.attic_vars
+      end
+    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. 
+  # 
+  # Returns the list of attic variable names or if not junk was
+  # given, returns the metaclass. 
+  #
+  # e.g.
+  #  
+  #     String.extend Attic
+  #     String.attic :timestamp
+  #
+  # In this example, attic created two instance methods:
+  # * +String#timestamp+ for getting the value
+  # * +String#timestamp+ for setting the value
+  #
+  def attic *junk
+    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)
+    
+    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
+    
+    attic_vars
+  end
+  
+  # Returns an Array of attic variables for the current class. 
+  # e.g.
+  #
+  #     String.extend Attic
+  #     String.attic :timestamp
+  #     String.attic_vars           # => [:timestamp]
+  #
+  def attic_vars
+    metametaclass.instance_variable_get("@attic") || []
+  end
+  
+  
+end
+
+# - Module#instance_method returns an UnboundMethod
+#   - http://ruby-doc.org/core/classes/Module.html#M001659

data/lib/attic/mixins.rb

@@ -0,0 +1,3 @@
+
+require 'attic/mixins/object'
+

data/lib/attic/mixins/object.rb

@@ -0,0 +1,57 @@
+
+# = Object
+#
+# These methods are copied directly from _why's metaid.rb. 
+# See: http://whytheluckystiff.net/articles/seeingMetaclassesClearly.html
+class Object
+  
+  # An Array of classes which do not have metaclasses.
+  NOMETACLASS = [Symbol, Fixnum].freeze
+  
+  # A convenient method for getting the metaclass of the current object.
+  # i.e.
+  #
+  #     class << self; self; end;
+  #
+  # 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
+    else
+      class << self; self; end; 
+    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

data/try/01_mixins_tryouts.rb

@@ -0,0 +1,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
+  end
+end

data/try/10_attic_tryouts.rb

@@ -0,0 +1,28 @@
+group "Attic"
+library :attic, "lib"
+tryouts "Basics" do
+  
+  drill "can extend Attic", true do
+    class ::Worker
+      extend Attic
+    end
+    Worker.methods.member? :attic
+  end
+  
+  drill "can't include Attic raises exception", :exception, RuntimeError do
+    class ::Worker
+      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 :metamethods, Worker.methods.sort
+    w.respond_to? :size
+  end
+  
+end
+

data/try/20_accessing_tryouts.rb

@@ -0,0 +1,34 @@
+group "Attic"
+library :attic, "lib"
+tryouts "Setting and Getting" do
+  
+  setup do
+    class ::Worker
+      extend Attic
+      attic :size
+    end
+  end
+  
+  drill "save an instance variable the long way", 'S&F' do
+    w = Worker.new
+    w.metametaclass.instance_variable_set '@mattress', 'S&F'
+    w.metametaclass.instance_variable_get '@mattress'
+  end
+  
+  drill "save an instance variable the short way", :california_king do
+    w = Worker.new
+    w.size = :california_king
+    w.size
+  end
+  
+  drill "new instances don't cross streams", nil do
+    w = Worker.new
+    w.size
+  end
+  
+  drill "instance variables are hidden", [] do
+    w = Worker.new
+    w.metametaclass.instance_variable_set '@mattress', 'S&F'
+    w.instance_variables
+  end
+end

data/try/25_string_tryouts.rb

@@ -0,0 +1,38 @@
+group "Attic"
+library :attic, "lib"
+tryouts "String Setting and Getting" do
+
+  drill "String can extend Attic", true do
+    String.extend Attic
+    String.respond_to? :attic
+  end
+  
+  drill "save an instance variable the long way", 'S&F' do
+    s = ""
+    s.metametaclass.instance_variable_set '@mattress', 'S&F'
+    s.metametaclass.instance_variable_get '@mattress'
+  end
+
+  drill "can create attributes", [:goodies] do
+    String.attic :goodies
+  end
+  
+  drill "save an instance variable the short way", :california_king do
+    s = ""
+    s.goodies = :california_king
+    stash :ivars, s.instance_variables
+    stash :avars, s.attic_vars
+    s.goodies
+  end
+  
+  drill "String instances don't cross streams", false do
+    String.extend Attic
+    String.attic :name
+    a = "any"
+    a.name = :roger
+    a.name == "".name
+  end
+  
+  
+      
+end

data/try/30_nometaclass_tryouts.rb

@@ -0,0 +1,24 @@
+group "No Meta Class"
+library :attic, 'lib'
+tryouts "Basics" do
+  
+  dream :class, Array
+  dream [Symbol, Fixnum]
+  drill "has list of no metaclass classes" do
+    Object::NOMETACLASS
+  end
+  
+  drill "Symbol metaclass returns Symbol", Symbol do
+    :any.metaclass
+  end
+  
+  ## NOTE: fails
+  drill "Symbol instances don't cross streams", true do
+    Symbol.extend Attic
+    Symbol.attic :name
+    a = :any
+    a.name = :roger
+    [a.name, :another.name]
+  end
+  
+end

data/try/metaclasses.rb

@@ -0,0 +1,112 @@
+# $ 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]
+
+
+
+
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: attic
 version: !ruby/object:Gem::Version 
-  version: "0.3"
+  version: 0.3.1
 platform: ruby
 authors: 
 - Delano Mandelbaum
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-12 00:00:00 -04:00
+date: 2009-07-13 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -29,6 +29,15 @@ files:
 - README.rdoc
 - Rakefile
 - attic.gemspec
+- lib/attic.rb
+- lib/attic/mixins.rb
+- lib/attic/mixins/object.rb
+- try/01_mixins_tryouts.rb
+- try/10_attic_tryouts.rb
+- 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: []