Shoulda Matchers for ViewComponent

Adds convenient ViewComponent matchers to shoulda matchers.

Include shoulda-matchers-viewcomponent in your Gemfile:

group :test do
  # ...
  gem 'shoulda-matchers-viewcomponent'
end

And run bundle.

Then configure Shoulda to use the ViewComponent matchers:

require 'shoulda/matchers/view_component'

# If using RSpec, this would typically go in spec/rails_helper.rb
Shoulda::Matchers.configure do |config|
  config.integrate do |with|
    # ...
    with.library :view_component
  end
end

At the moment only one matcher exists, use_collection_parameter, which checks that a collection parameter was set for the component through with_collection_parameter. E.g.:

# app/components/product_component.rb
class ProductComponent < ViewComponent::Base
  with_collection_parameter :product

  def initialize(product:, product_counter:, product_iteration:)
    # ...
  end
end

# spec/components/product_component_spec.rb
RSpec.describe ProductComponent, type: :component do
  it do
    expect(described_class).to use_collection_parameter(:product)
      .with_counter   # Optional, checks for product_counter: param
      .with_iteration # Optional, checks for product_iteration: param
  end
end

After checking out the repo, run bin/setup to install dependencies. 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 the created tag, and push the .gem file to rubygems.org.

Bug reports and pull requests are welcome on GitHub at https://github.com/beezwax/shoulda-matchers-viewcomponent.

The gem is available as open source under the terms of the MIT License.