attic 0.9.0.pre.rc2 → 1.0.0.pre.RC3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b8515c2812b3e4523d79d1fae98c348f041b4d6862d632e7a41ff4fb6555d7a
-  data.tar.gz: 29f3b9a07abb04e0d4611724a015ff8a0fcb704d7d8f3038d4ecd99ed6ae6768
+  metadata.gz: cd963a291df8b9b731adac87c5886f9f25b83606c7a171347d0e6e8396c98533
+  data.tar.gz: '0113974e4554b99b6061005f7d0218398592384d7bcd85f2fe4899b0d51232e9'
 SHA512:
-  metadata.gz: 37911f6e23435f00b28f5d75643d2e250ee760c9ddee7049b6296dc3f5eaf6a00a48a9a6d3c484e9e9fd24e3feb15b57afaf7cc33d1e9456be80a8383840a360
-  data.tar.gz: bf9811b8008f3d292c0be8087202785ada8fda996ba352194d8d77652fc997ef0c2d9fe324f710493459f6aa79939472569d11bd68a25b6e4c7c31021b8c9c05
+  metadata.gz: 92fcb090695086fcfa85472d69f8f2631054c035c99f3024f7cebc67b730e418c6ed650f2c8042f4c6882e6782c1febea6fc73768c43258e6e84d28d6219c149
+  data.tar.gz: a22f7131a2aca63c30bde0546c3ad0fdf77ef095b3d2cd5ed23853da02b314535c26771a900df059de056a76e32d50ad5e4802eab943736e9b423719ad036731

data/Gemfile.lock

@@ -5,7 +5,7 @@ GEM
     byebug (11.1.3)
     coderay (1.1.3)
     drydock (0.6.9)
-    json (2.7.1)
+    json (2.7.2)
     language_server-protocol (3.17.0.3)
     method_source (1.0.0)
     parallel (1.24.0)
@@ -46,8 +46,7 @@ GEM
     yard (0.9.36)
 
 PLATFORMS
-  arm64-darwin-23
-  ruby
+  arm64-darwin-22
 
 DEPENDENCIES
   byebug
@@ -57,7 +56,7 @@ DEPENDENCIES
   tryouts (= 2.2.0.pre.RC1)
 
 RUBY VERSION
-   ruby 3.1.4p223
+   ruby 3.2.0p0
 
 BUNDLED WITH
-   2.5.7
+   2.4.12

data/README.md

@@ -1,4 +1,4 @@
-# Attic - v1.0-RC1 (2023-03-15)
+# Attic - v1.0-RC1 (2024-04-01)
 
 A place to hide private instance variables in your Ruby objects: in the attic.
 
@@ -11,6 +11,7 @@ Like, _why though_? Well sometimes you want to hide thing from the public interf
 
 ### Example
 
+
 ```ruby
     require 'attic'
 
@@ -49,7 +50,7 @@ Like, _why though_? Well sometimes you want to hide thing from the public interf
 
 ### **Objects without singleton classes
 
-Symbol, Integer, Float, TrueClass, FalseClass, NilClass, and Fixnum are all objects that do not have singleton classes. TrueClass, FalseClass, and NilClass are all singletons themselves. Fixnum is a singleton of Integer.
+Symbol, Integer, Float, TrueClass, FalseClass, NilClass, and Integer are all objects that do not have singleton classes. TrueClass, FalseClass, and NilClass are all singletons themselves. Integer is a singleton of Integer.
 
 These objects do not have metaclasses so the attic is hidden in the object itself.
 
@@ -139,10 +140,6 @@ which produced the same results for both.
     ]
 ```
 
-## Credits
-
-* (@delano) Delano Mandelbaum
-
 
 ## License
 

data/attic.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = "attic"
-  s.version     = "0.9.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

@@ -21,8 +21,8 @@ module Attic
       # 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 have to
-      # keep trying to access its singleton class.
+      # object to the NoSingletonError list so we don't keep
+      # trying to access its singleton class over and over.
       !singleton_class.nil?
 
     rescue TypeError
@@ -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,8 +100,7 @@ require_relative "attic/instance_methods"
 # nil.attic.object_id #=> 800
 #
 module Attic
-  VERSION = '0.9.0-RC1'.freeze unless defined?(VERSION)
-  attr_reader :all_attic_variables
+  VERSION = '1.0.0-RC3'.freeze unless defined?(VERSION)
 
   # A convenince method at the class level for including
   # ConstructMethods in the given object specifically.
@@ -121,8 +120,10 @@ module Attic
     obj.include Attic::ClassMethods
   end
 
