deprecation_collector 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e119a79e2c879e9e0ec02476523620eab84c6ae4c354d382207cd8be6bde7a9a
-  data.tar.gz: e2f7f495ee705f5dada2456b425fa739a9a67b801dce461c86e5f4a04c6266d0
+  metadata.gz: 26bc69b0016762d0f5e8546f48177a7b2d90334bc8f4c995853c51e814386731
+  data.tar.gz: d059f4d6985f9136305160d0e0a6ffe184a6ac1a927e31959241e525974d78ea
 SHA512:
-  metadata.gz: 8857214426445395aa62c0c56dae0d598d5f673f2d1b8d42bd00a7a8ba1ef037513ca5449a93c182f0556ef45fe6e6345bd798ffa2137a7e78f92f5f1902f0a1
-  data.tar.gz: 9de452b1a5d98b40777ac59224e57a134368ae91c9c24ecc7d792a199c66fd5f92c22d62689c6cadbc409d3d330057d4c487e50f6100dc697ea5295b83761066
+  metadata.gz: 7a4609b79edbf7f54aa11538a7201595951ced8194d2a65fd01f4ef9be21cc75719fb27c1e0debbfcad5be2fc5407a9e8a04a6b398e7af2bc19c196461017437
+  data.tar.gz: 70f742f7dbd0525ee444c5aa076ccd241f1b8b5acd7c20a10b8778e838a40b3ba383dffd2b58b8776da6bc978583775f16104e89db5d1f1746bfe03e6e1ef8a3

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+== 0.7.0
+- support for Rails 7.1
+- make install critical section smaller to prevent installation deprecations preventing installation
+
 == 0.6.0
 - added active_record storage
 - redis dependency will become optional in v1.0

data/README.md

