trailblazer-test 0.1.1 → 1.0.0

data/lib/trailblazer/test/suite/assert.rb

@@ -0,0 +1,90 @@
+module Trailblazer
+  module Test
+    # Offers the assertions `#assert_pass` and friends but with a configuration "DSL".
+    # That means you can write super short and concise test cases using the defaulting
+    # in this module.
+    module Suite
+      # Provide {Assert.assert_pass} and {Assert.assert_fail} functions which decouple
+      # the assertion logic from the actual test framework.
+      # They are called from the {Suite#assert_pass} helpers.
+      module Assert
+        module_function
+
+        # @semi-public (for rspec-trailblazer).
+        def normalize_for(params_fragment, **kws)
+          kws = normalize_kws(**kws)
+          ctx = ctx_for_params_fragment(params_fragment, **kws)
+
+          return ctx, kws
+        end
+
+        #@public
+        def assert_pass(params_fragment, deep_merge: true, assertion:, expected_attributes_to_merge:, **kws) # TODO: remove kws.
+          ctx, kws = normalize_for(params_fragment, **kws) # compute input, .
+
+          expected_attributes = expected_attributes_for(expected_attributes_to_merge, **kws) # compute "output", expected model attributes.
+
+          activity = kws[:operation]  # FIXME.
+
+          assertion.(activity, ctx, expected_model_attributes: expected_attributes, **kws)
+        end
+
+        def assert_fail(params_fragment, expected_errors, assertion:, **kws)
+          ctx, kws = normalize_for(params_fragment, **kws)
+          activity = kws[:operation]  # FIXME.
+
+          assertion.(activity, ctx, expected_errors, **kws)
+        end
+
+        # @semi-public used in rspec-trailblazer.
+        def ctx_for_params_fragment(params_fragment, key_in_params:, default_ctx:, **)
+          return params_fragment if params_fragment.kind_of?(Trailblazer::Test::Context)
+          # If {:key_in_params} is given, key the {params_fragment} with it, e.g. {params: {transaction: {.. params_fragment ..}}}
+          merge_with_ctx = key_in_params ? {params: {key_in_params => params_fragment}} : {params: params_fragment}
+
+          ctx = Suite.merge_for(default_ctx, merge_with_ctx, true)
+        end
+
+        # @private
+        # Gather all test case configuration. This involves reading all test `let` directives.
+        def normalize_kws(user_block:, test:, operation: test.operation, contract_name: "default", invoke: Assertion.method(:invoke_operation), **options)
+          kws = {
+            operation:            operation,
+            test:                 test,
+            contract_name:        contract_name,
+            user_block:           user_block,
+            invoke: invoke,
+
+            **normalize_kws_for_ctx(test: test, **options),
+            **normalize_kws_for_model_assertion(test: test, **options),
+          }
+
+          return kws
+        end
+
+        # @semi-public used in rspec-trailblazer.
+        # Used when building the incoming {ctx}, e.g. in {#run}.
+        def normalize_kws_for_ctx(test:, key_in_params: test.key_in_params, default_ctx: test.default_ctx, **)
+          {
+            default_ctx:          default_ctx,
+            key_in_params:        key_in_params,
+          }
+        end
+
+        def normalize_kws_for_model_assertion(test:, expected_attributes: test.expected_attributes, model_at: :model, **)
+          {
+            expected_attributes:  expected_attributes,
+            model_at:             model_at,
+          }
+        end
+
+        # FIXME: when {deep_merge: true} the result hash contains subclassed AR classes instead of the original ones.
+        #        when we got this sorted we can allows deep merging here, too.
+        # @semi-public (for rspec-trailblazer).
+        def expected_attributes_for(expected_attributes_to_merge, expected_attributes:, deep_merge: false, **)
+          _expected_attributes = Suite.merge_for(expected_attributes, expected_attributes_to_merge, deep_merge)
+        end
+      end
+    end
+  end
+end

data/lib/trailblazer/test/suite/ctx.rb

