nocode 0.0.6 → 0.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb204abe5d0c62fce45c1c9afd052fe90e21c9f422020b7acb497dd3e226c22b
-  data.tar.gz: dedd69881e903e5a1778303ea5adcd114fdcba10fbadbe2605c7e72b867beb83
+  metadata.gz: e8132a6f8dd5bde1975030689aaed4f3858243075116febf95c34fa182df67f5
+  data.tar.gz: 950d30f0d5c5d9ff9c670119f3f03e90628a4ef54b578ca925be9c5f23a0995f
 SHA512:
-  metadata.gz: 1e36a07d157d207d70606a067561cbfd049fab0842c124ebb252ef7e15d2bf1e397f5e683b17cead76f92e75112596038d627189ad9e37372bf7236341d500ef
-  data.tar.gz: dfb6f8759f55c3234fc04bae3e1701679b59d6e2678ae12d81190d9775f22a1f87beb6de63e0e58da5e7454d47ba72e3ec3791df66ce43a4e015a6ab8892878a
+  metadata.gz: 72a179c3862851d65cf38679d2f147da64bb5f3bcceca8c2f7849c3687500f8637fb4c1f3ae78a90f670e356ef19d37ff2b3e35559d11e32467c4ac0b3c1e43b
+  data.tar.gz: 0dafc012dbcd75fe1ac4af1cda75e3084a8c9c85b9e21e51b69451b70b968aba7d03fdb5d485eb44b9f4ecca997a932c1dba750f5e7e8e8bbfcec074b777bde0

data/CHANGELOG.md

@@ -1,11 +1,28 @@
+#### 0.0.10 - February 18th, 2022
+
+* Replace ObjectTemplate with Nay library.
+#### 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.
+* 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/lib/nocode/context.rb

@@ -33,5 +33,13 @@ module Nocode
         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

@@ -31,33 +31,25 @@ module Nocode
         registers: registers
       )
 
-      log_title
+      log_title(context)
 
       StepsExecutor.new(context: context, steps: steps).execute
 
-      log("Ended: #{DateTime.now}")
-      log_line
+      context.log("Ended: #{DateTime.now}")
+      context.log_line
 
       context
     end
 
     private
 
-    def log_title
-      log_line
+    def log_title(context)
+      context.log_line
 
-      log('Nocode Execution')
-      log("Started: #{DateTime.now}")
+      context.log('Nocode Execution')
+      context.log("Started: #{DateTime.now}")
 
-      log_line
-    end
-
-    def log_line
-      log('-' * 50)
-    end
-
-    def log(msg)
-      io.puts(msg)
+      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

@@ -12,20 +12,36 @@ module Nocode
 
       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
+          registers[element_key] = entry
+          registers[index_key]   = index
 
-          StepsExecutor.new(context: context, steps: steps).execute
+          execute_steps
         end
       end
-      # rubocop:enable Metrics/AbcSize
+
+      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

@@ -13,7 +13,7 @@ module Nocode
 
     attr_reader :context, :steps
 
-    def_delegators :context, :io
+    def_delegators :context, :log_line, :log
 
     def initialize(context:, steps:)
       @context = context
@@ -32,11 +32,8 @@ module Nocode
 
     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)
+      evaluated_step = Nay.evaluate(step, context.to_h)
       type           = evaluated_step[TYPE_KEY].to_s
       name           = evaluated_step[NAME_KEY].to_s
       step_class     = StepRegistry.constant!(type)
@@ -67,13 +64,5 @@ module Nocode
 
       log_line
     end
-
-    def log_line
-      log('-' * 50)
-    end
-
-    def log(msg)
-      io.puts(msg)
-    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.rb

@@ -4,5 +4,4 @@ require_relative 'util/arrayable'
 require_relative 'util/class_loader'
 require_relative 'util/class_registry'
 require_relative 'util/dictionary'
-require_relative 'util/object_template'
 require_relative 'util/optionable'

data/lib/nocode/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Nocode
-  VERSION = '0.0.6'
+  VERSION = '0.0.10'
 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'

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.3')
+
   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.6
+  version: 0.0.10
 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.3
+  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.3
 - !ruby/object:Gem::Dependency
   name: bundler-audit
   requirement: !ruby/object:Gem::Requirement
@@ -189,9 +209,13 @@ files:
 - 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
@@ -203,9 +227,7 @@ files:
 - lib/nocode/util/class_loader.rb
 - lib/nocode/util/class_registry.rb
 - 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/util/object_template.rb

@@ -1,44 +0,0 @@
-# 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
-    # recursively evaluate all strings within an object.  Heuristics:
-    #    - Strings evaluate using StringTemplate
-    #    - Hashes will have their keys and values traversed
-    #    - Arrays will have their entries traversed
-    #    - All other types will simply return themselves
-    class ObjectTemplate
-      attr_reader :object
-
-      def initialize(object)
-        @object = object
-
-        freeze
-      end
-
-      def evaluate(values = {})
-        recursive_evaluate(object, values)
-      end
-
-      private
-
-      def recursive_evaluate(expression, values)
-        case expression
-        when Array
-          expression.map { |o| recursive_evaluate(o, values) }
-        when Hash
-          expression.to_h do |k, v|
-            [recursive_evaluate(k, values), recursive_evaluate(v, values)]
-          end
-        when String
-          Util::StringTemplate.new(expression).evaluate(values)
-        else
-          expression
-        end
-      end
-    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