nocode 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 884ab5737629463437ef0991555e1ea30faa8db0cd6d8c79da712942aa69011b
-  data.tar.gz: d8562fdf11b2a204e9ced685b434d6959bafe2dca605dd3795355aeed1ed5238
+  metadata.gz: 8726547b06744c6a7870a8634901b344e41a65bb1ede23c7e68e99d2218d482f
+  data.tar.gz: 3462f703d7639662c0da4f96ec9913749698c7f7a08a58387671db909a88785f
 SHA512:
-  metadata.gz: 677aa00aba3a998a4cc616002420c9366ac945fabdfc336d948b5158c24eae6c9bfc1b8a7ee658718c5c55af4148c4f83656fddf8b45995002471ef7224870da
-  data.tar.gz: e4de53676eaebb1d9bd3738dbbbb6df777ce0fdf1674e9aa370176c2eca9d42d4672d6edd682a313b943f24d149566491d1d7322d9c30ed0cc352db7730e0f3f
+  metadata.gz: f7bcfd37d152798a753801944a6a4787e3ad83a08fcfca0b40d9a0957cd7c5142a298adbb64215ed2e161c9e7f842b89ab460f6374fb8ec552a3482aa0b712eb
+  data.tar.gz: 6e024f679e2973888d5bb67c20988c8e93b296a6b6c4dbc66f7cb1f55d8638db48842834fd00c2a6d24050d9aa61950666107ff285a469e3f63835f74e7a5e7d

data/CHANGELOG.md

@@ -1,7 +1,11 @@
+#### 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/lib/nocode/executor.rb

@@ -6,6 +6,12 @@ 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)
@@ -17,8 +23,8 @@ module Nocode
     end
 
     def execute
-      steps      = yaml['steps'] || []
-      parameters = yaml['parameters'] || {}
+      steps      = yaml[STEPS_KEY] || []
+      parameters = yaml[PARAMETERS_KEY] || {}
       context    = Context.new(io: io, parameters: parameters)
 
       log_title
@@ -39,9 +45,9 @@ module Nocode
 
     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'] || {}
+      type       = step[TYPE_KEY].to_s
+      name       = step[NAME_KEY].to_s
+      options    = step[OPTIONS_KEY] || {}
       step_class = StepRegistry.constant!(type)
 
       step_class.new(

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/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/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nocode
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Matthew Ruggio
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-02-13 00:00:00.000000000 Z
+date: 2022-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler-audit
@@ -179,6 +179,11 @@ files:
 - 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