invoca-utils 0.1.1 → 0.2.0.pre.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 415752871460b9b105317298a448748ab21d3e66
-  data.tar.gz: f946ff261cbc342c34d3a82da9c1d4bb31328317
+SHA256:
+  metadata.gz: c649aa42003b13eb382b508255bbfcac81b8b923bb851716a5d2e3c6894e0e81
+  data.tar.gz: 1c2eb05eccb83b374ad1caeeec48d3a74e2be1354697df021055e7a6f033559d
 SHA512:
-  metadata.gz: dc7d2f1aa0a27e6afcdbcb32fecf90dd39e987145ef5d0f875711cc8631e676bc9551f8d761710426d3d7a96343c03e1b25a3a4fba0fc93b0fa610815385375f
-  data.tar.gz: ed4627548537d4c8d8d79c177a605f45920f494aa3e747b5b5585801e4837ebaf88db6c48035ad59bd4d7d89a87ba2eccf1c88028803036cc5c2262cb1ab68a5
+  metadata.gz: 9b2b6ea11bb6e6c2157e15ba05703705fb46623e48bbe7eaff9cd2a7a5cbcbf5ad8747c0eca4190047defa003024ecc0496c92cac6c489b01073049dca672f6c
+  data.tar.gz: da808833388e650a1cd8e55d773fcf4319dab6551fee8a36fb47cac68b0a17363e31475f0c152e242728aae7b7d3f131e404e3c1946e95146028832909fd17c3

data/.gitignore

@@ -10,10 +10,12 @@ coverage
 doc/
 lib/bundler/man
 pkg
+pkg/
 rdoc
-spec/reports
+test/reports
 test/tmp
 test/version_tmp
+
 tmp
 *.bundle
 *.so
@@ -22,4 +24,3 @@ tmp
 mkmf.log
 .idea/
 .rubocop-http*
-test/reports

data/.jenkins/Jenkinsfile

@@ -0,0 +1,50 @@
+#!/usr/bin/groovy
+@Library('jenkins-pipeline@v0.4.5')
+import com.invoca.docker.*;
+pipeline {
+  agent {
+    kubernetes {
+      defaultContainer "ruby"
+      yamlFile ".jenkins/ruby_build_pod.yml"
+    }
+  }
+
+  environment {
+    GITHUB_TOKEN = credentials('github_token')
+    BUNDLE_GEM__FURY__IO = credentials('gemfury_deploy_token')
+  }
+
+  stages {
+    stage('Setup') {
+      steps {
+        script {
+          sh 'bundle install'
+        }
+      }
+    }
+    stage('Unit Test') {
+      steps {
+        script {
+          sh 'bundle exec rake'
+        }
+      }
+      post {
+        always { junit '*/reports/*.xml' }
+        success { updateGitHubStatus('clean-build', 'success', 'Unit tests.') }
+        failure { updateGitHubStatus('clean-build', 'failure', 'Unit tests.') }
+      }
+    }
+  }
+}
+
+void updateGitHubStatus(String context, String status, String description) {
+  gitHubStatus([
+    repoSlug:    'Invoca/invoca-utils',
+    sha:         env.GIT_COMMIT,
+    description: description,
+    context:     context,
+    targetURL:   env.BUILD_URL,
+    token:       env.GITHUB_TOKEN,
+    status:      status
+  ])
+}

data/.jenkins/ruby_build_pod.yml

@@ -0,0 +1,19 @@
+---
+apiVersion: v1
+kind: Pod
+metadata:
+  labels:
+  jenkins/invoca-utils: 'true'
+  namespace: jenkins
+  name: invoca-utils
+spec:
+  containers:
+  - name: ruby
+    image: ruby:2.6.5
+    tty: true
+    resources:
+    requests:
+      memory: "100Mi"
+    command:
+      - cat
+

data/.ruby-version

@@ -1 +1 @@
-2.4.2
+2.6.5

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+# CHANGELOG for `invoca-utils`
+
+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.2.0] - Unreleased
+### Added
+- Enumerable::build_hash method ported from HoboSupport
+- Enumerable::* operator ported from HoboSupport
+
+[0.2.0]: https://github.com/Invoca/process_settings/compare/v0.1.1...v0.2.0

data/Gemfile

@@ -5,12 +5,13 @@ source 'https://rubygems.org'
 gemspec
 
 group :development do
+  gem 'minitest'
+  gem 'minitest-reporters'
+  gem 'pry'
   gem 'rake'
-  gem 'test-unit', '= 1.2.3'
   gem 'rr',        '=1.1.2'
-  gem 'shoulda',   '= 3.5.0'
-  gem 'pry'
   gem 'ruby-prof'
-  gem 'minitest'
+  gem 'shoulda',   '= 3.5.0'
+  gem 'test-unit', '= 1.2.3'
   gem 'tzinfo'
 end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    invoca-utils (0.1.1)
+    invoca-utils (0.2.0.pre.1)
 
 GEM
   remote: https://rubygems.org/
@@ -11,20 +11,28 @@ GEM
       i18n (~> 0.7)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
+    ansi (1.5.0)
+    builder (3.2.4)
     coderay (1.1.2)
     concurrent-ruby (1.0.5)
-    hoe (3.16.2)
-      rake (>= 0.8, < 13.0)
+    hoe (3.22.1)
+      rake (>= 0.8, < 15.0)
     i18n (0.9.1)
       concurrent-ruby (~> 1.0)
     method_source (0.9.0)
     minitest (5.11.1)
+    minitest-reporters (1.1.14)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
     pry (0.11.3)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
-    rake (12.3.0)
+    rake (13.0.1)
     rr (1.1.2)
     ruby-prof (0.17.0)
+    ruby-progressbar (1.10.1)
     shoulda (3.5.0)
       shoulda-context (~> 1.0, >= 1.0.1)
       shoulda-matchers (>= 1.4.1, < 3.0)
@@ -43,6 +51,7 @@ PLATFORMS
 DEPENDENCIES
   invoca-utils!
   minitest
+  minitest-reporters
   pry
   rake
   rr (= 1.1.2)

data/Rakefile

@@ -4,14 +4,8 @@
 require "bundler/gem_tasks"
 require 'rake/testtask'
 
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'lib'
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
-  t.verbose = false
-end
-
 task default: :test
 
-task :default => 'test'
-
+Rake::TestTask.new do |t|
+  t.pattern = "test/**/*_test.rb"
+end

data/lib/invoca/utils.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "invoca/utils/array"
+require "invoca/utils/enumerable"
 require "invoca/utils/diff"
 require "invoca/utils/http"
 require "invoca/utils/map_compact"

data/lib/invoca/utils/array.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require_relative './multi_sender'
+
+# Invoca ::Array extensions
+module Invoca
+  module Utils
+    module ArrayMultiply
+      def *(rhs = nil)
+        if rhs
+          super
+        else
+          Invoca::Utils::MultiSender.new(self, :map)
+        end
+      end
+    end
+  end
+end
+
+Array.prepend(Invoca::Utils::ArrayMultiply)

data/lib/invoca/utils/enumerable.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require_relative './multi_sender'
+
+# Invoca ::Enumerable extensions
+module Enumerable
+  def build_hash(res = {})
+    each do |x|
+      pair = block_given? ? yield(x) : x
+      res[pair.first] = pair.last if pair
+    end
+    res
+  end
+
+  def *
+    Invoca::Utils::MultiSender.new(self, :map)
+  end
+end

data/lib/invoca/utils/multi_sender.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Invoca
+  module Utils
+    class MultiSender
+      undef_method(*(instance_methods - [:__id__, :__send__, :object_id]))
+
+      def initialize(enumerable, method)
+        @enumerable = enumerable
+        @method     = method
+      end
+
+      # rubocop:disable Style/MethodMissingSuper
+      # rubocop:disable Style/MissingRespondToMissing
+      def method_missing(name, *args, &block)
+        @enumerable.send(@method) { |x| x.send(name, *args, &block) }
+      end
+      # rubocop:enable Style/MethodMissingSuper
+      # rubocop:enable Style/MissingRespondToMissing
+    end
+  end
+end

data/lib/invoca/utils/version.rb

@@ -2,6 +2,6 @@
 
 module Invoca
   module Utils
-    VERSION = "0.1.1"
+    VERSION = "0.2.0.pre.1"
   end
 end

data/test/test_helper.rb

@@ -7,3 +7,8 @@ require 'pry'
 require 'active_support/all'
 
 require 'invoca/utils'
+require "minitest/reporters"
+Minitest::Reporters.use! [
+  Minitest::Reporters::DefaultReporter.new,
+  Minitest::Reporters::JUnitReporter.new
+]

data/test/unit/array_test.rb

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

data/test/unit/enumerable_test.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'set'
+require_relative '../../lib/invoca/utils/enumerable.rb'
+require_relative '../test_helper'
+
+class EnumerableTest < Minitest::Test
+
+  context 'build_hash' do
+    should 'convert arrays of [key, value] to a hash of { key => value }' do
+      assert_equal({ 'some' => 4, 'short' => 5, 'words' => 5 }, ['some', 'short', 'words'].build_hash { |s| [s, s.length] })
+    end
+
+    should 'ignore nils returned from map' do
+      assert_equal({ 'some' => 4, 'words' => 5 }, ['some', 'short', 'words'].build_hash { |s|  s == 'short' ? nil : [s, s.length] })
+    end
+
+    # these seem like erroneous behavior, but, they have been left as-is for backward compatibility with hobosupport::Enumerable::build_hash
+
+    should 'convert arrays of [single_value] to a hash of { single_value => single_value }' do
+      assert_equal({ 'some' => 4, 'short' => 'short', 'words' => 5 }, ['some', 'short', 'words'].build_hash { |s| s == 'short' ? [s] : [s, s.length] })
+    end
+
+    should 'convert arrays of [first, ..., last] to a hash of { first => last }' do
+      assert_equal({ 'some' => 4, 'short' => 'three', 'words' => 5 }, ['some', 'short', 'words'].build_hash { |s| s == 'short' ? [s, 'two', 'three'] : [s, s.length] })
+    end
+
+    should 'convert empty arrays to a hash of { nil => nil }' do
+      assert_equal({ 'some' => 4, nil => nil, 'words' => 5 }, ['some', 'short', 'words'].build_hash { |s| s == 'short' ? [] : [s, s.length] })
+    end
+  end
+
+  context '* operator' do
+    should 'call the same method on each item in an Set and return the results as an array' do
+      assert_equal([4, 5, 5], Set['some', 'short', 'words'].*.length)
+    end
+
+    should 'call the same method on each item in an Hash and return the results as an array' do
+      assert_equal(['key1:value1', 'key2:value2'], { key1: 'value1', key2: 'value2' }.*.join(':'))
+    end
+  end
+end

data/test/unit/multi_sender_test.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require_relative '../../lib/invoca/utils/multi_sender.rb'
+require_relative '../test_helper'
+
+class MultiSenderTest < Minitest::Test
+  # create enumerable class for testing
+  class LinkedList
+    include Enumerable
+
+    def initialize(head, tail = nil)
+      @head, @tail = head, tail
+    end
+
+    def <<(item)
+      LinkedList.new(item, self)
+    end
+
+    def inspect
+      [@head, @tail].inspect
+    end
+
+    def each(&block)
+      if block_given?
+        block.call(@head)
+        @tail&.each(&block)
+      else
+        to_enum(:each)
+      end
+    end
+  end
+
+  context 'MultiSender' do
+    context 'with custom Enumerable' do
+      setup do
+        linked_list = LinkedList.new('some') << 'short' << 'words'
+        @multi_sender = Invoca::Utils::MultiSender.new(linked_list, :map)
+      end
+
+      should 'call the same method on each item in an Enumerable and return the results as an array' do
+        assert_equal([5, 5, 4], @multi_sender.length)
+      end
+
+      should 'handle methods with arguments' do
+        assert_equal(['or', 'ho', 'om'], @multi_sender.slice(1, 2))
+      end
+    end
+
+    context 'with built-in Array' do
+      should 'call the same method on each item in an Array and return the results as an array' do
+        multi_sender = Invoca::Utils::MultiSender.new(['some', 'short', 'words'], :map)
+        assert_equal([4, 5, 5], multi_sender.length)
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: invoca-utils
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0.pre.1
 platform: ruby
 authors:
 - Invoca development
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-16 00:00:00.000000000 Z
+date: 2020-04-26 00:00:00.000000000 Z
 dependencies: []
 description: A public collection of helpers used in multiple projects
 email:
@@ -18,8 +18,11 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".jenkins/Jenkinsfile"
+- ".jenkins/ruby_build_pod.yml"
 - ".rubocop.yml"
 - ".ruby-version"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -27,18 +30,24 @@ files:
 - Rakefile
 - invoca-utils.gemspec
 - lib/invoca/utils.rb
+- lib/invoca/utils/array.rb
 - lib/invoca/utils/diff.rb
+- lib/invoca/utils/enumerable.rb
 - lib/invoca/utils/guaranteed_utf8_string.rb
 - lib/invoca/utils/http.rb
 - lib/invoca/utils/map_compact.rb
 - lib/invoca/utils/min_max.rb
+- lib/invoca/utils/multi_sender.rb
 - lib/invoca/utils/stable_sort.rb
 - lib/invoca/utils/time.rb
 - lib/invoca/utils/version.rb
 - test/helpers/constant_overrides.rb
 - test/test_helper.rb
+- test/unit/array_test.rb
+- test/unit/enumerable_test.rb
 - test/unit/guaranteed_utf8_string_test.rb
 - test/unit/map_compact_test.rb
+- test/unit/multi_sender_test.rb
 - test/unit/stable_sort_test.rb
 - test/unit/time_calculations_test.rb
 - test/unit/utils_test.rb
@@ -58,20 +67,22 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A public collection of helpers used in multiple projects
 test_files:
 - test/helpers/constant_overrides.rb
 - test/test_helper.rb
+- test/unit/array_test.rb
+- test/unit/enumerable_test.rb
 - test/unit/guaranteed_utf8_string_test.rb
 - test/unit/map_compact_test.rb
+- test/unit/multi_sender_test.rb
 - test/unit/stable_sort_test.rb
 - test/unit/time_calculations_test.rb
 - test/unit/utils_test.rb