assert 2.16.5 → 2.18.3

data/lib/assert/assert_runner.rb

@@ -1,7 +1,6 @@
-require 'assert/cli'
+require "assert/cli"
 
 module Assert
-
   class AssertRunner
     USER_SETTINGS_FILE  = ".assert/init.rb"
     LOCAL_SETTINGS_FILE = ".assert.rb"
@@ -10,7 +9,7 @@ module Assert
 
     def initialize(config, test_paths, test_options)
       @config = config
-      Assert::CLI.bench('Applying settings') do
+      Assert::CLI.bench("Applying settings") do
         apply_user_settings
         apply_local_settings
         apply_env_settings
@@ -25,7 +24,7 @@ module Assert
     def init(test_files, test_dir)
       # load any test helper file
       if test_dir && (h = File.join(test_dir, self.config.test_helper)) && File.exists?(h)
-        Assert::CLI.bench('Requiring test helper'){ require h }
+        Assert::CLI.bench("Requiring test helper"){ require h }
       end
 
       if self.config.list
@@ -61,15 +60,15 @@ module Assert
     end
 
     def apply_user_settings
-      safe_require("#{ENV['HOME']}/#{USER_SETTINGS_FILE}") if ENV['HOME']
+      safe_require("#{ENV["HOME"]}/#{USER_SETTINGS_FILE}") if ENV["HOME"]
     end
 
     def apply_local_settings
-      safe_require(ENV['ASSERT_LOCALFILE'] || path_of(LOCAL_SETTINGS_FILE, Dir.pwd))
+      safe_require(ENV["ASSERT_LOCALFILE"] || path_of(LOCAL_SETTINGS_FILE, Dir.pwd))
     end
 
     def apply_env_settings
-      self.config.runner_seed ENV['ASSERT_RUNNER_SEED'].to_i if ENV['ASSERT_RUNNER_SEED']
+      self.config.runner_seed ENV["ASSERT_RUNNER_SEED"].to_i if ENV["ASSERT_RUNNER_SEED"]
     end
 
     def apply_option_settings(options)
@@ -111,13 +110,11 @@ module Assert
 
     def path_of(segment, a_path)
       # this method inspects a test path and finds the test dir path.
-      full_path = File.expand_path(a_path || '.', Dir.pwd)
+      full_path = File.expand_path(a_path || ".", Dir.pwd)
       seg_pos = full_path.index(segment_regex(segment))
       File.join(seg_pos && (seg_pos > 0) ? full_path[0..(seg_pos-1)] : full_path, segment)
     end
 
     def segment_regex(seg); /^#{seg}$|^#{seg}\/|\/#{seg}\/|\/#{seg}$/; end
-
   end
-
 end

data/lib/assert/assertions.rb

@@ -1,8 +1,15 @@
-require 'assert/utils'
+require "assert/utils"
 
 module Assert
-
   module Assertions
+    IGNORED_ASSERTION_HELPERS =
+      [
+        :assert_throws,     :assert_nothing_thrown,
+        :assert_operator,   :refute_operator,
+        :assert_in_epsilon, :refute_in_epsilon,
+        :assert_in_delta,   :refute_in_delta,
+        :assert_send
+      ]
 
     def assert_block(desc = nil)
       assert(yield, desc){ "Expected block to return a true value." }
@@ -27,7 +34,7 @@ module Assert
     alias_method :refute_empty, :assert_not_empty
 
     def assert_equal(exp, act, desc = nil)
-      assert(exp == act, desc) do
+      assert(act == exp, desc) do
         c = __assert_config__
         exp_show = Assert::U.show_for_diff(exp, c)
         act_show = Assert::U.show_for_diff(act, c)
@@ -42,7 +49,7 @@ module Assert
     end
 
     def assert_not_equal(exp, act, desc = nil)
-      assert(exp != act, desc) do
+      assert(act != exp, desc) do
         c = __assert_config__
         exp_show = Assert::U.show_for_diff(exp, c)
         act_show = Assert::U.show_for_diff(act, c)
