invoca-utils 0.4.1 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bc2c9db5fc433f7e4f0abfc7ba11ca6a41065e5a4e9a233bb6f38fa8d310e0d0
-  data.tar.gz: 426e3b56dcb95d79b964d613198b2c483050da092999a4ccd4e29348231b0588
+  metadata.gz: c8684fc70ce068552001b1cd99cf11a8f60882e23d46b9a56f94276e5c5b6403
+  data.tar.gz: c429285201930b90be6ea32d043f9625fcd22b493b6c4871ea912d55800958d2
 SHA512:
-  metadata.gz: b0e762c4b3a2e044abc0a340dc741a9258b2a3afbca3caf575f5f160067fef863ce10d40b03bc374275d0953c9984fd0bf2253df8d5cdcc0e43774bbf42948fe
-  data.tar.gz: fc973c0be3d37b5f8e38f2e12d9ea45a87539c78ff8afe7b7f8adf8351d623f847af68a1d9df96bbc39938894dfb6e2bf2fe4f36ef182278f80b3511381cdedf
+  metadata.gz: a8c825cfa1b59d065cd8ea81a56cbe1e1d5c1acd277b2d9d05b452392b027de3a07acd6537aef12732fe70b7994b3aa2a0b74c03355c053b3c4d0db6552ccf43
+  data.tar.gz: e641a1ef06cd907e48d5b6addec2bcb8ae27b125528ec645bd2366153938245c0a3de6635241aebe416a86a196509337c6ad9a88ee3685d97d84ceb60e11f3e1

data/.github/workflows/pipeline.yml

@@ -0,0 +1,40 @@
+---
+name: Pipeline
+
+on: [push]
+
+jobs:
+  tests:
+    runs-on: ubuntu-22.04
+
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [2.5, 2.6, 2.7, '3.0', 3.1, 3.2]
+        gemfile:
+          - Gemfile
+          - gemfiles/activesupport_5.gemfile
+          - gemfiles/activesupport_6.gemfile
+          - gemfiles/activesupport_7.gemfile
+        exclude:
+          - ruby: 2.5
+            gemfile: gemfiles/activesupport_7.gemfile
+          - ruby: 2.6
+            gemfile: gemfiles/activesupport_7.gemfile
+
+    env:
+      BUNDLE_GEMFILE: ${{ matrix.gemfile }}
+
+    name: Unit Tests (${{ matrix.ruby }} - ${{ matrix.gemfile }})
+
+    steps:
+      - name: Check out
+        uses: actions/checkout@v2
+      - name: Set up Ruby ${{ matrix.ruby }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler: 2.2.29
+          bundler-cache: true
+      - name: Run Tests
+        run: bundle exec rspec

data/.gitignore

@@ -1,26 +1,37 @@
+# OS artifacts
 .DS_Store
-*.gem
-*.rbc
-.bundle
-.config
+
+# IDEs
+.idea/
+
+# Documentation artifacts
 .yardoc
-InstalledFiles
 _yardoc
-coverage
 doc/
-lib/bundler/man
-pkg
-pkg/
 rdoc
-test/reports
-test/tmp
-test/version_tmp
 
-tmp
+# Rubocop
+.rubocop-http*
+
+# test artifacts
+spec/reports
+coverage
+
+# Appraisal
+gemfiles/*.lock
+
+# gem building artifacts
+*.a
 *.bundle
-*.so
+*.gem
 *.o
-*.a
+*.rbc
+*.so
+.bundle
+.config
+InstalledFiles
+checksums
+lib/bundler/man
 mkmf.log
-.idea/
-.rubocop-http*
+pkg
+tmp

data/.rspec

@@ -0,0 +1,3 @@
+--require spec_helper
+--format progress
+--color

data/.ruby-version

@@ -1 +1 @@
-2.6.5
+2.7.5

data/.tool-versions

@@ -0,0 +1 @@
+ruby 2.7.5

data/Appraisals

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+appraise 'activesupport-5' do
+  gem 'activesupport', '~> 5.2'
+end
+
+appraise 'activesupport-6' do
+  gem 'activesupport', '~> 6.0'
+end
+
+appraise 'activesupport-7' do
+  gem 'activesupport', '~> 7.0'
+end

data/CHANGELOG.md

@@ -2,7 +2,15 @@
 
 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).
+**Note:** This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.5.1] - 2023-02-17
+### Added
+- Integrated Appraisal into github actions for testing across multiple versions of ActiveSupport
+- 
+## [0.5.0] - 2023-02-10
+### Added
+- Relaxed version requirement for ActiveSupport 
 
 ## [0.4.1] - 2020-06-17
 ### Fixed
@@ -27,6 +35,9 @@ 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.5.1]: https://github.com/Invoca/invoca-utils/compare/v0.5.0...v0.5.1
+[0.5.0]: https://github.com/Invoca/invoca-utils/compare/v0.4.1...v0.5.0
+[0.4.1]: https://github.com/Invoca/invoca-utils/compare/v0.4.0...v0.4.1
 [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

@@ -2,21 +2,14 @@
 
 source 'https://rubygems.org'
 
+# Specify your gem's run time dependencies in invoca-utils.gemspec
 gemspec
 
-source 'https://rubygems.org' do
-  gem 'activesupport', '~> 4.2'
-  gem 'minitest'
-  gem 'minitest-reporters'
-  gem 'pry'
-  gem 'rake'
-  gem 'rr',        '=1.1.2'
-  gem 'ruby-prof'
-  gem 'shoulda',   '= 3.5.0'
-  gem 'test-unit', '= 1.2.3'
-  gem 'tzinfo'
-end
-
-source 'https://gem.fury.io/invoca' do
-  gem 'test_overrides',      '~> 0.13'
-end
+# Specify your gem's development and test dependencies below
+gem "appraisal",             "~> 2.4"
+gem "rake",                  "~> 13.0"
+gem "rspec",                 "~> 3.0"
+gem "rspec_junit_formatter", "~> 0.4"
+# minitest, which is a transitive dependency of activesupport,
+# version should support ruby 2.5 which is the minimum github pipeline targets
+gem "minitest",              "~> 5.10.0"

data/Gemfile.lock

@@ -1,68 +1,59 @@
 PATH
   remote: .
   specs:
-    invoca-utils (0.4.1)
+    invoca-utils (0.5.1)
+      activesupport (>= 5.0)
 
 GEM
   remote: https://rubygems.org/
-  remote: https://gem.fury.io/invoca/
   specs:
-    activesupport (4.2.11.3)
-      i18n (~> 0.7)
+    activesupport (5.2.8.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
       minitest (~> 5.1)
-      thread_safe (~> 0.3, >= 0.3.4)
       tzinfo (~> 1.1)
-    ansi (1.5.0)
-    builder (3.2.4)
-    coderay (1.1.3)
-    concurrent-ruby (1.1.6)
-    hoe (3.22.1)
-      rake (>= 0.8, < 15.0)
-    i18n (0.9.5)
+    appraisal (2.4.1)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    concurrent-ruby (1.2.0)
+    diff-lcs (1.5.0)
+    i18n (1.12.0)
       concurrent-ruby (~> 1.0)
-    method_source (1.0.0)
-    minitest (5.14.1)
-    minitest-reporters (1.4.2)
-      ansi
-      builder
-      minitest (>= 5.0)
-      ruby-progressbar
-    pry (0.13.1)
-      coderay (~> 1.1)
-      method_source (~> 1.0)
-    rake (13.0.1)
-    rr (1.1.2)
-    ruby-prof (1.4.1)
-    ruby-progressbar (1.10.1)
-    shoulda (3.5.0)
-      shoulda-context (~> 1.0, >= 1.0.1)
-      shoulda-matchers (>= 1.4.1, < 3.0)
-    shoulda-context (1.2.2)
-    shoulda-matchers (2.8.0)
-      activesupport (>= 3.0.0)
-    test-unit (1.2.3)
-      hoe (>= 1.5.1)
-    test_overrides (0.13.0)
+    minitest (5.10.3)
+    rake (13.0.6)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.1)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rspec_junit_formatter (0.6.0)
+      rspec-core (>= 2, < 4, != 2.12.0)
+    thor (1.2.1)
     thread_safe (0.3.6)
-    tzinfo (1.2.7)
+    tzinfo (1.2.11)
       thread_safe (~> 0.1)
 
 PLATFORMS
+  arm64-darwin-22
   ruby
+  x86_64-linux
 
 DEPENDENCIES
-  activesupport (~> 4.2)!
+  appraisal (~> 2.4)
   invoca-utils!
-  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!
+  minitest (~> 5.10.0)
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rspec_junit_formatter (~> 0.4)
 
 BUNDLED WITH
-   1.17.3
+   2.2.29

data/Rakefile

@@ -2,11 +2,14 @@
 # frozen_string_literal: true
 
 require "bundler/gem_tasks"
-require 'rake/testtask'
-require 'rake_test_warning_false'
+require 'rake'
 
-task default: :test
-
-Rake::TestTask.new do |t|
-  t.pattern = "test/**/*_test.rb"
+desc "run rspec unit tests"
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:rspec) do |rspec_task|
+    rspec_task.pattern = "spec/**{,/*/**}/*_spec.rb"
+  end
 end
+
+task default: :rspec

data/gemfiles/activesupport_5.gemfile

@@ -0,0 +1,12 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal", "~> 2.4"
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.0"
+gem "rspec_junit_formatter", "~> 0.4"
+gem "minitest", "~> 5.10.0"
+gem "activesupport", "~> 5.2"
+
+gemspec path: "../"

data/gemfiles/activesupport_6.gemfile

@@ -0,0 +1,12 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal", "~> 2.4"
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.0"
+gem "rspec_junit_formatter", "~> 0.4"
+gem "minitest", "~> 5.10.0"
+gem "activesupport", "~> 6.0"
+
+gemspec path: "../"

data/gemfiles/activesupport_7.gemfile

@@ -0,0 +1,12 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal", "~> 2.4"
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.0"
+gem "rspec_junit_formatter", "~> 0.4"
+gem "minitest", "~> 5.10.0"
+gem "activesupport", "~> 7.0"
+
+gemspec path: "../"

data/invoca-utils.gemspec

@@ -1,22 +1,34 @@
+# frozen_string_literal: true
+
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
 require 'invoca/utils/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "invoca-utils"
   spec.version       = Invoca::Utils::VERSION
+  spec.licenses      = ["MIT"]
+
   spec.authors       = ["Invoca development"]
   spec.email         = ["development@invoca.com"]
+
   spec.summary       = "A public collection of helpers used in multiple projects"
-  spec.homepage      = ""
-  spec.license       = "MIT"
+  spec.description   = "A public collection of helpers used in multiple projects"
+  spec.homepage      = "https://github.com/Invoca/invoca-utils"
 
-  spec.metadata = {
-    'allowed_push_host' => 'https://rubygems.org'
-  }
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
 
   spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.executables   = spec.files.grep(%r{^bin/}) { |file| File.basename(file) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
+
+  # this should match the minimum github pipeline targets
+  # which is currently set to 2.5
+  spec.required_ruby_version = ">= 2.5.0"
+
+  spec.add_dependency "activesupport", ">= 5.0"
+
+  # Specify this gem's development and test dependencies in Gemfile
 end

data/lib/invoca/utils/version.rb

@@ -2,6 +2,6 @@
 
 module Invoca
   module Utils
-    VERSION = "0.4.1"
+    VERSION = "0.5.1"
   end
 end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'active_support/all'
+
+require 'invoca/utils'
+require 'rspec_junit_formatter'
+
+RSpec.configure do |config|
+  config.add_formatter(RspecJunitFormatter, 'spec/reports/rspec.xml')
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  RSpec::Support::ObjectFormatter.default_instance.max_formatted_output_length = 2_000
+end

data/spec/unit/array_spec.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require_relative '../../lib/invoca/utils/array.rb'
+require_relative '../spec_helper'
+
+describe Array do
+  context '* operator' do
+    it 'call the same method on each item in an array and return the results as an array' do
+      expect(['some', 'short', 'words'].*.length).to eq([4, 5, 5])
+    end
+
+    it 'handle methods with arguments' do
+      expect(['some', 'short', 'words'].*.slice(1, 2)).to eq(['om', 'ho', 'or'])
+    end
+
+    it 'not alter normal behavior (multiplication) when there is a right hand side to the expression' do
+      expect(['some', 'short', 'words'] * 2).to eq(['some', 'short', 'words', 'some', 'short', 'words'])
+    end
+  end
+end

data/spec/unit/enumerable_spec.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+require 'set'
+require_relative '../../lib/invoca/utils/enumerable.rb'
+require_relative '../spec_helper'
+
+describe Enumerable do
+
+  context 'map_and_find' do
+    it 'return the mapped value of the first match' do
+      expect([1, 2, 3, 4].map_and_find { |v| 'FOUND 3' if v == 3 }).to eq('FOUND 3')
+    end
+
+    it 'return the mapped value of the first match, even if there are multiple matches' do
+      expect([1, 2, 3, 4].map_and_find { |v| "FOUND #{v}" if v > 2 }).to eq('FOUND 3')
+    end
+
+    it 'return the provided argument if the value is not found' do
+      expect([1, 2, 3, 4].map_and_find('NOT FOUND') { |v| "FOUND 6" if v == 6 }).to eq('NOT FOUND')
+    end
+
+    it 'return nil if the value is not found and no argument is provided' do
+      expect([1, 2, 3, 4].map_and_find { |v| "FOUND 6" if v == 6 }).to be_nil
+    end
+  end
+
+  context 'map_with_index' do
+    it 'call the block with the value and index' do
+      expect([10, 20, 30, 40].map_with_index { |v, index| v + index }).to eq([10, 21, 32, 43])
+    end
+
+    it 'assumulate into the provided enumerable' do
+      expect([10, 20, 30, 40].map_with_index([1]) { |v, index| v + index }).to eq([1, 10, 21, 32, 43])
+    end
+  end
+
+  context 'map_hash' do
+    it 'convert enumerables into a hash using the value for key and the map result as the hash value' do
+      expect([1, 2, 3].map_hash { |v| v + 10  }).to eq({ 1 => 11, 2 => 12, 3 => 13 })
+    end
+
+    it 'includes nils returned from map' do
+      expect([1, 2, 3].map_hash { |v| v + 10 unless v == 2  }).to eq({ 1 => 11, 2 => nil, 3 => 13 })
+    end
+  end
+
+  context 'build_hash' do
+    it 'convert arrays of [key, value] to a hash of { key => value }' do
+      expect(['some', 'short', 'words'].build_hash { |s| [s, s.length] }).to eq({ 'some' => 4, 'short' => 5, 'words' => 5 })
+    end
+
+    it 'ignore nils returned from map' do
+      expect(['some', 'short', 'words'].build_hash { |s|  s == 'short' ? nil : [s, s.length] }).to eq({ 'some' => 4, 'words' => 5 })
+    end
+
+    # these seem like erroneous behavior, but, they have been left as-is for backward compatibility with hobosupport::Enumerable::build_hash
+
+    it 'convert arrays of [single_value] to a hash of { single_value => single_value }' do
+      expect(['some', 'short', 'words'].build_hash { |s| s == 'short' ? [s] : [s, s.length] }).to eq({ 'some' => 4, 'short' => 'short', 'words' => 5 })
+    end
+
+    it 'convert arrays of [first, ..., last] to a hash of { first => last }' do
+      expect(['some', 'short', 'words'].build_hash { |s| s == 'short' ? [s, 'two', 'three'] : [s, s.length] }).to eq({ 'some' => 4, 'short' => 'three', 'words' => 5 })
+    end
+
+    it 'convert empty arrays to a hash of { nil => nil }' do
+      expect(['some', 'short', 'words'].build_hash { |s| s == 'short' ? [] : [s, s.length] }).to eq({ 'some' => 4, nil => nil, 'words' => 5 })
+    end
+  end
+
+  context '* operator' do
+    it 'call the same method on each item in an Set and return the results as an array' do
+      expect(Set['some', 'short', 'words'].*.length).to eq([4, 5, 5])
+    end
+
+    it 'call the same method on each item in an Hash and return the results as an array' do
+      expect({ key1: 'value1', key2: 'value2' }.*.join(':')).to eq(['key1:value1', 'key2:value2'])
+    end
+  end
+end

data/{test/unit/exceptions_test.rb → spec/unit/exceptions_spec.rb}

@@ -1,23 +1,23 @@
 # frozen_string_literal: true
 
-require_relative '../test_helper'
+require_relative '../spec_helper'
 
-class ExceptionsTest < Minitest::Test
+describe Invoca::Utils do
   context "exceptions" do
     context ".retry_on_exception" do
-      should "default retries: to 1" do
+      it "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
+        expect(result).to eq(1)
+        expect(tries).to eq([0])
       end
 
       context "when never raising an exception" do
-        should "return result" do
+        it "return result" do
           times = 0
           tries = []
           result = Invoca::Utils.retry_on_exception(ArgumentError, retries: 2) do |try|
@@ -26,26 +26,26 @@ class ExceptionsTest < Minitest::Test
             try == 0 and raise ArgumentError, '!!!'
             times
           end
-          assert_equal 2, result
-          assert_equal [0, 1], tries
+          expect(result).to eq(2)
+          expect(tries).to eq([0,1])
         end
       end
 
       context "when always raising an exception" do
-        should "retry and finally raise" do
+        it "retry and finally raise" do
           tries = []
-          assert_raises(ArgumentError, /!!! 2/) do
+          expect 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.to raise_exception(ArgumentError, /!!! 2/)
+          expect(tries).to eq([0,1])
         end
       end
 
       context "when raising but then succeeding" do
-        should "retry and finally return result" do
+        it "retry and finally return result" do
           times = 0
           result = Invoca::Utils.retry_on_exception(ArgumentError, retries: 1) do
             times += 1
@@ -55,12 +55,12 @@ class ExceptionsTest < Minitest::Test
               times
             end
           end
-          assert_equal 2, result
+          expect(result).to eq(2)
         end
       end
 
       context "when raising different exceptions (array notation) but then succeeding" do
-        should "retry and finally return result" do
+        it "retry and finally return result" do
           times = 0
           tries = []
           result = Invoca::Utils.retry_on_exception([ArgumentError, RuntimeError], retries: 2) do |try|
@@ -75,8 +75,8 @@ class ExceptionsTest < Minitest::Test
               times
             end
           end
-          assert_equal 3, result
-          assert_equal [0, 1, 2], tries
+          expect(result).to eq(3)
+          expect(tries).to eq([0, 1, 2])
         end
       end
     end