nocode 0.0.5 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8726547b06744c6a7870a8634901b344e41a65bb1ede23c7e68e99d2218d482f
-  data.tar.gz: 3462f703d7639662c0da4f96ec9913749698c7f7a08a58387671db909a88785f
+  metadata.gz: f199fcae3341fccc2e54c1c139ba2c7e65a20dda27d2be31c79de02f9ec2558a
+  data.tar.gz: c10d64f895d34e567b846c52727205d1394641adcd68b1b1d2707c509577700c
 SHA512:
-  metadata.gz: f7bcfd37d152798a753801944a6a4787e3ad83a08fcfca0b40d9a0957cd7c5142a298adbb64215ed2e161c9e7f842b89ab460f6374fb8ec552a3482aa0b712eb
-  data.tar.gz: 6e024f679e2973888d5bb67c20988c8e93b296a6b6c4dbc66f7cb1f55d8638db48842834fd00c2a6d24050d9aa61950666107ff285a469e3f63835f74e7a5e7d
+  metadata.gz: 1a53bcec0412b9b8be57d9cb61601db583aa210542f9372c05d4cdee0e693861d05e017a697103253a2d522a2253e609481ded8e0524362ccaf6640a9d13f9d3
+  data.tar.gz: 131855e439116d1718cf46c53cc32597187aeae36156d71fff508fa4a0a20739a9965b055874aadc93cae4a5dd3fbf3f4b0201d5f7c75a9d1d63ed60e9150044

data/CHANGELOG.md

@@ -1,6 +1,25 @@
+#### 0.0.9 - February 18th, 2022
+
+* Replace StringTemplate with Nay library.
+#### 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.
+* Added initial `dataset` steps.
 
 #### 0.0.4 - February 13th, 2022
 

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/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_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/object_template.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative 'string_template'
-
 module Nocode
   module Util
     # Built on top of StringTemplate but instead of only working for a string, this will
@@ -34,7 +32,7 @@ module Nocode
             [recursive_evaluate(k, values), recursive_evaluate(v, values)]
           end
         when String
-          Util::StringTemplate.new(expression).evaluate(values)
+          Nay.evaluate(expression, values)
         else
           expression
         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.9'
 end

data/lib/nocode.rb

@@ -4,6 +4,7 @@ require 'benchmark'
 require 'csv'
 require 'fileutils'
 require 'json'
+require 'nay'
 require 'singleton'
 require 'time'
 require 'yaml'
@@ -12,14 +13,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

data/nocode.gemspec

@@ -29,6 +29,8 @@ Gem::Specification.new do |s|
 
   s.required_ruby_version = '>= 2.6'
 
+  s.add_dependency('nay', '~>0.0', '>=0.0.2')
+
   s.add_development_dependency('bundler-audit')
   s.add_development_dependency('guard-rspec')
   s.add_development_dependency('pry')

metadata

@@ -1,15 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: nocode
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.9
 platform: ruby
 authors:
 - Matthew Ruggio
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-02-14 00:00:00.000000000 Z
+date: 2022-02-18 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: nay
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.2
 - !ruby/object:Gem::Dependency
   name: bundler-audit
   requirement: !ruby/object:Gem::Requirement
@@ -175,7 +195,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,14 +208,20 @@ 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/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
@@ -203,7 +229,6 @@ files:
 - lib/nocode/util/dictionary.rb
 - lib/nocode/util/object_template.rb
 - lib/nocode/util/optionable.rb
-- lib/nocode/util/string_template.rb
 - lib/nocode/version.rb
 - nocode.gemspec
 homepage: https://github.com/mattruggio/nocode

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

data/lib/nocode/util/string_template.rb

@@ -1,49 +0,0 @@
-# frozen_string_literal: true
-
-module Nocode
-  module Util
-    # Takes in an expression and interpolates in any parameters using << >> notation.
-    # For example:
-    #   input = { 'person' => 'hops' }
-    #   Nocode::Util::StringTemplate.new("Hello, << person.name >>!").evaluate(input)
-    # Should produce: "Hello, hops!"
-    class StringTemplate
-      LEFT_TOKEN  = '<<'
-      RIGHT_TOKEN = '>>'
-      SEPARATOR   = '.'
-      REG_EXPR    = /#{Regexp.quote(LEFT_TOKEN)}(.*?)#{Regexp.quote(RIGHT_TOKEN)}/.freeze
-
-      attr_reader :expression
-
-      def initialize(expression)
-        @expression = expression.to_s
-
-        freeze
-      end
-
-      def evaluate(values = {})
-        resolved = tokens_to_values(tokens, values)
-
-        tokens.inject(expression) do |memo, token|
-          memo.gsub("#{LEFT_TOKEN}#{token}#{RIGHT_TOKEN}", resolved[token].to_s)
-        end
-      end
-
-      private
-
-      def tokens
-        expression.to_s.scan(REG_EXPR).flatten
-      end
-
-      def tokens_to_values(tokens, values)
-        tokens.each_with_object({}) do |token, memo|
-          cleansed = token.strip
-          parts    = cleansed.split(SEPARATOR)
-          value    = values.dig(*parts)
-
-          memo[token] = value
-        end
-      end
-    end
-  end
-end