silencer 0.6.0 → 1.0.0.rc1

data/README.md

@@ -5,6 +5,8 @@
 
 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.
 
+__Note__: Silencer is not thread safe.
+
 ## Installation
 
 Just add silencer to your Gemfile:

data/lib/silencer/environment.rb

@@ -0,0 +1,37 @@
+module Silencer
+  module Environment
+
+    RAILS_2_3 = %r{^2.3}
+    RAILS_3_2 = %r{^3.2}
+    RAILS_4 = %r{^4}
+
+    def rails?
+      defined?(::Rails)
+    end
+
+    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
+    end
+
+    def rails4?
+      rails_version =~ RAILS_4
+    end
+
+    def tagged_logger?
+      rails3_2? || rails4?
+    end
+
+    module_function :rails?, :rails2?, :rails_version, :rails3_2?
+    module_function :rails4?, :tagged_logger?
+
+  end
+end

data/lib/silencer/hush.rb

@@ -0,0 +1,19 @@
+module Silencer
+  module Hush
+
+    private
+
+    def silence_request?(env)
+      (silent_header?(env) || silent_path?(env))
+    end
+
+    def silent_header?(env)
+      env['HTTP_X_SILENCE_LOGGER']
+    end
+
+    def silent_path?(env)
+      @silence.any? { |s| s === env['PATH_INFO'] }
+    end
+
+  end
+end

data/lib/silencer/logger.rb

@@ -1,29 +1,11 @@
-require 'rails/rack/logger'
-require 'active_support/core_ext/array/wrap'
+require 'silencer/environment'
+require 'silencer/rack/logger'
+require 'silencer/rails/logger' if Silencer::Environment.rails?
 
 module Silencer
-  class Logger < Rails::Rack::Logger
-    def initialize(app, *taggers)
-      @app = app
-      opts = taggers.extract_options!
-      @taggers = taggers.flatten
-      @silence = Array.wrap(opts[:silence])
-    end
-
-    def call(env)
-      old_logger_level   = Rails.logger.level
-      Rails.logger.level = ::Logger::ERROR if silence_request?(env)
-
-      super
-    ensure
-      # Return back to previous logging level
-      Rails.logger.level = old_logger_level
-    end
-
-    private
-
-    def silence_request?(env)
-      env['HTTP_X_SILENCE_LOGGER'] || @silence.any? { |s| s === env['PATH_INFO'] }
-    end
+  Logger = if Silencer::Environment.rails?
+    Silencer::Rails::Logger
+  else
+    Silencer::Rack::Logger
   end
 end

data/lib/silencer/rack/logger.rb

@@ -0,0 +1,27 @@
+require 'rack/logger'
+require 'silencer/util'
+require 'silencer/hush'
+
+module Silencer
+  module Rack
+    class Logger < ::Rack::Logger
+      include Silencer::Util
+      include Silencer::Hush
+
+      def initialize(app, *args)
+        opts     = extract_options!(args)
+        @silence = wrap(opts.delete(:silence))
+
+        super app, *args
+      end
+
+      def call(env)
+        logger       = ::Logger.new(env['rack.errors'])
+        logger.level = (silence_request?(env) ? ::Logger::ERROR : @level)
+
+        env['rack.logger'] = logger
+        @app.call(env)
+      end
+    end
+  end
+end

data/lib/silencer/rails/logger.rb

@@ -0,0 +1,47 @@
+module Silencer
+  RailsLogger = if Silencer::Environment.rails2?
+    require 'rails/rack/log_tailer'
+    ::Rails::Rack::LogTailer
+  else
+    require 'rails/rack/logger'
+    ::Rails::Rack::Logger
+  end
+
+  module Rails
+    class Logger < RailsLogger
+      include Silencer::Util
+      include Silencer::Hush
+
+      def initialize(app, *args)
+        opts     = extract_options!(args)
+        @silence = wrap(opts.delete(:silence))
+
+        if normalized_args = normalize(args.flatten)
+          super(app, normalized_args)
+        else
+          super(app)
+        end
+      end
+
+      def call(env)
+        old_logger_level     = ::Rails.logger.level
+        ::Rails.logger.level = ::Logger::ERROR if silence_request?(env)
+
+        super
+      ensure
+        # Return back to previous logging level
+        ::Rails.logger.level = old_logger_level
+      end
+
+      private
+
+      def normalize(args)
+        args = case args.size
+        when 0 then nil
+        when 1 then args.shift
+        else args
+        end
+      end
+    end
+  end
+end

data/lib/silencer/util.rb

@@ -0,0 +1,25 @@
+module Silencer
+  module Util
+
+    def wrap(object)
+      if object.nil?
+        []
+      elsif object.respond_to?(:to_ary)
+        object.to_ary || [object]
+      else
+        [object]
+      end
+    end
+
+    def extract_options!(args)
+      if args.last.is_a?(Hash)
+        args.pop
+      else
+        {}
+      end
+    end
+
+    module_function :wrap, :extract_options!
+
+  end
+end

data/lib/silencer/version.rb

@@ -1,3 +1,3 @@
 module Silencer
-  VERSION = "0.6.0"
+  VERSION = "1.0.0.rc1"
 end

data/silencer.gemspec

@@ -1,5 +1,7 @@
-# -*- encoding: utf-8 -*-
-require File.expand_path('../lib/silencer/version', __FILE__)
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'silencer/version'
 
 Gem::Specification.new do |gem|
   gem.name          = "silencer"
@@ -7,13 +9,13 @@ Gem::Specification.new do |gem|
   gem.authors       = ["Steve Agalloco"]
   gem.email         = ["steve.agalloco@gmail.com"]
   gem.homepage      = "http://github.com/spagalloco/silencer"
-  gem.description   = 'Selectively quiet your Rails logger on a per-action basis'
+  gem.description   = 'Selectively quiet your Rails/Rack logger on a per-route basis'
   gem.summary       = gem.description
 
-  gem.add_dependency 'railties', '>= 3'
+  gem.files = %w(.yardopts LICENSE.md README.md Rakefile silencer.gemspec)
+  gem.files += Dir.glob("lib/**/*.rb")
+  gem.files += Dir.glob("spec/**/*")
+  gem.test_files = Dir.glob("spec/**/*")
 
-  gem.files         = `git ls-files`.split("\n")
-  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   gem.require_paths = ["lib"]
 end

data/spec/silencer/rack/logger_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe Silencer::Rack::Logger do
+  let(:app) { lambda { |env| [200, {}, ''] } }
+
+  it 'quiets the log when configured with a silenced path' do
+    expect_any_instance_of(::Logger).to receive(:level=).with(::Logger::ERROR)
+
+    Silencer::Rack::Logger.new(app, :silence => ['/']).
+      call(Rack::MockRequest.env_for("/"))
+  end
+
+  it 'quiets the log when configured with a regex' 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"))
+  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'))
+  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)
+  end
+end

data/spec/silencer/rails/logger_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+describe Silencer::Rails::Logger do
+  let(:app)       { lambda { |env| [200, {}, ''] } }
+  let(:log_tags)  { [:uuid, :queue] }
+
+  it 'quiets the log when configured with a silenced path' do
+    expect(::Rails.logger).to receive(:level=).
+      with(::Logger::ERROR).at_least(:once)
+
+    Silencer::Rails::Logger.new(app, :silence => ['/']).
+      call(Rack::MockRequest.env_for("/"))
+  end
+
+  it 'quiets the log when configured with a regex' do
+    expect(::Rails.logger).to receive(:level=).
+      with(::Logger::ERROR).at_least(:once)
+
+    Silencer::Rails::Logger.new(app, :silence => [/assets/]).
+      call(Rack::MockRequest.env_for("/assets/application.css"))
+  end
+
+  it 'quiets the log when passed a custom header "X-SILENCE-LOGGER"' do
+    expect(::Rails.logger).to receive(:level=).
+      with(::Logger::ERROR).at_least(:once)
+
+    Silencer::Rails::Logger.new(app).
+      call(Rack::MockRequest.env_for("/", 'HTTP_X_SILENCE_LOGGER' => 'true'))
+  end
+
+  it 'does not tamper with the response' do
+    response = Silencer::Rails::Logger.new(app).
+      call(Rack::MockRequest.env_for("/", 'HTTP_X_SILENCE_LOGGER' => 'true'))
+
+    expect(response[0]).to eq(200)
+  end
+
+  it 'instantiates with an optional taggers array' do
+    expect(::Rails.logger).to receive(:level=).
+      with(::Logger::ERROR).at_least(:once)
+
+    Silencer::Rails::Logger.new(app, log_tags, :silence => ['/']).
+      call(Rack::MockRequest.env_for("/"))
+  end if Silencer::Environment.tagged_logger?
+
+  it 'instantiates with an optional taggers array passed as args' do
+    expect(::Rails.logger).to receive(:level=).
+      with(::Logger::ERROR).at_least(:once)
+
+    Silencer::Rails::Logger.new(app, :uuid, :queue, :silence => ['/']).
+      call(Rack::MockRequest.env_for("/"))
+  end if Silencer::Environment.tagged_logger?
+
+end

data/spec/spec_helper.rb

@@ -8,6 +8,33 @@ unless ENV['CI']
 end
 
 require 'rack'
-require 'rails'
-require 'silencer'
 require 'rspec'
+
+require 'logger'
+require 'stringio'
+
+io = StringIO.new
+
+begin
+  require 'rails'
+  ::Rails.logger = ::Logger.new(io)
+rescue LoadError
+  require 'activesupport'
+  RAILS_ENV            = 'test'
+  RAILS_ROOT           = File.dirname(__FILE__)
+  RAILS_DEFAULT_LOGGER = ::Logger.new(io)
+  require 'initializer'
+end
+
+require 'silencer'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+
+  config.before(:each) do
+    allow(::Rails.logger).to receive(:level=).with(anything)
+  end
+
+end

metadata

@@ -1,54 +1,39 @@
 --- !ruby/object:Gem::Specification
 name: silencer
 version: !ruby/object:Gem::Version
-  version: 0.6.0
-  prerelease: 
+  version: 1.0.0.rc1
+  prerelease: 6
 platform: ruby
 authors:
 - Steve Agalloco
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-02 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: railties
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '3'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '3'
-description: Selectively quiet your Rails logger on a per-action basis
+date: 2013-10-20 00:00:00.000000000 Z
+dependencies: []
+description: Selectively quiet your Rails/Rack logger on a per-route basis
 email:
 - steve.agalloco@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gemtest
-- .gitignore
-- .rspec
-- .travis.yml
 - .yardopts
-- Gemfile
-- Guardfile
 - LICENSE.md
 - README.md
 - Rakefile
-- lib/silencer.rb
+- silencer.gemspec
+- lib/silencer/environment.rb
+- lib/silencer/hush.rb
 - lib/silencer/logger.rb
+- lib/silencer/rack/logger.rb
+- lib/silencer/rails/logger.rb
+- lib/silencer/util.rb
 - lib/silencer/version.rb
-- silencer.gemspec
-- spec/silencer_spec.rb
+- lib/silencer.rb
+- spec/log/test.log
+- spec/silencer/rack/logger_spec.rb
+- spec/silencer/rails/logger_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/spagalloco/silencer
 licenses: []
@@ -64,23 +49,22 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4361503101731160331
+      hash: 3624886497730780016
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>='
+  - - ! '>'
     - !ruby/object:Gem::Version
-      version: '0'
-      segments:
-      - 0
-      hash: -4361503101731160331
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: Selectively quiet your Rails logger on a per-action basis
+summary: Selectively quiet your Rails/Rack logger on a per-route basis
 test_files:
-- spec/silencer_spec.rb
+- spec/log/test.log
+- spec/silencer/rack/logger_spec.rb
+- spec/silencer/rails/logger_spec.rb
 - spec/spec_helper.rb
 has_rdoc: 

data/.gitignore

@@ -1,17 +0,0 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp/*.log

data/.rspec

@@ -1,3 +0,0 @@
---color
---format=nested
---backtrace

data/.travis.yml

@@ -1,14 +0,0 @@
-bundler_args: --without development
-language: ruby
-rvm:
-  - jruby-18mode
-  - jruby-19mode
-  - rbx-18mode
-  - rbx-19mode
-  - 1.8.7
-  - 1.9.2
-  - 1.9.3
-  - 2.0.0
-matrix:
-  allow_failures:
-    - rvm: 2.0.0

data/Gemfile

@@ -1,16 +0,0 @@
-source 'http://rubygems.org'
-
-gem 'rake'
-gem 'yard'
-
-group :development do
-  gem 'kramdown'
-  gem 'guard-rspec'
-end
-
-group :test do
-  gem 'rspec'
-  gem 'simplecov', :require => false
-end
-
-gemspec

data/Guardfile

@@ -1,21 +0,0 @@
-# A sample Guardfile
-# More info at https://github.com/guard/guard#readme
-
-guard 'rspec', :version => 2 do
-  watch(%r{^spec/.+_spec\.rb$})
-  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
-  watch('spec/spec_helper.rb')  { "spec" }
-
-  # Rails example
-  watch(%r{^spec/.+_spec\.rb$})
-  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
-  watch(%r{^lib/(.+)\.rb$})                           { |m| "spec/lib/#{m[1]}_spec.rb" }
-  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
-  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
-  watch('spec/spec_helper.rb')                        { "spec" }
-  watch('config/routes.rb')                           { "spec/routing" }
-  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
-  # Capybara request specs
-  watch(%r{^app/views/(.+)/.*\.(erb|haml)$})          { |m| "spec/requests/#{m[1]}_spec.rb" }
-end
-

data/spec/silencer_spec.rb

@@ -1,63 +0,0 @@
-require 'spec_helper'
-
-describe Silencer::Logger do
-  before(:each) do
-    @app = lambda { |env| [200, {}, ''] }
-
-    Rails.logger = stub('ActiveSupport::BufferedLogger').tap do |l|
-      l.stub(:level).and_return(::Logger::INFO)
-      l.stub(:level=).and_return(true)
-      l.stub(:info)
-    end
-  end
-
-  def should_silence_logger
-    Rails.logger.should_receive(:level=).with(::Logger::ERROR).once
-  end
-  def should_not_silence_logger
-    Rails.logger.should_not_receive(:level=).with(::Logger::ERROR)
-  end
-
-  it 'by default does not silence any requests or use any taggers' do
-    should_not_silence_logger
-    logger = Silencer::Logger.new(@app)
-    logger.instance_variable_get(:@taggers).should == []
-    logger.call(Rack::MockRequest.env_for("/"))
-  end
-
-  let(:log_tags) { [:uuid, :queue] }
-  it 'instantiates with an optional taggers array' do
-    should_silence_logger
-    logger = Silencer::Logger.new(@app, log_tags, :silence => ['/'])
-    logger.instance_variable_get(:@taggers).should == log_tags
-    logger.call(Rack::MockRequest.env_for("/"))
-  end
-
-  # Note: initially this test used a splat on log_tags but it fails on 1.8
-  it 'instantiates with an optional taggers array passed as args' do
-    should_silence_logger
-    logger = Silencer::Logger.new(@app, :uuid, :queue, :silence => ['/'])
-    logger.instance_variable_get(:@taggers).should == log_tags
-    logger.call(Rack::MockRequest.env_for("/"))
-  end
-
-  it 'quiets the log when configured with a silenced path' do
-    should_silence_logger
-    Silencer::Logger.new(@app, :silence => ['/']).call(Rack::MockRequest.env_for("/"))
-  end
-
-  it 'quiets the log when configured with a regex' do
-    should_silence_logger
-    Silencer::Logger.new(@app, :silence => [/assets/]).call(Rack::MockRequest.env_for("/assets/application.css"))
-  end
-
-  it 'quiets the log when passed a custom header "X-SILENCE-LOGGER"' do
-    should_silence_logger
-    Silencer::Logger.new(@app).call(Rack::MockRequest.env_for("/", 'HTTP_X_SILENCE_LOGGER' => 'true'))
-  end
-
-  it 'does not tamper with the response' do
-    response = Silencer::Logger.new(@app).call(Rack::MockRequest.env_for("/", 'HTTP_X_SILENCE_LOGGER' => 'true'))
-    response[0].should eq(200)
-  end
-end