nocode 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4609bf6b3f082509087ab07dfbe8b96f55df01788baac74c0d7c4500f1a48f35
-  data.tar.gz: 1acd73ef5df505964078a840362f271a8196b7f099e5f18e9f5d7f4692152e5c
+  metadata.gz: 884ab5737629463437ef0991555e1ea30faa8db0cd6d8c79da712942aa69011b
+  data.tar.gz: d8562fdf11b2a204e9ced685b434d6959bafe2dca605dd3795355aeed1ed5238
 SHA512:
-  metadata.gz: ce4af8b6a125a1cd178d0436e32918ed246053ac8f214b7adc98f4051ab34916c60794bb915f978aa0101adca7f4d9ccd332b04f0f27efaba8dc9fb17035e310
-  data.tar.gz: 4e2e951062a9085a6bba5d146c5672f0862e6dc92eeedcc5d08cc5e7fdcdad86c08395240034a13441b6770c3bf0d31b1383446bf9f27ed4f18ceb0cd4cda9ac
+  metadata.gz: 677aa00aba3a998a4cc616002420c9366ac945fabdfc336d948b5158c24eae6c9bfc1b8a7ee658718c5c55af4148c4f83656fddf8b45995002471ef7224870da
+  data.tar.gz: e4de53676eaebb1d9bd3738dbbbb6df777ce0fdf1674e9aa370176c2eca9d42d4672d6edd682a313b943f24d149566491d1d7322d9c30ed0cc352db7730e0f3f

data/.github/workflows/rubygem.yml

@@ -25,3 +25,5 @@ jobs:
         bundler-cache: true # runs 'bundle install' and caches installed gems automatically
     - name: Run tests
       run: bundle exec rake
+    - name: Security audit dependencies
+      run: bundle exec bundler-audit check --update

data/.rubocop.yml

@@ -14,8 +14,5 @@ Metrics/BlockLength:
 Metrics/MethodLength:
   Max: 20
 
-Style/Documentation:
-  Enabled: false
-
 RSpec/ExampleLength:
   Max: 10

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+#### 0.0.4 - February 13th, 2022
+
+* Increase class documentation
+* Add YAML serialization/deserializationß
+
 #### 0.0.3 - February 12th, 2022
 
 * Add initial implementation.

data/README.md

@@ -2,9 +2,7 @@
 
 #### Execute Ruby code through YAML
 
