ruflow 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 653e7c74352a1d446f5165fcc8b395313509ffc54849569c2781694674334d44
-  data.tar.gz: ead4a34b446afb8c18c051f79c9a9abb6f56046d67bcc36f1970bb01fabdc79a
+  metadata.gz: fdeec6d4a796f5db914c0eee7f5665936416c281574b6a6f3a53dbe0ac15d8c3
+  data.tar.gz: c7598cdfb3279daa47abcc32b7f88e6e95f2295f506512727de8f3393eb4686b
 SHA512:
-  metadata.gz: 101a6e4790dd995c1b68f945951cd39fc364df78b8f22d7133d28990feca9313f3c91bae94e33e32efbeb08616f32eb58d957dee7dbdbd92c1a966288f9763b2
-  data.tar.gz: ed7d81de354fc7253d78bfb20139edcecc21fe1cf0b92ed255e5144450e8ee7010b75e0fee9dfaf0545a3c8c0ad676811ce78a09232276d933728602e24a3c63
+  metadata.gz: 802e1ff8608bf668d8a8ee6a6d6ad7dd4a612c5a85a91dcbcea03f1ac2b7e773390d1b38799cd0b70f84dc754699969aac843f4730b54186159ffa5a3bff09e8
+  data.tar.gz: cc8ff7550c3f232cb1d33519f98fd4a673a5c97fb01aa6963be2caea6238c0d3cf43939cd1adc0d379ef580c2a77e36877627a6fdcf1f70fdeec211e3f14d8d2

data/.gitignore

@@ -13,4 +13,5 @@
 .ruby-gemset
 .ruby-version
 Gemfile.lock
-/spec/dumb
+/spec/dumb
+.byebug_history

data/lib/ruflow.rb

@@ -1,5 +1,16 @@
-require "ruflow/version"
 require "configurations"
+require 'require_all'
+
+require "ruflow/version"
+require "ruflow/type_checker"
+require "ruflow/action"
+require "ruflow/flow"
+
+require "ruflow/error/bad_return"
+require "ruflow/error/mismatch_input_type"
+require "ruflow/error/mismatch_output_type"
+require "ruflow/error/mismatch_output_input_type"
+require "ruflow/error/output_port_not_defined"
 
 module Ruflow
   include Configurations
@@ -13,6 +24,9 @@ module Ruflow
 
     def setup(&block)
       Ruflow.configure(&block)
+
+      autoload_all "#{Dir.pwd}/#{config.components_folder}/actions"
+      autoload_all "#{Dir.pwd}/#{config.components_folder}/flows"
     end
   end
 end

data/lib/ruflow/action.rb

@@ -0,0 +1,92 @@
+module Ruflow
+  class Action
+    class << self
+      attr_accessor :options
+
+      alias_method :set_options, :options=
+
+      def change_options(_options = {})
+        self.options = options.merge(_options)
+      end
+
+      def with_custom_options(_options = {})
+        klass = self.clone
+        klass.change_options(_options)
+        klass
+      end
+
+      def start(param = nil)
+        _param = param.nil? ? options[:default_input] : param
+
+        type_check_input!(_param, input_type)
+        output_port_and_value = self.new.start(_param)
+
+        check_return!(output_port_and_value)
+
+        output_port, value = output_port_and_value
+
+        check_output_port_is_defined!(output_port)
+
+        output_type = options[:output][output_port]
+
+        type_check_output!(value, output_type)
+
+        [output_port, value]
+      end
+
+      def input_type
+        options[:input]
+      end
+
+      def options
+        @options || ::Ruflow::Action.options
+      end
+
+      private
+
+      def type_check_input!(value, input_type)
+        if TypeChecker.is_invalid?(value, type: input_type)
+          raise Error::MismatchInputType.new(value, input_type)
+        end
+      end
+
+      def check_return!(return_value)
+        if return_value.class != Array || return_value.first.class != Symbol
+          raise Error::BadReturn.new(return_value)
+        end
+      end
+
+      def check_output_port_is_defined!(output_port)
+        _output_port = options[:output][output_port]
+
+        if _output_port.nil? || _output_port.empty?
+          raise Error::OutputPortNotDefined.new(_output_port)
+        end
+      end
+
+      def type_check_output!(value, output_type)
+        if TypeChecker.is_invalid?(value, type: output_type)
+          raise Error::MismatchOutputType.new(value, output_type)
+        end
+      end
+    end
+
+    set_options(
+      default_input: nil,
+      input:  '*',
+      output: {
+        ok: '*'
+      }
+    )
+
+    def start(value = nil)
+      raise NotImplementedError, 'Overwrite instance method start'
+    end
+
+    protected
+
+    def options
+      self.class.options
+    end
+  end
+end

