trailblazer-operation 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 024692c54e2cd96083ce9646b34a081ca96fe0c4
-  data.tar.gz: 5c70e52676a9f29238e373ea327429a773e98bc0
+  metadata.gz: 06580a6dc8f0356b1c6b8216728703e5c994e0e1
+  data.tar.gz: c8f45a4f5066f203a59c04620fe90a2f464ded39
 SHA512:
-  metadata.gz: d58111c3bd7d8f78a867a36b25caedffb1fdd8b4fd0d8a1bd44451c5f5a2b1ead27aa917239e8b40a98bd73aad915592e5e4b26845a556cec5c45021287aff4b
-  data.tar.gz: 09e44c9e7fad270accfa3358a7010fc17aa09840668c8565eeab8b0ea02c23cf909d7e35281c331687eb03879f8fcbb1c441e66606fc8d31af1820e3fd834be6
+  metadata.gz: 31fe5767c979b2224b6b06c18ffb76e3a60e99543788f219cc744cad361d69d1c710c18295835091c1e299a8966a5e81f2ca9eb02b295e5d273ae3ef8590e67d
+  data.tar.gz: c844b16ab00e425c533e9bc867520c4b88fb437ef63ddf949a41260a5a851af0b4577acb02d05fc7392235aa1d05ac9481a7516b3b1f3a2e906cd6e5c155058d

data/CHANGES.md

@@ -1,3 +1,7 @@
+## 0.0.4
+
+* Don't pass the operation into `Result`, but the `Skill` options hash, only.
+
 ## 0.0.3
 
 * Add `#inspect(slices)`.

data/README.md

@@ -1,3 +1,9 @@
 ## Goal
 
 * Make `Operation` an imutable object without having to expose @instance variables. This is now done via the Result object.
