nay 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e7aa4e8a6e59c35d02dac84443aa109593f4c16ea23298d3bbbcd4e0c7c7baf5
-  data.tar.gz: ee9d6518d6597bc1a68ef2d3a4261ced357b86a32b0482565dd44ca811dea2d4
+  metadata.gz: b57f5f0b2fa5d4029a0929787441104e328b7d3a2a90a10ad31d916dc240980c
+  data.tar.gz: 3304ea0e737b31138c7962e0279ba0ffc648c5ef5a4f5ceb24a73c8f7a3d2314
 SHA512:
-  metadata.gz: e79219112b550df70baa420a7070ee3cc2766b906e535fdf6d8f84e10451f65173e8624b0a71778d4d80acef017ef2b588a3e21993826933ba000266ef18319f
-  data.tar.gz: 778e6dd6a679833a2cdeefb327f5d84f2aacabf74aee750085e02c318dc8781369281dbcdd1a155f30e5a0ba228f5d91ce953cd17f6113b8ba47af07631945dc
+  metadata.gz: 07a0c0cfde1458fe322091287277128757514a581c0fabc9cc782efe38d6a23572bd9e1d43f88e96c8c7fbba6a6fd052ac7cda7c840a77e13f0f5f1598d23684
+  data.tar.gz: 8924a857891e42d710de59cafbd54247f46e018f02195e9d762cec56893d53ed3015ed31658f5eeeba32eba3f48e0e22fee2bd4120596fe2ab1026479ac18457

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+#### 0.0.3 - February 18th, 2022
+
+* Works with not just string expressions but with also hash and arrays.
+#### 0.0.2 - February 18th, 2022
+
+* Add underscore and hyphen to list of acceptable tokens without qualifying.
+
 #### 0.0.1 - February 17th, 2022
 
 * Initial version.

data/README.md

@@ -22,6 +22,8 @@ bundle add nay
 
 ## Examples
 
+### Simple String-based Expression
+
 ````ruby
 animal   = {
   'animal' => {
@@ -41,6 +43,59 @@ Notes:
 * Tokens are passed through #[] method for the passed in object.  Any object providing a brackets interface will work.
 * A valid token only contains the following characters: [a-zA-Z0-9_-]. If a token needs to contain something not in that list then qualify it with double quotes (i.e. `hello, << person."first name" >>`)
 
+### More Complex Expressions
+
+Expressions are not limited to just being a string.  Here are the basic heuristics:
+
+* hash: then each key and value are recursively traversed
+* array: then each entry is recursively traversed
+* string: evaluated with parameters
+* anything not a hash, array, or string: do nothing
+
+An example of this would be a somewhat complicated object:
+
+````ruby
+object = {
+  '<< id_key >>' => '<< id >>',
+  'pets' => [
+    '<< pets."pet 1" >>',
+    '<< pets."pet 2" >>'
+  ],
+  zyx: :vut
+}
+
+parameters = {
+  'id_key' => 'id',
+  'id' => 123,
+  'pets' => {
+    'pet 1' => 'dog',
+    'pet 2' => 'cat'
+  },
+  zyx: :vut
+}
+
+evaluated_object = Nay.evaluate(object, parameters)
+````
+
+In the above example evaluated_object would be equivalent to:
+
+````ruby
+{
+  'id' => '123',
+  'pets' => [
+    'dog',
+    'cat'
+  ],
+  zyx: :vut
+}
+````
+
+Notes:
+
+* A hash, hash key, and hash value are represented here
+* An array with entries are represented here
+* A non-string is represented here (as the zyx/vut key/value)
+
 ## Contributing
 
 ### Development Environment Configuration

data/lib/nay/evaluator.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Nay
-  # Knows how to take a stream of lexically analyzed tokens along with an input hash and
+  # Knows how to take a stream of lexically analyzed tokens along with a parameters hash and
   # evaluate interpolated key paths.
   class Evaluator
     attr_reader :lexer
@@ -10,16 +10,16 @@ module Nay
       @lexer = lexer
     end
 
-    def evaluate(input = {})
+    def evaluate(parameters = {})
       io      = StringIO.new
-      pointer = input
+      pointer = parameters
 
       while (token = lexer.next_token)
         case token.type
         when Lexer::CONTENT
           io << token.literal
         when Lexer::OPEN_EXPRESSION
-          pointer = input
+          pointer = parameters
         when Lexer::IDENTIFIER
           pointer = traverse(pointer, token.literal)
         when Lexer::CLOSE_EXPRESSION
@@ -32,8 +32,8 @@ module Nay
 
     private
 
-    def traverse(input, value)
-      input[value] if input.respond_to?(:[])
+    def traverse(parameters, value)
+      parameters[value] if parameters.respond_to?(:[])
     end
   end
 end

data/lib/nay/template.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require_relative 'evaluator'
+require_relative 'lexer'
+
+module Nay
+  # Built on top of the string-based Lexer/Evaluator but instead of only working for a string,
+  # this will recursively evaluate all strings within an object.  Heuristics:
+  #    - Hashes will have their keys and parameters traversed
+  #    - Arrays will have their entries traversed
+  #    - Strings evaluate using Lexer
+  #    - All other types will simply return themselves (not be traversed or use the Lexer)
+  class Template
+    attr_reader :object
+
+    def initialize(object)
+      @object = object
+
+      freeze
+    end
+
+    def evaluate(parameters = {})
+      recursive_evaluate(object, parameters)
+    end
+
+    private
+
+    def recursive_evaluate(expression, parameters)
+      case expression
+      when Array
+        expression.map { |o| recursive_evaluate(o, parameters) }
+      when Hash
+        expression.to_h do |k, v|
+          [recursive_evaluate(k, parameters), recursive_evaluate(v, parameters)]
+        end
+      when String
+        Evaluator.new(Lexer.new(expression)).evaluate(parameters)
+      else
+        expression
+      end
+    end
+  end
+end

data/lib/nay/version.rb

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

data/lib/nay.rb

@@ -3,17 +3,13 @@
 require 'stringio'
 require 'strscan'
 
-require_relative 'nay/evaluator'
-require_relative 'nay/lexer'
+require_relative 'nay/template'
 
 # Top-level API
 module Nay
   class << self
-    def evaluate(string = '', input = {})
-      lexer     = Lexer.new(string)
-      evaluator = Evaluator.new(lexer)
-
-      evaluator.evaluate(input)
+    def evaluate(object, parameters = {})
+      Template.new(object).evaluate(parameters)
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nay
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Matthew Ruggio
@@ -188,6 +188,7 @@ files:
 - lib/nay/evaluator.rb
 - lib/nay/lexer.rb
 - lib/nay/state.rb
+- lib/nay/template.rb
 - lib/nay/token.rb
 - lib/nay/version.rb
 - nay.gemspec