minitest-substitute 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 82dcc1be480cea4b024afc50aa111065cb8f6762847d40db97e2eae37823d43e
-  data.tar.gz: f9b44bae2d05d0552cbfdc944531ceb71834ee1e017eea62df34b8d5cd952e9e
+  metadata.gz: ada3a9ae885b2050d30579935751f6f6d6d3a668b299def79602098549897ff6
+  data.tar.gz: 2892e09363f655605a9c7f19da56cc40f2229d44cb332e4b583d50f193c18cef
 SHA512:
-  metadata.gz: ea455efb4e176abb0441e9fe57306628f0b5c232fda56ce4b152152127a902ddf0e75cd1a6a40513e610e14dee5d00cb8b187534fbe2ff5cef609be16e1c2803
-  data.tar.gz: 52ffbfd39b06e813c4f7a44fd4dade18ab7c2e1728a0b0993971bb5d51c4607ac1ca29321a7e308de2244732efc33598e7be61e5b4afc38c06a6ae7fdd9a9ba4
+  metadata.gz: 3222b3c80b2cf6aee7451d14f602b6aa154367a4ef95b873bc1917d2c76ab240df9183a2322c917507737059eb7a83b3d17f5952c8363f23874c04e4eaa81eda
+  data.tar.gz: d85e9ea4fb25448a7065c0d0c32a0aa28b00df47cc03495d72b2f8df8134c43fb7aadb920dda4c1b71792012a0bf048f1ac7f0e863bf55b4b30d4a6b780449bb

checksums.yaml.gz.sig