+  # Friendly exception to say we're not to be included
+  #
   def self.included(obj)
-    raise Runtime, "Did you to `extend Attic`` in #{obj}"
+    raise RuntimeError, "Did you mean to `extend Attic`` in #{obj}"
   end
 
   def self.extended(obj)
@@ -145,28 +146,29 @@ 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.
   # * +names+ 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 no names were
-  # given, returns the attic.
+  # Returns an Array of all attic variables for the current
+  # class unless no arguments are given in which case it
+  # returns its singleton.
   #
   # e.g.
   #
@@ -178,12 +180,12 @@ module Attic
   # * <tt>String#timestamp</tt> for setting the value
   #
   def attic(*names)
-    return all_attic_variables if names.empty?
+    return singleton_class if names.empty?
 
     names.each do |name|
       next if attic_variable? name
 
-      self.all_attic_variables << name
+      self.attic_variables << name
 
       unless method_defined?(name)
         define_method(name) do
@@ -198,7 +200,17 @@ module Attic
       end
     end
 
-    all_attic_variables
+    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.
@@ -208,12 +220,11 @@ module Attic
   #     String.attic :timestamp
   #     String.attic_variables     # => [:timestamp]
   #
-  # def attic_variables
-  #   a = attic.instance_variable_get('@attic_variables')
-  #   a ||= attic.instance_variable_set('@attic_variables', [])
-  #   a
-  # end
-  # alias attic_vars attic_variables
+  def attic_variables
+    a = attic.instance_variable_get('@attic_variables')
+    a ||= attic.instance_variable_set('@attic_variables', [])
+    a
+  end
 
   def attic_variable?(name)
     attic_variables.member? name

data/try/01_mixins_tryouts.rb

@@ -1,17 +1,65 @@
-require 'attic'
+require_relative '../lib/attic'
 
-## has metaclass", 'Object' do
-if Tryouts.sysinfo.ruby.to_s == "1.9.1"
-  Object.new.metaclass.superclass.to_s
-else
-  'Object'
-end
-#=> 'Object'
+#
+# Tests for the Object mixins that Attic relies on.
+#
+
+## Has a valid NoMetaClass exception class
+NoMetaClass < RuntimeError
+#=> true
 
-## has metametaclass", '#<Class:Object>' do
-if Tryouts.sysinfo.ruby.to_s >= "1.9.1"
-  Object.new.metaclass.superclass.to_s
-else
-  '#<Class:Object>'
+## Has a pre-populated array of built-ins without a metaclass
+begin
+    Object::NOMETACLASS
+rescue NameError => e
+    e.class
 end
-#=> 'Object'
+#=> NameError
+
+## Has Object#metaclass method
+Object.new.respond_to? :metaclass
+#=> false
+
+## Has Object#singleton_class method
+Object.new.respond_to? :singleton_class
+#=> true
+
+## Object#singleton_class is a class
+Object.new.singleton_class.class
+#=> Class
+
+## Object#singleton_class is a class
+Object.new.singleton_class.object_id.class
+#=> Integer
+
+## Object#singleton_class is a class
+a = Object.new
+b = Object.new
+a.singleton_class.object_id == b.singleton_class.object_id
+#=> false
+
+## Object#singleton_class is an Object class
+Object.new.singleton_class.superclass
+#=> Object
+
+## Object#singleton_class is equivalent to `class << self; self; end;`
+a = Object.new
+a.singleton_class == (class << a; self; end)
+#=> true
+
+## Integer doesn't have a singleton_class
+Integer.singleton_class?
+#=> false
+
+## Symbol doesn't have a singleton_class
+Symbol.singleton_class?
+#=> false
+
+## Object has a singleton_class
+Object.singleton_class?
+#=> false
+
+## Object#singleton_class is equivalent to Object#singleton_class
+a = Object.new
+a.singleton_class == a.singleton_class
+#=> true

data/try/10_attic_tryouts.rb

@@ -1,41 +1,51 @@
-require 'attic'
-  
-## can extend Attic
-class ::Worker
+require_relative '../lib/attic'
+
+#
+# Tests for the Attic module
+#
+
+## A class we define can extend Attic
+class ::ExampleClass
   extend Attic
-  def kind() :true end
+  def kind() :unlikely_value end
 end
-# 1.9                             # 1.8
-Worker.methods.member?(:attic) || Worker.methods.member?('attic')
+ExampleClass.methods.member?(:attic)
 #=> true
-  
-## can't include Attic raises exception
+
+## Trying to include Attic raises an exception
 begin
