shoulda-matchers-viewcomponent 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bb373e08e2294cd568fd64d7fd0cd12b39b40cbd9a906f731d5657512fedfac9
+  data.tar.gz: befd64bdf96be45b81885bf9df77fa666329998ab23c891fb8d90828c3a03b5a
+SHA512:
+  metadata.gz: 63a059031a017c707a3d4e8ae9085927536d000dff85df3dc1ad4890ef4fbb722dd7d38ede128a7fae46b5b384c3b41e53b061aefab122797bc78270d803ad5a
+  data.tar.gz: 3c18e5eb1cbf3ac47a16b236e94665b4683c21e799e9371686d594f7b7b24a42cf4a9b577855b9da12cccab9c60645ff19405458709ff0429871d60aac632407

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-09-12
+
+- Initial release

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in shoulda-matchers-viewcomponent.gemspec
+gemspec
+
+gem "rake", "~> 13.0"

data/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Pedro Carbajal and Beezwax Datatools, Inc.
+
+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.
+Footer

data/README.md

@@ -0,0 +1,82 @@
+# Shoulda Matchers for ViewComponent
+
+[![Gem Version](https://badge.fury.io/rb/shoulda-matchers-viewcomponent.svg?style=flat)](https://rubygems.org/gems/shoulda-matchers-viewcomponent)
+[![CI](https://github.com/beezwax/shoulda-matchers-viewcomponent/actions/workflows/ci.yml/badge.svg)](https://github.com/beezwax/shoulda-matchers-viewcomponent/actions/workflows/ci.yml)
+[![Powered by Beezwax](https://img.shields.io/badge/Powered%20By-Beezwax-gold?logo=data:image/svg+xml;charset=utf-8;base64,PHN2ZyB3aWR0aD0iMTA5IiBoZWlnaHQ9IjEwOSIgdmlld0JveD0iMCAwIDEwOSAxMDkiIGZpbGw9Im5vbmUiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyI+DQogICA8Zz4NCiAgICAgIDxwYXRoIGQ9Ik01MC44IDEwNi42MjVDNTkuMSA5OS4zMjUgNjEuOSA5MS42MjUgNjEuOSA5MS42MjVDNjMuMiA4Ny43MjUgNjQuNyA4NC41MjUgNjQuNyA2OS4zMjVDNjQuNyA0Ni40MjUgNTYuMiAzOC45MjUgNDcgMzIuMDI1QzQwLjggMjcuMzI1IDI0LjkgMjEuMTI1IDE1LjUgMTcuNjI1TDIuMjk5OTggMjUuMTI1QzEuNDk5OTggMjUuNzI1IDAuOTk5OTc2IDI2LjIyNSAwLjU5OTk3NiAyNi44MjVDMjQuNCAzMi4xMjUgNDEuNSA0OC4wMjUgNDEuNSA2Ni44MjVDNDEuNSA3OC4yMjUgMzUuMSA4OC42MjUgMjQuOSA5Ni4xMjVMNDQuNyAxMDcuNTI1QzQ1LjEgMTA3LjcyNSA0NiAxMDguMTI1IDQ3LjMgMTA4LjEyNUM0Ny45IDEwOC4xMjUgNDkgMTA3LjkyNSA1MC4zIDEwNi44MjVMNTAuOCAxMDYuNjI1WiIgZmlsbD0iI0ZGRDkzOSI+PC9wYXRoPg0KICAgICAgPHBhdGggZD0iTTIyLjkgMTMuMzI0OEw0NCAyMC40MjQ4QzY0LjYgMjcuNzI0OCA3My4yIDM3LjgyNDggNzMuMiAzNy44MjQ4Qzg0LjUgNDkuMTI0OCA4My4yIDYxLjYyNDggODMuMiA3Ni44MjQ4QzgzLjIgODAuNjI0OCA4Mi42IDg0LjkyNDggODEuNyA4OS4wMjQ4TDkzIDgyLjYyNDhDOTUuNiA4MS4xMjQ4IDk1LjYgNzcuOTI0OCA5NS42IDc3LjkyNDhWMjkuMzI0OEM5NS42IDI2LjEyNDggOTMgMjQuNjI0OCA5MyAyNC42MjQ4TDcyLjUgMTMuMjI0OEw1MC42IDAuNjI0ODQ1QzQ4LjEgLTAuNjc1MTU1IDQ1LjUgMC40MjQ4NDUgNDUuMyAwLjYyNDg0NUwyMy4xIDEzLjMyNDhIMjIuOVoiIGZpbGw9IiNGRkQ5MzkiPjwvcGF0aD4NCiAgICAgIDxwYXRoIGQ9Ik0wLjEgMzEuNTI0NFY3OC4yMjQ0QzAuMSA4MC44MjQ0IDIuMiA4Mi4zMjQ0IDIuNyA4Mi43MjQ0TDE0LjggODkuNjI0NEwxNy44IDkxLjMyNDRDMjQuNCA4NC43MjQ0IDI4LjQgNzYuMzI0NCAyOC41IDY3LjEyNDRDMjguNSA1MS41MjQ0IDE2LjggMzguMDI0NCAwIDMxLjUyNDRIMC4xWiIgZmlsbD0iI0ZGRDkzOSI+PC9wYXRoPg0KICAgPC9nPg0KPC9zdmc+)](https://beezwax.net/)
+
+Adds convenient
+[ViewComponent](https://github.com/ViewComponent/view_component) matchers to
+[shoulda matchers](https://github.com/thoughtbot/shoulda-matchers).
+
+## Installation
+
+Include `shoulda-matchers-viewcomponent` in your Gemfile:
+
+```ruby
+group :test do
+  # ...
+  gem 'shoulda-matchers-viewcomponent'
+end
+```
+
+And run `bundle`.
+
+Then configure Shoulda to use the ViewComponent matchers:
+
+```ruby
+# 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
+```
+
+## Usage
+
+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.:
+
+```ruby
+# 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
+```
+
+## Development
+
+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](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/beezwax/shoulda-matchers-viewcomponent.
+
+## License
+
+The gem is available as open source under the terms of the
+[MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/lib/shoulda/matchers/integrations/libraries/view_component.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Shoulda
+  module Matchers
+    module Integrations
+      module Libraries
+        class ViewComponent
+          Integrations.register_library(self, :view_component)
+
+          include Integrations::Inclusion
+          include Integrations::Rails
+
+          def integrate_with(test_framework)
+            test_framework.include(matchers_module, type: :component)
+          end
+
+          private
+
+          def matchers_module
+            Shoulda::Matchers::ViewComponent
+          end
+        end
+      end
+    end
+  end
+end

data/lib/shoulda/matchers/view_component/use_collection_parameter.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+module Shoulda
+  module Matchers
+    module ViewComponent
+      # The `use_collection_parameter` matcher tests usage of the
+      # `with_collection_parameter` macro.
+      #
+      #     class ProductComponent < ViewComponent::Base
+      #       with_collection_parameter :product
+      #
+      #       def initialize(product:)
+      #       end
+      #     end
+      #
+      #     # RSpec
+      #     RSpec.describe ProductComponent, type: :component do
+      #       it { expect(described_class).to use_collection_parameter(:product) }
+      #     end
+      #
+      #     # Minitest (Shoulda)
+      #     class ProductComponentTest < ActiveSupport::TestCase
+      #       should use_collection_parameter(:product)
+      #     end
+      #
+      # @return [HaveReadonlyAttributeMatcher]
+      #
+      def use_collection_parameter(value)
+        UseCollectionParameter.new(value)
+      end
+
+      # @private
+      class UseCollectionParameter
+        def initialize(attribute)
+          @attribute = attribute.to_s
+        end
+
+        def matches?(subject)
+          @subject = subject
+
+          collection_parameter_matches? &&
+            has_matching_initialize_parameter? &&
+            requires_counter? && requires_iteration?
+        end
+
+        def description
+          description = "use collection parameter " \
+            ":#{@attribute} with matching #initialize(#{@attribute}:"
+
+          if @with_counter
+            description += ", #{@attribute}_counter:"
+          end
+
+          if @with_iteration
+            description += ", #{@attribute}_iteration:"
+          end
+
+          description += '[, ...]) keyword argument'
+
+          description += 's' if @with_counter || @with_iteration
+
+          description
+        end
+
+        def failure_message
+          "expected #{@subject} to #{description}"
+        end
+
+        def failure_message_when_negated
+          "expected #{@subject} not to #{description}"
+        end
+
+        def with_counter
+          @with_counter = true
+          self
+        end
+
+        def with_iteration
+          @with_iteration = true
+          self
+        end
+
+        private
+
+        def collection_parameter_matches?
+          @subject.collection_parameter.to_s == @attribute
+        end
+
+        def has_matching_initialize_parameter?
+          has_keyword_parameter?(@attribute)
+        end
+
+        def requires_counter?
+          return true unless @with_counter
+          has_keyword_parameter?("#{@attribute}_counter")
+        end
+
+        def requires_iteration?
+          return true unless @with_iteration
+          has_keyword_parameter?("#{@attribute}_iteration")
+        end
+
+        def has_keyword_parameter?(parameter)
+          @subject.instance_method(:initialize).parameters.any? do |(type, name)|
+            type == :keyreq && name.to_s == parameter
+          end
+        end
+      end
+    end
+  end
+end

data/lib/shoulda/matchers/view_component/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Shoulda
+  module Matchers
+    module ViewComponent
+      VERSION = "1.0.0"
+    end
+  end
+end

data/lib/shoulda/matchers/view_component.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'shoulda/matchers/view_component/use_collection_parameter'
+require 'shoulda/matchers/integrations/libraries/view_component'
+
+module Shoulda
+  module Matchers
+    module ViewComponent
+    end
+  end
+end

data/lib/shoulda/matchers/viewcomponent.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "view_component"

data/shoulda-matchers-viewcomponent.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative "lib/shoulda/matchers/view_component/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "shoulda-matchers-viewcomponent"
+  spec.version = Shoulda::Matchers::ViewComponent::VERSION
+  spec.authors = ["Pedro Carbajal"]
+  spec.email = ["pedro_c@beezwax.net"]
+
+  spec.summary = "Shoulda matchers extension for ViewComponent"
+  spec.homepage = "https://github.com/beezwax/shoulda-matchers-viewcomponent"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.license = "MIT"
+
+  #spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "https://github.com/beezwax/shoulda-matchers-viewcomponent/blob/master/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "shoulda-matchers", "~> 4.0"
+
+  spec.add_development_dependency "view_component"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rails"
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: shoulda-matchers-viewcomponent
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Pedro Carbajal
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-09-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: shoulda-matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: view_component
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email:
+- pedro_c@beezwax.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/shoulda/matchers/integrations/libraries/view_component.rb
+- lib/shoulda/matchers/view_component.rb
+- lib/shoulda/matchers/view_component/use_collection_parameter.rb
+- lib/shoulda/matchers/view_component/version.rb
+- lib/shoulda/matchers/viewcomponent.rb
+- shoulda-matchers-viewcomponent.gemspec
+homepage: https://github.com/beezwax/shoulda-matchers-viewcomponent
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/beezwax/shoulda-matchers-viewcomponent
+  source_code_uri: https://github.com/beezwax/shoulda-matchers-viewcomponent
+  changelog_uri: https://github.com/beezwax/shoulda-matchers-viewcomponent/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.3
+signing_key:
+specification_version: 4
+summary: Shoulda matchers extension for ViewComponent
+test_files: []