trailblazer 2.0.0 → 2.0.1

data/test/docs/guard_test.rb

@@ -29,10 +29,10 @@ class DocsGuardProcTest < Minitest::Spec
    #---
   #- Guard inheritance
   class New < Create
-    override Policy::Guard( ->(options) { options["current_user"] } )
+    step Policy::Guard( ->(options) { options["current_user"] } ), override: true
   end
 
-  it { New["pipetree"].inspect.must_equal %{[>>operation.new,&policy.default.eval,&process]} }
+  it { New["pipetree"].inspect.must_equal %{[>operation.new,>policy.default.eval,>process]} }
 end
 
 #---

data/test/docs/macro_test.rb

@@ -0,0 +1,36 @@
+require "test_helper"
+
+class DocsMacroTest < Minitest::Spec
+  #:simple
+  module Macro
+    def self.MyPolicy(allowed_role: "admin")
+      step = ->(input, options) { options["current_user"].type == allowed_role }
+
+      [ step, name: "my_policy.#{allowed_role}" ] # :before, :replace, etc. work, too.
+    end
+  end
+  #:simple end
+
+  #:simple-op
+  class Create < Trailblazer::Operation
+    step Macro::MyPolicy( allowed_role: "manager" )
+    # ..
+  end
+  #:simple-op end
+
+=begin
+  it do
+  #:simple-pipe
+    puts Create["pipetree"].inspect(style: :rows) #=>
+     0 ========================>operation.new
+     1 ====================>my_policy.manager
+  #:simple-pipe end
+  end
+=end
+
+  it { Create["pipetree"].inspect.must_equal %{[>operation.new,>my_policy.manager]} }
+end
+
+# injectable option
+# nested pipe
+# using macros in macros

data/test/docs/model_test.rb

