logged 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e1310ea50fa310d62926eaae95e14a43d10a6ef1
-  data.tar.gz: d0534cb21b89cb1ed6541acf6900f80b3ad2a82c
+  metadata.gz: 9a294551c9c1d8f611c79fa771132e57b586db5c
+  data.tar.gz: 82cad862705898fe8429960241e81b33b9394f04
 SHA512:
-  metadata.gz: 3cd4a66ffaa38f73b68f58118945efd6d1e8b006b0094780ccb1b0951c74e2175def1fa6c95281aab9d041238be5ed1e92b2b0fc38a0282a0696a6e3bc257a2a
-  data.tar.gz: 16a667469a85584ba4656e37441d21396535ee3da00945e0a6ca3bc2fbe5f16ac24b210f08f97860d60aedda7fbc045e6ce2e1d58c814630fd34e5c47e1d0e3a
+  metadata.gz: 8c071f8408c92af3756ba5249da9b6b35eb630f3aefb2cd338f13df6b1457b508280cf913538e407205c317e049f1fd063d47ef27c48d4190626d2365883f1e6
+  data.tar.gz: 680ed90a1eb0aa9da95580dafe52b347b62296f40dc313c496833e0d26b717dfd6fb8b83f1b871a87526fd3ba1f0b6f3bbc897f5dbafbf259bbcbd28e947f0e0

data/.gitignore

@@ -7,6 +7,7 @@
 /pkg/
 /spec/reports/
 /tmp/
+/log/
 *.bundle
 *.so
 *.o

data/.rubocop.yml

@@ -9,3 +9,6 @@ LineLength:
 
 Metrics/MethodLength:
   Max: 16
+
+Metrics/CyclomaticComplexity:
+  Max: 8

data/.travis.yml

@@ -1,3 +1,5 @@
+sudo: false
+
 language: ruby
 
 rvm:
@@ -8,3 +10,6 @@ gemfile:
   - Gemfile
 
 script: bundle exec rake spec
+
+before_install:
+  - gem install bundler -v '~> 1.9'

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Change Log
+
+## 0.1.0 (2015-08-13)
+### Changes
+- Allow to disable/enable logger

data/README.md

@@ -29,12 +29,11 @@ Or install it yourself as:
 
 ## Usage
 
-### Overview
+### Configuration overview
 
 ```ruby
 # config/environments/*.rb or config/application.rb
 Rails.application.configure do
-
   # Enabling it
   config.logged.enabled = true
 
@@ -75,6 +74,28 @@ Rails.application.configure do
 end
 ```
 
+### Logging
+
+Get wrapping logger:
+```ruby
+logger = Logged.logger_by_component(:foo)
+```
+
+Actual logging:
+```ruby
+logger = Logged.logger_by_component(:foo)
+logger.info('bar')
+```
+
+Disable/Enable logger:
+```ruby
+logger = Logged.logger_by_component(:foo)
+logger.disable!
+logger.info('bar') # doesn't get logged
+logger.enable!
+```
+
+
 ### Lograge
 
 You can replicate the output of lograge by using the following configuration:

data/lib/logged/logger.rb

@@ -12,9 +12,12 @@ module Logged
       @loggers   = loggers
       @component = component
       @formatter = formatter
+      @enabled   = true
     end
 
     def add(severity, message = nil, progname = nil)
+      return unless enabled?
+
       message = yield    if block_given? && message.blank?
       message = progname if message.blank?
 
@@ -56,6 +59,22 @@ module Logged
 
     def <<(_msg); end
 
+    def enabled?
+      @enabled
+    end
+
+    def enabled=(enable)
+      @enabled = !!enable
+    end
+
+    def enable!
+      self.enabled = true
+    end
+
+    def disable!
+      self.enabled = false
+    end
+
     private
 
     def prepare_data(event, data, options)

data/lib/logged/rack/logger.rb

@@ -14,8 +14,6 @@ module Logged
 
         request = ActionDispatch::Request.new(env)
 
