attic 1.0.0.pre.RC2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 65eaa51d7ee74a1e97bef40a3cdb0c6cb8c78ca29e0cd8f8bb55e0cba641f664
-  data.tar.gz: fbc75d2a1063522b54edfc6d608a2f4599ac2b34c39a92aa400b138138f19cd8
+  metadata.gz: ba2c5122967296a766b52ac046951567c4daf3845596533f297936bb094155d4
+  data.tar.gz: ad4d86d50d03b6b48c8f05f5cf06c27ed2df348a2adf7ef3b038b4efed3c9337
 SHA512:
-  metadata.gz: 2a54f4d47b2aa70d9a8d6ee30578d5c06360e9e5c2ffd3c5dfa196086b40122dfee3d84b079cbabd9a24076262b8d8b4521d50a649fe111c3f8f3b80d20945da
-  data.tar.gz: b06ab0a4a824c1536046f4d36ee0a42ce0e5315e214ef398955cf45f7046c56937d93333102044a1a4607fbe4780dd176d0377569126320e81f623c220527c16
+  metadata.gz: d884ee454dd855cb09315b995c0705bbc4c327dc5ea397589e3b8e6143ed54d7cfb36bf01f62ba99404a62243523a1ee4c35c3d95ca53b319a5acbecab64d9b5
+  data.tar.gz: 6e2391ebb5e6ff55b1c27c475bacadbb9c67f5d1e770b79e762dfdf2cb9bc8a4c982b370cacb2ca2436d9f291101eef733a2af11b9727436f51415876f8af33f

data/.gitignore

@@ -11,8 +11,8 @@
 !LICENSE.txt
 .ruby-version
 appendonlydir
-Gemfile.lock
 etc/config
 log
 tmp
 vendor
+*.gem

data/Gemfile

@@ -2,9 +2,7 @@
 
 source "https://rubygems.org"
 
-ruby '>= 3.1'
-
-git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+ruby '>= 2.6.8', '< 4.0'
 
 # bundle install --without production
 # bundle install --with development
@@ -14,5 +12,5 @@ group "development" do
   gem "pry"
   gem "pry-doc"
   gem "rubocop"
-  gem "tryouts", '2.2.0.pre.RC1'
+  gem "tryouts", '~> 2.2.0'
 end

data/Gemfile.lock

@@ -47,6 +47,7 @@ GEM
 
 PLATFORMS
   arm64-darwin-22
+  ruby
 
 DEPENDENCIES
   byebug
@@ -59,4 +60,4 @@ RUBY VERSION
    ruby 3.2.0p0
 
 BUNDLED WITH
-   2.4.12
+   2.5.7

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"
   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"]
@@ -15,9 +15,8 @@ Gem::Specification.new do |s|
 
   s.required_ruby_version = Gem::Requirement.new(">= 2.6.0")
 
-  s.add_dependency "rake", ">= 13.0.6"
+  s.add_dependency "rake", "~> 13.0.6"
 
-  # Add development dependencies
   s.add_development_dependency "rspec", "~> 3.0"
   s.add_development_dependency "rubocop", "~> 1.0"
 end

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
@@ -25,6 +52,7 @@ module Attic
     end
 
     def attic_variable_set(name, val)
+      raise FrozenError, self, caller if frozen?
       attic_variables << name unless attic_variable? name
       attic.instance_variable_set("@___attic_#{name}", val)
     end

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'.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/10_attic_tryouts.rb

@@ -49,3 +49,14 @@ ExampleClass.attic :kind
 a = ExampleClass.new
 a.kind
 #=> :unlikely_value
+
+# If we try to add an attic variable to an instance,
+# we get an ArgumentError (we can only add attic vars
+# at the class level).
+a = ExampleClass.new
+begin
+  a.attic :colour
+rescue => e
+ e.class
+end
+#=> ArgumentError

data/try/15_frozen_attic_tryouts.rb

@@ -0,0 +1,67 @@
+require_relative '../lib/attic'
+
+# Tests for the frozen objects
+
+# A class we define can extend Attic
+class ::ExampleClass
+  extend Attic
+end
+
+ExampleClass.methods.member?(:attic)
+#=> true
+
+# Classes that extend Attic don't spawn frozen instances
+a = ExampleClass.new
+a.frozen?
+#=> false
+
+# Classes that extend Attic and have attic variables
+# also don't spawn frozen instances
+ExampleClass.attic :size
+a = ExampleClass.new
+a.frozen?
+#=> false
+
+# Instances can still freeze normally
+a = ExampleClass.new
+a.freeze
+a.frozen?
+#=> true
+
+# Instances can still freeze normally even if they
+# have attic with values
+ExampleClass.attic :size
+a = ExampleClass.new
+a.size = 2
+a.freeze
+[a.frozen?, a.size]
+#=> [true, 2]
+
+# Frozen instances can't have their attic vars changed either
+a = ExampleClass.new
+a.size = 2
+a.freeze
+begin
+  a.size = 3
+rescue => e
+  e.class
+end
+#=> FrozenError
+
+# Regardless of the behaviour of the instance itself, once
+# it's frozen, its singleton class is frozen too!
+a = ExampleClass.new
+a.freeze
+a.singleton_class.frozen?
+#=> true
+
+# Frozen instances can't have their attic vars changed either
+a = ExampleClass.new
+a.size = 2
+a.freeze
+begin
+  a.size = 3
+rescue => e
+  e.class
+end
+#=> FrozenError

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,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: attic
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.RC2
+  version: 1.0.0
 platform: ruby
 authors:
 - Delano Mandelbaum
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-04-04 00:00:00.000000000 Z
+date: 2024-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 13.0.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 13.0.6
 - !ruby/object:Gem::Dependency
@@ -69,11 +69,11 @@ 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
 - try/10_attic_tryouts.rb
+- try/15_frozen_attic_tryouts.rb
 - try/20_accessing_tryouts.rb
 - try/25_string_tryouts.rb
 - try/30_nometaclass_tryouts.rb
@@ -93,9 +93,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.4.12
 signing_key:

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