shoulda-context 1.2.2 → 2.0.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 8f5e8f0cc83d3b44bd9eddf2193085c1b9fea968
-  data.tar.gz: 7c8a322dea7cfb60550eb4a199a01346f86bfaa3
+SHA256:
+  metadata.gz: 51bde035855288943372f8d9fc71310416ae02ddacbab30f912e5abbce21ab5f
+  data.tar.gz: ce5ee8ece26119b829ab2851b3607ed1f62c00478115ede3e3a987dc86455e16
 SHA512:
-  metadata.gz: b441e5a21877364af355eb9a431fbd05be5065cd3c646c3335d397b87a1eb857e71c11a7f9b6884896c18c4dceb83ffcdde80773ed71ae31575b3d2a12c643e2
-  data.tar.gz: 5893017828229249e980f1f4c67c08a04ec3619942a8b9dd455727be8d71525a39927ea764a3f8b3ba3fa90069bc99c77d92694b978329a60c64277ce3036ca8
+  metadata.gz: ef854338d26cb4613673c019d38fd66411899e5ab983421ed3d0db45449ac527c982faa8910b831421fd1a1edfbfa6f1e8572bba6d191ba17809b6b8aef4a338
+  data.tar.gz: e2854aad28db7d53de92728d00df9b51395e142d3f74a41da75883e8febc2a2e062c48d84e96879b9bae88f49bbce9002fd29442da33068e7d44d8042eea2e75

data/.gitignore

@@ -1,5 +1,4 @@
 .bundle
-Gemfile.lock
 vendor/ruby
 vendor/cache
 doc

data/.rubocop.yml

