init_copy 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1620d2aa498e981be870fd3e0d671595b0407e557b54e40cf7e32b38b95158a8
-  data.tar.gz: 1b08062be47d208e59ed5a70e548f726d55936ccc000a84bbda5b2ed47119360
+  metadata.gz: f2ea381fdf2b5c0bec710f2b219f87e2f897e8bba17246591982617e02a5024c
+  data.tar.gz: c33f202bb2301400918c86fc49a8acf0a43be8f82f5e7e2df1dc6ca9935fc4c4
 SHA512:
-  metadata.gz: 17b1bc267564f9f49c5b699581f522690bc13a63addbab7708bbb6af227970f3701c0f259d00d0d42b4c898e5b349324672b416395d5d0d34be151cf48994db0
-  data.tar.gz: e2973b90f3bd28a061904a1db08435b2f2a5af11c2a7bc4d14ce1a40bfbc7837099b0c8c786ea39b064714b041d87994420890ff6f6ae30afb621dac6f31d89b
+  metadata.gz: 36b93091f59641bf0ea2fc2a7c520815f285e24aa5136d7e03c1e837811084f2b62e6040f82e98a1facd9e6b0930834558f7df7783cfe01a60a17b20d99152c9
+  data.tar.gz: fb2e3f6d74272af1061f73794814874bdb7d76f16c7998fdd9cfd41d1c5d17a7eda9985a0e0724be9fa16e1a55ba64f557ae431d93eff9a2637fc6bffab1312f

data/.rdoc_options

@@ -11,6 +11,7 @@ embed_mixins: true
 force_update: true
 hyperlink_all: true
 line_numbers: true
+markup: markdown
 show_hash: true
 skip_tests: true
 

data/Gemfile

@@ -6,11 +6,11 @@ source 'https://rubygems.org'
 gemspec
 
 group :development,:test do
-  gem 'bundler'   ,'~> 2.6'
-  gem 'rake'      ,'~> 13.3'
-  gem 'rdoc'      ,'~> 6.14'
+  gem 'bundler' ,'~>  2.6 '
+  gem 'rake'    ,'~> 13.3 '
+  gem 'rdoc'    ,'~>  6.14'
 end
 
 group :test do
-  gem 'minitest'  ,'~> 5.25'
+  gem 'minitest','~>  5.25'
 end

data/README.md

