minitest-keyword 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 88c45029ebc3e0ed80c93e43cc14c1158b2af479
+  data.tar.gz: 151557967681a6fb8a3da72e4efac0e3f965bea7
+SHA512:
+  metadata.gz: ce9eb124236528069c6658d0caf49d35aa04bcc274f14dc2e6c194be6b535615a70674cfd9c41b3bc7b362981b8c72e39c712fd9a8390d0d966ee0fa444c710c
+  data.tar.gz: 7011f1dcc776b55a7647aba423683f6aca1eda1129c3844ca86041e42c4b3b91319b40ae3c8e6178e5cafeb021b503539f124866a83c0bfc0fb7cc612b644537

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rubocop.yml

@@ -0,0 +1,11 @@
+AllCops:
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+  TargetRubyVersion: 2.1
+  Exclude:
+  - 'vendor/**/*'
+
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    default: '[]'
+    '%r': '{}'

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm: 2.4.1
+before_install: gem install bundler -v 1.14.6
+cache: bundler
+script:
+- bundle exec rake
+- bundle exec rubocop

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Kevin Deisz
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,53 @@
+# Minitest::Keyword
+
+[![Build Status](https://travis-ci.org/kddeisz/minitest-keyword.svg?branch=master)](https://travis-ci.org/kddeisz/minitest-keyword)
+[![Coverage Status](https://coveralls.io/repos/github/kddeisz/minitest-keyword/badge.svg?branch=master)](https://coveralls.io/github/kddeisz/minitest-keyword?branch=master)
+[![Gem](https://img.shields.io/gem/v/minitest-keyword.svg)](https://rubygems.org/gems/minitest-keyword)
+
+A small gem for allowing you to use Minitest assertions with keyword arguments. No longer worry about remembering the order of arguments!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'minitest-keyword'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install minitest-keyword
+
+## Usage
+
+Add `require 'minitest-keyword'` to the top of your `test_helper.rb` script. In your tests you will now be able to change your assertions from:
+
+```ruby
+assert_equal 'foo', foo.inspect
+```
+
+to:
+
+```ruby
+assert_equal exp: 'foo', act: 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.
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/kddeisz/minitest-keyword.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'minitest/keyword'
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/lib/minitest/keyword/version.rb

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

data/lib/minitest/keyword.rb

@@ -0,0 +1,63 @@
+require 'minitest'
+require 'minitest/keyword/version'
+
+module Minitest
+  # The module containing overridden assertion methods that will be prepended
+  # into the Test class
+  module Keyword
+    # Raised if someone tries to pass both the regular arguments and the
+    # keyword arguments
+    class OverloadedArgumentError < ArgumentError
+      def initialize(method_name, argument_name)
+        super('Cannot specify keyword argument and pass regular argument to ' \
+              "#{method_name} for argument #{argument_name}")
+      end
+    end
+
+    # Raised if a parameter is required but none was provided as either a
+    # regular argument or a keyword argument
+    class MissingRequiredArgumentError < ArgumentError
+      def initialize(method_name, argument_name)
+        super("You must specify a value for the #{argument_name} argument " \
+              "for the #{method_name} assertion")
+      end
+    end
+
+    Assertions.instance_methods.grep(/assert|refute/).each do |method_name|
+      parameters = Assertions.instance_method(method_name).parameters
+      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
+          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)
+        end
+
+        super(*passed_params, &block)
+      end
+    end
+  end
+
+  # Hook into the Minitest::Test class and prepend the Keyword module
+  class Test
+    prepend Keyword
+  end
+end

data/minitest-keyword.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'minitest/keyword/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'minitest-keyword'
+  spec.version       = Minitest::Keyword::VERSION
+  spec.authors       = ['Kevin Deisz']
+  spec.email         = ['kevin.deisz@gmail.com']
+
+  spec.summary       = 'Use Minitest assertions with keyword arguments'
+  spec.homepage      = 'https://github.com/kddeisz/minitest-keyword'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 2.1.0'
+  spec.add_dependency 'minitest', '~> 5.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'coveralls', '~> 0.8'
+  spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_development_dependency 'rubocop', '~> 0.48'
+  spec.add_development_dependency 'simplecov', '~> 0.14'
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: minitest-keyword
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Kevin Deisz
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-05-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.48'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.48'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+description: 
+email:
+- kevin.deisz@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/minitest/keyword.rb
+- lib/minitest/keyword/version.rb
+- minitest-keyword.gemspec
+homepage: https://github.com/kddeisz/minitest-keyword
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Use Minitest assertions with keyword arguments
+test_files: []