attic 1.0.0.pre.RC2 → 1.0.0.pre.RC3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 65eaa51d7ee74a1e97bef40a3cdb0c6cb8c78ca29e0cd8f8bb55e0cba641f664
-  data.tar.gz: fbc75d2a1063522b54edfc6d608a2f4599ac2b34c39a92aa400b138138f19cd8
+  metadata.gz: cd963a291df8b9b731adac87c5886f9f25b83606c7a171347d0e6e8396c98533
+  data.tar.gz: '0113974e4554b99b6061005f7d0218398592384d7bcd85f2fe4899b0d51232e9'
 SHA512:
-  metadata.gz: 2a54f4d47b2aa70d9a8d6ee30578d5c06360e9e5c2ffd3c5dfa196086b40122dfee3d84b079cbabd9a24076262b8d8b4521d50a649fe111c3f8f3b80d20945da
-  data.tar.gz: b06ab0a4a824c1536046f4d36ee0a42ce0e5315e214ef398955cf45f7046c56937d93333102044a1a4607fbe4780dd176d0377569126320e81f623c220527c16
+  metadata.gz: 92fcb090695086fcfa85472d69f8f2631054c035c99f3024f7cebc67b730e418c6ed650f2c8042f4c6882e6782c1febea6fc73768c43258e6e84d28d6219c149
+  data.tar.gz: a22f7131a2aca63c30bde0546c3ad0fdf77ef095b3d2cd5ed23853da02b314535c26771a900df059de056a76e32d50ad5e4802eab943736e9b423719ad036731

data/attic.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = "attic"
-  s.version     = "1.0.0-RC2"
+  s.version     = "1.0.0-RC3"
   s.summary     = "When in doubt, store it in the attic"
   s.description = "Attic: a place to hide metadata about the class or variable itself (e.g. SHA hash summaries)."
   s.authors     = ["Delano Mandelbaum"]

data/lib/attic/class_methods.rb

@@ -40,6 +40,8 @@ module Attic
 
       safe_name = "@_attic_#{name}"
       instance_variable_set(safe_name, name)
+    rescue TypeError => e
+      raise NoSingletonError, name, caller
     end
 
     def attic_variable?(name)

data/lib/attic/instance_methods.rb

@@ -8,12 +8,39 @@ module Attic
   module InstanceMethods
 
     def attic
-      raise NoSingleton, self, caller unless attic?
+      raise NoSingletonError, self, caller unless attic?
 
       singleton_class
 
     rescue TypeError
-      NoSingleton.add_member self
+      NoSingletonError.add_member self
+    end
+
+    # A quick way to check if this object instance already has a
+    # dedicated singleton class. We like to know this upfront
+    # because this is where our attic variables are to be stored.
+    def attic?
+      return false if NoSingletonError.member? self
+
+      # NOTE: Calling this on an object for the first time lazily
+      # creates a singleton class for itself. Another way of doing
+      # the same thing is to attempt defining a singleton method
+      # for the object. In either case, objects that cannot have
+      # cannot have a dedicated singleton class (e.g. nil, true,
+      # false) will raise a TypeError. We rescue this and add the
+      # object to the NoSingletonError list so we don't keep
+      # trying to access its singleton class over and over.
+      #
+      # NOTE 2: Module#singleton_class? is only available for
+      # modules and classes (which are also modules); it is not
+      # available for instances of classes.
+      #
+      !singleton_class.nil?
+
+    rescue TypeError
+      # Remember for next time.
+      NoSingletonError.add_member self
+      false
     end
 
     def attic_variables

data/lib/attic.rb

@@ -100,7 +100,7 @@ require_relative "attic/instance_methods"
 # nil.attic.object_id #=> 800
 #
 module Attic
-  VERSION = '0.9.0-RC1'.freeze unless defined?(VERSION)
+  VERSION = '1.0.0-RC3'.freeze unless defined?(VERSION)
 
   # A convenince method at the class level for including
   # ConstructMethods in the given object specifically.
@@ -146,20 +146,20 @@ module Attic
       attic_vars = self.attic_variables.clone
       klass.attic.instance_variable_set("@attic_variables", attic_vars)
     end
-    if method_defined? :instance_variables
-      instance_variables_orig = instance_method(:instance_variables)
-      define_method :instance_variables do
-        ret = _instance_variables_orig.bind(self).call.clone
+    if obj.method_defined? :instance_variables
+      instance_variables_orig = obj.instance_method(:instance_variables)
+      obj.define_method :instance_variables do
+        ret = instance_variables_orig.bind(self).call.clone
         ret.reject! { |v| v.to_s =~ /^@___?attic/ }  # match 2 or 3 underscores
         ret
       end
