docspec 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b8a5c9b5152aec40381604f7b29473d9df865cba3cd650cd1b70dda2115e9165
-  data.tar.gz: 618428c8f9733ee701f6e2fb4babd5c1da39e85c0db601ae8b0f07e9f942e864
+  metadata.gz: 7f995211f9a696fc2d183baf3f9e4e36eea49138eb284dc131538bd091155c0b
+  data.tar.gz: d9ab2eed21925c84af410ab1f8738b284cd46c828b7b839edd1665b6e590673f
 SHA512:
-  metadata.gz: 2a2eacb5a463a059419863bf58676146b73e9398c5ec94563e444525865764bf2ba1814bc4cdb9980983a1314d7c8951c3be0b23f7cb3a6a4b7e312d46761164
-  data.tar.gz: 5de5e31541b08ba45594da601462db482b6c677eae357026b75678fb0d50dbaad861f4e86e339f2dbcdd5760fc13ae22f47d4577e39e604be83e971ef598e75a
+  metadata.gz: 4d1b6ba6f8dba292df58c9b381afd69b7205c534bc9adb7a42aabdc623fb2537f9798e9d4855fc8f57a0858bd486030d329d53d56c96442e0afd3b0999393f34
+  data.tar.gz: 66aff11ef3b75ff2633c083f9adfdca2d3639223f55caf081fcbcd2d586b16f60a29e8889ceb8f33da85199bf977b915be92ab44f69af79d885a069dc2eb7590

data/README.md

@@ -68,6 +68,7 @@ puts document.success?
 # Test a file using the CLI class
 runner = Docspec::CLI.new 'test/sample.md'
 success = runner.run
+#=> file : test/sample.md
 #=> pass : Sample Test
 #=> 
 #=> 1 tests, 0 failed
@@ -75,8 +76,8 @@ success = runner.run
 
 
 ```ruby
-# Test a folder using the CLI class
-runner = Docspec::CLI.new 'test'
+# Test multiple folders/files using the CLI class
+runner = Docspec::CLI.new 'test', 'test/sample.md'
 success = runner.run
 #=> file : test/folder/another.md
 #=> pass : Another Sample Test
@@ -89,8 +90,11 @@ success = runner.run
 #=> void : echo shell
 #=> pass : puts "ruby"
 #=> void : puts "ruby"
+#=> 
+#=> file : test/sample.md
+#=> pass : Sample Test
 #=>
-#=> 6 tests, 0 failed
+#=> 7 tests, 0 failed
 
 ```
 
@@ -113,7 +117,16 @@ string of that exception:
 ```ruby
 # Exceptions are captured
 puts "hello".camel_case
-#=> #<NoMethodError: undefined method `camel_case' for "hello":String>
+#=> #<NoMethodError: undefined method `camel_case' for ...
+```
+
+Using three dots at the beginning or end of the expected output (like in the
+above example) will perform a partial match:
+
+```ruby
+# Ellipsis match
+puts "the beginning will be ignored as well as the end"
+#=> ... will be ignored ...
 ```
 
 Your code and expected output can contain multiple lines of code:

data/bin/docspec

@@ -1,5 +1,6 @@
 #!/usr/bin/env ruby
-if Gem.loaded_specs.has_key?('simplecov') && !ENV['DISABLE_SIMPLECOV']
+disabled = ENV['DOCSPEC_NOCOV'] || ENV['NOCOV']
+if Gem.loaded_specs.has_key?('simplecov') && !disabled
   require 'simplecov'
   SimpleCov.configure do
     command_name ENV['SIMPLECOV_COMMAND'] || 'Docspec'
@@ -10,6 +11,6 @@ end
 require 'docspec'
 require 'docspec/cli'
 
-runner = Docspec::CLI.new ARGV[0]
+runner = Docspec::CLI.new(*ARGV)
 success = runner.run
 exit success ? 0 : 1

data/lib/docspec/cli.rb

@@ -1,48 +1,48 @@
 require 'colsole'
-include Colsole
 
 module Docspec
   class CLI
-    attr_reader :target, :exit_code, :total_examples, :failed_examples
+    include Colsole
 
-    def initialize(target = nil)
-      @target = target || 'README.md'
-    end
+    attr_reader :targets, :exit_code, :total_examples, :failed_examples
 
-    def mode
-      File.directory?(target) ? :dir : :file
+    def initialize(*targets)
+      targets = ['README.md'] if targets.empty?
+      @targets = targets
     end
 
     def run
-      abort "Target not found: #{target}" unless File.exist? target
-
       @exit_code = 0
       @total_examples = 0
       @failed_examples = 0
 
-      if mode == :dir
-        run_dir
-      else
-        run_file target
-      end
+      targets.each { |target| run_target target }
 
       show_footer
     end
 
   private
 
-    def run_dir
-      all_success = true
-      Dir["#{target}/**/*.md"].sort.each do |file|
-        say ''
-        say "c`file : #{file}`"
-        success = run_file file
-        all_success = false unless success
+    def run_target(target)
+      abort "Target not found: #{target}" unless File.exist? target
+
+      if File.directory? target
+        run_dir target
+      else
+        run_file target
+      end
+    end
+
+    def run_dir(dir)
+      Dir["#{dir}/**/*.md"].each do |file|
+        run_file file
       end