@@ -1,4 +1,6 @@
-��Z79{��XP�/�/�@/+ԥ����d�胱��>�C�/1Wqv�J_%wL̔�?}wR��F[�N7�+��\v���Z5�����Ͻ�&_Ls
-ߜa���Fn�&�<�7��?����rޛ���l�H
-vU�u�XE�{�HU3#���_R��#���:���Q�z#H��Z�Y�\�&���f�{!�8�!��a�:i��ᣯZŭ�}�@�
-*��v5�΁[R��^�Q�e�|zXi��%	
�Mu��‡qzg�
+�GY���5�ln��c��OM��2hf���_��
+��犲��@��TM�
+O�i֢�u-����X��OB��E�����
+n�F�(�%�P6����|޼I�O���R}>z�_�B�����z}+����N�u��Y��hC�=W׿
+8��V���i�?;Hj*�`�����^Q
h3b�ғ^m�߽�UM��{��='eYqX��U�,7
+���d%ݬܥ�@���B_�{�?�

data/CHANGELOG.md

@@ -2,6 +2,16 @@
 
 Nothing so far
 
+## 0.2.1
+
+Nothing so far
+
+## 0.2.0
+
+#### Additions
+* Refactor to support class variables as well
+* Use declared subject as default target for with helper
+
 ## 0.1.0
 
 #### Initial Implementation

data/README.md

@@ -41,13 +41,6 @@ require 'minitest/substitute'
 
 ## Usage
 
-This lightweight gem implements features on a "as needed" basis, as of now:
-
-* substitution of instance variables
-* substitution of global variables
-
-Please [create an issue describing your use case](https://github.com/svoop/minitest-substitute/issues) in case you need more features such as the substitution of class variables or substitution via accessor methods.
-
 ### Block
 
 To substitute the value of an instance variable for the duration of a block:
@@ -59,11 +52,29 @@ class Config
   end
 end
 
-Config.instance_variable_get('@version')     # => 1
-with '@version', 2, on: Config do
-  Config.instance_variable_get('@version')   # => 2
+config = Config.new
+
+config.instance_variable_get('@version')     # => 1
+with '@version', 2, on: config do
+  config.instance_variable_get('@version')   # => 2
 end
-Config.instance_variable_get('@version')     # => 1
+config.instance_variable_get('@version')     # => 1
+```
+
+:warning: The target `on` is set explicitly in this case. If you omit this argument, `self` will be used as target by default.
+
+Class variables can be substituted as well:
+
+```ruby
+class Config
+  @@counter = 0
+end
+
+Config.class_variable_get('@@counter')     # => 0
+with '@@counter', 42, on: Config do
+  Config.class_variable_get('@@counter')   # => 42
+end
+Config.class_variable_get('@@counter')     # => 0
 ```
 
 Same goes for global variables:
@@ -120,14 +131,46 @@ describe Config do
 end
 ```
 
-For consistency with other Minitest helpers, the following alternative does exactly the same:
+:warning: The target `on` is set explicitly in this case. If you omit this argument, `:subject` will be used as target by default which refers to the subject defined by the `subject {}` helper.
+
+Alternatively, you can pass the substitution value as a block. This block will be evaluated once in the context of the test, in other words, you can use assignments done with `let` inside the block:
 
 ```ruby
-with '@version', on: Config do
-  2
+class Config
+  def initialize
+    @version = 1
+  end
+end
+
+describe Config do
+  subject do
+    Config.new
+  end
+
+  let :version do
+    2
+  end
+
+  describe 'original version' do
+    it "returns the original version" do
+      _(subject.instance_variable_get('@version')).must_equal 1
+    end
+  end
+
+  describe 'sustituted version' do
+    with '@version', on: Config do
+      version   # set using "let" above
+    end
+
+    it "returns the substituted version" do
+      _(subject.instance_variable_get('@version')).must_equal 2
+    end
+  end
 end
 ```
 
+If both a substitution value and a substitution block are present, the latter takes precedence.
+
 It's safe to use multiple `with` statements within one `describe` block.
 
 (The spec integration is borrowed from [minitest-around](https://rubygems.org/gems/minitest-around) for elegance and compatibility.)

data/lib/minitest/substitute/spec.rb

@@ -3,23 +3,23 @@
 require 'minitest/spec'
 
 Minitest::Spec::DSL.class_eval do
-  class Substitutor
-    include Minitest::Substitute::With
-  end
 
   # Substitute the variable value for the duration of the current description
   #
   # @param variable [String] instance or global variable name
   # @param substitute [Object] temporary substitution value
-  # @param on [Object, nil] substitute in the context of this object
+  # @param on [Object, Symbol, nil] substitute in the context of this object
+  #   or in the context of the declared subject if +:subject+ is set
   # @yield temporary substitution value (takes precedence over +substitute+ param)
-  def with(variable, substitute=nil, on: self)
+  def with(variable, substitute=nil, on: :subject, &block)
+    substitutor = Minitest::Substitute::Substitutor.new(variable, on: on)
     before do
-      substitute = yield if block_given?
-      Substitutor.send(:commit_substitution, variable, substitute, on: on)
+      substitutor.substitute(block ? instance_eval(&block) : substitute)
+      substitutor.on = subject if on == :subject && respond_to?(:subject)
+      substitutor.commit
     end
     after do
-      Substitutor.send(:rollback_substitution, variable, on: on)
+      substitutor.rollback
     end
   end
 
@@ -44,4 +44,5 @@ Minitest::Spec::DSL.class_eval do
       end
     end)  #.then &:include
   end
+
 end

data/lib/minitest/substitute/substitutor.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Minitest
+  module Substitute
+    class Substitutor
+
+      EVAL_METHODS = [:instance_eval, :instance_eval, :class_eval].freeze
+
+      attr_writer :on
+
+      def initialize(variable, on:)
+        @variable, @on = variable, on
+      end
+
+      def substitute(value)
+        @substitute = value unless instance_variable_defined? :@substitute
+        self
+      end
+
+      def commit
+        @original = get
+        set @substitute
+      end
+
+      def rollback
+        set @original
+      end
+
+      private
+
+      def eval_method
+        EVAL_METHODS[@variable.count('@')]
+      end
+
+      def get
+        @on.send(eval_method, @variable.to_s)
+      end
+
+      def set(value)
+        @on.send(eval_method, "#{@variable} = value")
+      end
+
+    end
+  end
+end

data/lib/minitest/substitute/version.rb

@@ -2,6 +2,6 @@
 
 module Minitest
   module Substitute
-    VERSION = '0.1.0'
+    VERSION = '0.2.1'
   end
 end

data/lib/minitest/substitute/with.rb

@@ -3,10 +3,6 @@
 module Minitest
   module Substitute
     module With
-      @original = {}
-      class << self
-        attr_accessor :original
-      end
 
       # Substitute the variable value for the duration of the given block
       #
@@ -16,22 +12,13 @@ module Minitest
       # @yield block during which the substitution is made
       # @return [Object] return value of the yielded block
       def with(variable, substitute, on: self)
-        commit_substitution(variable, substitute, on: on)
+        substitutor = Minitest::Substitute::Substitutor.new(variable, on: on).substitute(substitute)
+        substitutor.commit
         yield.tap do
-          rollback_substitution(variable, on: on)
+          substitutor.rollback
         end
       end
 
-      private
-
-      def commit_substitution(variable, substitute, on:)
-        Minitest::Substitute::With.original[variable.hash] = on.instance_eval variable.to_s
-        on.instance_eval "#{variable} = substitute"
-      end
-
-      def rollback_substitution(variable, on:)
-        on.instance_eval "#{variable} = Minitest::Substitute::With.original.delete(variable.hash)"
-      end
     end
   end
 end

data/lib/minitest/substitute.rb

@@ -2,6 +2,7 @@
 
 require_relative 'substitute/version'
 
+require_relative 'substitute/substitutor'
 require_relative 'substitute/with'
 require_relative 'substitute/spec'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: minitest-substitute
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Sven Schwyn
@@ -29,7 +29,7 @@ cert_chain:
   kAyiRqgxF4dJviwtqI7mZIomWL63+kXLgjOjMe1SHxfIPo/0ji6+r1p4KYa7o41v
   fwIwU1MKlFBdsjkd
   -----END CERTIFICATE-----
-date: 2023-08-23 00:00:00.000000000 Z
+date: 2023-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -157,7 +157,11 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: ''
+description: |
+  Simple Minitest helper to replace values such as an instance variable of an
+  object or an environment variable for the duration of a block or a group of
+  tests. This comes in very handy when you have to derive from default
+  configuration in order to test some aspects of your code.
 email:
 - ruby@bitcetera.com
 executables: []
@@ -172,6 +176,7 @@ files:
 - README.md
 - lib/minitest/substitute.rb
 - lib/minitest/substitute/spec.rb
+- lib/minitest/substitute/substitutor.rb
 - lib/minitest/substitute/version.rb
 - lib/minitest/substitute/with.rb
 homepage: https://github.com/svoop/minitest-substitute