ni 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 265a1f7cc75012e97066f5653b33bc25b77e7abc0d60fa4b626e295b81654048
-  data.tar.gz: 26c58567835dcefddbb834ba7269203af72e19125dcf9df2b4d2bcf47b7a4dfc
+  metadata.gz: 2722909d396c8ab5b69d6eaeff89bd86e2f9348ed9cb0ce13c2e13b08cb12156
+  data.tar.gz: ab92b5e571b2863ffeff1e184157c1b51f29798daec0b41b8aff6bb83d99c619
 SHA512:
-  metadata.gz: 14d145ecad87c1260831277f089a9c1fb2c9a92876e332e3a8cd88e217d11ea2b758e6df9f186b110d4efb93d3233ad58aa70082b1750e485db060e7f6a524c8
-  data.tar.gz: 1e57c0a420648e1be62661d7be739fc448d9f8b02cff146438defdd8de1d0e36a5c9da56f9fa1acccac7df84c86667405dbfe32fac299d6aa69b05d55ea5b450
+  metadata.gz: e9983ebf7e41b12bb13ed3eb5b1572f8f4252c2f5b9cc36841fce42d8211eae378575830cc6af37c500581cb026adfd2af6627bcddd2b6096c3f0536a988dfde
+  data.tar.gz: 604430e4558babccf76befc9d164724ddac2901e65cf5c091b378f5a22940a51d2f4cae68dedc79f3c9fd18448bdd78868c4991592d7c50e5b1feff60c61eacc

data/Gemfile.lock

