laminar 0.3.0

data/lib/laminar/flow/specification.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Laminar
+  module Flow
+    # Specification for a flow (chained sequence of particles).
+    class Specification
+      attr_accessor :steps, :first_step
+
+      def initialize(_args = {}, &spec)
+        @steps = {}
+        instance_eval(&spec) if spec
+      end
+
+      def step(name, options = {}, &gotos)
+        step = add_step(name, options, &gotos)
+
+        # backport a default next step onto the previous step to point to
+        # the current one, unless this is the first step. Allows for simple
+        # case where execution just falls through to the next step where they
+        # haven't specified any explicit branching or none of the branch
+        # conditions get met.
+        @prev_step&.branch(step.name)
+        @prev_step = step
+      end
+
+      def before_each(*args, &block)
+        before_each_callbacks.concat(args)
+        before_each_callbacks << block if block
+      end
+
+      def after_each(*args, &block)
+        after_each_callbacks.concat(args)
+        after_each_callbacks << block if block
+      end
+
+      def before_each_callbacks
+        @before_each_callbacks ||= []
+      end
+
+      def after_each_callbacks
+        @after_each_callbacks ||= []
+      end
+
+      private
+
+      def add_step(name, options = {}, &gotos)
+        raise ArgumentError, "Step #{name} defined twice" if @steps.key?(name)
+
+        step = Step.new(name, options, &gotos)
+        @first_step ||= step.name
+        @steps[step.name] = step
+      end
+    end
+  end
+end

data/lib/laminar/flow/step.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+require 'laminar/flow/options_validator'
+require 'active_support'
+require 'active_support/core_ext/string/inflections'
+
+module Laminar
+  module Flow
+    # Specification for an executable step in a Flow.
+    class Step
+      include OptionsValidator
+      attr_reader :name, :branches, :class_name
+
+      valid_options %i[class].freeze
+
+      def initialize(name, options = {}, &block)
+        unless name.class.method_defined?(:to_sym)
+          raise ArgumentError, 'invalid name'
+        end
+
+        validate_options(options)
+        @class_name = (options[:class] || name).to_s.camelize
+        @name = name.to_sym
+        @branches = []
+
+        instance_eval(&block) if block
+      end
+
+      # Return class instance of the associated particle.
+      def particle
+        class_name.constantize
+      end
+
+      # Add a branch specification. This is typically called as
+      # part of a flow specification:
+      #
+      # flow do
+      #   step :step1
+      # end
+      #
+      def branch(target, options = {})
+        branches << Branch.new(target, options)
+      end
+      alias goto branch
+
+      # Find the next rule in the flow. Examines the branches associated
+      # with the current rule and returns the name of the first branch
+      # that satisfies its condition.
+      def next_step_name(impl_context)
+        branch = first_applicable_branch(impl_context)
+        return if branch.nil?
+
+        branch.name
+      end
+
+      # Defines a callback to run before the flow executes the step.
+      def before(*args, &block)
+        before_callbacks.concat(args)
+        before_callbacks << block if block
+      end
+
+      # Defines a callback to run after the flow executes the step.
+      def after(*args, &block)
+        after_callbacks.concat(args)
+        after_callbacks << block if block
+      end
+
+      # Return the list of before callbacks.
+      def before_callbacks
+        @before_callbacks ||= []
+      end
+
+      # Return the list of after callbacks.
+      def after_callbacks
+        @after_callbacks ||= []
+      end
+
+      # Return the first branch that satisfies its condition.
+      def first_applicable_branch(target)
+        branches.each do |branch|
+          return branch if branch.meets_condition?(target)
+        end
+        nil
+      end
+    end
+  end
+end

data/lib/laminar/particle.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module Laminar
+  # Base methods for a logic particle. Particles can be invoked
+  # by themselves or as part of a Flow. Classes should include
+  # this module rather than inherit.
+  module Particle
+    def self.included(klass)
+      klass.class_eval do
+        extend ClassMethods
+        include Callbacks
+        include InstanceMethods
+      end
+
+      attr_reader :context
+    end
+
+    # Laminar::Particle class methods and attributes.
+    module ClassMethods
+      def call(context = {})
+        new(context).invoke
+      end
+
+      def call!(context = {})
+        new(context).invoke!
+      end
+    end
+
+    module InstanceMethods
+      def initialize(context = {})
+        @context = Context.build(context)
+      end
+
+      def invoke
+        invoke!
+      rescue ParticleStopped
+        context
+      end
+
+      def invoke!
+        run_before_callbacks
+        return context if context.halted?
+
+        param_list = context_slice
+        param_list.empty? ? call : call(context_slice)
+        run_after_callbacks
+        context
+      end
+
+      def call; end
+
+      private
+
+      def context_slice
+        context.select { |k, _v| introspect_params.include?(k) }
+      end
+
+      # Returns an array of keyword parameters that the instance expects
+      # or accepts. If the signature includes a 'splat' (:keyrest) to catch
+      # a variable set of arguments, returns the current context keys.
+      def introspect_params
+        params = self.class.instance_method(:call).parameters
+        return context.keys if params.map(&:first).include?(:keyrest)
+
+        params.map(&:last)
+      end
+    end
+  end
+end

data/lib/laminar/particle_stopped.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Laminar
+  # Raised when someone calls fail!() on a Laminar::Context.
+  class ParticleStopped < StandardError
+    attr_reader :context
+
+    def initialize(context = nil)
+      @context = context
+      super
+    end
+  end
+end

data/lib/laminar/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Laminar
+  VERSION = '0.3.0'
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: laminar
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Robert Lockerd
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-10-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+description: 
+email:
+- rmlockerd@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/ISSUE_TEMPLATE/feature_request.md"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- laminar.gemspec
+- lib/laminar.rb
+- lib/laminar/callbacks.rb
+- lib/laminar/context.rb
+- lib/laminar/flow.rb
+- lib/laminar/flow/branch.rb
+- lib/laminar/flow/flow_error.rb
+- lib/laminar/flow/options_validator.rb
+- lib/laminar/flow/specification.rb
+- lib/laminar/flow/step.rb
+- lib/laminar/particle.rb
+- lib/laminar/particle_stopped.rb
+- lib/laminar/version.rb
+homepage: https://github.com/rmlockerd/laminar
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Simple, composable business objects & workflow
+test_files: []