hanami-rspec 2.1.0.beta1 → 2.1.0.rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 269b1419c457289578dcba75f394d7063c4ae93c508e7cef167c6e539909cda2
-  data.tar.gz: 3878122758804f81133387645f8f3f2e8ec0471793f6ecebce95ee83e1fe5f74
+  metadata.gz: 213e19981cb640eec5aca246cafc481ad481731099a0c58b391fcb41a17300c7
+  data.tar.gz: a67b4291aa541a722e5460bf403aa9f203d770476c3b3a0b823c7cb056f676e0
 SHA512:
-  metadata.gz: a76436f24498e5ac580014a30e509fc6595267392a7425ac470514c0cc04a4cd8b1aeaf1bd7ff1357b791947c0c81a0f5ae10763475a6d9f8b7427a261a21a68
-  data.tar.gz: 39c5b148b7062e6892a31979eeade944e3f88274d8a58a1d5473649581b38eca1228449755b73fb9aed6db69c15a30286941c889d472e4cf5d1ba01cd0d097a7
+  metadata.gz: 4c4d92b324e878aa771f045e592b1e35e6bb80f375dba7b9ac80bab120d29cb1ac06e036006dfe3ab504510b437f6ab99af94aed2d8b949ea0289f4e5bbbf604
+  data.tar.gz: 984fe9016a17887063c2e4e1545cf9b5344fb3faa7ce42cc22516912cdd1753c6f33cb99d72c33f264855df804266f81925c73b5e09b13b3bac64a850fdd1f00

data/CHANGELOG.md

@@ -2,6 +2,27 @@
 
 RSpec support for Hanami
 
+## 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
+
+- [Luca Guidi] Generate spec for `hanami generate part` command
+
+### Changed
+
+- [Luca Guidi] Default request spec to expect 404, now that `hanami new` doesn't generate a default root route anymore
+
 ## v2.1.0.beta1 - 2023-06-29
 
 ## v2.0.1 - 2022-12-25

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.rc"
   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)
@@ -99,6 +116,24 @@ module Hanami
             generator.call(app.namespace, slice, controller, action)
           end
         end
+
+        # @since 2.1.0
+        # @api private
+        class Part < Hanami::CLI::Commands::App::Command
+          # @since 2.1.0
+          # @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]))
+
+            generator = Generators::Part.new(fs: fs, inflector: inflector)
+            generator.call(app.namespace, slice, name)
+          end
+        end
       end
     end
   end

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/part/part_base_spec.erb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+RSpec.describe <%= camelized_app_name %>::Views::Part do
+<%- if ruby_omit_hash_values? -%>
+  subject { described_class.new(value:) }
+<%- else -%>
+  subject { described_class.new(value: value) }
+<%- end -%>
+  let(:value) { double("value") }
+
+  it "works" do
+    expect(subject).to be_kind_of(described_class)
+  end
+end

data/lib/hanami/rspec/generators/part/part_slice_base_spec.erb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+RSpec.describe <%= camelized_slice_name %>::Views::Part do
+<%- if ruby_omit_hash_values? -%>
+  subject { described_class.new(value:) }
+<%- else -%>
+  subject { described_class.new(value: value) }
+<%- end -%>
+  let(:value) { double("value") }
+
+  it "works" do
+    expect(subject).to be_kind_of(described_class)
+  end
+end

data/lib/hanami/rspec/generators/part/part_slice_spec.erb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+RSpec.describe <%= camelized_slice_name %>::Views::Parts::<%= camelized_name %> do
+<%- if ruby_omit_hash_values? -%>
+  subject { described_class.new(value:) }
+<%- else -%>
+  subject { described_class.new(value: value) }
+<%- end -%>
+  let(:value) { double("<%= underscored_name %>") }
+
+  it "works" do
+    expect(subject).to be_kind_of(described_class)
+  end
+end

