hanami-rspec 2.1.0.rc1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dbf21d5b7746adf7037bf9028868a3e0e101696f2d2a6b943683ca7e0243b37e
-  data.tar.gz: 8239bea8a08ac6e60aa45681a5979bbe5a72da970c3ac06a125b7cfb1360918a
+  metadata.gz: d3f3869599052cc0752377dec54fffb80cd623976da4875c1b9ec1c9a4a02bbc
+  data.tar.gz: 7a603744efdc55db1777ab5efeb442446d31502fe74318c0e52a48b78df93fc4
 SHA512:
-  metadata.gz: 4a4fe2ff34cdb0599c2352db2d2ff068ee414b199758d1bf2133b4442bf06917e5918cb41b8d3c83fdaa6baa8b9ab9b851235295dbc574bc64fbd0592e3ee7a3
-  data.tar.gz: 955846cdaefbec231159dcdf96d2424a2449afda08bc650b33d68c7d6f5410b16026f1047781bdff3c36646e66e02467cbcaa457e480f4b009d31a254f45cd10
+  metadata.gz: 93af247f8a5835bf2537f4acc9ae5567ac3474b83860b3715af779f79187b509e4278f37af8eaebac505f3a40a9ec6856dc00bed347e09bd3ed347ae00dd9b97
+  data.tar.gz: d6f33d3d885b1bfd20e6e6b97fceef4b41641b28aea234471ff51050d7ff131b00230a8714c065955afcf80e0e09cbafbe618056bbccfd419a24881687b9ef7e

data/.github/workflows/ci.yml

@@ -1,20 +1,20 @@
 name: ci
 
-'on':
+"on":
   push:
     paths:
-      - '.github/workflows/ci.yml'
-      - 'lib/**'
-      - '*.gemspec'
-      - 'spec/**'
-      - 'Rakefile'
-      - 'Gemfile'
-      - '.rubocop.yml'
+      - ".github/workflows/ci.yml"
+      - "lib/**"
+      - "*.gemspec"
+      - "spec/**"
+      - "Rakefile"
+      - "Gemfile"
+      - ".rubocop.yml"
   pull_request:
     branches:
       - main
   schedule:
-    - cron: '30 4 * * *'
+    - cron: "30 4 * * *"
   create:
 
 jobs:
@@ -24,20 +24,21 @@ jobs:
       fail-fast: false
       matrix:
         ruby:
-          - '3.2'
-          - '3.1'
-          - '3.0'
+          - "3.3"
+          - "3.2"
+          - "3.1"
+          - "3.0"
     steps:
       - uses: ravsamhq/notify-slack-action@v1
         if: always()
         with:
           status: ${{ job.status }}
-          notify_when: 'failure'
+          notify_when: "failure"
         env:
           SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
       - uses: actions/checkout@v1
       - name: Install package dependencies
-        run: '[ -e $APT_DEPS ] || sudo apt-get install -y --no-install-recommends $APT_DEPS'
+        run: "[ -e $APT_DEPS ] || sudo apt-get install -y --no-install-recommends $APT_DEPS"
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:

data/CHANGELOG.md

@@ -2,6 +2,21 @@
 
 RSpec support for Hanami
 
+## v2.1.0 - 2024-02-27
+
+## v2.1.0.rc3 - 2024-02-16
+
+## v2.1.0.rc2 - 2023-11-08
+
+### Added
+
+- [Tim Riley] Skip generating tests for `hanami generate` when `--skip-tests` CLI option is given.
+- [Tim Riley] Install Capybara and generate `spec/support/capybara.rb` in `hanami install` hook.
+
+### Changed
+
+- [Tim Riley] Add explanatory code comments to `spec/support/rspec.rb` generated in `hanami install` hook.
+
 ## v2.1.0.rc1 - 2023-11-01
 
 ### Added

data/Gemfile

@@ -4,12 +4,13 @@ source "https://rubygems.org"
 gemspec
 
 unless ENV["CI"]
-  gem "byebug", require: false, platforms: :mri
-  gem "yard",   require: false
+  gem "byebug", platforms: :mri
+  gem "yard"
 end
 
