trailblazer-context 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cbed8941980e69f6e3ef14de677024e8c45f4573
+  data.tar.gz: 31c11f6e2a59b45868e0247772bf9eafc692f06e
+SHA512:
+  metadata.gz: 33020d8f9f10cf5323e3dbe5572da5f8d1fe0b7842d1b2a73199be07a2bba2648ddcc146dea445e06551900152117bbedc19b7a6c5c476c2675d8222fa7fcaac
+  data.tar.gz: 6bf38334cd38dce21da64615860eec450bc180c4457c0b09399d179c376b204a7af1360349edc377054923e8f70354a22b943729d22412659eb80155998cddef

data/.gitignore

@@ -0,0 +1,50 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+gemspec
+
+gem "minitest-line"
+gem "benchmark-ips"

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 TRAILBLAZER GmbH
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,9 @@
+# Trailblazer-context
+
+_Argument-specific data structures for Trailblazer._
+
+This gem provides data structures needed across `Activity`, `Workflow` and `Operation`, such as the following.
+
+* `Trailblazer::Context` implements the so-called `options` hash that is passed between steps and implements the keyword arguments.
+* `Trailblazer::Option` is often used to wrap an option at compile-time and `call` it at runtime, which allows to have the common `-> ()`, `:method` or `Callable` pattern used for most options.
+* `Trailblazer::ContainerChain` to implement chained lookups of properties and allow including containers such as `Dry::Container` in this chain. This is experimental.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/*_test.rb']
+end
+
+task :default => :test

data/lib/trailblazer-context.rb

@@ -0,0 +1,2 @@
+require "trailblazer/context"
+require "trailblazer/option"

data/lib/trailblazer/container_chain.rb

@@ -0,0 +1,45 @@
+# @private
+class Trailblazer::Context::ContainerChain # used to be called Resolver.
+  # Keeps a list of containers. When looking up a key/value, containers are traversed in
+  # the order they were added until key is found.
+  #
+  # Required Container interface: `#key?`, `#[]`.
+  #
+  # @note ContainerChain is an immutable data structure, it does not support writing.
+  # @param containers Array of <Container> objects (splatted)
+  def initialize(containers, to_hash: nil)
+    @containers = containers
+    @to_hash    = to_hash
+  end
+
+  # @param name Symbol or String to lookup a value stored in one of the containers.
+  def [](name)
+    self.class.find(@containers, name)
+  end
+
+  # @private
+  def key?(name)
+    @containers.find { |container| container.key?(name) }
+  end
+
+  def self.find(containers, name)
+    containers.find { |container| container.key?(name) && (return container[name]) }
+  end
+
+  def keys
+    @containers.collect(&:keys).flatten
+end
+
+  # @private
+  def to_hash
+    return @to_hash.(@containers) if @to_hash # FIXME: introduce pattern matching so we can have different "transformers" for each container type.
+    @containers.each_with_object({}) { |container, hash| hash.merge!(container.to_hash) }
+  end
+end
+
+# alternative implementation:
+# 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
+#             resolver     68.928k (± 6.4%) i/s -    342.836k in   5.001610s

data/lib/trailblazer/context.rb

@@ -0,0 +1,68 @@
+# 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
+  # Holds local options (aka `mutable_options`) and "original" options from the "outer"
+  # activity (aka wrapped_options).
+
+  # only public creator: Build
+  class Context # :data object:
+    def initialize(wrapped_options, mutable_options)
+      @wrapped_options, @mutable_options = wrapped_options, mutable_options
+    end
+
+    def [](name)
+      ContainerChain.find( [@mutable_options, @wrapped_options], name )
+    end
+
+    def key?(name)
+      @mutable_options.key?(name) || @wrapped_options.key?(name)
+    end
+
+    def []=(name, value)
+      @mutable_options[name] = value
+    end
+
+    def merge(hash)
+      original, mutable_options = decompose
+
+      ctx = Trailblazer::Context( original, mutable_options.merge(hash) )
+    end
+
+    # Return the Context's two components. Used when computing the new output for
+    # the next activity.
+    def decompose
+      [ @wrapped_options, @mutable_options ]
+    end
+
+    def key?(name)
+      ContainerChain.find( [@mutable_options, @wrapped_options], name )
+    end
+
+
+    def keys
+      @mutable_options.keys + @wrapped_options.keys # FIXME.
+    end
+
+
+
+    # TODO: maybe we shouldn't allow to_hash from context?
+    # TODO: massive performance bottleneck. also, we could already "know" here what keys the
+    # transformation wants.
+    # FIXME: ToKeywordArguments()
+    def to_hash
+      {}.tap do |hash|
+        # the "key" here is to call to_hash on all containers.
+        [ @wrapped_options.to_hash, @mutable_options.to_hash ].each do |options|
+          options.each { |k, v| hash[k.to_sym] = v }
+        end
+      end
+    end
+  end
+
+  def self.Context(wrapped_options, mutable_options={})
+    Context.new(wrapped_options, mutable_options)
+  end
+end # Trailblazer

data/lib/trailblazer/context/version.rb

@@ -0,0 +1,5 @@
+module Trailblazer
+  class Context
+    VERSION = "0.1.0"
+  end
+end

data/lib/trailblazer/option.rb

@@ -0,0 +1,78 @@
+module Trailblazer
+  # @note This might go to trailblazer-args along with `Context` at some point.
+  def self.Option(proc)
+    Option.build(Option, proc)
+  end
+
+  class Option
+    # Generic builder for a callable "option".
+    # @param call_implementation [Class, Module] implements the process of calling the proc
+    #   while passing arguments/options to it in a specific style (e.g. kw args, step interface).
+    # @return [Proc] when called, this proc will evaluate its option (at run-time).
+    def self.build(call_implementation, proc)
+      if proc.is_a? Symbol
+        ->(*args) { call_implementation.evaluate_method(proc, *args) }
+      else
+        ->(*args) { call_implementation.evaluate_callable(proc, *args) }
+      end
+    end
+
+    # A call implementation invoking `proc.(*args)` and plainly forwarding all arguments.
+    # Override this for your own step strategy (see KW#call!).
+    # @private
+    def self.call!(proc, *args)
+      proc.(*args)
+    end
+
+    # Note that both #evaluate_callable and #evaluate_method drop most of the args.
+    # If you need those, override this class.
+    # @private
+    def self.evaluate_callable(proc, *args, **flow_options)
+      call!(proc, *args)
+    end
+
+    # Make the context's instance method a "lambda" and reuse #call!.
+    # @private
+    def self.evaluate_method(proc, *args, exec_context:raise, **flow_options)
+      call!(exec_context.method(proc), *args)
+    end
+
+    # Returns a {Proc} that, when called, invokes the `proc` argument with keyword arguments.
+    # This is known as "step (call) interface".
+    #
+    # This is commonly used by `Operation::step` to wrap the argument and make it
+    # callable in the circuit.
+    #
+    #   my_proc = ->(options, **kws) { options["i got called"] = true }
+    #   task    = Trailblazer::Option::KW(my_proc)
+    #   task.(options = {})
+    #   options["i got called"] #=> true
+    #
+    # Alternatively, you can pass a symbol and an `:exec_context`.
+    #
+    #   my_proc = :some_method
+    #   task    = Trailblazer::Option::KW(my_proc)
+    #
+    #   class A
+    #     def some_method(options, **kws)
+    #       options["i got called"] = true
+    #     end
+    #   end
+    #
+    #   task.(options = {}, exec_context: A.new)
+    #   options["i got called"] #=> true
+    def self.KW(proc)
+      Option.build(KW, proc)
+    end
+
+    # TODO: It would be cool if call! was typed and had `options SymbolizedHash` or something.
+    class KW < Option
+      # A different call implementation that calls `proc` with a "step interface".
+      #   your_code.(options, **options)
+      # @private
+      def self.call!(proc, options, *)
+        proc.(options, **options.to_hash) # Step interface: (options, **)
+      end
+    end
+  end
+end

data/trailblazer-context.gemspec

@@ -0,0 +1,28 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'trailblazer/context/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "trailblazer-context"
+  spec.version       = Trailblazer::Context::VERSION
+  spec.authors       = ["Nick Sutterer"]
+  spec.email         = ["apotonick@gmail.com"]
+
+  spec.summary       = %q{Argument-specific data structures for Trailblazer.}
+  spec.description   = %q{Argument-specific data structures for Trailblazer such as Context, Option and ContainerChain.}
+  spec.homepage      = "http://trailblazer.to/gems/workflow"
+  spec.licenses      = ["MIT"]
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+
+  spec.required_ruby_version = '>= 2.0.0'
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: trailblazer-context
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nick Sutterer
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-12-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Argument-specific data structures for Trailblazer such as Context, Option
+  and ContainerChain.
+email:
+- apotonick@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/trailblazer-context.rb
+- lib/trailblazer/container_chain.rb
+- lib/trailblazer/context.rb
+- lib/trailblazer/context/version.rb
+- lib/trailblazer/option.rb
+- trailblazer-context.gemspec
+homepage: http://trailblazer.to/gems/workflow
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: Argument-specific data structures for Trailblazer.
+test_files: []