trailblazer 2.0.3 → 2.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a1f0c47cf26109508aa2f58b38a69f0a4b5f9b07
-  data.tar.gz: 98cddf35489a1ea61a95e01237d459682d9ab3df
+  metadata.gz: c715d450be489fd1d47e0e9543044dbecc683db8
+  data.tar.gz: 3212afa6969b12ed86cab5b73cb43a84ffa56ac0
 SHA512:
-  metadata.gz: 60ef0796bcfa0c12255595c47b514f4a0cbfbac1d90091172459cd4a23b7250d444bff6ecb90d74504c216bebca893bab5cfbe6643d9779ecddd0f7bfc093f2f
-  data.tar.gz: 212e3134780b3146cd25e713b5b83beadd4219f291a772e31cdcb766b745fd334ec765b01f70b085c9fa999ca0e062ae7cff88064a86b65139e73d257241f2d2
+  metadata.gz: 7ff9d994e6c2176ed8dd418ed49fd9214edb7251c44251b6a1afaa93803063bf599f10f0f08b2e726ec69d979e550bee18567e73ffdb822210db93744d2689b4
+  data.tar.gz: 4f7a37983d925bd4e6c8722422aa97d067a1dec4ba11c3018c4887d9b5ec8e2fab57aed6ce6a062ad4a0ea2713dbfdd15fda98401343e0c7e5d934783e3abf24

data/CHANGES.md

@@ -1,9 +1,13 @@
+# 2.0.4
+
+* When using `Nested(X)`, the automatic `:name` option is now `"Nested(X)"` instead of the cryptic proc string.
+
 # 2.0.3
 
 * `Guard` now allows kw args for its option.
 * Fix a bug where `Nested( ->{} )` wouldn't `_call` the nested operation and did too much work on re-nested the already nested params. Thanks to @eliranf for spotting this.
 * Add `Nested(..., input: )` to dynamically decide the input to the nested operation. http://trailblazer.to/gems/operation/2.0/api.html#nested-input
-* Add `Nested(..., output: )`: http://localhost:4000/gems/operation/2.0/api.html#nested-output
+* Add `Nested(..., output: )`: http://trailblazer.to/gems/operation/2.0/api.html#nested-output
 
 # 2.0.2
 

data/Gemfile

@@ -9,7 +9,7 @@ gemspec
 gem "reform-rails"
 gem "activesupport", "~> 4.2.0"
 
-gem "roar", github: "apotonick/roar"
+# gem "roar", github: "apotonick/roar"
 # gem "reform", "~> 2.0.0"
 gem "reform"#, path: "../reform"
 # gem "roar", path: "../roar"

data/lib/trailblazer/operation/nested.rb

@@ -1,8 +1,8 @@
 class Trailblazer::Operation
-  def self.Nested(step, input:nil, output:nil)
-    step = Nested.for(step, input, output)
+  def self.Nested(callable, input:nil, output:nil)
+    step = Nested.for(callable, input, output)
 
-    [ step, { name: "Nested(#{step})" } ]
+    [ step, { name: "Nested(#{callable})" } ]
   end
 
   # WARNING: this is experimental API, but it will end up with something like that.
@@ -22,9 +22,10 @@ class Trailblazer::Operation
   module Nested
     # Please note that the instance_variable_get are here on purpose since the
     # superinternal API is not entirely decided, yet.
-    def self.for(step, input, output) # DISCUSS: use builders here?
+    # @api private
+    def self.for(step, input, output, is_nestable_object=method(:nestable_object?)) # DISCUSS: use builders here?
       invoker            = Caller::Dynamic.new(step)
-      invoker            = Caller.new(step) if step.is_a?(Class) && step <= Trailblazer::Operation # interestingly, with < we get a weird nil exception. bug in Ruby?
+      invoker            = Caller.new(step) if is_nestable_object.(step)
 
       options_for_nested = Options.new
       options_for_nested = Options::Dynamic.new(input) if input
@@ -42,6 +43,11 @@ class Trailblazer::Operation
       end
     end
 
+    def self.nestable_object?(object)
+      # interestingly, with < we get a weird nil exception. bug in Ruby?
+      object.is_a?(Class) && object <= Trailblazer::Operation
+    end
+
     # Is executed at runtime and calls the nested operation.
     class Caller
       include Element

