minitest-markdown 0.2.1.pre → 0.2.2.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 959c342f3e4ec34238e2385e3578faf1d5133beb2f74d9b52d4ffc9ab0dc8d58
-  data.tar.gz: 8b4bae7c2888040d6b2124fa2bd5d103c67405c883bf3de606f220e317912249
+  metadata.gz: 0a9a40aad00d3cf796ff92234e9677cc452131a2ca0ff09936d77de0155e1cd7
+  data.tar.gz: 57e2ce0e6b9b4a3752a621dde91cdf8e483dca82efa4eb6373a2de04f2175769
 SHA512:
-  metadata.gz: e3d59e3fc4f77092cdd8dda4f3a0b8a8d79e1b73cbfc37186947efd6dbb0e35f508ab0d32da4f6a88d4c816d72370ff92b563e819c44073da4ea44404b946acb
-  data.tar.gz: 2522d752e44a422f82be9ccb1a44c9ddec8346381d2cb0465990a7eee5b383e0a6b664c7f7b52c9ba860602c2a78411dc9f225c4a580bc287f65c26fbace05ad
+  metadata.gz: a09e92d607c2484518f8f23fac73e709de766b62f41d17bdfeaccc4931293b2e00cbdf35a5ad4872be6aae6f4022a6579d38dc31c23a5581191c16c85924b596
+  data.tar.gz: 96fbb9758bfd397dcce743c0f76c9e78e6155b4fd5f4a299e9c64bb304503732565f4310b348032a43fb4febccab3e7eb79b1cc12aa3a21b82563fc2760d829d

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## [Unreleased]
 
+## [0.2.2.pre] - 2025-05-08
+
+- Improve magic comment & hook comment parsing
+- Fix bug with empty sting after magic comment
+- Fix bug in config if Bundler undefined
+
 ## [0.2.1.pre] - 2025-05-07
 
 - Fix issue with require in eval

data/README.md

@@ -21,6 +21,17 @@ If bundler is not being used to manage dependencies, install the gem by executin
 gem install minitest-markdown
 ```
 
+## Configuration
+
+No configuation is required if you use Bundler. If not, set your `project_root` path using the setter method:
+```ruby
+@config = Markdown.config
+# => instance_of Configuration
+
+Configuration.instance_methods(false)
+# => includes :project_root=
+```
+
 ## Usage
 
 ### In your test class
@@ -106,13 +117,13 @@ Everything in the code blocks above runs as test code. [minitest-proveit](https:
 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
+  set_stubs_new = Minitest::StubChain.stubproc(Set, :new, Set.new) # returns a proc which stubs Set.new to return an empty set
+  set_stubs_size = Minitest::StubChain.stubproc(Set, :size, 42, any_instance: true) # uses the bundled minitest-stub_any_instance gem
 
   stubs = {}
-  @stub_chain = Minitest::StubChain.new([set_stubs_new, array_stubs_size]) # initialized with zero or more stub procs
-  stubs[8] = @stub_chain
-  stubs[9] = @stub_chain # StubChain instances themseves may be reused
+  @stub_chain = Minitest::StubChain.new([set_stubs_new, set_stubs_size]) # initialized with zero or more stub procs
+  stubs[9] = @stub_chain
+  stubs[10] = @stub_chain # StubChain instances themseves may be reused
 
   Markdown.generate_markdown_tests(self, stubs: stubs)
 end
@@ -120,27 +131,20 @@ end
 ```
 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
+# This is test_block9
+Set.new([1, 'c', :s]).size # Here Set.new was stubbed to return an empty set and Set#size was stubbed to return 42
 # => 42
 ```
 Example showing the reuse of a StubChain:
 ```ruby