@@ -0,0 +1,51 @@
+require "hashie"
+require "trailblazer/test/context"
+
+module Trailblazer
+  module Test
+    module Suite
+      # @private
+      class CtxHash < Hash
+        include Hashie::Extensions::DeepMerge
+      end
+
+      module_function
+      # @private
+      def merge_for(dest, source, deep_merge)
+        return dest.merge(source) unless deep_merge
+
+        CtxHash[dest].deep_merge(CtxHash[source]) # FIXME: this subclasses ActiveRecord classes in dest like {class: ReportSubscription}
+      end
+
+      def Ctx(merge_with_ctx={}, exclude: false, merge: true, **kws)
+        if merge
+          options       = Suite::Assert.normalize_kws_for_ctx(test: self, **kws) # FIXME: why test?
+          key_in_params = options[:key_in_params]
+          default_ctx   = options[:default_ctx]
+
+          # Extract {:params} from {default_ctx}
+          default_params = key_in_params ? default_ctx[:params][key_in_params] : default_ctx[:params]
+
+          # Remove {:exclude} variables from the {params:} part
+          filtered_default_params =
+            if exclude
+              default_params.slice(*(default_params.keys - exclude))
+            else
+              default_params # use original params if no filtering configured.
+            end
+
+          # FIXME: very, very redundant.
+          default_params_for_ctx = key_in_params ? {key_in_params => filtered_default_params} : filtered_default_params
+
+          ctx = default_ctx.merge({params: default_params_for_ctx})
+        else # FIXME: if/else here sucks.
+          ctx = {}
+        end
+
+        ctx = Suite.merge_for(ctx, merge_with_ctx, true) # merge injections
+
+        Trailblazer::Test::Context[ctx] # this signals "pass-through"
+      end
+    end # Suite
+  end
+end

data/lib/trailblazer/test/suite.rb

@@ -0,0 +1,58 @@
+module Trailblazer
+  module Test
+    # Offers the assertions `#assert_pass` and friends but with a configuration "DSL".
+    # That means you can write super short and concise test cases using the defaulting
+    # in this module.
+    module Suite
+      # Defaults so tests run without tweaking (almost).
+      module Spec
+        def self.included(includer)
+          includer.let(:operation)            { raise "Trailblazer::Test: `let(:operation) { ... }` is missing" }
+          includer.let(:key_in_params)        { false }
+          includer.let(:expected_attributes)  { {} } # You need to override this in your tests.
+          includer.let(:default_ctx)          { {} }
+        end
+      end
+
+      # For Minitest::Test, given there are still people using this awkward syntax. :)
+      module Test
+        def operation
+          raise "Trailblazer::Test: `def operation` is missing"
+        end
+
+        def key_in_params
+          false
+        end
+
+        def expected_attributes
+          {}
+        end
+
+        def default_ctx
+          {}
+        end
+      end
+
+      # The assertions and helpers included into the actual test.
+      def assert_pass(params_fragment, expected_attributes_to_merge={}, assertion: Assertion::AssertPass, **kws, &block)
+        Assert.assert_pass(params_fragment, test: self, user_block: block, assertion: assertion, expected_attributes_to_merge: expected_attributes_to_merge, **kws)
+      end
+
+      def assert_fail(params_fragment, expected_errors=nil, assertion: Assertion::AssertFail, **kws, &block)
+        Assert.assert_fail(params_fragment, expected_errors, test: self, user_block: block, assertion: assertion, **kws)
+      end
+
+      def assert_pass?(*args, **kws, &block)
+        assert_pass(*args, **kws, invoke: Assertion.method(:invoke_operation_with_wtf), &block)
+      end
+
+      def assert_fail?(*args, **kws, &block)
+        assert_fail(*args, **kws, invoke: Assertion.method(:invoke_operation_with_wtf), &block)
+      end
+
+      def Ctx(*args, **kws)
+        Assert.Ctx(*args, test: self, **kws)
+      end
+    end # Suite
+  end
+end

data/lib/trailblazer/test/testing.rb