@@ -0,0 +1,52 @@
+require "test_helper"
+
+class DocsModelTest < Minitest::Spec
+  Song = Struct.new(:id, :title) do
+    def self.find_by(id:nil)
+      id.nil? ? nil : new(id)
+    end
+  end
+
+  #:op
+  class Create < Trailblazer::Operation
+    step Model( Song, :new )
+    # ..
+  end
+  #:op end
+
+  it do
+    #:create
+    result = Create.({})
+    result["model"] #=> #<struct Song id=nil, title=nil>
+    #:create end
+
+    result["model"].inspect.must_equal %{#<struct DocsModelTest::Song id=nil, title=nil>}
+  end
+
+  #:update
+  class Update < Trailblazer::Operation
+    step Model( Song, :find_by )
+    # ..
+  end
+  #:update end
+
+  it do
+    #:update-ok
+    result = Update.({ id: 1 })
+    result["model"] #=> #<struct Song id=1, title="Roxanne">
+    #:update-ok end
+
+    result["model"].inspect.must_equal %{#<struct DocsModelTest::Song id=1, title=nil>}
+  end
+
+  it do
+    #:update-fail
+    result = Update.({})
+    result["model"] #=> nil
+    result.success? #=> false
+    #:update-fail end
+
+    result["model"].must_equal nil
+    result.success?.must_equal false
+  end
+end

data/test/docs/nested_test.rb

@@ -73,15 +73,15 @@ class DocsNestedOperationTest < Minitest::Spec
 
   #- shared data
   class B < Trailblazer::Operation
-    self.> ->(options) { options["can.B.see.it?"] = options["this.should.not.be.visible.in.B"] }
-    self.> ->(options) { options["can.B.see.current_user?"] = options["current_user"] }
-    self.> ->(options) { options["can.B.see.A.class.data?"] = options["A.class.data"] }
+    success ->(options) { options["can.B.see.it?"] = options["this.should.not.be.visible.in.B"] }
+    success ->(options) { options["can.B.see.current_user?"] = options["current_user"] }
+    success ->(options) { options["can.B.see.A.class.data?"] = options["A.class.data"] }
   end
 
   class A < Trailblazer::Operation
     self["A.class.data"] = true
 
-    self.> ->(options) { options["this.should.not.be.visible.in.B"] = true }
+    success ->(options) { options["this.should.not.be.visible.in.B"] = true }
     step Nested B
   end
 
@@ -115,3 +115,100 @@ class NestedClassLevelTest < Minitest::Spec
   it { Create.().inspect("x", "y").must_equal %{<Result:true [true, true] >} }
   it { Create.(); Create["class"].must_equal nil }
 end
+
+class NestedWithCallableTest < Minitest::Spec
+  Song = Struct.new(:id, :title)
+
+  class X < Trailblazer::Operation
+    step ->(options) { options["x"] = true }
+  end
+
+  class Y < Trailblazer::Operation
+    step ->(options) { options["y"] = true }
+  end
+
+  class A < Trailblazer::Operation
+    step ->(options) { options["z"] = true }
+    step Nested( ->(options, *) { options["class"] } )
+  end
+
+  it { A.({}, "class" => X).inspect("x", "y", "z").must_equal "<Result:true [true, nil, true] >" }
+  it { A.({}, "class" => Y).inspect("x", "y", "z").must_equal "<Result:true [nil, true, true] >" }
+  # it { Create.({}).inspect("x", "y", "z").must_equal "<Result:true [nil, true, true] >" }
+
+  class Song
+    module Contract
+      class Create < Reform::Form
+        property :title
+      end
+    end
+  end
+
+  User = Struct.new(:is_admin) do
+    def admin?
+      !! is_admin
+    end
+  end
+
+  class Create < Trailblazer::Operation
+    step Nested( ->(options, current_user:nil, **) { current_user.admin? ? Admin : NeedsModeration })
+
+    class NeedsModeration < Trailblazer::Operation
+      step Model( Song, :new )
+      step Contract::Build( constant: Song::Contract::Create )
+      step Contract::Validate()
+      step :notify_moderator!
+
+      def notify_moderator!(options, **)
+        #~noti
+        options["x"] = true
+        #~noti end
+      end
+    end
+
+    class Admin < Trailblazer::Operation # TODO: test if current_user is passed in.
+
+    end
+  end
+
+  let (:admin) { User.new(true) }
+  let (:anonymous) { User.new(false) }
+
+  it { Create.({}, "current_user" => anonymous).inspect("x").must_equal %{<Result:true [true] >} }
+  it { Create.({}, "current_user" => admin)    .inspect("x").must_equal %{<Result:true [nil] >} }
+
+  #:method
+  class Update < Trailblazer::Operation
+    step Nested( :build! )
+
+    def build!(options, current_user:nil, **)
+      current_user.admin? ? Create::Admin : Create::NeedsModeration
+    end
+  end
+  #:method end
+
+  it { Update.({}, "current_user" => anonymous).inspect("x").must_equal %{<Result:true [true] >} }
+  it { Update.({}, "current_user" => admin)    .inspect("x").must_equal %{<Result:true [nil] >} }
+
+  #:callable-builder
+  class MyBuilder
+    extend Uber::Callable
+
+    def self.call(options, current_user:nil, **)
+      current_user.admin? ? Create::Admin : Create::NeedsModeration
+    end
+  end
+  #:callable-builder end
+
+  #:callable
+  class Delete < Trailblazer::Operation
+    step Nested( MyBuilder )
+    # ..
+  end
+  #:callable end
+
+  it { Delete.({}, "current_user" => anonymous).inspect("x").must_equal %{<Result:true [true] >} }
+  it { Delete.({}, "current_user" => admin)    .inspect("x").must_equal %{<Result:true [nil] >} }
+end
+
+# builder: Nested + deviate to left if nil / skip_track if true

data/test/docs/operation_test.rb

@@ -4,6 +4,32 @@ class DocsOperationExampleTest < Minitest::Spec
   Song = Struct.new(:id, :title, :created_by) do
     def save; true; end
   end
+  User = Struct.new(:name)
+
+  #:invocation-dep
+  class Create < Trailblazer::Operation
+    step     Model( Song, :new )
+    step     :assign_current_user!
+    # ..
+    def assign_current_user!(options)
+      options["model"].created_by = options["current_user"]
+    end
+  end
+  #:invocation-dep end
+
+  it do
+    current_user = User.new("Ema")
+  #:invocation-dep-call
+  result = Create.( { title: "Roxanne" }, "current_user" => current_user )
+  #:invocation-dep-call end
+
+  #:invocation-dep-res
+  result["current_user"] #=> #<User name="Ema">
+  result["model"]        #=> #<Song id=nil, title=nil, created_by=#<User name="Ema">>
+  #:invocation-dep-res end
+  end
+
+  it { Create.({ title: "Roxanne" }, "current_user" => Module).inspect("model").must_equal %{<Result:true [#<struct DocsOperationExampleTest::Song id=nil, title=nil, created_by=Module>] >} }
 
   #:op
   class Song::Create < Trailblazer::Operation
@@ -41,7 +67,7 @@ class DndTest < Minitest::Spec
     step     :authorize!
     failure  :auth_err!
     step     :save!
-    self.< Wrap
+    failure Wrap
   end
 end
 
@@ -182,3 +208,201 @@ class DocsOperationAPIExampleTest < Minitest::Spec
   it { Song::Create.({ }).inspect("model").must_equal %{<Result:false [#<struct DocsOperationAPIExampleTest::Song id=nil, title=nil, created_by=nil>] >} }
   it { Song::Create.({ title: "Nothin'" }, "current_user"=>Module).inspect("model").must_equal %{<Result:true [#<struct DocsOperationAPIExampleTest::Song id=nil, title="Nothin'", created_by=Module>] >} }
 end
+
+
+class DocsOperationInheritanceTest < Minitest::Spec
+  Song = Struct.new(:id, :title, :created_by) do
+    def save; true; end
+  end
+
+  class MyContract < Reform::Form
+    property :title
+    validates :title, presence: true
+  end
+
+  #:inh-new
+  class New < Trailblazer::Operation
+    step Model( Song, :new )
+    step Contract::Build( constant: MyContract )
+  end
+  #:inh-new end
+
+  puts New["pipetree"].inspect(style: :row)
+=begin
+  #:inh-new-pipe
+   0 =======================>>operation.new
+   1 ==========================&model.build
+   2 =======================>contract.build
+  #:inh-new-pipe end
+=end
+
+  #:inh-create
+  class Create < New
+    step Contract::Validate()
+    step Contract::Persist()
+  end
+  #:inh-create end
+
+  puts Create["pipetree"].inspect(style: :row)
+=begin
+  #:inh-create-pipe
+   0 =======================>>operation.new
+   1 ==========================&model.build
+   2 =======================>contract.build
+   3 ==============&contract.default.params
+   4 ============&contract.default.validate
+   5 =========================&persist.save
+  #:inh-create-pipe end
+=end
+
+  module MyApp
+  end
+
+  #:override-app
+  module MyApp::Operation
+    class New < Trailblazer::Operation
+      extend Contract::DSL
+
+      contract do
+        property :title
+      end
+
+      step Model( nil, :new )
+      step Contract::Build()
+    end
+  end
+  #:override-app end
+
+  #:override-new
+  class Song::New < MyApp::Operation::New
+    step Model( Song, :new ), override: true
+  end
+  #:override-new end
+
+  puts Song::New["pipetree"].inspect(style: :row)
+=begin
+  #:override-pipe
+  Song::New["pipetree"].inspect(style: :row)
+   0 =======================>>operation.new
+   1 ==========================&model.build
+   2 =======================>contract.build
+  #:override-pipe end
+=end
+
+  it do
+    Song::New["pipetree"].inspect.must_equal %{[>operation.new,>model.build,>contract.build]}
+    Song::New.().inspect("model").must_equal %{<Result:true [#<struct DocsOperationInheritanceTest::Song id=nil, title=nil, created_by=nil>] >}
+  end
+end
+
+class DocsOperationStepOptionsTest < Minitest::Spec
+  Song = Struct.new(:title) do
+    def self.find_by(*)
+      nil
+    end
+  end
+
+  class AutomaticNameTest < Minitest::Spec
+    #:name-auto
+    class New < Trailblazer::Operation
+      step Model( Song, :new )
+    end
+    #:name-auto end
+
+    puts New["pipetree"].inspect(style: :row)
+=begin
+  #:name-auto-pipe
+   0 =======================>>operation.new
+   1 ==========================&model.build
+  #:name-auto-pipe end
+=end
+
+    #:replace-inh
+    class Update < New
+      step Model(Song, :find_by), replace: "model.build"
+    end
+    #:replace-inh end
+
+    puts Update["pipetree"].inspect(style: :row)
+=begin
+  #:replace-inh-pipe
+   0 =======================>>operation.new
+   2 ==========================&model.build
+  #:replace-inh-pipe end
+=end
+
+    it { Update.({}).inspect("model").must_equal %{<Result:false [nil] >} }
+
+
+#     #:delete-inh
+#     class Noop < New
+#       step nil, delete: "model.build"
+#     end
+#     #:delete-inh end
+
+# puts "yo"
+#     puts Update["pipetree"].inspect(style: :row)
+# =begin
+#   #:delete-inh-pipe
+#    0 =======================>>operation.new
+#    2 ==========================&model.build
+#   #:delete-inh-pipe end
+# =end
+
+#     it { Noop.({}).inspect("model").must_equal %{<Result:false [nil] >} }
+  end
+
+  class ManualNameTest < Minitest::Spec
+    #:name-manu
+    class New < Trailblazer::Operation
+      step Model( Song, :new ), name: "build.song.model"
+      step :validate_params!,   name: "my.params.validate"
+      # ..
+    end
+    #:name-manu end
+
+    puts New["pipetree"].inspect(style: :row)
+=begin
+  #:name-manu-pipe
+   0 =======================>>operation.new
+   1 =====================&build.song.model
+   2 ===================&my.params.validate
+  #:name-manu-pipe end
+=end
+  end
+
+  class BeforeTest < Minitest::Spec
+    #:pos-before
+    class New < Trailblazer::Operation
+      step Model( Song, :new )
+      step :validate_params!,   before: "model.build"
+      # ..
+    end
+    #:pos-before end
+
+    puts New["pipetree"].inspect(style: :row)
+=begin
+  #:pos-before-pipe
+   0 =======================>>operation.new
+   1 =====================&validate_params!
+   2 ==========================&model.build
+  #:pos-before-pipe end
+=end
+
+    #:pos-inh
+    class Create < New
+      step :policy!, after: "operation.new"
+    end
+    #:pos-inh end
+
+    puts Create["pipetree"].inspect(style: :row)
+=begin
+  #:pos-inh-pipe
+   0 =======================>>operation.new
+   1 ==============================&policy!
+   2 =====================&validate_params!
+   3 ==========================&model.build
+  #:pos-inh-pipe end
+=end
+  end
+end