data/lib/ruflow/error/bad_return.rb

@@ -0,0 +1,9 @@
+module Ruflow
+  module Error
+    class BadReturn < StandardError
+      def initialize(return_value)
+        super("Expected start to return [:<<output_port>>, <<value>>], but returned #{return_value}")
+      end
+    end
+  end
+end

data/lib/ruflow/error/mismatch_input_type.rb

@@ -0,0 +1,9 @@
+module Ruflow
+  module Error
+    class MismatchInputType < StandardError
+      def initialize(value, expect_type)
+        super("Expected INPUT as #{expect_type}, but received #{value.class}")
+      end
+    end
+  end
+end

data/lib/ruflow/error/mismatch_output_input_type.rb

@@ -0,0 +1,19 @@
+module Ruflow
+  module Error
+    class MismatchOutputInputType < StandardError
+      attr_reader :errors
+      
+      def initialize(errors, msg="Mismatches found in: ")
+        @errors = Array(errors)
+        super(msg + format_errors)
+      end
+
+      private
+
+      def format_errors
+        @errors.map { |e| "ACTION_ID=#{e[:from_action_id]} to ACTION_ID=#{e[:to_action_id]} mismatch type on port #{e[:port]} (#{e[:from]} to #{e[:to]})" }
+               .join(', ')
+      end
+    end
+  end
+end

data/lib/ruflow/error/mismatch_output_type.rb

@@ -0,0 +1,9 @@
+module Ruflow
+  module Error
+    class MismatchOutputType < StandardError
+      def initialize(value, expect_type)
+        super("Expected OUTPUT to be a #{expect_type}, but was #{value.class}")
+      end
+    end
+  end
+end

data/lib/ruflow/error/output_port_not_defined.rb

@@ -0,0 +1,9 @@
+module Ruflow
+  module Error
+    class OutputPortNotDefined < StandardError
+      def initialize(return_value)
+        super("Expected start method to return [:<<output_port>>, <<value>>], but returned #{return_value}")
+      end
+    end
+  end
+end

data/lib/ruflow/flow.rb

@@ -0,0 +1,75 @@
+module Ruflow
+  class Flow < Action
+
+    def start(param)
+      action = self.class.start_action
+      value  = param
+
+      while action[:output_to]
+        output_port, value = action[:klass].start(value)
+
+        action = self.class.actions[action[:output_to][output_port]]
+      end
+
+      action[:klass].start(value)
+    end
+
+    class << self
+      attr_accessor :actions, :start_action_id
+
+      alias_method :set_actions,         :actions=
+      alias_method :set_start_action_id, :start_action_id=
+
+      def check_actions!
+        raise NotImplementedError, 'actions must be defined using set_actions({})' if actions.nil?
+
+        raise NotImplementedError, 'start_action_id must be defined using set_start_action_id(Integer)' if start_action_id.nil?
+
+        raise NotImplementedError, 'actions must be a Hash'  if not(actions.is_a?(Hash))
+
+        raise NotImplementedError, 'start_action not found, change the start_action_id' if start_action.nil?
+
+        if (actions_with_error = actions_without_klass).any?
+          raise NotImplementedError, "actions id=#{actions_with_error.keys.join(', ')} must have value as a Hash and define a 'klass:' key"
+        end
+
+        if (actions_with_error = actions_mismatch_output_input_type).any?
+          raise Error::MismatchOutputInputType.new(actions_with_error)
+        end
+      end
+
+      def start
+        check_actions!
+        super(nil)
+      end
+
+      def start_action
+        actions[start_action_id]
+      end
+
+      private
+
+      def actions_without_klass
+        actions.select { |_, a| not(a.is_a?(Hash)) || a[:klass].nil? }
+      end
+
+      def actions_with_output_to
+        actions.select { |_, a| a[:output_to] }
+      end
+
+      def actions_mismatch_output_input_type
+        actions_with_output_to.map do |action_id, action|
+
+          action[:output_to].map do |port, next_action_id|
+            action_input_type  = actions[next_action_id][:klass].options[:input]
+            action_output_type = action[:klass].options[:output][port]
+
+            if TypeChecker.incompatible_types?(action_input_type, action_output_type)
+              {from_action_id: action_id, to_action_id: next_action_id, from: action_output_type, to: action_input_type, port: port}
+            end
+          end
+        end.flatten.compact
+      end
+    end
+  end
+end

data/lib/ruflow/tasks/base.rb

@@ -1,14 +1,27 @@
 require_relative 'setup'
+require_relative '../../ruflow'
 
 module Ruflow
   module Tasks
     class Base < Thor
-      desc "new  [PROJECT_NAME]", "generate a new project"
+      desc "new  [PROJECT_NAME]", "Generate a new project"
       def new(project_name)
         Ruflow::Tasks::Setup.start([project_name])
       end
 
