nocode 0.0.4 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 884ab5737629463437ef0991555e1ea30faa8db0cd6d8c79da712942aa69011b
-  data.tar.gz: d8562fdf11b2a204e9ced685b434d6959bafe2dca605dd3795355aeed1ed5238
+  metadata.gz: f42cd4574b36e4098fbb2c3de7263d8530ee2c935ec1d86da30950c51f45998e
+  data.tar.gz: a1259cd1075a946a056db27b2a3da5c7acebee2002c0f1e01b2f6a5fef203fa9
 SHA512:
-  metadata.gz: 677aa00aba3a998a4cc616002420c9366ac945fabdfc336d948b5158c24eae6c9bfc1b8a7ee658718c5c55af4148c4f83656fddf8b45995002471ef7224870da
-  data.tar.gz: e4de53676eaebb1d9bd3738dbbbb6df777ce0fdf1674e9aa370176c2eca9d42d4672d6edd682a313b943f24d149566491d1d7322d9c30ed0cc352db7730e0f3f
+  metadata.gz: 7be2f97365a7d2494e956362074d47c07cf39a741af34299b2bd30e70c2a74f8bf7566a24de816b4af692deede762c4e03ba9b2e1f8ddd81cf161a263e6e6f1b
+  data.tar.gz: '0099f90f5b0a569f2fe95b93d16aa5e737f957830bcfcb84d598f362c21edec9c759e113f0d01049a5ecfa05bb17d5e70ec49436b5c558a66f0e194d8c32ff28'

data/CHANGELOG.md

@@ -1,7 +1,28 @@
+
+#### 0.0.8 - February 14th, 2022
+
+* Add `map` step to iterate and collect a dataset result.
+* Add `record/map` step to iterate over a hash.
+* Add `io/list` to populate a register with the contents of a directory.
+* Add `io/delete` to delete a file specified in the path option.
+#### 0.0.7 - February 13th, 2022
+
+* Move shared logging logic to context (until a first class log writer emerges).
+* Provide type_prefix option for class_registry
+
+#### 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.
+
 #### 0.0.4 - February 13th, 2022
 
 * Increase class documentation
-* Add YAML serialization/deserializationß
+* Add YAML serialization/deserialization
 
 #### 0.0.3 - February 12th, 2022
 

data/README.md

@@ -2,7 +2,7 @@
 
 #### Execute Ruby code through YAML
 
