uncruft 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1c93c7cc504ba0e5d3bf93b8ffbbfadee05e66c8084f3580fc93855490ed4ec3
-  data.tar.gz: 6b1f3835bb69a640c757896730bb9cf284f212087f9f04339709e0186f921b92
+  metadata.gz: a2cab324dae5f8b3fc23c4f99785900af558ab66cee8a908222b3e7793482a35
+  data.tar.gz: 65ce169801afae62f4bd2b005b0ec901416c7f1372c2c5ca48a8ca3a9e9b79b0
 SHA512:
-  metadata.gz: f6427a8d529e5b0f51f26c3fc8b88f06d3f9823a0d02eb0e3cfdf3c00419dab9c9f2c634adec618ba21c72f54cc9ddedd6b90c18aaad854ea7c0564c224dff52
-  data.tar.gz: 67fba4c3a6ba79098cc141f597e7965917804306b41d5299cb4795600f191a3c5c8589506e4073d7be9ec6f045b75abe635338a75077ebc28b35b4848773d446
+  metadata.gz: 4d8f03d9ae4074f0097facfa7f20895ef17ec72082ba4f2a2fa49ddc8dfef688a7574f2fab60d134a42e60fa0ef841ce9201a9226da3e0dc9bd239737d260a88
+  data.tar.gz: 6f5857f50049b5016bb96d3e106de7c5a54818625c7922de2cb2b1971b857118af64bdf19a414694862b77d22b5a015c7f908ecc683899c8df5a4dc743ce14de

data/lib/uncruft/deprecation_handler.rb

@@ -41,9 +41,11 @@ module Uncruft
 
     def normalize_callstack_path(message)
       if (gem_home = gem_home(message)).present?
-        message.gsub(gem_home, '$GEM_PATH')
-      elsif (absolute_path = absolute_path(message)).present?
-        message.gsub(absolute_path, relative_path(absolute_path))
+        message.gsub!(gem_home, '$GEM_PATH')
+      end
+
+      if (absolute_path = absolute_path(message)).present?
+        message.gsub!(absolute_path, relative_path(absolute_path))
       end
     end
 
@@ -64,7 +66,7 @@ module Uncruft
     end
 
     def gem_home(message)
