minitest-markdown 0.0.0.pre → 0.1.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d1ee2803d0dd9c5009efdbfb7510395c875617f325d9f506b3e6f5dcf011565
-  data.tar.gz: 39534d84dbfdef4d58e1c55e9e5479e3b9d697637cd04dd82a75b3e2892b57c2
+  metadata.gz: c4e1e286d2eead001d4b6e0d361aa9bb5c0a7019a5eb8d72eacf6635003e59da
+  data.tar.gz: 3f95349b886aa8752280e2fb2b5083d5bfc754ec8c4faed065dbb2a6e9b4d7e5
 SHA512:
-  metadata.gz: 1703b4fe13cd34c08c999dfc5dbbe8a5cd85a439e9411b3c645575424d0df365798c85745707c275dd59e750ff34eb1ee67ec30724d4f45700d78f66c297a59e
-  data.tar.gz: fc492517b52b8c6542d444dba33f2b5c0f532c156b19d6d2c336a0f11e3bf6ee717aab2652334b7a2f37ecce1cbb6cbfbbe56a9affa25e06339cffa60213edb3
+  metadata.gz: cd12cc6d7df1724100119b6e03e5960411d7d83b4de26beb0d4bbde0cc3e3f7a66e94901e5f99f051a82f70e058ffa1b103ee0726d103765bb9c405d661387e1
+  data.tar.gz: 11a4a61ba9044aec6811b9df724a111fa5345b29d837d91c8ee76a73e95939ca760243423e40127597d3b3ea0f040e633e31001d4268f33c8e06b5545efa0e06

data/.rubocop.yml

@@ -1,5 +1,5 @@
 ---
-require:
+plugins:
   - rubocop-minitest
   - rubocop-performance
   - rubocop-rake
@@ -7,6 +7,9 @@ require:
 AllCops:
   TargetRubyVersion: 3.1
   NewCops: enable
+  Exclude:
+    - 'vendor/**/*'  # GitLab caching..
+    - test/fixtures/klass.rb
 
 Lint/InterpolationCheck:
   Enabled: false

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 ## [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
+- Fix 'method redefined' warning in tests
+- Fix undefined method 'assert' for module 'Minitest::Assertions' in AssertionExtensions
+- Fix bug with expected value strings with multiple spaces
+
 ## [0.0.0.pre] - 2024-09-26
 
 - Initial release

data/README.md

@@ -1,3 +1,6 @@
+[![Gem Version](https://badge.fury.io/rb/minitest-markdown.svg)](https://badge.fury.io/rb/minitest-markdown)
+[![Ruby Style Guide](https://img.shields.io/badge/code_style-rubocop-brightgreen.svg)](https://github.com/rubocop/rubocop)
+
 # Minitest extension for testing Ruby code blocks in your README and other Markdown files
 
 ## \_why?
@@ -27,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
@@ -38,24 +41,23 @@ To test Ruby blocks in another Markdown file, create another test file and pass
 
 Each Markdown file is represented by a single test class and each Ruby block in a file becomes a test method with zero or more assertions. The syntax used is `# => ` followed by an assertion keyword. Keywords may be one of the [Minitest "assert_" assertions](https://docs.seattlerb.org/minitest/Minitest/Assertions.html) less the "assert_" prefix (refutations are not implemented at this time). If the keyword is omitted, the default assertion; `assert_equal` is used. The actual value passed to the assertion is the result of the evaluation of the Ruby code above each magic comment. The following block (a single test) includes 3 assertions:
 ```ruby
-# the code will of course be in your lib's, but for demonstration purposes:
-class Foo
-  def bar
-    'Hello Markdown!'
-  end
-end
+File.read 'test/fixtures/klass.rb'
+# => "class Klass\n  def hello\n    'Hello Markdown!'\n  end\nend"
+
+require 'test/fixtures/klass' # a demonstration 
+# => true
 
 # ordinary comments are ignored.
 
-foo = Foo.new # inline comments are also ignored
+Klass.new # inline comments are also ignored
 # The assertion and expected value are:-
-# => instance_of Foo
+# => instance_of Klass
 
 # No keywword here, so the default assertion is used (assert_equal)
-Foo.new.bar
+Klass.new.hello
 # => 'Hello Markdown!'
 
-Foo.bar
+Klass.hello
 # => raises NoMethodError
 ```
 Plain old `assert` has been aliased as `assert_truthy`, so when expecting a truthy value you should do this:
@@ -99,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:
@@ -118,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/assertions_extensions.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'minitest/assertions'
+
 module Minitest
   # patch
   module Assertions
@@ -7,11 +9,11 @@ module Minitest
     alias assert_included_in assert_includes
 
     # extensions
-    module AssertionExtensions
+    module AssertionsExtensions
       WITH_BLOCK_EVAL = %i[assert_output assert_pattern assert_raises assert_silent assert_throws refute_pattern].freeze
       EXPECTED_ACTUAL_REVERSED = %i[assert_includes assert_operator assert_predicate assert_respond_to].freeze
     end
 
-    Assertions.prepend AssertionExtensions
+    Assertions.prepend AssertionsExtensions
   end
 end

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,17 +59,20 @@ 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
 
       def evaluation_assertions(assertion_hash, bind)
         ruby, assertion, args = TestCodeBlock::ASSERTION_KEYS.map { |key| assertion_hash[key] } # order dep
 
-        lmbda = -> { eval(ruby) } # rubocop:disable Security/Eval # TODO: assign a binding
+        lmbda = -> { eval(ruby) } # rubocop:disable Security/Eval
         return unless assertion
         return eval_with_block(bind, assertion, lmbda, args) if Assertions::WITH_BLOCK_EVAL.include? assertion
 

data/lib/minitest/markdown/test_code_block.rb

@@ -45,9 +45,15 @@ module Minitest
       end
 
       def parse(magic_comment_string)
-        arr = magic_comment_string.split
-        assertion = self.class.assertions_map[arr.first.to_sym]
-        assertion ? [assertion, "[#{arr[1..].join(' ')}]"] : [DEFAULT_ASSERTION, "[#{arr.join(' ')}]"] # args in []
+        assertion = parse_assertion(magic_comment_string)
+        return [DEFAULT_ASSERTION, "[#{magic_comment_string}]"] if assertion.nil?
+        return [assertion, '[]'] if magic_comment_string.split.size == 1
+
+        [assertion, "[#{magic_comment_string.sub(/#{assertion.to_s.sub(ASSERT_, '')}\s+/, '')}]"]
+      end
+
+      def parse_assertion(str)
+        self.class.assertions_map[str.split.first.to_sym]
       end
 
       def magic_comments

data/lib/minitest/markdown/version.rb

@@ -2,6 +2,6 @@
 
 module Minitest
   module Markdown
-    VERSION = '0.0.0.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,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: minitest-markdown
 version: !ruby/object:Gem::Version
-  version: 0.0.0.pre
+  version: 0.1.0.pre
 platform: ruby
 authors:
 - MatzFan
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-09-26 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minifyrb
@@ -37,6 +36,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.25'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.25.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -44,8 +46,24 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.25'
+    - - ">="
+      - !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.
-email:
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -60,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
@@ -71,7 +90,6 @@ metadata:
   source_code_uri: https://gitlab.com/matzfan/minitest-markdown
   changelog_uri: https://gitlab.com/matzfan/minitest-markdown/-/blob/master/CHANGELOG.md
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -86,8 +104,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.19
-signing_key:
+rubygems_version: 3.6.8
 specification_version: 4
 summary: Turn your README.md Ruby code blocks into testable code.
 test_files: []