caixanegra 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4296a7a3ef7cd55657a83b6fd6f4cf9389c8ba731a539191a6e6c16e853b6848
-  data.tar.gz: 8805ae26d4cbb6a37c98a22b5fba5b11a3f14a88de9fa685d313bfc58d22e4ed
+  metadata.gz: c291dfc1c33d2c17e87093eff1bceff3c061ef8c7230a561ace088cd9e23f279
+  data.tar.gz: e812c3f4c1d202902f926115162c0b9b46885b35af56db52db3aa94ab8e53ac8
 SHA512:
-  metadata.gz: c866e8d7614824e7a82bd8fe26dc0a434be293a6e317142169724c24a00f5c60b7e4ff804836053a0f75a865f6df1943464ae5c5dbfad8c2500ce31ea820b306
-  data.tar.gz: 0d12dc642122961304bb47ec2840560e6da603f83c575b8e3e0604e5527743a54ce43c950ca372763018658da8f9a9ba2a06e88da6a31bb62bb18e45e128e7e3
+  metadata.gz: c6276bd14d36c832729b8a717a15ad5a8c6b9e6223343d6169fa1c153dc0389d0d0ef73ed61b0eb4f19a9dfc1936683b59b80e994b740df4cc670958fbc21833
+  data.tar.gz: 70059940599beff0f5cf09bbb73defa53fc31e336166a15a0262902f194862cd318b5bb8fb7bcb22a7934960411c7dce14f997816a0430fc943ba6d0dceddb88

data/README.md

@@ -51,7 +51,7 @@ uid = Caixanegra::Manager.handler(my_flow || {})
 You can then safely navigate to the designer.
 
 ```ruby
-link_to "Some flow", "/caixanegra/design/#{@uid}?unit_scope=optional_scope", target: :blank
+link_to "Some flow", "/caixanegra/design/#{@uid}?unit_scope=optional_scope,another_optional_scope", target: :_blank
 ```
 
 Saved changes will update the flow definition on Redis, and you must then persist them. You can get the flow definition for any specified **caixanegra** handled UID:
@@ -63,7 +63,7 @@ persist_flow(updated_flow) # your own persistence or transport solution. It's a
 
 **NOTE:** There's currently no managed way to set callbacks on save actions from the designer. Working on it
 