@@ -0,0 +1,190 @@
+AllCops:
+  TargetRubyVersion: 2.4
+  Exclude:
+    - '*.gemspec'
+Layout/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+Layout/ConditionPosition:
+  Enabled: false
+Layout/DotPosition:
+  EnforcedStyle: trailing
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+Lint/AmbiguousOperator:
+  Enabled: false
+Lint/AmbiguousRegexpLiteral:
+  Enabled: false
+Lint/AssignmentInCondition:
+  Enabled: false
+Lint/DeprecatedClassMethods:
+  Enabled: false
+Lint/ElseLayout:
+  Enabled: false
+Lint/HandleExceptions:
+  Enabled: false
+Lint/IndentHeredoc:
+  Enabled: false
+Lint/LiteralInInterpolation:
+  Enabled: false
+Lint/Loop:
+  Enabled: false
+Lint/ParenthesesAsGroupedExpression:
+  Enabled: false
+Lint/RequireParentheses:
+  Enabled: false
+Lint/UnderscorePrefixedVariableName:
+  Enabled: false
+Lint/Void:
+  Enabled: false
+Metrics/BlockLength:
+  Enabled: false
+Metrics/ClassLength:
+  Enabled: false
+Metrics/LineLength:
+  IgnoredPatterns:
+    - "^[ ]*describe.+$"
+    - "^[ ]*context.+$"
+    - "^[ ]*shared_context.+$"
+    - "^[ ]*shared_examples_for.+$"
+    - "^[ ]*it.+$"
+    - "^[ ]*'.+?' => '.+?',?$"
+    - "^[ ]*\".+?\" => \".+?\",?$"
+    - "^[ ]*.+?: .+?$"
+Metrics/MethodLength:
+  Max: 30
+Naming/AccessorMethodName:
+  Enabled: false
+Naming/AsciiIdentifiers:
+  Enabled: false
+Naming/BinaryOperatorParameterName:
+  Enabled: false
+Naming/MemoizedInstanceVariableName:
+  EnforcedStyleForLeadingUnderscores: required
+Style/ClassVars:
+  Enabled: false
+Style/ColonMethodCall:
+  Enabled: false
+Naming/FileName:
+  Enabled: false
+Rails:
+  Enabled: true
+Rails/Delegate:
+  Enabled: false
+Rails/HttpPositionalArguments:
+  Enabled: false
+Style/Alias:
+  Enabled: false
+Style/ArrayJoin:
+  Enabled: false
+Style/AsciiComments:
+  Enabled: false
+Style/Attr:
+  Enabled: false
+Style/CaseEquality:
+  Enabled: false
+Style/CharacterLiteral:
+  Enabled: false
+Style/ClassAndModuleChildren:
+  Enabled: false
+Style/CollectionMethods:
+  PreferredMethods:
+    find: detect
+    reduce: inject
+    collect: map
+    find_all: select
+Style/CommentAnnotation:
+  Enabled: false
+Style/Documentation:
+  Enabled: false
+Style/DoubleNegation:
+  Enabled: false
+Style/EachWithObject:
+  Enabled: false
+Style/EmptyLiteral:
+  Enabled: false
+Style/Encoding:
+  Enabled: false
+Style/EvenOdd:
+  Enabled: false
+Style/ExpandPathArguments:
+  Enabled: false
+Style/FlipFlop:
+  Enabled: false
+Style/FormatString:
+  Enabled: false
+Style/FrozenStringLiteralComment:
+  Enabled: false
+Style/GlobalVars:
+  Enabled: false
+Style/GuardClause:
+  Enabled: false
+Style/IfUnlessModifier:
+  Enabled: false
+Style/IfWithSemicolon:
+  Enabled: false
+Style/InlineComment:
+  Enabled: false
+Style/Lambda:
+  Enabled: false
+Style/LambdaCall:
+  Enabled: false
+Style/LineEndConcatenation:
+  Enabled: false
+Style/MethodCalledOnDoEndBlock:
+  Enabled: false
+Style/ModuleFunction:
+  Enabled: false
+Style/NegatedIf:
+  Enabled: false
+Style/NegatedWhile:
+  Enabled: false
+Style/Next:
+  Enabled: false
+Style/NilComparison:
+  Enabled: false
+Style/Not:
+  Enabled: false
+Style/NumericLiterals:
+  Enabled: false
+Style/NumericPredicate:
+  Enabled: false
+Style/OneLineConditional:
+  Enabled: false
+Style/PercentLiteralDelimiters:
+  Enabled: false
+Style/PerlBackrefs:
+  Enabled: false
+Style/PreferredHashMethods:
+  Enabled: false
+Style/Proc:
+  Enabled: false
+Style/RaiseArgs:
+  Enabled: false
+Style/RegexpLiteral:
+  Enabled: false
+Style/RescueStandardError:
+  Enabled: false
+Style/SelfAssignment:
+  Enabled: false
+Style/SignalException:
+  Enabled: false
+Style/SingleLineBlockParams:
+  Enabled: false
+Style/SingleLineMethods:
+  Enabled: false
+Style/SpecialGlobalVars:
+  Enabled: false
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+Style/SymbolArray:
+  Enabled: false
+Style/TrivialAccessors:
+  Enabled: false
+Style/WhenThen:
+  Enabled: false
+Style/WhileUntilModifier:
+  Enabled: false
+Style/WordArray:
+  Enabled: false
+Style/VariableInterpolation:
+  Enabled: false

data/.ruby-version

@@ -1 +1 @@
-2.0.0-p247
+2.6.1

data/.travis.yml

@@ -1,3 +1,28 @@
+language: ruby
+sudo: false
+cache:
+  directories:
+    - vendor/bundle
+script: "bundle exec rake"
+# Source: <https://docs.travis-ci.com/user/languages/ruby/#bundler-20>
+before_install:
+  - gem update --system '2.7.8' --no-document
+  - gem uninstall -v '>= 2' -i $(rvm gemdir)@global -ax bundler || true
+  - gem install bundler -v '< 2' --no-document
+install: "bundle install --jobs=3 --retry=3 --path vendor/bundle"
+
 rvm:
-  - 1.9.3
-  - 2.0.0
+  - 2.6.1
+  - 2.5.1
+  - 2.4.4
+  - 2.3.7
+
+env:
+  - TEST_FRAMEWORK=minitest
+  - TEST_FRAMEWORK=test_unit
+
+gemfile:
+  - gemfiles/rails_4_2.gemfile
+  - gemfiles/rails_5_0.gemfile
+  - gemfiles/rails_5_1.gemfile
+  - gemfiles/rails_5_2.gemfile

data/Appraisals

@@ -1,44 +1,27 @@
-appraise 'rails_3_0' do
-  gem 'rails', '~> 3.0.0'
-  gem 'sqlite3'
+shared_dependencies = proc do
+  gem "sqlite3", "~> 1.3.6"
 end
 
