caixanegra 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd21dec4c184b88b2898d5f011eb9e7288562c28f2204db0a6e85cca004153de
-  data.tar.gz: 49b39b216ac37609aa921ece85a263de64a7e932082d80761388e41d5c5eaf3d
+  metadata.gz: 4296a7a3ef7cd55657a83b6fd6f4cf9389c8ba731a539191a6e6c16e853b6848
+  data.tar.gz: 8805ae26d4cbb6a37c98a22b5fba5b11a3f14a88de9fa685d313bfc58d22e4ed
 SHA512:
-  metadata.gz: 8dcad855ae35dc5241379f3f4acc574ec4b0204877cea2d8770a08cf9774ffe7257f0a873ac0e067048ea432ee4c2689c94afea393aecd94942764b42ea67e06
-  data.tar.gz: a636a4d03ab305b54464f2003488fdb21f756f3876f4899da6b026b53e6f3326a4909a860ec7cb3390eecb68530e9070c44ed794a9fa484fbf25dbd35411d424
+  metadata.gz: c866e8d7614824e7a82bd8fe26dc0a434be293a6e317142169724c24a00f5c60b7e4ff804836053a0f75a865f6df1943464ae5c5dbfad8c2500ce31ea820b306
+  data.tar.gz: 0d12dc642122961304bb47ec2840560e6da603f83c575b8e3e0604e5527743a54ce43c950ca372763018658da8f9a9ba2a06e88da6a31bb62bb18e45e128e7e3

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2021 sergiorribeiro
+Copyright 2023 sergiorribeiro
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,18 +1,69 @@
 # caixanegra
 ![Gem](https://img.shields.io/gem/v/caixanegra?logo=ruby&logoColor=red)
 
-## Getting Started
+An unopinionated flow oriented blackbox designer, executor and debugger to interface your service classes and allow users to manipulate or completely redesign processes using your code.
 
+# Installation
+Add this line to your application's Gemfile:
 
+```ruby
+gem 'caixanegra'
+```
 
+or 
 
+```
+bundler add caixanegra
+```
+# Getting Started
+**caixanegra** implements a self-contained designer, which only requires Redis to be able to receive and report back flow descriptors.  
+To get started, the only thing you need is to point to your Redis instance and point which classes on your codebase should represent units.
 
+First, mount the engine. Add the line below to `routes.rb` file:
 
-## Installation
-Add this line to your application's Gemfile:
+```ruby
+mount Caixanegra::Engine, at: "/caixanegra", as: :caixanegra
+```
+
+Then, let's create a `caixanegra.rb` initializer (or any name you prefer)
 
 ```ruby
-gem 'caixanegra'
+Caixanegra.setup do |config|
+  config.units = {
+    awesome_unit: Caixanegra::Units::AU,
+    another_awesome_unit: Some::Other::Namespace::AAU,
+    you_can_also: {
+      scope_units: Caixanegra::Units::ScopedUnit,
+    },
+  }
+  config.redis = Redis.new
+end
+```
+
+With the designer configured, you can use `Caixanegra::Manager` to handle the previously stored definition (or an empty one).  
+This will give you the UID that **caixanegra** designer will understand.  
+
+```ruby
+my_flow = somewhere.get_flow # get from your own persistence or transport solution
+uid = Caixanegra::Manager.handler(my_flow || {})
 ```
-## License
+
+You can then safely navigate to the designer.
+
+```ruby
+link_to "Some flow", "/caixanegra/design/#{@uid}?unit_scope=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:
+
+```ruby
+updated_flow = Caixanegra::Manager.get(my_uid)
+persist_flow(updated_flow) # your own persistence or transport solution. It's a JSON
+```
+
+**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).
+
+# License
 **caixanegra** is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/caixanegra/engine.rb

@@ -6,13 +6,13 @@ module Caixanegra
   self.units = []
 
   def self.setup(&block)
-     yield self
+    yield self
   end
 
   class Engine < ::Rails::Engine
     isolate_namespace Caixanegra
 
-    initializer "caixanegra.assets.precompile" do |app|
+    initializer 'caixanegra.assets.precompile' do |app|
       app.config.assets.precompile += %w[
         caixanegra/api.js
         caixanegra/caixanegra.js

data/lib/caixanegra/executor.rb

@@ -27,7 +27,7 @@ module Caixanegra
     end
 
     def run_and_report_result
-      log_console_entry "Started"
+      log_console_entry 'Started'
       set_start_unit
       format_result(flow_through)
     rescue Caixanegra::UnitScopedException => e

data/lib/caixanegra/manager.rb

@@ -4,7 +4,7 @@ module Caixanegra
   class Manager
     class << self
       def handler(flow_definition = {})
-        uid = SecureRandom.uuid.gsub("-", "")
+        uid = SecureRandom.uuid.gsub('-', '')
 
         Caixanegra.redis.multi do |pipeline|
           pipeline.hset(:caixanegra, uid, JSON.dump(flow_definition))

data/lib/caixanegra/version.rb

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

data/lib/caixanegra.rb

@@ -1,8 +1,9 @@
-require "caixanegra/exceptions"
-require "caixanegra/engine"
-require "caixanegra/version"
-require "caixanegra/executor"
-require "caixanegra/manager"
+# frozen_string_literal: true
 
-module Caixanegra  
-end
+require 'caixanegra/exceptions'
+require 'caixanegra/engine'
+require 'caixanegra/version'
+require 'caixanegra/executor'
+require 'caixanegra/manager'
+
+module Caixanegra ; end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: caixanegra
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - sergiorribeiro
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-08 00:00:00.000000000 Z
+date: 2023-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -38,7 +38,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: TBD
+description: An unopinionated, flow oriented blackbox designer and executor to interface
+  your service classes
 email:
 - sergio.r.ribeiro@live.com
 executables: []
@@ -73,11 +74,10 @@ files:
 - lib/caixanegra/manager.rb
 - lib/caixanegra/version.rb
 - lib/tasks/caixanegra_tasks.rake
-homepage: http://sergioribeiro.com
+homepage: https://github.com/sergiorribeiro/caixanegra/wiki
 licenses:
 - MIT
-metadata:
-  allowed_push_host: https://rubygems.org
+metadata: {}
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -96,5 +96,5 @@ requirements: []
 rubygems_version: 3.3.17
 signing_key:
 specification_version: 4
-summary: TBD
+summary: Unopinionated flow oriented blackbox designer, executor and debugger
 test_files: []