+
+## Copyright
+
+Copyright (c) 2016 Nick Sutterer <apotonick@gmail.com>
+
+`trailblazer-operation` is released under the [MIT License](http://www.opensource.org/licenses/MIT).

data/lib/trailblazer/operation.rb

@@ -2,7 +2,7 @@ require "declarative" # FIXME: here?
 require "trailblazer/operation/skill"
 require "trailblazer/operation/pipetree"
 require "trailblazer/operation/generic"
-require "trailblazer/operation/stepable"
+require "trailblazer/operation/macro"
 
 module Trailblazer
   # The Trailblazer-style operation.
@@ -16,6 +16,7 @@ module Trailblazer
     include Pipetree        # ::call, ::|
     # we want the skill dependency-mechanism.
     extend Skill::Call      # ::call
+    extend Skill::Call::Positional # ::call(params, options)
 
     # we want the initializer and the ::call method.
     include Generic         # #initialize, #call, #process.

data/lib/trailblazer/operation/generic.rb

@@ -5,7 +5,7 @@ module Trailblazer
       @skills = skills
     end
 
-    # dependency injection interface
+    # dependency interface
     extend Uber::Delegates
     delegates :@skills, :[], :[]=
   end

data/lib/trailblazer/operation/{stepable.rb → macro.rb}

@@ -1,7 +1,7 @@
 class Trailblazer::Operation
-  module Stepable
+  module Macro
     Configuration = Struct.new(:mod, :args, :block) do
-      include Stepable # mark it, so that ::| thinks this is a step module.
+      include Macro # mark it, so that ::| thinks this is a step module.
 
       def import!(operation, import)
         mod.import!(operation, import, *args)

data/lib/trailblazer/operation/pipetree.rb

@@ -23,9 +23,12 @@ class Trailblazer::Operation
       def call(options)
         pipe = self["pipetree"] # TODO: injectable? WTF? how cool is that?
 
-        last, operation = pipe.(self, options) # operation == self, usually.
+        last, operation = pipe.(self, options)
 
-        Result.new(last == ::Pipetree::Flow::Right, operation)
+        # The reason the Result wraps the Skill object (`options`), not the operation
+        # itself is because the op should be irrelevant, plus when stopping the pipe
+        # before op instantiation, this would be confusing (and wrong!).
+        Result.new(last == ::Pipetree::Flow::Right, options)
       end
 
       # This method would be redundant if Ruby had a Class::finalize! method the way
@@ -56,7 +59,7 @@ class Trailblazer::Operation
       end
 
       def |(cfg, user_options={}) # sorry for the magic here, but still playing with the DSL.
-        if cfg.is_a?(Stepable) # e.g. Contract::Validate
+        if cfg.is_a?(Macro) # e.g. Contract::Validate
           import = Import.new(self, user_options)
 
           return cfg.import!(self, import) &&

data/lib/trailblazer/operation/result.rb

@@ -1,11 +1,11 @@
 class Trailblazer::Operation
   class Result
     def initialize(success, data)
-      @success, @data = success, data
+      @success, @data = success, data # @data is a Skill instance.
     end
 
     extend Uber::Delegates
-    delegates :@data, :[]
+    delegates :@data, :[] # DISCUSS: make it a real delegator? see Nested.
 
     def success?
       @success

data/lib/trailblazer/operation/skill.rb

@@ -23,9 +23,21 @@ class Trailblazer::Operation
 
     # Overrides Operation::call, creates the Skill hash and passes it to :call.
     module Call
-      def call(params={}, options={}, *dependencies)
-        super Trailblazer::Skill.new(mutual={}, options.merge("params" => params), *dependencies, self.skills)
+      def call(options={}, *dependencies)
+        super Trailblazer::Skill.new(options, *dependencies, self.skills)
+        # DISCUSS: should this be: Trailblazer::Skill.new(runtime_options: [options, *dependencies], compiletime_options: [self.skills])
+      end
+      alias :_call :call
+
+      # It really sucks that Ruby doesn't have method overloading where we could simply have
+      # two different implementations of ::call.
+      # FIXME: that shouldn't be here in this namespace.
+      module Positional
+        def call(params={}, options={}, *dependencies)
+          super(options.merge("params" => params), *dependencies)
+        end
       end
     end
+
   end
 end

data/lib/trailblazer/operation/version.rb

@@ -1,5 +1,5 @@
 module Trailblazer
   class Operation
-    VERSION = "0.0.3"
+    VERSION = "0.0.4"
   end
 end

data/lib/trailblazer/skill.rb

@@ -1,9 +1,13 @@
 # TODO: mark/make all but mutable_options as frozen.
+# The idea of Skill is to have a generic, ordered read/write interface that
+# collects mutable runtime-computed data while providing access to compile-time
+# information.
+# The runtime-data takes precedence over the class data.
 module Trailblazer
   class Skill
-    def initialize(mutuable_options, *containers)
-      @mutuable_options = mutuable_options
-      @resolver         = Resolver.new(@mutuable_options, *containers)
+    def initialize(*containers)
+      @mutable_options = {}
+      @resolver        = Resolver.new(@mutable_options, *containers)
     end
 
     def [](name)
@@ -11,13 +15,25 @@ module Trailblazer
     end
 
     def []=(name, value)
-      @mutuable_options[name] = value
+      @mutable_options[name] = value
+    end
+
+    # THIS METHOD IS CONSIDERED PRIVATE AND MIGHT BE REMOVED.
+    # Options from ::call (e.g. "user.current"), containers, etc.
+    # NO mutual data from the caller operation. no class state.
+    def to_runtime_data
+      @resolver.instance_variable_get(:@containers).slice(1..-2)
+    end
+
+    # THIS METHOD IS CONSIDERED PRIVATE AND MIGHT BE REMOVED.
+    def to_mutable_data
+      @mutable_options
     end
 
     # Look through a list of containers until you find the skill.
     class Resolver
     # alternative implementation:
-    # containers.reverse.each do |container| @mutuable_options.merge!(container) end
+    # containers.reverse.each do |container| @mutable_options.merge!(container) end
     #
     # benchmark, merging in #initialize vs. this resolver.
     #                merge     39.678k (± 9.1%) i/s -    198.700k in   5.056653s

data/test/gemfiles/Gemfile.ruby-1.9

@@ -2,3 +2,4 @@ source 'https://rubygems.org'
 gemspec path: "../../"
 
 gem "declarative"
+gem "pipetree"

data/test/gemfiles/Gemfile.ruby-1.9.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../../
   specs:
-    trailblazer-operation (0.0.2)
+    trailblazer-operation (0.0.3)
       declarative
       pipetree (>= 0.0.4, < 0.1.0)
       uber (>= 0.1.0, < 0.2.0)
@@ -23,6 +23,7 @@ DEPENDENCIES
   bundler
   declarative
   minitest
+  pipetree
   rake
   trailblazer-operation!
 

data/test/pipetree_test.rb

@@ -2,7 +2,7 @@ require "test_helper"
 
 class PipetreeTest < Minitest::Spec
   module Validate
-    extend Trailblazer::Operation::Stepable
+    extend Trailblazer::Operation::Macro
 
     def self.import!(operation, pipe)
       pipe.(:>, ->{ snippet }, name: "validate", before: "operation.new")

data/test/skill_test.rb

@@ -14,9 +14,7 @@ class SkillTest < Minitest::Spec
         "model.class" => Integer
       }
 
-      mutable_options = {}
-
-      skill = Trailblazer::Skill.new(mutable_options, runtime_skills, class_level_container)
+      skill = Trailblazer::Skill.new(runtime_skills, class_level_container)
 
       # non-existent key.
       skill[:nope].must_equal nil
@@ -34,8 +32,6 @@ class SkillTest < Minitest::Spec
       # add new tuple.
       skill["user.current"] = "Todd"
 
-      # options we add get added to the hash.
-      mutable_options.inspect.must_equal %{{"model.class"=>Fixnum, "user.current"=>"Todd"}}
       # original container don't get changed
       class_level_container.inspect.must_equal %{{"contract.class"=>Object, "model.class"=>String}}
       runtime_skills.inspect.must_equal %{{"contract"=>SkillTest::MyContract, "model.class"=>Integer}}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trailblazer-operation
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Nick Sutterer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-19 00:00:00.000000000 Z
+date: 2016-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: uber
@@ -121,10 +121,10 @@ files:
 - Rakefile
 - lib/trailblazer/operation.rb
 - lib/trailblazer/operation/generic.rb
+- lib/trailblazer/operation/macro.rb
 - lib/trailblazer/operation/pipetree.rb
 - lib/trailblazer/operation/result.rb
 - lib/trailblazer/operation/skill.rb
-- lib/trailblazer/operation/stepable.rb
 - lib/trailblazer/operation/version.rb
 - lib/trailblazer/skill.rb
 - test/benchmark/skill_resolver_benchmark.rb