-        loggers = Logged.components.map { |c| Logged.logger_by_component(c) }.compact.uniq
-
         if loggers.length > 0
           loggers_tagged(loggers, request) { @app.call(env) }
         else
@@ -27,6 +25,10 @@ module Logged
 
       private
 
+      def loggers
+        @loggers ||= Logged.components.map { |c| Logged.logger_by_component(c) }.compact.uniq
+      end
+
       def loggers_tagged(loggers, request, &block)
         logger = loggers.shift
         tags   = tags_for_component(logger.component, request)

data/lib/logged/subscriptions.rb

@@ -0,0 +1,56 @@
+module Logged
+  # Railtie for logged
+  module Subscriptions
+    # remove rails log subscriber by component name
+    def remove_rails_subscriber(component)
+      subscriber = rails_subscriber(component)
+
+      return unless subscriber
+
+      unsubscribe(component, subscriber)
+    end
+
+    # try to guess and get rails log subscriber by component name
+    def rails_subscriber(component)
+      class_name = "::#{component.to_s.camelize}::LogSubscriber"
+
+      return unless Object.const_defined?(class_name)
+
+      clazz = class_name.constantize
+
+      ActiveSupport::LogSubscriber.log_subscribers.each do |subscriber|
+        return subscriber if subscriber.is_a?(clazz)
+      end
+
+      nil
+    end
+
+    # unsubscribe a subscriber from a component
+    def unsubscribe(component, subscriber)
+      events = subscriber.public_methods(false).reject { |method| method.to_s == 'call' }
+
+      events.each do |event|
+        ActiveSupport::Notifications.notifier.listeners_for("#{event}.#{component}").each do |listener|
+          if listener.instance_variable_get('@delegate') == subscriber
+            ActiveSupport::Notifications.unsubscribe listener
+          end
+        end
+      end
+    end
+
+    # register log subscriber with logged
+    def register(component, subscriber)
+      return if @subscribers[component].include?(subscriber)
+
+      @subscribers[component] << subscriber
+    end
+
+    # require log subscribers for rails frameworks
+    def require_rails_subscribers
+      require 'logged/log_subscriber/action_controller' if defined?(ActionController)
+      require 'logged/log_subscriber/action_view'       if defined?(ActionView)
+      require 'logged/log_subscriber/active_record'     if defined?(ActiveRecord)
+      require 'logged/log_subscriber/action_mailer'     if defined?(ActionMailer)
+    end
+  end
+end

data/lib/logged/version.rb

@@ -1,4 +1,4 @@
 module Logged
   # Version
-  VERSION = '0.0.3'
+  VERSION = '0.1.0'
 end

data/lib/logged.rb

@@ -8,10 +8,12 @@ require 'logged/formatter/single_key'
 require 'logged/formatter/logstash'
 require 'logged/railtie'
 require 'logged/rack/logger'
+require 'logged/subscriptions'
 
 # logged
 module Logged
   extend Logged::LevelConversion
+  extend Logged::Subscriptions
 
   # special keys which not represent a component
   CONFIG_KEYS = Configuration::DEFAULT_VALUES.keys + [:loggers, :disable_rails_logging]
@@ -19,7 +21,6 @@ module Logged
   mattr_accessor :app, :config
 
   class << self
-
     # setup logged
     def setup(app)
       self.app    = app
@@ -27,13 +28,7 @@ module Logged
 
       app.config.middleware.insert_after ::Rails::Rack::Logger, Logged::Rack::Logger
 
-      components.each do |component|
-        remove_rails_subscriber(component) if config[component].disable_rails_logging
-
-        next unless config[component].enabled
-
-        enable_component(component)
-      end
+      setup_components
     end
 
     # default log level
@@ -66,7 +61,7 @@ module Logged
 
       @component_loggers[key] = Logger.new(loggers, component, formatter)
     end
-    alias :'[]' :logger_by_component
+    alias_method :'[]', :logger_by_component
 
     # loggers for component
     def loggers_for(component)
@@ -111,6 +106,8 @@ module Logged
     def enable_component(component)
       loggers = loggers_for(component)
 
+      return unless loggers.any?
+
       loggers.each do |logger, options|
         level = options[:level] || config[component].level || default_level
 
@@ -118,10 +115,8 @@ module Logged
       end
 
       # only attach subscribers with loggers
-      if loggers.any?
-        @subscribers[component].each do |subscriber|
-          subscriber.attach_to(component)
-        end
+      @subscribers[component].each do |subscriber|
+        subscriber.attach_to(component)
       end
     end
 
@@ -130,13 +125,9 @@ module Logged
       return false unless event
       return false unless conf.enabled
 
-      if !event.is_a?(String) && conf.ignore.is_a?(Array)
-        return true if conf.ignore.include?(event.name)
-      end
+      return true if !event.is_a?(String) && conf.ignore.is_a?(Array) && conf.ignore.include?(event.name)
 
-      if conf.custom_ignore.respond_to?(:call)
-        return conf.custom_ignore.call(event)
-      end
+      return conf.custom_ignore.call(event) if conf.custom_ignore.respond_to?(:call)
 
       false
     end
@@ -154,67 +145,30 @@ module Logged
       config.keys - CONFIG_KEYS
     end
 
-    # remove rails log subscriber by component name
-    def remove_rails_subscriber(component)
-      subscriber = rails_subscriber(component)
-
-      return unless subscriber
-
-      unsubscribe(component, subscriber)
+    # rack request environment
+    def request_env
+      Thread.current[:logged_request_env]
     end
 
-    # try to guess and get rails log subscriber by component name
-    def rails_subscriber(component)
-      class_name = "::#{component.to_s.camelize}::LogSubscriber"
-
-      return unless Object.const_defined?(class_name)
-
-      clazz = class_name.constantize
-
-      ActiveSupport::LogSubscriber.log_subscribers.each do |subscriber|
-        return subscriber if subscriber.is_a?(clazz)
-      end
+    private
 
-      nil
-    end
+    def setup_components
+      components.each do |component|
+        remove_rails_subscriber(component) if config[component].disable_rails_logging
 
-    # unsubscribe a subscriber from a component
-    def unsubscribe(component, subscriber)
-      events = subscriber.public_methods(false).reject { |method| method.to_s == 'call' }
+        next unless config[component].enabled
 
-      events.each do |event|
-        ActiveSupport::Notifications.notifier.listeners_for("#{event}.#{component}").each do |listener|
-          if listener.instance_variable_get('@delegate') == subscriber
-            ActiveSupport::Notifications.unsubscribe listener
-          end
-        end
+        enable_component(component)
       end
     end
 
-    # register log subscriber with logged
-    def register(component, subscriber)
-      return if @subscribers[component].include?(subscriber)
-
-      @subscribers[component] << subscriber
-    end
-
-    def request_env
-      Thread.current[:logged_request_env]
-    end
-
-    private
-
     def init
-      @subscribers ||= Hash.new { |hash, key| hash[key] = [] }
+      @subscribers       ||= Hash.new { |hash, key| hash[key] = [] }
+      @component_loggers   = {}
 
-      @component_loggers = {}
+      require_rails_subscribers
     end
   end
 
   init
 end
-
-require 'logged/log_subscriber/action_controller' if defined?(ActionController)
-require 'logged/log_subscriber/action_view'       if defined?(ActionView)
-require 'logged/log_subscriber/active_record'     if defined?(ActiveRecord)
-require 'logged/log_subscriber/action_mailer'     if defined?(ActionMailer)

data/logged.gemspec

