minitest-substitute 0.2.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ada3a9ae885b2050d30579935751f6f6d6d3a668b299def79602098549897ff6
-  data.tar.gz: 2892e09363f655605a9c7f19da56cc40f2229d44cb332e4b583d50f193c18cef
+  metadata.gz: 9f8802ed1f575511d0d40b4c9c6aa83ac9e0438a4e516a3e9d371d64cbeec44c
+  data.tar.gz: 94dab332d69b4340512030e332d20b68975a80b0860f7e8cdb72334c25cfd076
 SHA512:
-  metadata.gz: 3222b3c80b2cf6aee7451d14f602b6aa154367a4ef95b873bc1917d2c76ab240df9183a2322c917507737059eb7a83b3d17f5952c8363f23874c04e4eaa81eda
-  data.tar.gz: d85e9ea4fb25448a7065c0d0c32a0aa28b00df47cc03495d72b2f8df8134c43fb7aadb920dda4c1b71792012a0bf048f1ac7f0e863bf55b4b30d4a6b780449bb
+  metadata.gz: 9ebd589721d0d15745712e3b280cf395bce7d185ccdbe9fc728213c87a7991d7b8ba442e853ce7932e673bc6693e98b6712b3bf75878ce240b6eeb7298ae0a97
+  data.tar.gz: fc1cb86a0d3f3123afcde191b906c154044975f4fe95eb8b0f9af0639aa27c822da7377f36e0213fcc380d2b776ed00c5db5bace1a46c6945e994ca61928f7a2

data/CHANGELOG.md

@@ -2,9 +2,21 @@
 
 Nothing so far
 
+## 1.0.0
+
+#### Breaking Changes
+* Switch from `with` to `substitute` because Rails 7 pollutes `Object` for
+  everybody by introducing `Object#with`. 💣
+
+## 0.3.0
+
+#### Additions
+* Substition of constants
+
 ## 0.2.1
 
-Nothing so far
+#### Changes
+* Defer evaluation of the substitution value block for specs
 
 ## 0.2.0
 

data/README.md

