realize 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d5725ecd097c45ce632cd82af3b5c03cd7f54dec0503c007ee28498a2ebe2f0e
-  data.tar.gz: c6731e9b7f14b3c7109e7a680ba107702dc2c65336e5cea75194f6f61501e796
+  metadata.gz: cfdc46e645ec480e88d53d4b68261ce46c2d1db6aff4a7f3a25359e014605246
+  data.tar.gz: ab19b4b184c520c12709739a136c789f35a8f9bb1e770ce6c9b9e7b577b6be3c
 SHA512:
-  metadata.gz: 1dc9995383fa3a27c3414cd1549871724583c19a1dccbda403b6dc6224927711a4d3309a894ddb9ed0c94587a2d7d37ac870a1fbe9fcc45a017073db39570ce0
-  data.tar.gz: 2cc2a27d5faa2aa2cd188c94051beaa1cf92acc2e499b1cf3762f667a0e4e27c2f9a750cfd687990cbdfcf52d86ee494278b4062af0ab091aa117b1ab7db035f
+  metadata.gz: 801d68a75e3138c5dc5cc713550d799f6cc83caf3247451df3a12735cc407ecc4f10c240bbc58a02480da215484bdcb316c41914b74fe0ad9aaa820d523f97e3
+  data.tar.gz: 8b88602a495732c85f5388cf5e9a456e0edb8170e6817947cbf34ec09c33154732f899af70b9608a140dccb57cf8e4c45212b574b7f096a7483a60822b389e6c

data/CHANGELOG.md

@@ -1,3 +1,22 @@
+# 1.2.0 (October 6th, 2020)
+
+New Transformers:
+
+* b/type/boolean
+* b/type/string
+* b/value/now
+* b/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
+
 # 1.0.0 (June 9th, 2020)
 
 Initial Release, includes 15 initial transformers.

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:
@@ -62,6 +62,9 @@ Here is a list of each built-in transformer, their options, and what their funct
 
 #### Collection-oriented Transformers
 
+* **r/collection/at_index** [index]:  Takes an array (or coerces value to an array) and returns the value at the given index position.
+* **r/collection/first** []:  Takes an array (or coerces value to an array) and returns the value at the first index position.
+* **r/collection/last** []:  Takes an array (or coerces value to an array) and returns the value at the last index position.
 * **r/collection/sort** [key, direction]:  Takes an array (or coerces value to an array) and sort it either ascending or descending by some defined key's value.
 
 #### Filtering Transformers
@@ -81,14 +84,21 @@ Here is a list of each built-in transformer, their options, and what their funct
 
 * **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/logical/blank** []: Always return a blank string.
-* **r/logical/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/logical/null** []: Always returns null.
-* **r/logical/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/logical/static** [value]: Always returns a hard-coded value.
-* **r/logical/verbatim** []: Default transformer, simply echos back the input.
+* **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,7 @@
 
 require 'acts_as_hashable'
 require 'objectable'
+require 'securerandom'
 require 'time'
 
 require_relative 'realize/arrays'

data/lib/realize/collection/at_index.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Realize
+  class Collection
+    # Transformer to get an item of a collection
+    class AtIndex
+      acts_as_hashable
+
+      attr_reader :index
+
+      def initialize(index:)
+        raise ArgumentError, 'index is required' if index.to_s.empty?
+
+        @index = index.to_i
+
+        freeze
+      end
+
+      def transform(_resolver, value, _time, _record)
+        value.is_a?(Array) ? value[index] : value
+      end
+    end
+  end
+end

data/lib/realize/collection/first.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Realize
+  class Collection
+    # Transformer to get the first item of a collection
+    class First
+      acts_as_hashable
+
+      def transform(resolver, value, time, record)
+        AtIndex.new(index: 0).transform(resolver, value, time, record)
+      end
+    end
+  end
+end

data/lib/realize/collection/last.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Realize
+  class Collection
+    # Transformer to get the last item of a collection
+    class Last
+      acts_as_hashable
+
+      def transform(resolver, value, time, record)
+        AtIndex.new(index: -1).transform(resolver, value, time, record)
+      end
+    end
+  end
+end

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

@@ -1,19 +1,31 @@
 # frozen_string_literal: true
 
+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 '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
@@ -24,21 +36,32 @@ 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/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.0.0'
+  VERSION = '1.2.0'
 end

data/realize.gemspec

@@ -11,8 +11,8 @@ Gem::Specification.new do |s|
     Derive and transform a value using a configuration-first pipeline.
   DESCRIPTION
 
-  s.authors     = ['Matthew Ruggio']
-  s.email       = ['mruggio@bluemarblepayroll.com']
+  s.authors     = ['Matthew Ruggio', 'Dan Dewar']
+  s.email       = ['mruggio@bluemarblepayroll.com', 'ddewar@bluemarblepayroll.com']
   s.files       = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   s.bindir      = 'exe'
   s.executables = []

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: realize
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Matthew Ruggio
+- Dan Dewar
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-09 00:00:00.000000000 Z
+date: 2020-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: acts_as_hashable
@@ -145,6 +146,7 @@ dependencies:
 description: "    Derive and transform a value using a configuration-first pipeline.\n"
 email:
 - mruggio@bluemarblepayroll.com
+- ddewar@bluemarblepayroll.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -165,6 +167,9 @@ files:
 - exe/.gitkeep
 - lib/realize.rb
 - lib/realize/arrays.rb
+- lib/realize/collection/at_index.rb
+- lib/realize/collection/first.rb
+- lib/realize/collection/last.rb
 - lib/realize/collection/sort.rb
 - lib/realize/collection/sort/direction.rb
 - lib/realize/filter/by_key_record_value.rb
@@ -178,11 +183,15 @@ files:
 - 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