@@ -214,8 +221,8 @@ module Assert
         c = __assert_config__
         exp_show = Assert::U.show_for_diff(exp, c)
         act_show = Assert::U.show_for_diff(act, c)
-        exp_id = "#<#{exp.class}:#{'0x0%x' % (exp.object_id << 1)}>"
-        act_id = "#<#{act.class}:#{'0x0%x' % (act.object_id << 1)}>"
+        exp_id = "#<#{exp.class}:#{"0x0%x" % (exp.object_id << 1)}>"
+        act_id = "#<#{act.class}:#{"0x0%x" % (act.object_id << 1)}>"
 
         if c.use_diff_proc.call(exp_show, act_show)
           "Expected #{act_id} to be the same as #{exp_id}, diff:\n"\
@@ -232,8 +239,8 @@ module Assert
         c = __assert_config__
         exp_show = Assert::U.show_for_diff(exp, c)
         act_show = Assert::U.show_for_diff(act, c)
-        exp_id = "#<#{exp.class}:#{'0x0%x' % (exp.object_id << 1)}>"
-        act_id = "#<#{act.class}:#{'0x0%x' % (act.object_id << 1)}>"
+        exp_id = "#<#{exp.class}:#{"0x0%x" % (exp.object_id << 1)}>"
+        act_id = "#<#{act.class}:#{"0x0%x" % (act.object_id << 1)}>"
 
         if c.use_diff_proc.call(exp_show, act_show)
           "Expected #{act_id} to not be the same as #{exp_id}, diff:\n"\
@@ -246,24 +253,6 @@ module Assert
     end
     alias_method :refute_same, :assert_not_same
 
-    # ignored assertion helpers
-
-    IGNORED_ASSERTION_HELPERS = [
-      :assert_throws,     :assert_nothing_thrown,
-      :assert_operator,   :refute_operator,
-      :assert_in_epsilon, :refute_in_epsilon,
-      :assert_in_delta,   :refute_in_delta,
-      :assert_send
-    ]
-    def method_missing(method, *args, &block)
-      if IGNORED_ASSERTION_HELPERS.include?(method.to_sym)
-        ignore "The assertion `#{method}` is not supported."\
-               " Please use another assertion or the basic `assert`."
-      else
-        super
-      end
-    end
-
     private
 
     def __assert_config__
@@ -328,7 +317,5 @@ module Assert
         super("exception not expected, but raised:")
       end
     end
-
   end
-
 end

data/lib/assert/cli.rb

@@ -1,14 +1,12 @@
-require 'benchmark'
-require 'set'
-require 'assert/assert_runner'
-require 'assert/version'
+require "benchmark"
+require "set"
+require "assert/assert_runner"
+require "assert/version"
 
 module Assert
-
   class CLI
-
     def self.debug?(args)
-      args.include?('-d') || args.include?('--debug')
+      args.include?("-d") || args.include?("--debug")
     end
 
     def self.debug_msg(msg)
@@ -36,40 +34,29 @@ module Assert
     def initialize(*args)
       @args = args
       @cli = CLIRB.new do
-        option 'runner_seed', 'use a given seed to run tests', {
-          :abbrev => 's', :value => Fixnum
-        }
-        option 'changed_only', 'only run test files with changes', {
-          :abbrev => 'c'
-        }
-        option 'changed_ref', 'reference for changes, use with `-c` opt', {
-          :abbrev => 'r', :value => ''
-        }
-        option 'single_test', 'only run the test on the given file/line', {
-          :abbrev => 't', :value => ''
-        }
-        option 'pp_objects', 'pretty-print objects in fail messages', {
-          :abbrev => 'p'
-        }
-        option 'capture_output', 'capture stdout and display in result details', {
-          :abbrev => 'o'
-        }
-        option 'halt_on_fail', 'halt a test when it fails', {
-          :abbrev => 'h'
-        }
-        option 'profile', 'output test profile info', {
-          :abbrev => 'e'
-        }
-        option 'verbose', 'output verbose runtime test info', {
-          :abbrev => 'v'
-        }
-        option 'list', 'list test files on $stdout', {
-          :abbrev => 'l'
-        }
+        option "runner_seed", "use a given seed to run tests",
+               abbrev: "s", value: Integer
+        option "changed_only", "only run test files with changes",
+               abbrev: "c"
+        option "changed_ref", "reference for changes, use with `-c` opt",
+               abbrev: "r", value: ""
+        option "single_test", "only run the test on the given file/line",
+               abbrev: "t", value: ""
+        option "pp_objects", "pretty-print objects in fail messages",
+               abbrev: "p"
+        option "capture_output", "capture stdout and display in result details",
+               abbrev: "o"
+        option "halt_on_fail", "halt a test when it fails",
+               abbrev: "h"
+        option "profile", "output test profile info",
+               abbrev: "e"
+        option "verbose", "output verbose runtime test info",
+               abbrev: "v"
+        option "list", "list test files on $stdout",
+               abbrev: "l"
+
         # show loaded test files, cli err backtraces, etc
