hanami-rspec 3.0.0 → 3.11.0.beta3

data/lib/hanami/rspec/commands.rb

@@ -1,22 +1,20 @@
 # frozen_string_literal: true
 
+require "hanami/cli"
 require "shellwords"
+require "hanami/cli/commands/app/command"
+require "hanami/cli/generators/context"
+require_relative "./generators"
 
 module Hanami
   module RSpec
-    # @api private
     module Commands
       class Install < Hanami::CLI::Command
         def call(*, **)
           append_gemfile
-          append_gitignore
           copy_dotrspec
           copy_spec_helper
           copy_support_rspec
-          copy_support_db
-          copy_support_features
-          copy_support_operations
-          copy_support_mailers
           copy_support_requests
 
           generate_request_spec
@@ -25,25 +23,18 @@ module Hanami
         private
 
         def append_gemfile
-          gemfile_template = Hanami.bundled?("hanami-db") ? "gemfile_db" : "gemfile"
-
           fs.append(
             fs.expand_path("Gemfile"),
-            fs.read(fs.expand_path(fs.join("generators", gemfile_template), __dir__))
-          )
-        end
-
-        def append_gitignore
-          fs.append(
-            fs.expand_path(".gitignore"),
-            fs.read(fs.expand_path(fs.join("generators", "gitignore"), __dir__))
+            fs.read(
+              fs.expand_path(fs.join("generators", "gemfile"), __dir__)
+            ),
           )
         end
 
         def copy_dotrspec
           fs.cp(
             fs.expand_path(fs.join("generators", "dotrspec"), __dir__),
-            fs.expand_path(fs.join(".rspec"))
+            fs.expand_path(fs.join(".rspec")),
           )
         end
 
@@ -61,43 +52,6 @@ module Hanami
           )
         end
 
