hanami-minitest 3.0.0.rc1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ecb2a53d8cbcc2ca342732ce92f727c1512a833b31cbc854e6a72cca74f44dfd
+  data.tar.gz: b84c14c29262f12aee015437ee83a90d69e7380e287a066cb45d1222e3c22e3c
+SHA512:
+  metadata.gz: 4527b3500752a8ab6f6cd6c7b1a2685decfdcdb0af0ab3f6116760c16b01ffa633b4fe38a0638822a7b87a0543208174025ca18b7003f1949d7fb6f2e7ec88a2
+  data.tar.gz: 25e7b28c6ac92c68c28c0098691d406e7cbab10dd5e1667690963f19d3291f069dce698ea4c87d46c7f102e40f06be049e65369f8e9481b51d127f11b6d60b40

data/CHANGELOG.md

@@ -0,0 +1,30 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Break Versioning](https://www.taoensso.com/break-versioning).
+
+## [Unreleased]
+
+### Added
+
+### Changed
+
+### Deprecated
+
+### Removed
+
+### Fixed
+
+### Security
+
+[Unreleased]: https://github.com/hanami/hanami-minitest/compare/v3.0.0.rc1...HEAD
+
+## [3.0.0.rc1] - 2026-06-16
+
+### Added
+
+- Create the gem. (@timriley)
+
+[3.0.0.rc1]: https://github.com/hanami/hanami-minitest/releases/tag/v3.0.0.rc1

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2015-2026 Hanakai team
+
+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.

data/README.md

@@ -0,0 +1,183 @@
+<!--- This file is synced from hanakai-rb/repo-sync -->
+
+[actions]: https://github.com/hanami/hanami-minitest/actions
+[chat]: https://discord.gg/naQApPAsZB
+[forum]: https://discourse.hanamirb.org
+[rubygem]: https://rubygems.org/gems/hanami-minitest
+
+# hanami-minitest [![Gem Version](https://badge.fury.io/rb/hanami-minitest.svg)][rubygem] [![CI Status](https://github.com/hanami/hanami-minitest/workflows/CI/badge.svg)][actions]
+
+[![Forum](https://img.shields.io/badge/Forum-dc360f?logo=discourse&logoColor=white)][forum]
+[![Chat](https://img.shields.io/badge/Chat-717cf8?logo=discord&logoColor=white)][chat]
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+group :cli, :development, :test do
+  gem "hanami-minitest"
+end
+```
+
+And then execute:
+
+```
+$ bundle install
+$ bundle exec hanami setup
+```
+
+## Usage
+
+For detailed examples, see [EXAMPLES.md](EXAMPLES.md).
+
+When you run `hanami setup`, this gem will automatically:
+
+- Add test dependencies to your `Gemfile`
+- Create a `test/test_helper.rb` file
+- Set up support files in `test/support/`
+- Generate an initial request test
+
+### RuboCop
+
+The test support files generated by this gem use compact class notation to re-open existing Hanami::Minitest classes (e.g. `class Hanami::Minitest::Test`). If your RuboCop configuration enables `Style/ClassAndModuleChildren`, you'll need to exclude these files in your root `.rubocop.yml`:
+
+```yaml
+Style/ClassAndModuleChildren:
+  Exclude:
+    - "test/support/**/*"
+```
+
+### Writing Tests
+
+#### Action Tests
+
+Generate an action with its test:
+
+```
+$ bundle exec hanami generate action home.index --url=/
+```
+
+This creates both the action and a corresponding test file.
+
+#### Request Tests
+
+Request tests use Rack::Test to test your application's HTTP interface:
+
+```ruby
+require "test_helper"
+
+class RootTest < RequestTest
+  def test_successful_response
+    get "/"
+    assert_equal 200, last_response.status
+  end
+end
+```
+
+#### Feature Tests
+
+Feature tests use Capybara for browser-based integration testing:
+
+```ruby
+require "test_helper"
+
+class SignUpTest < FeatureTest
+  def test_visit_home_page
+    visit "/"
+    assert_text "Welcome to Hanami"
+  end
+end
+```
+
+#### Part Tests
+
+When generating a view part, a test is automatically created:
+
+```ruby
+require "test_helper"
+
+class MyApp::Views::Parts::UserTest < Minitest::Test
+  def setup
+    @value = Object.new
+    @subject = MyApp::Views::Parts::User.new(value: @value)
+  end
+
+  def test_works
+    assert_kind_of MyApp::Views::Parts::User, @subject
+  end
+end
+```
+
+### Database Cleaning
+
+If you're using `hanami-db`, database cleaning is automatically configured using `database_cleaner-sequel`. 
+
+Feature tests automatically get database cleaning. For other tests that need database access, simply include the `TestSupport::DB` module:
+
+```ruby
+require "test_helper"
+
+class MyDatabaseTest < Minitest::Test
+  include TestSupport::DB  # This test will get database cleaning
+  
+  def test_database_operation
+    # Database is cleaned before and after this test
+  end
+end
+```
+
+By default, tests use database transactions (fast). If you need truncation (e.g., for JavaScript-driven tests), define a `use_truncation?` method:
+
+```ruby
+class DynamicFormTest < FeatureTest
+  def use_truncation?
+    true  # Use truncation instead of transactions
+  end
+  
+  def test_with_javascript
+    # Uses truncation strategy
+  end
+end
+```
+
+### Operations Testing
+
+The gem includes support for testing operations that use `dry-monads`:
+
+```ruby
+require "test_helper"
+
+class MyOperationTest < Minitest::Test
+  def test_successful_operation
+    result = MyOperation.new.call(valid_params)
+    assert result.success?
+  end
+
+  def test_failed_operation
+    result = MyOperation.new.call(invalid_params)
+    assert result.failure?
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. 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/hanami/hanami-minitest. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/hanami/hanami-minitest/blob/main/CODE_OF_CONDUCT.md).
+
+## Links
+
+- [User documentation](https://hanamirb.org)
+- [API documentation](http://rubydoc.info/gems/hanami-minitest)
+
+
+## License
+
+See `LICENSE` file.
+

data/hanami-minitest.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+# This file is synced from hanakai-rb/repo-sync. To update it, edit repo-sync.yml.
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "hanami/minitest/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "hanami-minitest"
+  spec.authors       = ["Hanakai team"]
+  spec.email         = ["info@hanakai.org"]
+  spec.license       = "MIT"
+  spec.version       = Hanami::Minitest::VERSION.dup
+
+  spec.summary       = "Minitest support for Hanami."
+  spec.description   = spec.summary
+  spec.homepage      = "https://hanamirb.org"
+  spec.files         = Dir["CHANGELOG.md", "LICENSE", "README.md", "hanami-minitest.gemspec", "lib/**/*"]
+  spec.bindir        = "exe"
+  spec.executables   = Dir["exe/*"].map { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.extra_rdoc_files = ["README.md", "CHANGELOG.md", "LICENSE"]
+
+  spec.metadata["changelog_uri"]     = "https://github.com/hanami/hanami-minitest/blob/main/CHANGELOG.md"
+  spec.metadata["source_code_uri"]   = "https://github.com/hanami/hanami-minitest"
+  spec.metadata["bug_tracker_uri"]   = "https://github.com/hanami/hanami-minitest/issues"
+  spec.metadata["funding_uri"]       = "https://github.com/sponsors/hanami"
+
+  spec.required_ruby_version = ">= 3.3"
+
+  spec.add_runtime_dependency "minitest", "~> 5.25"
+  spec.add_runtime_dependency "zeitwerk", "~> 2.6"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "yard"
+end
+

data/lib/hanami/minitest/commands.rb

@@ -0,0 +1,167 @@
+# frozen_string_literal: true
+
+require "shellwords"
+
+module Hanami
+  module Minitest
+    # @api private
+    module Commands
+      class Install < Hanami::CLI::Command
+        def call(*, **)
+          append_gemfile
+          append_gitignore
+          copy_test_helper
+          copy_support_minitest
+          copy_support_db
+          copy_support_features
+          copy_support_operations
+          copy_support_requests
+
+          generate_request_test
+        end
+
+        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", "templates", gemfile_template), __dir__))
+          )
+        end
+
+        def append_gitignore
+          fs.append(
+            fs.expand_path(".gitignore"),
+            fs.read(fs.expand_path(fs.join("generators", "templates", "gitignore"), __dir__))
+          )
+        end
+
+        def copy_test_helper
+          fs.cp(
+            fs.expand_path(fs.join("generators", "templates", "helper.rb"), __dir__),
+            fs.expand_path(fs.join("test", "test_helper.rb"))
+          )
+        end
+
+        def copy_support_minitest
+          fs.cp(
+            fs.expand_path(fs.join("generators", "templates", "support_minitest.rb"), __dir__),
+            fs.expand_path(fs.join("test", "support", "minitest.rb"))
+          )
+        end
+
+        def copy_support_db
+          return unless Hanami.bundled?("hanami-db")
+
+          fs.cp(
+            fs.expand_path(fs.join("generators", "templates", "support_db.rb"), __dir__),
+            fs.expand_path(fs.join("test", "support", "db.rb"))
+          )
+
+          fs.cp(
+            fs.expand_path(fs.join("generators", "templates", "support_db_cleaning.rb"), __dir__),
+            fs.expand_path(fs.join("test", "support", "db", "cleaning.rb"))
+          )
+        end
+
+        def copy_support_features
+          fs.cp(
+            fs.expand_path(fs.join("generators", "templates", "support_features.rb"), __dir__),
+            fs.expand_path(fs.join("test", "support", "features.rb"))
+          )
+        end
+
+        def copy_support_operations
+          fs.cp(
+            fs.expand_path(fs.join("generators", "templates", "support_operations.rb"), __dir__),
+            fs.expand_path(fs.join("test", "support", "operations.rb"))
+          )
+        end
+
+        def copy_support_requests
+          fs.cp(
+            fs.expand_path(fs.join("generators", "templates", "support_requests.rb"), __dir__),
+            fs.expand_path(fs.join("test", "support", "requests.rb"))
+          )
+        end
+
+        def generate_request_test
+          fs.cp(
+            fs.expand_path(fs.join("generators", "templates", "request.rb"), __dir__),
+            fs.expand_path(fs.join("test", "requests", "root_test.rb"))
+          )
+        end
+      end
+
+      module Generate
+        class Slice < Hanami::CLI::Command
+          def call(options = nil, name: nil, **)
+            slice = inflector.underscore(Shellwords.shellescape(name))
+
+            generator = Generators::Slice.new(fs: fs, inflector: inflector)
+            generator.call(slice)
+          end
+        end
+
+        class Action < Hanami::CLI::Commands::App::Command
+          def call(options = nil, 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 ? "test/slices/#{slice}" : "test"
+
+            generator = Generators::Action.new(fs:, inflector:)
+            generator.call(key:, namespace:, base_path:)
+          end
+        end
+
+        class Part < Hanami::CLI::Commands::App::Command
+          def call(options = nil, 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(options = nil, 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 ? "test/slices/#{slice}" : "test"
+
+            generator = Generators::Operation.new(fs:, inflector:)
+            generator.call(key:, namespace:, base_path:)
+          end
+        end
+
+        class Mailer < Hanami::CLI::Commands::App::Command
+          def call(options = nil, 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 ? "test/slices/#{slice}" : "test"
+
+            generator = Generators::Mailer.new(fs:, inflector:)
+            generator.call(key:, namespace:, base_path:)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hanami/minitest/feature_test.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "capybara/minitest"
+require_relative "test"
+
+module Hanami
+  module Minitest
+    # Base test class for feature tests in Hanami applications.
+    #
+    # Includes Capybara DSL and assertions for browser-based integration testing.
+    #
+    # @since 2.0.0
+    # @api public
+    class FeatureTest < Test
+      include Capybara::DSL
+      include Capybara::Minitest::Assertions
+
+      Capybara.app = Hanami.app
+
+      # Resets Capybara sessions after each test.
+      #
+      # @since 2.0.0
+      # @api public
+      def teardown
+        super
+        Capybara.reset_sessions!
+        Capybara.use_default_driver
+      end
+    end
+  end
+end

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

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require "hanami/cli/generators/app/ruby_class_file"
+require "hanami/cli/ruby_file_generator"
+
+module Hanami
+  module Minitest
+    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)
+          test_file_path = ruby_class_file.path.gsub(/\.rb$/, "_test.rb")
+          action_class_name = ruby_class_file.fully_qualified_name
+
+          fs.write(test_file_path, test_content(action_class_name))
+        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
+
+        def test_content(class_name)
+          Hanami::CLI::RubyFileGenerator.class(
+            "#{class_name}Test",
+            header: ["# frozen_string_literal: true", "", 'require "test_helper"'],
+            parent_class_name: "Hanami::Minitest::Test",
+            body: [
+              "test \"works\" do",
+              "  params = {}",
+              "  response = #{class_name}.new.call(params)",
+              "  assert_predicate response, :successful?",
+              "end"
+            ]
+          )
+        end
+      end
+    end
+  end
+end

data/lib/hanami/minitest/generators/mailer.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require "hanami/cli/generators/app/ruby_class_file"
+require "hanami/cli/ruby_file_generator"
+
+module Hanami
+  module Minitest
+    module Generators
+      class Mailer
+        def initialize(fs:, inflector:)
+          @fs = fs
+          @inflector = inflector
+        end
+
+        def call(key:, namespace:, base_path:)
+          ruby_class_file = mailer_ruby_class_file(key:, namespace:, base_path:)
+          test_file_path = ruby_class_file.path.gsub(/\.rb$/, "_test.rb")
+          mailer_class_name = ruby_class_file.fully_qualified_name
+
+          fs.write(test_file_path, test_content(mailer_class_name))
+        end
+
+        private
+
+        attr_reader :fs, :inflector
+
+        def mailer_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: "Mailers"
+          )
+        end
+
+        def test_content(class_name)
+          Hanami::CLI::RubyFileGenerator.class(
+            "#{class_name}Test",
+            header: ["# frozen_string_literal: true", "", 'require "test_helper"'],
+            parent_class_name: "Hanami::Minitest::Test",
+            body: <<~RUBY.lines(chomp: true)
+              # Inspect the delivered message to assert on its contents:
+              #
+              # assert_equal ["recipient@example.com"], result.message.to
+              # assert_equal "Welcome", result.message.subject
+
+              test "delivers" do
+                skip "Add assertions for your mailer"
+
+                result = #{class_name}.new.deliver
+
+                assert_predicate result, :success?
+              end
+            RUBY
+          )
+        end
+      end
+    end
+  end
+end

data/lib/hanami/minitest/generators/operation.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require "hanami/cli/generators/app/ruby_class_file"
+require "hanami/cli/ruby_file_generator"
+
+module Hanami
+  module Minitest
+    module Generators
+      class Operation
+        def initialize(fs:, inflector:)
+          @fs = fs
+          @inflector = inflector
+        end
+
+        def call(key:, namespace:, base_path:)
+          ruby_class_file = operation_ruby_class_file(key: key, namespace: namespace, base_path: base_path)
+          test_file_path = ruby_class_file.path.gsub(/\.rb$/, "_test.rb")
+          operation_class_name = ruby_class_file.fully_qualified_name
+
+          fs.write(test_file_path, test_content(operation_class_name))
+        end
+
+        private
+
+        attr_reader :fs, :inflector
+
+        def operation_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
+          )
+        end
+
+        def test_content(class_name)
+          Hanami::CLI::RubyFileGenerator.class(
+            "#{class_name}Test",
+            header: ["# frozen_string_literal: true", "", 'require "test_helper"'],
+            parent_class_name: "Hanami::Minitest::Test",
+            body: <<~RUBY.lines(chomp: true)
+              # Use `Success` and `Failure` (from test/support/operations.rb) to assert on an operation's
+              # wrapped value:
+              #
+              # assert_equal Success(thing), result
+
+              test "succeeds" do
+                skip "Add assertions for your operation"
+
+                result = #{class_name}.new.call
+
+                assert_predicate result, :success?
+              end
+            RUBY
+          )
+        end
+      end
+    end
+  end
+end