prolog_minitest_matchers 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fab4720efbabb4f86251454fb1107c3b12b133e2
+  data.tar.gz: 10d7bb2ce0ce02a2308193a66d1853b89ba45d57
+SHA512:
+  metadata.gz: e44d46dde47f14931e9056e898e6b10a9361d48f314b3ad1b810dbe8681e4d246689a6b30a9a722307601c72d8d09bee0d34a1db7d7fa9deadd67f6c9f3e9853
+  data.tar.gz: 488130da26e438b86938551ced8286f7fbb2252e28923fe0e27d9f03961d40e062d3a78b5371e1ff0e6024db7ffc7861448d5a0aa1e769466defb39d7bcedf91

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/o-rdoc/
+!/bin/console
+!/bin/setup
+/bin/

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at jdickey@seven-sigma.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in prolog_minitest_matchers.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Jeff Dickey
+
+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,109 @@
+# PrologMinitestMatchers
+
+This is an evolving collection of MiniTest and MiniTest::Spec custom matchers which we have found useful in our work. As we have built up our applications, we've seen the disparity between *tests* and *assertions* grow; often to a differential of 30% or even more. While some standard MiniTest::Spec expectations involve multiple assertions, we can police our own.
+
+For example, we often have class API tests that look something like
+
+```ruby
+# in foo.rb
+class Foo
+  def initialize(foo:, bar:)
+    # ...
+  end
+
+  # ...
+end
+
+# in foo_test.rb
+
+describe 'Foo' do
+  describe 'initialisation' do
+    describe 'requires parameters for' do
+      let(:params) { { foo: 'some foo', bar: 'some bar' } }
+
+      it 'foo' do
+        params.delete :foo
+        error = expect { Foo.new params }.must_raise ArgumentError
+        expect(error.message).must_equal 'missing keyword: foo'
+      end
+
+      it 'bar' do
+        # ...
+      end
+    end
+
+    # ... other initialisation tests
+  end
+
+  # ... other tests
+end
+
+```
+
+That parameter test has two expectations: first, that an `ArgumentError` will be raised; and second, that that error's message will be as expected. Instead, how about this:
+
+```ruby
+
+# in foo_test.rb
+
+describe 'Foo' do
+  describe 'initialisation' do
+    describe 'requires parameters for' do
+      let(:params) { { foo: 'some foo', bar: 'some bar' } }
+
+      it 'foo' do
+        expect(Foo).must_require_initialize_parameter params, :foo
+      end
+
+      it 'bar' do
+        expect(Foo).must_require_initialize_parameter params, :bar
+      end
+    end
+
+    # ... other initialisation tests
+  end
+
+  # ... other tests
+end
+
+```
+
+Two expectations; two assertions; two much more *intention-revealing* expectations.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'prolog_minitest_matchers'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install prolog_minitest_matchers
+
+## Usage
+
+See the discussion at the top of this page for a description of how to use the `must_require_initialize_parameter` expectation, which is a MiniTest::Spec wrapper around the `assert_requires_initialize_parameter` MiniTest assertion.
+
+Note that this assertion will verify that the parameter expected to fail when removed must exist in the full set of parameters specified.
+
+As other assertions/expectations are added to this Gem over the next few weeks, *including* formal test coverage of the asserters and expectations themselves, this usage information will be broken out into a separate document. Stay tuned – or open a pull request!
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies (which as of now must already be installed on your local system). Then, run `bin/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 `bin/rake install`. Maintainers should be familiar with the standard procedure for releasing an updated Gem version to RubyGems.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/prolog_minitest_matchers. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## 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/lib/prolog_minitest_matchers.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'prolog_minitest_matchers/version'
+require 'prolog_minitest_matchers/matchers/requires_initialize_parameter'
+
+module PrologMinitestMatchers
+  # Your code goes here...
+end

data/lib/prolog_minitest_matchers/matchers/asserters/assert_requires_initialize_parameter.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module MiniTest
+  # Adding custom assertions to make specs easier to read
+  module Assertions
+    # Actual test logic for `#assert_requires_initialize_parameter`.
+    class AssertRequiresInitializeParameter
+      def initialize(klass, full_params, param_key, message)
+        @klass = klass
+        @full_params = full_params
+        @param_key = param_key
+        @message = initial_message_from(message, param_key)
+        self
+      end
+
+      def call(assert)
+        assert.call(errors_as_expected(save_and_try_to_init), message)
+      end
+
+      private
+
+      attr_reader :full_params, :klass, :message, :param_key
+
+      def errors_as_expected(errors)
+        errors[:expected]&.message == message
+      end
+
+      def initial_message_from(message, param_key)
+        message || "missing keyword: #{param_key}"
+      end
+
+      def save_and_try_to_init
+        verify_param_in_list
+        saved_item = full_params[param_key]
+        full_params.delete param_key
+        errors = try_to_init
+        full_params[param_key] = saved_item
+        errors
+      end
+
+      def try_to_init
+        expected_error = nil
+        begin
+          _ = klass.new full_params
+        rescue ArgumentError => error
+          expected_error = error
+        rescue StandardError => error
+          ap [:matcher_48, 'Unexpected error', error]
+        end
+        { expected: expected_error }
+      end
+
+      def verify_param_in_list
+        no_param_message = "No key :#{param_key} in #{full_params}!"
+        fail KeyError, no_param_message unless full_params.key?(param_key)
+      end
+    end # class MiniTest::Assertions::AssertRequiresInitializeParameter
+  end
+end

