trailblazer 1.1.2 → 2.0.0.beta1

data/test/operation/dsl/callback_test.rb

@@ -1,28 +1,26 @@
 require "test_helper"
-require "trailblazer/operation/dispatch"
-
 
 class DslCallbackTest < MiniTest::Spec
   module SongProcess
-    def process(params)
-      contract(OpenStruct.new).validate(params)
-      dispatch!
-    end
-
     def _invocations
-      @_invocations ||= []
+      self["x"] ||= []
     end
 
     def self.included(includer)
+      includer.extend Trailblazer::Operation::Contract::DSL
       includer.contract do
         property :title
       end
+      includer.| Trailblazer::Operation::Model[OpenStruct, :new]
+      includer.| Trailblazer::Operation::Contract::Build[includer["contract.default.class"]]
+      includer.| Trailblazer::Operation::Contract::Validate[]
+      includer.| Trailblazer::Operation::Callback[:default]
     end
   end
 
   describe "inheritance across operations" do
     class Operation < Trailblazer::Operation
-      include Dispatch
+      extend Callback::DSL
       include SongProcess
 
       callback do
@@ -39,21 +37,14 @@ class DslCallbackTest < MiniTest::Spec
         def admin_default!(*); _invocations << :admin_default!; end
         def after_save!(*);    _invocations << :after_save!; end
 
-        def process(*)
-          super
-          dispatch!(:after_save)
-        end
+        self.| Trailblazer::Operation::Callback[:after_save]
       end
 
       def default!(*); _invocations << :default!; end
     end
 
-    it { Operation.({"title"=> "Love-less"})._invocations.must_equal([:default!]) }
-    it { Operation::Admin.({"title"=> "Love-less"})._invocations.must_equal([:default!, :admin_default!, :after_save!]) }
-  end
-
-  describe "Op.callback" do
-    it { Operation.callback(:default).must_equal Operation.callbacks[:default][:group] }
+    it { Operation.({"title"=> "Love-less"})["x"].must_equal([:default!]) }
+    it { Operation::Admin.({"title"=> "Love-less"})["x"].must_equal([:default!, :admin_default!, :after_save!]) }
   end
 
   describe "Op.callback :after_save, AfterSaveCallback" do
@@ -66,17 +57,14 @@ class DslCallbackTest < MiniTest::Spec
     end
 
     class OpWithExternalCallback < Trailblazer::Operation
-      include Dispatch
       include SongProcess
+      extend Callback::DSL
       callback :after_save, AfterSaveCallback
 
-      def process(params)
-        contract(OpenStruct.new).validate(params)
-        dispatch!(:after_save)
-      end
+      self.| Callback[:after_save]
     end
 
-    it { OpWithExternalCallback.("title"=>"Thunder Rising")._invocations.must_equal([:after_save!]) }
+    it { OpWithExternalCallback.("title"=>"Thunder Rising").must_equal([:after_save!]) }
   end
 
   describe "Op.callback :after_save, AfterSaveCallback do .. end" do
@@ -89,13 +77,13 @@ class DslCallbackTest < MiniTest::Spec
     end
 
     class OpUsingCallback < Trailblazer::Operation
-      include Dispatch
+      extend Callback::DSL
       include SongProcess
       callback :default, DefaultCallback
     end
 
     class OpExtendingCallback < Trailblazer::Operation
-      include Dispatch
+      extend Callback::DSL
       include SongProcess
       callback :default, DefaultCallback do
         on_change :after_save!
@@ -111,8 +99,8 @@ class DslCallbackTest < MiniTest::Spec
     end
 
     # this operation copies DefaultCallback and shouldn't run #after_save!.
-    it { OpUsingCallback.(title: "Thunder Rising")._invocations.must_equal([:default!]) }
+    it { OpUsingCallback.(title: "Thunder Rising")["x"].must_equal([:default!]) }
     # this operation copies DefaultCallback, extends it and runs #after_save!.
-    it { OpExtendingCallback.(title: "Thunder Rising")._invocations.must_equal([:extended_default!, :after_save!]) }
+    it { OpExtendingCallback.(title: "Thunder Rising")["x"].must_equal([:extended_default!, :after_save!]) }
   end
-end
+end

data/test/operation/dsl/contract_test.rb

@@ -1,16 +1,165 @@
 require "test_helper"
+require "trailblazer/operation/contract"
+
+# contract Constant # new
+# contract Constant, inherit: true # extend existing
+# contract do end # extend existing || new
+# contract Constant do .. end # new, extend new
 
-# ::contract builds Reform::Form class
 class DslContractTest < MiniTest::Spec