@@ -0,0 +1,62 @@
+require "trailblazer/macro"
+require "trailblazer/macro/contract"
+# require "reform/form/active_model/validations" # FIXME: document!
+require "dry-validation" #  FIXME: bug in reform-rails with Rails 6.1 errors object forces us to use dry-v until it's fixed.
+require "trailblazer/operation"
+
+module Trailblazer::Test
+  # Test components we need in other gems, too.
+  module Testing
+    class Memo < Struct.new(:id, :title, :content, :tag_list, :persisted?, :errors, keyword_init: true)
+      VALID_INPUT = {params: {memo: {title: "TODO", content: "Stock up beer"}}}.freeze
+
+      def save
+        self[:persisted?] = true
+        self[:id] = 1
+      end
+
+      module Operation
+        class Create < Trailblazer::Operation
+          class Form < Reform::Form
+            require "reform/form/dry"
+            include Reform::Form::Dry
+
+            property :title
+            property :content
+            property :tag_list
+
+            validation do
+              params do
+                required(:title).filled
+                required(:content).filled(min_size?: 8)
+                optional(:tag_list).maybe(type?: String)
+              end
+            end
+          end
+
+          step :capture
+          step Model::Build(Memo, :new)
+          step Contract::Build(constant: Form)
+          step Contract::Validate(key: :memo)
+          step :parse_tag_list
+          step Contract::Persist()
+
+          module Capture
+            def capture(ctx, **)
+              ctx[:captured] = CU.inspect(ctx.to_h)
+            end
+          end
+          include Capture
+
+          def parse_tag_list(ctx, **)
+            tag_list = ctx["contract.default"].tag_list or return true
+
+            tags = tag_list.split(",")
+
+            ctx["contract.default"].tag_list = tags
+          end
+        end # Create
+      end
+    end
+  end
+end

data/lib/trailblazer/test/version.rb

@@ -1,5 +1,5 @@
 module Trailblazer
   module Test
-    VERSION = "0.1.1".freeze
+    VERSION = "1.0.0".freeze
   end
 end

data/lib/trailblazer/test.rb

@@ -3,10 +3,19 @@ require "trailblazer/test/version"
 module Trailblazer
   module Test
     # Your code goes here...
+
+    def self.module!(*args, **options, &block)
+      Assertion.module!(*args, **options, &block)
+    end
   end
 end
 
-require "trailblazer/test/assertions"
-require "trailblazer/test/operation/helper"
-require "trailblazer/test/operation/assertions"
-require "trailblazer/test/operation/policy_assertions"
+require "trailblazer/test/assertion/assert_exposes"
+require "trailblazer/test/assertion/assert_pass"
+require "trailblazer/test/assertion/assert_fail"
+require "trailblazer/test/assertion"
+require "trailblazer/test/suite"
+require "trailblazer/test/suite/assert"
+require "trailblazer/test/suite/ctx"
+require "trailblazer/test/helper/mock_step"
+# require "trailblazer/test/operation/policy_assertions"

data/trailblazer-test.gemspec

@@ -23,10 +23,15 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "minitest-line"
   spec.add_development_dependency "rake"
-  spec.add_development_dependency "rubocop"
-  spec.add_development_dependency "simplecov"
 
-  spec.add_dependency "trailblazer-activity", ">= 0.10.0"
-  spec.add_dependency "trailblazer-activity-dsl-linear", ">= 0.2.5"
+  spec.add_development_dependency "trailblazer-operation"
+  spec.add_development_dependency "trailblazer-macro"
+  spec.add_development_dependency "trailblazer-macro-contract"
+  # spec.add_development_dependency "reform-rails"
+  spec.add_development_dependency "dry-validation"
+  spec.add_development_dependency "trailblazer-core-utils", ">= 0.0.5"
+
+  spec.add_dependency "trailblazer-activity-dsl-linear", ">= 1.2.6"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trailblazer-test
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Nick Sutterer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-28 00:00:00.000000000 Z
+date: 2025-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-line
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -67,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: trailblazer-operation
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: trailblazer-macro
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -95,33 +109,61 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: trailblazer-activity
+  name: trailblazer-macro-contract
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.10.0
-  type: :runtime
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dry-validation
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: trailblazer-core-utils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.5
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: 0.0.5
 - !ruby/object:Gem::Dependency
   name: trailblazer-activity-dsl-linear
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.5
+        version: 1.2.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.5
+        version: 1.2.6
 description: Assertions, matchers, and helpers to test Trailblazer code.
 email:
 - apotonick@gmail.com