-Please, refer to [the wiki](https://github.com/sergiorribeiro/caixanegra/wiki) to get to know more about [creating your units](https://github.com/sergiorribeiro/caixanegra/wiki/Creating-units).
+Please, refer to [the wiki](https://github.com/sergiorribeiro/caixanegra/wiki) to get to know more about [units](https://github.com/sergiorribeiro/caixanegra/wiki/Anatomy-of-a-unit).
 
 # License
 **caixanegra** is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/app/assets/javascripts/caixanegra/designer.js

@@ -166,9 +166,9 @@ window.Caixanegra.Designer = {
             ctx.beginPath();
             ctx.moveTo(this.#drawValues.position.x + this.size.x, exit.markerY);
             ctx.lineTo(this.#drawValues.position.x + this.size.x + 25, exit.markerY);
-            
+
             if (this.connectingExit === exit && context.mouse.move) {
-              ctx.lineTo(context.mouse.move.x, context.mouse.move.y);
+              ctx.lineTo(context.mouse.move.x + context.referential.x, context.mouse.move.y + context.referential.y);
             } else if (exit.reference.target) {
               const targetCenter = exit.reference.target.getCenter(context.referential);
               ctx.lineTo(targetCenter.x, targetCenter.y);
@@ -382,10 +382,10 @@ window.Caixanegra.Designer = {
     }
 
     deleteUnit() {
-      this.removeUnit(this.selectedUnit.oid);
-      this.toggleDeleteConfirmation();
       this.unitDetailPane.classList.remove("-open");
       this.unitDebugHitsPane.classList.remove("-open");
+      this.removeUnit(this.selectedUnit.oid);
+      this.toggleDeleteConfirmation();
     }
 
     flushToConsole(entries) {
@@ -522,33 +522,63 @@ window.Caixanegra.Designer = {
         this.#catalog = response;
         const unitMenu = document.querySelector("#unitMenu");
         unitMenu.innerHTML = "";
-        this.#catalog.forEach((unitData) => {
-          const item = document.createElement("div");
-          const content = document.createElement("div");
-          const colorCode = document.createElement("div");
-          const header = document.createElement("div");
-          const name = document.createElement("span");
-          const type = document.createElement("span");
-          const description = document.createElement("div");
-          description.classList.add("description");
-          item.classList.add("unit");
-          header.classList.add("header");
-          content.classList.add("content");
-          colorCode.classList.add("color-code");
-          name.classList.add("name");
-          type.classList.add("type");
-
-          name.innerHTML = unitData.title;
-          type.innerHTML = unitData.type;
-          description.innerHTML = unitData.description;
-          colorCode.style.backgroundColor = Caixanegra.Designer.typeColor(unitData.type);
-
-          header.append(name, type);
-          content.append(header, description);
-          item.append(colorCode, content);
-          item.addEventListener("click", this.createUnit.bind(this, unitData));
-          unitMenu.appendChild(item);
+
+        const scopes = [];
+        
+        this.#catalog.forEach(unit => {
+          if (unit.hasOwnProperty("scope") && Array.isArray(unit.scope)) {
+            scopes.push(...unit.scope);
+          } else {
+            scopes.push("_unscoped");
+          }
+        });
+        
+        [...new Set(scopes)].sort().forEach(scope => {
+          const scopeWrapper = document.createElement("div");
+          const scopeTitle = document.createElement("div");
+          const scopeUnits = document.createElement("div");
+
+          scopeWrapper.classList.add("unit-wrapper");
+          scopeTitle.classList.add("title");
+
+          scopeTitle.innerHTML = scope === "_unscoped" ? "unscoped" : scope.replace(/_/g, " ");
+          scopeWrapper.appendChild(scopeTitle);
+          scopeWrapper.appendChild(scopeUnits);
+
+          const filteredUnits = this.#catalog.filter(unit => {
+            return (unit.scope === null && scope === "_unscoped") || (unit.scope || []).includes(scope)
+          });
+
+          filteredUnits.forEach((unitData) => {
+            const item = document.createElement("div");
+            const content = document.createElement("div");
+            const colorCode = document.createElement("div");
+            const header = document.createElement("div");
+            const name = document.createElement("span");
+            const type = document.createElement("span");
+            const description = document.createElement("div");
+            description.classList.add("description");
+            item.classList.add("unit");
+            header.classList.add("header");
+            content.classList.add("content");
+            colorCode.classList.add("color-code");
+            name.classList.add("name");
+            type.classList.add("type");
+  
+            name.innerHTML = unitData.title;
+            type.innerHTML = unitData.type;
+            description.innerHTML = unitData.description;
+            colorCode.style.backgroundColor = Caixanegra.Designer.typeColor(unitData.type);
+  
+            header.append(name, type);
+            content.append(header, description);
+            item.append(colorCode, content);
+            item.addEventListener("click", this.createUnit.bind(this, unitData));
+            scopeUnits.appendChild(item);
+          });
+          unitMenu.appendChild(scopeWrapper);
         });
+
         this.#loadedComponents.catalog = true;
         this.#reveal();
       });

data/app/assets/stylesheets/caixanegra/designer.scss

@@ -119,6 +119,15 @@ $accent-contrast-color: darken($accent-color, 20%);
     transform: translateY(0%);
   }
 
+  .unit-wrapper {
+    .title {
+      font-family: Verdana, Geneva, Tahoma, sans-serif;
+      font-size: 0.7em;
+      color: rgba(0,0,0,.7);
+      margin-bottom: 5px;
+    }
+  }
+
   .unit {
     display: flex;
     flex-direction: row;

data/app/controllers/caixanegra/api/designer/flows_controller.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
 module Caixanegra
-  module API
+  module Api
     module Designer
-      class FlowsController < ::Caixanegra::APIController
+      class FlowsController < ::Caixanegra::ApiController
         before_action :set_flow, only: %i[show debug_run]
 
         def show
@@ -20,7 +20,6 @@ module Caixanegra
           execution = Caixanegra::Executor.new(
             initial_carryover: initial_carryover,
             flow_definition: @flow,
-            unit_scope: params[:unit_scope],
             debug_mode: true
           ).run
 

data/app/controllers/caixanegra/api/designer/units_controller.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
 module Caixanegra
-  module API
+  module Api
     module Designer
-      class UnitsController < ::Caixanegra::APIController
+      class UnitsController < ::Caixanegra::ApiController
         def index
           render json: units
         end
@@ -15,26 +15,21 @@ module Caixanegra
         end
 
         def units
-          @units ||= begin
-            base_units = Caixanegra.units.reject { |_, v| v.is_a? Hash }
-            scope_units = Caixanegra.units[unit_scope] if unit_scope.present?
-            all_units = base_units.merge(scope_units || {})
+          @units ||= ::Caixanegra::UnitHelper.scoped_units(unit_scope).map do |k, v|
+            base = {
+              scope: v.scope,
+              title: v.unit_name,
+              type: v.type,
+              description: v.description,
+              class: k,
+              exits: v.exits&.map { |e| { name: e } },
+              inputs: v.inputs,
+              assignments: v.assignments
+            }
 
-            all_units.map do |k, v|
-              base = {
-                title: v.name,
-                type: v.type,
-                description: v.description,
-                class: k,
-                exits: v.exits&.map { |e| { name: e } },
-                inputs: v.inputs,
-                assignments: v.assignments
-              }
+            base[:set] = v.set if base[:set]
 
-              base[:set] = v.set if base[:set]
-
-              base
-            end
+            base
           end
         end
       end

data/app/controllers/caixanegra/api_controller.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module Caixanegra
-  class APIController < ActionController::API
+  class ApiController < ActionController::API
   end
 end

data/app/models/caixanegra/unit.rb

@@ -36,6 +36,12 @@ module Caixanegra
       }
     end
 
+    def exit_and_return
+      {
+        carry_over: @carry_over
+      }
+    end
+
     def flow
       exit_through exits.first
     end
@@ -64,11 +70,18 @@ module Caixanegra
 
         input_value = result
       end
+
       input_value.presence || @inputs[id][:default]
+    rescue StandardError
+      raise(UnitIOException.new, "Unable to fetch input '#{id}'")
+    end
+
+    def scope
+      self.class.scope
     end
 
-    def name
-      self.class.name
+    def unit_name
+      self.class.unit_name
     end
 
     def description
@@ -99,12 +112,16 @@ module Caixanegra
     end
 
     class << self
-      attr_reader :name, :description, :inputs, :exits, :assignments, :type
+      attr_reader :unit_name, :description, :inputs, :exits, :assignments, :type, :scope
 
       @type = :passthrough
 
+      def configure_scope(value)
+        @scope = value
+      end
+
       def configure_name(value)
-        @name = value
+        @unit_name = value
       end
 
       def configure_description(value)

data/lib/caixanegra/exceptions.rb

@@ -2,4 +2,6 @@
 
 module Caixanegra
   class UnitScopedException < StandardError; end
+  class UnitIOException < StandardError; end
+  class ContinuityException < StandardError; end
 end

data/lib/caixanegra/executor.rb

@@ -5,7 +5,6 @@ module Caixanegra
     def initialize(params)
       @initial_carryover = params[:initial_carryover] || {}
       @flow = (params[:flow_definition] || {}).deep_symbolize_keys
-      @unit_scope = params[:unit_scope]
       @debug_mode = params[:debug_mode] == true
       @execution = { history: [], steps: [] }
       @storage = {}
@@ -113,6 +112,8 @@ module Caixanegra
           raise exception
         end
         next_unit = next_unit(result)
+        raise(ContinuityException.new, "Unable to choose a valid exit") if next_unit.nil?
+
         log_step_result(result, next_unit)
         @execution[:steps] += feeder_steps
         @step_unit = next_unit
@@ -143,11 +144,15 @@ module Caixanegra
     end
 
     def next_unit(result)
+      return nil if result.nil?
+
       exit_name = result[:exit_through]
       metadata = unit_metadata(@step_unit.oid)
-      log_console_entry "Next unit found through '#{exit_name}': '#{@step_unit.oid}'"
       exit_metadata = metadata[:exits].find { |ex| ex[:name] == exit_name.to_s }
-      unit(exit_metadata[:target], map_carry_over(result))
+      next_unit = unit(exit_metadata[:target], map_carry_over(result))
+      log_console_entry "Next unit found through '#{exit_name}': '#{next_unit.oid}'"
+
+      next_unit
     end
 
     def process_feeders
@@ -187,15 +192,13 @@ module Caixanegra
       unit_class = scoped_units[unit_data[:class].to_sym]
       inputs = unit_class.inputs
       unit_class.new(unit_data[:oid], inputs, mappings, carry_over, @storage)
+    rescue
+      log_console_entry "Unable to load unit instance of type '#{unit_data[:class]}'"
+      nil
     end
 
     def scoped_units
-      @scoped_units ||= begin
-        base_units = Caixanegra.units.reject { |_, v| v.is_a? Hash }
-        scope_units = Caixanegra.units[@unit_scope] if @unit_scope.present?
-
-        base_units.merge(scope_units || {})
-      end
+      @scoped_units ||= UnitHelper.all_units
     end
   end
 end

data/lib/caixanegra/unit_helper.rb

@@ -0,0 +1,28 @@
+module Caixanegra
+  class UnitHelper
+    class << self
+      def scoped_units(scope)
+        units = {}
+
+        scopes = (scope || "").split(",").map(&:to_sym)
+        Caixanegra.units.each do |unit|
+          if unit.scope.nil? || unit.scope.any? { |checking_scope| scopes.include?(checking_scope) }
+            units[unit.name.demodulize.underscore.to_sym] = unit
+          end
+        end
+
+        units
+      end
+
+      def all_units
+        units = {}
+
+        Caixanegra.units.each do |unit|
+          units[unit.name.demodulize.underscore.to_sym] = unit
+        end
+
+        units
+      end
+    end
+  end
+end

data/lib/caixanegra/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Caixanegra
-  VERSION = '0.1.1'
+  VERSION = '0.2.0'
 end

data/lib/caixanegra.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'caixanegra/exceptions'
+require 'caixanegra/unit_helper'
 require 'caixanegra/engine'
 require 'caixanegra/version'
 require 'caixanegra/executor'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: caixanegra
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - sergiorribeiro
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-30 00:00:00.000000000 Z
+date: 2023-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -61,7 +61,6 @@ files:
 - app/controllers/caixanegra/api_controller.rb
 - app/controllers/caixanegra/application_controller.rb
 - app/controllers/caixanegra/designer_controller.rb
-- app/helpers/caixanegra/application_helper.rb
 - app/models/caixanegra/unit.rb
 - app/views/caixanegra/designer/index.html.erb
 - app/views/layouts/caixanegra/application.html.erb
@@ -72,6 +71,7 @@ files:
 - lib/caixanegra/exceptions.rb
 - lib/caixanegra/executor.rb
 - lib/caixanegra/manager.rb
+- lib/caixanegra/unit_helper.rb
 - lib/caixanegra/version.rb
 - lib/tasks/caixanegra_tasks.rake
 homepage: https://github.com/sergiorribeiro/caixanegra/wiki
@@ -86,7 +86,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.7.5
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/app/helpers/caixanegra/application_helper.rb

@@ -1,4 +0,0 @@
-module Caixanegra
-  module ApplicationHelper
-  end
-end