-[![Ruby Gem CI](https://github.com/mattruggio/nocode/actions/workflows/rubygem.yml/badge.svg)](https://github.com/mattruggio/nocode/actions/workflows/rubygem.yml)
-
-**Warning**: This library is currently experimental.
+[![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)
 
 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.
 
@@ -113,16 +111,16 @@ Note: ensure you have proper authorization before trying to publish new versions
 
 After code changes have successfully gone through the Pull Request review process then the following steps should be followed for publishing new versions:
 
-1. Merge Pull Request into master
+1. Merge Pull Request into main
 2. Update `version.rb` using [semantic versioning](https://semver.org/)
 3. Install dependencies: `bundle`
 4. Update `CHANGELOG.md` with release notes
-5. Commit & push master to remote and ensure CI builds master successfully
+5. Commit & push main to remote and ensure CI builds main successfully
 6. Run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Code of Conduct
 
-Everyone interacting in this codebase, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/mattruggio/nocode/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in this codebase, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/mattruggio/nocode/blob/main/CODE_OF_CONDUCT.md).
 
 ## License
 

data/lib/nocode/context.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 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
 

data/lib/nocode/executor.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
 require_relative 'context'
-require_relative 'object_template'
 require_relative 'step_registry'
 
 module Nocode
+  # Manages the lifecycle and executes a job.
   class Executor
     attr_reader :yaml, :io
 
@@ -38,7 +38,7 @@ module Nocode
     private
 
     def make_step(step, context)
-      step       = ObjectTemplate.new(step).evaluate(context.to_h)
+      step       = Util::ObjectTemplate.new(step).evaluate(context.to_h)
       type       = step['type'].to_s
       name       = step['name'].to_s
       options    = step['options'] || {}

data/lib/nocode/step.rb

@@ -1,14 +1,22 @@
 # frozen_string_literal: true
 
 module Nocode
+  # Defines a running step.  Steps should be sub-classes of this class as well as to implement
+  # #perform.
   class Step
     extend Forwardable
     include Util::Arrayable
     include Util::Optionable
 
-    attr_reader :name, :context, :options, :type
+    attr_reader :context,
+                :name,
+                :options,
+                :type
 
-    def_delegators :context, :parameters, :registers, :io
+    def_delegators :context,
+                   :io,
+                   :parameters,
+                   :registers
 
     def initialize(
       context: Context.new,

data/lib/nocode/step_registry.rb

@@ -2,7 +2,11 @@
 
 require_relative 'step'
 
+# This will execute the StepRegisty's load! method upon script evaluation.
 module Nocode
+  # Provides a global place to register all valid steps by their types.  By default the
+  # steps directory will be autoloaded and their paths will be used as their types.  For example:
+  # for the class: steps/io/write, it would register as "io/write" type.
   class StepRegistry < Util::ClassRegistry
     include Singleton
 
@@ -22,9 +26,11 @@ module Nocode
     def load!
       files_loaded = Util::ClassLoader.new(DIR).load!
 
+      # Class the parent to load up the registry with the files we found.
       load(files_loaded, PREFIX)
     end
   end
 
+  # Call upon class evaluation to autoload all classes.
   StepRegistry.load!
 end

data/lib/nocode/steps/copy.rb

@@ -2,11 +2,12 @@
 
 module Nocode
   module Steps
+    # Shallow-copy one register to another.
     class Copy < Step
       option :from_register, :to_register
 
       def perform
-        registers[to_register_option] = registers[from_register_option]
+        registers[to_register_option] = registers[from_register_option].dup
       end
     end
   end

data/lib/nocode/steps/delete.rb

@@ -2,6 +2,7 @@
 
 module Nocode
   module Steps
+    # Remove a register completely.
     class Delete < Step
       option :register
 

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

@@ -3,6 +3,7 @@
 module Nocode
   module Steps
     module Deserialize
+      # take a specified register and parse it as a CSV to produce an array of hashes.
       class Csv < Step
         option :register
 

data/lib/nocode/steps/deserialize/json.rb

@@ -3,6 +3,7 @@
 module Nocode
   module Steps
     module Deserialize
+      # take a specified register and parse it as JSON to produce Ruby object(s).
       class Json < Step
         option :register
 

data/lib/nocode/steps/deserialize/yaml.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Nocode
+  module Steps
+    module Deserialize
+      # Take a specified register and parse it as YAML to produce Ruby object(s).
+      #
+      # NOTE: This will throw an error if unsafe YAML types are used.  The only allowed types are
+      # array, hash, strings, numbers, booleans, nil.  See:
+      # https://ruby-doc.org/stdlib-2.6.1/libdoc/psych/rdoc/Psych.html#method-c-safe_load
+      class Yaml < Step
+        option :register
+
+        def perform
+          input = registers[register_option]
+
+          registers[register_option] = YAML.safe_load(input)
+        end
+      end
+    end
+  end
+end

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

@@ -3,6 +3,7 @@
 module Nocode
   module Steps
     module Io
+      # Read a file from disk and place its contents in a register.
       class Read < Step
         option :path,
                :register

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

@@ -3,6 +3,7 @@
 module Nocode
   module Steps
     module Io
+      # Write the contents of a register to disk.
       class Write < Step
         option :path,
                :register

data/lib/nocode/steps/log.rb

@@ -2,6 +2,7 @@
 
 module Nocode
   module Steps
+    # Simply output the passed in message into the outputted log.
     class Log < Step
       option :message
 

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

@@ -3,6 +3,8 @@
 module Nocode
   module Steps
     module Serialize
+      # Take the contents of a register and create a CSV out of its contents.  The CSV contents
+      # will override the register specified.
       class Csv < Step
         option :register
 

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

@@ -3,6 +3,8 @@
 module Nocode
   module Steps
     module Serialize
+      # Take the contents of a register and serialize it as JSON.  The serialized JSON
+      # will override the register specified.
       class Json < Step
         option :register
 

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Nocode
+  module Steps
+    module Serialize
+      # Take the contents of a register and serialize it as YAML.  The serialized YAML
+      # will override the register specified.
+      class Yaml < Step
+        option :register
+
+        def perform
+          input = registers[register_option]
+
+          registers[register_option] = input.to_yaml
+        end
+      end
+    end
+  end
+end

data/lib/nocode/steps/set.rb

@@ -2,6 +2,7 @@
 
 module Nocode
   module Steps
+    # Set a register's value to the value option specified.
     class Set < Step
       option :register, :value
 

data/lib/nocode/steps/sleep.rb

@@ -2,6 +2,7 @@
 
 module Nocode
   module Steps
+    # Sleep for an arbitrary number of seconds.
     class Sleep < Step
       option :seconds
 

data/lib/nocode/util/arrayable.rb

@@ -2,6 +2,7 @@
 
 module Nocode
   module Util
+    # Hand
     module Arrayable
       def array(value)
         if value.is_a?(Hash)

data/lib/nocode/util/class_loader.rb

@@ -2,6 +2,7 @@
 
 module Nocode
   module Util
+    # Loads a directory full of Ruby classes and returns their relative paths.
     class ClassLoader
       EXTENSION = '.rb'
 

data/lib/nocode/util/class_registry.rb

@@ -2,6 +2,9 @@
 
 module Nocode
   module Util
+    # Create a type -> class constant interface.  Classes can be registered as types.  Types
+    # are snake-cased while class names are stored as pascal-cased.  Then constant! can be called
+    # to retrieve the class constant by type.
     class ClassRegistry
       extend Forwardable
 

data/lib/nocode/util/dictionary.rb

@@ -2,6 +2,7 @@
 
 module Nocode
   module Util
+    # A hash-like object which ensures all keys are strings.
     class Dictionary
       extend Forwardable
 

data/lib/nocode/util/object_template.rb

@@ -0,0 +1,44 @@
+# 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/optionable.rb

@@ -2,6 +2,20 @@
 
 module Nocode
   module Util
+    # Add on a DSL for classes.  The DSL allows for a new class-level keyword called 'option'
+    # which can be used to describe what metadata values are important.  Then instances
+    # can reference those option's values using magic _option methods.  For example:
+    #
+    # class Animal
+    #   include Optionable
+    #   option :type
+    #   attr_writer :options
+    # end
+    #
+    # animal = Animal.new
+    # animal.options = { 'type' => 'dog' }
+    #
+    # animal.type_option # -> should return 'dog'
     module Optionable
       def self.included(klass)
         klass.extend(ClassMethods)

data/lib/nocode/util/string_template.rb

@@ -2,6 +2,11 @@
 
 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 = '>>'
@@ -11,7 +16,7 @@ module Nocode
       attr_reader :expression
 
       def initialize(expression)
-        @expression = expression
+        @expression = expression.to_s
 
         freeze
       end

data/lib/nocode/util.rb

@@ -4,5 +4,5 @@ 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'
-require_relative 'util/string_template'

data/lib/nocode/version.rb

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

data/lib/nocode.rb

@@ -14,7 +14,9 @@ require 'nocode/util'
 # Core
 require 'nocode/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

data/nocode.gemspec

@@ -29,6 +29,7 @@ Gem::Specification.new do |s|
 
   s.required_ruby_version = '>= 2.6'
 
+  s.add_development_dependency('bundler-audit')
   s.add_development_dependency('guard-rspec')
   s.add_development_dependency('pry')
   s.add_development_dependency('rake')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nocode
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Matthew Ruggio
@@ -10,6 +10,20 @@ bindir: exe
 cert_chain: []
 date: 2022-02-13 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler-audit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -162,18 +176,19 @@ files:
 - lib/nocode.rb
 - lib/nocode/context.rb
 - lib/nocode/executor.rb
-- lib/nocode/object_template.rb
 - lib/nocode/step.rb
 - lib/nocode/step_registry.rb
 - lib/nocode/steps/copy.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/io/read.rb
 - lib/nocode/steps/io/write.rb
 - lib/nocode/steps/log.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/util.rb
@@ -181,6 +196,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

data/lib/nocode/object_template.rb

@@ -1,34 +0,0 @@
-# frozen_string_literal: true
-
-module Nocode
-  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