-      define_method :all_instance_variables do
-        _instance_variables_orig.bind(self).call
+      obj.define_method :all_instance_variables do
+        instance_variables_orig.bind(self).call
       end
     end
 
   rescue TypeError => e
-    raise NoSingleton, obj, caller
+    raise NoSingletonError, obj, caller
   end
 
   # A class method for defining variables to store in the attic.
@@ -203,6 +203,16 @@ module Attic
     attic_variables  # only after defining new attic vars
   end
 
+  def attic?
+    return false if NoSingletonError.member? self
+
+    singleton_class?
+
+  rescue TypeError
+    NoSingletonError.add_member self
+    false
+  end
+
   # Returns an Array of attic variables for the current class.
   # e.g.
   #

data/try/20_accessing_tryouts.rb

@@ -1,29 +1,30 @@
-require 'attic'
+require_relative '../lib/attic'
+
 class ::Worker
   extend Attic
   attic :size
 end
 
-  
+
 ## save an instance variable the long way
 w = Worker.new
-w.metametaclass.instance_variable_set '@mattress', 'S&F'
-w.metametaclass.instance_variable_get '@mattress'
+w.attic.instance_variable_set '@mattress', 'S&F'
+w.attic.instance_variable_get '@mattress'
 #=> 'S&F'
-  
+
 ## save an instance variable the short way
 w = Worker.new
 w.size = :california_king
 w.size
 #=> :california_king
-  
+
 ## new instances don't cross streams
 w = Worker.new
 w.size
 #=> nil
-  
+
 ## instance variables are hidden
 w = Worker.new
-w.metametaclass.instance_variable_set '@mattress', 'S&F'
+w.attic.instance_variable_set '@mattress', 'S&F'
 w.instance_variables
 ## []

data/try/25_string_tryouts.rb

@@ -4,25 +4,25 @@ require 'attic'
     String.extend Attic
     String.respond_to? :attic
 #=> true
-  
+
 ## save an instance variable the long way
 s = ""
-s.metametaclass.instance_variable_set '@mattress', 'S&F'
-s.metametaclass.instance_variable_get '@mattress'
+s.attic.instance_variable_set '@mattress', 'S&F'
+s.attic.instance_variable_get '@mattress'
 #=> 'S&F'
 
 ## can create attributes
 String.attic :goodies
 #=> [:goodies]
-  
+
 ## save an instance variable the short way
 s = ""
 s.goodies = :california_king
 p s.instance_variables
-p s.attic_vars
+p s.attic_variables
 s.goodies
 #=> :california_king
-  
+
 ## String instances don't cross streams
 String.extend Attic
 String.attic :name

data/try/30_nometaclass_tryouts.rb

@@ -39,6 +39,14 @@ Symbol.extend Attic
 :any.attic?
 #=> false
 
+## A String's attic vars appear in `all_instance_variables` do
+String.extend Attic
+String.attic :_name
+a, b = 'String1', 'String2'
+a._name = :roger
+a.all_instance_variables
+#=> [:@___attic_name]
+
 ## A Symbol's attic vars appear in `all_instance_variables` do
 Symbol.extend Attic
 Symbol.attic :_name

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: attic
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.RC2
+  version: 1.0.0.pre.RC3
 platform: ruby
 authors:
 - Delano Mandelbaum
@@ -69,7 +69,6 @@ files:
 - attic.gemspec
 - lib/attic.rb
 - lib/attic/class_methods.rb
-- lib/attic/core_ext.rb
 - lib/attic/errors.rb
 - lib/attic/instance_methods.rb
 - try/01_mixins_tryouts.rb

data/lib/attic/core_ext.rb

@@ -1,70 +0,0 @@
-
-class NoMetaClass < RuntimeError
-end
-
-# = Object
-#
-# These methods are copied directly from _why's metaid.rb.
-# See: http://whytheluckystiff.net/articles/seeingMetaclassesClearly.html
-class Object
-
-  unless defined?(::Object::NOMETACLASS)
-    # An Array of classes which do not have metaclasses.
-    NOMETACLASS = [Symbol, Integer].freeze
-  end
-
-  def nometaclass?
-    NOMETACLASS.member?(self)
-  end
-
-  def metaclass?
-    !NOMETACLASS.member?(self.class)
-  end
-
-  # 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 !self.metaclass?
-      raise NoMetaClass, self
-    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