activesupport-deprecation_test_helper 0.1.0.pre.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 96e1b8c154348e3c7eeab086231c932236883101667273e8e6e1fa8b3ed8de28
+  data.tar.gz: 65e6b88eb0e720224b48ebc0f1bf27c50253a9f1361bfd0e9b29c533bb33cf6d
+SHA512:
+  metadata.gz: ece0f7556a64e132d9ab47c7a421315a11f959959da4f7e31625de13baa07c70f7fd8e06cc352883e827350a6f5600825e802e3b3510bb08867666846a986232
+  data.tar.gz: 99de410cc1ed6479dc136d2d71e99db0c4611f14293e0f36dd6f7309aa9ec69bf7b92efd08903bc045c87ad21b3478823e30db4992b314cb0191855b0aac15d0

data/.dependabot/config.yml

@@ -0,0 +1,10 @@
+---
+version: 1
+update_configs:
+- package_manager: "ruby:bundler"
+  directory: "/"
+  update_schedule: "live"
+  version_requirement_updates: "off"
+  commit_message:
+    prefix: "No-Jira"
+    include_scope: true

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/gemfiles/*.lock
+
+# rspec failure tracking
+.rspec_status

data/.jenkins/Jenkinsfile

@@ -0,0 +1,69 @@
+#!/usr/bin/groovy
+
+@Library('jenkins-pipeline@v0.4.4')
+
+def setGithubStatus(String name, String description, String status) {
+  gitHubStatus([
+    repoSlug:    'Invoca/active_support-deprecation_test_helper',
+    sha:         env.GIT_COMMIT,
+    description: description,
+    context:     name,
+    targetURL:   env.RUN_DISPLAY_URL,
+    token:       env.GITHUB_TOKEN,
+    status:      status
+  ])
+}
+
+pipeline {
+  agent {
+    kubernetes {
+      defaultContainer 'ruby'
+      yamlFile '.jenkins/ruby_build_pod.yml'
+    }
+  }
+
+  environment { GITHUB_TOKEN = credentials('github_token') }
+
+  stages {
+    stage("Setup") {
+      steps {
+        setGithubStatus('clean-build', 'Running unit tests', 'pending')
+        sh 'bundle install'
+        sh 'bundle exec appraisal install'
+      }
+    }
+
+    stage("Appraisals") {
+      parallel {
+        stage("Current") {
+          environment { JUNIT_OUTPUT = 'spec/reports/current/rspec.xml' }
+          steps { sh 'bundle exec rake' }
+          post { always { junit JUNIT_OUTPUT } }
+        }
+
+        stage("Rails 4") {
+          environment { JUNIT_OUTPUT = 'spec/reports/rails-4/rspec.xml' }
+          steps { sh 'bundle exec appraisal rails-4 rake' }
+          post { always { junit JUNIT_OUTPUT } }
+        }
+
+        stage("Rails 5") {
+          environment { JUNIT_OUTPUT = 'spec/reports/rails-5/rspec.xml' }
+          steps { sh 'bundle exec appraisal rails-5 rake' }
+          post { always { junit JUNIT_OUTPUT } }
+        }
+
+        stage("Rails 6") {
+          environment { JUNIT_OUTPUT = 'spec/reports/rails-6/rspec.xml' }
+          steps { sh 'bundle exec appraisal rails-6 rake' }
+          post { always { junit JUNIT_OUTPUT } }
+        }
+      }
+    }
+  }
+
+  post {
+    success { setGithubStatus('clean-build', 'Passed all unit tests!', 'success') }
+    failure { setGithubStatus('clean-build', 'Failure during unit tests!', 'failure') }
+  }
+}

data/.jenkins/ruby_build_pod.yml

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

data/.rspec

@@ -0,0 +1,5 @@
+--require spec_helper
+--format progress
+--color
+--format RspecJunitFormatter
+--out <%= ENV['JUNIT_OUTPUT'] || 'spec/reports/rspec.xml' %>

data/.ruby-version

@@ -0,0 +1 @@
+2.6.5

data/Appraisals

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

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+# CHANGELOG for `activesupport-deprecation_test_helper`
+
+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.1.0] - Unreleased
+Initial release for the gem
+### Added
+- Added ability to configure your tests to record and report unexpected deprecation warnings
+
+[0.1.0]: https://github.com/Invoca/active_support-deprecation_warning_helper/tree/v0.1.0

data/Gemfile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in active_support-deprecation_test_helper.gemspec
+gemspec
+
+gem "appraisal"
+gem "pry"
+gem 'pry-byebug'
+gem "rake",                  "~> 13.0"
+gem "rspec",                 "~> 3.0"
+gem "rspec_junit_formatter", "~> 0.4"

data/Gemfile.lock

@@ -0,0 +1,69 @@
+PATH
+  remote: .
+  specs:
+    activesupport-deprecation_test_helper (0.1.0.pre.1)
+      activesupport (>= 4.2, < 7)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.0.3.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    appraisal (2.3.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.6)
+    diff-lcs (1.3)
+    i18n (1.8.3)
+      concurrent-ruby (~> 1.0)
+    method_source (1.0.0)
+    minitest (5.14.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.9.0)
+      byebug (~> 11.0)
+      pry (~> 0.13.0)
+    rake (13.0.1)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    rspec_junit_formatter (0.4.1)
+      rspec-core (>= 2, < 4, != 2.12.0)
+    thor (1.0.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    zeitwerk (2.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport-deprecation_test_helper!
+  appraisal
+  pry
+  pry-byebug
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rspec_junit_formatter (~> 0.4)
+
+BUNDLED WITH
+   1.17.3

data/README.md

@@ -0,0 +1,79 @@
+# ActiveSupport::DeprecationTestHelper
+
+A test helper that removes `ActiveSupport::Deprecation` noise from being interlaced in your test output.  Instead this gem collects
+any and all deprecation warnings that occur during your tests, and succinctly reports them at the end of the test run.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'activesupport-deprecation_test_helper'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install activesupport-deprecation_test_helper
+
+## Usage
+### Basic Configuration
+In order to capture and report all deprecation warnings at the end of the test run, use one of the
+following methods for configuration.
+
+#### Configuring for Supported Test Frameworks
+Currently the following test frameworks are supported out of the box:
+- Minitest (`:minitest`)
+- RSpec (`:rspec`)
+
+In order to configure you test runs in `Minitest` add the following to your `test_helper.rb`
+```ruby
+require 'active_support/deprecation_test_helper'
+ActiveSupport::DeprecationTestHelper.configure(:minitest)
+```
+
+And for `RSpec` add the following to your `spec_helper.rb` after your `RSpec.configure` block:
+```ruby
+require 'active_support/deprecation_test_helper'
+ActiveSupport::DeprecationTestHelper.configure(:rspec)
+```
+
+#### Configuring for Unsupported Test Frameworks
+If you are using an unsupported test framework and would like to use this gem, you'll need to add the
+following pieces to your test setup.
+
+1. Include `ActiveSupport::DeprecationTestHelper` into `ActiveSupport::Deprecation` using the following
+```ruby
+require 'active_support/deprecation_test_helper'
+ActiveSupport::Deprecation.include ActiveSupport::DeprecationTestHelper
+```
+2. Report all unexpected warnings at the end of the test run with
+```ruby
+ActiveSupport::DeprecationTestHelper.report_unexpected_warnings
+```
+
+### Expected Deprecation Warnings
+If you have some deprecations warnings that you're not going to resolve, and would like to omit them from the test run report, you can do the following
+
+```ruby
+ActiveSupport::DeprecationTestHelper.allow_warning("The full deprecation warning string")
+```
+
+Or you can use a regex if you would like to match a series of deprecation warnings
+
+```ruby
+ActiveSupport::DeprecationTestHelper.allow_warning(/will be removed from Rails 6\.0/)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Invoca/active_support-deprecation_test_helper.

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/active_support-deprecation_test_helper.gemspec

@@ -0,0 +1,33 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "active_support/deprecation_test_helper/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "activesupport-deprecation_test_helper"
+  spec.version       = ActiveSupport::DeprecationTestHelper::VERSION
+  spec.authors       = ["Invoca"]
+  spec.email         = ["operations@invoca.com"]
+
+  spec.summary       = ""
+  spec.description   = ""
+  spec.homepage      = "https://github.com/Invoca/active_support-deprecation_test_helper"
+
+  spec.metadata = {
+    'allowed_push_host' => 'https://rubygems.org',
+    'homepage_uri'      => 'https://github.com/Invoca/active_support-deprecation_test_helper',
+    'source_code_uri'   => 'https://github.com/Invoca/active_support-deprecation_test_helper',
+    'changelog_uri'     => 'https://github.com/Invoca/active_support-deprecation_test_helper/blob/master/CHANGELOG.md'
+  }
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'activesupport', '>= 4.2', '< 7'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "active_support/deprecation_test_helper"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/gemfiles/rails_4.gemfile

@@ -0,0 +1,13 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal"
+gem "pry"
+gem "pry-byebug"
+gem "rake", "~> 10.0"
+gem "rspec", "~> 3.0"
+gem "rspec_junit_formatter", "~> 0.4"
+gem "activesupport", "~> 4.2"
+
+gemspec path: "../"

data/gemfiles/rails_5.gemfile

@@ -0,0 +1,13 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal"
+gem "pry"
+gem "pry-byebug"
+gem "rake", "~> 10.0"
+gem "rspec", "~> 3.0"
+gem "rspec_junit_formatter", "~> 0.4"
+gem "activesupport", "~> 5.2"
+
+gemspec path: "../"

data/gemfiles/rails_6.gemfile

@@ -0,0 +1,13 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal"
+gem "pry"
+gem "pry-byebug"
+gem "rake", "~> 10.0"
+gem "rspec", "~> 3.0"
+gem "rspec_junit_formatter", "~> 0.4"
+gem "activesupport", "~> 6.0"
+
+gemspec path: "../"

data/lib/active_support/deprecation_test_helper.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require "active_support/deprecation_test_helper/version"
+require "active_support/deprecation"
+require "active_support/core_ext/object/inclusion"
+
+module ActiveSupport
+  module DeprecationTestHelper
+    CONFIGURABLE_TEST_FRAMEWORKS = [:rspec, :minitest].freeze
+
+    class << self
+      def configure(test_framework)
+        test_framework.in?(CONFIGURABLE_TEST_FRAMEWORKS) or raise "Unexpected test framework encountered. Supported frameworks are #{CONFIGURABLE_TEST_FRAMEWORKS.join(' ')}"
+
+        ActiveSupport::Deprecation.include(self)
+
+        case test_framework
+        when :rspec
+          RSpec.configuration.after(:all, after_all_callback)
+        when :minitest
+          Minitest.after_run(after_all_callback)
+        end
+      end
+
+      def reset
+        @allowed_warnings    = Set.new
+        @unexpected_warnings = Set.new
+      end
+
+      def allow_warning(message_or_regex)
+        unless message_or_regex.is_a?(String) || message_or_regex.is_a?(Regexp)
+          raise ArgumentError, "Expected message_or_regex to be a String or a Regexp but was a #{message_or_regex.class.name}"
+        end
+        allowed_warnings << message_or_regex
+      end
+
+      def after_all_callback
+        -> { unexpected_warnings.any? and warn unexpected_warnings_message }
+      end
+
+      def unexpected_warnings_message
+        <<~EOS.chomp
+          =====
+          #{(['Unexpected Deprecation Warnings Encountered'] + unexpected_warnings.to_a).join("\n  ")}
+          =====
+        EOS
+      end
+
+      def track_warning(warning)
+        if warning && !expected_warning?(warning)
+          unexpected_warnings << warning
+        end
+      end
+
+      protected
+
+      attr_reader :unexpected_warnings, :allowed_warnings
+
+      def expected_warning?(warning)
+        allowed_warnings.any? { |allowed_warning| allowed_warning === warning }
+      end
+    end
+
+    self.reset
+
+    def deprecation_warning(*_args)
+      super.tap { |warning| ActiveSupport::DeprecationTestHelper.track_warning(warning) }
+    end
+
+    def behavior
+      [::ActiveSupport::Deprecation::DEFAULT_BEHAVIORS[:silence]]
+    end
+  end
+end

data/lib/active_support/deprecation_test_helper/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module ActiveSupport
+  module DeprecationTestHelper
+    VERSION = "0.1.0.pre.1"
+  end
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: activesupport-deprecation_test_helper
+version: !ruby/object:Gem::Version
+  version: 0.1.0.pre.1
+platform: ruby
+authors:
+- Invoca
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-06-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+description: ''
+email:
+- operations@invoca.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".dependabot/config.yml"
+- ".gitignore"
+- ".jenkins/Jenkinsfile"
+- ".jenkins/ruby_build_pod.yml"
+- ".rspec"
+- ".ruby-version"
+- Appraisals
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- active_support-deprecation_test_helper.gemspec
+- bin/console
+- bin/setup
+- gemfiles/rails_4.gemfile
+- gemfiles/rails_5.gemfile
+- gemfiles/rails_6.gemfile
+- lib/active_support/deprecation_test_helper.rb
+- lib/active_support/deprecation_test_helper/version.rb
+homepage: https://github.com/Invoca/active_support-deprecation_test_helper
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/Invoca/active_support-deprecation_test_helper
+  source_code_uri: https://github.com/Invoca/active_support-deprecation_test_helper
+  changelog_uri: https://github.com/Invoca/active_support-deprecation_test_helper/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: ''
+test_files: []