data/lib/prolog_minitest_matchers/matchers/requires_initialize_parameter.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'minitest/spec'
+
+require_relative './asserters/assert_requires_initialize_parameter'
+
+module MiniTest
+  # Adding custom assertions to make specs easier to read
+  module Assertions
+    def assert_requires_initialize_parameter(klass, full_params, param_key,
+                                             message = nil)
+      AssertRequiresInitializeParameter.new(klass, full_params, param_key,
+                                            message).call(method(:assert))
+    end
+  end
+
+  # Make it available to MiniTest::Spec
+  module Expectations
+    infect_an_assertion :assert_requires_initialize_parameter,
+                        :must_require_initialize_parameter, :reverse
+  end
+end

data/lib/prolog_minitest_matchers/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module PrologMinitestMatchers
+  VERSION = '0.1.0'
+end

data/prolog_minitest_matchers.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'prolog_minitest_matchers/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "prolog_minitest_matchers"
+  spec.version       = PrologMinitestMatchers::VERSION
+  spec.authors       = ["Jeff Dickey"]
+  spec.email         = ["jdickey@seven-sigma.com"]
+
+  spec.summary       = %q{Custom Minitest matcher(s) we've developed for our own use.}
+  # spec.description   = %q{TODO: Write a longer description or delete this line.}
+  spec.homepage      = "https://github.com/TheProlog/prolog_minitest_matchers"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12", ">= 1.12.5"
+  spec.add_development_dependency "rake", "~> 11.2", ">= 11.2.2"
+  spec.add_development_dependency "minitest", "~> 5.9", ">= 5.9.0"
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: prolog_minitest_matchers
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jeff Dickey
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-07-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.12.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.12.5
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 11.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 11.2.2
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.9.0
+description: 
+email:
+- jdickey@seven-sigma.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/prolog_minitest_matchers.rb
+- lib/prolog_minitest_matchers/matchers/asserters/assert_requires_initialize_parameter.rb
+- lib/prolog_minitest_matchers/matchers/requires_initialize_parameter.rb
+- lib/prolog_minitest_matchers/version.rb
+- prolog_minitest_matchers.gemspec
+homepage: https://github.com/TheProlog/prolog_minitest_matchers
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.6
+signing_key: 
+specification_version: 4
+summary: Custom Minitest matcher(s) we've developed for our own use.
+test_files: []