-      desc "setup", "generate all files and folder required"
+      desc "start [FLOW_CLASS_NAME]", "Start a flow"
+      def start(flow_klass_name)
+        _file_path = "#{Dir.pwd}/ruflow_config"
+
+        if File.exist?("#{_file_path}.rb")
+          require _file_path
+          Kernel.const_get(flow_klass_name).start
+        else
+          puts "ruflow_config.rb not found on #{Dir.pwd}"
+        end
+      end
+
+      desc "setup", "Generate all files and folder required"
       def setup
         Ruflow::Tasks::Setup.start(['.'])
       end

data/lib/ruflow/type_checker.rb

@@ -0,0 +1,33 @@
+module Ruflow
+  module TypeChecker
+    def self.incompatible_types?(type, compare_type)
+      !compatible_types?(type, compare_type)
+    end
+
+    def self.compatible_types?(type, compare_type)
+      return true if compare_type.include? '*'
+
+      compare_types = compare_type.split('|')
+
+      type.split('|').any? { |t| compare_types.include?(t) }
+    end
+
+    def self.is_invalid?(value, type:)
+      !is_valid?(value, type: type)
+    end
+
+    def self.is_valid?(value, type:)
+      return true if type.include? '*'
+
+      types = type.split('|').map { |t| get_constant(t) }.flatten
+
+      types.any? { |t| value.is_a?(t) }
+    end
+
+    private
+
+    def self.get_constant(type)
+      type == 'Boolean' ? [TrueClass, FalseClass] : [Kernel.const_get(type)]
+    end
+  end
+end

data/lib/ruflow/version.rb

@@ -1,3 +1,3 @@
 module Ruflow
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/ruflow.gemspec

@@ -21,9 +21,11 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "configurations", "~> 2.2.0"
-  spec.add_dependency "thor", "~> 0.20.0"
+  spec.add_dependency "thor",           "~> 0.20.0"
+  spec.add_dependency "require_all",    "~> 1.5.0"
 
   spec.add_development_dependency "bundler", "~> 1.16"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "byebug"
 end

data/setup_files/components/actions/printer.rb

@@ -0,0 +1,21 @@
+module Actions
+  class Printer < ::Ruflow::Action
+    set_options(
+      default_input: '',
+      input: 'String',
+      output: {
+        ok: 'String'
+      }
+    )
+
+    def self.with_custom_options(can_print:, text:)
+      super(can_print: can_print, text: text)
+    end
+
+    def start(text)
+      puts text if options[:can_print]
+
+      [:ok, text + options[:text]]
+    end
+  end
+end

data/setup_files/components/flows/hello_world.rb

@@ -0,0 +1,12 @@
+module Flows
+  class HelloWorld < ::Ruflow::Flow
+    set_actions({
+      1 => { klass: ::Actions::Printer.with_custom_options(can_print: false, text: 'Hello'), output_to: { ok: 2 } },
+      2 => { klass: ::Actions::Printer.with_custom_options(can_print: false, text: 'Hello'), output_to: { ok: 3 } },
+      3 => { klass: ::Actions::Printer.with_custom_options(can_print: false, text: 'Again'), output_to: { ok: 4 } },
+      4 => { klass: ::Actions::Printer.with_custom_options(can_print: true,  text: 'World') }
+    })
+
+    set_start_action_id(1)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruflow
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - victor95pc
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-08 00:00:00.000000000 Z
+date: 2018-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: configurations
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.20.0
+- !ruby/object:Gem::Dependency
+  name: require_all
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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'
 description: Framework to create flow-based programs using Ruby.
 email:
 - victorpalomocastro@gmail.com
@@ -108,12 +136,22 @@ files:
 - bin/thor
 - exe/ruflow
 - lib/ruflow.rb
+- lib/ruflow/action.rb
+- lib/ruflow/error/bad_return.rb
+- lib/ruflow/error/mismatch_input_type.rb
+- lib/ruflow/error/mismatch_output_input_type.rb
+- lib/ruflow/error/mismatch_output_type.rb
+- lib/ruflow/error/output_port_not_defined.rb
+- lib/ruflow/flow.rb
 - lib/ruflow/tasks/base.rb
 - lib/ruflow/tasks/setup.rb
+- lib/ruflow/type_checker.rb
 - lib/ruflow/version.rb
 - ruflow.gemspec
 - setup_files/Gemfile
 - setup_files/components/.gitkeep
+- setup_files/components/actions/printer.rb
+- setup_files/components/flows/hello_world.rb
 - setup_files/ruflow_config.rb
 homepage: https://github.com/victor95pc/ruflow
 licenses: []