invoca-utils 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 926143286cf40283408cd86732347339453d12a671c2e1539f01e391cef84ed4
-  data.tar.gz: b4114b43131585610f6e875680895e1be15fe68e164a0a8904ddec46b59e58cf
+  metadata.gz: 54dcad50905bf9c0d48905b88e563c6418ea4bc852e4f85d4cd892e2b2031096
+  data.tar.gz: 592dde85e812312a5fb5ff67d34da1d5a0127f0c2c2f5f60538baab3c63d32ff
 SHA512:
-  metadata.gz: 50a6cf86a1547385b1b7dabfce31f4a89d0156f872f7dde7b6e179afd6373f8b56cc6e4bfea3b383af02aaabb6567a096d4dfe9250a8e639a0f02c3d0535455f
-  data.tar.gz: 2bcfc2fa9de854a2f78ba03a5bd9814fc921c9ab668ca0660491b14679e81536a9e4c61cb6e4b8f00f88ddb609a891956f02094de64e48efbe0411fdc4afbeff
+  metadata.gz: 6fac4beb8eef9b3a4ebc3615cb7711c9134e401e34ba26a2d0012b89c7962ca19440b2ceb2e0fafd5aaafcd4576717d10fddd276c4583858ffc725904194464a
+  data.tar.gz: c312101bd66d62f9c145610be64a8e75ec931387d4dc33f581885dc5707ff7565e474fd618ddbf569ed9091a591d0f2e0a164b7899ffe311b889c62fbc5a7d37

data/CHANGELOG.md

@@ -4,6 +4,12 @@ Inspired by [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 Note: This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.4.0] - 2020-06-09
+### Added
+- Added `Invoca::Utils.retry_on_exception`.
+- Added `Invoca::Utils::GuaranteedUTF8String.normalize_all_strings` to normalize
+  all strings found in a JSON doc of hashes, arrays, and values.
+
 ## [0.3.0] - 2020-04-28
 ### Added
 - Array::* operator changed to use alias_method instead of prepend to prevent infinite recursion when HoboSupport gem is present
@@ -17,5 +23,6 @@ Note: This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0
 - Enumerable::build_hash method ported from HoboSupport
 - Enumerable::* operator ported from HoboSupport
 
+[0.4.0]: https://github.com/Invoca/invoca-utils/compare/v0.3.0...v0.4.0
 [0.3.0]: https://github.com/Invoca/invoca-utils/compare/v0.2.0...v0.3.0
 [0.2.0]: https://github.com/Invoca/invoca-utils/compare/v0.1.1...v0.2.0

data/Gemfile

@@ -4,7 +4,7 @@ source 'https://rubygems.org'
 
 gemspec
 
-group :development do
+source 'https://rubygems.org' do
   gem 'activesupport', '~> 4.2'
   gem 'minitest'
   gem 'minitest-reporters'
@@ -16,3 +16,7 @@ group :development do
   gem 'test-unit', '= 1.2.3'
   gem 'tzinfo'
 end
+
+source 'https://gem.fury.io/invoca' do
+  gem 'test_overrides',      '~> 0.13'
+end

data/Gemfile.lock

@@ -1,37 +1,38 @@
 PATH
   remote: .
   specs:
-    invoca-utils (0.3.0)
+    invoca-utils (0.4.0)
 
 GEM
   remote: https://rubygems.org/
+  remote: https://gem.fury.io/invoca/
   specs:
-    activesupport (4.2.11.1)
+    activesupport (4.2.11.3)
       i18n (~> 0.7)
       minitest (~> 5.1)
       thread_safe (~> 0.3, >= 0.3.4)
       tzinfo (~> 1.1)
     ansi (1.5.0)
     builder (3.2.4)
-    coderay (1.1.2)
+    coderay (1.1.3)
     concurrent-ruby (1.1.6)
     hoe (3.22.1)
       rake (>= 0.8, < 15.0)
     i18n (0.9.5)
       concurrent-ruby (~> 1.0)
-    method_source (0.9.0)
-    minitest (5.14.0)
-    minitest-reporters (1.1.14)
+    method_source (1.0.0)
+    minitest (5.14.1)
+    minitest-reporters (1.4.2)
       ansi
       builder
       minitest (>= 5.0)
       ruby-progressbar
-    pry (0.11.3)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
     rake (13.0.1)
     rr (1.1.2)
-    ruby-prof (0.17.0)
+    ruby-prof (1.4.1)
     ruby-progressbar (1.10.1)
     shoulda (3.5.0)
       shoulda-context (~> 1.0, >= 1.0.1)
@@ -41,6 +42,7 @@ GEM
       activesupport (>= 3.0.0)
     test-unit (1.2.3)
       hoe (>= 1.5.1)
+    test_overrides (0.13.0)
     thread_safe (0.3.6)
     tzinfo (1.2.7)
       thread_safe (~> 0.1)
@@ -49,17 +51,18 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  activesupport (~> 4.2)
+  activesupport (~> 4.2)!
   invoca-utils!
-  minitest
-  minitest-reporters
-  pry
-  rake
-  rr (= 1.1.2)
-  ruby-prof
-  shoulda (= 3.5.0)
-  test-unit (= 1.2.3)
-  tzinfo
+  minitest!
+  minitest-reporters!
+  pry!
+  rake!
+  rr (= 1.1.2)!
+  ruby-prof!
+  shoulda (= 3.5.0)!
+  test-unit (= 1.2.3)!
+  test_overrides (~> 0.13)!
+  tzinfo!
 
 BUNDLED WITH
    1.17.3

data/Rakefile

@@ -3,6 +3,7 @@
 
 require "bundler/gem_tasks"
 require 'rake/testtask'
+require 'rake_test_warning_false'
 
 task default: :test
 

data/invoca-utils.gemspec

@@ -1,4 +1,4 @@
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'invoca/utils/version'
 
@@ -7,8 +7,7 @@ Gem::Specification.new do |spec|
   spec.version       = Invoca::Utils::VERSION
   spec.authors       = ["Invoca development"]
   spec.email         = ["development@invoca.com"]
-  spec.summary       = %q{A public collection of helpers used in multiple projects}
-  spec.description   = %q{A public collection of helpers used in multiple projects}
+  spec.summary       = "A public collection of helpers used in multiple projects"
   spec.homepage      = ""
   spec.license       = "MIT"
 

data/lib/invoca/utils.rb

@@ -1,5 +1,10 @@
 # frozen_string_literal: true
 
+module Invoca
+  module Utils
+  end
+end
+
 require "invoca/utils/module"
 require "invoca/utils/array"
 require "invoca/utils/enumerable"
@@ -11,14 +16,10 @@ require "invoca/utils/map_compact"
 require "invoca/utils/min_max"
 require "invoca/utils/stable_sort"
 require "invoca/utils/time"
+require "invoca/utils/exceptions"
 require "invoca/utils/guaranteed_utf8_string"
 require "invoca/utils/version"
 
-module Invoca
-  module Utils
-  end
-end
-
 unless defined?(Diff)
   Diff = Invoca::Utils::Diff
 end

data/lib/invoca/utils/exceptions.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Invoca
+  module Utils
+    class << self
+      # Yields and rescues any exceptions given in `exception_classes`, retrying the given number of times.
+      # The final retry does not rescue any exceptions.
+      # The try number (0..retries) is yielded as a block param.
+      #
+      # @param [Class or Array(Class)] exception_classes - exception()s) to rescue
+      # @param [Integer] retries: - 1+ count of retries (1 retry = up to 2 tries total)
+      # @param [Proc] before_retry - optional proc which is called before each retry, with the exception passed as a block param
+      # @return the value from yield
+      def retry_on_exception(exception_classes, retries: 1, before_retry: nil)
+        retries.times do |attempt_number|
+          return yield(attempt_number)
+        rescue *Array(exception_classes) => ex
+          before_retry&.call(ex)
+        end
+
+        yield(retries)   # no rescue for this last try, so any exceptions will raise out
+      end
+    end
+  end
+end

data/lib/invoca/utils/guaranteed_utf8_string.rb

@@ -21,6 +21,7 @@ module Invoca
       REPLACE_CHARACTER = '~'
 
       class << self
+        # normalizes a string to UTF-8
         def normalize_string(orig_string,
                              normalize_utf16:              true,
                              normalize_cp1252:             true,
@@ -43,6 +44,22 @@ module Invoca
                                      replace_unicode_beyond_ffff: replace_unicode_beyond_ffff)
         end
 
+        # Walks a JSON doc of hashes, arrays, and values and normalizes all strings found to UTF-8
+        def normalize_all_strings(value, **options)
+          case value
+          when Hash
+            value.each_with_object({}) do |(k, v), result|
+              result[normalize_all_strings(k, **options)] = normalize_all_strings(v, **options)
+            end
+          when Array
+            value.map { |v| normalize_all_strings(v, **options) }
+          when String
+            normalize_string(value, **options)
+          else
+            value
+          end
+        end
+
         private
 
         def normalize_string_from_utf8(string,
@@ -54,13 +71,11 @@ module Invoca
           found_utf_16 = normalize_utf_16(string, normalize_cp1252: normalize_cp1252) if normalize_utf16
           if found_utf_16
             string.encode!('UTF-8')
-          else
-            unless string.valid_encoding?
-              if normalize_cp1252
-                cp1252_to_utf_8(string)
-              else
-                raise ArgumentError, 'Could not normalize to utf8 due to invalid characters (probably CP1252)'
-              end
+          elsif !string.valid_encoding?
+            if normalize_cp1252
+              cp1252_to_utf_8(string)
+            else
+              raise ArgumentError, 'Could not normalize to utf8 due to invalid characters (probably CP1252)'
             end
           end
           normalize_newlines(string)           if normalize_newlines

data/lib/invoca/utils/hash.rb

@@ -2,7 +2,6 @@
 
 # Invoca ::Hash extensions
 class Hash
-
   def select_hash(&block)
     res = {}
     each { |k, v| res[k] = v if (block.arity == 1 ? yield(v) : yield(k, v)) } # rubocop:disable Style/ParenthesesAroundCondition

data/lib/invoca/utils/version.rb

@@ -2,6 +2,6 @@
 
 module Invoca
   module Utils
-    VERSION = "0.3.0"
+    VERSION = "0.4.0"
   end
 end

data/test/unit/exceptions_test.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require_relative '../test_helper'
+
+class ExceptionsTest < Minitest::Test
+  context "exceptions" do
+    context ".retry_on_exception" do
+      should "default retries: to 1" do
+        times = 0
+        tries = []
+        result = Invoca::Utils.retry_on_exception(ArgumentError) do |try|
+          tries << try
+          times += 1
+        end
+        assert_equal 1, result
+        assert_equal [0], tries
+      end
+
+      context "when never raising an exception" do
+        should "return result" do
+          times = 0
+          tries = []
+          result = Invoca::Utils.retry_on_exception(ArgumentError, retries: 2) do |try|
+            tries << try
+            times += 1
+            try == 0 and raise ArgumentError, '!!!'
+            times
+          end
+          assert_equal 2, result
+          assert_equal [0, 1], tries
+        end
+      end
+
+      context "when always raising an exception" do
+        should "retry and finally raise" do
+          tries = []
+          assert_raises(ArgumentError, /!!! 2/) do
+            Invoca::Utils.retry_on_exception(ArgumentError, retries: 1) do |try|
+              tries << try
+              raise ArgumentError, "!!! #{try + 1}"
+            end
+          end
+          assert_equal [0, 1], tries
+        end
+      end
+
+      context "when raising but then succeeding" do
+        should "retry and finally return result" do
+          times = 0
+          result = Invoca::Utils.retry_on_exception(ArgumentError, retries: 1) do
+            times += 1
+            if times == 1
+              raise ArgumentError, "!!! #{times}"
+            else
+              times
+            end
+          end
+          assert_equal 2, result
+        end
+      end
+
+      context "when raising different exceptions (array notation) but then succeeding" do
+        should "retry and finally return result" do
+          times = 0
+          tries = []
+          result = Invoca::Utils.retry_on_exception([ArgumentError, RuntimeError], retries: 2) do |try|
+            tries << try
+            times += 1
+            case times
+            when 1
+              raise ArgumentError, "!!! #{times}"
+            when 2
+              raise RuntimeError, "!!! #{times}"
+            else
+              times
+            end
+          end
+          assert_equal 3, result
+          assert_equal [0, 1, 2], tries
+        end
+      end
+    end
+  end
+end

data/test/unit/guaranteed_utf8_string_test.rb

@@ -221,6 +221,29 @@ class GuaranteedUTF8StringTest < Minitest::Test
           assert_equal Encoding::UTF_8, encoded_string.encoding
         end
       end
+
+      context ".normalize_strings" do
+        should "walk json doc, replacing strings in: values, inside array elements, and hash keys and values" do
+          json_doc = {
+            '😹' => "\xE2\x9C\x93 laughing cat",
+            ['😹'] => ["\xE2", "\xf0\x9f\x98\xb9", { "newline" => "\r\n" }],
+            'cp1252' => "\x91smart quotes\x92"
+          }
+
+          normalized_json = Invoca::Utils::GuaranteedUTF8String.normalize_all_strings(json_doc,
+                                                                                      normalize_utf16:              true,
+                                                                                      normalize_cp1252:             true,
+                                                                                      normalize_newlines:           true,
+                                                                                      remove_utf8_bom:              true,
+                                                                                      replace_unicode_beyond_ffff:  true)
+
+          assert_equal({
+                         '~' => "✓ laughing cat",
+                         ['~'] => ["â", "~", { "newline" => "\n" }],
+                         'cp1252' => "‘smart quotes’"
+                       }, normalized_json)
+        end
+      end
     end
 
     context 'constructor' do

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: invoca-utils
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Invoca development
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-29 00:00:00.000000000 Z
+date: 2020-06-09 00:00:00.000000000 Z
 dependencies: []
-description: A public collection of helpers used in multiple projects
+description: 
 email:
 - development@invoca.com
 executables: []
@@ -33,6 +33,7 @@ files:
 - lib/invoca/utils/array.rb
 - lib/invoca/utils/diff.rb
 - lib/invoca/utils/enumerable.rb
+- lib/invoca/utils/exceptions.rb
 - lib/invoca/utils/guaranteed_utf8_string.rb
 - lib/invoca/utils/hash.rb
 - lib/invoca/utils/hash_with_indifferent_access.rb
@@ -48,6 +49,7 @@ files:
 - test/test_helper.rb
 - test/unit/array_test.rb
 - test/unit/enumerable_test.rb
+- test/unit/exceptions_test.rb
 - test/unit/guaranteed_utf8_string_test.rb
 - test/unit/hash_test.rb
 - test/unit/hash_with_indifferent_access_test.rb
@@ -86,6 +88,7 @@ test_files:
 - test/test_helper.rb
 - test/unit/array_test.rb
 - test/unit/enumerable_test.rb
+- test/unit/exceptions_test.rb
 - test/unit/guaranteed_utf8_string_test.rb
 - test/unit/hash_test.rb
 - test/unit/hash_with_indifferent_access_test.rb