realize 1.1.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f1004b6b97c8ebd485bac4fb9859ffd28511240f4a9943c73875664be35722c
-  data.tar.gz: 979d68bb86ecc8ba32251c2346a0183158686bf04fb9949f04646e7e16a6a03b
+  metadata.gz: 0d7bccc32a2837daee77ec8bcdda00975744c90e0ac08f62f5dbfcaf338dfd91
+  data.tar.gz: aa23c2077287abe225dc2c4b7aa3a2bec7a405bdfd4011ce375d7aed64ac5f56
 SHA512:
-  metadata.gz: f2398a44d581a5e8685ef9c29acbb140fbc2488cb7ffc6411317254325154e30b72b3828b96df5aa7e17f299a79c802f4ece1a50486c0ec62d20bdcb9bd5f073
-  data.tar.gz: 9b87926382b38afda00be7ab8055ab26eea572228489f0d0efd341dd0b709d11d1becafa3e925d79baa5c30bccd0fab30130c8792e646891c902fc6cb7a23aa9
+  metadata.gz: e1201c0671253238b656904b713482db1b53b1f720c36821b87618fd6d0ace49314eda6773080ccb3ed27fca50d8cb68f822547d9d631ff8529f437e7babdba5
+  data.tar.gz: aadc039cccfdcae68d14b7902e854e14078ea2a674d7c4e84cc2f16c2f1e54f6f1cc1568a408676b726b581a5f80004861d44f751a350eb340d1bd995f02d3fe

data/.rubocop.yml

@@ -17,6 +17,7 @@ Metrics/MethodLength:
 
 AllCops:
   TargetRubyVersion: 2.5
+  NewCops: enable
 
 Metrics/AbcSize:
   Max: 16

data/CHANGELOG.md

@@ -1,3 +1,25 @@
+# 1.3.0 (November 4th, 2020)
+
+New Transformers:
+
+* r/format/string_template
+* r/format/substring
+
+# 1.2.0 (October 6th, 2020)
+
+New Transformers:
+
+* r/type/boolean
+* r/type/string
+* r/value/now
+* r/value/uuid
+
+# 1.1.1 (September 9th, 2020)
+
+Fixes:
+
+* Do not leverage #to_datetime even if it is available for date parsing.  This removes un-intentional coupling of other libraries into Realize and keeps it based on Ruby standard and core libraries.
+
 # 1.1.0 (June 24th, 2020)
 
 Addition of r/collection/at_index, r/collection/first, and r/collection/last

data/README.md

@@ -13,7 +13,7 @@ It is currently used in production at Blue Marble to power the transformation pi
 To install through Rubygems:
 
 ````
-gem install install realize
+gem install realize
 ````
 
 You can also add this to your Gemfile:
@@ -79,18 +79,27 @@ Here is a list of each built-in transformer, their options, and what their funct
 * **r/format/date** [input_format, output_format]: Parses the incoming value into a Time object using the configured input_format and outputs it as formatted by the configured output_format.
 * **r/format/remove_whitespace** []: Removes all whitespace from the incoming value.
 * **r/format/string_replace** [original, replacement]: Replaces all occurrences of the configured original value with the replacement value.
+* **r/format/string_template** [expression, separator, use_record]: String interpolate an expression using either the record or passed in value.  Nested objects can be handled (i.e. key paths like dot-notation) by passing in a separator.
+* **r/format/substring** [start_index, end_index, exclusive]: Cut a string in a given range.  All options are optional.  If a start_index is not provided, the beginning of the string is used.  If no end_index is specified then the end of the string is used.  If exclusive is set to true then the last index position will not be included.  For example: "hellofriend" with a start_index of 0, an end_index of 5, and exclusive as true would yield: "hello".  If exclusive was false then it would yield "hellof"
 
 #### Logical Transformers
 
 * **r/logical/switch** [cases, default_transformers, key]: Provides a value-based logic branching.  If a value matches a specific case, the specific cases transformers will be executed.  If it does not match any case then the default_transformers will be executed.
 
