minitest-trailblazer 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f62860b3fe28a0311e4b7e9cdf01d5f5142f9bee4d1b2311f6f971208dc529f
-  data.tar.gz: 06a711d20c62e0e09e79ab76004bcf29492213d12418f0d6f8f9e8651869927f
+  metadata.gz: ec0114a234eb6f716145dc4a1be37a9808ec44fbd16fca0ce19f970f95e168c8
+  data.tar.gz: bed776e88a668b82801858071acc2de0b0a4cc6942b9066b5aa297fd0d3fde64
 SHA512:
-  metadata.gz: bcfb44aae8f51049eb5c18e3fb8f5aba70f1ff0075720be773a58245a80dd5b3b592936132e748534aac1a08554209508d0496f4b11762628eb4a5d72c802732
-  data.tar.gz: cf0fd9d98dca61efb19a1676729e482a13afbceae1d72b375dbbd4d447f085be899bf5883656db72762e2d2bf7491af53e861d694f6afcfe95862f49e7cbcda6
+  metadata.gz: bfefb1090baf10b81ec5c0824d91974845965747362ab5e8251035cbe67b286d409b77df79559f564c99995cbff92f15224895b38c31bbaf78d2c311f9aab2ee
+  data.tar.gz: e2792341127375463b0c4116988b11240d5e1bd173cd76f2a6e65bb65e04a97d0b2f45c1f5b18a5cf8078ef34f98d59f44352c8e130a9bc4121140f83930da96

data/README.md

@@ -1,34 +1,82 @@
 # Minitest::Trailblazer
 
-TODO: Delete this and the text below, and describe your gem
+Minitest base classes and assertion helpers for [Trailblazer](https://trailblazer.to) applications.
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/minitest/trailblazer`. To experiment with that code, run `bin/console` for an interactive prompt.
+Trailblazer's own testing conventions (see [trailblazer-test](https://github.com/trailblazer/trailblazer-test)) write assertions *actual-first* — `assert_equal result[:model].title, "Roxanne"` — while stock Minitest expects *expected-first*. Mixing the two styles in one suite is a reliable source of confusing failure diffs. This gem gives you dedicated base classes to build your operation tests on, and an opt-in override that makes `assert_equal` read actual-first everywhere you choose to use it.
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+Add to your application's Gemfile (usually the `:development, :test` group):
 
-Install the gem and add to the application's Gemfile by executing:
+```ruby
+gem "minitest-trailblazer"
+```
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+Or install directly:
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+```console
+gem install minitest-trailblazer
+```
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+Supports minitest 5.x and 6.x.
 
 ## Usage
 
-TODO: Write usage instructions here
+### Base classes
+
+```ruby
+require "minitest-trailblazer"
+
+class Song::Operation::CreateTest < Minitest::TrailblazerTest
+  def test_valid_input
+    result = Song::Operation::Create.(params: { title: "Roxanne" })
+
+    assert result.success?
+  end
+end
+```
+
+Spec-style is available too:
+
+```ruby
+class Song::Operation::CreateSpec < Minitest::TrailblazerSpec
+  it "persists the model" do
+    result = Song::Operation::Create.(params: { title: "Roxanne" })
+
+    _(result[:model]).must_be :persisted?
+  end
+end
+```
+
+Both classes include `Minitest::Trailblazer::Assertions`, the extension point where Trailblazer-specific assertions land.
+
+### Actual-first `assert_equal`
+
+`Minitest::Trailblazer::AssertionsOverride` flips `assert_equal`'s argument order to `(actual, expected)`:
+
+```ruby
+class Song::Operation::CreateTest < Minitest::TrailblazerTest
+  include Minitest::Trailblazer::AssertionsOverride
+
+  def test_title
+    result = Song::Operation::Create.(params: { title: "Roxanne" })
+
+    assert_equal result[:model].title, "Roxanne" # actual first, Trailblazer-style
+  end
+end
+```
+
+It is deliberately opt-in per test class: include it where your suite follows Trailblazer conventions, leave the rest of your tests untouched.
 
 ## 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.
+After checking out the repo, run `bundle install`, then `bundle exec rake test`.
 
-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).
+Releases are cut by [release-please](https://github.com/googleapis/release-please) from conventional commit messages (`fix:`, `feat:`) on `master`.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/minitest-trailblazer.
+Bug reports and pull requests are welcome at https://github.com/seuros/minitest-trailblazer.
 
 ## License
 

data/lib/minitest/trailblazer/version.rb

@@ -2,6 +2,6 @@
 
 module Minitest
   module Trailblazer
-    VERSION = '0.0.1'
+    VERSION = '0.0.2'
   end
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: minitest-trailblazer
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Abdelkader Boudih
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-10 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -19,7 +18,7 @@ dependencies:
         version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +28,7 @@ dependencies:
         version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7'
 description: Minitest integration for Trailblazer
 email:
 - terminale@gmail.com
@@ -51,7 +50,6 @@ metadata:
   source_code_uri: https://github.com/seuros/minitest-trailblazer
   changelog_uri: https://github.com/seuros/minitest-trailblazer/blob/master/CHANGELOG.md
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -66,8 +64,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
-signing_key:
+rubygems_version: 4.0.10
 specification_version: 4
 summary: Minitest integration for Trailblazer
 test_files: []