minitest-markdown 0.0.1.pre → 0.2.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6836d7576d3a208628f401e2660fac20d4288faf95c6513e76dd20a2a402fed2
-  data.tar.gz: 4f38166f7ff54f9a74391daafe8e698a7f0aabc57cf7a3797f292b3b8d85d524
+  metadata.gz: 50ca2163359f3e4b038a8e4837bcb38511bca5e5b00bc2603873816bba2408e1
+  data.tar.gz: 15fcbc54bcc387111b92b86fe5c291ce82d05f9391f12d41955aaa0d191c2735
 SHA512:
-  metadata.gz: 393bc3aff42df19c5cfd10c2edddb64242798765d30aed3185e44be621547e0ed93f495113cca4082e388ab20f2da213f4f5ad4411b17f6117b1421c531d066a
-  data.tar.gz: a30d096c73f2064311cb2d729305fe5cc1d00cca871575fb75783d8046d28f5fc325d92882ccb886834358ed6a586f36eb397439829fba22f4d875c2f6e61998
+  metadata.gz: 26bba54a86204e035f3890032eb985ac494133a697fc79c937ed863270e7659acb8675e916aba14b83062b1cb162b5ca7ef7a73e3283ad2c80b95889e8fac356
+  data.tar.gz: f6556b67590972e176b120c879d499d00fc2bc0574c1f134bec9f76c12f6f37907b2b1c09fb19aab7e73d41bd697bdf37c289f2180797b8f4940043935441043

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 ## [Unreleased]
 
+## [0.2.0.pre] - 2025-05-06
+
+- Add ability to pass any number of stubs to a test code block
+
+### Breaking changes
+- StubChain class replaces Stubb module see https://gitlab.com/matzfan/minitest-markdown#stubbing
+
+## [0.1.0.pre] - 2025-05-01
+
+- Add ability to pass stubs to test class
+- Add dependency; minitest-stub_any_instance 
+
 ## [0.0.1.pre] - 2025-04-24
 
 - Bump minitest dep to >= 5.25.2

data/README.md

