probatio 1.2.1 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd1f950d5d015ce5c74dea984568661b91aace4fafd7eb7904d6e4ce5a0d378d
-  data.tar.gz: 0a4b0bfc642e0a4b3e5f1a05b774e75bf9e1abc39c23d44dad0a7198c036ff26
+  metadata.gz: 5935c5e5ed80703f327b9080a0853dec130b1e5b595f29a5ee914a493865368b
+  data.tar.gz: 37167cd9088927754eddc83b2f75a765be851c6e6c2b602e1f77d6c1c60b681e
 SHA512:
-  metadata.gz: 46a775f846dbc48ee13b0626d3dd469e402eee354433e5d7d95ccd1481d6518418e1475afeac0e7cf6c2ebca1df1278c5c1a6f014c2be58e4543f9ac14d3c1ac
-  data.tar.gz: 33e87186c8baa159a43d1491e3fe580069dd0288337b85a3351380f74a4c2c5a2fc80660efa34b3b48691d4866deb44afcbc7d733d622dd4d7fe6fd4c27b94d8
+  metadata.gz: d3ac2a8013890f1b9d05bf2b836e2360081082a99135173976685c6cd7d4bac74534771c2d4e7d4e358577632b97377a8998e2c4715386b6e9b0da20f743c10b
+  data.tar.gz: e0e7595dd5163fa4c43f574dea4af27eb03ea684ed10ed54c6f50ceaecd2db81dc6c328b409ff80374419f94cf5b3d6fd308caf1928c2ab5eadd982e25f65ece

data/CHANGELOG.md

@@ -2,6 +2,18 @@
 # CHANGELOG.md
 
 
+## probatio 1.4.0 released 2025-10-13
+
+* Work on StringDiff, HashDiff, and ArrayDiff
+* Use diff-lcs for StringDiff
+
+
+## probatio 1.3.0 released 2025-08-08
+
+* Add windows? and jruby? to Probatio::Group
+* Alias `assert_nothing_raised` to `assert_no_error`
+
+
 ## probatio 1.2.1 released 2025-05-20
 
 * Tighten Probatio.beep and friends

data/README.md

@@ -39,6 +39,7 @@ Usage: bundle exec proba [OPTIONS] [DIRS] [FILES] [OTHERS] [ENVS]
     -d, --debug smr        's' for start opts, 'm' for messages, 'r' for $DEBUG
     -x, --example          Outputs an example test file
     -X, --plugin-example   Outputs an example plugin file
+    -b, --beep[s] {n || 1} Beeps n time before exit
     --mangle               Turns the given _spec.rb files into proba _test.rb
 
   Dirs:
@@ -174,6 +175,8 @@ group 'core' do
       assert_no_error lambda { do_this_or_that() }
       assert_not_error { do_this_or_that() }
       assert_not_error lambda { do_this_or_that() }