-[![Gem Version](https://badge.fury.io/rb/nocode.svg)](https://badge.fury.io/rb/nocode) [![Ruby Gem CI](https://github.com/mattruggio/nocode/actions/workflows/rubygem.yml/badge.svg)](https://github.com/mattruggio/nocode/actions/workflows/rubygem.yml)
+[![Gem Version](https://badge.fury.io/rb/nocode.svg)](https://badge.fury.io/rb/nocode) [![Ruby Gem CI](https://github.com/mattruggio/nocode/actions/workflows/rubygem.yml/badge.svg)](https://github.com/mattruggio/nocode/actions/workflows/rubygem.yml) [![Maintainability](https://api.codeclimate.com/v1/badges/66479dae44129c87dc88/maintainability)](https://codeclimate.com/github/mattruggio/nocode/maintainability) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
 This is a proof of concept showing how a YAML interface could be draped over arbitrary Ruby code.  The YAML contains a series of steps with each step mapping to a specific Ruby class.  The Ruby classes just have one responsibility: to implement #perform.
 

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,9 +29,17 @@ module Nocode
 
     def to_h
       {
-        'registers' => registers,
-        'parameters' => parameters
+        REGISTERS_KEY => registers,
+        PARAMETERS_KEY => parameters
       }
     end
+
+    def log_line
+      log('-' * 50)
+    end
+
+    def log(msg)
+      io.puts(msg)
+    end
   end
 end

data/lib/nocode/job_executor.rb

@@ -0,0 +1,55 @@
+# 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(context)
+
+      StepsExecutor.new(context: context, steps: steps).execute
+
+      context.log("Ended: #{DateTime.now}")
+      context.log_line
+
+      context
+    end
+
+    private
+
+    def log_title(context)
+      context.log_line
+
+      context.log('Nocode Execution')
+      context.log("Started: #{DateTime.now}")
+
+      context.log_line
+    end
+  end
+end

data/lib/nocode/step_registry.rb

@@ -10,8 +10,8 @@ module Nocode
   class StepRegistry < Util::ClassRegistry
     include Singleton
 
-    PREFIX = 'Nocode::Steps::'
-    DIR    = File.join(__dir__, 'steps')
+    CLASS_PREFIX = 'Nocode::Steps::'
+    DIR          = File.join(__dir__, 'steps')
 
     class << self
       extend Forwardable
@@ -27,7 +27,7 @@ module Nocode
       files_loaded = Util::ClassLoader.new(DIR).load!
 
       # Class the parent to load up the registry with the files we found.
-      load(files_loaded, PREFIX)
+      load(files_loaded, class_prefix: CLASS_PREFIX)
     end
   end
 

data/lib/nocode/steps/dataset/append.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Nocode
+  module Steps
+    module Dataset
+      # Add entries specified in the options to the end of the specified register's
+      # existing entries.
+      class Append < Step
+        option :entries, :register
+
+        def perform
+          registers[register_option] = array(registers[register_option])
+
+          array(entries_option).each do |entry|
+            registers[register_option].append(entry)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/nocode/steps/dataset/coalesce.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Nocode
+  module Steps
+    module Dataset
+      # Combine all specified from_registers into one dataset and place in the specified
+      # to_register.  If anything currently exists in the to_register then it will be coerced
+      # to an array and prepended to the beginning.
+      class Coalesce < Step
+        option :from_registers, :to_register
+
+        def perform
+          registers[to_register_option] = array(registers[to_register_option])
+
+          array(from_registers_option).each do |from_register|
+            registers[to_register_option] += array(registers[from_register])
+          end
+        end
+      end
+    end
+  end
+end

data/lib/nocode/steps/dataset/insert.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Nocode
+  module Steps
+    module Dataset
+      # Insert the entries to the at_index of the specified register.
+      # If at_index is nil then they will appended to the end.
+      class Insert < Step
+        option :at_index, :entries, :register
+
+        def perform
+          registers[register_option] = array(registers[register_option])
+
+          registers[register_option].insert(at_index, *entries)
+        end
+
+        private
+
+        def entries
+          array(entries_option)
+        end
+
+        def at_index
+          at_index_option.nil? ? -1 : at_index_option.to_i
+        end
+      end
+    end
+  end
+end

data/lib/nocode/steps/dataset/prepend.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Nocode
+  module Steps
+    module Dataset
+      # Add entries specified in the options to the beginning of the specified register's
+      # existing entries.
+      class Prepend < Step
+        option :entries, :register
+
+        def perform
+          registers[register_option] = array(registers[register_option])
+
+          array(entries_option).reverse_each do |entry|
+            registers[register_option].prepend(entry)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/nocode/steps/dataset/range.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Nocode
+  module Steps
+    module Dataset
+      # Slice a dataset and keep on the entries between start_index and end_index, inclusively.
+      # If start_index is not provided then it defaults to 0.
+      # If end_index is not provided then it defaults to the end of the dataset.
+      class Range < Step
+        option :end_index,
+               :register,
+               :start_index
+
+        def perform
+          registers[register_option] = array(registers[register_option])
+
+          registers[register_option] = registers[register_option][start_index..end_index]
+        end
+
+        private
+
+        def start_index
+          start_index_option.nil? ? 0 : start_index_option.to_i
+        end
+
+        def end_index
+          end_index_option.nil? ? -1 : end_index_option.to_i
+        end
+      end
+    end
+  end
+end

data/lib/nocode/steps/each.rb

@@ -0,0 +1,47 @@
+# 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!
+
+      def perform
+        entries.each_with_index do |entry, index|
+          registers[element_key] = entry
+          registers[index_key]   = index
+
+          execute_steps
+        end
+      end
+
+      private
+
+      def execute_steps
+        StepsExecutor.new(context: context, steps: steps).execute
+      end
+
+      def entries
+        array(registers[register_option])
+      end
+
+      def steps
+        array(steps_option)
+      end
+
+      def element_key
+        "#{element_register_prefix_option}_element"
+      end
+
+      def index_key
+        "#{element_register_prefix_option}_index"
+      end
+    end
+  end
+end

data/lib/nocode/steps/io/delete.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Nocode
+  module Steps
+    module Io
+      # Delete the specified path.  Does nothing if the file does not exist.
+      class Delete < Step
+        option :path
+
+        def perform
+          return if path.to_s.empty?
+
+          FileUtils.rm_f(path) if File.exist?(path)
+        end
+
+        private
+
+        def path
+          File.join(*array(path_option))
+        end
+      end
+    end
+  end
+end

data/lib/nocode/steps/io/list.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Nocode
+  module Steps
+    module Io
+      # List all files in the path option.  Wildcards can be used.
+      #
+      # Mechanic: https://ruby-doc.org/core-2.5.0/Dir.html#method-c-glob
+      class List < Step
+        option :path,
+               :register
+
+        def perform
+          registers[register_option] = Dir[path].reject { |p| File.directory?(p) }
+        end
+
+        private
+
+        def path
+          File.join(*array(path_option))
+        end
+      end
+    end
+  end
+end

data/lib/nocode/steps/map.rb

@@ -0,0 +1,52 @@
+# 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.
+    #
+    # The main difference between this and 'each' is that this will collect the iterator
+    # element register and set the register to this new collection.
+    class Map < Step
+      option :element_register_prefix,
+             :register,
+             :steps
+
+      skip_options_evaluation!
+
+      def perform
+        registers[register_option] = entries.map.with_index do |entry, index|
+          registers[element_key] = entry
+          registers[index_key]   = index
+
+          execute_steps
+
+          registers[element_key]
+        end
+      end
+
+      private
+
+      def execute_steps
+        StepsExecutor.new(context: context, steps: steps).execute
+      end
+
+      def entries
+        array(registers[register_option])
+      end
+
+      def steps
+        array(steps_option)
+      end
+
+      def element_key
+        "#{element_register_prefix_option}_element"
+      end
+
+      def index_key
+        "#{element_register_prefix_option}_index"
+      end
+    end
+  end
+end

data/lib/nocode/steps/record/map.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Nocode
+  module Steps
+    module Record
+      # Create a new hash from an existing hash mapping each key as configured by the
+      # key_mappings option.  The key_mappings option should be in the form of:
+      #   new_key => old_key
+      class Map < Step
+        option :key_mappings, :register
+
+        def perform
+          input  = registers[register_option] || {}
+          output = {}
+
+          (key_mappings_option || {}).each do |to, from|
+            output[to.to_s] = input[from.to_s]
+          end
+
+          registers[register_option] = output
+        end
+      end
+    end
+  end
+end

data/lib/nocode/steps/serialize/csv.rb

@@ -27,14 +27,8 @@ module Nocode
 
           if object.is_a?(Array)
             csv << object
-
-            true
           elsif object.respond_to?(:values)
             csv << object.values
-
-            true
-          else
-            false
           end
         end
       end

data/lib/nocode/steps/sleep.rb

@@ -3,6 +3,8 @@
 module Nocode
   module Steps
     # Sleep for an arbitrary number of seconds.
+    #
+    # Mechanic: https://apidock.com/ruby/Kernel/sleep
     class Sleep < Step
       option :seconds
 

data/lib/nocode/steps_executor.rb

@@ -0,0 +1,68 @@
+# 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, :log_line, :log
+
+    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
+
+    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
+  end
+end

data/lib/nocode/util/class_registry.rb

@@ -20,13 +20,13 @@ module Nocode
         freeze
       end
 
-      def load(types, prefix = '')
+      def load(types, class_prefix: '', type_prefix: '')
         types.each do |type|
           pascal_cased = type.split(File::SEPARATOR).map do |part|
             part.split('_').collect(&:capitalize).join
           end.join('::')
 
-          register(type, "#{prefix}#{pascal_cased}")
+          register("#{type_prefix}#{type}", "#{class_prefix}#{pascal_cased}")
         end
 
         self

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.4'
+  VERSION = '0.0.8'
 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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nocode
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.8
 platform: ruby
 authors:
 - Matthew Ruggio
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-02-13 00:00:00.000000000 Z
+date: 2022-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler-audit
@@ -175,22 +175,33 @@ 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
+- lib/nocode/steps/dataset/append.rb
+- lib/nocode/steps/dataset/coalesce.rb
+- lib/nocode/steps/dataset/insert.rb
+- lib/nocode/steps/dataset/prepend.rb
+- lib/nocode/steps/dataset/range.rb
 - lib/nocode/steps/delete.rb
 - 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/delete.rb
+- lib/nocode/steps/io/list.rb
 - lib/nocode/steps/io/read.rb
 - lib/nocode/steps/io/write.rb
 - lib/nocode/steps/log.rb
+- lib/nocode/steps/map.rb
+- lib/nocode/steps/record/map.rb
 - lib/nocode/steps/serialize/csv.rb
 - lib/nocode/steps/serialize/json.rb
 - 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,84 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'context'
-require_relative 'step_registry'
-
-module Nocode
-  # Manages the lifecycle and executes a job.
-  class Executor
-    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'] || []
-      parameters = yaml['parameters'] || {}
-      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'].to_s
-      name       = step['name'].to_s
-      options    = step['options'] || {}
-      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