-        option 'debug', 'run in debug mode', {
-          :abbrev => 'd'
-        }
+        option "debug", "run in debug mode", abbrev: "d"
       end
     end
 
@@ -100,7 +87,6 @@ module Assert
       "Options:"\
       "#{@cli}"
     end
-
   end
 
   module RoundedMillisecondTime
@@ -111,20 +97,20 @@ module Assert
     end
   end
 
-  class CLIRB  # Version 1.0.0, https://github.com/redding/cli.rb
+  class CLIRB  # Version 1.1.0, https://github.com/redding/cli.rb
     Error    = Class.new(RuntimeError);
     HelpExit = Class.new(RuntimeError); VersionExit = Class.new(RuntimeError)
     attr_reader :argv, :args, :opts, :data
 
     def initialize(&block)
       @options = []; instance_eval(&block) if block
-      require 'optparse'
+      require "optparse"
       @data, @args, @opts = [], [], {}; @parser = OptionParser.new do |p|
-        p.banner = ''; @options.each do |o|
+        p.banner = ""; @options.each do |o|
           @opts[o.name] = o.value; p.on(*o.parser_args){ |v| @opts[o.name] = v }
         end
-        p.on_tail('--version', ''){ |v| raise VersionExit, v.to_s }
-        p.on_tail('--help',    ''){ |v| raise HelpExit,    v.to_s }
+        p.on_tail("--version", ""){ |v| raise VersionExit, v.to_s }
+        p.on_tail("--help",    ""){ |v| raise HelpExit,    v.to_s }
       end
     end
 
@@ -137,33 +123,31 @@ module Assert
     end
     def to_s; @parser.to_s; end
     def inspect
-      "#<#{self.class}:#{'0x0%x' % (object_id << 1)} @data=#{@data.inspect}>"
+      "#<#{self.class}:#{"0x0%x" % (object_id << 1)} @data=#{@data.inspect}>"
     end
 
     class Option
       attr_reader :name, :opt_name, :desc, :abbrev, :value, :klass, :parser_args
 
-      def initialize(name, *args)
-        settings, @desc = args.last.kind_of?(::Hash) ? args.pop : {}, args.pop || ''
-        @name, @opt_name, @abbrev = parse_name_values(name, settings[:abbrev])
-        @value, @klass = gvalinfo(settings[:value])
+      def initialize(name, desc = nil, abbrev: nil, value: nil)
+        @name, @desc = name, desc || ""
+        @opt_name, @abbrev = parse_name_values(name, abbrev)
+        @value, @klass = gvalinfo(value)
         @parser_args = if [TrueClass, FalseClass, NilClass].include?(@klass)
           ["-#{@abbrev}", "--[no-]#{@opt_name}", @desc]
         else
-          ["-#{@abbrev}", "--#{@opt_name} #{@opt_name.upcase}", @klass, @desc]
+          ["-#{@abbrev}", "--#{@opt_name} VALUE", @klass, @desc]
         end
       end
 
       private
 
       def parse_name_values(name, custom_abbrev)