-      all_success
     end
 
     def run_file(file)
+      say ''
+      say "c`file : #{file}`"
+
       document = Docspec::Document.from_file file
       document.test
 

data/lib/docspec/example.rb

@@ -3,6 +3,8 @@ require 'diffy'
 module Docspec
   class Example
     include OutputCapturer
+    using StringRefinements
+
     attr_reader :code, :type, :before
 
     def initialize(type:, code:, before: nil)
@@ -60,7 +62,11 @@ module Docspec
     end
 
     def success?
-      actual == expected
+      if expected.include? '...'
+        expected.ellipses_match? actual
+      else
+        actual == expected
+      end
     end
 
   protected
@@ -68,10 +74,8 @@ module Docspec
     def actual!
       capture_output do
         case type
-        when 'ruby'
-          eval full_code
-        when 'shell'
-          puts `#{full_code}`
+        when 'ruby' then eval full_code
+        when 'shell' then puts `#{full_code}`
         end
       end.strip
     end

data/lib/docspec/refinements.rb

@@ -0,0 +1,14 @@
+module Docspec
+  module StringRefinements
+    refine String do
+      def ellipses_match?(other)
+        str = self
+
+        str = str[3..-1] if str.start_with?('...')
+        str = str[0..-4] if str.end_with?('...')
+
+        other.include?(str)
+      end
+    end
+  end
+end

data/lib/docspec/version.rb

@@ -1,3 +1,3 @@
 module Docspec
-  VERSION = '0.1.3'
+  VERSION = '0.2.0'
 end

data/lib/docspec.rb

@@ -1,6 +1,7 @@
-require 'byebug' if ENV['BYEBUG']
+require 'docspec/refinements'
 
+require 'docspec/testable'
 require 'docspec/output_capturer'
+
 require 'docspec/example'
-require 'docspec/testable'
 require 'docspec/document'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: docspec
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Danny Ben Shitrit
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-17 00:00:00.000000000 Z
+date: 2024-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole
@@ -58,14 +58,18 @@ files:
 - lib/docspec/document.rb
 - lib/docspec/example.rb
 - lib/docspec/output_capturer.rb
+- lib/docspec/refinements.rb
 - lib/docspec/testable.rb
 - lib/docspec/version.rb
 homepage: https://github.com/dannyben/docspec
 licenses:
 - MIT
 metadata:
+  bug_tracker_uri: https://github.com/DannyBen/docspec/issues
+  changelog_uri: https://github.com/DannyBen/docspec/blob/master/CHANGELOG.md
+  source_code_uri: https://github.com/DannyBen/docspec
   rubygems_mfa_required: 'true'
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -73,15 +77,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.8
-signing_key: 
+rubygems_version: 3.5.14
+signing_key:
 specification_version: 4
 summary: Embedded tests in Markdown documents
 test_files: []