minitest-keyword 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 88c45029ebc3e0ed80c93e43cc14c1158b2af479
-  data.tar.gz: 151557967681a6fb8a3da72e4efac0e3f965bea7
+  metadata.gz: 4a6def3f236a875e344c8319d67b706fcc74b1ef
+  data.tar.gz: 674ed4c01d9426b89e90b08f9607b7be684666cb
 SHA512:
-  metadata.gz: ce9eb124236528069c6658d0caf49d35aa04bcc274f14dc2e6c194be6b535615a70674cfd9c41b3bc7b362981b8c72e39c712fd9a8390d0d966ee0fa444c710c
-  data.tar.gz: 7011f1dcc776b55a7647aba423683f6aca1eda1129c3844ca86041e42c4b3b91319b40ae3c8e6178e5cafeb021b503539f124866a83c0bfc0fb7cc612b644537
+  metadata.gz: 8d80dbaa4353678dc91da6e60f44858a427f5ac8148eed53840c85657717135e0fdb051396118497f6ea12f951b5059f373c24b8c3d4fc694ef142763b63b4f3
+  data.tar.gz: ee43f67179591e194469a161d88307dc2ce4ebd904f1b00f199b98a772c1284da111587ee2d97d4c28df81285f9bfd53e8881934baf8c9ef6804e71b1842ca3b

data/README.md

@@ -33,11 +33,54 @@ assert_equal 'foo', foo.inspect
 to:
 
 ```ruby
-assert_equal exp: 'foo', act: foo.inspect
+assert_equal expected: 'foo', actual: foo.inspect
 ```
 
 All of the standard Minitest assertions can now be used with keyword arguments. Note that this gem is still backwards-compatible with Minitest itself, so your existing tests won't break.
 
+## Cheat Sheet
+
+The actual keyword method creation is done through introspection, but the equivalent method signatures are listed below. Note that when you see `message: nil` it effectively means that you can pass through a message or it will use whatever standard Minitest message is configured for that assertion.
+
+```ruby
+assert             test:, message: nil
+assert_empty       object:, message: nil
+assert_equal       expected:, actual:, message: nil
+assert_in_delta    expected:, actual:, delta:, message: nil
+assert_in_epsilon  a:, b:, epsilon:, message: nil
+assert_includes    collection:, object:, message: nil
+assert_instance_of class:, object:, message: nil
+assert_kind_of     class:, object:, message: nil
+assert_match       matcher:, object:, message: nil
+assert_nil         object:, message: nil
+assert_operator    o1:, op:, o2:, message: nil
+assert_output      stdout:, stderr:
+assert_predicate   o1:, op:, message: nil
+assert_raises      expected:
+assert_respond_to  object:, method:, message: nil
+assert_same        expected:, actual:, message: nil
+assert_throws      symbol:, message: nil
+```
+
+The associated refutations are also overridden, with the below signatures.
+
+```ruby
+refute             test:, message: nil
+refute_empty       object:, message: nil
+refute_equal       expected:, actual:, message: nil
+refute_in_delta    expected:, actual:, delta:, message: nil
+refute_in_epsilon  a:, b:, epsilon:, message: nil
+refute_includes    collection:, object:, message: nil
+refute_instance_of class:, object:, message: nil
+refute_kind_of     class:, object:, message: nil
+refute_match       matcher:, object:, message: nil
+refute_nil         object:, message: nil
+refute_operator    o1:, op:, o2:, message: nil
+refute_predicate   o1:, op:, message: nil
+refute_respond_to  object:, method:, message: nil
+refute_same        expected:, actual:, message: nil
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/minitest/keyword.rb

@@ -5,6 +5,17 @@ module Minitest
   # The module containing overridden assertion methods that will be prepended
   # into the Test class
   module Keyword
+    # Longer names so that the keywords make more sense
+    ALIASES = {
+      act: :actual,
+      cls: :class,
+      exp: :expected,
+      meth: :method,
+      msg: :message,
+      obj: :object,
+      sym: :symbol
+    }.freeze
+
     # Raised if someone tries to pass both the regular arguments and the
     # keyword arguments
     class OverloadedArgumentError < ArgumentError
@@ -28,27 +39,27 @@ module Minitest
       next if parameters.empty?
 
       define_method(method_name) do |*args, **kwargs, &block|
-        passed_params =
-          parameters.map.with_index do |(type, arg_name), index|
-            if args.length > index && kwargs.key?(arg_name)
-              raise OverloadedArgumentError.new(method_name, arg_name)
-            end
-
-            if args.length <= index && !kwargs.key?(arg_name) && type == :req
-              raise MissingRequiredArgumentError.new(method_name, arg_name)
-            end
-
-            if type == :rest
-              args.any? ? args[index..-1] : kwargs[arg_name]
-            else
-              args[index] || kwargs[arg_name]
-            end
+        passed_params = []
+
+        parameters.each.with_index do |(type, arg_name), index|
+          if args.length > index &&
+             (kwargs.key?(arg_name) || kwargs.key?(ALIASES[arg_name]))
+            raise OverloadedArgumentError.new(method_name, arg_name)
           end
 
-        # Special case for behavior like `assert_raises`, where a splat takes
-        # all of the types of errors for rescue
-        if parameters.length == 1 && parameters[0][0] == :rest
-          passed_params.flatten!(1)
+          if type == :req && args.length <= index &&
+             !kwargs.key?(arg_name) && !kwargs.key?(ALIASES[arg_name])
+            raise MissingRequiredArgumentError.new(method_name, arg_name)
+          end
+
+          if type == :rest && args.any?
+            passed_params += args[index..-1]
+          elsif type == :rest
+            passed_params += (kwargs[arg_name] || kwargs[ALIASES[arg_name]])
+          else
+            passed_params <<
+              (args[index] || kwargs[arg_name] || kwargs[ALIASES[arg_name]])
+          end
         end
 
         super(*passed_params, &block)

data/lib/minitest/keyword/version.rb

@@ -1,5 +1,5 @@
 module Minitest
   module Keyword
-    VERSION = '0.0.1'.freeze
+    VERSION = '0.0.2'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: minitest-keyword
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Kevin Deisz
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-05-07 00:00:00.000000000 Z
+date: 2017-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest