realize 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 65013db138b786888e85a76bb1532122e0faf8ef4d2eff4e5e287231cda4e999
-  data.tar.gz: dc4117f7fc4d2c2b39767e24006c6811ca4065621e984554aaa0004a5bf4a9e9
+  metadata.gz: f6decbc7d163ec927dbb7927ac09aee8d5df5b4de3d44e4ea233959bd1456276
+  data.tar.gz: b4c96da12cbc56d66a50f9396a4e66e3f97dbb035a62d31c29532030c7ee3e3b
 SHA512:
-  metadata.gz: c5a90f318c8958386a920fe5643ce5e9851bc5e513c6e31634b3a06abe3e8c00b6e0b4990fca235f5ec8c608743f576ac7a27810499d3454dddd01629f405408
-  data.tar.gz: 3d58041bd36ce2ec71254cf17c0b98c883e213e0d3679b8b915b3f0d633f83f9818eeaea53e7395a5104017ad183e220bc8ccf2ed647f60d45c384002a105951
+  metadata.gz: e24dffe48d39646bb6e631000c03cb0480ac539d368008ca49d38528696b4b8b37f61fdf2524a9b7c308ec10707b16d6d3966948a4ca0b0be4603e1aa0834dca
+  data.tar.gz: f1d2105f0d009d0520edcd846e9f0b6e00bed4816f07498495a9a51ad849fd1d4a527af122e7c8cc17a6aadaaf101d22aa7f3db36037b895cf7a3b8fa33a33ff

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+# 1.5.0 (TBD)
+
+New Transformers:
+
+* r/file/basename
+* r/file/extname
+* r/format/pad
+* r/format/sha256
+* r/format/split
+* r/type/array
+
 # 1.4.0 (November 16th, 2020)
 
 New Transformers:

data/README.md

@@ -1,6 +1,6 @@
 # Realize
 