data/lib/trailblazer/operation/rescue.rb

@@ -1,5 +1,5 @@
 class Trailblazer::Operation
-  def self.Rescue(*exceptions, handler: Rescue::Noop, &block)
+  def self.Rescue(*exceptions, handler: lambda { |*| }, &block)
     exceptions = [StandardError] unless exceptions.any?
     handler    = Option.(handler)
 
@@ -17,9 +17,5 @@ class Trailblazer::Operation
 
     [ step, name: "Rescue:#{block.source_location.last}" ]
   end
-
-  module Rescue
-    Noop = ->(*) {}
-  end
 end
 

data/lib/trailblazer/operation/test.rb

@@ -0,0 +1,17 @@
+module Trailblazer
+  module Test
+    module Run
+      # DISCUSS: use Endpoint here?
+      # DISCUSS: use Controller code here?
+      module_function
+      def run(operation_class, *args)
+        result = operation_class.(*args)
+
+        raise "[Trailblazer] #{operation_class} wasn't run successfully. #{result.inspect}" if result.failure?
+
+        result
+
+      end
+    end
+  end
+end

data/lib/trailblazer/version.rb

@@ -1,3 +1,3 @@
 module Trailblazer
-  VERSION = "2.0.3"
+  VERSION = "2.0.4"
 end

data/test/docs/contract_test.rb

@@ -4,7 +4,7 @@ class DocsContractOverviewTest < Minitest::Spec
   Song = Struct.new(:length, :title)
 
   #:overv-reform
-  # app/concepts/comment/create.rb
+  # app/concepts/song/create.rb
   class Create < Trailblazer::Operation
     #~bla
     extend Contract::DSL
@@ -126,29 +126,6 @@ class DocsContractExplicitTest < Minitest::Spec
   #:reform-inline-op end
 end
 
