logging-rails 0.2.0 → 0.3.0

data/History.txt

@@ -1,3 +1,10 @@
+== 0.3.0 / 2011-09-19
+
+Enhancements
+- Appending default "log_to" destinations to the configuration files
+- Remove the LogTail middleware if present
+- Removing the Rails version check
+
 == 0.2.0 / 2011-09-16
 
 Enhancements

data/README.md

@@ -7,18 +7,24 @@ framework into your Rails 3 application.
 Features
 --------
 
+The railtie provides only one feature - integration of the **Logging**
+framework into your Rails appcliation. But this gives you quite a bit of
+flexibility to format your log messages and direct them to multiple logging
+destiations: stdout with colors, a rolling log file, email, or even get a
+growl notification.
+
 Install
 -------
 
-Add the ```logging-rails``` railtie gem to your rails project's Gemfile and run ```bundle install```.
+Add the ```logging-rails``` railtie gem to your Rails project's Gemfile and run ```bundle install```.
 
 ```ruby
 gem 'logging-rails', :require => 'logging/rails'
 ````
 
 A generator is included with the railtie that will create a ```config/logging.rb```
-configuration file for use in your rails project. Please run this generator
-before attempting use the logging framework.
+configuration file for use in your Rails project. Please run this generator
+before attempting to use the **Logging** framework.
 
 ```
 rails generate logging:install
@@ -27,14 +33,58 @@ rails generate logging:install
 Usage
 -----
 
-Out of the box, the Logging framework is configured to behave in the same way
-as the standard Rails logger setup. The major exception is that the log file
-will be rolled daily - gone are the days of 2GB log files on production
+Out of the box, the **Logging** framework is configured to behave in the same
+way as the standard Rails logger setup. The major exception is that the log
+file will be rolled daily - gone are the days of 2GB log files on production
 servers.
 
-config.log_to
+The railtie adds a configuration option, ```log_to```, that determines where
+log messages will be sent. This is an array of appender names (an appender
+writes log messages to some destination such as a file, STDOUT, syslog, email,
+etc.). The appender configuration should be set in your environment specific
+configuration file. For example, in production we would want to log to a file
+and send emails on error:
+
+```ruby
+config.log_to = %w[file email]
+```
+
+The **Logging** framework sets the global log level from the ```log_level```
+configuration item. However, each class can be assigned its own log level.
+This is very useful when debugging a single controller or model in your
+Rails application. Consider the example below. The overall log level for the
+application is set to ```:info```, but the log level for the *User* model and
+controller is set to ```:debug```.
+
+```ruby
+config.log_level = :info
+Logging.logger['User'].level = :debug
+Logging.logger['UserController'].level = :debug
+```
 
-Logging.logger['ModelName'].level = :debug
+When using the logging railtie, a small display of the current logging
+configuration will be displayed when the Rails logger is in the debug mode.
+A description of the display can be found [here](https://github.com/TwP/logging/blob/master/lib/logging.rb#L400).
+
+```
+root  ............................................  *debug      -T
+- <Appenders::Stdout:0x806bc058 name="stdout">
+- <Appenders::RollingFile:0x806bbc0c name="file">
+  ActionController::Base  ........................   debug  +A  -T
+  ActiveRecord::Base  ............................   debug  +A  -T
+  ActiveSupport::Cache::FileStore  ...............   debug  +A  -T
+  ActiveSupport::Dependencies  ...................   debug  +A  -T
+  Logging  .......................................    *off  -A  -T
+  Rails  .........................................   debug  +A  -T
+```
+
+This is useful for understanding more complex logging configurations. It can
+be annoying in day-to-day usage. The soluation is to set the Rails logger to
+```:info``` or higher.
+
+```ruby
+Logging.logger['Rails'].level = :info
+```
 
 Author
 ------

data/lib/logging/rails.rb

@@ -2,6 +2,12 @@
 require 'logging'
 include Logging.globally
 
+require 'rails' if !defined? Rails or Rails.version
+
+if Rails.version < '3'
+  abort("The Logging Railtie only works with Rails 3 or higher - you are running Rails #{Rails.version}")
+end
+
 module Logging::Rails
 
   # :stopdoc:
@@ -66,3 +72,20 @@ module Logging::Rails
 
 end  # Logging::Rails
 
+
+# Here we need to remove the Rails LogTailer from the list of middlewares. The
+# Logging framework is fully capable of sending log events to multiple logging
+# destinations.
+#
+module Rails
+  class Server < ::Rack::Server
+    def middleware_without_log_tailer
+      middlewares = middleware_with_log_tailer['anything']
+      middlewares.delete_if { |middleware| Rails::Rack::LogTailer == middleware.first }
+      Hash.new(middlewares)
+    end
+    alias :middleware_with_log_tailer :middleware
+    alias :middleware :middleware_without_log_tailer
+  end
+end
+

data/lib/logging/rails/generators/USAGE

@@ -6,3 +6,7 @@ Example:
 
     This will create:
         config/logging.rb
+
+    And it will append "log_to" destinations to:
+        config/environments/development.rb
+        config/environments/production.rb

data/lib/logging/rails/generators/install_generator.rb

@@ -8,6 +8,12 @@ module Logging::Rails
       def generate_config
         template 'logging.rb.erb', 'config/logging.rb'
       end
+
+      def insert_log_to_destinations
+        comment = "\n  # Set the logging destination(s)\n  %s\n"
+        insert_into_file 'config/environments/development.rb', comment % 'config.log_to = %w[stdout file]', :before => %r/^end\s*$/
+        insert_into_file 'config/environments/production.rb', comment % 'config.log_to = %w[file]', :before => %r/^end\s*$/
+      end
     end
   end
 end

data/lib/logging/rails/railtie.rb

@@ -1,12 +1,4 @@
 
-if !defined? Rails or Rails.version
-  abort('The Logging Railtie only works in the context of a Rails application')
-end
-
-if Rails.version < '3'
-  abort("The Logging Railtie only works with Rails 3 or higher - you are running Rails #{Rails.version}")
-end
-
 module Logging::Rails
 
   # The Railtie is used to inject the Logging framework into the Rails

data/version.txt

@@ -1 +1 @@
-0.2.0
+0.3.0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: logging-rails
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-16 00:00:00.000000000Z
+date: 2011-09-19 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logging
-  requirement: &2163091300 !ruby/object:Gem::Requirement
+  requirement: &2154977120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 1.6.1
   type: :runtime
   prerelease: false
-  version_requirements: *2163091300
+  version_requirements: *2154977120
 - !ruby/object:Gem::Dependency
   name: bones
-  requirement: &2163090480 !ruby/object:Gem::Requirement
+  requirement: &2154976480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: 3.7.1
   type: :development
   prerelease: false
-  version_requirements: *2163090480
+  version_requirements: *2154976480
 description: ! 'A Railtie for for integrating the [Logging](https://github.com/TwP/logging)
 
   framework into your Rails 3 application.'