@@ -18,7 +18,7 @@ This comes in very handy when you have to derive from default configuration in o
 This gem is [cryptographically signed](https://guides.rubygems.org/security/#using-gems) in order to assure it hasn't been tampered with. Unless already done, please add the author's public key as a trusted certificate now:
 
 ```
-gem cert --add <(curl -Ls https://raw.github.com/svoop/minitest-substitute/main/certs/svoop.pem)
+gem cert --add <(curl -Ls https://bitcetera.com/downloads/gem-public_cert.pem)
 ```
 
 Add the following to the <tt>Gemfile</tt> or <tt>gems.rb</tt> of your [Bundler](https://bundler.io) powered Ruby project:
@@ -39,6 +39,24 @@ Finally, require this gem in your `test_helper.rb` or `spec_helper.rb`:
 require 'minitest/substitute'
 ```
 
+## Update from 0.x.x to 1.x.x
+
+Rails 7 has polluted `Object` for everybody by introducing `Object#with`. To prevent collisions, Minitest::Substitute has switched from `with` to `substitute` as of version 1.0.0.
+
+After having updated this gem, you'll have to adapt all your tests accordingly:
+
+```ruby
+# Version 0.x.x
+with '@version', 2, on: config do
+  config.instance_variable_get('@version')   # => 2
+end
+
+# Version 1.x.x
+substitute '@version', 2, on: config do
+  config.instance_variable_get('@version')   # => 2
+end
+```
+
 ## Usage
 
 ### Block
@@ -55,7 +73,7 @@ end
 config = Config.new
 
 config.instance_variable_get('@version')     # => 1
-with '@version', 2, on: config do
+substitute '@version', 2, on: config do
   config.instance_variable_get('@version')   # => 2
 end
 config.instance_variable_get('@version')     # => 1
@@ -71,7 +89,7 @@ class Config
 end
 
 Config.class_variable_get('@@counter')     # => 0
-with '@@counter', 42, on: Config do
+substitute '@@counter', 42, on: Config do
   Config.class_variable_get('@@counter')   # => 42
 end
 Config.class_variable_get('@@counter')     # => 0
@@ -81,23 +99,60 @@ Same goes for global variables:
 
 ```ruby
 $verbose = false   # => false
-with '$verbose', true do
+substitute '$verbose', true do
   $verbose         # => true
 end
 $verbose           # => false
 ```
 
-And it works for hashes as well which comes in handy when you have to temporarily override the value of an environment variable:
+And it works for globals like `ENV` as well which comes in handy when you have to temporarily override the value of an environment variable:
 
 ```ruby
 ENV['EDITOR']     # => 'vi'
-with "ENV['EDITOR']", 'nano' do
+substitute "ENV['EDITOR']", 'nano' do
   ENV['EDITOR']   # => 'nano'
 end
 ENV['EDITOR']     # => 'vi'
 ```
 
-It's safe to nest multiple `with` statements.
+You can even substitute constants, however, you have to use their absolute name starting with `::`:
+
+```ruby
+module Animals
+  DOG_MAKES = 'woof'
+  CAT_MAKES = 'meow'
+end
+
+Animals::DOG_MAKES     # => 'woof'
+substitute '::Animals::DOG_MAKES', Animals::CAT_MAKES do
+  Animals::DOG_MAKES   # => 'meow'
+end
+Animals::DOG_MAKES     # => 'woof'
+```
+
+Remember that class declarations are assigned to constants as well:
+
+```ruby
+class Dog
+  self.makes
+    'woof'
+  end
+end
+
+class Cat
+  self.makes
+    'meow'
+  end
+end
+
+Dog.makes     # => 'woof'
+substitute '::Dog', Cat do
+  Dog.makes   # => 'meow'
+end
+Dog.makes     # => 'woof'
+```
+
+It's safe to nest multiple `substitute` statements.
 
 ### Group of Tests
 
@@ -122,7 +177,7 @@ describe Config do
   end
 
   describe 'sustituted version' do
-    with '@version', 2, on: Config
+    substitute '@version', 2, on: Config
 
     it "returns the substituted version" do
       _(subject.instance_variable_get('@version')).must_equal 2
@@ -158,7 +213,7 @@ describe Config do
   end
 
   describe 'sustituted version' do
-    with '@version', on: Config do
+    substitute '@version', on: Config do
       version   # set using "let" above
     end
 
@@ -171,7 +226,7 @@ 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.
+It's safe to use multiple `substitute` 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

@@ -9,13 +9,13 @@ Minitest::Spec::DSL.class_eval do
   # @param variable [String] instance or global variable name
   # @param substitute [Object] temporary substitution value
   # @param on [Object, Symbol, nil] substitute in the context of this object
-  #   or in the context of the declared subject if +:subject+ is set
+  #   or in the context of the declared subject if +nil+
   # @yield temporary substitution value (takes precedence over +substitute+ param)
-  def with(variable, substitute=nil, on: :subject, &block)
+  def substitute(variable, substitute=nil, on: nil, &block)
     substitutor = Minitest::Substitute::Substitutor.new(variable, on: on)
     before do
       substitutor.substitute(block ? instance_eval(&block) : substitute)
-      substitutor.on = subject if on == :subject && respond_to?(:subject)
+      substitutor.on = subject if on.nil? && respond_to?(:subject)
       substitutor.commit
     end
     after do
@@ -29,7 +29,7 @@ Minitest::Spec::DSL.class_eval do
     include(Module.new do
       define_method(:setup) do
         super()
-        instance_eval &block
+        instance_eval(&block)
       end
     end) # .then &:include
   end
@@ -38,7 +38,7 @@ Minitest::Spec::DSL.class_eval do
   def after(_type=nil, &block)
     include(Module.new do
       define_method(:teardown) do
-        instance_eval &block
+        instance_eval(&block)
       ensure
         super()
       end

data/lib/minitest/substitute/{with.rb → substitute.rb}

@@ -2,7 +2,7 @@
 
 module Minitest
   module Substitute
-    module With
+    module Substitute
 
       # Substitute the variable value for the duration of the given block
       #
@@ -11,7 +11,7 @@ module Minitest
       # @param on [Object, nil] substitute in the context of this object
       # @yield block during which the substitution is made
       # @return [Object] return value of the yielded block
-      def with(variable, substitute, on: self)
+      def substitute(variable, substitute, on: self)
         substitutor = Minitest::Substitute::Substitutor.new(variable, on: on).substitute(substitute)
         substitutor.commit
         yield.tap do

data/lib/minitest/substitute/substitutor.rb

@@ -4,12 +4,10 @@ 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
+      def initialize(target, on:)
+        @target, @on = target, on
       end
 
       def substitute(value)
@@ -28,16 +26,32 @@ module Minitest
 
       private
 
-      def eval_method
-        EVAL_METHODS[@variable.count('@')]
-      end
-
       def get
-        @on.send(eval_method, @variable.to_s)
+        case @target
+        when /^@@/   # class variable
+          @on.class_eval @target.to_s
+        else   # constant, instance or global variable
+          @on.instance_eval @target.to_s
+        end
       end
 
       def set(value)
-        @on.send(eval_method, "#{@variable} = value")
+        case @target
+        when /^::/
+          remove_const @target
+          eval "#{@target} = value"
+        when /^@@/   # class variable
+          @on.class_eval "#{@target} = value"
+        else    # instance or global variable
+          @on.instance_eval "#{@target} = value"
+        end
+      end
+
+      # Remove constant without warning
+      def remove_const(const)
+        namespace, _, name = const.rpartition('::')
+        receiver = namespace == '' ? Object : Object.const_get(namespace)
+        receiver.send(:remove_const, name)
       end
 
     end

data/lib/minitest/substitute/version.rb

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

data/lib/minitest/substitute.rb

@@ -3,7 +3,7 @@
 require_relative 'substitute/version'
 
 require_relative 'substitute/substitutor'
-require_relative 'substitute/with'
+require_relative 'substitute/substitute'
 require_relative 'substitute/spec'
 
-include Minitest::Substitute::With
+include Minitest::Substitute::Substitute

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: minitest-substitute
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Sven Schwyn
@@ -10,26 +10,24 @@ bindir: bin
 cert_chain:
 - |
   -----BEGIN CERTIFICATE-----
-  MIIDODCCAiCgAwIBAgIBATANBgkqhkiG9w0BAQsFADAjMSEwHwYDVQQDDBhydWJ5
-  L0RDPWJpdGNldGVyYS9EQz1jb20wHhcNMjIxMTA2MTIzNjUwWhcNMjMxMTA2MTIz
-  NjUwWjAjMSEwHwYDVQQDDBhydWJ5L0RDPWJpdGNldGVyYS9EQz1jb20wggEiMA0G
+  MIIC+jCCAeKgAwIBAgIBAjANBgkqhkiG9w0BAQsFADAjMSEwHwYDVQQDDBhydWJ5
+  L0RDPWJpdGNldGVyYS9EQz1jb20wHhcNMjMxMTEwMTgyMzM2WhcNMjQxMTA5MTgy
+  MzM2WjAjMSEwHwYDVQQDDBhydWJ5L0RDPWJpdGNldGVyYS9EQz1jb20wggEiMA0G
   CSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDcLg+IHjXYaUlTSU7R235lQKD8ZhEe
   KMhoGlSUonZ/zo1OT3KXcqTCP1iMX743xYs6upEGALCWWwq+nxvlDdnWRjF3AAv7
   ikC+Z2BEowjyeCCT/0gvn4ohKcR0JOzzRaIlFUVInlGSAHx2QHZ2N8ntf54lu7nd
   L8CiDK8rClsY4JBNGOgH9UC81f+m61UUQuTLxyM2CXfAYkj/sGNTvFRJcNX+nfdC
   hM9r2kH1+7wsa8yG7wJ2IkrzNACD8v84oE6qVusN8OLEMUI/NaEPVPbw2LUM149H
   PVa0i729A4IhroNnFNmw4wOC93ARNbM1+LW36PLMmKjKudf5Exg8VmDVAgMBAAGj
-  dzB1MAkGA1UdEwQCMAAwCwYDVR0PBAQDAgSwMB0GA1UdDgQWBBSfK8MtR62mQ6oN
-  yoX/VKJzFjLSVDAdBgNVHREEFjAUgRJydWJ5QGJpdGNldGVyYS5jb20wHQYDVR0S
-  BBYwFIEScnVieUBiaXRjZXRlcmEuY29tMA0GCSqGSIb3DQEBCwUAA4IBAQAYG2na
-  ye8OE2DANQIFM/xDos/E4DaPWCJjX5xvFKNKHMCeQYPeZvLICCwyw2paE7Otwk6p
-  uvbg2Ks5ykXsbk5i6vxDoeeOLvmxCqI6m+tHb8v7VZtmwRJm8so0eSX0WvTaKnIf
-  CAn1bVUggczVdNoBXw9WAILKyw9bvh3Ft740XZrR74sd+m2pGwjCaM8hzLvrVbGP
-  DyYhlBeRWyQKQ0WDIsiTSRhzK8HwSTUWjvPwx7SEdIU/HZgyrk0ETObKPakVu6bH
-  kAyiRqgxF4dJviwtqI7mZIomWL63+kXLgjOjMe1SHxfIPo/0ji6+r1p4KYa7o41v
-  fwIwU1MKlFBdsjkd
+  OTA3MAkGA1UdEwQCMAAwCwYDVR0PBAQDAgSwMB0GA1UdDgQWBBSfK8MtR62mQ6oN
+  yoX/VKJzFjLSVDANBgkqhkiG9w0BAQsFAAOCAQEAXhT/LpMArF3JRcZSRkJDY+dU
+  GKCRqOefi2iydqh1yIqXyTA9PGR1w5O6O+WS1FvF+sHCwh8fFjCuStg2L8V2RSeo
+  aDtfZ5s80sL8wRFxg3kek69cBuI6ozU+rf9DaXlMES4i8+zASsdv9Y4a2BsbhEdE
+  9AtuMcWn5a45TOO0S4Q8OuV0v705V38Ow15J2RDRvkFRySt+//8/Vd57XAJxPXU0
+  k/QvZU05f6HMYBrPogJgIzHC/C5N/yeE4BVEuBDn+10Zb1iu3aDk8sd0uMgukCY8
+  TUmlP5A6NeGdeDJIoLgromAKs+nvI7TWzhQq9ODs51XhxgUFRCvBqUTpjTQigw==
   -----END CERTIFICATE-----
-date: 2023-09-06 00:00:00.000000000 Z
+date: 2024-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -176,9 +174,9 @@ files:
 - README.md
 - lib/minitest/substitute.rb
 - lib/minitest/substitute/spec.rb
+- lib/minitest/substitute/substitute.rb
 - lib/minitest/substitute/substitutor.rb
 - lib/minitest/substitute/version.rb
-- lib/minitest/substitute/with.rb
 homepage: https://github.com/svoop/minitest-substitute
 licenses:
 - MIT
@@ -188,7 +186,9 @@ metadata:
   source_code_uri: https://github.com/svoop/minitest-substitute
   documentation_uri: https://www.rubydoc.info/gems/minitest-substitute
   bug_tracker_uri: https://github.com/svoop/minitest-substitute/issues
-post_install_message:
+post_install_message: '⚠️ Breaking change: minitest-substitute >= 1.0.0 switched from
+  "with" to "substitute" to prevent conflicts with Rails 7. Please read the update
+  section in the README.'
 rdoc_options:
 - "--title"
 - Minitest::Substitute
@@ -210,7 +210,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
+rubygems_version: 3.5.6
 signing_key:
 specification_version: 4
 summary: Substitute values for the duration of a block or a group of tests