shoulda-matchers 4.3.0 → 4.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c022366c394fe10215171aee752452d41f7e051ef0174b99e0d9f947486ac1f7
-  data.tar.gz: 38bc2bf3e4d8432ebc8a8c1bfb319fc1da9236699e1ec28d78b53d93621c96c2
+  metadata.gz: 50d63f547edcfe3f040aff155386def4cf30b3b17befc2e24a3b29f9933d6aba
+  data.tar.gz: dc7066ab2357ddda9efe73ab7bfd547dae0a2b6c3180a4d68d3fb715708af500
 SHA512:
-  metadata.gz: e06ce93032d5612eb34c952eb310f199b718e35875ae31c84ae177a09ca2bbdcc5fe33cc8fc3a97f5bf77aa3c5e2c91e3f7596e8c6328c66e494c8a9f3a94d90
-  data.tar.gz: 10f26b7b206227be842077802b9da370775b198cf30f32e8df70fa1b1bb69cbddd831244071eab874d98e186c6abee7a8c11187015f65b8f1f570b47ba20e947
+  metadata.gz: a112316adba7fa8458cc8b4aa404152cf3618705f232002dddc7b1004f99f69a9717961d4893cfaff50e7d802ae30ea7837e70104bc4a497c9b560982ab80831
+  data.tar.gz: a732f1d0039ad911f35ee9f1d05a4cac8683232b253b42a59a8d6409ed285e292213bca8680e4c627f9fbd7ff27ba85dcc5d67a42885d571462456c385ec635a

data/README.md

@@ -22,10 +22,10 @@ complex, and error-prone.
 ## Quick links
 
 📖 **[Read the documentation for the latest version][rubydocs].**  