-# This is test_block9
-Set.new([]).size
+# This is test_block10
+Set.new.size
 # => 42
 ```
 
-## Configuration
+### Errors
 
-No configuation is required if you use Bundler. If not, set your `project_root` path using the setter method:
-```ruby
-@config = Markdown.config
-# => instance_of Configuration
-
-Configuration.instance_methods(false)
-# => includes :project_root=
-```
+All errors subclass `Markdown::Error`
 
 ## Development
 

data/lib/minitest/markdown/configuration.rb

@@ -2,29 +2,32 @@
 
 require 'pathname'
 
-require_relative 'error'
+require_relative 'errors'
 
 module Minitest
   module Markdown
     # configuration for gem
     class Configuration
-      attr_accessor :project_root, :prove_it
+      PROJECT_ROOT_UNDETERMINED = "Project root can't be determined, set with 'Markdown.config.project_root = /path'"
+
+      attr_writer :project_root
+      attr_accessor :prove_it
 
       def initialize
-        @project_root = determine_project_root
+        @project_root = self.class.determine_project_root
         @prove_it = true
       end
 
-      def readme_path
-        project_root.join 'README.md'
+      def self.determine_project_root
+        Bundler.root if defined? Bundler
       end
 
-      private
-
-      def determine_project_root
-        return Bundler.root if defined? Bundler
+      def project_root
+        @project_root || (raise Error, PROJECT_ROOT_UNDETERMINED)
+      end
 
-        raise Error::MarkdownError, "Project root can't be determined, set with 'Config.project_root = /root/path'"
+      def readme_path
+        project_root.join 'README.md'
       end
     end
   end

data/lib/minitest/markdown/{error.rb → errors.rb}

@@ -2,8 +2,6 @@
 
 module Minitest
   module Markdown
-    module Error
-      class MarkdownError < StandardError; end
-    end
+    class Error < StandardError; end
   end
 end

data/lib/minitest/markdown/test_class.rb

@@ -13,12 +13,15 @@ module Minitest
       HOOK_METHODS = %i[before_all after_all around around_all].freeze # minitest-hooks extension
       NON_TEST_METHODS = %i[setup teardown].freeze
 
+      BAD_KLASS = 'TestClass must be instantiated with Minitest::Test or subclass thereof'
+      BAD_PATH = 'Path does not exist or is not readable:'
+
       attr_reader :klass, :path
 
       def initialize(klass, path: nil)
-        @klass = klass
+        @klass = validate_class(klass)
         @config = Markdown.config
-        @path = path || @config.readme_path
+        @path = validate_path(path)
         @ruby_blocks = parse_ruby_blocks
       end
 
@@ -30,6 +33,19 @@ module Minitest
 
       private
 
+      def validate_class(klass)
+        raise ArgumentError, BAD_KLASS unless klass.respond_to?(:ancestors) && klass.ancestors.include?(Minitest::Test)
+
+        klass
+      end
+
+      def validate_path(path)
+        return @config.readme_path if path.nil?
+        raise ArgumentError, "#{BAD_PATH} #{path}" unless File.exist?(path) && File.file?(path)
+
+        path
+      end
+
       def parse_ruby_blocks
         File.new(path).read.scan(FENCED_BLOCK_REGEXP).flatten.map { |str| TestCodeBlock.new(str) }
       end
@@ -54,13 +70,17 @@ module Minitest
       end
 
       def parse_non_test_method_block(type)
-        blocks = @ruby_blocks.map.select { |blk| blk.fenced_block_str.lines.first == "# #{type}\n" }
+        blocks = @ruby_blocks.map.select { |blk| parse_type(blk, type) }
         return if blocks.empty?
-        raise Error::MarkdownError, "Multiple #{type} blocks are not allowed" if blocks.size > 1
+        raise Error, "Multiple #{type} blocks are not allowed" if blocks.size > 1
 
         @ruby_blocks.delete(blocks.first).fenced_block_str # hook method blocks can't be test methods
       end
 
+      def parse_type(blk, type)
+        blk.fenced_block_str.lines.first.match?(/^\s*#\s*#{type}\s*\n$/)
+      end
+
       def define_test_method(block, meth_index, stub_chain = nil)
         stub_chain ||= StubChain.new
         instance = self # scope
@@ -75,7 +95,7 @@ module Minitest
       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
+        lmbda = -> { kernel_eval(ruby) }
         return unless assertion
         return eval_with_block(bind, assertion, lmbda, args) if Assertions::WITH_BLOCK_EVAL.include? assertion
 
@@ -85,20 +105,26 @@ module Minitest
       def eval_with_block(bind, assertion, actual, args)
         return bind.receiver.send(assertion, &actual) if args.empty?
 
-        bind.receiver.send(assertion, *eval(args), &actual) # rubocop:disable Security/Eval
+        bind.receiver.send(assertion, *kernel_eval(args), &actual)
       end
 
       def eval_without_block(bind, assertion, lmbda, args)
         actual = lmbda.call
         return bind.receiver.send(assertion, actual) if args == '[]'
 
-        expected, *rest = eval(args) # rubocop:disable Security/Eval
+        expected, *rest = kernel_eval(args)
         expected, actual = actual, expected if Assertions::EXPECTED_ACTUAL_REVERSED.include? assertion
         kwargs = rest.last.is_a?(Hash) ? rest.last : nil
         return bind.receiver.send(assertion, expected, actual, *rest) unless kwargs
 
         bind.receiver.send(assertion, expected, actual, *rest, **kwargs) # assert_respond_to takes a kwarg..
       end
+
+      def kernel_eval(args)
+        eval args # rubocop:disable Security/Eval
+      rescue SyntaxError
+        raise ArgumentError, "Invalid test code, failed to parse #{args}"
+      end
     end
   end
 end

data/lib/minitest/markdown/test_code_block.rb

@@ -3,7 +3,7 @@
 require 'minifyrb' # DEP
 
 require_relative '../assertions_extensions' # for assert_truthy
-require_relative '../markdown/error'
+require_relative '../markdown/errors'
 
 module Minitest
   module Markdown
@@ -16,9 +16,9 @@ module Minitest
 
       ASSERTION_KEYS = %i[ruby assertion test_args].freeze
 
-      MAGIC_COMMENT_DELIMITER = '# => '
-      MAGIC_COMMENT_REGEXP = /^#{MAGIC_COMMENT_DELIMITER}.*$/
-      MAGIC_COMMENT_SCAN_REGEXP = /^#{MAGIC_COMMENT_DELIMITER}(.*)$/ # strips delimiter prefix
+      MAGIC_COMMENT_DELIMITER = '=>'
+      MAGIC_COMMENT_REGEXP = /^\s*#\s*#{MAGIC_COMMENT_DELIMITER}.*$/
+      MAGIC_COMMENT_SCAN_REGEXP = /^\s*#\s*#{MAGIC_COMMENT_DELIMITER}(.*)$/ # strips delimiter prefix
 
       attr_reader :fenced_block_str
 
@@ -41,10 +41,12 @@ module Minitest
       private
 
       def assertions_arr
-        code_strings.zip(magic_comments.map { |s| parse(s) }).map(&:flatten)
+        code_strings.zip(magic_comments.each_with_index.map { |s, i| parse(s, i) }).map(&:flatten)
       end
 
-      def parse(magic_comment_string)
+      def parse(magic_comment_string, idx)
+        raise ArgumentError, "Block#{idx} magic comment missing assertion or value" if magic_comment_string.strip.empty?
+
         assertion = parse_assertion(magic_comment_string)
         return [DEFAULT_ASSERTION, "[#{magic_comment_string}]"] if assertion.nil?
         return [assertion, '[]'] if magic_comment_string.split.size == 1
@@ -57,14 +59,14 @@ module Minitest
       end
 
       def magic_comments
-        @fenced_block_str.scan(MAGIC_COMMENT_SCAN_REGEXP).flatten
+        @fenced_block_str.scan(MAGIC_COMMENT_SCAN_REGEXP).flatten.map(&:strip)
       end
 
       def code_strings
         @fenced_block_str.split(MAGIC_COMMENT_REGEXP).map do |str|
           Minifyrb::Minifier.new(str).minify.strip
         rescue SyntaxError
-          raise Error::MarkdownError, "Syntax error in:\n\n#{str}"
+          raise Error, "Syntax error in:\n\n#{str}"
         end
       end
     end

data/lib/minitest/markdown/version.rb

@@ -2,6 +2,6 @@
 
 module Minitest
   module Markdown
-    VERSION = '0.2.1.pre'
+    VERSION = '0.2.2.pre'
   end
 end

data/lib/minitest/markdown.rb

@@ -4,7 +4,7 @@ require 'minitest/stub_any_instance'
 
 require_relative 'stub_chain'
 require_relative 'markdown/configuration'
-require_relative 'markdown/error'
+require_relative 'markdown/errors'
 require_relative 'markdown/version'
 require_relative 'markdown/test_class'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: minitest-markdown
 version: !ruby/object:Gem::Version
-  version: 0.2.1.pre
+  version: 0.2.2.pre
 platform: ruby
 authors:
 - MatzFan
@@ -77,7 +77,7 @@ files:
 - lib/minitest/assertions_extensions.rb
 - lib/minitest/markdown.rb
 - lib/minitest/markdown/configuration.rb
-- lib/minitest/markdown/error.rb
+- lib/minitest/markdown/errors.rb
 - lib/minitest/markdown/test_class.rb
 - lib/minitest/markdown/test_code_block.rb
 - lib/minitest/markdown/version.rb