silencer 1.0.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ccb6ea675b222655dd7b500ed47ac2379d32a5b7
-  data.tar.gz: 340ecc14723e16c5f7c4d7dc8793e2210bb974a2
+SHA256:
+  metadata.gz: 63363db7eb9e93e891e6910a11e53919acfaab80e63a280544e9b7c1b3eed686
+  data.tar.gz: 347c68c4cf21b860ab12497a684b5b037f980ef1649ae9bdc03fda713870703e
 SHA512:
-  metadata.gz: b627ac2efed95a1a2ed774faf9bd782e81bea0ff0a5d318d1f91c40387c8fc54472960e1be1500003009b7f3260be8d24ba42a5af11e33a55205f7cea937c38d
-  data.tar.gz: 7b71a44a0e85a1385daa09d7b38a87fa11f6e1c13bded1adbd8ed752c29a69b5fe3c7f1bb1a8e766bef9b4d4ee850b980ab71585c5cbebe4c5affab0ed296e4c
+  metadata.gz: b631a27a0bb92c343ff55f5976416b44d23cbe9f520d412890c98ba1c7d2489a283404d8b0d70a2ac2ee0278d5578f52affcc37d7b891809e8907aaac96a85de
+  data.tar.gz: 4435eb5f9254a7fd2266947dcef3b4776b41e8e1579edab6adb2a550d6bd2c6f5b5903e596dfa741a9bbdda21b76c68dbe30ec40bf8e13c7bae557b8ab90d731

data/README.md

@@ -1,13 +1,9 @@
 # Silencer
 
-
 [![Gem Version](http://img.shields.io/gem/v/silencer.svg)][gem]
-[![Build Status](http://img.shields.io/travis/stve/silencer.svg)][travis]
-[![Dependency Status](http://img.shields.io/gemnasium/stve/silencer.svg)][gemnasium]
+![Tests](https://github.com/stve/silencer/actions/workflows/ci.yml/badge.svg)
 
 [gem]: https://rubygems.org/gems/silencer
-[travis]: https://travis-ci.org/stve/silencer
-[gemnasium]: https://gemnasium.com/stve/silencer
 
 Silencer is a simple rack-middleware for Rails that can selectively disable logging on per-action basis.  It's based on a [blog post](http://dennisreimann.de/blog/silencing-the-rails-log-on-a-per-action-basis/) by Dennis Reimann.
 
@@ -17,7 +13,15 @@ __Note__: Silencer is only threadsafe in Rails version 4.2.6 and later.
 
 Just add silencer to your Gemfile:
 
-    gem 'silencer'
+```ruby
+gem 'silencer', require: false
+```
+
+### Upgrading to version 2.0
+
+__Note:__ 1.x versions of silencer detected the presence of Rails when it was required. This made it easy to use silencer for most applications, but made assumptions on usage.
+
+In version 2.0, you'll need to require the correct logger within your application. See the Usage documentation for more details.
 
 ## Usage
 
@@ -26,19 +30,24 @@ Just add silencer to your Gemfile:
 Create an initializer (like `config/initializers/silencer.rb`) with the contents:
 
 ```ruby
-require 'silencer/logger'
+require 'silencer/rails/logger'
 
 Rails.application.configure do
-  config.middleware.swap Rails::Rack::Logger, Silencer::Logger, :silence => ["/noisy/action.json"]
+  config.middleware.swap(
+    Rails::Rack::Logger, 
+    Silencer::Logger, 
+    config.log_tags,
+    silence: ["/noisy/action.json"]
+  )
 end
 ```
 
 ### Rack
 
 ```ruby
-require 'silencer/logger'
+require 'silencer/rack/logger'
 
-use Silencer::Logger, :silence => ["/noisy/action.json"]
+use Silencer::Logger, silence: ["/noisy/action.json"]
 ```
 
 ## Configuration
@@ -46,44 +55,50 @@ use Silencer::Logger, :silence => ["/noisy/action.json"]
 Or if you'd prefer, you can pass it regular expressions:
 
 ```ruby
-config.middleware.swap Rails::Rack::Logger, Silencer::Logger, :silence => [%r{^/assets/}]
+config.middleware.swap(
+  Rails::Rack::Logger, 
+  Silencer::Logger, 
+  config.log_tags, 
+  silence: [%r{^/assets/}]
+)
 ```
 
 Or you can silence specific request methods only:
 
 ```ruby
-config.middleware.swap Rails::Rack::Logger, Silencer::Logger, :get => [%r{^/assets/}], :post => [%r{^/some_path}]
+config.middleware.swap(
+  Rails::Rack::Logger, 
+  Silencer::Logger, 
+  config.log_tags, 
+  get: [%r{^/assets/}], 
+  post: [%r{^/some_path}]
+)
 ```
 
-Silencer's logger will serve as a drop-in replacement for Rails' default logger.  It will not suppress any logging by default, simply pass it an array of urls via the options hash.  You can also send it a 'X-SILENCE-LOGGER' header (with any value) with your request and that will also produce the same behavior.
+Silencer's logger will serve as a drop-in replacement for Rails' default logger.  It will not suppress any logging by default, simply pass it an array of URLs via the options hash.  You can also send an `X-SILENCE-LOGGER` header (with any value) with your request and that will also produce the same behavior.
 
 ### All options
 
 Silencer supports the following configuration options.
 
-    :silence - Silences matching requests regardless of request method
-    :get     - Silences matching GET requests
-    :head    - Silences matching HEAD requests
-    :post    - Silences matching POST requests
-    :put     - Silences matching PUT requests
-    :delete  - Silences matching DELETE requests
-    :patch   - Silences matching PATCH requests
-    :trace   - Silences matching TRACE requests
-    :connect - Silences matching CONNECT requests
-    :options - Silences matching OPTIONS requests
-
-### Rails 2.3
-
-Rails 2.3.x introduced a tagged logging feature.  If you are using tagged logging with Rails 2.3 you can also pass taggers via the middleware:
-
-```ruby
-config.middleware.swap Rails::Rack::Logger, Silencer::Logger, config.log_tags, :silence => [%r{^/assets/}]
-```
+| Configuration | Description | Default |
+|---------------|-------------|---------|
+| `silence` | Silences matching requests regardless of request method | None |
+| `get` | Silences matching GET requests | None |
+| `head` | Silences matching HEAD requests | None |
+| `post` | Silences matching POST requests | None |
+| `put` | Silences matching PUT requests | None |
+| `delete` | Silences matching DELETE requests | None |
+| `patch` | Silences matching PATCH requests | None |
+| `trace` | Silences matching TRACE requests | None |
+| `connect` | Silences matching CONNECT requests | None |
+| `options` | Silences matching OPTIONS requests | None |
+| `enable_header` | Enable/disable X-SILENCE-LOGGER header support | `true` |
 
 ## Note on Patches/Pull Requests
 
 * Fork the project.
-* Make your feature addition or bug fix.
+* Make your feature addition or bugfix.
 * Add tests for it. This is important so I don't break it in a
   future version unintentionally.
 * Commit, do not mess with rakefile, version, or history.
@@ -92,4 +107,4 @@ config.middleware.swap Rails::Rack::Logger, Silencer::Logger, config.log_tags, :
 
 ## Copyright
 
-Copyright (c) 2012 Steve Agalloco. See [LICENSE](https://github.com/spagalloco/silencer/blob/master/LICENSE.md) for details.
+Copyright (c) 2012 Steve Agalloco. See [LICENSE](https://github.com/spagalloco/silencer/blob/main/LICENSE.md) for details.

data/lib/silencer/hush.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module Silencer
   module Hush
     private
 
-    def silence_request?(env)
-      (silent_header?(env) || silent_path?(env))
+    def silence_request?(env, enable_header: true)
+      ((enable_header && silent_header?(env)) || silent_path?(env))
     end
 
     def silent_header?(env)

data/lib/silencer/methods.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 module Silencer
   module Methods
-    METHODS = [:options, :get, :head, :post, :put, :delete, :trace, :connect, :patch]
+    METHODS = %i[options get head post put delete trace connect patch]
 
     def define_routes(silence_paths, opts)
       METHODS.each_with_object({}) do |method, routes|

data/lib/silencer/rack/logger.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rack/logger'
 require 'silencer/hush'
 require 'silencer/methods'
@@ -15,16 +17,35 @@ module Silencer
         @silence = wrap(opts.delete(:silence))
         @routes  = define_routes(@silence, opts)
 
+        @enable_header = opts.delete(:enable_header) { true }
+
         super(app, *args)
       end
 
       def call(env)
-        logger       = ::Logger.new(env['rack.errors'])
-        logger.level = (silence_request?(env) ? ::Logger::ERROR : @level)
+        if silence_request?(env, enable_header: @enable_header)
+          quiet(env) do
+            super
+          end
+        else
+          super
+        end
+      end
+
+      private
+
+      def quiet(env)
+        old_logger = env['rack.logger']
+        logger = ::Logger.new(env['rack.errors'])
+        logger.level = ::Logger::ERROR
 
         env['rack.logger'] = logger
-        @app.call(env)
+        yield
+      ensure
+        env['rack.logger'] = old_logger
       end
     end
   end
+
+  Logger = Silencer::Rack::Logger
 end

data/lib/silencer/{environment.rb → rails/environment.rb}

@@ -1,8 +1,11 @@
+# frozen_string_literal: true
+
 module Silencer
   module Environment
-    RAILS_2_3 = /^2.3/
-    RAILS_3_2 = /^3.2/
     RAILS_4 = /^4/
+    RAILS_5 = /^5/
+
+    module_function
 
     def rails?
       defined?(::Rails)
@@ -10,26 +13,20 @@ module Silencer
 
     def rails_version
       return unless rails?
-      ::Rails::VERSION::STRING
-    end
-
-    def rails2?
-      rails_version =~ RAILS_2_3
-    end
 
-    def rails3_2?
-      rails_version =~ RAILS_3_2
+      ::Rails::VERSION::STRING
     end
 
     def rails4?
       rails_version =~ RAILS_4
     end
 
-    def tagged_logger?
-      rails3_2? || rails4?
+    def rails5?
+      rails_version =~ RAILS_5
     end
 
-    module_function :rails?, :rails2?, :rails_version, :rails3_2?
-    module_function :rails4?, :tagged_logger?
+    def tagged_logger?
+      rails4? || rails5?
+    end
   end
 end

data/lib/silencer/rails/logger.rb

@@ -1,21 +1,14 @@
+# frozen_string_literal: true
+
+require 'rails/rack/logger'
 require 'silencer/hush'
 require 'silencer/methods'
 require 'silencer/util'
+require 'silencer/rails/environment'
 
 module Silencer
-  # rubocop:disable Style/ConstantName
-  RailsLogger = begin
-    if Silencer::Environment.rails2?
-      require 'rails/rack/log_tailer'
-      ::Rails::Rack::LogTailer
-    else
-      require 'rails/rack/logger'
-      ::Rails::Rack::Logger
-    end
-  end
-
   module Rails
-    class Logger < RailsLogger
+    class Logger < ::Rails::Rack::Logger
       include Silencer::Hush
       include Silencer::Methods
       include Silencer::Util
@@ -25,7 +18,10 @@ module Silencer
         @silence = wrap(opts.delete(:silence))
         @routes  = define_routes(@silence, opts)
 
-        if normalized_args = normalize(args) # rubocop:disable Lint/AssignmentInCondition
+        @enable_header = opts.delete(:enable_header) { true }
+
+        normalized_args = normalize(args)
+        if normalized_args
           super(app, normalized_args)
         else
           super(app)
@@ -33,7 +29,7 @@ module Silencer
       end
 
       def call(env)
-        if silence_request?(env)
+        if silence_request?(env, enable_header: @enable_header)
           quiet do
             super
           end
@@ -53,10 +49,8 @@ module Silencer
       end
 
       # This is threadsafe in Rails 4.2.6+
-      def quiet_with_silence
-        ::Rails.logger.silence do
-          yield
-        end
+      def quiet_with_silence(&block)
+        ::Rails.logger.silence(&block)
       end
 
       # This is not threadsafe
@@ -79,4 +73,6 @@ module Silencer
       end
     end
   end
+
+  Logger = Silencer::Rails::Logger
 end

data/lib/silencer/util.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Silencer
   module Util
     def wrap(object)

data/lib/silencer/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Silencer
-  VERSION = '1.0.1'
+  VERSION = '2.0.0'
 end

data/lib/silencer.rb

@@ -1 +1 @@
-require 'silencer/logger'
+# frozen_string_literal: true

data/spec/silencer/rack/logger_spec.rb

@@ -1,63 +1,63 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
+require 'silencer/rack/logger'
 
 describe Silencer::Rack::Logger do
-  let(:app) { ->(_env) { [200, {}, ''] } }
+  let(:app) do
+    lambda { |env|
+      log = env['rack.logger']
+      log.info('ohai')
 
-  it 'quiets the log when configured with a silenced path' do
-    expect_any_instance_of(::Logger).to receive(:level=).with(::Logger::ERROR)
+      [200, {'Content-Type' => 'text/plain'}, ['Hello, World!']]
+    }
+  end
 
-    Silencer::Rack::Logger.new(app, silence: ['/'])
-                          .call(Rack::MockRequest.env_for('/'))
+  let(:errors) do
+    StringIO.new
   end
 
-  it 'quiets the log when configured with a regex' do
-    expect_any_instance_of(::Logger).to receive(:level=).with(::Logger::ERROR)
+  it 'quiets the log when configured with a silenced path' do
+    a = Rack::Lint.new(Silencer::Rack::Logger.new(app, silence: ['/']))
+    Rack::MockRequest.new(a).get('/', 'rack.errors' => errors)
+    expect(errors).not_to match('ohai')
+  end
 
-    Silencer::Rack::Logger.new(app, silence: [/assets/])
-                          .call(Rack::MockRequest.env_for('/assets/application.css'))
+  it 'quiets the log when configured with a regex' do
+    a = Rack::Lint.new(Silencer::Rack::Logger.new(app, silence: [/assets/]))
+    Rack::MockRequest.new(a).get('/assets/application.css', 'rack.errors' => errors)
+    expect(errors).not_to match('ohai')
   end
 
-  %w(OPTIONS GET HEAD POST PUT DELETE TRACE CONNECT PATCH).each do |method|
+  %w[OPTIONS GET POST PUT DELETE PATCH].each do |method|
     it "quiets the log when configured with a silenced path for #{method} requests" do
-      expect_any_instance_of(::Logger).to receive(:level=).with(::Logger::ERROR)
-
-      Silencer::Rack::Logger.new(app, method.downcase.to_sym => ['/'])
-                            .call(Rack::MockRequest.env_for('/', method: method))
+      a = Rack::Lint.new(Silencer::Rack::Logger.new(app, method.downcase.to_sym => ['/']))
+      Rack::MockRequest.new(a).send(method.downcase.to_sym, '/', 'rack.errors' => errors)
+      expect(errors).not_to match('ohai')
     end
 
     it "quiets the log when configured with a regex for #{method} requests" do
-      expect_any_instance_of(::Logger).to receive(:level=).with(::Logger::ERROR)
-
-      Silencer::Rack::Logger.new(app, method.downcase.to_sym => [/assets/])
-                            .call(Rack::MockRequest.env_for('/assets/application.css', method: method))
+      a = Rack::Lint.new(Silencer::Rack::Logger.new(app, method.downcase.to_sym => [/assets/]))
+      Rack::MockRequest.new(a).send(method.downcase.to_sym, '/assets/application.css', 'rack.errors' => errors)
+      expect(errors).not_to match('ohai')
     end
   end
 
-  it 'quiets the log when configured with a silenced path for non-standard requests' do
-    expect_any_instance_of(::Logger).to receive(:level=).with(::Logger::ERROR)
-
-    Silencer::Rack::Logger.new(app, silence: ['/'])
-                          .call(Rack::MockRequest.env_for('/', method: 'UPDATE'))
-  end
-
   it 'quiets the log when configured with a regex for non-standard requests' do
-    expect_any_instance_of(::Logger).to receive(:level=).with(::Logger::ERROR)
-
-    Silencer::Rack::Logger.new(app, silence: [/assets/])
-                          .call(Rack::MockRequest.env_for('/assets/application.css', method: 'UPDATE'))
+    a = Rack::Lint.new(Silencer::Rack::Logger.new(app, silence: [/assets/]))
+    Rack::MockRequest.new(a).get('/', 'rack.errors' => errors)
+    expect(errors).not_to match('ohai')
   end
 
   it 'quiets the log when passed a custom header "X-SILENCE-LOGGER"' do
-    expect_any_instance_of(::Logger).to receive(:level=).with(::Logger::ERROR)
-
-    Silencer::Rack::Logger.new(app)
-                          .call(Rack::MockRequest.env_for('/', 'HTTP_X_SILENCE_LOGGER' => 'true'))
+    a = Rack::Lint.new(Silencer::Rack::Logger.new(app))
+    Rack::MockRequest.new(a).get('/', 'rack.errors' => errors, 'HTTP_X_SILENCE_LOGGER' => 'true')
+    expect(errors).not_to match('ohai')
   end
 
   it 'does not tamper with the response' do
-    response = Silencer::Rack::Logger.new(app)
-                                     .call(Rack::MockRequest.env_for('/', 'HTTP_X_SILENCE_LOGGER' => 'true'))
-
-    expect(response[0]).to eq(200)
+    a = Rack::Lint.new(Silencer::Rack::Logger.new(app))
+    response = Rack::MockRequest.new(a).get('/', 'rack.errors' => errors, 'HTTP_X_SILENCE_LOGGER' => 'true')
+    expect(response.status).to eq(200)
   end
 end

data/spec/silencer/rails/logger_spec.rb

@@ -1,9 +1,12 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'syslogger'
+require 'silencer/rails/logger'
 
 describe Silencer::Rails::Logger do
   let(:app)       { ->(_env) { [200, {}, ''] } }
-  let(:log_tags)  { [:uuid, :queue] }
+  let(:log_tags)  { %i[uuid queue] }
 
   context 'quieted' do
     before do
@@ -20,7 +23,7 @@ describe Silencer::Rails::Logger do
                              .call(Rack::MockRequest.env_for('/assets/application.css'))
     end
 
-    %w(OPTIONS GET HEAD POST PUT DELETE TRACE CONNECT PATCH).each do |method|
+    %w[OPTIONS GET HEAD POST PUT DELETE TRACE CONNECT PATCH].each do |method|
       it "quiets the log when configured with a silenced path for #{method} requests" do
         Silencer::Rails::Logger.new(app, method.downcase.to_sym => ['/'])
                                .call(Rack::MockRequest.env_for('/', method: method))
@@ -67,6 +70,22 @@ describe Silencer::Rails::Logger do
     end
   end
 
+  describe 'enable_header option' do
+    it 'does not quiet the log when passed a custom header "X-SILENCE-LOGGER" when enable_header option is false' do
+      expect_any_instance_of(Silencer::Rails::Logger).to_not receive(:quiet)
+
+      Silencer::Rails::Logger.new(app, enable_header: false)
+                             .call(Rack::MockRequest.env_for('/', 'HTTP_X_SILENCE_LOGGER' => 'true'))
+    end
+
+    it 'quiets the log when passed a custom header "X-SILENCE-LOGGER" when enable_header option is true' do
+      expect_any_instance_of(Silencer::Rails::Logger).to receive(:quiet).once.and_call_original
+
+      Silencer::Rails::Logger.new(app, enable_header: true)
+                             .call(Rack::MockRequest.env_for('/', 'HTTP_X_SILENCE_LOGGER' => 'true'))
+    end
+  end
+
   it 'silences' do
     logger = Silencer::Rails::Logger.new(app, silence: ['/'])
 

data/spec/spec_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 unless ENV['CI']
   require 'simplecov'
   SimpleCov.start do
@@ -7,6 +9,7 @@ unless ENV['CI']
 end
 
 require 'rack'
+require 'rack/lint'
 require 'rspec'
 
 require 'logger'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: silencer
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Steve Agalloco
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-03-21 00:00:00.000000000 Z
+date: 2022-04-24 00:00:00.000000000 Z
 dependencies: []
 description: Selectively quiet your Rails/Rack logger on a per-route basis
 email:
@@ -22,11 +22,10 @@ files:
 - README.md
 - Rakefile
 - lib/silencer.rb
-- lib/silencer/environment.rb
 - lib/silencer/hush.rb
-- lib/silencer/logger.rb
 - lib/silencer/methods.rb
 - lib/silencer/rack/logger.rb
+- lib/silencer/rails/environment.rb
 - lib/silencer/rails/logger.rb
 - lib/silencer/util.rb
 - lib/silencer/version.rb
@@ -38,7 +37,7 @@ files:
 homepage: http://github.com/spagalloco/silencer
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -53,9 +52,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: Selectively quiet your Rails/Rack logger on a per-route basis
 test_files:

data/lib/silencer/logger.rb

@@ -1,14 +0,0 @@
-require 'silencer/rack/logger'
-require 'silencer/environment'
-
-module Silencer
-  # rubocop:disable Style/ConstantName
-  Logger = begin
-    if Silencer::Environment.rails?
-      require 'silencer/rails/logger'
-      Silencer::Rails::Logger
-    else
-      Silencer::Rack::Logger
-    end
-  end
-end