@@ -0,0 +1,189 @@
+PATH
+  remote: .
+  specs:
+    ni (0.1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (6.0.0)
+      actionpack (= 6.0.0)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (6.0.0)
+      actionpack (= 6.0.0)
+      activejob (= 6.0.0)
+      activerecord (= 6.0.0)
+      activestorage (= 6.0.0)
+      activesupport (= 6.0.0)
+      mail (>= 2.7.1)
+    actionmailer (6.0.0)
+      actionpack (= 6.0.0)
+      actionview (= 6.0.0)
+      activejob (= 6.0.0)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (6.0.0)
+      actionview (= 6.0.0)
+      activesupport (= 6.0.0)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (6.0.0)
+      actionpack (= 6.0.0)
+      activerecord (= 6.0.0)
+      activestorage (= 6.0.0)
+      activesupport (= 6.0.0)
+      nokogiri (>= 1.8.5)
+    actionview (6.0.0)
+      activesupport (= 6.0.0)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (6.0.0)
+      activesupport (= 6.0.0)
+      globalid (>= 0.3.6)
+    activemodel (6.0.0)
+      activesupport (= 6.0.0)
+    activerecord (6.0.0)
+      activemodel (= 6.0.0)
+      activesupport (= 6.0.0)
+    activestorage (6.0.0)
+      actionpack (= 6.0.0)
+      activejob (= 6.0.0)
+      activerecord (= 6.0.0)
+      marcel (~> 0.3.1)
+    activesupport (6.0.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.1, >= 2.1.8)
+    builder (3.2.3)
+    byebug (11.0.1)
+    coderay (1.1.2)
+    concurrent-ruby (1.1.5)
+    crass (1.0.4)
+    database_cleaner (1.7.0)
+    diff-lcs (1.3)
+    docile (1.3.2)
+    erubi (1.8.0)
+    globalid (0.4.2)
+      activesupport (>= 4.2.0)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    json (2.2.0)
+    loofah (2.2.3)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (0.3.3)
+      mimemagic (~> 0.3.2)
+    method_source (0.9.2)
+    mimemagic (0.3.3)
+    mini_mime (1.0.2)
+    mini_portile2 (2.4.0)
+    minitest (5.11.3)
+    nio4r (2.5.1)
+    nokogiri (1.10.4)
+      mini_portile2 (~> 2.4.0)
+    pg (1.1.4)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rack (2.0.7)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (6.0.0)
+      actioncable (= 6.0.0)
+      actionmailbox (= 6.0.0)
+      actionmailer (= 6.0.0)
+      actionpack (= 6.0.0)
+      actiontext (= 6.0.0)
+      actionview (= 6.0.0)
+      activejob (= 6.0.0)
+      activemodel (= 6.0.0)
+      activerecord (= 6.0.0)
+      activestorage (= 6.0.0)
+      activesupport (= 6.0.0)
+      bundler (>= 1.3.0)
+      railties (= 6.0.0)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-dummy (0.1.0)
+      railties
+    rails-html-sanitizer (1.2.0)
+      loofah (~> 2.2, >= 2.2.2)
+    railties (6.0.0)
+      actionpack (= 6.0.0)
+      activesupport (= 6.0.0)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.20.3, < 2.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-rails (3.8.2)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+    simplecov (0.17.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    sprockets (3.7.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.1)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    thor (0.20.3)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    websocket-driver (0.7.1)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.4)
+    zeitwerk (2.1.10)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  byebug
+  database_cleaner
+  ni!
+  pg
+  pry
+  rails
+  rails-dummy
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rspec-rails
+  simplecov
+
+BUNDLED WITH
+   1.17.3

data/lib/ni/action_chain.rb

@@ -0,0 +1,140 @@
+module Ni
+  class ActionChain
+    attr_accessor :name, :description, :received_values, :returned_values, :units, :failure_callback, :rescues
+
+    def initialize(klass, name, description, &block)
+      @interactor_klass = klass
+      @name = name, @description = description
+      @units = block_given? ? [block.to_proc] : []
+      @failure_callback = nil
+      @rescues = []
+      @returned_values = []
+
+      self
+    ensure
+      update_chain
+    end
+
+    # Params methods
+
+    def receive(*args)
+      @received_values = args
+
+      self
+    ensure
+      update_chain
+    end
+
+    def provide(*args)
+      @returned_values = args
+
+      self
+    ensure
+      update_chain
+    end
+
+    # Flow methods
+
+    def then(*args, **options, &block)
+      if block_given?
+        @units << block.to_proc
+      else
+        @units << chain_builder(args, options)
+      end
+
+      self
+    ensure
+      update_chain
+    end
+
+    def isolate(*args, **options, &block)
+      if block_given?
+        raise 'Not Implemented yet'
+      else
+        first, last = args
+        @units << Ni::Flows::IsolatedInlineInteractor.new(first, (last || :perform), options)
+      end
+
+      self
+    ensure
+      update_chain
+    end
+
+    def failure(&block)
+      @failure_callback = block.to_proc
+
+      self
+    ensure
+      update_chain
+    end
+
+    def rescue_from(*args, &block)
+      args = [Exception] if args.empty?
+
+      @rescues << [args, block.to_proc]
+
+      self
+    ensure
+      update_chain
+    end
+
+    def wait_for(condition, options={})
+      @units << Ni::Flows::WaitForCondition.new(condition, @interactor_klass, options)
+
+      self
+    ensure
+      update_chain  
+    end  
+
+    def branch(*args, **options, &block)
+      @units << Ni::Flows::BranchInteractor.new(@interactor_klass, args, options, &block)
+
+      self
+    ensure
+      update_chain
+    end
+
+    def terminate!
+      @units << "context.terminate!"
+    ensure  
+      update_chain
+    end
+
+    def cancel!
+      @units << "context.cancel!"
+    ensure  
+      update_chain
+    end
+
+    def failure!
+      @units << "context.failure!"
+    ensure  
+      update_chain
+    end
+
+    def success!
+      @units << "context.success!"
+    ensure  
+      update_chain
+    end
+
+    private
+
+    def chain_builder(args, options)
+      first, last = args
+
+      case first
+      when Symbol, String
+        first
+      when Class
+        Ni::Flows::InlineInteractor.new(first, (last || :perform), options)
+      else
+        raise 'Invalid chain options'
+      end
+    end
+
+    def update_chain
+      @interactor_klass.defined_actions[name] = self
+    end
+  end
+end

data/lib/ni/context.rb

@@ -0,0 +1,217 @@
+module Ni
+  class Context
+    class Errors
+      include Enumerable
+
+      delegate :each, :empty?, :present?, :blank?, to: '@errors'
+
+      def initialize
+        @errors = {}
+      end
+
+      def add(key, message)
+        @errors[key] ||= []
+        @errors[key] << message
+      end
+
+      def []=(key, message)
+        @errors[key] ||= []
+        @errors[key] << message
+      end
+
+      def full_messages
+        @errors.values.flatten
+      end
+
+      def to_h
+        @errors
+      end
+
+      def to_json
+        to_h.to_json
+      end
+    end
+
+    attr_accessor :current_interactor, :current_action, :errors
+    attr_accessor :as_result, :system_uid, :continue_from, :external_system_uid
+    attr_accessor :halt_execution, :skip_the_rest_chain
+
+    delegate :each, :slice, to: '@data'
+
+    def initialize(interactor, action, system_uid = nil)
+      self.external_system_uid = system_uid
+      self.system_uid = system_uid || SecureRandom.hex(15)
+      self.current_interactor = interactor
+      self.current_action = action
+      self.errors = Errors.new
+      self.as_result = false
+      @data = {}
+      @success = true
+      @terminated = false
+    end
+
+    def success?
+      @success && valid?
+    end 
+
+    def failed?
+      !@success || !valid?
+    end
+
+    def canceled?
+      !@success && valid?
+    end
+
+    def terminated?
+      @terminated
+    end
+
+    def failure!
+      @success = false
+    end
+
+    def cancel!
+      @success = false
+    end
+
+    def can_perform_next_step?
+      success? && !terminated?
+    end
+
+    def success!
+      @terminated = true
+    end
+
+    def terminate!
+      @success = false
+      @terminated = true
+    end  
+
+    def assign_data!(params)
+      @data.merge!(params)
+    end
+
+    def assign_current_interactor!(interactor)
+      self.current_interactor = interactor
+    end
+
+    def continue_from!(name_or_interactor)
+      name = name_or_interactor.is_a?(Class) ? name_or_interactor.interactor_id! : name_or_interactor
+      self.continue_from = name
+    end  
+
+    def halt_execution!
+      self.halt_execution = true
+    end
+
+    def execution_halted?
+      halt_execution.present?
+    end
+
+    def skip_the_rest_chain!
+      self.skip_the_rest_chain = true
+    end
+
+    def chain_skipped?
+      skip_the_rest_chain.present?
+    ensure
+      # I now it's a bad Idea to mutate state in predicates but this operation should be atomic
+      self.skip_the_rest_chain = false 
+    end
+
+    def wait_completed!
+      self.continue_from = nil
+    end
+
+    def wait_for_execution?
+      continue_from.present?
+    end
+
+    def should_be_restored?
+      wait_for_execution? || self.external_system_uid.present?
+    end
+
+    def resultify!
+      self.as_result = true
+
+      self
+    end
+
+    def within_interactor(interactor, action)
+      stored_interactor = self.current_interactor
+      stored_action = self.current_action
+
+      self.current_interactor = interactor
+      self.current_action = action
+
+      result = yield
+
+      self.current_interactor = stored_interactor
+      self.current_action = stored_action
+
+      result
+    end
+
+    def [](name)
+      unless allow_to_read?(name)
+        raise "The `#{name}` is not allowed to read"
+      end
+
+      raw_get(name)
+    end
+
+    def []=(name, value)
+      unless allow_to_write?(name)
+        raise "The `#{name}` is not allowed to write"
+      end
+
+      raw_set(name, value)
+    end
+
+    # raw_get was defined only for internal purposes only. Please do not use it in your code
+    def raw_get(name)
+      @data[name.to_sym]
+    end
+
+    # raw_set was defined only for internal purposes only. Please do not use it in your code
+    def raw_set(name, value)
+      @data[name.to_sym] = value
+    end
+
+    def respond_to?(name, include_private=false)
+      super || has_key?(name)
+    end
+
+    def has_key?(name)
+      @data.has_key?(name.to_sym)
+    end
+
+    def valid?
+      errors.empty?
+    end
+
+    def invalid?
+      !valid?
+    end
+
+    def fetch(*args)
+      args.map { |name| self[name] }
+    end
+
+    def allow_to_read?(name)
+      as_result || self.current_interactor.allow_to_read?(self.current_action, name)
+    end
+
+    def allow_to_write?(name)
+      as_result || self.current_interactor.allow_to_write?(self.current_action, name)
+    end
+
+    def method_missing(name, *args, &block)
+      if name.to_s.ends_with?('=')
+        self[name[0..-2].to_sym] = args.first
+      else
+        self[name]
+      end
+    end
+  end
+end