@@ -19,9 +19,10 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler',      '~> 1.7'
-  spec.add_development_dependency 'rake',         '~> 10.0'
-  spec.add_development_dependency 'rspec',        '~> 3.1'
+  spec.add_development_dependency 'bundler',      '~> 1.9'
+  spec.add_development_dependency 'rake',         '~> 10.4'
+  spec.add_development_dependency 'rspec',        '~> 3.2'
+  spec.add_development_dependency 'rails',        rails_version
   spec.add_development_dependency 'actionpack',   rails_version
   spec.add_development_dependency 'actionview',   rails_version
   spec.add_development_dependency 'actionmailer', rails_version

data/spec/config_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+require 'logged'
+require 'rails'
+
+RSpec.describe 'Logged Configuration' do
+  before do
+    class Application < Rails::Application
+      config.eager_load = true
+
+      config.logged.enabled = true
+    end
+
+    Rails.application.initialize!
+  end
+
+  it 'enables logged' do
+    expect(Logged.config.enabled).to eq(true)
+  end
+end

data/spec/formatter/key_value_spec.rb

@@ -5,6 +5,10 @@ RSpec.describe Logged::Formatter::KeyValue do
   subject { described_class.new }
 
   it 'serializes data' do
-    expect(subject.call(foo: 'bar')).to eq("foo='bar'")
+    expect(subject.call(foo: 'bar', bar: 3.123)).to eq("foo='bar' bar=3.12")
+  end
+
+  it 'ignores nil values' do
+    expect(subject.call(foo: 'bar', bar: nil)).to eq("foo='bar'")
   end
 end

data/spec/formatter/single_key_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+require 'logged'
+
+RSpec.describe Logged::Formatter::SingleKey do
+  subject { described_class.new(:foo) }
+
+  it 'serializes data' do
+    expect(subject.call(foo: 'bar', bar: 'foo')).to eq('bar')
+  end
+end

data/spec/removes_rails_log_subscribers_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+require 'logged'
+require 'active_support/notifications'
+require 'active_support/log_subscriber'
+require 'action_controller/log_subscriber'
+require 'action_view/log_subscriber'
+require 'action_mailer/log_subscriber'
+require 'active_record/log_subscriber'
+
+RSpec.describe 'Rails log subscriber' do
+  after do
+    log_subscribers = []
+
+    ActiveSupport::LogSubscriber.log_subscribers.each do |subscriber|
+      events = subscriber.public_methods(false).reject { |method| method.to_s == 'call' }
+      events.each do |event|
+        ActiveSupport::Notifications.notifier.listeners_for("#{event}.#{subscriber.class.to_s.split('::').first.underscore}").each do |listener|
+          delegate = listener.instance_variable_get('@delegate')
+          log_subscribers << subscriber.class if delegate == subscriber
+        end
+      end
+    end
+
+    ActionController::LogSubscriber.attach_to :action_controller unless log_subscribers.include?(ActionController::LogSubscriber)
+    ActionView::LogSubscriber.attach_to       :action_view       unless log_subscribers.include?(ActionView::LogSubscriber)
+    ActionMailer::LogSubscriber.attach_to     :action_mailer     unless log_subscribers.include?(ActionMailer::LogSubscriber)
+    ActiveRecord::LogSubscriber.attach_to     :active_record     unless log_subscribers.include?(ActiveRecord::LogSubscriber)
+  end
+
+  it 'is removed for action_controller events' do
+    expect {
+      Logged.remove_rails_subscriber(:action_controller)
+    }.to change {
+      ActiveSupport::Notifications.notifier.listeners_for('process_action.action_controller')
+    }
+  end
+
+  it 'is removed for action_view events' do
+    expect {
+      Logged.remove_rails_subscriber(:action_view)
+    }.to change {
+      ActiveSupport::Notifications.notifier.listeners_for('render_template.action_view')
+    }
+  end
+
+  it 'is removed for action_mailer events' do
+    expect {
+      Logged.remove_rails_subscriber(:action_mailer)
+    }.to change {
+      ActiveSupport::Notifications.notifier.listeners_for('deliver.action_mailer')
+    }
+  end
+
+  it 'is removed for active_record events' do
+    expect {
+      Logged.remove_rails_subscriber(:active_record)
+    }.to change {
+      ActiveSupport::Notifications.notifier.listeners_for('sql.active_record')
+    }
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logged
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - Florian Schwab
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-01 00:00:00.000000000 Z
+date: 2015-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,42 +16,62 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '1.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '1.9'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '10.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '10.4'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
@@ -163,6 +183,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -184,13 +205,16 @@ files:
 - lib/logged/logger.rb
 - lib/logged/rack/logger.rb
 - lib/logged/railtie.rb