-  class ::Worker
+  class ::ExampleClass
     include Attic
   end
-rescue => RuntimeError
-  :success
+rescue => e
+  e.class
 end
-#=> :success
+#=> RuntimeError
 
-## can define attic attribute
-Worker.attic :size
-w = Worker.new
-#w.attic :size
-p Worker.instance_methods(false)
-p Worker.methods.sort
+## Can define attic variables at class level
+ExampleClass.attic :size
+w = ExampleClass.new
 w.respond_to? :size
-#=> true 
-  
-## can access attic attributes explicitly"
-w = Worker.new
+#=> true
+
+## Accessing attic vars at the instance level fails
+begin
+  w = ExampleClass.new
+  w.attic :size, 2
+rescue => e
+  e.class
+end
+#=> NoMethodError
+
+## Can access attic vars the long way though
+w = ExampleClass.new
 w.attic_variable_set :size, 2
 w.attic_variable_get :size
 #=> 2
-  
-## won't define a method if on already exists
-Worker.attic :kind
-a = Worker.new
+
+## Won't clobber an existing method with the same name
+## NOTE: But also won't tell you it didn't define the method
+ExampleClass.attic :kind
+a = ExampleClass.new
 a.kind
-#=> :true
+#=> :unlikely_value

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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: attic
 version: !ruby/object:Gem::Version
-  version: 0.9.0.pre.rc2
+  version: 1.0.0.pre.RC3
 platform: ruby
 authors:
 - Delano Mandelbaum
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-04-03 00:00:00.000000000 Z
+date: 2024-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -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
@@ -78,9 +77,6 @@ files:
 - try/25_string_tryouts.rb
 - try/30_nometaclass_tryouts.rb
 - try/40_explicit_accessor_tryouts.rb
-- try/X1_metaclasses.rb
-- try/X2_extending.rb
-- try/X3_nosingleton.rb
 homepage: https://github.com/delano/attic
 licenses:
 - MIT
@@ -100,7 +96,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.4.12
 signing_key:
 specification_version: 4
 summary: When in doubt, store it in the attic

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, Fixnum].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

data/try/X1_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]
-
-
-
-
-

data/try/X2_extending.rb

@@ -1,27 +0,0 @@
-$:.unshift './lib'
-require 'attic'
-
-class A 
-  extend Attic
-  attic :andy
-end
-
-class B < A
-  attic :size
-end
-
-class C
-  extend Attic
-  attic :third
-end
-
-a, b, c = A.new, B.new, C.new
-
-a.andy, b.andy = 1, 2
-
-p [a.respond_to?(:andy), b.respond_to?(:andy)] # true, true
-p [a.andy, b.andy]                             # 1, 2
-
-p [a.class.attic_vars, b.class.attic_vars, c.class.attic_vars]  
-
-

data/try/X3_nosingleton.rb

@@ -1,44 +0,0 @@
-
-
-# "".has_singleton_class? # => true
-# :"".has_singleton_class? # => false
-# 1.has_singleton_class? # =>
-# nil.has_singleton_class? # => false
-# NilClass.has_singleton_class? # => true
-
-# members = ["", :food, 1, 1.00000001, nil, NilClass, true, TrueClass]
-# members2 = members.clone
-
-# members.each_with_index do |member, idx|
-#   puts "member: #{member.inspect}"
-#   member2 = members2[idx]
-
-#   member.has_a_dedicated_singleton_class?  # => false
-#   member2.has_a_dedicated_singleton_class?  # => false
-#   member.bestow_a_singleton_class!
-#   member.has_a_dedicated_singleton_class?  # => true
-#   member2.has_a_dedicated_singleton_class?  # => false
-#   member2.bestow_a_singleton_class!
-#   member2.has_a_dedicated_singleton_class?  # => true
-
-#   member.singleton_class.object_id # => 600
-#   member2.singleton_class.object_id # => 700
-
-#   member.has_method?(:foo) # => false
-#   member.foo # => NoMethodError
-#   member.add_to_singleton_class(:foo)
-#   member.has_method?(:foo) # => true
-#   member.foo = :bar
-#   member.foo # => :bar
-#   member.foo.object_id # => 601
-
-#   member2.has_method?(:foo) # => false
-#   member2.foo # => NoMethodError
-#   member2.add_to_singleton_class(:foo)
-#   member2.has_method?(:foo) # => true
-#   member2.foo = :bar
-#   member2.foo # => :bar
-#   member2.foo.object_id # => 701
-
-#   member2.foo.object_id == member.foo.object_id # => false
-# end