+      assert_nothing_raised { do_this_or_that() }
+      assert_nothing_raised lambda { do_this_or_that() }
         # checks that the block or Proc does not raise an error
 
       assert_hashy(
@@ -230,6 +233,51 @@ group 'core < sub-core < sub-sub-core' do
   test 'that' do
   end
 end
+
+
+group 'notcore' do
+
+  # A section allows for some kind of "inheritance" between groups...
+  #
+  section 'with db' do
+
+    setup do
+
+      prepare_db
+    end
+
+    before do
+
+      reset_and_load_fixtures
+    end
+  end
+
+  group 'alpha' do
+
+    group 'without db' do
+
+      # ...
+    end
+
+    group 'with db' do
+
+      # gets the setup and before from the "with db" section
+    end
+  end
+
+  group 'bravo' do
+
+    group 'without db' do
+
+      # ...
+    end
+
+    group 'with db' do
+
+      # gets the setup and before from the "with db" section
+    end
+  end
+end
 ```
 
 
@@ -276,10 +324,13 @@ some_env:
   {
   USER: "jmettraux",
   HOME: "/home/jmettraux",
-  PATH: "/home/jmettraux/.gem/ruby/3.3/bin:/home/jmettraux/.pkg_rubies/ruby33:/usr/local/jdk-21/bin:/home/jmettraux/bin:/bin:/usr/bin:/sbin:/usr/sbin:/usr/X11R6/bin:/usr/local/bin:/usr/local/sbin",
   SHELL: "/usr/local/bin/fish",
   GEM_HOME: "/home/jmettraux/.gem/ruby/3.3",
   PWD: "/home/jmettraux/w/probatio/test",
+  PATH:
+    "/home/jmettraux/.gem/ruby/3.3/bin:/home/jmettraux/.pkg_rubies/ruby33:" +
+    "/usr/local/jdk-21/bin:/home/jmettraux/bin:/bin:/usr/bin:/sbin:" +
+    "/usr/sbin:/usr/X11R6/bin:/usr/local/bin:/usr/local/sbin",
   },
 }
 ```
@@ -289,6 +340,28 @@ Probatio uses it when servicing `bundle exec proba 0` or `bundle exe proba -1`.
 It can also be useful to other tools around probatio.
 
 
+## Helpers
+
+Built-in helpers:
+```ruby
+  jruby?    # => returns true when running on JRuby
+  windows?  # => returns true when running on Windows
+```
+
+_Waiter_ helpers:
+```ruby
+  wait_for {
+    some_condition == true
+  }
+  wait_for(timeout: 60, frequency: 1) { # wait for 60 seconds, check every sec
+    some_condition == true
+  }
+  wait_until { # wait_until is an alias to wait_for
+    some_condition == true
+  }
+```
+
+
 ## Warnings
 
 ```

data/exe/proba

@@ -100,7 +100,7 @@ if switches['-h'] || switches['--help']
     -d, --debug smr        's' for start opts, 'm' for messages, 'r' for $DEBUG
     -x, --example          Outputs an example test file
     -X, --plugin-example   Outputs an example plugin file
-    -b, --beeps {n || 1}   Beeps n time before exit
+    -b, --beep[s] {n || 1} Beeps n time before exit
     --mangle               Turns the given _spec.rb files into proba _test.rb
 
   Dirs:

data/lib/probatio/assertions.rb

@@ -176,6 +176,7 @@ class Probatio::Context
       err && "no error expected but returned #{err.class} #{err.name}" }
   end
   alias assert_no_error assert_not_error
+  alias assert_nothing_raised assert_not_error
 
   # Checks whether its "_assert_something", if that's the case,
   # just flags the assertion as :pending an moves on
@@ -298,13 +299,13 @@ class Probatio::Context
 
   def extract_file_and_line(backtrace)
 
-    #l = backtrace.find { |l|
-    #  ! l.index('lib/probatio/assertions.rb') &&
-    #  ! l.index('_helper.rb') }
-    l = backtrace.find { |l| l.index('_test.rb') }
+    l =
+      backtrace.find { |l| l.index('_test.rb') } ||
+      backtrace.find { |l| ! l.index('/lib/probatio/') }
+    m =
+      l && l.match(/([^:]+):(\d+)/)
 
-    m = l && l.match(/([^:]+):(\d+)/)
-    m && [ m[1], m[2].to_i ]
+    m ? [ m[1], m[2].to_i ] : [ nil, -1 ]
   end
 
   def extract_assert_method(backtrace)

data/lib/probatio/errors.rb

@@ -0,0 +1,279 @@
+
+#
+# probatio/errors.rb
+
+module Probatio
+
+  class AssertionError < StandardError
+
+    attr_reader :assertion, :arguments, :test, :file, :line
+    attr_accessor :nested_error
+
+    alias path file
+
+    def initialize(assertion, arguments, error_or_message, test, file, line)
+
+      @assertion = assertion
+      @arguments = arguments
+
+      @test = test
+
+      @file = file
+      @line = line
+
+      if error_or_message.is_a?(String)
+        @msg = error_or_message
+      else
+        @msg = "error while asserting: " + error_or_message.message
+        @nested_error = error_or_message
+      end
+
+      super(@msg)
+    end
+
+    def location
+
+      [ @file, @line ]
+    end
+
+    def loc
+
+      location.map(&:to_s).join(':')
+    end
+
+    def to_s
+
+      "#{self.class.name}: #{@msg}"
+    end
+
+    def trail
+
+      @test.trail + "\n" +
+      Probatio.c.red("#{'  ' * (test.depth + 1)}#{loc} --> #{@msg}")
+    end
+
+    def source_line
+
+      @source_line ||=
+        File.readlines(@file)[@line - 1]
+    end
+
+    def source_lines
+
+      @source_lines ||=
+        Probatio::AssertionError.select_source_lines(@file, @line)
+    end
+
+    def summary(indent='')
+
+      nl = "\n" + indent
+
+      tw = Probatio.term_width - 4 - indent.length
+
+      as =
+        @arguments.find { |a| a.inspect.length > tw } ?
+          @arguments.collect { |a|
+            if (s0 = a.inspect).length < tw
+              nl + '    ' + s0 + "\n"
+            else
+              s1 = StringIO.new; PP.pp(a, s1, tw)
+              qualify_argument(a) + "\n" +
+              indent + s1.string.gsub(/^(.*)$/) { "    #{$1}" }
+            end } :
+        @arguments.collect(&:inspect)
+
+      s = StringIO.new
+      s << indent << @assertion << ':'
+
+      case @arguments.collect(&:class)
+      when [ Hash, Hash ]
+        as.each_with_index { |a, i| s << nl << '  %d: %s' % [ i, a ] }
+        output_hash_diff(indent, s)
+      when [ Array, Array ]
+        output_array_diff(indent, s)
+      when [ String, String ]
+        output_string_diff(indent, s)
+      else
+        as.each_with_index { |a, i| s << nl << '  %d: %s' % [ i, a ] }
+      end
+
+      s.string
+    end
+
+    class << self
+
+      def select_source_lines(path, line)
+
+        return [] unless path
+
+        File.readlines(path).each_with_index.to_a[line - 1..-1]
+          .map { |l, i| [ i + 1, l.rstrip ] }
+          .take_while { |_, l|
+            l = l.strip
+            l.length > 0 && l != 'end' && l != '}' }
+      end
+    end
+
+    protected
+
+    def output_hash_diff(indent, s)
+
+      nl = "\n" + indent
+
+      c = Probatio.c
+
+      d0 = @arguments[0].to_a - @arguments[1].to_a
+      d1 = @arguments[1].to_a - @arguments[0].to_a
+
+      dh = {}
+        d0.each { |k, v| dh[k] = [ v, nil ] }
+        d1.each { |k, v| dv = (dh[k] ||= [ nil, nil ]); dv[1] = v }
+
+      s << nl << '  Hash diff:'
+      dh.each do |k, (v0, v1)|
+        s << nl << '    ' << c.yellow(k.inspect) << c.dg << ' =>'
+        s << nl << '      ' << c.white(0) << c.dg << ': ' << v0.inspect
+        s << " -- has_key? #{@arguments[0].has_key?(k)}" if v0 == nil
+        s << nl << '      ' << c.white(1) << c.dg << ': ' << v1.inspect
+        s << " -- has_key? #{@arguments[1].has_key?(k)}" if v1 == nil
+      end
+    end
+
+    def output_string_diff(indent, s)
+
+      a0, a1 = @arguments
+      a0l, a1l = a0.length, a1.length
+      a0c, a1c = a0.lines.count, a1.lines.count
+
+      sep = "\n" + ('-' * 49)
+      c = Probatio.c
+
+      s <<
+        sep << " length: #{a0l} / lines: #{a0c}\n" <<
+          c.yellow << a0 << c.dark_grey <<
+        sep << " length: #{a1l} / lines: #{a1c}\n" <<
+          c.yellow << a1 << c.dark_grey <<
+        sep
+
+      ls0 = @arguments[0].lines.map(&:chomp)
+      ls1 = @arguments[1].lines.map(&:chomp)
+
+      return if ls0.length < 2 && ls1.length < 2
+
+      output_sdiff(ls0, ls1, s)
+    end
+
+    def output_array_diff(indent, s)
+
+      a0, a1 = @arguments
+      a0c, a1c = a0.count, a1.count
+
+      sep = "\n" + ('-' * 49)
+      c = Probatio.c
+
+      s << c.dg << sep << "length: #{a0c}\n" << c.white << a0.inspect
+      s << c.dg << sep << "length: #{a1c}\n" << c.white << a1.inspect
+      s << c.dg << sep
+
+      s0 = a0.collect { |e| e.is_a?(String) ? e : e.inspect }
+      s1 = a1.collect { |e| e.is_a?(String) ? e : e.inspect }
+
+      output_sdiff(s0, s1, s)
+    end
+
+    def output_sdiff(a0, a1, s)
+
+      c = Probatio.c
+      nl = "\n"
+      sep = "\n" + ('-' * 49)
+
+      diff = Diff::LCS.sdiff(a0, a1).collect(&:to_a)
+
+      maxl = diff
+        .inject([]) { |a, d| a << d[1][0]; a << d[2][0]; a }
+        .max.to_s.length
+      forl = "%0#{maxl}d"
+
+      #ov = c.rev(' ')
+      ov = c.dg + c.rev('<')
+      fence = lambda { |s| s + (s.match?(/\s$/) ? ov : '') }
+
+      s << nl << c.dg << sep
+      diff.each do |d|
+        if d[0] == '='
+          s << nl << c.dg << '= ' << (forl % d[1][0]) << ' ' << d[1][1]
+        elsif d[0] == '+'
+#s << nl << d.inspect
+          s << nl << c.gn << '+ ' << (forl % d[2][0]) << ' ' << fence[d[2][1]]
+        elsif d[0] == '-'
+#s << nl << d.inspect
+          s << nl << c.rd << '- ' << (forl % d[1][0]) << ' ' << fence[d[1][1]]
+        else # '!'
+          a, b = d[1], d[2]
+          s << nl << c.y << '! ' << (forl % a[0]) << ' ' << fence[a[1]]
+          s << nl << c.y << '  ' << (forl % b[0]) << ' ' << fence[b[1]]
+        end
+      end
+      s << c.dg << sep << c.reset
+    end
+
+    def qualify_argument(a)
+
+      '<' +
+      a.class.to_s +
+      (a.respond_to?(:size) ? " size:#{a.size}" : '') +
+      '>'
+    end
+  end
+
+  module ExtraErrorMethods
+
+    attr_accessor :test
+
+    def path; test.path; end
+    def location; [ path, line ]; end
+    def loc; location.map(&:to_s).join(':'); end
+
+    def trail
+
+      msg = "#{self.class}: #{self.message.inspect}"
+
+      @test.trail + "\n" +
+      Probatio.c.red("#{'  ' * (test.depth + 1)}#{loc} --> #{msg}")
+    end
+
+    def source_lines
+
+      @source_lines ||=
+        Probatio::AssertionError.select_source_lines(test.path, line)
+    end
+
+    def summary(indent='')
+
+      o = StringIO.new
+
+      o << self.class.name << ': ' << self.message.inspect << "\n"
+
+      i = backtrace.index { |l| l.match?(/\/lib\/probatio\.rb:/) } || -1
+
+      backtrace[0..i]
+        .inject(o) { |o, l| o << indent << l << "\n" }
+
+      o.string
+    end
+
+    def line
+
+      backtrace.each do |l|
+
+        ss = l.split(':')
+
+        next unless ss.find { |e| e == test.path }
+        return ss.find { |e| e.match?(/^\d+$/) }.to_i
+      end
+
+      -1
+    end
+  end
+end
+

data/lib/probatio/examples/a_test.rb

@@ -69,6 +69,14 @@ group 'core' do
         # checks that the given Proc raises an ArgumentError and
         # the error message == "bad"
 
+      assert_no_error { do_this_or_that() }
+      assert_no_error lambda { do_this_or_that() }
+      assert_not_error { do_this_or_that() }
+      assert_not_error lambda { do_this_or_that() }
+      assert_nothing_raised { do_this_or_that() }
+      assert_nothing_raised lambda { do_this_or_that() }
+        # checks that the block or Proc does not raise an error
+
       assert_hashy(
         this_thing => 1,
         that_thing => 'two')
@@ -124,3 +132,48 @@ group 'core < sub-core < sub-sub-core' do
   end
 end
 
+
+group 'notcore' do
+
+  # A section allows for some kind of "inheritance" between groups...
+  #
+  section 'with db' do
+
+    setup do
+
+      prepare_db
+    end
+
+    before do
+
+      reset_and_load_fixtures
+    end
+  end
+
+  group 'alpha' do
+
+    group 'without db' do
+
+      # ...
+    end
+
+    group 'with db' do
+
+      # gets the setup and before from the "with db" section
+    end
+  end
+
+  group 'bravo' do
+
+    group 'without db' do
+
+      # ...
+    end
+
+    group 'with db' do
+
+      # gets the setup and before from the "with db" section
+    end
+  end
+end
+

data/lib/probatio/helpers.rb

@@ -8,6 +8,22 @@ module Probatio::Helpers
 
     Probatio.beep(count || 0)
   end
+
+  def jruby?
+
+    !! RUBY_PLATFORM.match?(/java/)
+  end
+
+  def windows?
+
+    Gem.win_platform?
+  end
+end
+
+
+class Probatio::Group
+
+  include Probatio::Helpers
 end
 
 class Probatio::Section

data/lib/probatio.rb

@@ -7,15 +7,18 @@ require 'set'
 require 'stringio'
 require 'io/console'
 
+require 'diff-lcs'
+
 require 'colorato'
 
 require 'probatio/debug'
+require 'probatio/errors'
 require 'probatio/more'
 
 
 module Probatio
 
-  VERSION = '1.2.1'
+  VERSION = '1.4.0'
 
   class << self
 
@@ -758,162 +761,6 @@ module Probatio
       # where beep and friends are defined...
   end
 
-  class AssertionError < StandardError
-
-    attr_reader :assertion, :arguments, :test, :file, :line
-    attr_accessor :nested_error
-
-    alias path file
-
-    def initialize(assertion, arguments, error_or_message, test, file, line)
-
-      @assertion = assertion
-      @arguments = arguments
-
-      @test = test
-
-      @file = file
-      @line = line
-
-      if error_or_message.is_a?(String)
-        @msg = error_or_message
-      else
-        @msg = "error while asserting: " + error_or_message.message
-        @nested_error = error_or_message
-      end
-
-      super(@msg)
-    end
-
-    def location
-
-      [ @file, @line ]
-    end
-
-    def loc
-
-      location.map(&:to_s).join(':')
-    end
-
-    def to_s
-
-      "#{self.class.name}: #{@msg}"
-    end
-
-    def trail
-
-      @test.trail + "\n" +
-      Probatio.c.red("#{'  ' * (test.depth + 1)}#{loc} --> #{@msg}")
-    end
-
-    def source_line
-
-      @source_line ||=
-        File.readlines(@file)[@line - 1]
-    end
-
-    def source_lines
-
-      @source_lines ||=
-        Probatio::AssertionError.select_source_lines(@file, @line)
-    end
-
-    def summary(indent='')
-
-      tw = Probatio.term_width - 4 - indent.length
-
-      as =
-        @arguments.find { |a| a.inspect.length > tw } ?
-          @arguments.collect { |a|
-            if (s0 = a.inspect).length < tw
-              "\n#{indent}    " + s0
-            else
-              s1 = StringIO.new; PP.pp(a, s1, tw)
-              qualify_argument(a) + "\n" +
-              indent + s1.string.gsub(/^(.*)$/) { "    #{$1}" }
-            end } :
-        @arguments.collect(&:inspect)
-
-      s = StringIO.new
-      s << indent << @assertion << ':'
-      as.each_with_index { |a, i| s << "\n#{indent}  %d: %s" % [ i, a ] }
-
-      s.string
-    end
-
-    class << self
-
-      def select_source_lines(path, line)
-
-        File.readlines(path).each_with_index.to_a[line - 1..-1]
-          .map { |l, i| [ i + 1, l.rstrip ] }
-          .take_while { |_, l|
-            l = l.strip
-            l.length > 0 && l != 'end' && l != '}' }
-      end
-    end
-
-    protected
-
-    def qualify_argument(a)
-
-      '<' +
-      a.class.to_s +
-      (a.respond_to?(:size) ? " size:#{a.size}" : '') +
-      '>'
-    end
-  end
-
-  module ExtraErrorMethods
-
-    attr_accessor :test
-
-    def path; test.path; end
-    def location; [ path, line ]; end
-    def loc; location.map(&:to_s).join(':'); end
-
-    def trail
-
-      msg = "#{self.class}: #{self.message.inspect}"
-
-      @test.trail + "\n" +
-      Probatio.c.red("#{'  ' * (test.depth + 1)}#{loc} --> #{msg}")
-    end
-
-    def source_lines
-
-      @source_lines ||=
-        Probatio::AssertionError.select_source_lines(test.path, line)
-    end
-
-    def summary(indent='')
-
-      o = StringIO.new
-
-      o << self.class.name << ': ' << self.message.inspect << "\n"
-
-      i = backtrace.index { |l| l.match?(/\/lib\/probatio\.rb:/) } || -1
-
-      backtrace[0..i]
-        .inject(o) { |o, l| o << indent << l << "\n" }
-
-      o.string
-    end
-
-    def line
-
-      backtrace.each do |l|
-
-        ss = l.split(':')
-
-        next unless ss.find { |e| e == test.path }
-        return ss.find { |e| e.match?(/^\d+$/) }.to_i
-      end
-
-      -1
-    end
-  end
-
   class Event
 
     attr_reader :tstamp, :delta

data/probatio.gemspec

@@ -38,8 +38,9 @@ Test tools for floraison and flor. Somewhere between Minitest and Rspec, but not
     "#{s.name}.gemspec",
   ]
 
+  s.add_runtime_dependency 'stringio'
+  s.add_runtime_dependency 'diff-lcs', '~> 1.6'
   s.add_runtime_dependency 'colorato', '~> 1.0'
-  #s.add_runtime_dependency 'diff-lcs', '~> 1.5'
 
   s.require_path = 'lib'
 

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: probatio
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.4.0
 platform: ruby
 authors:
 - John Mettraux
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-05-20 00:00:00.000000000 Z
+date: 2025-10-13 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: stringio
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: diff-lcs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: colorato
   requirement: !ruby/object:Gem::Requirement
@@ -40,6 +68,7 @@ files:
 - lib/probatio.rb
 - lib/probatio/assertions.rb
 - lib/probatio/debug.rb
+- lib/probatio/errors.rb
 - lib/probatio/examples/a_plugin.rb
 - lib/probatio/examples/a_test.rb
 - lib/probatio/helpers.rb