+- lib/logged/subscriptions.rb
 - lib/logged/tagged_logging.rb
 - lib/logged/version.rb
 - logged.gemspec
+- spec/config_spec.rb
 - spec/formatter/json_spec.rb
 - spec/formatter/key_value_spec.rb
 - spec/formatter/raw_spec.rb
-- spec/logged_spec.rb
+- spec/formatter/single_key_spec.rb
+- spec/removes_rails_log_subscribers_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/ydkn/logged
 licenses:
@@ -212,14 +236,16 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Better logging for rails
 test_files:
+- spec/config_spec.rb
 - spec/formatter/json_spec.rb
 - spec/formatter/key_value_spec.rb
 - spec/formatter/raw_spec.rb
-- spec/logged_spec.rb
+- spec/formatter/single_key_spec.rb
+- spec/removes_rails_log_subscribers_spec.rb
 - spec/spec_helper.rb
 has_rdoc: 

data/spec/logged_spec.rb

@@ -1,63 +0,0 @@
-require 'spec_helper'
-require 'logged'
-require 'active_support/notifications'
-require 'active_support/log_subscriber'
-require 'action_controller/log_subscriber'
-require 'action_view/log_subscriber'
-require 'action_mailer/log_subscriber'
-require 'active_record/log_subscriber'
-
-RSpec.describe Logged do
-  context 'when removing Rails log subscribers' do
-    after do
-      log_subscribers = []
-
-      ActiveSupport::LogSubscriber.log_subscribers.each do |subscriber|
-        events = subscriber.public_methods(false).reject { |method| method.to_s == 'call' }
-        events.each do |event|
-          ActiveSupport::Notifications.notifier.listeners_for("#{event}.#{subscriber.class.to_s.split('::').first.underscore}").each do |listener|
-            delegate = listener.instance_variable_get('@delegate')
-            log_subscribers << subscriber.class if delegate == subscriber
-          end
-        end
-      end
-
-      ActionController::LogSubscriber.attach_to :action_controller unless log_subscribers.include?(ActionController::LogSubscriber)
-      ActionView::LogSubscriber.attach_to :action_view unless log_subscribers.include?(ActionView::LogSubscriber)
-      ActionMailer::LogSubscriber.attach_to :action_mailer unless log_subscribers.include?(ActionMailer::LogSubscriber)
-      ActiveRecord::LogSubscriber.attach_to :active_record unless log_subscribers.include?(ActiveRecord::LogSubscriber)
-    end
-
-    it 'removes subscribers for action_controller events' do
-      expect {
-        Logged.remove_rails_subscriber(:action_controller)
-      }.to change {
-        ActiveSupport::Notifications.notifier.listeners_for('process_action.action_controller')
-      }
-    end
-
-    it 'removes subscribers for action_view events' do
-      expect {
-        Logged.remove_rails_subscriber(:action_view)
-      }.to change {
-        ActiveSupport::Notifications.notifier.listeners_for('render_template.action_view')
-      }
-    end
-
-    it 'removes subscribers for action_mailer events' do
-      expect {
-        Logged.remove_rails_subscriber(:action_mailer)
-      }.to change {
-        ActiveSupport::Notifications.notifier.listeners_for('deliver.action_mailer')
-      }
-    end
-
-    it 'removes subscribers for active_record events' do
-      expect {
-        Logged.remove_rails_subscriber(:active_record)
-      }.to change {
-        ActiveSupport::Notifications.notifier.listeners_for('sql.active_record')
-      }
-    end
-  end
-end