-gem "dry-files", require: false, git: "https://github.com/dry-rb/dry-files.git", branch: "main"
-gem "dry-logger", require: false, git: "https://github.com/dry-rb/dry-logger.git", branch: "main"
-gem "hanami-utils", require: false, git: "https://github.com/hanami/utils.git", branch: "main"
-gem "hanami-cli", require: false, git: "https://github.com/hanami/cli.git", branch: "main"
-gem "hanami", require: false, git: "https://github.com/hanami/hanami.git", branch: "main"
+gem "dry-files", github: "dry-rb/dry-files", branch: "main"
+gem "dry-logger", github: "dry-rb/dry-logger", branch: "main"
+
+gem "hanami-utils", github: "hanami/utils", branch: "main"
+gem "hanami-cli", github: "hanami/cli", branch: "main"
+gem "hanami", github: "hanami/hanami", branch: "main"

data/hanami-rspec.gemspec

@@ -29,7 +29,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "hanami-cli", "~> 2.0"
+  spec.add_dependency "hanami-cli", "~> 2.1"
   spec.add_dependency "rspec", "~> 3.12"
   spec.add_dependency "rake", "~> 13.0"
   spec.add_dependency "zeitwerk", "~> 2.6"

data/lib/hanami/rspec/commands.rb

@@ -14,9 +14,11 @@ module Hanami
         # @api private
         def call(*, **)
           append_gemfile
+          append_gitignore
           copy_dotrspec
           copy_spec_helper
           copy_support_rspec
+          copy_support_features
           copy_support_requests
 
           generate_request_spec
@@ -27,9 +29,14 @@ module Hanami
         def append_gemfile
           fs.append(
             fs.expand_path("Gemfile"),
-            fs.read(
-              fs.expand_path(fs.join("generators", "gemfile"), __dir__)
-            ),
+            fs.read(fs.expand_path(fs.join("generators", "gemfile"), __dir__))
+          )
+        end
+
+        def append_gitignore
+          fs.append(
+            fs.expand_path(".gitignore"),
+            fs.read(fs.expand_path(fs.join("generators", "gitignore"), __dir__))
           )
         end
 
@@ -54,6 +61,13 @@ module Hanami
           )
         end
 
