hatchet 0.0.17 → 0.0.18

data/README.md

@@ -0,0 +1,141 @@
+# Hatchet
+
+Ruby logging library that provides the ability to add class/module specific
+filters.
+
+This README provides a brief overview of Hatchet, [see the main site for more complete documentation and tutorials](http://gshutler.github.com/hatchet/).
+
+[![Build Status](https://secure.travis-ci.org/gshutler/hatchet.png?branch=master)](http://travis-ci.org/gshutler/hatchet)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hatchet'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+Or install it yourself as:
+
+```
+$ gem install hatchet
+```
+
+## Usage
+
+### Logging
+
+To use the logger you must add it to your classes as a mixin or use it to extend
+your modules. Then you can call the logger through the methods `log` and
+`logger`. They are aliases for the same method to ease migration.
+
+#### Classes
+
+```ruby
+class Foo
+  include Hatchet
+
+  def self.class_work
+    log.info { 'Doing some class work' }
+  end
+
+  def work
+    log.info { 'Doing some work' }
+  end
+
+  def dangerous_work
+    log.info { 'Attempting dangerous work' }
+    attempt_dangerous_work
+    log.info { 'Dangerous work complete' }
+    true
+  rescue => e
+    log.error "Dangerous work failed - #{e.message}", e
+    false
+  end
+end
+```
+
+#### Modules
+
+```ruby
+module Bar
+  include Hatchet
+
+  def self.work
+    log.info { 'Doing some module work' }
+  end
+
+  def work
+    log.info { 'Doing some mixin work' }
+  end
+end
+```
+
+### Configuration
+
+#### Standard
+
+```ruby
+Hatchet.configure do |config|
+  # Set the level to use unless overridden (defaults to :info)
+  config.level :info
+  # Set the level for a specific class/module and its children
+  config.level :debug, 'Namespace::Something::Nested'
+
+  # Add as many appenders as you like
+  config.appenders << Hatchet::LoggerAppender.new do |appender|
+    # Set the logger that this is wrapping (required)
+    appender.logger = Logger.new('log/test.log')
+  end
+end
+```
+
+#### Sinatra
+
+Use the standard configuration method but also register Hatchet as a helper
+where appropriate:
+
+```ruby
+register Hatchet
+```
+
+Note that you may have to use the `log` alias as Sinatra already has a `logger`
+method.
+
+#### Rails
+
+Hatchet includes a Railtie that is loaded automatically and wraps the
+`Rails.logger`. The Hatchet configuration object is available through
+`config.hatchet` within your standard configuration files for fine-tuning your
+Hatchet configuration.
+
+To make it so your log calls are scoped to your controllers you also need to add
+Hatchet to your `ApplicationController`:
+
+```ruby
+class ApplicationController < ActionController::Base
+  include Hatchet
+end
+```
+
+You could include it in your models so that each of those has its own logging
+context too.
+
+## Contributing
+
+1. Fork it
+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 new Pull Request
+
+All pull requests should come complete with tests when appropriate and should
+follow the existing style which is best described in
+[Github's Ruby style guide](https://github.com/styleguide/ruby/).
+

data/RELEASE.md

@@ -0,0 +1,16 @@
+# Release notes
+
+## 0.0.18
+
+ * Made the presence of a `formatter=` method on appenders optional
+
+## 0.0.17
+
+ * Added the ability to pass an error along with your message
+
+### Bug fixes
+
+ * Fixed the fallback logging if an appender raises an error whilst trying to
+   log a message
+ * Ensured all logging calls truly do return `nil` rather than it just being
+   part of the documented contract

data/lib/hatchet/configuration.rb

@@ -58,9 +58,9 @@ module Hatchet
     #         used to setup Hatchet.
     #
     # Once the block returns each of the configured appenders has its formatter
-    # set to the default formatter if one is not already set, and its levels
-    # Hash is set to the shared levels Hash if an explicit one has not been
-    # provided.
+    # set to the default formatter if they have one and one is not already set,
+    # and its levels Hash is set to the shared levels Hash if an explicit one
+    # has not been provided.
     #
     # Example
     #
@@ -85,8 +85,8 @@ module Hatchet
       # Ensure every appender has a formatter and a level configuration.
       #
       appenders.each do |appender|
-        appender.formatter ||= @formatter
-        appender.levels = @levels if appender.levels.empty?
+        appender.formatter ||= @formatter if appender.respond_to? 'formatter='
+        appender.levels = @levels         if appender.levels.empty?
       end
     end
 

data/lib/hatchet/hatchet_logger.rb

@@ -20,8 +20,17 @@ module Hatchet
   #
   # Examples
   #
-  #   logger.info "Informational message"
-  #   logger.info { "Informational message #{potentially_expensive}" }
+  #   log.info "Informational message"
+  #   log.info { "Informational message #{potentially_expensive}" }
+  #
+  # It is also possible to pass an error to associate with a message. It is down
+  # to the appender what it will do with the error (such as including the stack
+  # trace) so it is recommended you still include basic information within the
+  # message you pass.
+  #
+  # Examples
+  #
+  #   log.error "Something bad happened - #{error.message}", error
   #
   # Log messages are sent to each appender where they will be filtered and
   # invoked as configured.

data/lib/hatchet/version.rb

@@ -4,6 +4,6 @@ module Hatchet
 
   # Public: The version of Hatchet.
   #
-  VERSION = '0.0.17'
+  VERSION = '0.0.18'
 
 end

data/spec/configuration_spec.rb

@@ -12,11 +12,17 @@ describe 'configuration' do
   describe 'appender defaults' do
     let(:set_levels) { { unique: :fake_level } }
     let(:appender)   { StoringAppender.new }
+    let(:unformatted_appender) do
+      obj = Object.new
+      obj.extend Hatchet::LevelManager
+      obj
+    end
 
     before do
       Hatchet.configure do |config|
         config.levels = set_levels
         config.appenders << appender
+        config.appenders << unformatted_appender
       end
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hatchet
 version: !ruby/object:Gem::Version
-  version: 0.0.17
+  version: 0.0.18
   prerelease: 
 platform: ruby
 authors:
@@ -47,7 +47,9 @@ files:
 - spec/spec_helper.rb
 - spec/standard_formatter_spec.rb
 - LICENSE
-homepage: https://github.com/gshutler/hatchet
+- README.md
+- RELEASE.md
+homepage: http://gshutler.github.com/hatchet/
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -59,18 +61,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -2041677748427944104
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -2041677748427944104
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.17