-        [ (processed_name = name.to_s.strip.downcase), processed_name.gsub('_', '-'),
-          custom_abbrev || processed_name.gsub(/[^a-z]/, '').chars.first || 'a'
+        [ (processed_name = name.to_s.strip.downcase).gsub("_", "-"),
+          custom_abbrev || processed_name.gsub(/[^a-z]/, "").chars.first || "a"
         ]
       end
-      def gvalinfo(v); v.kind_of?(Class) ? [nil,gklass(v)] : [v,gklass(v.class)]; end
-      def gklass(k); k == Fixnum ? Integer : k; end
+      def gvalinfo(v); v.kind_of?(Class) ? [nil,v] : [v,v.class]; end
     end
   end
-
 end

data/lib/assert/config.rb

@@ -1,13 +1,11 @@
-require 'assert/default_runner'
-require 'assert/default_suite'
-require 'assert/default_view'
-require 'assert/file_line'
-require 'assert/utils'
+require "assert/default_runner"
+require "assert/default_suite"
+require "assert/default_view"
+require "assert/file_line"
+require "assert/utils"
 
 module Assert
-
   class Config
-
     def self.settings(*items)
       items.each do |item|
         define_method(item) do |*args|
@@ -33,7 +31,7 @@ module Assert
 
       @test_dir    = "test"
       @test_helper = "helper.rb"
-      @test_file_suffixes = ['_tests.rb', '_test.rb']
+      @test_file_suffixes = ["_tests.rb", "_test.rb"]
 
       @changed_proc  = Assert::U.git_changed_proc
       @pp_proc       = Assert::U.stdlib_pp_proc
@@ -43,8 +41,8 @@ module Assert
       # option settings
       @runner_seed    = begin; srand; srand % 0xFFFF; end.to_i
       @changed_only   = false
-      @changed_ref    = ''
-      @single_test    = ''
+      @changed_ref    = ""
+      @single_test    = ""
       @pp_objects     = false
       @capture_output = false
       @halt_on_fail   = true
@@ -78,7 +76,5 @@ module Assert
     def single_test_file_path
       self.single_test_file_line.file if self.single_test_file_line
     end
-
   end
-
 end

data/lib/assert/config_helpers.rb

@@ -1,7 +1,5 @@
 module Assert
-
   module ConfigHelpers
-
     def runner; self.config.runner; end
     def suite;  self.config.suite;  end
     def view;   self.config.view;   end
@@ -33,27 +31,27 @@ module Assert
       self.pass_result_count == self.result_count
     end
 
-    def formatted_run_time(run_time, format = '%.6f')
+    def formatted_run_time(run_time, format = "%.6f")
       format % run_time
     end
 
-    def formatted_test_rate(test_rate, format = '%.6f')
+    def formatted_test_rate(test_rate, format = "%.6f")
       format % test_rate
     end
 
-    def formatted_result_rate(result_rate, format = '%.6f')
+    def formatted_result_rate(result_rate, format = "%.6f")
       format % result_rate
     end
 
-    def formatted_suite_run_time(format = '%.6f')
+    def formatted_suite_run_time(format = "%.6f")
       formatted_run_time(self.config.suite.run_time, format)
     end
 
-    def formatted_suite_test_rate(format = '%.6f')
+    def formatted_suite_test_rate(format = "%.6f")
       formatted_test_rate(self.config.suite.test_rate, format)
     end
 
-    def formatted_suite_result_rate(format = '%.6f')
+    def formatted_suite_result_rate(format = "%.6f")
       formatted_result_rate(self.config.suite.result_rate, format)
     end
 
@@ -77,7 +75,5 @@ module Assert
     def get_rate(count, time)
       time == 0 ? 0.0 : (count.to_f / time.to_f)
     end
-
   end
-
 end

data/lib/assert/context.rb

@@ -1,22 +1,26 @@
-require 'assert/assertions'
-require 'assert/context/setup_dsl'
-require 'assert/context/subject_dsl'
-require 'assert/context/suite_dsl'
-require 'assert/context/test_dsl'
-require 'assert/context_info'
-require 'assert/macros/methods'
-require 'assert/result'
-require 'assert/suite'
-require 'assert/utils'
+require "assert/actual_value"
+require "assert/assertions"
+require "assert/context/let_dsl"
+require "assert/context/method_missing"
+require "assert/context/setup_dsl"
+require "assert/context/subject_dsl"
+require "assert/context/suite_dsl"
+require "assert/context/test_dsl"
+require "assert/context_info"
+require "assert/macros/methods"
+require "assert/result"
+require "assert/suite"
+require "assert/utils"
 
 module Assert
-
   class Context
     # put all logic in DSL methods to keep context instances pure for running tests
     extend SetupDSL
     extend SubjectDSL
     extend SuiteDSL
     extend TestDSL
+    extend LetDSL
+    include MethodMissing
     include Assert::Assertions
     include Assert::Macros::Methods
 
@@ -33,7 +37,7 @@ module Assert
         klass_method_name = "#{self}##{method_name}"
 
         if self.suite.test_methods.include?(klass_method_name)
-          puts "WARNING: redefining '#{klass_method_name}'"
+          puts "WARNING: redefining "#{klass_method_name}""
           puts "  from: #{caller_locations(1,1)}"
         else
           self.suite.test_methods << klass_method_name
@@ -62,9 +66,8 @@ module Assert
       end
     end
 
-    # check if the assertion is a truthy value, if so create a new pass result,
-    # otherwise create a new fail result with the desc and what failed msg.
-    # all other assertion helpers use this one in the end
+    # Check if the result is true. If so, create a new pass result,  Otherwise
+    # create a new fail result with the desc and fail msg.
     def assert(assertion, desc = nil)
       if assertion
         pass
@@ -79,8 +82,8 @@ module Assert
       end
     end
 
-    # the opposite of assert, check if the assertion is a false value, if so create a new pass
-    # result, otherwise create a new fail result with the desc and it's what failed msg
+    # The opposite of assert. Check if the result is false. If so, create a new
+    # pass result. Otherwise create a new fail result with the desc and fail msg.
     def assert_not(assertion, fail_desc = nil)
       assert(!assertion, fail_desc) do
         "Failed assert_not: assertion was "\
@@ -89,6 +92,10 @@ module Assert
     end
     alias_method :refute, :assert_not
 
+    def assert_that(actual_value)
+      Assert::ActualValue.new(actual_value, context: self)
+    end
+
     # adds a Pass result to the end of the test's results
     # does not break test execution
     def pass(pass_msg = nil)
@@ -111,15 +118,15 @@ module Assert
     def fail(message = nil)
       if @__assert_pending__ == 0
         if halt_on_fail?
-          raise Result::TestFailure, message || ''
+          raise Result::TestFailure, message || ""
         else
-          capture_result(Assert::Result::Fail, message || '')
+          capture_result(Assert::Result::Fail, message || "")
         end
       else
         if halt_on_fail?
-          raise Result::TestSkipped, "Pending fail: #{message || ''}"
+          raise Result::TestSkipped, "Pending fail: #{message || ""}"
         else
-          capture_result(Assert::Result::Skip, "Pending fail: #{message || ''}")
+          capture_result(Assert::Result::Skip, "Pending fail: #{message || ""}")
         end
       end
     end
@@ -128,7 +135,7 @@ module Assert
     # adds a Skip result to the end of the test's results
     # breaks test execution
     def skip(skip_msg = nil, called_from = nil)
-      raise Result::TestSkipped, (skip_msg || ''), called_from
+      raise Result::TestSkipped, (skip_msg || ""), called_from
     end
 
     # runs block and any fails are skips and any passes are fails
@@ -172,7 +179,7 @@ module Assert
     # Returns a Proc that will output a custom message along with the default
     # fail message.
     def fail_message(fail_desc = nil, what_failed_msg = nil)
-      [ fail_desc, what_failed_msg ].compact.join("\n")
+      [fail_desc, what_failed_msg].compact.join("\n")
     end
 
     private
@@ -190,6 +197,5 @@ module Assert
     def __assert_config__
       @__assert_config__
     end
-
   end
 end