minitest-markdown 0.0.1.pre → 0.1.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6836d7576d3a208628f401e2660fac20d4288faf95c6513e76dd20a2a402fed2
-  data.tar.gz: 4f38166f7ff54f9a74391daafe8e698a7f0aabc57cf7a3797f292b3b8d85d524
+  metadata.gz: c4e1e286d2eead001d4b6e0d361aa9bb5c0a7019a5eb8d72eacf6635003e59da
+  data.tar.gz: 3f95349b886aa8752280e2fb2b5083d5bfc754ec8c4faed065dbb2a6e9b4d7e5
 SHA512:
-  metadata.gz: 393bc3aff42df19c5cfd10c2edddb64242798765d30aed3185e44be621547e0ed93f495113cca4082e388ab20f2da213f4f5ad4411b17f6117b1421c531d066a
-  data.tar.gz: a30d096c73f2064311cb2d729305fe5cc1d00cca871575fb75783d8046d28f5fc325d92882ccb886834358ed6a586f36eb397439829fba22f4d875c2f6e61998
+  metadata.gz: cd12cc6d7df1724100119b6e03e5960411d7d83b4de26beb0d4bbde0cc3e3f7a66e94901e5f99f051a82f70e058ffa1b103ee0726d103765bb9c405d661387e1
+  data.tar.gz: 11a4a61ba9044aec6811b9df724a111fa5345b29d837d91c8ee76a73e95939ca760243423e40127597d3b3ea0f040e633e31001d4268f33c8e06b5545efa0e06

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## [Unreleased]
 
+## [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,34 @@ 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 by passing a hash of procs using the stubs keyword. Hash keys represent the index of the text code block and the key is a proc which is called around the relevant test code. 2 convenience methods are provided by the `Markdown::Stubb` module. In your markdown test:
+```ruby
+class MarkdownTest < Minitest::Test
+  extend Markdown::Stubb # for the stubb & stubb_any_instance methods
+
+  stubs = {}
+  stubs[8] = stubb(Set, :new, []) # returns a proc
+  stubs[9] = stubb_any_instance(Set, :size, 42) # uses the bundled `minitest-stub_any_instance` extension
+
+  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]) # Set.new stubbed to return an Array
+# => instance_of Array
+```
+```ruby
+# This is test_block9
+Set.new([1, 'c', :s]).size # Set#size stubbed to return 42
+# => 42
+```
+Presently only one stub per test is possible.
+
 ## Configuration
 
 No configuation is required if you use Bundler. If not, set your `project_root` path using the setter method:
@@ -120,7 +148,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/stubb.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Minitest
+  module Markdown
+    # a proc'ed stub
+    module Stubb
+      def stubb(object, method, ret_val, *args, **kwargs)
+        proc { |&blk| object.stub(method, ret_val, *args, **kwargs) { blk.call } }
+      end
+
+      def stubb_any_instance(object, method, ret_val, *args, **kwargs)
+        proc { |&blk| object.stub_any_instance(method, ret_val, *args, **kwargs) { blk.call } }
+      end
+    end
+  end
+end

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,13 @@ 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 = nil)
+        stub ||= proc { |&blk| blk.call } # empty proc if no stub provided
         instance = self # scope
         klass.define_method(:"test_block#{meth_index}") do
-          block.assertions.each { |assertion_hash| instance.send(:evaluation_assertions, assertion_hash, binding) }
+          stub.call do
+            block.assertions.each { |assertion_hash| instance.send(:evaluation_assertions, assertion_hash, binding) }
+          end
         end
       end
 

data/lib/minitest/markdown/version.rb

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

data/lib/minitest/markdown.rb

@@ -1,7 +1,10 @@
 # frozen_string_literal: true
 
+require 'minitest/stub_any_instance'
+
 require_relative 'markdown/configuration'
 require_relative 'markdown/error'
+require_relative 'markdown/stubb'
 require_relative 'markdown/version'
 require_relative 'markdown/test_class'
 
@@ -17,8 +20,8 @@ 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: {})
+        TestClass.new(klass, path: path).define_methods(stubs: stubs)
       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.1.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: []
@@ -64,6 +78,7 @@ files:
 - lib/minitest/markdown.rb
 - lib/minitest/markdown/configuration.rb
 - lib/minitest/markdown/error.rb
+- lib/minitest/markdown/stubb.rb
 - lib/minitest/markdown/test_class.rb
 - lib/minitest/markdown/test_code_block.rb
 - lib/minitest/markdown/version.rb
@@ -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.6.8
 specification_version: 4
 summary: Turn your README.md Ruby code blocks into testable code.
 test_files: []