trailblazer 2.0.7 → 2.1.0.beta1

data/test/operation/model_test.rb

@@ -9,21 +9,24 @@ class ModelTest < Minitest::Spec
   #---
   # use Model semantics, no customizations.
   class Create < Trailblazer::Operation
-    step Model Song, :new
+    step Model( Song, :new )
   end
 
   # :new new.
-  it { Create.({})["model"].inspect.must_equal %{#<struct ModelTest::Song id=nil>} }
+  it { Create.(params: {})[:model].inspect.must_equal %{#<struct ModelTest::Song id=nil>} }
 
   class Update < Create
     step Model( Song, :find ), override: true
   end
 
+  #---
+  #- inheritance
+
   # :find it
-  it { Update.({ id: 1 })["model"].inspect.must_equal %{#<struct ModelTest::Song id=1>} }
+  it { Update.(params: { id: 1 })[:model].inspect.must_equal %{#<struct ModelTest::Song id=1>} }
 
-  #- inheritance
-  it { Update["pipetree"].inspect.must_equal %{[>operation.new,>model.build]} }
+  # inherited inspect is ok
+  it { Trailblazer::Operation::Inspect.(Update).must_equal %{[>model.build]} }
 
   #---
   # :find_by, exceptionless.
@@ -31,30 +34,21 @@ class ModelTest < Minitest::Spec
     step Model Song, :find_by
     step :process
 
-    def process(*); self["x"] = true end
+    def process(options, **); options["x"] = true end
   end
 
   # can't find model.
   #- result object, model
   it do
-    Find.(id: nil)["result.model"].failure?.must_equal true
-    Find.(id: nil)["x"].must_equal nil
-    Find.(id: nil).failure?.must_equal true
+    Find.(params: {id: nil})["result.model"].failure?.must_equal true
+    Find.(params: {id: nil})["x"].must_be_nil
+    Find.(params: {id: nil}).failure?.must_equal true
   end
 
   #- result object, model
   it do
-    Find.(id: 9)["result.model"].success?.must_equal true
-    Find.(id: 9)["x"].must_equal true
-    Find.(id: 9)["model"].inspect.must_equal %{#<struct ModelTest::Song id=9>}
+    Find.(params: {id: 9})["result.model"].success?.must_equal true
+    Find.(params: {id: 9})["x"].must_equal true
+    Find.(params: {id: 9})[:model].inspect.must_equal %{#<struct ModelTest::Song id=9>}
   end
-
-  # #---
-  # # creating the model before operation instantiation (ex Model::External)
-  # class Show < Create
-  #   extend Model::BuildMethods # FIXME: how do we communicate that and prevent the include from Model[] ?
-  #   step Model( Song, :update ), before: "operation.new"
-  # end
-
-  # it { Show.({id: 1})["model"].inspect.must_equal %{#<struct ModelTest::Song id=1>} }
 end

data/test/operation/persist_test.rb

@@ -6,26 +6,33 @@ class PersistTest < Minitest::Spec
   end
 
   class Create < Trailblazer::Operation
-    extend Contract::DSL
-    contract do
+    class Form < Reform::Form
       property :title
     end
 
+    class Fail1
+      def self.call(options, **); options["1. fail"] = "Validate" end
+    end
+
+    class Fail2
+      def self.call(options, **); options["2. fail"] = "Persist" end
+    end
+
     step Model( Song, :new )
-    step Contract::Build()
+    step Contract::Build( constant: Form )
     step Contract::Validate()
-    failure ->(options) { options["1. fail"] = "Validate" }
+    fail Fail1
     step Contract::Persist()
-    failure ->(options) { options["2. fail"] = "Persist" }
+    fail Fail2
   end
 
-  it { Create.(title: "In Recital")["model"].title.must_equal "In Recital" }
-  it { Create.(title: "In Recital")["model"].saved.must_equal true }
+  it { Create.(params: {title: "In Recital"})[:model].title.must_equal "In Recital" }
+  it { Create.(params: {title: "In Recital"})[:model].saved.must_equal true }
   # failure
   it do
-    result = Create.(title: "Fail!")
-    result["model"].saved.must_equal nil
-    result["model"].title.must_equal "Fail!"
+    result = Create.(params: {title: "Fail!"})
+    result[:model].saved.must_be_nil
+    result[:model].title.must_equal "Fail!"
     result["2. fail"].must_equal "Persist"
     result.success?.must_equal false
   end
@@ -35,7 +42,7 @@ class PersistTest < Minitest::Spec
   class Update < Create
   end
 
-  it { Update["pipetree"].inspect.must_equal %{[>operation.new,>model.build,>contract.build,>contract.default.validate,<persist_test.rb:17,>persist.save,<persist_test.rb:19]} }
+  it { Operation::Inspect.( Update ).must_equal %{[>model.build,>contract.build,>contract.default.validate,<<PersistTest::Create::Fail1,>persist.save,<<PersistTest::Create::Fail2]} }
 
   #---
   it do

data/test/operation/pundit_test.rb

@@ -20,31 +20,31 @@ class PolicyTest < Minitest::Spec
     step Policy::Pundit( Auth, :only_user? )
     step :process
 
-    def process(*)
-      self["process"] = true
+    def process(options, **)
+      options["process"] = true
     end
   end
 
   # successful.
   it do
-    result = Create.({}, "current_user" => Module)
+    result = Create.(params: {}, current_user: Module)
     result["process"].must_equal true
     #- result object, policy
     result["result.policy.default"].success?.must_equal true
-    result["result.policy.default"]["message"].must_equal nil
-    # result[:valid].must_equal nil
+    result["result.policy.default"]["message"].must_be_nil
+    # result[:valid].must_be_nil
     result["policy.default"].inspect.must_equal %{<Auth: user:Module, model:nil>}
   end
   # breach.
   it do
-    result = Create.({}, "current_user" => nil)
-    result["process"].must_equal nil
+    result = Create.(params: {}, current_user: nil)
+    result["process"].must_be_nil
     #- result object, policy
     result["result.policy.default"].success?.must_equal false
     result["result.policy.default"]["message"].must_equal "Breach"
   end
-  # inject different policy.Condition  it { Create.({}, "current_user" => Object, "policy.default.eval" => Trailblazer::Operation::Policy::Pundit::Condition.new(Auth, :user_object?))["process"].must_equal true }
-  it { Create.({}, "current_user" => Module, "policy.default.eval" => Trailblazer::Operation::Policy::Pundit::Condition.new(Auth, :user_object?))["process"].must_equal nil }
+  # inject different policy.Condition  it { Create.(params: {}, current_user: Object, "policy.default.eval" => Trailblazer::Operation::Policy::Pundit::Condition.new(Auth, :user_object?))["process"].must_equal true }
+  it { Create.(params: {}, current_user: Module, "policy.default.eval" => Trailblazer::Operation::Policy::Pundit::Condition.new(Auth, :user_object?))["process"].must_be_nil }
 
 
   #---
@@ -53,22 +53,22 @@ class PolicyTest < Minitest::Spec
     step Model( Song, :new ), before: "policy.default.eval"
   end
 
-  it { Show["pipetree"].inspect.must_equal %{[>operation.new,>model.build,>policy.default.eval,>process]} }
+  it { Trailblazer::Operation::Inspect.(Show).must_equal %{[>model.build,>policy.default.eval,>process]} }
 
   # invalid because user AND model.
   it do
-    result = Show.({}, "current_user" => Module)
-    result["process"].must_equal nil
-    result["model"].inspect.must_equal %{#<struct PolicyTest::Song id=nil>}
+    result = Show.(params: {}, current_user: Module)
+    result["process"].must_be_nil
+    result[:model].inspect.must_equal %{#<struct PolicyTest::Song id=nil>}
     # result["policy"].inspect.must_equal %{#<struct PolicyTest::Song id=nil>}
   end
 
   # valid because new policy.
   it do
     # puts Show["pipetree"].inspect
-    result = Show.({}, "current_user" => Module, "policy.default.eval" => Trailblazer::Operation::Policy::Pundit::Condition.new(Auth, :user_and_model?))
+    result = Show.(params: {}, current_user: Module, "policy.default.eval" => Trailblazer::Operation::Policy::Pundit::Condition.new(Auth, :user_and_model?))
     result["process"].must_equal true
-    result["model"].inspect.must_equal %{#<struct PolicyTest::Song id=nil>}
+    result[:model].inspect.must_equal %{#<struct PolicyTest::Song id=nil>}
     result["policy.default"].inspect.must_equal %{<Auth: user:Module, model:#<struct PolicyTest::Song id=nil>>}
   end
 
@@ -79,25 +79,27 @@ class PolicyTest < Minitest::Spec
     step Policy::Pundit( Auth, :user_and_model? )
     step :process
 
-    def process(*); self["process"] = true end
+    def process(options, **)
+      options["process"] = true
+    end
   end
 
   # successful.
   it do
-    result = Edit.({ id: 1 }, "current_user" => Module)
+    result = Edit.(params: { id: 1 }, current_user: Module)
     result["process"].must_equal true
-    result["model"].inspect.must_equal %{#<struct PolicyTest::Song id=1>}
+    result[:model].inspect.must_equal %{#<struct PolicyTest::Song id=1>}
     result["result.policy.default"].success?.must_equal true
-    result["result.policy.default"]["message"].must_equal nil
-    # result[:valid].must_equal nil
+    result["result.policy.default"]["message"].must_be_nil
+    # result[:valid].must_be_nil
     result["policy.default"].inspect.must_equal %{<Auth: user:Module, model:#<struct PolicyTest::Song id=1>>}
   end
 
   # breach.
   it do
-    result = Edit.({ id: 4 }, "current_user" => nil)
-    result["model"].inspect.must_equal %{#<struct PolicyTest::Song id=4>}
-    result["process"].must_equal nil
+    result = Edit.(params: { id: 4 }, current_user: nil)
+    result[:model].inspect.must_equal %{#<struct PolicyTest::Song id=4>}
+    result["process"].must_be_nil
     result["result.policy.default"].success?.must_equal false
     result["result.policy.default"]["message"].must_equal "Breach"
   end

data/test/operation/representer_test.rb

@@ -1,254 +1,254 @@
-require "test_helper"
-require "representable/json"
-
-class RepresenterTest < MiniTest::Spec
-  Album  = Struct.new(:title, :artist)
-  Artist = Struct.new(:name)
-
-  class Create < Trailblazer::Operation
-    include Contract::Explicit
-    include Representer
-    include Representer::InferFromContract
-    attr_reader :model # FIXME: all we want is #model.
-
-    contract do
-      property :title
-      validates :title, presence: true
-      property :artist, populate_if_empty: Artist do
-        property :name
-        validates :name, presence: true
-      end
-    end
-
-    def call(params)
-      self["model"] = Album.new # NO artist!!!
-      validate(params[:album], model: self["model"])
-      self
-    end
-  end
-
-
-  # Infers representer from contract, no customization.
-  class Show < Create
-    def call(params)
-      self["model"] = Album.new("After The War", Artist.new("Gary Moore"))
-      self
-    end
-  end
-
-
-  # Infers representer, adds hypermedia.
-  require "roar/json/hal"
-  class HypermediaCreate < Create
-    representer do
-      include Roar::JSON::HAL
-
-      link(:self) { "//album/#{represented.title}" }
-    end
-  end
-
-  class HypermediaShow < HypermediaCreate
-    def call(params)
-      self["model"] = Album.new("After The War", Artist.new("Gary Moore"))
-      self
-    end
-  end
-
-
-  # rendering
-  # generic contract -> representer
-  it { Show.().to_json.must_equal %{{"title":"After The War","artist":{"name":"Gary Moore"}}} }
-
-  # contract -> representer with hypermedia
-  it do
-    HypermediaShow.().to_json.must_equal %{{"title":"After The War","artist":{"name":"Gary Moore"},"_links":{"self":{"href":"//album/After The War"}}}}
-  end
-
-
-  # parsing
-  it do
-    op = Create.(album: %{{"title":"Run For Cover","artist":{"name":"Gary Moore"}}})
-    op.contract.title.must_equal "Run For Cover"
-    op.contract.artist.name.must_equal "Gary Moore"
-  end
-
-  it do
-    op = HypermediaCreate.(album: %{{"title":"After The War","artist":{"name":"Gary Moore"},"_links":{"self":{"href":"//album/After The War"}}}})
-    op.contract.title.must_equal "After The War"
-    op.contract.artist.name.must_equal "Gary Moore"
-  end
-
-
-
-
-
-  # explicit representer set with ::representer_class=.
-  require "roar/decorator"
-  class JsonApiCreate < Trailblazer::Operation
-    include Contract::Explicit
-    include Representer
-    attr_reader :model
-
-    contract do # we still need contract as the representer writes to the contract twin.
-      property :title
-    end
-
-    class AlbumRepresenter < Roar::Decorator
-      include Roar::JSON
-      property :title
-    end
-
-    # FIXME: this won't inherit, of course.
-    # self["representer.class"] = AlbumRepresenter
-    representer AlbumRepresenter
-
-    def call(params)
-      self["model"] = Album.new # NO artist!!!
-      validate(params[:album], model: self["model"])
-      self
-    end
-  end
-
-  class JsonApiShow < JsonApiCreate
-    def call(params)
-      self["model"] = Album.new("After The War", Artist.new("Gary Moore"))
-      self
-    end
-  end
-
-  # render.
-  it do
-    JsonApiShow.().to_json.must_equal %{{"title":"After The War"}}
-  end
-
-  # parse.
-  it do
-    JsonApiCreate.(album: %{{"title":"Run For Cover"}}).contract.title.must_equal "Run For Cover"
-  end
-end
-
-class InternalRepresenterAPITest < MiniTest::Spec
-  Song = Struct.new(:id)
-
-  describe "#represented" do
-    class Show < Trailblazer::Operation
-      include Contract::Explicit
-      include Representer, Model
-      model Song, :create
-
-      representer do
-        property :class
-      end
-
-      def call(*)
-        self
-      end
-
-      def model # FIXME.
-        self["model"]
-      end
-    end
-
-    it "uses #model as represented, per default" do
-      Show.({}).to_json.must_equal '{"class":"InternalRepresenterAPITest::Song"}'
-    end
-
-    class ShowContract < Show
-      def represented
-        "Object"
-      end
-    end
-
-    it "can be overriden to use the contract" do
-      ShowContract.({}).to_json.must_equal %{{"class":"String"}}
-    end
-  end
-
-  describe "#to_json" do
-    class OptionsShow < Trailblazer::Operation
-      include Representer
-
-      representer do
-        property :class
-        property :id
-      end
-
-      def to_json(*)
-        super(self["params"])
-      end
-
-      include Model::Builder
-      def model!(*)
-        Song.new(1)
-      end
-    end
-
-    it "allows to pass options to #to_json" do
-      OptionsShow.(include: [:id]).to_json.must_equal %{{"id":1}}
-    end
-  end
-end
-
-class DifferentParseAndRenderingRepresenterTest < MiniTest::Spec
-  Album = Struct.new(:title)
-
-  # rendering
-  class Create < Trailblazer::Operation
-    include Contract::Explicit
-    extend Representer::DSL
-    include Representer::Rendering # no Deserializer::Hash here or anything.
-
-    contract do
-      property :title
-    end
-
-    representer do
-      property :title, as: :Title
-    end
-
-    def call(params)
-      self["model"] = Album.new
-      validate(params) do
-        contract.sync
-      end
-      self
-    end
-  end
-
-  it do
-    Create.(title: "The Kids").to_json.must_equal %{{"Title":"The Kids"}}
-  end
-
-  # parsing
-  class Update < Trailblazer::Operation
-    include Contract::Explicit
-    extend Representer::DSL
-    include Representer::Deserializer::Hash # no Rendering.
-
-    representer do
-      property :title, as: :Title
-    end
-
-    contract do
-      property :title
-    end
-
-    def call(params)
-      self["model"] = Album.new
-
-      validate(params) do
-        contract.sync
-      end
-
-      self
-    end
-
-    def to_json(*)
-      %{{"title": "#{self["model"].title}"}}
-    end
-  end
-
-  it do
-    Update.("Title" => "The Kids").to_json.must_equal %{{"title": "The Kids"}}
-  end
-end
+# require "test_helper"
+# require "representable/json"
+
+# class RepresenterTest < MiniTest::Spec
+#   Album  = Struct.new(:title, :artist)
+#   Artist = Struct.new(:name)
+
+#   class Create < Trailblazer::Operation
+#     include Contract
+#     include Representer
+#     include Representer::InferFromContract
+#     attr_reader :model # FIXME: all we want is #model.
+
+#     contract do
+#       property :title
+#       validates :title, presence: true
+#       property :artist, populate_if_empty: Artist do
+#         property :name
+#         validates :name, presence: true
+#       end
+#     end
+
+#     def call(params)
+#       self["model"] = Album.new # NO artist!!!
+#       validate(params[:album], model: self["model"])
+#       self
+#     end
+#   end
+
+
+#   # Infers representer from contract, no customization.
+#   class Show < Create
+#     def call(params)
+#       self["model"] = Album.new("After The War", Artist.new("Gary Moore"))
+#       self
+#     end
+#   end
+
+
+#   # Infers representer, adds hypermedia.
+#   require "roar/json/hal"
+#   class HypermediaCreate < Create
+#     representer do
+#       include Roar::JSON::HAL
+
+#       link(:self) { "//album/#{represented.title}" }
+#     end
+#   end
+
+#   class HypermediaShow < HypermediaCreate
+#     def call(params)
+#       self["model"] = Album.new("After The War", Artist.new("Gary Moore"))
+#       self
+#     end
+#   end
+
+
+#   # rendering
+#   # generic contract -> representer
+#   it { Show.().to_json.must_equal %{{"title":"After The War","artist":{"name":"Gary Moore"}}} }
+
+#   # contract -> representer with hypermedia
+#   it do
+#     HypermediaShow.().to_json.must_equal %{{"title":"After The War","artist":{"name":"Gary Moore"},"_links":{"self":{"href":"//album/After The War"}}}}
+#   end
+
+
+#   # parsing
+#   it do
+#     op = Create.(album: %{{"title":"Run For Cover","artist":{"name":"Gary Moore"}}})
+#     op.contract.title.must_equal "Run For Cover"
+#     op.contract.artist.name.must_equal "Gary Moore"
+#   end
+
+#   it do
+#     op = HypermediaCreate.(album: %{{"title":"After The War","artist":{"name":"Gary Moore"},"_links":{"self":{"href":"//album/After The War"}}}})
+#     op.contract.title.must_equal "After The War"
+#     op.contract.artist.name.must_equal "Gary Moore"
+#   end
+
+
+
+
+
+#   # explicit representer set with ::representer_class=.
+#   require "roar/decorator"
+#   class JsonApiCreate < Trailblazer::Operation
+#     include Contract
+#     include Representer
+#     attr_reader :model
+
+#     contract do # we still need contract as the representer writes to the contract twin.
+#       property :title
+#     end
+
+#     class AlbumRepresenter < Roar::Decorator
+#       include Roar::JSON
+#       property :title
+#     end
+
+#     # FIXME: this won't inherit, of course.
+#     # self["representer.class"] = AlbumRepresenter
+#     representer AlbumRepresenter
+
+#     def call(params)
+#       self["model"] = Album.new # NO artist!!!
+#       validate(params[:album], model: self["model"])
+#       self
+#     end
+#   end
+
+#   class JsonApiShow < JsonApiCreate
+#     def call(params)
+#       self["model"] = Album.new("After The War", Artist.new("Gary Moore"))
+#       self
+#     end
+#   end
+
+#   # render.
+#   it do
+#     JsonApiShow.().to_json.must_equal %{{"title":"After The War"}}
+#   end
+
+#   # parse.
+#   it do
+#     JsonApiCreate.(album: %{{"title":"Run For Cover"}}).contract.title.must_equal "Run For Cover"
+#   end
+# end
+
+# class InternalRepresenterAPITest < MiniTest::Spec
+#   Song = Struct.new(:id)
+
+#   describe "#represented" do
+#     class Show < Trailblazer::Operation
+#       include Contract
+#       include Representer, Model
+#       model Song, :create
+
+#       representer do
+#         property :class
+#       end
+
+#       def call(*)
+#         self
+#       end
+
+#       def model # FIXME.
+#         self["model"]
+#       end
+#     end
+
+#     it "uses #model as represented, per default" do
+#       Show.({}).to_json.must_equal '{"class":"InternalRepresenterAPITest::Song"}'
+#     end
+
+#     class ShowContract < Show
+#       def represented
+#         "Object"
+#       end
+#     end
+
+#     it "can be overriden to use the contract" do
+#       ShowContract.({}).to_json.must_equal %{{"class":"String"}}
+#     end
+#   end
+
+#   describe "#to_json" do
+#     class OptionsShow < Trailblazer::Operation
+#       include Representer
+
+#       representer do
+#         property :class
+#         property :id
+#       end
+
+#       def to_json(*)
+#         super(self["params"])
+#       end
+
+#       include Model::Builder
+#       def model!(*)
+#         Song.new(1)
+#       end
+#     end
+
+#     it "allows to pass options to #to_json" do
+#       OptionsShow.(include: [:id]).to_json.must_equal %{{"id":1}}
+#     end
+#   end
+# end
+
+# class DifferentParseAndRenderingRepresenterTest < MiniTest::Spec
+#   Album = Struct.new(:title)
+
+#   # rendering
+#   class Create < Trailblazer::Operation
+#     include Contract
+#     extend Representer::DSL
+#     include Representer::Rendering # no Deserializer::Hash here or anything.
+
+#     contract do
+#       property :title
+#     end
+
+#     representer do
+#       property :title, as: :Title
+#     end
+
+#     def call(params)
+#       self["model"] = Album.new
+#       validate(params) do
+#         contract.sync
+#       end
+#       self
+#     end
+#   end
+
+#   it do
+#     Create.(title: "The Kids").to_json.must_equal %{{"Title":"The Kids"}}
+#   end
+
+#   # parsing
+#   class Update < Trailblazer::Operation
+#     include Contract
+#     extend Representer::DSL
+#     include Representer::Deserializer::Hash # no Rendering.
+
+#     representer do
+#       property :title, as: :Title
+#     end
+
+#     contract do
+#       property :title
+#     end
+
+#     def call(params)
+#       self["model"] = Album.new
+
+#       validate(params) do
+#         contract.sync
+#       end
+
+#       self
+#     end
+
+#     def to_json(*)
+#       %{{"title": "#{self["model"].title}"}}
+#     end
+#   end
+
+#   it do
+#     Update.("Title" => "The Kids").to_json.must_equal %{{"title": "The Kids"}}
+#   end
+# end