-  module SongProcess
-    def process(params)
-      validate(params, @model = OpenStruct.new)
+  module Call
+    def call(params)
+      validate(params, model: model=OpenStruct.new) { contract.sync }
+      model
+    end
+
+    def self.included(includer)
+      includer.| Trailblazer::Operation::Model( OpenStruct, :new )
+      includer.| Trailblazer::Operation::Contract::Build()
+      includer.| Trailblazer::Operation::Contract::Validate()
+      includer.| Trailblazer::Operation::Persist( save_method: :sync )
+      # includer.> ->(op, *) { op["x"] = [] }
+    end
+  end
+
+  # ---
+  # Operation::["contract.default.class"]
+  # Operation::["contract.default.class"]=
+  class Create < Trailblazer::Operation
+    include Contract
+    self["contract.default.class"] = String
+  end
+
+  # reader method.
+  # no subclassing.
+  it { Create["contract.default.class"].must_equal String }
+
+  class CreateOrFind < Create
+  end
+
+  # no inheritance with setter.
+  it { CreateOrFind["contract.default.class"].must_equal nil }
+
+  # ---
+  # Op::contract Constant
+  class Update < Trailblazer::Operation
+    class IdContract < Reform::Form
+      property :id
+    end
+
+    extend Contract::DSL
+    contract IdContract
+
+    include Call
+  end
+
+  # UT: subclasses contract.
+  it { Update["contract.default.class"].superclass.must_equal Update::IdContract }
+  # IT: only knows `id`.
+  it { Update.(id: 1, title: "Coaster")["model"].inspect.must_equal %{#<OpenStruct id=1>} }
+
+  # Op::contract with inheritance
+  # no ::contract call.
+  class Upgrade < Update
+  end
+
+  # UT: subclasses contract but doesn't share with parent.
+  it { Upgrade["contract.default.class"].superclass.must_equal Update::IdContract }
+  it { Upgrade["contract.default.class"].wont_equal Update["contract.default.class"] }
+  # IT: only knows `id`.
+  it { Upgrade.(id: 1, title: "Coaster")["model"].inspect.must_equal %{#<OpenStruct id=1>} }
+
+  # ::contract B overrides old A contract.
+  # this makes sure when calling contract(Constant), the old class gets wiped and is replaced with the new constant.
+  class Upsert < Update
+    class TitleContract < Reform::Form
+      property :title
+    end
+
+    contract TitleContract
+  end
+
+  # UT: subclasses contract.
+  it { Upsert["contract.default.class"].superclass.must_equal Upsert::TitleContract }
+  # IT: only knows `title`.
+  it { Upsert.(id: 1, title: "Coaster")["model"].inspect.must_equal %{#<OpenStruct title="Coaster">} }
+
+  # ::contract B do ..end overrides and extends new.
+  # using a constant will wipe out the existing class.
+  class Upside < Update
+    contract Upsert::TitleContract do
+      property :id
+    end
+  end
+
+  # UT: subclasses contract.
+  it { Upside["contract.default.class"].superclass.must_equal Upsert::TitleContract }
+  # IT: only knows `title`.
+  it { Upside.(id: 1, title: "Coaster")["model"].inspect.must_equal %{#<OpenStruct title="Coaster", id=1>} }
+
+
+
+  #---
+  # contract do .. end
+  # (with block)
+  class Delete < Trailblazer::Operation
+    include Call
+    extend Contract::DSL
+    contract do
+      property :title
+    end
+  end
+
+  # UT: contract path is "contract.default.class"
+  it { Delete["contract.default.class"].definitions.keys.must_equal ["title"] }
+  # IT: knows `title`.
+  it { Delete.(id: 1, title: "Coaster")["model"].inspect.must_equal %{#<OpenStruct title=\"Coaster\">} }
+
+  class Wipe < Trailblazer::Operation
+    extend Contract::DSL
+
+    self["x"] = contract do end
+  end
+  # UT: ::contract returns form class
+  it { Wipe["x"].superclass.must_equal Reform::Form }
+
+  # subsequent calls merge.
+  class Remove < Trailblazer::Operation
+    extend Contract::DSL
+    include Call
+
+    contract do
+      property :title
+    end
+
+    contract do
+      property :id
+    end
+  end
+
+  # IT: knows `title` and `id`, since contracts get merged.
+  it { Remove.(id: 1, title: "Coaster")["model"].inspect.must_equal %{#<OpenStruct title=\"Coaster\", id=1>} }
+
+
+
+
+
+
+  # Operation::["contract.default.class"]
+  # Operation::["contract.default.class"]=
+  describe %{Operation::["contract.default.class"]} do
+
+    class Update2 < Trailblazer::Operation
+      self["contract.default.class"] = String
     end
+
+    it { Update2["contract.default.class"].must_equal String }
   end
 
   describe "inheritance across operations" do
     # inheritance
     class Operation < Trailblazer::Operation
+      extend Contract::DSL
       contract do
         property :title
         property :band
@@ -22,24 +171,28 @@ class DslContractTest < MiniTest::Spec
           property :band, virtual: true
         end
       end
+
+      class XML < self
+      end
     end
 
     # inherits subclassed Contract.
-    it { Operation.contract_class.wont_equal Operation::JSON.contract_class }
+    it { Operation["contract.default.class"].wont_equal Operation::JSON["contract.default.class"] }
+    it { Operation::XML["contract.default.class"].superclass.must_equal Reform::Form }
 
     it do
-      form = Operation.contract_class.new(OpenStruct.new)
+      form = Operation["contract.default.class"].new(OpenStruct.new)
       form.validate({})#.must_equal true
       form.errors.to_s.must_equal "{}"
 
-      form = Operation::JSON.contract_class.new(OpenStruct.new)
+      form = Operation::JSON["contract.default.class"].new(OpenStruct.new)
       form.validate({})#.must_equal true
       form.errors.to_s.must_equal "{:genre=>[\"can't be blank\"]}"
     end
 
     # allows overriding options
     it do
-      form = Operation::JSON.contract_class.new(song = OpenStruct.new)
+      form = Operation::JSON["contract.default.class"].new(song = OpenStruct.new)
       form.validate({genre: "Punkrock", band: "Osker"}).must_equal true
       form.sync
 
@@ -48,21 +201,18 @@ class DslContractTest < MiniTest::Spec
     end
   end
 
-  describe "Op.contract" do
-    it { Operation.contract.must_equal Operation.contract_class }
-  end
-
   describe "Op.contract CommentForm" do
     class SongForm < Reform::Form
       property :songTitle, validates: {presence: true}
     end
 
     class OpWithExternalContract < Trailblazer::Operation
+      extend Contract::DSL
       contract SongForm
-      include SongProcess
+      include Call
     end
 
-    it { OpWithExternalContract.("songTitle"=> "Monsterparty").contract.songTitle.must_equal "Monsterparty" }
+    it { OpWithExternalContract.("songTitle"=> "Monsterparty")["contract.default"].songTitle.must_equal "Monsterparty" }
   end
 
   describe "Op.contract CommentForm do .. end" do
@@ -71,27 +221,29 @@ class DslContractTest < MiniTest::Spec
     end
 
     class OpNotExtendingContract < Trailblazer::Operation
+      extend Contract::DSL
       contract DifferentSongForm
-      include SongProcess
+      include Call
     end
 
     class OpExtendingContract < Trailblazer::Operation
+      extend Contract::DSL
       contract DifferentSongForm do
         property :genre
       end
-      include SongProcess
+      include Call
     end
 
     # this operation copies DifferentSongForm and shouldn't have `genre`.
     it do
-      contract = OpNotExtendingContract.("songTitle"=>"Monsterparty", "genre"=>"Punk").contract
+      contract = OpNotExtendingContract.("songTitle"=>"Monsterparty", "genre"=>"Punk")["contract.default"]
       contract.songTitle.must_equal "Monsterparty"
       assert_raises(NoMethodError) { contract.genre }
     end
 
     # this operation copies DifferentSongForm and extends it with the property `genre`.
     it do
-      contract = OpExtendingContract.("songTitle"=>"Monsterparty", "genre"=>"Punk").contract
+      contract = OpExtendingContract.("songTitle"=>"Monsterparty", "genre"=>"Punk")["contract.default"]
       contract.songTitle.must_equal "Monsterparty"
       contract.genre.must_equal "Punk"
     end
@@ -101,4 +253,42 @@ class DslContractTest < MiniTest::Spec
       assert_raises(NoMethodError) { DifferentSongForm.new(OpenStruct.new).genre }
     end
   end
-end
+
+  describe "Op.contract :name, Form" do
+    class Follow < Trailblazer::Operation
+      ParamsForm = Class.new
+
+      extend Contract::DSL
+      contract :params, ParamsForm
+    end
+
+    it { Follow["contract.params.class"].superclass.must_equal Follow::ParamsForm }
+  end
+
+  describe "Op.contract :name do..end" do
+    class Unfollow < Trailblazer::Operation
+      extend Contract::DSL
+      contract :params do
+        property :title
+      end
+    end
+
+    it { Unfollow["contract.params.class"].superclass.must_equal Reform::Form }
+  end
+
+  # multiple ::contract calls.
+  describe "multiple ::contract calls" do
+    class Star < Trailblazer::Operation
+      extend Contract::DSL
+      contract do
+        property :title
+      end
+
+      contract do
+        property :id
+      end
+    end
+
+    it { Star["contract.default.class"].definitions.keys.must_equal ["title", "id"]  }
+  end
+end

data/test/operation/dsl/representer_test.rb

@@ -1,15 +1,16 @@
 require "test_helper"
 require "representable/json"
 require "trailblazer/operation/representer"
+require "trailblazer/operation/contract"
 
 class DslRepresenterTest < MiniTest::Spec
   module SongProcess
     def process(params)
-      @model = OpenStruct.new(params)
+      self["model"] = OpenStruct.new(params)
     end
 
     def represented
-      model
+      self["model"]
     end
   end
 
@@ -34,10 +35,6 @@ class DslRepresenterTest < MiniTest::Spec
     it { Operation::JSON.(title: "Nothing To Lose", band: "Gary Moore").to_json.must_equal %{{"title":"Nothing To Lose","band":"Gary Moore"}} }
   end
 
-  describe "Op.representer" do
-    it { Operation.representer.must_equal Operation.representer_class }
-  end
-
   describe "Op.representer CommentRepresenter" do
     class SongRepresenter < Representable::Decorator
       include Representable::JSON
@@ -53,6 +50,32 @@ class DslRepresenterTest < MiniTest::Spec
     it { OpWithExternalRepresenter.("songTitle"=>"Listen To Your Heartbeat").to_json.must_equal %{{"songTitle":"Listen To Your Heartbeat"}} }
   end
 
+  # name for representer
+  describe "1) Op.representer :parse, Representer" do
+    class Op1 < Trailblazer::Operation
+      include Representer
+      representer :parse, String
+    end
+
+    it { Op1["representer.parse.class"].superclass.must_equal String }
+    it { Op1.({})["representer.parse.class"].superclass.must_equal String }
+  end
+
+  # name for default representer
+  describe "2) Op.representer Representer" do
+    class Op2 < Trailblazer::Operation
+      include Representer
+      representer String
+      def call(*); self; end
+    end
+
+    it { Op2["representer.default.class"].superclass.must_equal String }
+    it { Op2.({})["representer.default.class"].superclass.must_equal String }
+    it { Op2.({}, "representer.default.class" => Integer)["representer.default.class"].must_equal Integer }
+  end
+
+
+
   describe "Op.representer CommentRepresenter do .. end" do
     class HitRepresenter < Representable::Decorator
       include Representable::JSON
@@ -90,28 +113,32 @@ class DslRepresenterTest < MiniTest::Spec
   end
 
   describe "Op.representer (inferring)" do
-    class OpWithContract < Trailblazer::Operation
+    class ContractOperation < Trailblazer::Operation
       include Representer
+      include Representer::InferFromContract
       include SongProcess
+      include Contract::Explicit
 
       contract do
         property :songTitle
       end
     end
 
-    class OpWithContract2 < Trailblazer::Operation
+    class ContractOperation2 < Trailblazer::Operation
       include Representer
       include SongProcess
+      include Contract::Explicit
+      include Representer::InferFromContract
+      contract ContractOperation["contract.default.class"]
 
-      contract OpWithContract.contract
       representer do
         property :genre
       end
     end
 
-    it { OpWithContract.("songTitle"=>"Monsterparty", "genre"=>"Punk").to_json.must_equal %{{"songTitle":"Monsterparty"}} }
+    it { ContractOperation.("songTitle"=>"Monsterparty", "genre"=>"Punk").to_json.must_equal %{{"songTitle":"Monsterparty"}} }
     # this representer block extends the inferred from contract.
-    it { OpWithContract2.("songTitle"=>"Monsterparty", "genre"=>"Punk").to_json.must_equal %{{"songTitle":"Monsterparty","genre":"Punk"}} }
+    it { ContractOperation2.("songTitle"=>"Monsterparty", "genre"=>"Punk").to_json.must_equal %{{"songTitle":"Monsterparty","genre":"Punk"}} }
   end
 
   describe "Op.representer_class" do
@@ -123,20 +150,20 @@ class DslRepresenterTest < MiniTest::Spec
     class OpSettingRepresenter < Trailblazer::Operation
       include Representer
       include SongProcess
-      self.representer_class= PlayRepresenter
+      self["representer.default.class"] = PlayRepresenter
     end
 
     class OpExtendRepresenter < Trailblazer::Operation
       include Representer
       include SongProcess
-      self.representer_class= PlayRepresenter
+      self["representer.default.class"] = PlayRepresenter
       representer do
         property :genre
       end
     end
 
     # both operations produce the same as the representer is shared, not copied.
-    it { OpSettingRepresenter.("title"=>"Monsterparty", "genre"=>"Punk").to_json.must_equal %{{"title":"Monsterparty","genre":"Punk"}} }
+    it { skip; OpSettingRepresenter.("title"=>"Monsterparty", "genre"=>"Punk").to_json.must_equal %{{"title":"Monsterparty","genre":"Punk"}} }
     it { OpExtendRepresenter.("title"=>"Monsterparty", "genre"=>"Punk").to_json.must_equal %{{"title":"Monsterparty","genre":"Punk"}} }
   end
-end
+end