-appraise 'rails_3_1' do
-  gem 'rails', '~> 3.1.0'
-  gem 'jquery-rails'
-  gem 'sass-rails'
-  gem 'sqlite3'
-end
+appraise "rails_4_2" do
+  instance_eval(&shared_dependencies)
 
-appraise 'rails_3_2' do
-  gem 'rails', '~> 3.2.0'
-  gem 'jquery-rails'
-  gem 'sass-rails'
-  gem 'sqlite3'
+  gem "rails", "~> 4.2.0"
 end
 
-appraise 'rails_4_0' do
-  gem 'rails', '~> 4.0.0'
-  gem 'jquery-rails'
-  gem 'sass-rails'
-  gem 'sqlite3'
-end
+appraise "rails_5_0" do
+  instance_eval(&shared_dependencies)
 
-appraise 'rails_4_1' do
-  gem 'rails', github: 'rails/rails', branch: '4-1-stable'
-  gem 'jquery-rails'
-  gem 'sass-rails'
-  gem 'sqlite3'
+  gem "rails", "~> 5.0.0"
 end
 
-appraise 'minitest_4_x' do
-  gem 'minitest', '~> 4.0'
-end
+appraise "rails_5_1" do
+  instance_eval(&shared_dependencies)
 
-appraise 'minitest_5_x' do
-  gem 'minitest', '~> 5.0'
+  gem "rails", "~> 5.1.0"
 end
 
-appraise 'test_unit' do
-  gem 'test-unit'
+appraise "rails_5_2" do
+  instance_eval(&shared_dependencies)
+
+  gem "rails", "~> 5.2.0"
 end

data/CHANGELOG.md

@@ -0,0 +1,27 @@
+# Changelog
+
+## 2.0.0 (unreleased)
+
+### Backward-incompatible changes
+
+* Drop support for RSpec 2 matchers. Matchers passed to `should` must conform
+  to RSpec 3's API (`failure_message` and `failure_message_when_negated`).
+* Drop support for Minitest 4.x (last updated in 2013).
+* Drop support for end-of-lifed versions of Rails. Rails 4.2.x, 5.1.x, and 5.2.x
+  are the only versions supported now.
+* Drop support for end-of-lifed versions of Ruby. Ruby 2.3.x, 2.4.x and 2.5.x
+  are the only versions supported now.
+
+### Bug fixes
+
+* Fix how test names are generated so that when including the name of the
+  outermost test class, "Test" is not removed from the class name if it does not
+  fall at the end.
+* Remove warning from Ruby about `context` not being used when using the gem
+  with warnings enabled.
+* Fix macro autoloading code. Files intended to hold custom macros which are
+  located in either `test/shoulda_macros`, `vendor/gems/*/shoulda_macros`, or
+  `vendor/plugins/*/shoulda_macros` are now loaded and mixed into your test
+  framework's automatically.
+* Restore compatibility with Shoulda Matchers, starting from 3.0.
+* Fix some compatibility issues with Minitest 5.

data/Gemfile

@@ -1,3 +1,6 @@
-source 'http://rubygems.org'
+source "https://rubygems.org"
 
 gemspec
+
+gem "minitest"
+gem "test-unit"

data/Gemfile.lock