-[![Gem Version](https://badge.fury.io/rb/realize.svg)](https://badge.fury.io/rb/realize) [![Build Status](https://travis-ci.org/bluemarblepayroll/realize.svg?branch=master)](https://travis-ci.org/bluemarblepayroll/realize) [![Maintainability](https://api.codeclimate.com/v1/badges/115f0c5a1d0a4cce7230/maintainability)](https://codeclimate.com/github/bluemarblepayroll/realize/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/115f0c5a1d0a4cce7230/test_coverage)](https://codeclimate.com/github/bluemarblepayroll/realize/test_coverage) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Gem Version](https://badge.fury.io/rb/realize.svg)](https://badge.fury.io/rb/realize) [![Build Status](https://travis-ci.com/bluemarblepayroll/realize.svg?branch=master)](https://travis-ci.com/bluemarblepayroll/realize) [![Maintainability](https://api.codeclimate.com/v1/badges/115f0c5a1d0a4cce7230/maintainability)](https://codeclimate.com/github/bluemarblepayroll/realize/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/115f0c5a1d0a4cce7230/test_coverage)](https://codeclimate.com/github/bluemarblepayroll/realize/test_coverage) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
 This library provides a pluggable and configurable data transformation framework.  The general use-case is:
 
@@ -67,6 +67,10 @@ Here is a list of each built-in transformer, their options, and what their funct
 * **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.
 
+#### File-based Transformers
+
+* **r/file/basename** [suffix]: Return the filename and extension.  If suffix is provided then it will be stripped from the end.  If '.*' is passed as the suffix then any extension will be ignored.
+* **r/file/extname** [suffix]: Return the extension for value.
 #### Filtering Transformers
 
 * **r/filter/by_key_record_value** [key, value]: Takes an array (or coerces value to an array) and selects only the records that match the key's value.  In this case the value is derived off of the main record.
@@ -78,7 +82,10 @@ 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/lowercase** []: Calls `#to_s.downcase` on the value so the returned value is guaranteed to be a lower-cased string.
+* **r/format/pad** [length, side, with]: Pad a string value with a specified 'with' value (defaults to blank space) up until the passed in length is reached.  The 'side' option can be used to specify whether the padding should occur to the left or right side of the value.
 * **r/format/remove_whitespace** []: Removes all whitespace from the incoming value.
+* **r/format/sha256** [encoding_format]: Convert the value into a SHA256 encoded string.  The encoding_format will be hex by default but can also be configured to use base64.
+* **r/format/split** [by]: Take a string value and split it on the specified 'by' value.  By default, it will be split on a blank space.
 * **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"
@@ -90,6 +97,7 @@ Here is a list of each built-in transformer, their options, and what their funct
 
 #### Type Transformers
 
+* **r/type/array** [nullable]: Ensure the value is an array by calling Kernel#Array on the value.
 * **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** [nullable]: Calls `#to_s` on the value so the returned value is guaranteed to be a string type.
 

data/lib/realize.rb

@@ -8,6 +8,7 @@
 #
 
 require 'acts_as_hashable'
+require 'digest'
 require 'objectable'
 require 'securerandom'
 require 'stringento'

data/lib/realize/file/basename.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2020-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+module Realize
+  class File
+    # Takes the value and strips out the directory.  Suffix is provided as an option which strips
+    # out the extension (last period and beyond).  If '.*' is passed in as the suffix then any
+    # extension will be stripped.  Note that files with multiple extensions will only have their
+    # last extesion removed.
+    class Basename
+      acts_as_hashable
+
+      attr_reader :suffix
+
+      def initialize(suffix: '')
+        @suffix = suffix.to_s
+
+        freeze
+      end
+
+      def transform(_resolver, value, _time, _record)
+        ::File.basename(value.to_s, suffix)
+      end
+    end
+  end
+end

data/lib/realize/file/extname.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2020-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+module Realize
+  class File
+    # Extract the file extension from the value.  If the value has multiple extensions then
+    # only the last one will be returned.
+    class Extname
+      acts_as_hashable
+
+      def transform(_resolver, value, _time, _record)
+        ::File.extname(value.to_s)
+      end
+    end
+  end
+end

data/lib/realize/format/pad.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2020-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+module Realize
+  class Format
+    # Pad a string value with a specified 'with' value (defaults to blank space) up until the
+    # passed in length is reached.  The 'side' option can be used to specify whether the
+    # padding should occur to the left or right side of the value.
+    # Examples:
+    #   'ABC' + [length: 10, side: 'left', with: '123'] => '1231231ABC'
+    #   'ABC' + [length: 10, side: 'right, with: '123'] => 'ABC1231231'
+    #
+    # If length is not specified or is less than the actual value's length then no padding
+    # will occur.
+    class Pad
+      acts_as_hashable
+
+      module Side
+        LEFT = :left
+        RIGHT = :right
+      end
+      include Side
+
+      DEFAULT_SIDE = LEFT
+      DEFAULT_WITH = ' '
+
+      attr_reader :length, :side, :with
+
+      def initialize(length: nil, side: LEFT, with: DEFAULT_WITH)
+        @length = length ? length.to_i : nil
+        @side   = Side.const_get(side.to_s.upcase.to_sym)
+        @with   = with.to_s
+
+        freeze
+      end
+
+      def transform(_resolver, value, _time, _record)
+        return value unless length
+
+        value.to_s.send(just_method, length, with)
+      end
+
+      private
+
+      def just_method
+        case side
+        when LEFT
+          :rjust
+        when RIGHT
+          :ljust
+        end
+      end
+    end
+  end
+end

data/lib/realize/format/sha256.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2020-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+module Realize
+  class Format
+    # Convert the value into a SHA256 encoded string.  There are two main encoding formats:
+    # hex or base64.  By default, the value will be hexidecimal encoded.
+    class Sha256
+      acts_as_hashable
+
+      module EncodingFormat
+        HEX    = :hex
+        BASE64 = :base64
+      end
+      include EncodingFormat
+
+      DEFAULT_ENCODING_FORMAT = HEX
+
+      attr_reader :encoding_format
+
+      def initialize(encoding_format: DEFAULT_ENCODING_FORMAT)
+        @encoding_format = EncodingFormat.const_get(encoding_format.to_s.upcase.to_sym)
+
+        freeze
+      end
+
+      def transform(_resolver, value, _time, _record)
+        Digest::SHA256.send(sha_method, value.to_s)
+      end
+
+      private
+
+      def sha_method
+        case encoding_format
+        when HEX
+          :hexdigest
+        when BASE64
+          :base64digest
+        end
+      end
+    end
+  end
+end

data/lib/realize/format/split.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2020-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+module Realize
+  class Format
+    # Take a string value and split it on the specified 'by' value.  By default, it will be
+    # split on a blank space.  For example: '123 456 789' would yield ['123', '456', '789'].
+    # If the value is not a string then it will be converted to a string by calling #to_s on it.
+    class Split
+      acts_as_hashable
+
+      DEFAULT_BY = ' '
+
+      attr_reader :by
+
+      def initialize(by: DEFAULT_BY)
+        @by = by.to_s
+
+        freeze
+      end
+
+      def transform(_resolver, value, _time, _record)
+        value.to_s.split(by)
+      end
+    end
+  end
+end

data/lib/realize/transformers.rb

@@ -12,6 +12,9 @@ require_relative 'collection/first'
 require_relative 'collection/last'
 require_relative 'collection/sort'
 
+require_relative 'file/basename'
+require_relative 'file/extname'
+
 require_relative 'filter/by_key_record_value'
 require_relative 'filter/by_key_value'
 require_relative 'filter/by_key_value_presence'
@@ -19,7 +22,10 @@ require_relative 'filter/inactive'
 
 require_relative 'format/date'
 require_relative 'format/lowercase'
+require_relative 'format/pad'
 require_relative 'format/remove_whitespace'
+require_relative 'format/sha256'
+require_relative 'format/split'
 require_relative 'format/string_replace'
 require_relative 'format/string_template'
 require_relative 'format/substring'
@@ -27,6 +33,7 @@ require_relative 'format/uppercase'
 
 require_relative 'logical/switch'
 
+require_relative 'type/array'
 require_relative 'type/boolean'
 require_relative 'type/string'
 
@@ -52,6 +59,9 @@ module Realize
     register 'r/collection/last',              Collection::Last
     register 'r/collection/sort',              Collection::Sort
 
+    register 'r/file/basename',                File::Basename
+    register 'r/file/extname',                 File::Extname
+
     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
@@ -59,7 +69,10 @@ module Realize
 
     register 'r/format/date',                  Format::Date
     register 'r/format/lowercase',             Format::Lowercase
+    register 'r/format/pad',                   Format::Pad
     register 'r/format/remove_whitespace',     Format::RemoveWhitespace
+    register 'r/format/sha256',                Format::Sha256
+    register 'r/format/split',                 Format::Split
     register 'r/format/string_replace',        Format::StringReplace
     register 'r/format/string_template',       Format::StringTemplate
     register 'r/format/substring',             Format::Substring
@@ -67,6 +80,7 @@ module Realize
 
     register 'r/logical/switch',               Logical::Switch
 
+    register 'r/type/array',                   Type::Array
     register 'r/type/boolean',                 Type::Boolean
     register 'r/type/string',                  Type::String
 

data/lib/realize/type/array.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2020-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+require_relative 'base'
+
+module Realize
+  class Type
+    # Ensure the value is an array by calling Kernel#Array on the value.  If the value is a hash
+    # then it will ensure the hash data structure is preserved and placed within the array.
+    # Normally calling Array(hash) would yield an array of key-value pair arrays.  For our
+    # pipeline we generally treat hashes as "record-like" objects, so we need to ensure
+    # we keep it in tact.
+    #
+    # This does not mean other data types do not suffer from Kernel#Array
+    # converting it to something unexpected. For example, passing in a Time object would yield
+    # an array of parts:
+    #   Array(Time.now) => [2, 59, 10, 21, 11, 2020, 6, 326, false, "CST"]
+    #
+    # See: https://ruby-doc.org/core-2.7.2/Kernel.html#method-i-Array for more information.
+    class Array < Base
+      include Arrays
+
+      def transform(_resolver, value, _time, _record)
+        return nil if nullable && value.nil?
+
+        array(value)
+      end
+    end
+  end
+end

data/lib/realize/version.rb

@@ -8,5 +8,5 @@
 #
 
 module Realize
-  VERSION = '1.4.0'
+  VERSION = '1.5.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: realize
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Matthew Ruggio
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-11-16 00:00:00.000000000 Z
+date: 2020-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: acts_as_hashable
@@ -186,13 +186,18 @@ files:
 - lib/realize/collection/last.rb
 - lib/realize/collection/sort.rb
 - lib/realize/collection/sort/direction.rb
+- lib/realize/file/basename.rb
+- lib/realize/file/extname.rb
 - lib/realize/filter/by_key_record_value.rb
 - lib/realize/filter/by_key_value.rb
 - lib/realize/filter/by_key_value_presence.rb
 - lib/realize/filter/inactive.rb
 - lib/realize/format/date.rb
 - lib/realize/format/lowercase.rb
+- lib/realize/format/pad.rb
 - lib/realize/format/remove_whitespace.rb
+- lib/realize/format/sha256.rb
+- lib/realize/format/split.rb
 - lib/realize/format/string_replace.rb
 - lib/realize/format/string_template.rb
 - lib/realize/format/substring.rb
@@ -201,6 +206,7 @@ files:
 - lib/realize/logical/switch/case.rb
 - lib/realize/pipeline.rb
 - lib/realize/transformers.rb
+- lib/realize/type/array.rb
 - lib/realize/type/base.rb
 - lib/realize/type/boolean.rb
 - lib/realize/type/string.rb