-      message.match(%r{called from( .+ at)? (#{ENV['GEM_HOME']}/(.+/)*gems)})&.[](2)
+      message.match(%r{(?i:c)alled from( .+ at)? (#{ENV['GEM_HOME']}/(.+/)*gems)})&.[](2) # rubocop:disable Style/FetchEnvVar
     end
 
     def absolute_path(message)

data/lib/uncruft/version.rb

@@ -1,3 +1,3 @@
 module Uncruft
-  VERSION = '0.3.0'.freeze
+  VERSION = '0.3.1'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: uncruft
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Nathan Griffith
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-10 00:00:00.000000000 Z
+date: 2023-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -112,14 +112,6 @@ files:
 - lib/uncruft/railtie.rb
 - lib/uncruft/version.rb
 - lib/uncruft/warning.rb
-- spec/dummy/config/application.rb
-- spec/spec_helper.rb
-- spec/support/rails_root.rb
-- spec/uncruft/deprecatable_spec.rb
-- spec/uncruft/deprecation_handler_spec.rb
-- spec/uncruft/railtie_spec.rb
-- spec/uncruft/warning_spec.rb
-- spec/uncruft_spec.rb
 homepage: https://github.com/Betterment/uncruft
 licenses:
 - MIT
@@ -140,16 +132,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.3.5
 signing_key: 
 specification_version: 4
 summary: A library to assist with Rails upgrades
-test_files:
-- spec/spec_helper.rb
-- spec/dummy/config/application.rb
-- spec/uncruft/railtie_spec.rb
-- spec/uncruft/warning_spec.rb
-- spec/uncruft/deprecatable_spec.rb
-- spec/uncruft/deprecation_handler_spec.rb
-- spec/support/rails_root.rb
-- spec/uncruft_spec.rb
+test_files: []

data/spec/dummy/config/application.rb

@@ -1,8 +0,0 @@
-ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../Gemfile', __dir__)
-require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
-$LOAD_PATH.unshift File.expand_path('../../../lib', __dir__)
-
-module Dummy
-  class Application < Rails::Application
-  end
-end

data/spec/spec_helper.rb

@@ -1,17 +0,0 @@
-require 'bundler'
-Bundler.require :default, :development
-
-ENV["RAILS_ENV"] ||= 'test'
-require File.expand_path('dummy/config/application', __dir__)
-require 'support/rails_root'
-
-RSpec.configure do |config|
-  config.run_all_when_everything_filtered = true
-  config.example_status_persistence_file_path = 'spec/examples.txt'
-
-  config.around(:all) do |example|
-    Time.use_zone(ActiveSupport::TimeZone.all.first) do
-      example.run
-    end
-  end
-end

data/spec/support/rails_root.rb

@@ -1,7 +0,0 @@
-module ::Rails
-  class << self
-    def root
-      @root ||= Pathname.new(Dir.pwd).realpath.join('spec', 'dummy')
-    end
-  end
-end

data/spec/uncruft/deprecatable_spec.rb

@@ -1,58 +0,0 @@
-require 'spec_helper'
-
-RSpec.describe Uncruft::Deprecatable do
-  let(:my_name) { "Jess" }
-
-  subject { klass.new }
-
-  describe '.deprecate_attribute' do
-    let(:klass) do
-      Class.new do
-        include Uncruft::Deprecatable
-
-        attr_accessor :first_name
-
-        deprecate_attribute(:first_name,
-                            message: "Please stop using this attribute!")
-      end
-    end
-
-    it 'applies deprecation warning when setting deprecated attribute' do
-      expect(ActiveSupport::Deprecation).to receive(:warn).once
-        .with("Please stop using this attribute!")
-
-      expect(subject.first_name = my_name).to eq my_name
-    end
-
-    it 'applies deprecation warning when getting deprecated attribute' do
-      subject.instance_variable_set(:@first_name, my_name)
-
-      expect(ActiveSupport::Deprecation).to receive(:warn)
-        .with("Please stop using this attribute!")
-
-      expect(subject.first_name).to eq my_name
-    end
-  end
-
-  describe '.deprecate_method' do
-    let(:klass) do
-      Class.new do
-        include Uncruft::Deprecatable
-
-        def legacy_method
-          "Hello Old World!"
-        end
-
-        deprecate_method(:legacy_method,
-                         message: "Please stop using this method!")
-      end
-    end
-
-    it 'applies deprecation warning when calling the deprecated method' do
-      expect(ActiveSupport::Deprecation).to receive(:warn)
-        .with("Please stop using this method!")
-
-      expect(subject.legacy_method).to eq "Hello Old World!"
-    end
-  end
-end

data/spec/uncruft/deprecation_handler_spec.rb

@@ -1,172 +0,0 @@
-require 'spec_helper'
-
-RSpec.describe Uncruft::DeprecationHandler do
-  let(:ignorefile_path) { Rails.root.join('config/deprecations.ignore') }
-
-  before do
-    File.delete(ignorefile_path) if File.exist?(ignorefile_path)
-  end
-
-  subject { described_class.new }
-
-  describe '#call' do
-    let(:absolute_path) { Rails.root.join('chicken/nuggets.rb') }
-    let(:line_number) { 123 }
-    let(:caller_label) { '<something>' }
-    let(:message) { "Warning: BAD called from #{caller_label} at #{absolute_path}:#{line_number}" }
-    let(:expected_ignorefile_entry) { 'Warning: BAD called from <something> at chicken/nuggets.rb' }
-    let(:expected_error) { "#{expected_ignorefile_entry}:123" }
-    let(:expected_error_message) do
-      <<~ERROR.strip
-        #{expected_error}
-
-        To resolve this error, adjust your code according to the instructions above.
-        If you did not introduce this error or are unsure why you are seeing it,
-        you will find additional guidance at the URL below:
-        https://github.com/Betterment/uncruft/blob/main/GUIDE.md
-      ERROR
-    end
-
-    it 'sanitizes the message and raises an error' do
-      expect { subject.call(message, '') }.to raise_error(RuntimeError, expected_error_message)
-    end
-
-    context 'when recording new deprecations' do
-      before do
-        allow(Uncruft).to receive(:record_deprecations?).and_return(true)
-      end
-
-      it 'sanitizes the message and writes it to the file' do
-        expect { subject.call(message, '') }.to change { File.exist?(ignorefile_path) }.from(false).to(true)
-        expect(File.read(ignorefile_path)).to include(expected_ignorefile_entry)
-      end
-
-      context 'when timecop is enabled' do
-        let(:test_started) { Time.zone.now }
-
-        it 'ignores time travel and writes the current time' do
-          Timecop.travel(test_started - 100.years) do
-            subject.call(message, '')
-
-            file_updated = Time.zone.parse(JSON.parse(File.read(ignorefile_path))['updated'])
-            expect(file_updated).to be_within(1.second).of(test_started)
-          end
-        end
-      end
-    end
-
-    context 'when caller is an erb file' do
-      let(:caller_label) { '_app_views_bananas_show__1234_567890' }
-      let(:expected_ignorefile_entry) { 'Warning: BAD called from chicken/nuggets.rb' }
-
-      it 'sanitizes the message and raises an error' do
-        expect { subject.call(message, '') }.to raise_error(RuntimeError, expected_error_message)
-      end
-    end
-
-    context 'when caller is "top (required)"' do
-      let(:caller_label) { '<top (required)>' }
-      let(:expected_ignorefile_entry) { 'Warning: BAD called from <global scope> at chicken/nuggets.rb' }
-
-      it 'sanitizes the caller and raises an error' do
-        expect { subject.call(message, '') }.to raise_error(RuntimeError, expected_error_message)
-      end
-    end
-
-    context 'when caller is "main"' do
-      let(:caller_label) { '<main>' }
-      let(:expected_ignorefile_entry) { 'Warning: BAD called from <global scope> at chicken/nuggets.rb' }
-
-      it 'sanitizes the caller and raises an error' do
-        expect { subject.call(message, '') }.to raise_error(RuntimeError, expected_error_message)
-      end
-    end
-
-    context 'when message includes custom gem path' do
-      let(:absolute_path) { Pathname.new('/banana/banana/banana/gems/chicken/nuggets.rb') }
-      let(:expected_ignorefile_entry) { "Warning: BAD called from <something> at $GEM_PATH/chicken/nuggets.rb" }
-
-      before do
-        allow(ENV).to receive(:[]).and_call_original
-        allow(ENV).to receive(:[]).with('GEM_HOME').and_return('/banana/banana/banana')
-      end
-
-      it 'sanitizes the message and raises an error' do
-        expect { subject.call(message, '') }.to raise_error(RuntimeError, expected_error_message)
-      end
-
-      context 'when gem home is nested' do
-        let(:absolute_path) { Pathname.new('/banana/banana/banana/arbitrary/gem/path/gems/chicken/nuggets.rb') }
-
-        it 'sanitizes the message and raises an error' do
-          expect { subject.call(message, '') }.to raise_error(RuntimeError, expected_error_message)
-        end
-      end
-
-      context 'when gem is vendored' do
-        let(:absolute_path) { Rails.root.join('vendor/cache/chicken/nuggets.rb') }
-
-        it 'sanitizes the message and raises an error' do
-          expect { subject.call(message, '') }.to raise_error(RuntimeError, expected_error_message)
-        end
-
-        context 'when gem is vendored elsewhere' do
-          let(:absolute_path) { Rails.root.join('../../vendor/cache/chicken/nuggets.rb') }
-
-          it 'sanitizes the message and raises an error' do
-            expect { subject.call(message, '') }.to raise_error(RuntimeError, expected_error_message)
-          end
-        end
-      end
-    end
-
-    context 'when caller is not a filepath' do
-      let(:absolute_path) { '(pry)' }
-      let(:expected_ignorefile_entry) { 'Warning: BAD called from <something> at (pry)' }
-
-      it 'sanitizes the message and raises an error' do
-        expect { subject.call(message, '') }.to raise_error(RuntimeError, expected_error_message)
-      end
-    end
-
-    context 'when ignorefile exists' do
-      let(:message) { "Warning: BAD called from #{absolute_path}:#{line_number}" }
-      let(:file_content) do
-        <<~IGNOREFILE
-          {
-            "ignored_warnings": [
-              "Warning: BAD called from chicken/nuggets.rb"
-            ],
-            "updated": "2018-06-05 15:20:12 -0400",
-            "rails_version": "5.1.6"
-          }
-        IGNOREFILE
-      end
-
-      before do
-        File.open(ignorefile_path, 'w') do |f|
-          f.write file_content
-        end
-      end
-
-      it 'does not raise an error and leaves the file intact' do
-        expect(File.read(ignorefile_path)).to eq(file_content)
-        expect { subject.call(message, '') }.not_to change { File.read(ignorefile_path) }
-      end
-
-      context 'when recording new deprecations' do
-        let(:line_number) { '456' }
-
-        before do
-          allow(Uncruft).to receive(:record_deprecations?).and_return(true)
-        end
-
-        it 'does not raise an error and leaves the file intact' do
-          expect(File.read(ignorefile_path)).to eq(file_content)
-          expect { subject.call(message, '') }.not_to raise_error
-          expect(File.read(ignorefile_path)).to include('Warning: BAD called from chicken/nuggets.rb')
-        end
-      end
-    end
-  end
-end

data/spec/uncruft/railtie_spec.rb

@@ -1,33 +0,0 @@
-require 'spec_helper'
-
-describe Uncruft::Railtie do
-  let(:app) { Rails.application }
-  let(:initializers) { app.initializers.tsort_each.select { |i| i.name.to_s.include?('deprecation') } }
-
-  it 'injects the default deprecation handler' do
-    expect { initializers.map { |i| i.run(app) } }.to change { Rails.application.config.active_support.deprecation }
-      .from(nil).to(a_collection_containing_exactly(an_instance_of(Uncruft::DeprecationHandler)))
-  end
-
-  context 'when the configured behavior is :stderr' do
-    before do
-      Rails.application.config.active_support.deprecation = :stderr
-    end
-
-    it 'injects the default deprecation handler' do
-      expect { initializers.map { |i| i.run(app) } }.to change { Rails.application.config.active_support.deprecation }
-        .from(:stderr).to(a_collection_containing_exactly(an_instance_of(Uncruft::DeprecationHandler)))
-    end
-  end
-
-  context 'when a custom deprecation behavior is already configured' do
-    before do
-      Rails.application.config.active_support.deprecation = :notify
-    end
-
-    it 'injects the default deprecation handler' do
-      expect { initializers.map { |i| i.run(app) } }.to change { Rails.application.config.active_support.deprecation }
-        .from(:notify).to(a_collection_containing_exactly(:notify, an_instance_of(Uncruft::DeprecationHandler)))
-    end
-  end
-end

data/spec/uncruft/warning_spec.rb

@@ -1,46 +0,0 @@
-require 'spec_helper'
-
-describe Uncruft::Warning do
-  before do
-    stub_const('Warning', Kernel) unless defined?(Warning)
-  end
-
-  it "doesn't block generic warnings" do
-    expect(ActiveSupport::Deprecation).not_to receive(:warn)
-    warn('oh no, you should worry')
-    Kernel.warn('oh no, you should worry')
-    Warning.warn('oh no, you should worry')
-  end
-
-  it "accepts kwargs from Kernel.warn" do
-    warn('oh no, you should worry', uplevel: 1)
-    Kernel.warn('oh no, you should worry', uplevel: 1)
-  end
-
-  context 'when warning includes the word "deprecation" or "deprecated"' do
-    it 'treats it as a deprecation warning' do
-      expect(ActiveSupport::Deprecation).to receive(:warn).and_return('banana').exactly(6).times
-      expect(warn('[dEpReCaTiOn] oh no, you should worry')).to eq 'banana'
-      expect(Kernel.warn('[dEpReCaTiOn] oh no, you should worry')).to eq 'banana'
-      expect(Warning.warn('[dEpReCaTiOn] oh no, you should worry')).to eq 'banana'
-      expect(warn('oh no, this is DePrEcAtEd, so you should worry')).to eq 'banana'
-      expect(Kernel.warn('oh no, this is DePrEcAtEd, so you should worry')).to eq 'banana'
-      expect(Warning.warn('oh no, this is DePrEcAtEd, so you should worry')).to eq 'banana'
-    end
-
-    context 'and when warning includes caller info' do
-      it 'strips out the path so that ActiveSupport::Deprecation can append a new one' do
-        path = caller_locations(0..0).first.path
-
-        allow(ActiveSupport::Deprecation).to receive(:warn).with('foo is deprecated!').and_return('hurray')
-        expect(warn("#{path}: foo is deprecated!")).to eq('hurray')
-
-        allow(ActiveSupport::Deprecation).to receive(:warn).with('[DEPRECATION] bar is no more.').and_return('huzzah')
-        expect(Kernel.warn("[DEPRECATION] bar is no more. #{path}:#{caller_locations(0..0).first.lineno}")).to eq('huzzah')
-
-        allow(ActiveSupport::Deprecation).to receive(:warn).with('Deprecation detected: banana --').and_return('we do our best...')
-        expect(Warning.warn("Deprecation detected: banana -- #{caller(0..0).first}")).to eq('we do our best...')
-      end
-    end
-  end
-end

data/spec/uncruft_spec.rb

@@ -1,46 +0,0 @@
-require 'spec_helper'
-
-RSpec.describe Uncruft do
-  describe '.record_deprecations?' do
-    it 'handles common truthy and falsy values' do
-      allow(ENV).to receive(:[]).with('RECORD_DEPRECATIONS').and_return('1')
-      expect(described_class.record_deprecations?).to eq true
-      allow(ENV).to receive(:[]).with('RECORD_DEPRECATIONS').and_return('t')
-      expect(described_class.record_deprecations?).to eq true
-      allow(ENV).to receive(:[]).with('RECORD_DEPRECATIONS').and_return('T')
-      expect(described_class.record_deprecations?).to eq true
-      allow(ENV).to receive(:[]).with('RECORD_DEPRECATIONS').and_return('true')
-      expect(described_class.record_deprecations?).to eq true
-      allow(ENV).to receive(:[]).with('RECORD_DEPRECATIONS').and_return('TRUE')
-      expect(described_class.record_deprecations?).to eq true
-      allow(ENV).to receive(:[]).with('RECORD_DEPRECATIONS').and_return('0')
-      expect(described_class.record_deprecations?).to eq false
-      allow(ENV).to receive(:[]).with('RECORD_DEPRECATIONS').and_return('f')
-      expect(described_class.record_deprecations?).to eq false
-      allow(ENV).to receive(:[]).with('RECORD_DEPRECATIONS').and_return('F')
-      expect(described_class.record_deprecations?).to eq false
-      allow(ENV).to receive(:[]).with('RECORD_DEPRECATIONS').and_return('false')
-      expect(described_class.record_deprecations?).to eq false
-      allow(ENV).to receive(:[]).with('RECORD_DEPRECATIONS').and_return('FALSE')
-      expect(described_class.record_deprecations?).to eq false
-      allow(ENV).to receive(:[]).with('RECORD_DEPRECATIONS').and_return('')
-      expect(described_class.record_deprecations?).to be_nil
-    end
-  end
-
-  describe '.ignorefile_path' do
-    it 'uses rails root' do
-      expect(described_class.ignorefile_path).to eq(Rails.root.join('config/deprecations.ignore'))
-    end
-
-    context 'when env var is set' do
-      before do
-        allow(ENV).to receive(:[]).with('UNCRUFT_IGNOREFILE_PATH').and_return('/path/to/file.txt')
-      end
-
-      it 'uses env var' do
-        expect(described_class.ignorefile_path).to eq('/path/to/file.txt')
-      end
-    end
-  end
-end