@@ -129,21 +171,24 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
-- ".rubocop-https---raw-githubusercontent-com-trailblazer-meta-master-rubocop-yml"
-- ".rubocop.yml"
-- ".travis.yml"
 - CHANGES.md
 - Gemfile
 - README.md
 - Rakefile
 - lib/trailblazer/test.rb
-- lib/trailblazer/test/assertions.rb
-- lib/trailblazer/test/deprecation/operation/assertions.rb
-- lib/trailblazer/test/deprecation/operation/helper.rb
-- lib/trailblazer/test/operation/assertions.rb
-- lib/trailblazer/test/operation/helper.rb
-- lib/trailblazer/test/operation/policy_assertions.rb
+- lib/trailblazer/test/assertion.rb
+- lib/trailblazer/test/assertion/assert_exposes.rb
+- lib/trailblazer/test/assertion/assert_fail.rb
+- lib/trailblazer/test/assertion/assert_pass.rb
+- lib/trailblazer/test/context.rb
+- lib/trailblazer/test/endpoint.rb
+- lib/trailblazer/test/helper/mock_step.rb
+- lib/trailblazer/test/suite.rb
+- lib/trailblazer/test/suite/assert.rb
+- lib/trailblazer/test/suite/ctx.rb
+- lib/trailblazer/test/testing.rb
 - lib/trailblazer/test/version.rb
 - trailblazer-test.gemspec
 homepage: http://trailblazer.to
@@ -164,7 +209,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
 summary: Assertions, matchers, and helpers to test Trailblazer code.

data/.rubocop-https---raw-githubusercontent-com-trailblazer-meta-master-rubocop-yml

@@ -1,115 +0,0 @@
-AllCops:
-  TargetRubyVersion: 2.5.0
-  DisplayCopNames: true
-Layout/CaseIndentation:
-  IndentOneStep: true
-Layout/FirstArrayElementLineBreak:
-  Enabled: true
-Layout/FirstHashElementLineBreak:
-  Enabled: true
-Layout/FirstMethodArgumentLineBreak:
-  Enabled: true
-Layout/FirstMethodParameterLineBreak:
-  Enabled: true
-Layout/MultilineAssignmentLayout:
-  Enabled: true
-  EnforcedStyle: same_line
-Layout/SpaceInsideHashLiteralBraces:
-  EnforcedStyle: no_space
-Metrics/LineLength:
-  Max: 130
-Metrics/ParameterLists:
-  Max: 5
-Naming/VariableNumber:
-  EnforcedStyle: snake_case
-Style/AndOr:
-  EnforcedStyle: conditionals
-Style/AutoResourceCleanup:
-  Enabled: true
-Style/CollectionMethods:
-  Enabled: true
-Style/Documentation:
-  Enabled: false
-Style/EmptyLiteral:
-  Enabled: false
-Style/EmptyMethod:
-  EnforcedStyle: expanded
-Style/FormatStringToken:
-  EnforcedStyle: template
-Style/ImplicitRuntimeError:
-  Enabled: true
-Style/MethodCalledOnDoEndBlock:
-  Enabled: true
-Style/MethodDefParentheses:
-  EnforcedStyle: require_parentheses
-Style/MissingElse:
-  Enabled: true
-  EnforcedStyle: case
-Style/NumericLiterals:
-  Enabled: false
-Style/OptionHash:
-  Enabled: true
-Style/PercentLiteralDelimiters:
-  PreferredDelimiters:
-    "%w": "[]"
-    "%W": "[]"
-    "%i": "[]"
-    "%I": "[]"
-    "%r": "()"
-Style/ReturnNil:
-  Enabled: true
-Style/SafeNavigation:
-  Enabled: false
-Style/Send:
-  Enabled: true
-Style/SignalException:
-  EnforcedStyle: semantic
-Style/StringLiterals:
-  EnforcedStyle: double_quotes
-Style/StringLiteralsInInterpolation:
-  EnforcedStyle: double_quotes
-Style/StringMethods:
-  Enabled: true
-Style/SymbolArray:
-  Enabled: true
-# this allows in rspec to have expect { } with multiple lines
-Style/BlockDelimiters:
-  EnforcedStyle: braces_for_chaining
-Layout/EndOfLine:
-  Enabled: false
-# don't need these checks in test folders
-Metrics/ModuleLength:
-  Exclude:
-    - "spec/**/*"
-    - "test/**/*"
-Metrics/BlockLength:
-  Exclude:
-    - "spec/**/*"
-    - "test/**/*"
-    - "*.gemspec" # definitely not in the gemspec
-Metrics/MethodLength:
-  Max: 20
-Lint/UnreachableCode:
-  Description: 'Unreachable code.'
-  Enabled: false
-Lint/Void:
-  Enabled: false
-Layout/AlignHash:
-  EnforcedLastArgumentHashStyle: ignore_implicit
-Metrics/AbcSize:
-  Max: 25
-Style/LambdaCall:
-  Enabled: false
-Style/Semicolon:
-  Enabled: false
-Naming/UncommunicativeMethodParamName:
-  Enabled: false
-Style/ClassAndModuleChildren:
-  Enabled: false
-Layout/LeadingCommentSpace:
-  Exclude:
-    - 'test/docs/**/*'
-Layout/AlignHash:
-  EnforcedHashRocketStyle: table
-Style/FrozenStringLiteralComment:
-  Enabled: false