@@ -30,7 +30,7 @@ To test the Ruby blocks in your README file, create file `test_readme.rb` (for e
 require 'minitest/autorun' # or in your test_helper
 require 'minitest/markdown' # ditto
 
-class ReadmeTest < MyTest # your own subclass of Minitest::Test
+class ReadmeTest < Minitest::Test # or your own subclass of Minitest::Test
   Markdown.generate_markdown_tests(self)
 end
 # => nil
@@ -101,6 +101,28 @@ The hook methods defined in the [minitest-hooks](https://github.com/jeremyevans/
 
 Everything in the code blocks above runs as test code. [minitest-proveit](https://github.com/seattlerb/minitest-proveit) would complain otherwise ;-)
 
+## Stubbing
+
+It is possible to pass stubs to the generated tests. This is done using the stubs keyword. Hash keys represent the index of the test code block and the key is an instance of `StubChain`. `StubChain.stubproc` returns a procified stub which is called around the relevant test code. Zero or more of these reusable procs can be used to instantiate a StubChain object:
+```ruby
+class MarkdownTest < Minitest::Test
+  set_stubs_new = Minitest::StubChain.stubproc(Set, :new, []) # returns a proc which stubs Set.new to return an empty array
+  array_stubs_size = Minitest::StubChain.stubproc(Array, :size, 42, any_instance: true) # uses the bundled minitest-stub_any_instance gem
+
+  stubs = {}
+  stubs[8] = Minitest::StubChain.new([set_stubs_new, array_stubs_size]) # initialized with zero or more stub procs
+
+  Markdown.generate_markdown_tests(self, stubs: stubs)
+end
+# => nil
+```
+The 2 stubs above are demonstated in the following examples:
+```ruby
+# This is test_block8
+Set.new([1, 'c', :s]).size # Here Set.new was stubbed to return an Array and Array#size was stubbed to return 42
+# => 42
+```
+
 ## Configuration
 
 No configuation is required if you use Bundler. If not, set your `project_root` path using the setter method:
@@ -120,7 +142,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/minitest-markdown. Please checkout a suitably named branch before submitting a PR.
+Bug reports and pull requests are welcome on GitHub at https://gitlab.com/matzfan/minitest-markdown. Please checkout a suitably named branch before submitting a PR.
 
 ## License
 

data/lib/minitest/markdown/test_class.rb

@@ -20,9 +20,9 @@ module Minitest
         @ruby_blocks = parse_ruby_blocks
       end
 
-      def define_methods
+      def define_methods(stubs: {})
         define_non_test_methods
-        @ruby_blocks.each_with_index { |block, i| define_test_method(block, i) }
+        @ruby_blocks.each_with_index { |block, i| define_test_method(block, i, stubs[i]) }
         nil
       end
 
@@ -59,10 +59,14 @@ module Minitest
         @ruby_blocks.delete(blocks.first).fenced_block_str # hook method blocks can't be test methods
       end
 
-      def define_test_method(block, meth_index)
+      def define_test_method(block, meth_index, stub_chain = nil)
+        stub_chain ||= StubChain.new
         instance = self # scope
         klass.define_method(:"test_block#{meth_index}") do
-          block.assertions.each { |assertion_hash| instance.send(:evaluation_assertions, assertion_hash, binding) }
+          test_code_proc = proc do
+            block.assertions.each { |assertion_hash| instance.send(:evaluation_assertions, assertion_hash, binding) }
+          end
+          stub_chain.call(test_code_proc)
         end
       end
 

data/lib/minitest/markdown/version.rb

@@ -2,6 +2,6 @@
 
 module Minitest
   module Markdown
-    VERSION = '0.0.1.pre'
+    VERSION = '0.2.0.pre'
   end
 end

data/lib/minitest/markdown.rb

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+require 'minitest/stub_any_instance'
+
+require_relative 'stub_chain'
 require_relative 'markdown/configuration'
 require_relative 'markdown/error'
 require_relative 'markdown/version'
@@ -8,6 +11,8 @@ require_relative 'markdown/test_class'
 module Minitest
   # namespace
   module Markdown
+    ARG_ERR = 'stubs keyword takes a hash. Keys are integers and values are StubChain instances'
+
     class << self
       def config
         @config ||= Configuration.new
@@ -17,8 +22,12 @@ module Minitest
         yield config
       end
 
-      def generate_markdown_tests(klass, path: nil)
-        TestClass.new(klass, path: path).define_methods
+      def generate_markdown_tests(klass, path: nil, stubs: {})
+        raise ArgumentError, ARG_ERR unless stubs.is_a? Hash
+        raise ArgumentError, ARG_ERR unless stubs.keys.all? { |o| o.instance_of? Integer }
+        raise ArgumentError, ARG_ERR unless stubs.values.all? { |o| o.instance_of? StubChain }
+
+        TestClass.new(klass, path: path).define_methods(stubs: stubs)
       end
     end
   end

data/lib/minitest/stub_chain.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Minitest
+  # respresentaion of zero or more stub blocks around one or more test assertions
+  class StubChain
+    NOT_CALLABLE_ERR = 'StubChain#call takes a callable argument'
+    MUST_NOT_CALL_A_BLOCK_ERR = 'StubChain#call takes a callable argument which must not call a block'
+
+    attr_reader :stubs
+
+    def initialize(stubs = [])
+      @stubs = *stubs
+    end
+
+    def self.stubproc(klass, method, ret_val, any_instance: false)
+      return proc { |&blk| klass.stub(method, ret_val) { blk.call } } unless any_instance
+
+      proc { |&blk| klass.stub_any_instance(method, ret_val) { blk.call } }
+    end
+
+    def call(test_code_proc)
+      validate(test_code_proc)
+      stubs << test_code_proc
+      call_recursive
+    end
+
+    private
+
+    def validate(test_code_proc)
+      raise ArgumentError, NOT_CALLABLE_ERR unless test_code_proc.respond_to?(:call)
+
+      test_code_proc
+    end
+
+    def call_recursive
+      (prok = stubs.shift).call # "undefined method 'call' for nil" if proc calls a block - i.e. stubs
+    rescue NoMethodError
+      prok.call { call_recursive }
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: minitest-markdown
 version: !ruby/object:Gem::Version
-  version: 0.0.1.pre
+  version: 0.2.0.pre
 platform: ruby
 authors:
 - MatzFan
@@ -49,6 +49,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 5.25.2
+- !ruby/object:Gem::Dependency
+  name: minitest-stub_any_instance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 description: Generates tests for Ruby code blocks in any Markdown file.
 executables: []
 extensions: []
@@ -67,6 +81,7 @@ files:
 - lib/minitest/markdown/test_class.rb
 - lib/minitest/markdown/test_code_block.rb
 - lib/minitest/markdown/version.rb
+- lib/minitest/stub_chain.rb
 - sig/minitest/markdown.rbs
 homepage: https://gitlab.com/matzfan/minitest-markdown
 licenses:
@@ -89,7 +104,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 3.7.0.dev
 specification_version: 4
 summary: Turn your README.md Ruby code blocks into testable code.
 test_files: []