flows 0.1.0 → 0.2.0

data/lib/flows/railway.rb

@@ -0,0 +1,48 @@
+require_relative './railway/errors'
+
+require_relative './railway/dsl'
+require_relative './railway/builder'
+require_relative './railway/executor'
+
+module Flows
+  # Railway DSL
+  module Railway
+    def self.included(mod)
+      mod.extend ::Flows::Railway::DSL
+    end
+
+    include ::Flows::Result::Helpers
+
+    def initialize(method_source: nil, deps: {})
+      _flows_do_checks
+
+      flow = _flows_make_flow(method_source || self, deps)
+      @_flows_executor = _flows_make_executor(flow)
+    end
+
+    def call(**params)
+      @_flows_executor.call(**params)
+    end
+
+    private
+
+    def _flows_do_checks
+      raise NoStepsError if self.class.steps.empty?
+    end
+
+    def _flows_make_flow(method_source, deps)
+      ::Flows::Railway::Builder.new(
+        steps: self.class.steps,
+        method_source: method_source,
+        deps: deps
+      ).call
+    end
+
+    def _flows_make_executor(flow)
+      ::Flows::Railway::Executor.new(
+        flow: flow,
+        class_name: self.class.name
+      )
+    end
+  end
+end

data/lib/flows/railway/builder.rb

@@ -0,0 +1,68 @@
+module Flows
+  module Railway
+    # Flow builder
+    class Builder
+      attr_reader :steps, :method_source, :deps
+
+      def initialize(steps:, method_source:, deps:)
+        @method_source = method_source
+        @steps = steps
+        @deps = deps
+      end
+
+      def call
+        resolve_bodies_and_wiring!
+
+        nodes = build_nodes
+        Flows::Flow.new(start_node: nodes.first.name, nodes: nodes)
+      end
+
+      private
+
+      def resolve_bodies_and_wiring!
+        index = 0
+
+        while index < @steps.length
+          current_step = @steps[index]
+
+          current_step[:next_step] = @steps[index + 1]&.fetch(:name) || :term
+          current_step[:body] = current_step[:custom_body] || resolve_body_from_source(current_step[:name])
+
+          index += 1
+        end
+      end
+
+      def resolve_body_from_source(name)
+        return @deps[name] if @deps.key?(name)
+
+        raise(::Flows::Railway::NoStepImplementationError, name) unless @method_source.respond_to?(name)
+
+        @method_source.method(name)
+      end
+
+      def build_nodes
+        @nodes = @steps.map do |step|
+          Flows::Node.new(
+            name: step[:name],
+            body: step[:body],
+            preprocessor: method(:node_preprocessor),
+            postprocessor: method(:node_postprocessor),
+            router: Flows::ResultRouter.new(step[:next_step], :term),
+
+            meta: { name: step[:name] }
+          )
+        end
+      end
+
+      def node_preprocessor(input, _context, _meta)
+        input.unwrap
+      end
+
+      def node_postprocessor(output, context, meta)
+        context[:last_step] = meta[:name]
+
+        output
+      end
+    end
+  end
+end

data/lib/flows/railway/dsl.rb

@@ -0,0 +1,28 @@
+module Flows
+  module Railway
+    # DSL methods for Railway
+    module DSL
+      attr_reader :steps
+
+      def self.extended(mod, steps = nil)
+        mod.instance_variable_set(:@steps, steps || [])
+
+        mod.class_exec do
+          def self.inherited(subclass)
+            ::Flows::Railway::DSL.extended(subclass, steps.map(&:dup))
+            super
+          end
+        end
+      end
+
+      include Flows::Result::Helpers
+
+      def step(name, custom_body = nil)
+        @steps << {
+          name: name,
+          custom_body: custom_body
+        }
+      end
+    end
+  end
+end

data/lib/flows/railway/errors.rb

@@ -0,0 +1,21 @@
+module Flows
+  module Railway
+    # rubocop:disable Style/Documentation
+    class NoStepsError < ::Flows::Error
+      def message
+        'No steps defined'
+      end
+    end
+
+    class NoStepImplementationError < ::Flows::Error
+      def initialize(step_name)
+        @step_name = step_name
+      end
+
+      def message
+        "Missing step definition: #{@step_name}"
+      end
+    end
+    # rubocop:enable Style/Documentation
+  end
+end