data/.rubocop.yml

@@ -1,17 +0,0 @@
-inherit_from:
-  - https://raw.githubusercontent.com/trailblazer/meta/master/rubocop.yml
-
-Style/SignalException:
-  Exclude:
-    - lib/trailblazer/test/operation/assertions.rb
-    - lib/trailblazer/test/operation/helper.rb
-    - lib/trailblazer/test/deprecation/operation/helper.rb
-
-Metrics/ParameterLists:
-  Exclude:
-    - lib/trailblazer/test/operation/assertions.rb
-
-Metrics/LineLength:
-  Exclude:
-    - lib/trailblazer/test/operation/assertions.rb
-

data/.travis.yml

@@ -1,14 +0,0 @@
-language: ruby
-cache: bundler
-matrix:
-  include:
-    - rvm: 2.1
-      gemfile: Gemfile
-    - rvm: 2.2
-      gemfile: Gemfile
-    - rvm: 2.3.1
-      gemfile: Gemfile
-    - rvm: 2.4.1
-      gemfile: Gemfile
-    - rvm: 2.5.0
-      gemfile: Gemfile

data/lib/trailblazer/test/assertions.rb

@@ -1,37 +0,0 @@
-# module MiniTest::Assertions
-module Trailblazer
-  module Test
-    # Evaluate value if it's a lambda, and let the caller know whether we need an
-    # assert_equal or an assert.
-    def self.expected(asserted, value, actual)
-      value.is_a?(Proc) ? [value.(actual: actual, asserted: asserted), false] : [value, true]
-    end
-
-    # Read the actual value from the asserted object (e.g. a model).
-    def self.actual(asserted, reader, name)
-      reader ? asserted.public_send(reader, name) : asserted.public_send(name)
-    end
-
-    module Assertions
-      module_function
-
-      # tuples = defaults.merge(overrides) # FIXME: merge with above!
-
-      # Test if all `tuples` values on `asserted` match the expected values.
-      # @param asserted Object Object that exposes attributes to test
-      # @param tuples Hash Key/value attribute pairs to test
-      # @param options Hash Default :reader is `asserted.{name}`,
-      # TODO: test err msgs!
-      def assert_exposes(asserted, tuples, reader: nil)
-        tuples.each do |k, v|
-          actual          = Test.actual(asserted, reader, k)
-          expected, is_eq = Test.expected(asserted, v, actual)
-
-          is_eq ? assert_equal(expected, actual, "Property [#{k}] mismatch") : assert(expected, "Actual: #{actual.inspect}.")
-        end
-      end
-    end
-  end
-end
-# Trailblazer::Operation::Result.infect_an_assertion :assert_result_matches, :must_match, :do_not_flip
-# Object.infect_an_assertion :assert_exposes, :must_expose, :do_not_flip