minitest-substitute 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 82dcc1be480cea4b024afc50aa111065cb8f6762847d40db97e2eae37823d43e
+  data.tar.gz: f9b44bae2d05d0552cbfdc944531ceb71834ee1e017eea62df34b8d5cd952e9e
+SHA512:
+  metadata.gz: ea455efb4e176abb0441e9fe57306628f0b5c232fda56ce4b152152127a902ddf0e75cd1a6a40513e610e14dee5d00cb8b187534fbe2ff5cef609be16e1c2803
+  data.tar.gz: 52ffbfd39b06e813c4f7a44fd4dade18ab7c2e1728a0b0993971bb5d51c4607ac1ca29321a7e308de2244732efc33598e7be61e5b4afc38c06a6ae7fdd9a9ba4

checksums.yaml.gz.sig

@@ -0,0 +1,4 @@
+��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�

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+## Main
+
+Nothing so far
+
+## 0.1.0
+
+#### Initial Implementation
+* Require Ruby 3.0
+* Substitution of instance variables
+* Substitution of global variables
+* Helper for Minitest spec notation

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Sven Schwyn
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,149 @@
+[![Version](https://img.shields.io/gem/v/minitest-substitute.svg?style=flat)](https://rubygems.org/gems/minitest-substitute)
+[![Tests](https://img.shields.io/github/actions/workflow/status/svoop/minitest-substitute/test.yml?style=flat&label=tests)](https://github.com/svoop/minitest-substitute/actions?workflow=Test)
+[![Code Climate](https://img.shields.io/codeclimate/maintainability/svoop/minitest-substitute.svg?style=flat)](https://codeclimate.com/github/svoop/minitest-substitute/)
+[![Donorbox](https://img.shields.io/badge/donate-on_donorbox-yellow.svg)](https://donorbox.org/bitcetera)
+
+# Minitest::Substitute
+
+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.
+
+* [Homepage](https://github.com/svoop/minitest-substitute)
+* [API](https://www.rubydoc.info/gems/minitest-substitute)
+* Author: [Sven Schwyn - Bitcetera](https://bitcetera.com)
+
+## Install
+
+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)
+```
+
+Add the following to the <tt>Gemfile</tt> or <tt>gems.rb</tt> of your [Bundler](https://bundler.io) powered Ruby project:
+
+```ruby
+gem 'minitest-substitute'
+```
+
+And then install the bundle:
+
+```
+bundle install --trust-policy MediumSecurity
+```
+
+Finally, require this gem in your `test_helper.rb` or `spec_helper.rb`:
+
+```ruby
+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:
+
+```ruby
+class Config
+  def initialize
+    @version = 1
+  end
+end
+
+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
+```
+
+Same goes for global variables:
+
+```ruby
+$verbose = false   # => false
+with '$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:
+
+```ruby
+ENV['EDITOR']     # => 'vi'
+with "ENV['EDITOR']", 'nano' do
+  ENV['EDITOR']   # => 'nano'
+end
+ENV['EDITOR']     # => 'vi'
+```
+
+It's safe to nest multiple `with` statements.
+
+### Group of Tests
+
+When using spec notation, you can change a value for all tests within a `describe` group:
+
+```ruby
+class Config
+  def initialize
+    @version = 1
+  end
+end
+
+describe Config do
+  subject do
+    Config.new
+  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', 2, on: Config
+
+    it "returns the substituted version" do
+      _(subject.instance_variable_get('@version')).must_equal 2
+    end
+  end
+end
+```
+
+For consistency with other Minitest helpers, the following alternative does exactly the same:
+
+```ruby
+with '@version', on: Config do
+  2
+end
+```
+
+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.)
+
+## Development
+
+To install the development dependencies and then run the test suite:
+
+```
+bundle install
+bundle exec rake    # run tests once
+bundle exec guard   # run tests whenever files are modified
+```
+
+You're welcome to [submit issues](https://github.com/svoop/minitest-substitute/issues) and contribute code by [forking the project and submitting pull requests](https://docs.github.com/en/get-started/quickstart/fork-a-repo).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/minitest/substitute/spec.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+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
+  # @yield temporary substitution value (takes precedence over +substitute+ param)
+  def with(variable, substitute=nil, on: self)
+    before do
+      substitute = yield if block_given?
+      Substitutor.send(:commit_substitution, variable, substitute, on: on)
+    end
+    after do
+      Substitutor.send(:rollback_substitution, variable, on: on)
+    end
+  end
+
+  # Minitest does not support multiple before/after blocks
+  remove_method :before
+  def before(_type=nil, &block)
+    include(Module.new do
+      define_method(:setup) do
+        super()
+        instance_eval &block
+      end
+    end) # .then &:include
+  end
+
+  remove_method :after
+  def after(_type=nil, &block)
+    include(Module.new do
+      define_method(:teardown) do
+        instance_eval &block
+      ensure
+        super()
+      end
+    end)  #.then &:include
+  end
+end

data/lib/minitest/substitute/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Minitest
+  module Substitute
+    VERSION = '0.1.0'
+  end
+end

data/lib/minitest/substitute/with.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Minitest
+  module Substitute
+    module With
+      @original = {}
+      class << self
+        attr_accessor :original
+      end
+
+      # Substitute the variable value for the duration of the given block
+      #
+      # @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
+      # @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)
+        yield.tap do
+          rollback_substitution(variable, on: on)
+        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

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative 'substitute/version'
+
+require_relative 'substitute/with'
+require_relative 'substitute/spec'
+
+include Minitest::Substitute::With

metadata

@@ -0,0 +1,212 @@
+--- !ruby/object:Gem::Specification
+name: minitest-substitute
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sven Schwyn
+autorequire:
+bindir: bin
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDODCCAiCgAwIBAgIBATANBgkqhkiG9w0BAQsFADAjMSEwHwYDVQQDDBhydWJ5
+  L0RDPWJpdGNldGVyYS9EQz1jb20wHhcNMjIxMTA2MTIzNjUwWhcNMjMxMTA2MTIz
+  NjUwWjAjMSEwHwYDVQQDDBhydWJ5L0RDPWJpdGNldGVyYS9EQz1jb20wggEiMA0G
+  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
+  -----END CERTIFICATE-----
+date: 2023-08-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: debug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-flash
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-focus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email:
+- ruby@bitcetera.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- CHANGELOG.md
+- LICENSE.txt
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- lib/minitest/substitute.rb
+- lib/minitest/substitute/spec.rb
+- lib/minitest/substitute/version.rb
+- lib/minitest/substitute/with.rb
+homepage: https://github.com/svoop/minitest-substitute
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/svoop/minitest-substitute
+  changelog_uri: https://github.com/svoop/minitest-substitute/blob/main/CHANGELOG.md
+  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:
+rdoc_options:
+- "--title"
+- Minitest::Substitute
+- "--main"
+- README.md
+- "--line-numbers"
+- "--inline-source"
+- "--quiet"
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.19
+signing_key:
+specification_version: 4
+summary: Substitute values for the duration of a block or a group of tests
+test_files: []