@@ -2,7 +2,6 @@
 
 [![Gem Version](https://badge.fury.io/rb/init_copy.svg)](https://badge.fury.io/rb/init_copy)
 [![CI Status](https://github.com/esotericpig/init_copy/actions/workflows/ci.yml/badge.svg)](https://github.com/esotericpig/init_copy/actions/workflows/ci.yml)
-
 [![Source Code](https://img.shields.io/badge/source-github-%23211F1F.svg)](https://github.com/esotericpig/init_copy)
 [![Changelog](https://img.shields.io/badge/changelog-md-%23A0522D.svg)](CHANGELOG.md)
 [![License](https://img.shields.io/github/license/esotericpig/init_copy.svg)](LICENSE.txt)
@@ -18,6 +17,7 @@ module SecretExt
   end
 end
 
+# Init vars.
 bob = 'Bob'
 bob.extend(SecretExt)
 bob.freeze
@@ -25,6 +25,7 @@ bob.freeze
 clone = bob.clone
 dup   = bob.dup
 
+# Check vars.
 puts clone.frozen? #=> true
 puts dup.frozen?   #=> false
 
@@ -35,8 +36,9 @@ puts dup.secret    #=> NoMethodError
 To solve this issue in the past, we had to define both `initialize_clone` & `initialize_dup` and maintain two copies of all our deep-copy code. That sucks. 😞
 
 🚀 Instead, *InitCopy* was created:
-1. Install the gem `init_copy` ([RubyGems.org page](https://rubygems.org/gems/init_copy)).
-2. Include `InitCopy` in your class/module.
+
+1. Install the gem `init_copy` ([on RubyGems.org](https://rubygems.org/gems/init_copy)).
+2. Include `InitCopy::Able` in your class/module.
 3. Override the `init_copy(original)` method.
 4. Use `ic_copy(var)`, instead of clone/dup.
 
@@ -46,14 +48,15 @@ Example usage:
 require 'init_copy'
 
 class JangoFett
-  include InitCopy
+  include InitCopy::Able
 
-  attr_reader :gear,:order66
+  attr_reader :gear,:bounties,:order66
 
   def initialize
     super
 
     @gear = ['blaster','jetpack']
+    @bounties = ['Padmé','Vosa']
 
     @order66 = Class.new do
       undef_method :clone
@@ -67,12 +70,15 @@ class JangoFett
     super
 
     @gear = ic_copy(@gear)
+    @bounties = ic_copy(@bounties)
+
     @order66 = ic_copy?(@order66) # Safe copy if no dup/clone.
   end
 end
 
+# Init vars.
 jango = JangoFett.new
-jango.freeze
+jango.bounties.freeze
 
 boba1 = jango.clone
 boba2 = jango.dup
@@ -80,13 +86,17 @@ boba2 = jango.dup
 jango.gear << 'vibroblade'
 boba1.gear << 'implant'
 
-puts jango.gear.inspect #=> ["blaster", "jetpack", "vibroblade"]
+# Check vars.
+puts jango.gear.inspect     #=> ["blaster", "jetpack", "vibroblade"]
 
-puts boba1.gear.inspect #=> ["blaster", "jetpack", "implant"]
-puts boba2.gear.inspect #=> ["blaster", "jetpack"]
+puts boba1.gear.inspect     #=> ["blaster", "jetpack", "implant"]
+puts boba2.gear.inspect     #=> ["blaster", "jetpack"]
 
-puts boba1.frozen? #=> true  (clone)
-puts boba2.frozen? #=> false (dup)
+puts boba1.bounties.inspect #=> ["Padmé", "Vosa"]
+puts boba2.bounties.inspect #=> ["Padmé", "Vosa"]
+
+puts boba1.bounties.frozen? #=> true  (clone)
+puts boba2.bounties.frozen? #=> false (dup)
 ```
 
 ## // Contents
@@ -114,16 +124,15 @@ spec.add_dependency 'init_copy', '~> X.X'
 In your *Gemfile*:
 
 ```ruby
-# Pick one...
+# Pick your poison...
 gem 'init_copy', '~> X.X'
-
 gem 'init_copy', git: 'https://github.com/esotericpig/init_copy.git', branch: 'main'
 ```
 
 From source:
 
 ```bash
-git clone 'https://github.com/esotericpig/init_copy.git'
+git clone --depth 1 'https://github.com/esotericpig/init_copy.git'
 cd init_copy
 bundle install
 bundle exec rake install:local

data/Rakefile

@@ -3,7 +3,7 @@
 
 require 'bundler/gem_tasks'
 
-require 'init_copy'
+require 'init_copy/version'
 require 'rake/clean'
 require 'rake/testtask'
 require 'rdoc/task'

data/init_copy.gemspec

@@ -1,7 +1,7 @@
 # encoding: UTF-8
 # frozen_string_literal: true
 
-require_relative 'lib/init_copy'
+require_relative 'lib/init_copy/version'
 
 Gem::Specification.new do |spec|
   spec.name        = 'init_copy'
@@ -21,9 +21,8 @@ Gem::Specification.new do |spec|
     'changelog_uri'         => 'https://github.com/esotericpig/init_copy/blob/main/CHANGELOG.md',
   }
 
-  # Lowest version that isn't eol (end-of-life).
   # - https://www.ruby-lang.org/en/downloads/branches/
-  spec.required_ruby_version = '>= 3.2'
+  spec.required_ruby_version = '>= 3.1'
   spec.require_paths         = ['lib']
   spec.bindir                = 'bin'
   spec.executables           = []

data/lib/init_copy/version.rb

@@ -0,0 +1,13 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+
+#--
+# This file is part of InitCopy.
+# Copyright (c) 2025 Bradley Whited
+#
+# SPDX-License-Identifier: MIT
+#++
+
+module InitCopy
+  VERSION = '0.3.0'
+end

data/lib/init_copy.rb

@@ -8,11 +8,13 @@
 # SPDX-License-Identifier: MIT
 #++
 
+require 'init_copy/version'
+
 # Example usage:
 #   require 'init_copy'
 #
 #   class JangoFett
-#     include InitCopy
+#     include InitCopy::Able
 #
 #     protected
 #
@@ -24,33 +26,11 @@
 #     end
 #   end
 module InitCopy
-  VERSION = '0.2.0'
-
-  def self.included(mod)
-    super
-
-    # NOTE: Can't use prepend(), else children's init_copy() won't call their parents', even with super().
-    mod.include(Copyable)
-  end
-
-  def self.extended(mod)
-    super
-
-    mod.include(Copyable)
-  end
-
-  def self.prepended(mod)
-    super
-
-    # User specifically requested to prepend.
-    mod.prepend(Copyable)
-  end
-
-  module Copyable
+  module Able
     def initialize_clone(orig)
       super
 
-      # The instance variable name is long & obnoxious to reduce conflicts.
+      # The instance var name is long & obnoxious to reduce conflicts.
       @__init_copy_method_name = :clone
       init_copy(orig)
     end

data/test/init_copy_test.rb

@@ -12,196 +12,180 @@ require 'minitest/autorun'
 
 require 'init_copy'
 
-class InitCopyTest < Minitest::Test
-  # def setup
-  # end
+describe InitCopy do
+  it 'has a correct version' do
+    _(InitCopy::VERSION).must_match(/\d+\.\d+\.\d+(-[0-9A-Za-z\-.]+)?(\+[0-9A-Za-z\-.]+)?/)
+  end
 
-  def test_include
-    %i[include extend prepend].each do |method|
-      sut_class = Class.new
-      sut_class.__send__(method,InitCopy)
+  def self.add_basic_copy_tests
+    it 'is not the same as the copies' do
+      _(@sut).wont_be_same_as(@sut_clone)
+      _(@sut).wont_be_same_as(@sut_dup)
+    end
 
-      assert_includes(sut_class.included_modules,InitCopy::Copyable,
-                      "`#{method}` of InitCopy should include InitCopy::Copyable")
+    it 'has the correct copy method name' do
+      _(@sut.init_copy_method_name).must_be_nil
+      _(@sut_clone.init_copy_method_name).must_equal(:clone)
+      _(@sut_dup.init_copy_method_name).must_equal(:dup)
     end
   end
 
-  def test_no_copy
-    sut = TestBag.new
-
-    refute_deep_copy(sut,sut.clone,:clone)
-    refute_deep_copy(sut,sut.dup,:dup)
-  end
+  def self.add_deep_copy_tests(is_frozen: false)
+    it 'has the correct original' do
+      _(@sut.orig).must_be_nil
+      _(@sut_clone.orig).must_be_same_as(@sut)
+      _(@sut_dup.orig).must_be_same_as(@sut)
+    end
 
-  def test_clone
-    sut = TestBagWithCopy.new
+    it 'does a deep copy' do
+      _(@sut.nums).wont_be_same_as(@sut_clone.nums)
+      _(@sut.nums).wont_be_same_as(@sut_dup.nums)
 
-    assert_deep_copy(sut,sut.clone,:clone)
-  end
+      expected = [1,2,3]
 
-  def test_dup
-    sut = TestBagWithCopy.new
+      _(@sut.nums).must_equal(expected)
+      _(@sut_clone.nums).must_equal(expected)
+      _(@sut_dup.nums).must_equal(expected)
 
-    assert_deep_copy(sut,sut.dup,:dup)
-  end
+      if !is_frozen
+        @sut.nums << 4
+        @sut_clone.nums << 5
+        @sut_dup.nums << 6
 
-  def test_correct_clone_and_dup_behavior
-    sut_ext = Module.new do
-      def bonus
-        return 100
+        _(@sut.nums).must_equal([1,2,3,4])
+        _(@sut_clone.nums).must_equal([1,2,3,5])
+        _(@sut_dup.nums).must_equal([1,2,3,6])
       end
     end
-
-    sut = TestBagWithCopy.new
-    sut.extend(sut_ext)
-
-    assert_deep_copy(sut,sut.clone,:clone)
-    assert_deep_copy(sut,sut.dup,:dup)
-
-    sut.nums.freeze
-    sut_clone = sut.clone
-    sut_dup = sut.dup
-
-    assert_predicate(sut.nums,:frozen?,'SUT nums should be frozen')
-    assert_respond_to(sut,:bonus,'SUT should have the bonus extension')
-    assert_equal(100,sut.bonus)
-
-    assert_predicate(sut_clone.nums,:frozen?,'clone should keep the nums as frozen')
-    assert_respond_to(sut_clone,:bonus,'clone should keep the bonus extension')
-    assert_equal(100,sut_clone.bonus)
-
-    refute_predicate(sut_dup.nums,:frozen?,'dup should remove the internal frozen state of nums')
-    refute_respond_to(sut_dup,:bonus,'dup should remove the bonus extension')
-    assert_raises(NoMethodError) { sut_dup.bonus }
   end
 
-  def test_safe_copy
-    sut = TestBagWithSafeCopy.new
-
-    assert_respond_to(sut.nums,:clone)
-    assert_respond_to(sut.nums,:dup)
-
-    assert_deep_copy(sut,sut.clone,:clone)
-    assert_deep_copy(sut,sut.dup,:dup)
-
-    class << sut.nums
-      undef_method :clone
-      undef_method :dup
+  describe 'without copy' do
+    before do
+      @sut = TestBag.new
+      @sut_clone = @sut.clone
+      @sut_dup = @sut.dup
     end
 
-    refute_respond_to(sut.nums,:clone)
-    refute_respond_to(sut.nums,:dup)
-
-    refute_deep_copy(sut,sut.clone,:clone,is_safe_copy: true)
-    refute_deep_copy(sut,sut.dup,:dup,is_safe_copy: true)
-
-    # Make sure we didn't remove clone()/dup() for all arrays.
-    assert_respond_to([1,2,3],:clone)
-    assert_respond_to([1,2,3],:dup)
-  end
-
-  def test_child_copy
-    sut_class = Class.new(TestBagWithCopy) do
-      attr_reader :strs
-
-      def initialize
-        super
-
-        @strs = %w[a b c]
-      end
-
-      def init_copy(*)
-        super
+    add_basic_copy_tests
 
-        @strs = ic_copy(@strs)
-      end
+    it 'has no original' do
+      _(@sut.orig).must_be_nil
+      _(@sut_clone.orig).must_be_nil
+      _(@sut_dup.orig).must_be_nil
     end
 
-    sut = sut_class.new
-    sut_clone = sut.clone
-    sut_dup = sut.dup
+    it 'does not do a deep copy' do
+      _(@sut.nums).must_be_same_as(@sut_clone.nums)
+      _(@sut.nums).must_be_same_as(@sut_dup.nums)
 
-    assert_deep_copy(sut,sut_clone,:clone)
-    assert_deep_copy(sut,sut_dup,:dup)
+      expected = [1,2,3]
 
-    expected = %w[a b c]
+      _(@sut.nums).must_equal(expected)
+      _(@sut_clone.nums).must_equal(expected)
+      _(@sut_dup.nums).must_equal(expected)
 
-    refute_same(sut.strs,sut_clone.strs)
-    refute_same(sut.strs,sut_dup.strs)
-    assert_equal(expected,sut.strs)
-    assert_equal(expected,sut_clone.strs)
-    assert_equal(expected,sut_dup.strs)
+      @sut.nums << 4
+      @sut_clone.nums << 5
+      @sut_dup.nums << 6
 
-    sut.strs << 'd'
-    sut_clone.strs << 'e'
-    sut_dup.strs << 'f'
+      expected = [1,2,3,4,5,6]
 
-    assert_equal(%w[a b c d],sut.strs)
-    assert_equal(%w[a b c e],sut_clone.strs)
-    assert_equal(%w[a b c f],sut_dup.strs)
+      _(@sut.nums).must_equal(expected)
+      _(@sut_clone.nums).must_equal(expected)
+      _(@sut_dup.nums).must_equal(expected)
+    end
   end
 
-  def assert_deep_copy(sut,sut_copy,copy_method_name)
-    refute_same(sut,sut_copy)
+  describe 'with copy' do
+    before do
+      @sut = TestBagWithCopy.new
+      @sut_clone = @sut.clone
+      @sut_dup = @sut.dup
+    end
 
-    assert_nil(sut.init_copy_method_name)
-    assert_equal(copy_method_name,sut_copy.init_copy_method_name)
+    add_basic_copy_tests
+    add_deep_copy_tests
+  end
 
-    assert_nil(sut.orig)
-    assert_same(sut,sut_copy.orig)
+  describe 'with copy and internal state' do
+    before do
+      @sut = TestBagWithCopy.new
+
+      @sut.nums.extend(
+        Module.new do
+          def bonus
+            return 110
+          end
+        end
+      )
+      @sut.nums.freeze
+
+      @sut_clone = @sut.clone
+      @sut_dup = @sut.dup
+    end
 
-    expected = [1,2,3]
+    add_basic_copy_tests
+    add_deep_copy_tests(is_frozen: true)
 
-    refute_same(sut.nums,sut_copy.nums)
-    assert_equal(expected,sut.nums)
-    assert_equal(expected,sut_copy.nums)
+    it 'has the correct bonus extension' do
+      _(@sut.nums).must_respond_to(:bonus,'SUT should have the nums bonus extension')
+      _(@sut.nums.bonus).must_equal(110)
 
-    sut.nums << 4
-    sut_copy.nums << 5
+      _(@sut_clone.nums).must_respond_to(:bonus,'clone should keep the nums bonus extension')
+      _(@sut_clone.nums.bonus).must_equal(110)
 
-    assert_equal([1,2,3,4],sut.nums)
-    assert_equal([1,2,3,5],sut_copy.nums)
+      _(@sut_dup.nums).wont_respond_to(:bonus,'dup should remove the nums bonus extension')
+      _ { @sut_dup.bonus }.must_raise(NoMethodError)
+    end
 
-    # Reset.
-    sut.nums.pop
-    sut_copy.nums.pop
+    it 'has the correct frozen state' do
+      _(@sut.nums.frozen?).must_equal(true,'SUT should have the nums as frozen')
+      _(@sut_clone.nums.frozen?).must_equal(true,'clone should keep the nums as frozen')
+      _(@sut_dup.nums.frozen?).must_equal(false,'dup should remove the nums as frozen')
+    end
   end
 
-  def refute_deep_copy(sut,sut_copy,copy_method_name,is_safe_copy: false)
-    refute_same(sut,sut_copy)
-
-    assert_nil(sut.init_copy_method_name)
-    assert_equal(copy_method_name,sut_copy.init_copy_method_name)
+  describe 'child with copy and unsafe var' do
+    before do
+      @sut = TestBagChildWithCopyAndUnsafe.new
+      @sut_clone = @sut.clone
+      @sut_dup = @sut.dup
+    end
 
-    assert_nil(sut.orig)
+    add_basic_copy_tests
+    add_deep_copy_tests
 
-    if is_safe_copy
-      assert_same(sut,sut_copy.orig)
-    else
-      assert_nil(sut_copy.orig)
-    end
+    it 'does a deep copy of the strs' do
+      _(@sut.strs).wont_be_same_as(@sut_clone.strs)
+      _(@sut.strs).wont_be_same_as(@sut_dup.strs)
 
-    expected = [1,2,3]
+      expected = %w[a b c]
 
-    assert_same(sut.nums,sut_copy.nums)
-    assert_equal(expected,sut.nums)
-    assert_equal(expected,sut_copy.nums)
+      _(@sut.strs).must_equal(expected)
+      _(@sut_clone.strs).must_equal(expected)
+      _(@sut_dup.strs).must_equal(expected)
 
-    sut.nums << 4
-    sut_copy.nums << 5
+      @sut.strs << 'd'
+      @sut_clone.strs << 'e'
+      @sut_dup.strs << 'f'
 
-    expected = [1,2,3,4,5]
+      _(@sut.strs).must_equal(%w[a b c d])
+      _(@sut_clone.strs).must_equal(%w[a b c e])
+      _(@sut_dup.strs).must_equal(%w[a b c f])
+    end
 
-    assert_equal(expected,sut.nums)
-    assert_equal(expected,sut_copy.nums)
+    it 'does not do a deep copy of the unsafe var' do
+      _(@sut.unsafe).wont_respond_to(:clone)
+      _(@sut.unsafe).wont_respond_to(:dup)
 
-    # Reset.
-    sut.nums.pop(2)
+      _(@sut.unsafe).must_be_same_as(@sut_clone.unsafe)
+      _(@sut.unsafe).must_be_same_as(@sut_dup.unsafe)
+    end
   end
 end
 
 class TestBag
-  include InitCopy
+  include InitCopy::Able
 
   attr_reader :orig
   attr_reader :nums
@@ -230,13 +214,24 @@ class TestBagWithCopy < TestBag
   end
 end
 
-class TestBagWithSafeCopy < TestBag
-  protected
+class TestBagChildWithCopyAndUnsafe < TestBagWithCopy
+  attr_reader :strs
+  attr_reader :unsafe
 
-  def init_copy(orig)
+  def initialize
     super
 
-    @orig = orig
-    @nums = ic_copy?(@nums)
+    @strs = %w[a b c]
+    @unsafe = Class.new do
+      undef_method :clone
+      undef_method :dup
+    end.new
+  end
+
+  def init_copy(*)
+    super
+
+    @strs = ic_copy(@strs)
+    @unsafe = ic_copy?(@unsafe)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: init_copy
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Bradley Whited
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-06-06 00:00:00.000000000 Z
+date: 2025-06-09 00:00:00.000000000 Z
 dependencies: []
 description: Easily use the correct clone or dup method in initialize_copy.
 email:
@@ -26,6 +26,7 @@ files:
 - Rakefile
 - init_copy.gemspec
 - lib/init_copy.rb
+- lib/init_copy/version.rb
 - test/init_copy_test.rb
 homepage: https://github.com/esotericpig/init_copy
 licenses:
@@ -45,14 +46,14 @@ rdoc_options:
 - "--main"
 - README.md
 - "--title"
-- InitCopy v0.2.0
+- InitCopy v0.3.0
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.2'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="