-📢 **[See what's changed in a recent version][news].**
+📢 **[See what's changed in recent versions][changelog].**
 
 [rubydocs]: http://matchers.shoulda.io/docs
-[news]: NEWS.md
+[changelog]: CHANGELOG.md
 
 ## Table of contents
 
@@ -41,10 +41,12 @@ complex, and error-prone.
    * [ActiveRecord matchers](#activerecord-matchers)
    * [ActionController matchers](#actioncontroller-matchers)
    * [Independent matchers](#independent-matchers)
-* [Compatibility](#compatibility)
+* [Extensions](#extensions)
 * [Contributing](#contributing)
+* [Compatibility](#compatibility)
 * [Versioning](#versioning)
-* [License](#license)
+* [Team](#team)
+* [Copyright/License](#copyright-license)
 * [About thoughtbot](#about-thoughtbot)
 
 ## Getting started
@@ -55,21 +57,21 @@ Start by including `shoulda-matchers` in your Gemfile:
 
 ```ruby
 group :test do
-  gem 'shoulda-matchers'
+  gem 'shoulda-matchers', '~> 4.0'
 end
 ```
 
-Now you need to tell the gem a couple of things:
+Then run `bundle install`.
 
-* Which test framework you're using
-* Which portion of the matchers you want to use
+Now you need to configure the gem by telling it:
 
-You can supply this information by providing a configuration block. Where this
-goes and what this contains depends on your project.
+* which matchers you want to use in your tests
+* that you're using RSpec so that it can make those matchers available in
+  your example groups
 
 #### Rails apps
 
-Assuming you are testing a Rails app, simply place this at the bottom of
+If you're working on a Rails app, simply place this at the bottom of
 `spec/rails_helper.rb` (or in a support file if you so choose):
 
 ```ruby
@@ -81,13 +83,12 @@ Shoulda::Matchers.configure do |config|
 end
 ```
 
-Now you're ready to [use matchers in your tests](#usage)!
-
 #### Non-Rails apps
 
-If your project isn't a Rails app, but you still make use of ActiveRecord or
-ActiveModel, you can still use this gem too! In that case, you'll want to place
-the following configuration at the bottom of `spec/spec_helper.rb`:
+If you're not working on a Rails app, but you still make use of ActiveRecord or
+ActiveModel in your project, you can still use this gem too! In that case,
+you'll want to place the following configuration at the bottom of
+`spec/spec_helper.rb`:
 
 ```ruby
 Shoulda::Matchers.configure do |config|
@@ -101,45 +102,83 @@ Shoulda::Matchers.configure do |config|
 end
 ```
 
-Now you're ready to [use matchers in your tests](#usage)!
-
 ### Minitest
 
-Shoulda Matchers was originally a component of [Shoulda][shoulda], a gem that
-also provides `should` and `context` syntax via
-[`shoulda-context`][shoulda-context].
+If you're using our umbrella gem [Shoulda], then make sure that you're using the
+latest version:
+
+```ruby
+group :test do
+  gem 'shoulda', '~> 4.0'
+end
+```
 
-[shoulda]: https://github.com/thoughtbot/shoulda
-[shoulda-context]: https://github.com/thoughtbot/shoulda-context
+[Shoulda]: https://github.com/thoughtbot/shoulda
 
-At the moment, `shoulda` has not been updated to support `shoulda-matchers` 3.x
-and 4.x, so you'll want to add the following to your Gemfile:
+Otherwise, add `shoulda-matchers` to your Gemfile:
 
 ```ruby
 group :test do
-  gem 'shoulda', '~> 3.5'
-  gem 'shoulda-matchers', '~> 2.0'
-  gem 'rails-controller-testing'
+  gem 'shoulda-matchers', '~> 4.0'
 end
 ```
 
-Now you're ready to [use matchers in your tests](#usage)!
+Then run `bundle install`.
+
+Now you need to configure the gem by telling it:
+
+* which matchers you want to use in your tests
+* that you're using Minitest so that it can make those matchers available in
+  your test case classes
+
+#### Rails apps
+
+If you're working on a Rails app, simply place this at the bottom of
+`test/test_helper.rb`:
+
+```ruby
+Shoulda::Matchers.configure do |config|
+  config.integrate do |with|
+    with.test_framework :minitest
+    with.library :rails
+  end
+end
+```
+
+#### Non-Rails apps
+
+If you're not working on a Rails app, but you still make use of ActiveRecord or
+ActiveModel in your project, you can still use this gem too! In that case,
+you'll want to place the following configuration at the bottom of
+`test/test_helper.rb`:
+
+```ruby
+Shoulda::Matchers.configure do |config|
+  config.integrate do |with|
+    with.test_framework :minitest
+
+    # Keep as many of these lines as are necessary:
+    with.library :active_record
+    with.library :active_model
+  end
+end
+```
 
 ## Usage
 
-The matchers provided by this gem are divided into different categories
-depending on what you're testing within your Rails app:
+Most of the matchers provided by this gem are useful in a Rails context, and as
+such, can be used for different parts of a Rails app:
 
 * [database models backed by ActiveRecord](#activemodel-matchers)
 * [non-database models, form objects, etc. backed by
   ActiveModel](#activerecord-matchers)
 * [controllers](#actioncontroller-matchers)
 * [routes](#routing-matchers) (RSpec only)
-* [usage of Rails-specific features like `delegate`](#independent-matchers)
+* [Rails-specific features like `delegate`](#independent-matchers)
 
-All matchers are designed to be prepended primarily with the word `should`,
-which is a special directive in both RSpec and Shoulda. For instance, a model
-test case may look something like:
+As the name of the gem indicates, most matchers are designed to be used in
+"one-liner" form using the `should` macro, a special directive available in both
+RSpec and [Shoulda]. For instance, a model test case may look something like:
 
 ``` ruby
 # RSpec
@@ -167,16 +206,17 @@ class MenuItemTest < ActiveSupport::TestCase
 end
 ```
 
-For the full set of matchers you can use, [see below](#matchers).
+[See below](#matchers) for the full set of matchers that you can use.
 
 ### On the subject of `subject`
 
 For both RSpec and Shoulda, the **subject** is an implicit reference to the
-object under test, and all of the matchers make use of it internally when they
-are run. This is always set automatically by your test framework in any given
-test case; however, in certain cases it can be advantageous to override the
-subject. For instance, when testing validations in a model, it is customary to
-provide a valid model instead of a fresh one:
+object under test, and through the use of `should` as demonstrated above, all of
+the matchers make use of `subject` internally when they are run. A `subject` is
+always set automatically by your test framework in any given test case; however,
+in certain cases it can be advantageous to override it. For instance, when
+testing validations in a model, it is customary to provide a valid model instead
+of a fresh one:
 
 ``` ruby
 # RSpec
@@ -234,11 +274,19 @@ end
 
 ### Availability of RSpec matchers in example groups
 
+#### Rails projects
+
 If you're using RSpec, then you're probably familiar with the concept of example
-groups: these are different kinds of test cases, and each of them has special
-behavior around them. As alluded to [above](#usage), this gem works in a similar
-way, and there are matchers that are only available in certain types of example
-groups:
+groups. Example groups can be assigned tags order to assign different behavior
+to different kinds of example groups. This comes into play especially when using
+`rspec-rails`, where, for instance, controller example groups, tagged with
+`type: :controller`, are written differently than request example groups, tagged
+with `type: :request`. This difference in writing style arises because
+`rspec-rails` mixes different behavior and methods into controller example
+groups vs. request example groups.
+
+Relying on this behavior, Shoulda Matchers automatically makes certain matchers
+available in certain kinds of example groups:
 
 * ActiveRecord and ActiveModel matchers are available only in model example
   groups, i.e., those tagged with `type: :model` or in files located under
@@ -250,13 +298,27 @@ groups:
   tagged with `type: :routing` or in files located under `spec/routing`.
 * Independent matchers are available in all example groups.
 
-As long as you're using Rails, you don't need to worry about this — everything
-should "just work".
+As long as you're using Rails, you don't need to worry about these details —
+everything should "just work".
+
+#### Non-Rails projects
+
+**What if you are using ActiveModel or ActiveRecord outside of Rails, however,
+and you want to use model matchers in a certain example group?** Then you'll
+need to manually include the module that holds those matchers into that example
+group. For instance, you might have to say:
 
-**However, if you are using ActiveModel or ActiveRecord outside of Rails**, and
-you want to use model matchers in certain example groups, you'll need to
-manually include the module that holds those matchers. A good way to do this is
-to place the following in your `spec_helper.rb`:
+``` ruby
+RSpec.describe MySpecialModel do
+  include Shoulda::Matchers::ActiveModel
+  include Shoulda::Matchers::ActiveRecord
+end
+```
+
+If you have a lot of similar example groups in which you need to do this, then
+you might find it more helpful to tag your example groups appropriately, then
+instruct RSpec to mix these modules into any example groups that have that tag.
+For instance, you could add this to your `rails_helper.rb`:
 
 ```ruby
 RSpec.configure do |config|
@@ -265,21 +327,20 @@ RSpec.configure do |config|
 end
 ```
 
-Then you can say:
+And from then on, you could say:
 
 ```ruby
-describe MySpecialModel, type: :model do
+RSpec.describe MySpecialModel, type: :model do
   # ...
 end
 ```
 
 ### `should` vs `is_expected.to`
 
-In this README and throughout the documentation, we're using the `should` form
-of RSpec's one-liner syntax over `is_expected.to`. The `should` form works
-regardless of how you've configured RSpec — meaning you can still use it even
-when using the `expect` syntax. But if you prefer to use `is_expected.to`, you
-can do that too:
+In this README and throughout the documentation, you'll notice that we use the
+`should` form of RSpec's one-liner syntax over `is_expected.to`. Beside being
+the namesake of the gem itself, this is our preferred syntax as it's short and
+sweet. But if you prefer to use `is_expected.to`, you can do that too:
 
 ```ruby
 RSpec.describe Person, type: :model do
@@ -289,7 +350,7 @@ end
 
 ## Matchers
 
-The following is a list of matchers shipped with the gem. If you need details
+Here is the full list of matchers that ship with this gem. If you need details
 about any of them, make sure to [consult the documentation][rubydocs]!
 
 ### ActiveModel matchers
@@ -330,10 +391,16 @@ about any of them, make sure to [consult the documentation][rubydocs]!
   tests that the table that backs your model has a specific column.
 * **[have_db_index](lib/shoulda/matchers/active_record/have_db_index_matcher.rb)**
   tests that the table that backs your model has an index on a specific column.
+* **[have_implicit_order_column](lib/shoulda/matchers/active_record/have_implicit_order_column.rb)**
+  tests usage of `implicit_order_column`.
 * **[have_many](lib/shoulda/matchers/active_record/association_matcher.rb)**
   tests your `has_many` associations.
+* **[have_many_attached](lib/shoulda/matchers/active_record/have_attached_matcher.rb)**
+  tests your `has_many_attached` associations.
 * **[have_one](lib/shoulda/matchers/active_record/association_matcher.rb)**
   tests your `has_one` associations.
+* **[have_one_attached](lib/shoulda/matchers/active_record/have_attached_matcher.rb)**
+  tests your `has_one_attached` associations.
 * **[have_readonly_attribute](lib/shoulda/matchers/active_record/have_readonly_attribute_matcher.rb)**
   tests usage of the `attr_readonly` macro.
 * **[have_rich_text](lib/shoulda/matchers/active_record/have_rich_text_matcher.rb)**
@@ -383,37 +450,51 @@ about any of them, make sure to [consult the documentation][rubydocs]!
   tests that an object forwards messages to other, internal objects by way of
   delegation.
 
-## Compatibility
+## Extensions
 
-Shoulda Matchers is tested and supported against Ruby 2.4+, Rails 5.x, Rails
-4.2.x, RSpec 3.x, and Minitest 5.x.
+Over time our community has created extensions to Shoulda Matchers. If you've
+created something that you want to share, please [let us know][new-issue]!
 
-For Ruby < 2.4 and Rails < 4.1 compatibility, please use [v3.1.3][v3.1.3].
+* **[shoulda-matchers-cucumber]** – Adds support for using Shoulda Matchers in
+  Cucumber tests.
 
-[v3.1.3]: https://github.com/thoughtbot/shoulda-matchers/releases/tag/v3.1.3
+[new-issue]: https://github.com/thoughtbot/shoulda-matchers/issues/new
+[shoulda-matchers-cucumber]: https://github.com/majioa/shoulda-matchers-cucumber
 
 ## Contributing
 
-Shoulda Matchers is open source, and we are grateful for
-[everyone][contributors] who's contributed so far.
+Have a fix for a problem you've been running into or an idea for a new feature
+you think would be useful? Take a look at the [Contributing
+document](CONTRIBUTING.md) for instructions on setting up the repo on your
+machine, understanding the codebase, and creating a good pull request.
 
-[contributors]: https://github.com/thoughtbot/shoulda-matchers/contributors
+## Compatibility
 
-If you'd like to contribute, please take a look at the
-[instructions](CONTRIBUTING.md) for installing dependencies and crafting a good
-pull request.
+Shoulda Matchers is [tested][travis] and supported against Ruby 2.4+, Rails
+4.2+, RSpec 3.x, and Minitest 5.x.
+
+For Ruby < 2.4 and Rails < 4.1 compatibility, please use [v3.1.3][v3.1.3].
+
+[v3.1.3]: https://github.com/thoughtbot/shoulda-matchers/tree/v3.1.3
 
 ## Versioning
 
 Shoulda Matchers follows Semantic Versioning 2.0 as defined at
 <http://semver.org>.
 
-## License
+## Team
+
+Shoulda Matchers is maintained by [Elliot Winkler][mcmire] and [Gui
+Albuk][guialbuk].
+
+[mcmire]: https://github.com/mcmire
+[guialbuk]: https://github.com/guialbuk
+
+## Copyright/License
 
-Shoulda Matchers is copyright © 2006-2020
-[thoughtbot, inc][thoughtbot-website]. It is free software,
-and may be redistributed under the terms specified in the
-[MIT-LICENSE](MIT-LICENSE) file.
+Shoulda Matchers is copyright © 2006-2020 Tammer Saleh and [thoughtbot,
+inc][thoughtbot-website]. It is free and opensource software and may be
+redistributed under the terms specified in the [LICENSE](LICENSE) file.
 
 [thoughtbot-website]: https://thoughtbot.com
 
@@ -423,8 +504,7 @@ and may be redistributed under the terms specified in the
 
 [thoughtbot-logo]: https://presskit.thoughtbot.com/images/thoughtbot-logo-for-readmes.svg
 
-Shoulda Matchers is maintained and funded by thoughtbot, inc. The names and
-logos for thoughtbot are trademarks of thoughtbot, inc.
+The names and logos for thoughtbot are trademarks of thoughtbot, inc.
 
 We are passionate about open source software. See [our other
 projects][community]. We are [available for hire][hire].

data/lib/shoulda/matchers.rb

@@ -1,21 +1,22 @@
 require 'shoulda/matchers/configuration'
-require 'shoulda/matchers/doublespeak'
-require 'shoulda/matchers/error'
-require 'shoulda/matchers/independent'
-require 'shoulda/matchers/integrations'
-require 'shoulda/matchers/matcher_context'
-require 'shoulda/matchers/rails_shim'
-require 'shoulda/matchers/util'
 require 'shoulda/matchers/version'
 require 'shoulda/matchers/warn'
 
-require 'shoulda/matchers/action_controller'
-require 'shoulda/matchers/active_model'
-require 'shoulda/matchers/active_record'
-require 'shoulda/matchers/routing'
-
 module Shoulda
   module Matchers
+    autoload :ActionController, 'shoulda/matchers/action_controller'
+    autoload :ActiveModel, 'shoulda/matchers/active_model'
+    autoload :ActiveRecord, 'shoulda/matchers/active_record'
+    autoload :Doublespeak, 'shoulda/matchers/doublespeak'
+    autoload :Error, 'shoulda/matchers/error'
+    autoload :Independent, 'shoulda/matchers/independent'
+    autoload :Integrations, 'shoulda/matchers/integrations'
+    autoload :MatcherContext, 'shoulda/matchers/matcher_context'
+    autoload :RailsShim, 'shoulda/matchers/rails_shim'
+    autoload :Routing, 'shoulda/matchers/routing'
+    autoload :Util, 'shoulda/matchers/util'
+    autoload :WordWrap, 'shoulda/matchers/util/word_wrap'
+
     class << self
       # @private
       attr_accessor :assertion_exception_class

data/lib/shoulda/matchers/action_controller.rb

@@ -1,24 +1,24 @@
-require 'shoulda/matchers/action_controller/filter_param_matcher'
-require 'shoulda/matchers/action_controller/route_params'
-require 'shoulda/matchers/action_controller/set_flash_matcher'
-require 'shoulda/matchers/action_controller/render_with_layout_matcher'
 require 'shoulda/matchers/action_controller/respond_with_matcher'
-require 'shoulda/matchers/action_controller/set_session_matcher'
 require 'shoulda/matchers/action_controller/route_matcher'
-require 'shoulda/matchers/action_controller/redirect_to_matcher'
-require 'shoulda/matchers/action_controller/render_template_matcher'
-require 'shoulda/matchers/action_controller/rescue_from_matcher'
-require 'shoulda/matchers/action_controller/callback_matcher'
-require 'shoulda/matchers/action_controller/permit_matcher'
-require 'shoulda/matchers/action_controller/set_session_or_flash_matcher'
-require 'shoulda/matchers/action_controller/flash_store'
-require 'shoulda/matchers/action_controller/session_store'
 
 module Shoulda
   module Matchers
     # This module provides matchers that are used to test behavior within
     # controllers.
     module ActionController
+      autoload :CallbackMatcher, 'shoulda/matchers/action_controller/callback_matcher'
+      autoload :FlashStore, 'shoulda/matchers/action_controller/flash_store'
+      autoload :FilterParamMatcher, 'shoulda/matchers/action_controller/filter_param_matcher'
+      autoload :PermitMatcher, 'shoulda/matchers/action_controller/permit_matcher'
+      autoload :RedirectToMatcher, 'shoulda/matchers/action_controller/redirect_to_matcher'
+      autoload :RenderTemplateMatcher, 'shoulda/matchers/action_controller/render_template_matcher'
+      autoload :RenderWithLayoutMatcher, 'shoulda/matchers/action_controller/render_with_layout_matcher'
+      autoload :RescueFromMatcher, 'shoulda/matchers/action_controller/rescue_from_matcher'
+      autoload :RouteParams, 'shoulda/matchers/action_controller/route_params'
+      autoload :SessionStore, 'shoulda/matchers/action_controller/session_store'
+      autoload :SetFlashMatcher, 'shoulda/matchers/action_controller/set_flash_matcher'
+      autoload :SetSessionMatcher, 'shoulda/matchers/action_controller/set_session_matcher'
+      autoload :SetSessionOrFlashMatcher, 'shoulda/matchers/action_controller/set_session_or_flash_matcher'
     end
   end
 end