-        def copy_support_db
-          return unless Hanami.bundled?("hanami-db")
-
-          fs.cp(
-            fs.expand_path(fs.join("generators/support_db.rb"), __dir__),
-            fs.expand_path(fs.join("spec", "support", "db.rb"))
-          )
-
-          fs.cp(
-            fs.expand_path(fs.join("generators/support_db_cleaning.rb"), __dir__),
-            fs.expand_path(fs.join("spec", "support", "db", "cleaning.rb"))
-          )
-        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_operations
-          fs.cp(
-            fs.expand_path(fs.join("generators", "support_operations.rb"), __dir__),
-            fs.expand_path(fs.join("spec", "support", "operations.rb"))
-          )
-        end
-
-        def copy_support_mailers
-          return unless Hanami.bundled?("hanami-mailer")
-
-          fs.cp(
-            fs.expand_path(fs.join("generators", "support_mailers.rb"), __dir__),
-            fs.expand_path(fs.join("spec", "support", "mailers.rb"))
-          )
-        end
-
         def copy_support_requests
           fs.cp(
             fs.expand_path(fs.join("generators", "support_requests.rb"), __dir__),
@@ -115,8 +69,9 @@ module Hanami
 
       module Generate
         class Slice < Hanami::CLI::Command
-          def call(name: nil, **)
-            slice = inflector.underscore(Shellwords.shellescape(name))
+          # FIXME: dry-cli kwargs aren't correctly forwarded in Ruby 3
+          def call(options, **)
+            slice = inflector.underscore(Shellwords.shellescape(options[:name]))
 
             generator = Generators::Slice.new(fs: fs, inflector: inflector)
             generator.call(slice)
@@ -124,62 +79,23 @@ module Hanami
         end
 
         class Action < Hanami::CLI::Commands::App::Command
-          def call(name: nil, slice: nil, skip_tests: false, **)
-            return if skip_tests
-
-            slice = inflector.underscore(Shellwords.shellescape(slice)) if slice
-            key = inflector.underscore(Shellwords.shellescape(name))
-
-            namespace = slice ? inflector.camelize(slice) : app.namespace
-            base_path = slice ? "spec/slices/#{slice}" : "spec"
-
-            generator = Generators::Action.new(fs:, inflector:)
-            generator.call(key:, namespace:, base_path:)
-          end
-        end
-
-        class Part < Hanami::CLI::Commands::App::Command
-          def call(name: nil, slice: nil, skip_tests: false, **)
-            return if skip_tests
-
-            slice = inflector.underscore(Shellwords.shellescape(slice)) if slice
-            name = inflector.underscore(Shellwords.shellescape(name))
-
-            generator = Generators::Part.new(fs: fs, inflector: inflector)
-            generator.call(app.namespace, slice, name)
-          end
-        end
-
-        class Operation < Hanami::CLI::Commands::App::Command
-          def call(name: nil, slice: nil, skip_tests: false, **)
-            return if skip_tests
-
-            slice = inflector.underscore(Shellwords.shellescape(slice)) if slice
-            key = inflector.underscore(Shellwords.shellescape(name))
-
-            namespace = slice ? inflector.camelize(slice) : app.namespace
-            base_path = slice ? "spec/slices/#{slice}" : "spec"
-
-            generator = Generators::Operation.new(fs:, inflector:)
-            generator.call(key:, namespace:, base_path:)
-          end
-        end
-
-        class Mailer < Hanami::CLI::Commands::App::Command
-          def call(name: nil, slice: nil, skip_tests: false, **)
-            return if skip_tests
-
-            slice = inflector.underscore(Shellwords.shellescape(slice)) if slice
-            key = inflector.underscore(Shellwords.shellescape(name))
-
-            namespace = slice ? inflector.camelize(slice) : app.namespace
-            base_path = slice ? "spec/slices/#{slice}" : "spec"
-
-            generator = Generators::Mailer.new(fs:, inflector:)
-            generator.call(key:, namespace:, base_path:)
+          # FIXME: dry-cli kwargs aren't correctly forwarded in Ruby 3
+          def call(options, **)
+            slice = inflector.underscore(Shellwords.shellescape(options[:slice])) if options[:slice]
+            name = inflector.underscore(Shellwords.shellescape(options[:name]))
+            *controller, action = name.split(ACTION_SEPARATOR)
+
+            generator = Generators::Action.new(fs: fs, inflector: inflector)
+            generator.call(app.namespace, slice, controller, action)
           end
         end
       end
     end
   end
 end
+
+if Hanami::CLI.within_hanami_app?
+  Hanami::CLI.after "install", Hanami::RSpec::Commands::Install
+  Hanami::CLI.after "generate slice", Hanami::RSpec::Commands::Generate::Slice
+  Hanami::CLI.after "generate action", Hanami::RSpec::Commands::Generate::Action
+end

data/lib/hanami/rspec/error.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Hanami
+  module RSpec
+    class Error < StandardError
+    end
+  end
+end

data/lib/hanami/rspec/generators/action/action_slice_spec.erb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+RSpec.describe <%= camelized_slice_name %>::Actions::<%= camelized_controller_name %>::<%= camelized_action_name %> do
+  let(:params) { Hash[] }
+
+  it "works" do
+    response = subject.call(params)
+    expect(response).to be_successful
+  end
+end

data/lib/hanami/rspec/generators/action/action_spec.erb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+RSpec.describe <%= camelized_app_name %>::Actions::<%= camelized_controller_name %>::<%= camelized_action_name %> do
+  let(:params) { Hash[] }
+
+  it "works" do
+    response = subject.call(params)
+    expect(response).to be_successful
+  end
+end

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

@@ -1,59 +1,52 @@
 # frozen_string_literal: true
 
-require "hanami/cli/generators/app/ruby_class_file"
+require "erb"
+require "hanami/cli/generators/app/action_context"
 
 module Hanami
   module RSpec
     module Generators
-      # @since 2.0.0
-      # @api private
       class Action
-        # @since 2.0.0
-        # @api private
         def initialize(fs:, inflector:)
           @fs = fs
           @inflector = inflector
         end
 
-        # @since 2.0.0
-        # @api private
-        def call(key:, namespace:, base_path:)
-          ruby_class_file = action_ruby_class_file(key: key, namespace: namespace, base_path: base_path)
-          spec_file_path = ruby_class_file.path.gsub(/\.rb$/, "_spec.rb")
-          action_class_name = ruby_class_file.fully_qualified_name
-
-          fs.write(spec_file_path, spec_content(action_class_name))
+        def call(app, slice, controller, action, context: Hanami::CLI::Generators::App::ActionContext.new(inflector, app, slice, controller, action)) # rubocop:disable Layout/LineLength
+          if slice
+            fs.write(
+              "spec/#{slice}/actions/#{controller_directory(controller)}/#{action}_spec.rb",
+              t("action_slice_spec.erb", context)
+            )
+          else
+            fs.write(
+              "spec/actions/#{controller_directory(controller)}/#{action}_spec.rb",
+              t("action_spec.erb", context)
+            )
+          end
         end
 
         private
 
-        attr_reader :fs, :inflector
-
-        def action_ruby_class_file(key:, namespace:, base_path:)
-          Hanami::CLI::Generators::App::RubyClassFile.new(
-            fs: fs,
-            inflector: inflector,
-            namespace: namespace,
-            key: inflector.underscore(key),
-            base_path: base_path,
-            extra_namespace: "Actions"
-          )
-        end
+        attr_reader :fs
 
-        def spec_content(class_name)
-          <<~RUBY
-            # frozen_string_literal: true
+        attr_reader :inflector
 
-            RSpec.describe #{class_name} do
-              let(:params) { Hash[] }
+        # @api private
+        # @param controller [Array<String>]
+        def controller_directory(controller)
+          fs.join(controller)
+        end
 
-              it "works" do
-                response = subject.call(params)
-                expect(response).to be_successful
-              end
-            end
-          RUBY
+        def template(path, context)
+          require "erb"
+
+          ERB.new(
+            File.read(__dir__ + "/action/#{path}")
+          ).result(context.ctx)
         end
+
+        alias_method :t, :template
       end
     end
   end

data/lib/hanami/rspec/generators/gemfile

@@ -1,6 +1,4 @@
 
 group :test do
-  # Web integration
-  gem "capybara"
   gem "rack-test"
 end

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

@@ -6,4 +6,5 @@ SPEC_ROOT = Pathname(__dir__).realpath.freeze
 ENV["HANAMI_ENV"] ||= "test"
 require "hanami/prepare"
 
-SPEC_ROOT.glob("support/**/*.rb").each { |f| require f }
+require_relative "support/rspec"
+require_relative "support/requests"

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

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

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

@@ -1,38 +1,28 @@
 # frozen_string_literal: true
 
 require "erb"
+require "hanami/cli/generators/app/slice_context"
 
 module Hanami
   module RSpec
     module Generators
-      # @since 2.0.0
-      # @api private
       class Slice
-        # @since 2.0.0
-        # @api private
         def initialize(fs:, inflector:)
           @fs = fs
           @inflector = inflector
         end
 
-        # @since 2.0.0
-        # @api private
-        def call(slice)
-          context = Struct.new(:slice, :camelized_slice_name).new(
-            slice,
-            inflector.camelize(slice)
-          )
-
-          fs.write("spec/slices/#{slice}/action_spec.rb", t("action_spec.erb", context))
-          # fs.write("spec/slices/#{slice}/view_spec.rb", t("view_spec.erb", context))
-          # fs.write("spec/slices/#{slice}/repository_spec.rb", t("repository_spec.erb", context))
-
-          fs.write("spec/slices/#{slice}/actions/.keep", t("keep.erb", context))
-          # fs.write("spec/slices/#{slice}/views/.keep", t("keep.erb", context))
-          # fs.write("spec/slices/#{slice}/templates/.keep", t("keep.erb", context))
-          # fs.write("spec/slices/#{slice}/templates/layouts/.keep", t("keep.erb", context))
-          # fs.write("spec/slices/#{slice}/entities/.keep", t("keep.erb", context))
-          # fs.write("spec/slices/#{slice}/repositories/.keep", t("keep.erb", context))
+        def call(slice, context: Hanami::CLI::Generators::App::SliceContext.new(inflector, nil, slice, nil))
+          fs.write("spec/#{slice}/action_spec.rb", t("action_spec.erb", context))
+          # fs.write("spec/#{slice}/view_spec.rb", t("view_spec.erb", context))
+          # fs.write("spec/#{slice}/repository_spec.rb", t("repository_spec.erb", context))
+
+          fs.write("spec/#{slice}/actions/.keep", t("keep.erb", context))
+          # fs.write("spec/#{slice}/views/.keep", t("keep.erb", context))
+          # fs.write("spec/#{slice}/templates/.keep", t("keep.erb", context))
+          # fs.write("spec/#{slice}/templates/layouts/.keep", t("keep.erb", context))
+          # fs.write("spec/#{slice}/entities/.keep", t("keep.erb", context))
+          # fs.write("spec/#{slice}/repositories/.keep", t("keep.erb", context))
         end
 
         private
@@ -46,7 +36,7 @@ module Hanami
 
           ERB.new(
             File.read(__dir__ + "/slice/#{path}")
-          ).result(context.instance_eval { binding })
+          ).result(context.ctx)
         end
 
         alias_method :t, :template

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

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

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

@@ -1,61 +1,27 @@
 # 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
 
-  # 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
+  config.disable_monkey_patching!
+  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/generators.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Hanami
+  module RSpec
+    module Generators
+      require_relative "./generators/slice"
+      require_relative "./generators/action"
+    end
+  end
+end

data/lib/hanami/rspec/rake_tasks.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "hanami/cli/rake_tasks"
+
 Hanami::CLI::RakeTasks.register_tasks do
   require "rspec/core/rake_task"
   ::RSpec::Core::RakeTask.new(:spec)

data/lib/hanami/rspec/version.rb

@@ -2,9 +2,6 @@
 
 module Hanami
   module RSpec
-    # The current hanami-rspec version.
-    #
-    # @api public
-    VERSION = "3.0.0"
+    VERSION = "3.11.0.beta3"
   end
 end

data/lib/hanami/rspec.rb

@@ -1,55 +1,10 @@
 # frozen_string_literal: true
 
-require "hanami/cli"
-require "zeitwerk"
-
-# @see Hanami::RSpec
-# @since 2.0.0
 module Hanami
-  # RSpec and testing support for Hanami applications.
-  #
-  # @since 2.0.0
-  # @api private
   module RSpec
-    # @since 2.0.0
-    # @api private
-    def self.gem_loader
-      @gem_loader ||= Zeitwerk::Loader.new.tap do |loader|
-        root = File.expand_path("..", __dir__)
-        loader.tag = "hanami-rspec"
-        loader.inflector = Zeitwerk::GemInflector.new("#{root}/hanami-rspec.rb")
-        loader.push_dir(root)
-        loader.ignore(
-          "#{root}/hanami-rspec.rb",
-          "#{root}/hanami/rspec/{rake_tasks,version}.rb"
-        )
-        loader.inflector.inflect("rspec" => "RSpec")
-      end
-    end
-
-    gem_loader.setup
     require_relative "rspec/version"
+    require_relative "rspec/error"
+    require_relative "rspec/commands"
     require_relative "rspec/rake_tasks"
-
-    if Hanami::CLI.within_hanami_app?
-      Hanami::CLI.before "install", Commands::Install
-      Hanami::CLI.after "generate slice", Commands::Generate::Slice
-
-      if Hanami.bundled?("dry-operation")
-        Hanami::CLI.after "generate operation", Commands::Generate::Operation
-      end
-
-      if Hanami.bundled?("hanami-action")
-        Hanami::CLI.after "generate action", Commands::Generate::Action
-      end
-
-      if Hanami.bundled?("hanami-view")
-        Hanami::CLI.after "generate part", Commands::Generate::Part
-      end
-
-      if Hanami.bundled?("hanami-mailer")
-        Hanami::CLI.after "generate mailer", Commands::Generate::Mailer
-      end
-    end
   end
 end

data/lib/hanami-rspec.rb

@@ -1,3 +1,3 @@
 # frozen_string_literal: true
 
-require_relative "hanami/rspec"
+require_relative "./hanami/rspec"