data/lib/flows/railway/executor.rb

@@ -0,0 +1,23 @@
+module Flows
+  module Railway
+    # Runner for railway steps
+    class Executor
+      include ::Flows::Result::Helpers
+
+      def initialize(flow:, class_name:)
+        @flow = flow
+        @railway_class_name = class_name
+      end
+
+      def call(**params)
+        context = {}
+        last_result = @flow.call(ok(params), context: context)
+
+        last_result.meta[:railway] = @railway_class_name
+        last_result.meta[:last_step] = context[:last_step]
+
+        last_result
+      end
+    end
+  end
+end

data/lib/flows/result.rb

@@ -13,3 +13,4 @@ require_relative 'result/errors'
 require_relative 'result/ok'
 require_relative 'result/err'
 require_relative 'result/helpers'
+require_relative 'result/do'

data/lib/flows/result/do.rb

@@ -0,0 +1,30 @@
+module Flows
+  class Result
+    # Do-notation for Result Objects
+    module Do
+      # DSL for Do-notation
+      module DSL
+        def do_for(method_name)
+          @flows_result_do_module.define_method(method_name) do |*args|
+            super(*args) do |*fields, result|
+              case result
+              when Flows::Result::Ok
+                fields.any? ? result.unwrap.values_at(*fields) : result.unwrap
+              when Flows::Result::Err then return result
+              else raise "Unexpected result: #{result.inspect}. Should be a Flows::Result"
+              end
+            end
+          end
+        end
+      end
+
+      def self.included(mod)
+        patch_mod = Module.new
+
+        mod.instance_variable_set(:@flows_result_do_module, patch_mod)
+        mod.prepend(patch_mod)
+        mod.extend(DSL)
+      end
+    end
+  end
+end

data/lib/flows/result_router.rb

@@ -1,6 +1,6 @@
 module Flows
   # Node router for simple case when result must be a `Flows::Result`
-  # and we don't care about resukt status key
+  # and we don't care about result status key
   class ResultRouter
     def initialize(success_route, failure_route)
       @success_route = success_route

data/lib/flows/version.rb

@@ -1,3 +1,3 @@
 module Flows
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.2.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flows
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Roman Kolesnev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-05 00:00:00.000000000 Z
+date: 2019-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: forspell
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.8
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-md
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
@@ -213,11 +241,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/build.yml"
 - ".gitignore"
+- ".mdlrc"
 - ".rspec"
 - ".rubocop.yml"
 - ".ruby-version"
-- ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -231,7 +260,28 @@ files:
 - bin/profile_10steps
 - bin/ruby_benchmarks
 - bin/setup
+- docs/.nojekyll
+- docs/CNAME
+- docs/README.md
+- docs/_sidebar.md
+- docs/contributing/benchmarks_profiling.md
+- docs/contributing/local_development.md
+- docs/flow/direct_usage.md
+- docs/flow/general_idea.md
+- docs/index.html
+- docs/operation/basic_usage.md
+- docs/operation/inject_steps.md
+- docs/operation/lambda_steps.md
+- docs/operation/result_shapes.md
+- docs/operation/routing_tracks.md
+- docs/operation/wrapping_steps.md
+- docs/overview/performance.md
+- docs/railway/basic_usage.md
+- docs/result_objects/basic_usage.md
+- docs/result_objects/do_notation.md
 - flows.gemspec
+- forspell.dict
+- lefthook.yml
 - lib/flows.rb
 - lib/flows/flow.rb
 - lib/flows/node.rb
@@ -241,7 +291,13 @@ files:
 - lib/flows/operation/dsl.rb
 - lib/flows/operation/errors.rb
 - lib/flows/operation/executor.rb
+- lib/flows/railway.rb
+- lib/flows/railway/builder.rb
+- lib/flows/railway/dsl.rb
+- lib/flows/railway/errors.rb
+- lib/flows/railway/executor.rb
 - lib/flows/result.rb
+- lib/flows/result/do.rb
 - lib/flows/result/err.rb
 - lib/flows/result/errors.rb
 - lib/flows/result/helpers.rb

data/.travis.yml

@@ -1,8 +0,0 @@
----
-sudo: false
-language: ruby
-cache: bundler
-rvm:
-  - 2.6.3
-  - 2.5.5
-before_install: gem install bundler -v 2.0.1