-#---
-#- Validate[key: :song]
-class DocsContractKeyTest < Minitest::Spec
-  Song = Struct.new(:id, :title)
-  #:key
-  class Create < Trailblazer::Operation
-    extend Contract::DSL
-
-    contract do
-      property :title
-    end
-
-    step Model( Song, :new )
-    step Contract::Build()
-    step Contract::Validate( key: "song" )
-    step Contract::Persist( method: :sync )
-  end
-  #:key end
-
-  it { Create.({}).inspect("model", "result.contract.default.extract").must_equal %{<Result:false [#<struct DocsContractKeyTest::Song id=nil, title=nil>, nil] >} }
-  it { Create.({"song" => { title: "SVG" }}).inspect("model").must_equal %{<Result:true [#<struct DocsContractKeyTest::Song id=nil, title="SVG">] >} }
-end
-
 #- Validate with manual key extraction
 class DocsContractSeparateKeyTest < Minitest::Spec
   Song = Struct.new(:id, :title)
@@ -181,48 +158,165 @@ class DocsContractSeparateKeyTest < Minitest::Spec
 end
 
 #---
-#- Contract::Build[ constant: XXX ]
+#- Contract::Build( constant: XXX )
 class ContractConstantTest < Minitest::Spec
-  Song = Struct.new(:id, :title)
-  #:constant
-  class Create < Trailblazer::Operation
-    class MyContract < Reform::Form
-      property :title
-      validates :title, length: 2..33
+  Song = Struct.new(:title, :length) do
+    def save
+      true
     end
+  end
 
+  #:constant-contract
+  # app/concepts/song/contract/create.rb
+  module Song::Contract
+    class Create < Reform::Form
+      property :title
+      property :length
 
+      validates :title,  length: 2..33
+      validates :length, numericality: true
+    end
+  end
+  #:constant-contract end
 
+  #:constant
+  class Song::Create < Trailblazer::Operation
     step Model( Song, :new )
-    step Contract::Build( constant: MyContract )
+    step Contract::Build( constant: Song::Contract::Create )
     step Contract::Validate()
-    step Contract::Persist( method: :sync )
+    step Contract::Persist()
   end
   #:constant end
 
-  it { Create.({ title: "A" }).inspect("model").must_equal %{<Result:false [#<struct ContractConstantTest::Song id=nil, title=nil>] >} }
-  it { Create.({ title: "Anthony's Song" }).inspect("model").must_equal %{<Result:true [#<struct ContractConstantTest::Song id=nil, title="Anthony's Song">] >} }
+  it { Song::Create.({ title: "A" }).inspect("model").must_equal %{<Result:false [#<struct ContractConstantTest::Song title=nil, length=nil>] >} }
+  it { Song::Create.({ title: "Anthony's Song", length: 12 }).inspect("model").must_equal %{<Result:true [#<struct ContractConstantTest::Song title="Anthony's Song", length=12>] >} }
+  it do
+    #:constant-result
+    result = Song::Create.( title: "A" )
+    result.success? #=> false
+    result["contract.default"].errors.messages
+      #=> {:title=>["is too short (minimum is 2 characters)"], :length=>["is not a number"]}
+    #:constant-result end
+
+    #:constant-result-true
+    result = Song::Create.( title: "Rising Force", length: 13 )
+    result.success? #=> true
+    result["model"] #=> #<Song title="Rising Force", length=13>
+    #:constant-result-true end
+  end
+
+  #---
+  # Song::New
+  #:constant-new
+  class Song::New < Trailblazer::Operation
+    step Model( Song, :new )
+    step Contract::Build( constant: Song::Contract::Create )
+  end
+  #:constant-new end
+
+  it { Song::New.().inspect("model").must_equal %{<Result:true [#<struct ContractConstantTest::Song title=nil, length=nil>] >} }
+  it { Song::New.()["contract.default"].model.inspect.must_equal %{#<struct ContractConstantTest::Song title=nil, length=nil>} }
+  it do
+    #:constant-new-result
+    result = Song::New.()
+    result["model"] #=> #<struct Song title=nil, length=nil>
+    result["contract.default"]
+      #=> #<Song::Contract::Create model=#<struct Song title=nil, length=nil>>
+    #:constant-new-result end
+  end
+
+  #---
+  #:validate-only
+  class Song::ValidateOnly < Trailblazer::Operation
+    step Model( Song, :new )
+    step Contract::Build( constant: Song::Contract::Create )
+    step Contract::Validate()
+  end
+  #:validate-only end
+
+  it { Song::ValidateOnly.().inspect("model").must_equal %{<Result:false [#<struct ContractConstantTest::Song title=nil, length=nil>] >} }
+  it do
+    result = Song::ValidateOnly.({ title: "Rising Forse", length: 13 })
+    result.inspect("model").must_equal %{<Result:true [#<struct ContractConstantTest::Song title=nil, length=nil>] >}
+  end
+
+  it do
+    #:validate-only-result-false
+    result = Song::ValidateOnly.({}) # empty params
+    result.success? #=> false
+    #:validate-only-result-false end
+  end
+
+  it do
+    #:validate-only-result
+    result = Song::ValidateOnly.({ title: "Rising Force", length: 13 })
+
+    result.success? #=> true
+    result["model"] #=> #<struct Song title=nil, length=nil>
+    result["contract.default"].title #=> "Rising Force"
+    #:validate-only-result end
+  end
+end
+
+#---
+#- Validate( key: :song )
+class DocsContractKeyTest < Minitest::Spec
+  Song = Class.new(ContractConstantTest::Song)
+
+  module Song::Contract
+    Create = ContractConstantTest::Song::Contract::Create
+  end
+
+  #:key
+  class Song::Create < Trailblazer::Operation
+    step Model( Song, :new )
+    step Contract::Build( constant: Song::Contract::Create )
+    step Contract::Validate( key: "song" )
+    step Contract::Persist( )
+  end
+  #:key end
+
+  it { Song::Create.({}).inspect("model", "result.contract.default.extract").must_equal %{<Result:false [#<struct DocsContractKeyTest::Song title=nil, length=nil>, nil] >} }
+  it { Song::Create.({"song" => { title: "SVG", length: 13 }}).inspect("model").must_equal %{<Result:true [#<struct DocsContractKeyTest::Song title=\"SVG\", length=13>] >} }
+  it do
+    #:key-res
+    result = Song::Create.({ "song" => { title: "Rising Force", length: 13 } })
+    result.success? #=> true
+    #:key-res end
+
+    #:key-res-false
+    result = Song::Create.({ title: "Rising Force", length: 13 })
+    result.success? #=> false
+    #:key-res-false end
+  end
 end
 
 #- Contract::Build[ constant: XXX, name: AAA ]
 class ContractNamedConstantTest < Minitest::Spec
-  Song = Struct.new(:id, :title)
-  #:constant-name
-  class Create < Trailblazer::Operation
-    class MyContract < Reform::Form
-      property :title
-      validates :title, length: 2..33
-    end
+  Song = Class.new(ContractConstantTest::Song)
+
+  module Song::Contract
+    Create = ContractConstantTest::Song::Contract::Create
+  end
 
+  #:constant-name
+  class Song::Create < Trailblazer::Operation
     step Model( Song, :new )
-    step Contract::Build( constant: MyContract, name: "form" )
+    step Contract::Build(    name: "form", constant: Song::Contract::Create )
     step Contract::Validate( name: "form" )
-    step Contract::Persist( method: :sync, name: "form" )
+    step Contract::Persist(  name: "form" )
   end
   #:constant-name end
 
-  it { Create.({ title: "A" }).inspect("model").must_equal %{<Result:false [#<struct ContractNamedConstantTest::Song id=nil, title=nil>] >} }
-  it { Create.({ title: "Anthony's Song" }).inspect("model").must_equal %{<Result:true [#<struct ContractNamedConstantTest::Song id=nil, title="Anthony's Song">] >} }
+  it { Song::Create.({ title: "A" }).inspect("model").must_equal %{<Result:false [#<struct ContractNamedConstantTest::Song title=nil, length=nil>] >} }
+  it { Song::Create.({ title: "Anthony's Song", length: 13 }).inspect("model").must_equal %{<Result:true [#<struct ContractNamedConstantTest::Song title="Anthony's Song", length=13>] >} }
+
+  it do
+    #:name-res
+    result = Song::Create.({ title: "A" })
+    result["contract.form"].errors.messages #=> {:title=>["is too short (minimum is 2 ch...
+    #:name-res end
+  end
 end
 
 #---

data/test/docs/nested_test.rb

@@ -76,6 +76,7 @@ class DocsNestedOperationTest < Minitest::Spec
   class B < Trailblazer::Operation
     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.params?"] = options["params"] }
     success ->(options) { options["can.B.see.A.class.data?"] = options["A.class.data"] }
   end
 
@@ -91,6 +92,7 @@ class DocsNestedOperationTest < Minitest::Spec
   it { A.()["this.should.not.be.visible.in.B"].must_equal true }
   # runtime dependencies are visible in B.
   it { A.({}, "current_user" => Module)["can.B.see.current_user?"].must_equal Module }
+  it { A.({ a: 1 })["can.B.see.params?"].must_equal({ a: 1 }) }
   # class data from A doesn't bleed into B.
   it { A.()["can.B.see.A.class.data?"].must_equal nil }
 
@@ -315,3 +317,18 @@ class NestedWithCallableTest < Minitest::Spec
 end
 
 # builder: Nested + deviate to left if nil / skip_track if true
+
+#---
+# automatic :name
+class NestedNameTest < Minitest::Spec
+  class Create < Trailblazer::Operation
+    class Present < Trailblazer::Operation
+      # ...
+    end
+
+    step Nested( Present )
+    # ...
+  end
+
+  it { Create["pipetree"].inspect.must_equal %{[>operation.new,>Nested(NestedNameTest::Create::Present)]} }
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trailblazer
 version: !ruby/object:Gem::Version
-  version: 2.0.3
+  version: 2.0.4
 platform: ruby
 authors:
 - Nick Sutterer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-23 00:00:00.000000000 Z
+date: 2017-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: trailblazer-operation
@@ -184,6 +184,7 @@ files:
 - lib/trailblazer/operation/pundit.rb
 - lib/trailblazer/operation/representer.rb
 - lib/trailblazer/operation/rescue.rb
+- lib/trailblazer/operation/test.rb
 - lib/trailblazer/operation/validate.rb
 - lib/trailblazer/operation/wrap.rb
 - lib/trailblazer/version.rb
@@ -242,7 +243,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.3
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: A high-level architecture for Ruby and Rails.