+        def copy_support_features
+          fs.cp(
+            fs.expand_path(fs.join("generators", "support_features.rb"), __dir__),
+            fs.expand_path(fs.join("spec", "support", "features.rb"))
+          )
+        end
+
         def copy_support_requests
           fs.cp(
             fs.expand_path(fs.join("generators", "support_requests.rb"), __dir__),
@@ -91,6 +105,9 @@ module Hanami
           # @api private
           def call(options, **)
             # FIXME: dry-cli kwargs aren't correctly forwarded in Ruby 3
+
+            return if options[:skip_tests]
+
             slice = inflector.underscore(Shellwords.shellescape(options[:slice])) if options[:slice]
             name = inflector.underscore(Shellwords.shellescape(options[:name]))
             *controller, action = name.split(ACTION_SEPARATOR)
@@ -107,6 +124,9 @@ module Hanami
           # @api private
           def call(options, **)
             # FIXME: dry-cli kwargs aren't correctly forwarded in Ruby 3
+
+            return if options[:skip_tests]
+
             slice = inflector.underscore(Shellwords.shellescape(options[:slice])) if options[:slice]
             name = inflector.underscore(Shellwords.shellescape(options[:name]))
 

data/lib/hanami/rspec/generators/gemfile

@@ -1,4 +1,5 @@
 
 group :test do
+  gem "capybara"
   gem "rack-test"
 end

data/lib/hanami/rspec/generators/gitignore

@@ -0,0 +1 @@
+spec/examples.txt

data/lib/hanami/rspec/generators/helper.rb

@@ -7,4 +7,5 @@ ENV["HANAMI_ENV"] ||= "test"
 require "hanami/prepare"
 
 require_relative "support/rspec"
+require_relative "support/features"
 require_relative "support/requests"

data/lib/hanami/rspec/generators/support_features.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require "capybara/rspec"
+
+Capybara.app = Hanami.app

data/lib/hanami/rspec/generators/support_requests.rb

@@ -2,11 +2,12 @@
 
 require "rack/test"
 
-RSpec.shared_context "Hanami app" do
+RSpec.shared_context "Rack::Test" do
+  # Define the app for Rack::Test requests
   let(:app) { Hanami.app }
 end
 
 RSpec.configure do |config|
   config.include Rack::Test::Methods, type: :request
-  config.include_context "Hanami app", type: :request
+  config.include_context "Rack::Test", type: :request
 end

data/lib/hanami/rspec/generators/support_rspec.rb

@@ -1,27 +1,61 @@
 # frozen_string_literal: true
 
 RSpec.configure do |config|
+  # Use the recommended non-monkey patched syntax.
+  config.disable_monkey_patching!
+
+  # Use and configure rspec-expectations.
   config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4.
     expectations.include_chain_clauses_in_custom_matcher_descriptions = true
   end
 
+  # Use and configure rspec-mocks.
   config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on a
+    # real object.
     mocks.verify_partial_doubles = true
   end
 
+  # This option will default to `:apply_to_host_groups` in RSpec 4.
   config.shared_context_metadata_behavior = :apply_to_host_groups
 
+  # Limit a spec run to individual examples or groups you care about by tagging
+  # them with `:focus` metadata. When nothing is tagged with `:focus`, all
+  # examples get run.
+  #
+  # RSpec also provides aliases for `it`, `describe`, and `context` that include
+  # `:focus` metadata: `fit`, `fdescribe` and `fcontext`, respectively.
   config.filter_run_when_matching :focus
 
-  config.disable_monkey_patching!
-  config.warnings = true
+  # Allow RSpec to persist some state between runs in order to support the
+  # `--only-failures` and `--next-failure` CLI options. We recommend you
+  # configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
 
+  # Uncomment this to enable warnings. This is recommended, but in some cases
+  # may be too noisy due to issues in dependencies.
+  # config.warnings = true
+
+  # Show more verbose output when running an individual spec file.
   if config.files_to_run.one?
     config.default_formatter = "doc"
   end
 
+  # Print the 10 slowest examples and example groups at the end of the spec run,
+  # to help surface which specs are running particularly slow.
   config.profile_examples = 10
 
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run:
+  #
+  # --seed 1234
   config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # This allows you to use `--seed` to deterministically reproduce test failures
+  # related to randomization by passing the same `--seed` value as the one that
+  # triggered the failure.
   Kernel.srand config.seed
 end

data/lib/hanami/rspec/version.rb

@@ -6,6 +6,6 @@ module Hanami
     #
     # @since 2.0.0
     # @api public
-    VERSION = "2.1.0.rc1"
+    VERSION = "2.1.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hanami-rspec
 version: !ruby/object:Gem::Version
-  version: 2.1.0.rc1
+  version: 2.1.0
 platform: ruby
 authors:
 - Luca Guidi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-11-01 00:00:00.000000000 Z
+date: 2024-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hanami-cli
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +108,7 @@ files:
 - lib/hanami/rspec/generators/action/action_spec.erb
 - lib/hanami/rspec/generators/dotrspec
 - lib/hanami/rspec/generators/gemfile
+- lib/hanami/rspec/generators/gitignore
 - lib/hanami/rspec/generators/helper.rb
 - lib/hanami/rspec/generators/part.rb
 - lib/hanami/rspec/generators/part/part_base_spec.erb
@@ -120,6 +121,7 @@ files:
 - lib/hanami/rspec/generators/slice/keep.erb
 - lib/hanami/rspec/generators/slice/repository_spec.erb
 - lib/hanami/rspec/generators/slice/view_spec.erb
+- lib/hanami/rspec/generators/support_features.rb
 - lib/hanami/rspec/generators/support_requests.rb
 - lib/hanami/rspec/generators/support_rspec.rb
 - lib/hanami/rspec/rake_tasks.rb
@@ -144,11 +146,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.4.13
+rubygems_version: 3.5.6
 signing_key:
 specification_version: 4
 summary: Hanami RSpec