@@ -0,0 +1,72 @@
+PATH
+  remote: .
+  specs:
+    shoulda-context (2.0.0.rc1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    appraisal (2.2.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    ast (2.4.0)
+    byebug (10.0.2)
+    coderay (1.1.2)
+    jaro_winkler (1.5.2)
+    m (1.5.1)
+      method_source (>= 0.6.7)
+      rake (>= 0.9.2.2)
+    metaclass (0.0.4)
+    method_source (0.9.2)
+    minitest (5.11.3)
+    mocha (1.8.0)
+      metaclass (~> 0.0.1)
+    parallel (1.14.0)
+    parser (2.6.0.0)
+      ast (~> 2.4.0)
+    power_assert (1.1.3)
+    powerpack (0.1.2)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.6.0)
+      byebug (~> 10.0)
+      pry (~> 0.10)
+    psych (3.1.0)
+    rainbow (3.0.0)
+    rake (12.3.2)
+    rubocop (0.65.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      powerpack (~> 0.1)
+      psych (>= 3.1.0)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.4.0)
+    ruby-progressbar (1.10.0)
+    snowglobe (0.1.0)
+    test-unit (3.3.0)
+      power_assert
+    thor (0.20.3)
+    unicode-display_width (1.4.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  appraisal
+  bundler (~> 1.0)
+  m
+  minitest
+  mocha
+  pry-byebug
+  rake
+  rubocop
+  shoulda-context!
+  snowglobe
+  test-unit
+
+BUNDLED WITH
+   1.17.3

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2006-2013, Tammer Saleh, thoughtbot, inc.
+Copyright (c) 2006-2013, Tammer Saleh and thoughtbot, inc.
 
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation

data/README.md

@@ -1,22 +1,34 @@
-# shoulda-context [![Gem Version](https://badge.fury.io/rb/shoulda-context.png)](http://badge.fury.io/rb/shoulda-context) [![Build Status](https://travis-ci.org/thoughtbot/shoulda-context.png?branch=master)](https://travis-ci.org/thoughtbot/shoulda-context)
+# Shoulda Context [![Gem Version][version-badge]][rubygems] [![Build Status][travis-badge]][travis] ![Downloads][downloads-badge] [![Hound][hound-badge]][hound]
 
-[Official Documentation](http://rubydoc.info/github/thoughtbot/shoulda-context/master/frames)
+[version-badge]: https://img.shields.io/gem/v/shoulda-context.svg
+[rubygems]: https://rubygems.org/gems/shoulda-matchers
+[travis-badge]: https://img.shields.io/travis/thoughtbot/shoulda-context/master.svg
+[travis]: https://travis-ci.org/thoughtbot/shoulda-context
+[downloads-badge]: https://img.shields.io/gem/dtv/shoulda-context.svg
+[hound-badge]: https://img.shields.io/badge/Reviewed_by-Hound-8E64B0.svg
+[hound]: https://houndci.com
 
-Shoulda's contexts make it easy to write understandable and maintainable tests for Test::Unit.
-It's fully compatible with your existing tests in Test::Unit, and requires no retooling to use.
+Shoulda Context makes it easy to write understandable and maintainable tests
+under Minitest and Test::Unit within Rails projects or plain Ruby projects. It's
+fully compatible with your existing tests and requires no retooling to use.
 
-Refer to the [shoulda](https://github.com/thoughtbot/shoulda) gem if you want to know more
-about using shoulda with Rails or RSpec.
+**[View the documentation for the latest version (1.2.2)][rubydocs] • [View
+the changelog][changelog]**
 
-## Contexts
+[changelog]: CHANGELOG.md
 
-Instead of writing Ruby methods with `lots_of_underscores`, shoulda-context adds
-context, setup, and should blocks...
+---
 
-```ruby
-require "test/unit"
+## Usage
+
+Instead of writing Ruby methods with `lots_of_underscores`, Shoulda Context lets
+you name your tests and group them together using English.
+
+At a minimum, the gem provides some convenience layers around core Minitest
+functionality. For instance, this test case:
 
-class CalculatorTest < Test::Unit::TestCase
+```ruby
+class CalculatorTest < Minitest::Test
   context "a calculator" do
     setup do
       @calculator = Calculator.new
@@ -33,35 +45,134 @@ class CalculatorTest < Test::Unit::TestCase
 end
 ```
 
-... which combine to produce the following test methods:
+is a prettier, but functionally equivalent, way of saying:
+
+```ruby
+class CalculatorTest < Minitest::Test
+  def setup
+    @calculator = Calculator.new
+  end
+
+  define_method "test_: a calculator should add two numbers for the sum" do
+    assert_equal 4, @calculator.sum(2, 2)
+  end
+
+  define_method "test_: a calculator should multiply two numbers for the product" do
+    assert_equal 10, @calculator.product(2, 5)
+  end
+end
+```
+
+However, Shoulda Context also provides functionality apart from Minitest /
+Test::Unit that allows you to shorten tests drastically by making use of
+RSpec-compatible matchers. For instance, with [Shoulda
+Matchers][shoulda-matchers] you can write such tests as:
+
+```ruby
+class User < ActiveSupport::TestCase
+  context "validations" do
+    subject { FactoryBot.build(:user) }
+
+    should validate_presence_of(:first_name)
+    should validate_presence_of(:last_name)
+    should validate_uniqueness_of(:email)
+    should_not allow_value('weird').for(:email)
+  end
+end
+```
+
+[shoulda-matchers]: https://github.com/thoughtbot/shoulda-matchers
+
+## API
+
+### DSL
+
+The primary method in Shoulda Context's API is `context`, which declares a group
+of a tests.
+
+These methods are available inside of a `context`:
+
+* `setup` — a DSL-y alternative to defining a `setup` method
+* `teardown` — a DSL-y alternative to defining a `teardown` method
+* `should` — There are two forms:
+  1. when passed a name + block, creates a test equivalent to defining a
+  `test_` method
+  2. when passed a matcher, creates a test that will run the matcher, asserting
+  that it passes
+* `should_not` — like the matcher version of `should`, but creates a test that
+  asserts that the matcher fails
+* `should_eventually` — allows you to temporarily skip tests
+* `context` — creates a subcontext
+
+These methods are available within a test case class, but outside of a
+`context`:
+
+* `should` — same as above
+* `should_not` — same as above
+* `should_eventually` — same as above
+* `described_type` — returns the class being tested, as determined by the class
+  name of the outermost class
+* `subject` — lets you define an object that is the primary focus of the tests
+  within a context; this is most useful when using a matcher as the matcher will
+  make use of this as _its_ subject
 
-    "test: a calculator should add two numbers for the sum."
-    "test: a calculator should multiply two numbers for the product."
+And these methods are available inside of a test (whether defined via a method
+or via `should`):
 
-When running a single test method via (example from a Rails context):
+* `subject` — an instance of the class under test, which is derived
+  automatically from the name of the test case class but is overridable via the
+  class method version of `subject` above
 
-    ruby -I"lib:test" path_to_test_file -n name_of_the_test_method
+[rubydocs]: http://rubydoc.info/github/thoughtbot/shoulda-context/master/frames
 
-you should include a trailing space(!), e.g.,
+### Assertions
 
-    ruby -I"lib:test" path_to_test_file -n "test: a calculator should add two numbers for the sum. "
+In addition to the main API, the gem also provides some extra assertions that
+may be of use:
 
+* `assert_same_elements` — compares two arrays for equality, but ignoring
+  ordering
+* `assert_contains` — asserts that an array has an item
+* `assert_does_not_contain` — the opposite of `assert_contains`
+* `assert_accepts` — what `should` uses internally; asserts that a matcher
+  object matches against a value
+* `assert_reject` — what `should_not` uses internally; asserts that a matcher
+  object does not match against a value
 
-## Assertions
+## Note on running tests
 
-It also has two additional Test::Unit assertions for working with Ruby's Array:
+Normally, you will run a single test like this:
 
-    assert_same_elements([:a, :b, :c], [:c, :a, :b])
-    assert_contains(['a', '1'], /\d/)
-    assert_contains(['a', '1'], 'a')
+    ruby -I lib -I test path_to_test.rb -n name_of_test_method
+
+When using Shoulda Context, however, you'll need to put a space after the test
+name:
+
+    ruby -I lib -I test path_to_test.rb -n "test_: a calculator should add two numbers for the sum. "
+
+If this is too cumbersome, consider using the [m] gem to run tests instead:
+
+    m path_to_test.rb:39
+
+[m]: https://github.com/qrush/m
+
+## Compatibility
+
+Shoulda Context is tested and supported against Rails 5.x, Rails 4.2, Minitest
+5, Test::Unit 3, and Ruby 2.3+.
 
 ## Credits
 
-Shoulda is maintained and funded by [thoughtbot](http://thoughtbot.com/community).
-shoulda-context is maintained by [Travis Jeffery](https://github.com/travisjeffery).
-Thank you to all the [contributors](https://github.com/thoughtbot/shoulda-context/contributors).
+Shoulda Context is maintained by [Travis Jeffery][travis-jeffery] and
+thoughtbot. Thank you to all the [contributors].
+
+[travis-jeffery]: https://github.com/travisjeffery
+[contributors]: https://github.com/thoughtbot/shoulda-context/contributors
 
 ## License
 
-Shoulda is Copyright © 2006-2016 thoughtbot, inc.
-It is free software, and may be redistributed under the terms specified in the MIT-LICENSE file.
+Shoulda Context is copyright © 2006-2019 [thoughtbot, inc][thoughtbot-website].
+It is free software, and may be redistributed under the terms specified in the
+[MIT-LICENSE](MIT-LICENSE) file.
+
+[thoughtbot-website]: https://thoughtbot.com