data/lib/hanami/rspec/generators/part/part_spec.erb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+RSpec.describe <%= camelized_app_name %>::Views::Parts::<%= camelized_name %> do
+<%- if ruby_omit_hash_values? -%>
+  subject { described_class.new(value:) }
+<%- else -%>
+  subject { described_class.new(value: value) }
+<%- end -%>
+  let(:value) { double("<%= underscored_name %>") }
+
+  it "works" do
+    expect(subject).to be_kind_of(described_class)
+  end
+end

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

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+require "erb"
+
+module Hanami
+  module RSpec
+    module Generators
+      # @since 2.1.0
+      # @api private
+      class Part
+        # @since 2.1.0
+        # @api private
+        def initialize(fs:, inflector:)
+          @fs = fs
+          @inflector = inflector
+        end
+
+        # @since 2.1.0
+        # @api private
+        def call(app, slice, name, context: Hanami::CLI::Generators::App::PartContext.new(inflector, app, slice, name))
+          if slice
+            generate_for_slice(slice, context)
+          else
+            generate_for_app(context)
+          end
+        end
+
+        private
+
+        # @since 2.1.0
+        # @api private
+        def generate_for_slice(slice, context)
+          generate_base_part_for_app(context)
+          generate_base_part_for_slice(context, slice)
+
+          fs.write(
+            "spec/slices/#{slice}/views/parts/#{context.underscored_name}_spec.rb",
+            t("part_slice_spec.erb", context)
+          )
+        end
+
+        # @since 2.1.0
+        # @api private
+        def generate_for_app(context)
+          generate_base_part_for_app(context)
+
+          fs.write(
+            "spec/views/parts/#{context.underscored_name}_spec.rb",
+            t("part_spec.erb", context)
+          )
+        end
+
+        # @since 2.1.0
+        # @api private
+        def generate_base_part_for_app(context)
+          path = fs.join("spec", "views", "part_spec.rb")
+          return if fs.exist?(path)
+
+          fs.write(
+            path,
+            t("part_base_spec.erb", context)
+          )
+        end
+
+        # @since 2.1.0
+        # @api private
+        def generate_base_part_for_slice(context, slice)
+          path = "spec/slices/#{slice}/views/part_spec.rb"
+          return if fs.exist?(path)
+
+          fs.write(
+            path,
+            t("part_slice_base_spec.erb", context)
+          )
+        end
+
+        # @since 2.1.0
+        # @api private
+        attr_reader :fs
+
+        # @since 2.1.0
+        # @api private
+        attr_reader :inflector
+
+        # @since 2.1.0
+        # @api private
+        def template(path, context)
+          require "erb"
+
+          ERB.new(
+            File.read(__dir__ + "/part/#{path}"),
+            trim_mode: "-"
+          ).result(context.ctx)
+        end
+
+        # @since 2.1.0
+        # @api private
+        alias_method :t, :template
+      end
+    end
+  end
+end

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

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
 RSpec.describe "Root", type: :request do
-  it "is successful" do
+  it "is not found" do
     get "/"
 
-    # Find me in `config/routes.rb`
-    expect(last_response).to be_successful
-    expect(last_response.body).to eq("Hello from Hanami")
+    # Generate new action via:
+    #   `bundle exec hanami generate action home.index --url=/`
+    expect(last_response.status).to be(404)
   end
 end

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.beta1"
+    VERSION = "2.1.0.rc2"
   end
 end

data/lib/hanami/rspec.rb

@@ -35,6 +35,7 @@ module Hanami
       Hanami::CLI.after "install", Commands::Install
       Hanami::CLI.after "generate slice", Commands::Generate::Slice
       Hanami::CLI.after "generate action", Commands::Generate::Action
+      Hanami::CLI.after "generate part", Commands::Generate::Part
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hanami-rspec
 version: !ruby/object:Gem::Version
-  version: 2.1.0.beta1
+  version: 2.1.0.rc2
 platform: ruby
 authors:
 - Luca Guidi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-06-29 00:00:00.000000000 Z
+date: 2023-11-08 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.rc
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 2.1.rc
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -108,13 +108,20 @@ 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
+- lib/hanami/rspec/generators/part/part_slice_base_spec.erb
+- lib/hanami/rspec/generators/part/part_slice_spec.erb
+- lib/hanami/rspec/generators/part/part_spec.erb
 - lib/hanami/rspec/generators/request.rb
 - lib/hanami/rspec/generators/slice.rb
 - lib/hanami/rspec/generators/slice/action_spec.erb
 - 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
@@ -143,7 +150,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.4.13
+rubygems_version: 3.4.21
 signing_key:
 specification_version: 4
 summary: Hanami RSpec