@@ -55,6 +55,16 @@ Rails.application.routes.draw do
 end
 ```
 
+usually it's a good idea to secure the ui in some way, you can use rails route constraint (actual check will depend on your app):
+```ruby
+Rails.application.routes.draw do
+  constraints(->(request) { request.session[:admin] }) do
+    require 'deprecation_collector/web'
+    mount DeprecationCollector::Web => '/deprecations', as: :deprecations
+  end
+end
+```
+
 ## 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.

data/deprecation_collector.gemspec

@@ -18,10 +18,8 @@ Gem::Specification.new do |spec|
   spec.metadata["source_code_uri"] = "https://github.com/Vasfed/deprecation_collector"
   spec.metadata["changelog_uri"] = "https://github.com/Vasfed/deprecation_collector/blob/main/CHANGELOG.md"
 
-  spec.files = Dir['lib/**/*', 'sig/**/*', '*.md', '*.txt', '*.gemspec'].select { |f| File.file?(f) }
+  spec.files = Dir["lib/**/*", "sig/**/*", "*.md", "*.txt", "*.gemspec"].select { |filename| File.file?(filename) }
   spec.require_paths = ["lib"]
 
   spec.add_dependency "redis", ">= 3.0"
-  spec.add_development_dependency "appraisal"
-  spec.add_development_dependency "rack-test"
 end

data/lib/deprecation_collector/collectors.rb

@@ -2,6 +2,27 @@
 
 # :nodoc:
 class DeprecationCollector
+  ACTIVE_SUPPORT_BEHAVIORS = {
+    rails71: ->(message, callstack, deprecator) do
+      # TODO: use deprecator.gem_name, deprecator.deprecation_horizon
+      DeprecationCollector.collect(message, callstack, :rails)
+      ActiveSupport::Deprecation::DEFAULT_BEHAVIORS[stock_activesupport_behavior].call(message, callstack, deprecator)
+    end,
+    legacy: ->(message, callstack, deprecation_horizon, gem_name) do
+      DeprecationCollector.collect(message, callstack, :rails)
+      ActiveSupport::Deprecation::DEFAULT_BEHAVIORS[stock_activesupport_behavior].call(
+        message, callstack, deprecation_horizon, gem_name
+      )
+    end
+  }.freeze
+
+  # for intercepting deprecations from deprecators not installed in Rails.application.deprecators
+  module ActiveSupportDeprecationCollectionPatch
+    def behavior
+      @behavior ||= [DeprecationCollector::ACTIVE_SUPPORT_BEHAVIORS[:rails71]]
+    end
+  end
+
   class << self
     protected
 
@@ -18,12 +39,17 @@ class DeprecationCollector
 
     def tap_activesupport
       # TODO: a more polite hook
-      ActiveSupport::Deprecation.behavior = lambda do |message, callstack, deprecation_horizon, gem_name|
-        # not polite to turn off all other possible behaviors, but otherwise may get duplicate calls
-        DeprecationCollector.collect(message, callstack, :rails)
-        ActiveSupport::Deprecation::DEFAULT_BEHAVIORS[stock_activesupport_behavior].call(
-          message, callstack, deprecation_horizon, gem_name
-        )
+      # not polite to turn off all other possible behaviors, but otherwise may get duplicate calls
+      if Rails.respond_to?(:gem_version) && Rails.gem_version >= "7.1"
+        Rails.application.deprecators.behavior = ACTIVE_SUPPORT_BEHAVIORS[:rails71] if Rails.application&.deprecators
+        # Rails.application.deprecators.behavior only captures new-style deprecations, but we need all:
+        if ActiveSupport::Deprecation.respond_to?(:_instance)
+          ActiveSupport::Deprecation._instance.behavior = ACTIVE_SUPPORT_BEHAVIORS[:rails71]
+        end
+        # collect deprecations from deprecators that are not installed in `Rails.application.deprecators`
+        ActiveSupport::Deprecation.prepend(ActiveSupportDeprecationCollectionPatch)
+      else
+        ActiveSupport::Deprecation.behavior = ACTIVE_SUPPORT_BEHAVIORS[:legacy]
       end
     end
 

data/lib/deprecation_collector/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class DeprecationCollector
-  VERSION = "0.6.0"
+  VERSION = "0.7.0"
 end

data/lib/deprecation_collector/web/helpers.rb

@@ -50,7 +50,10 @@ class DeprecationCollector
       def trigger_rails_deprecation
         return unless defined?(ActiveSupport::Deprecation)
 
-        -> { ActiveSupport::Deprecation.warn("Test deprecation") } []
+        deprecator = ActiveSupport::Deprecation
+        deprecator = ActiveSupport::Deprecation.new("0.0", "deprecation_collector") if Rails.gem_version >= "7.1"
+
+        -> { deprecator.warn("Test deprecation") } []
       end
 
       def current_color_theme
@@ -65,6 +68,8 @@ class DeprecationCollector
         msg = deprecation[:message].to_s
         return :kwargs if msg.include?("Using the last argument as keyword parameters is deprecated") ||
                           msg.include?("Passing the keyword argument as the last hash parameter is deprecated")
+
+        nil
       end
 
       def test_deprecation?(deprecation)

data/lib/deprecation_collector/web/router.rb

@@ -172,6 +172,8 @@ class DeprecationCollector
           }
 
           return [status, { "content-type" => "text/html" }.merge(color_scheme_headers), [html.to_s]] if html
+
+          nil
         end
 
         VIEW_PATH = "#{__dir__}/views"

data/lib/deprecation_collector.rb

@@ -44,10 +44,10 @@ class DeprecationCollector
 
       yield instance if block_given?
       instance.fetch_known_digests
-
-      install_collectors
     end
 
+    install_collectors
+
     @instance
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: deprecation_collector
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Vasily Fedoseyev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-21 00:00:00.000000000 Z
+date: 2023-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -24,34 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: appraisal
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rack-test
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: Collects and aggregates warnings and deprecations. Optimized for production
   environment.
 email: