sweet-logger 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1f49f890b86cb4eca6168ff1e456b4d6f275f99e
+  data.tar.gz: 60687cabceb51fb3ec2bf0b94f57689c7959e3b4
+SHA512:
+  metadata.gz: 6cc427f8f38c31b7d7e7912ee3ffa1468681f922a57011e76705041ee8262d5b32ebcda418e2fa3415bd3d17a068c476ed434ba8950f8ffa15dd6ee365c2e212
+  data.tar.gz: a2d6d082f475fb5acc6e9a0d469b1f92a043a4cf5af7922ed17799cc785a62ecc4edc41d6f7278cd8f6302ddd3bb7b7096104b2e4d8c27e253dcffcb4daaaf63

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*.gem

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sweet-logger.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Nikolay Nemshilov
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,55 @@
+# SweetLogger
+
+This little gem solves two issues with rails `ActiveSuppot::Logger` when it's
+running in a multi-threaded environment.
+
+1. It doesn't let log entries for concurrent requests overlap
+2. Adds a log silencer (for `/assets/`) that works correctly with multiple threads
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sweet-logger'
+```
+
+Enjoy!
+
+## Rack::Lock
+
+By default in the `development` environment, Rails adds the `Rack::Lock` middleware
+so that the rack server will process only one request at a time.
+
+If you need to enable the real multi-threaded processing in the development
+environment, add this to your `config/application.rb`
+
+```ruby
+  config.middleware.delete Rack::Lock
+```
+
+
+## Silencer
+
+Our sweet logger comes with a silencer in case you need to remove some of the
+entries from leaking into the logs. By default it silences the `/assets/` entries.
+But if you need to silence anything else, add this to one of your rails initializers
+
+```ruby
+SweetLogger.silence %w[
+  favicon.io
+  livereload.js
+  /something/else
+]
+```
+
+__NOTE__: logger will check if the route _included_ in the current request's path.
+
+
+## Contributing
+
+1. Fork it ( https://github.com/MadRabbit/sweet-logger/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/lib/sweet-logger.rb

@@ -0,0 +1,4 @@
+#
+# Just a gem hook
+#
+require_relative "./sweet_logger"

data/lib/sweet_logger.rb

@@ -0,0 +1,13 @@
+module SweetLogger
+  extend self
+
+  def silence(routes)
+    Logstash.silence(routes)
+  end
+end
+
+require_relative "./sweet_logger/version"
+require_relative "./sweet_logger/middleware"
+require_relative "./sweet_logger/logstash"
+require_relative "./sweet_logger/hackhack"
+require_relative "./sweet_logger/railtie"

data/lib/sweet_logger/hackhack.rb

@@ -0,0 +1,19 @@
+#
+# Hack hack hack
+#
+# This makes the logger to write into a current thread
+# stash while it's blocked by other threads.
+#
+ActiveSupport::Logger.class_eval do
+
+  alias :add_before_sweet_logger :add
+
+  def add(*args, &block)
+    if Thread.current[:sweet_logger_stash]
+      Thread.current[:sweet_logger_stash].push [self, args, block]
+    else
+      add_before_sweet_logger *args, &block
+    end
+  end
+
+end

data/lib/sweet_logger/logstash.rb

@@ -0,0 +1,65 @@
+#
+# A little queue to stash logs while the STDOUT it blocked
+# by another threads
+#
+require "thread"
+
+module SweetLogger
+  class Logstash
+    MUTEX = Mutex.new
+
+    def self.silence(routes)
+      @silencer_re = /#{ routes.map { |e| Regexp.escape(e) }.join("|") }/
+    end
+
+    def self.silencer_re
+      @silencer_re
+    end
+
+    def wrap(path, &block)
+      silenced = shall_be_silenced?(path)
+      we_started_this = ! Thread.main[:sweet_logger_stash]
+
+      MUTEX.synchronize do
+        if we_started_this && ! silenced
+          Thread.main[:sweet_logger_stash] = []
+        else
+          Thread.current[:sweet_logger_stash] = []
+        end
+      end
+
+      yield
+
+    ensure
+      MUTEX.synchronize do
+        if silenced || ! Thread.current[:sweet_logger_stash]
+          Thread.current[:sweet_logger_stash] = []
+        end
+
+        if Thread.main[:sweet_logger_stash]
+          if we_started_this
+            flush Thread.main[:sweet_logger_stash]
+            Thread.main[:sweet_logger_stash] = nil
+          else
+            Thread.main[:sweet_logger_stash] += Thread.current[:sweet_logger_stash]
+          end
+
+        elsif
+          flush Thread.current[:sweet_logger_stash]
+        end
+
+        Thread.current[:sweet_logger_stash] = nil
+      end
+    end
+
+    def flush(entries)
+      entries.each do |logger, args, block|
+        logger.add_before_sweet_logger *args, &block
+      end
+    end
+
+    def shall_be_silenced?(path)
+      path =~ self.class.silencer_re
+    end
+  end
+end

data/lib/sweet_logger/middleware.rb

@@ -0,0 +1,20 @@
+#
+# The rack middleware patch for `Rails::Rack::Logger`
+#
+module SweetLogger
+  class Middleware < Rails::Rack::Logger
+
+    def initialize(*args, &block)
+      super
+
+      @logstash = SweetLogger::Logstash.new
+    end
+
+    def call(env)
+      @logstash.wrap env['PATH_INFO'] do
+        super env
+      end
+    end
+
+  end
+end

data/lib/sweet_logger/railtie.rb

@@ -0,0 +1,13 @@
+module SweetLogger
+  class Railtie < Rails::Railtie
+    railtie_name :sweet_logger
+
+    config.before_initialize do |app|
+      Rails.configuration.middleware.swap(
+        Rails::Rack::Logger, SweetLogger::Middleware
+      )
+
+      SweetLogger.silence %w{ /assets/ }
+    end
+  end
+end

data/lib/sweet_logger/version.rb

@@ -0,0 +1,5 @@
+module SweetLogger
+
+  VERSION = "1.0.0"
+
+end

data/sweet-logger.gemspec

@@ -0,0 +1,19 @@
+# coding: utf-8
+require_relative './lib/sweet_logger/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sweet-logger"
+  spec.version       = SweetLogger::VERSION
+  spec.authors       = ["Nikolay Nemshilov"]
+  spec.email         = ["nemshilov@gmail.com"]
+  spec.summary       = %q{Betterer Rails logger that handles multi-threading}
+  spec.description   = %q{Betterer Rails logger that handles multi-threading well}
+  spec.homepage      = "https://github.com/MadRabbit/sweet-logger"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+end

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: sweet-logger
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Nikolay Nemshilov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-31 00:00:00.000000000 Z
+dependencies: []
+description: Betterer Rails logger that handles multi-threading well
+email:
+- nemshilov@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- lib/sweet-logger.rb
+- lib/sweet_logger.rb
+- lib/sweet_logger/hackhack.rb
+- lib/sweet_logger/logstash.rb
+- lib/sweet_logger/middleware.rb
+- lib/sweet_logger/railtie.rb
+- lib/sweet_logger/version.rb
+- sweet-logger.gemspec
+homepage: https://github.com/MadRabbit/sweet-logger
+licenses:
+- MIT
+metadata: {}
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Betterer Rails logger that handles multi-threading
+test_files: []