nocode 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8726547b06744c6a7870a8634901b344e41a65bb1ede23c7e68e99d2218d482f
-  data.tar.gz: 3462f703d7639662c0da4f96ec9913749698c7f7a08a58387671db909a88785f
+  metadata.gz: bb204abe5d0c62fce45c1c9afd052fe90e21c9f422020b7acb497dd3e226c22b
+  data.tar.gz: dedd69881e903e5a1778303ea5adcd114fdcba10fbadbe2605c7e72b867beb83
 SHA512:
-  metadata.gz: f7bcfd37d152798a753801944a6a4787e3ad83a08fcfca0b40d9a0957cd7c5142a298adbb64215ed2e161c9e7f842b89ab460f6374fb8ec552a3482aa0b712eb
-  data.tar.gz: 6e024f679e2973888d5bb67c20988c8e93b296a6b6c4dbc66f7cb1f55d8638db48842834fd00c2a6d24050d9aa61950666107ff285a469e3f63835f74e7a5e7d
+  metadata.gz: 1e36a07d157d207d70606a067561cbfd049fab0842c124ebb252ef7e15d2bf1e397f5e683b17cead76f92e75112596038d627189ad9e37372bf7236341d500ef
+  data.tar.gz: dfb6f8759f55c3234fc04bae3e1701679b59d6e2678ae12d81190d9775f22a1f87beb6de63e0e58da5e7454d47ba72e3ec3791df66ce43a4e015a6ab8892878a

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+#### 0.0.6 - February 13th, 2022
+
+* Expose registers to main YAML configuration.
+* Add Each step to serve as an example of an iterator.
+
 #### 0.0.5 - February 13th, 2022
 
 * Added initial Dataset steps.

data/exe/nocode

@@ -4,6 +4,8 @@
 require 'bundler/setup'
 require 'nocode'
 
+require 'pry'
+
 path = ARGV[0]
 
 if path.to_s.empty?

data/lib/nocode/context.rb

@@ -4,7 +4,12 @@ module Nocode
   # Describes the environment for each running step.  An instance is initialized when a job
   # kicks off and then is passed from step to step.
   class Context
-    attr_reader :io, :parameters, :registers
+    PARAMETERS_KEY = 'parameters'
+    REGISTERS_KEY  = 'registers'
+
+    attr_reader :io,
+                :parameters,
+                :registers
 
     def initialize(io: $stdout, parameters: {}, registers: {})
       @io         = io || $stdout
@@ -24,8 +29,8 @@ module Nocode
 
     def to_h
       {
-        'registers' => registers,
-        'parameters' => parameters
+        REGISTERS_KEY => registers,
+        PARAMETERS_KEY => parameters
       }
     end
   end

data/lib/nocode/job_executor.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require_relative 'context'
+require_relative 'steps_executor'
+
+module Nocode
+  # Manages the lifecycle and executes a job.
+  class JobExecutor
+    PARAMETERS_KEY = 'parameters'
+    REGISTERS_KEY  = 'registers'
+    STEPS_KEY      = 'steps'
+
+    attr_reader :yaml, :io
+
+    def initialize(yaml, io: $stdout)
+      @yaml = yaml.respond_to?(:read) ? yaml.read : yaml
+      @yaml = YAML.safe_load(@yaml) || {}
+      @io   = io
+
+      freeze
+    end
+
+    def execute
+      steps      = yaml[STEPS_KEY] || []
+      parameters = yaml[PARAMETERS_KEY] || {}
+      registers  = yaml[REGISTERS_KEY] || {}
+
+      context = Context.new(
+        io: io,
+        parameters: parameters,
+        registers: registers
+      )
+
+      log_title
+
+      StepsExecutor.new(context: context, steps: steps).execute
+
+      log("Ended: #{DateTime.now}")
+      log_line
+
+      context
+    end
+
+    private
+
+    def log_title
+      log_line
+
+      log('Nocode Execution')
+      log("Started: #{DateTime.now}")
+
+      log_line
+    end
+
+    def log_line
+      log('-' * 50)
+    end
+
+    def log(msg)
+      io.puts(msg)
+    end
+  end
+end

data/lib/nocode/steps/each.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Nocode
+  module Steps
+    # Iterate over a register.  Each iteration will store the current element and index in
+    # special registers called: _element and _index.  You can prefix these registers by setting
+    # the element_register_prefix option.
+    class Each < Step
+      option :element_register_prefix,
+             :register,
+             :steps
+
+      skip_options_evaluation!
+
+      # rubocop:disable Metrics/AbcSize
+      def perform
+        entries = array(registers[register_option])
+
+        entries.each_with_index do |entry, index|
+          steps = array(steps_option)
+
+          registers["#{element_register_prefix_option}_element"] = entry
+          registers["#{element_register_prefix_option}_index"]   = index
+
+          StepsExecutor.new(context: context, steps: steps).execute
+        end
+      end
+      # rubocop:enable Metrics/AbcSize
+    end
+  end
+end

data/lib/nocode/steps_executor.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require_relative 'step_registry'
+
+module Nocode
+  # Class that knows how to execute a series of steps given a context.
+  class StepsExecutor
+    extend Forwardable
+
+    NAME_KEY    = 'name'
+    OPTIONS_KEY = 'options'
+    TYPE_KEY    = 'type'
+
+    attr_reader :context, :steps
+
+    def_delegators :context, :io
+
+    def initialize(context:, steps:)
+      @context = context
+      @steps   = steps
+
+      freeze
+    end
+
+    def execute
+      steps.each do |step|
+        step_instance = make_step(step)
+
+        execute_step(step_instance)
+      end
+    end
+
+    private
+
+    # TODO: It could be better encapsulated to move the evaluation logic into the step itself
+    # and let it deal with compilation.  This may call for re-working the lifecycle of the Step
+    # class so I will temporarily defer this refactoring.
+    def make_step(step)
+      evaluated_step = Util::ObjectTemplate.new(step).evaluate(context.to_h)
+      type           = evaluated_step[TYPE_KEY].to_s
+      name           = evaluated_step[NAME_KEY].to_s
+      step_class     = StepRegistry.constant!(type)
+
+      options =
+        if step_class.skip_options_evaluation?
+          step[OPTIONS_KEY]
+        else
+          evaluated_step[OPTIONS_KEY]
+        end
+
+      step_class.new(
+        options: Util::Dictionary.new(options),
+        context: context,
+        name: name,
+        type: type
+      )
+    end
+
+    def execute_step(step)
+      log(step.name) unless step.name.empty?
+      log("Step:  #{step.type}")
+      log("Class: #{step.class}")
+
+      time_in_seconds = Benchmark.measure { step.perform }.real
+
+      log("Completed in #{time_in_seconds.round(3)} second(s)")
+
+      log_line
+    end
+
+    def log_line
+      log('-' * 50)
+    end
+
+    def log(msg)
+      io.puts(msg)
+    end
+  end
+end

data/lib/nocode/util/optionable.rb

@@ -23,6 +23,14 @@ module Nocode
 
       # Class-level DSL Methods
       module ClassMethods
+        def skip_options_evaluation?
+          @skip_options_evaluation || false
+        end
+
+        def skip_options_evaluation!
+          @skip_options_evaluation = true
+        end
+
         def option(*values)
           values.each { |v| options << v.to_s }
         end

data/lib/nocode/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Nocode
-  VERSION = '0.0.5'
+  VERSION = '0.0.6'
 end

data/lib/nocode.rb

@@ -12,14 +12,14 @@ require 'yaml'
 require 'nocode/util'
 
 # Core
-require 'nocode/executor'
+require 'nocode/job_executor'
 
 # Establish main top-level namespace
 module Nocode
   # Default consumer entrypoint into the library.
   class << self
     def execute(yaml, io: $stdout)
-      Executor.new(yaml, io: io).execute
+      JobExecutor.new(yaml, io: io).execute
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nocode
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Matthew Ruggio
@@ -175,7 +175,7 @@ files:
 - exe/nocode
 - lib/nocode.rb
 - lib/nocode/context.rb
-- lib/nocode/executor.rb
+- lib/nocode/job_executor.rb
 - lib/nocode/step.rb
 - lib/nocode/step_registry.rb
 - lib/nocode/steps/copy.rb
@@ -188,6 +188,7 @@ files:
 - lib/nocode/steps/deserialize/csv.rb
 - lib/nocode/steps/deserialize/json.rb
 - lib/nocode/steps/deserialize/yaml.rb
+- lib/nocode/steps/each.rb
 - lib/nocode/steps/io/read.rb
 - lib/nocode/steps/io/write.rb
 - lib/nocode/steps/log.rb
@@ -196,6 +197,7 @@ files:
 - lib/nocode/steps/serialize/yaml.rb
 - lib/nocode/steps/set.rb
 - lib/nocode/steps/sleep.rb
+- lib/nocode/steps_executor.rb
 - lib/nocode/util.rb
 - lib/nocode/util/arrayable.rb
 - lib/nocode/util/class_loader.rb

data/lib/nocode/executor.rb

@@ -1,90 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'context'
-require_relative 'step_registry'
-
-module Nocode
-  # Manages the lifecycle and executes a job.
-  class Executor
-    NAME_KEY       = 'name'
-    OPTIONS_KEY    = 'options'
-    PARAMETERS_KEY = 'parameters'
-    STEPS_KEY      = 'steps'
-    TYPE_KEY       = 'type'
-
-    attr_reader :yaml, :io
-
-    def initialize(yaml, io: $stdout)
-      @yaml = yaml.respond_to?(:read) ? yaml.read : yaml
-      @yaml = YAML.safe_load(@yaml) || {}
-      @io   = io
-
-      freeze
-    end
-
-    def execute
-      steps      = yaml[STEPS_KEY] || []
-      parameters = yaml[PARAMETERS_KEY] || {}
-      context    = Context.new(io: io, parameters: parameters)
-
-      log_title
-
-      steps.each do |step|
-        step_instance = make_step(step, context)
-
-        execute_step(step_instance)
-      end
-
-      log("Ended: #{DateTime.now}")
-      log_line
-
-      context
-    end
-
-    private
-
-    def make_step(step, context)
-      step       = Util::ObjectTemplate.new(step).evaluate(context.to_h)
-      type       = step[TYPE_KEY].to_s
-      name       = step[NAME_KEY].to_s
-      options    = step[OPTIONS_KEY] || {}
-      step_class = StepRegistry.constant!(type)
-
-      step_class.new(
-        options: Util::Dictionary.new(options),
-        context: context,
-        name: name,
-        type: type
-      )
-    end
-
-    def execute_step(step)
-      log(step.name) unless step.name.empty?
-      log("Step:  #{step.type}")
-      log("Class: #{step.class}")
-
-      time_in_seconds = Benchmark.measure { step.perform }.real
-
-      log("Completed in #{time_in_seconds.round(3)} second(s)")
-
-      log_line
-    end
-
-    def log_title
-      log_line
-
-      log('Nocode Execution')
-      log("Started: #{DateTime.now}")
-
-      log_line
-    end
-
-    def log_line
-      log('-' * 50)
-    end
-
-    def log(msg)
-      io.puts(msg)
-    end
-  end
-end