+#### Type Transformers
+
+* **r/type/boolean** [nullable]: Returns `true` if the input is 'truthy', `false` if not.  By default nullable is false, which means a nil input will return false.  Changing this to true will return nil if nil is passed in.  A 'truthy' value is defined as matching: true, t, yes, y, or 1 (case-insensitive).
+* **r/type/string** []: Calls `#to_s` on the value so the returned value is guaranteed to be a string type.
+
 #### Value-oriented Transformers
 
 * **r/value/blank** []: Always return a blank string.
 * **r/value/map** [values]: Do a lookup on the value using the `values` hash.  If a value is found, then its corresponding value is returned.  If it isn't then the input is returned.
+* **r/value/now** [utc_offset]: Returns a Time object, defaulting to UTC offset.  You can optionally pass in a different offset in the FORM: "+/-HH:MM"
 * **r/value/null** []: Always returns null.
 * **r/value/resolve** [key]: Dynamically resolves a value based on the record's key.  It uses the [Objectable](https://github.com/bluemarblepayroll/objectable) library by default, which provides some goodies like dot-notation for nested objects and type-insensitivity (works for Ruby objects, hashes, structs, etc.)
 * **r/value/static** [value]: Always returns a hard-coded value.
+* **r/value/uuid** []: Returns a new 36 character UUID (i.e. 6967fec6-bbde-4497-82d9-55ccc7b87cd0)
 * **r/value/verbatim** []: Default transformer, simply echos back the input.
 
 ### Plugging in Transformers

data/lib/realize.rb

@@ -9,6 +9,8 @@
 
 require 'acts_as_hashable'
 require 'objectable'
+require 'securerandom'
+require 'stringento'
 require 'time'
 
 require_relative 'realize/arrays'

data/lib/realize/format/date.rb

@@ -30,12 +30,10 @@ module Realize
         return nil if value.to_s.empty?
 
         date_time =
-          if value.respond_to?(:to_datetime)
-            value.to_datetime
-          elsif input_format?
+          if input_format?
             DateTime.strptime(value, input_format)
           else
-            DateTime.parse(value)
+            DateTime.parse(value.to_s)
           end
 
         date_time.strftime(output_format)

data/lib/realize/format/string_template.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Realize
+  class Format
+    # Use an expression as a template and string interpolate it using the Stringento library.
+    # Stringento also uses Objectable to provide (optional) key-path notation for handling
+    # nested objects.
+    # For more information see underlying libraries:
+    #   * Stringento: https://github.com/bluemarblepayroll/stringento
+    #   * Objectable: https://github.com/bluemarblepayroll/objectable
+    class StringTemplate
+      acts_as_hashable
+
+      DEFAULT_SEPARATOR = '.'
+
+      attr_reader :expression, :resolver, :use_record
+
+      def initialize(expression: '', separator: DEFAULT_SEPARATOR, use_record: false)
+        @expression = expression.to_s
+        @resolver   = Objectable.resolver(separator: separator)
+        @use_record = use_record || false
+
+        freeze
+      end
+
+      def transform(_resolver, value, _time, record)
+        input = use_record ? record : value
+
+        Stringento.evaluate(expression, input, resolver: self)
+      end
+
+      # For Stringento consumption
+      def resolve(value, input)
+        resolver.get(input, value)
+      end
+    end
+  end
+end

data/lib/realize/format/substring.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Realize
+  class Format
+    # Cut a string using a range (start and end index).  You can also choose whether you wish the
+    # range selection to be inclusive (default) or exclusive.
+    #
+    # Examples using the string: '012-345-6789'
+    #
+    # Exclusive vs. Inclusive
+    #
+    # [start_index: 4, end_index: 6, exclusive: false] => '345'
+    # [start_index: 4, end_index: 6, exclusive: true]  => '34'
+    #
+    # Default Values / Omitted Options
+    #
+    # [end_index: 6]   => '012-345'
+    # [start_index: 4] => '345-6789'
+    class Substring
+      acts_as_hashable
+
+      DEFAULT_END_INDEX   = -1
+      DEFAULT_START_INDEX = 0
+
+      attr_reader :end_index, :exclusive, :start_index
+
+      def initialize(
+        end_index: DEFAULT_END_INDEX,
+        exclusive: false,
+        start_index: DEFAULT_START_INDEX
+      )
+        @end_index   = end_index.to_i
+        @exclusive   = exclusive || false
+        @start_index = start_index.to_i
+
+        freeze
+      end
+
+      def transform(_resolver, value, _time, _record)
+        exclusive ? value.to_s[start_index...end_index] : value.to_s[start_index..end_index]
+      end
+    end
+  end
+end

data/lib/realize/logical/switch.rb

@@ -14,7 +14,7 @@ module Realize
 
       attr_reader :cases, :default_transformers, :key
 
-      def initialize(cases: [], default_transformers: [], key:)
+      def initialize(key:, cases: [], default_transformers: [])
         raise ArgumentError, 'key is required' if key.to_s.empty?
 
         @cases                = Case.array(cases)

data/lib/realize/transformers.rb

@@ -4,19 +4,30 @@ require_relative 'collection/at_index'
 require_relative 'collection/first'
 require_relative 'collection/last'
 require_relative 'collection/sort'
+
 require_relative 'filter/by_key_record_value'
 require_relative 'filter/by_key_value'
 require_relative 'filter/by_key_value_presence'
 require_relative 'filter/inactive'
+
 require_relative 'format/date'
 require_relative 'format/remove_whitespace'
 require_relative 'format/string_replace'
+require_relative 'format/string_template'
+require_relative 'format/substring'
+
 require_relative 'logical/switch'
+
+require_relative 'type/boolean'
+require_relative 'type/string'
+
 require_relative 'value/blank'
 require_relative 'value/map'
+require_relative 'value/now'
 require_relative 'value/null'
 require_relative 'value/resolve'
 require_relative 'value/static'
+require_relative 'value/uuid'
 require_relative 'value/verbatim'
 
 module Realize
@@ -27,24 +38,34 @@ module Realize
   class Transformers
     acts_as_hashable_factory
 
-    register '',                               Value::Verbatim
     register 'r/collection/at_index',          Collection::AtIndex
     register 'r/collection/first',             Collection::First
     register 'r/collection/last',              Collection::Last
     register 'r/collection/sort',              Collection::Sort
+
     register 'r/filter/by_key_record_value',   Filter::ByKeyRecordValue
     register 'r/filter/by_key_value',          Filter::ByKeyValue
     register 'r/filter/by_key_value_presence', Filter::ByKeyValuePresence
     register 'r/filter/inactive',              Filter::Inactive
+
     register 'r/format/date',                  Format::Date
     register 'r/format/remove_whitespace',     Format::RemoveWhitespace
     register 'r/format/string_replace',        Format::StringReplace
+    register 'r/format/string_template',       Format::StringTemplate
+    register 'r/format/substring',             Format::Substring
+
     register 'r/logical/switch',               Logical::Switch
+
+    register 'r/type/boolean',                 Type::Boolean
+    register 'r/type/string',                  Type::String
+
     register 'r/value/blank',                  Value::Blank
     register 'r/value/map',                    Value::Map
+    register 'r/value/now',                    Value::Now
     register 'r/value/null',                   Value::Null
     register 'r/value/resolve',                Value::Resolve
     register 'r/value/static',                 Value::Static
-    register 'r/value/verbatim',               Value::Verbatim
+    register 'r/value/uuid',                   Value::Uuid
+    register 'r/value/verbatim', '',           Value::Verbatim
   end
 end

data/lib/realize/type/boolean.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Realize
+  class Type
+    # Convert input into either true, false, or nil.
+    # By default nils will return false unless nullable: true is passed in.
+    # This transformer is very liberal in its parsing and will return true for:
+    #   true, 'true', 't', 'TRUE', 'True', 1, '1', 'Y', 'yes', 'Yes', 'YES'
+    # All other non-truthy values will evaluate to false, such as:
+    #   false, 'false', 'f', 'FALSE', 'False', 0, '0', 'N', 'no', 'No', 'NO', {}, [], '',
+    #   'abc', 123, :abc, etc...
+    class Boolean
+      acts_as_hashable
+
+      attr_reader :nullable
+
+      def initialize(nullable: false)
+        @nullable = nullable || false
+      end
+
+      def transform(_resolver, value, _time, _record)
+        if nullable && value.nil?
+          nil
+        elsif truthy?(value)
+          true
+        else
+          false
+        end
+      end
+
+      private
+
+      def truthy?(value)
+        value.to_s.match?(/(true|t|yes|y|1)$/i)
+      end
+    end
+  end
+end

data/lib/realize/type/string.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Realize
+  class Type
+    # Call #to_s on the value and return result.
+    class String
+      acts_as_hashable
+
+      attr_reader :nullable
+
+      def initialize(nullable: false)
+        @nullable = nullable || false
+      end
+
+      def transform(_resolver, value, _time, _record)
+        return nil if nullable && value.nil?
+
+        value.to_s
+      end
+    end
+  end
+end

data/lib/realize/value/now.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Realize
+  class Value
+    # Return a current Time object.
+    class Now
+      acts_as_hashable
+
+      DEFAULT_UTC_OFFSET = '+00:00'
+
+      attr_reader :utc_offset
+
+      def initialize(utc_offset: DEFAULT_UTC_OFFSET)
+        @utc_offset = utc_offset || DEFAULT_UTC_OFFSET
+
+        freeze
+      end
+
+      def transform(_resolver, _value, _time, _record)
+        Time.now.utc.localtime(utc_offset)
+      end
+    end
+  end
+end

data/lib/realize/value/uuid.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Realize
+  class Value
+    # Return a current Time object.
+    class Uuid
+      acts_as_hashable
+
+      def transform(_resolver, _value, _time, _record)
+        SecureRandom.uuid
+      end
+    end
+  end
+end

data/lib/realize/version.rb

@@ -8,5 +8,5 @@
 #
 
 module Realize
-  VERSION = '1.1.0'
+  VERSION = '1.3.0'
 end

data/realize.gemspec

@@ -30,12 +30,13 @@ Gem::Specification.new do |s|
 
   s.add_dependency('acts_as_hashable', '~>1', '>=1.2.0')
   s.add_dependency('objectable', '~>1')
+  s.add_dependency('stringento', '~>2.1')
 
   s.add_development_dependency('guard-rspec', '~>4.7')
   s.add_development_dependency('pry', '~>0')
   s.add_development_dependency('rake', '~> 13')
   s.add_development_dependency('rspec')
-  s.add_development_dependency('rubocop', '~>0.79.0')
+  s.add_development_dependency('rubocop', '~>1.1')
   s.add_development_dependency('simplecov', '~>0.17.0')
   s.add_development_dependency('simplecov-console', '~>0.6.0')
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: realize
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Matthew Ruggio
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-24 00:00:00.000000000 Z
+date: 2020-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: acts_as_hashable
@@ -45,6 +45,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1'
+- !ruby/object:Gem::Dependency
+  name: stringento
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -107,14 +121,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.79.0
+        version: '1.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.79.0
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -179,15 +193,21 @@ files:
 - lib/realize/format/date.rb
 - lib/realize/format/remove_whitespace.rb
 - lib/realize/format/string_replace.rb
+- lib/realize/format/string_template.rb
+- lib/realize/format/substring.rb
 - lib/realize/logical/switch.rb
 - lib/realize/logical/switch/case.rb
 - lib/realize/pipeline.rb
 - lib/realize/transformers.rb
+- lib/realize/type/boolean.rb
+- lib/realize/type/string.rb
 - lib/realize/value/blank.rb
 - lib/realize/value/map.rb
+- lib/realize/value/now.rb
 - lib/realize/value/null.rb
 - lib/realize/value/resolve.rb
 - lib/realize/value/static.rb
+- lib/realize/value/uuid.rb
 - lib/realize/value/verbatim.rb
 - lib/realize/version.rb
 - realize.gemspec