yell 0.3.1 → 0.3.2

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+
+script: "rake"
+
+rvm:
+  - 1.9.3
+
+notifications:
+  email:
+    - me@rudionrails.com

data/README.md

@@ -1,5 +1,7 @@
 Yell - Your Extensible Logging Library
 
+[![Build Status](https://secure.travis-ci.org/rudionrails/yell.png)](http://travis-ci.org/rudionrails/yell)
+
 ## Installation
 
 System wide:
@@ -11,10 +13,11 @@ gem install yell
 Or in your Gemfile:
 
 ```ruby
-gem 'yell'
+gem "yell"
 ```
 
 ## Usage
+
 On the basics, Yell works just like any other logging library. However, it 
 tries to make your log mesages  more readable. By default, it will format the given 
 message as follows:
@@ -32,17 +35,20 @@ When no arguments are given, Yell will check for `ENV['RACK_ENV']` and
 determine the filename from that.
 
 Alternatively, you may define `ENV['YELL_ENV']` to set the filename. If neither 
-`YELL_ENV` or `RACK_ENV` is defined, `'development'` will be the default. Also, if a 
+`YELL_ENV` or `RACK_ENV` is defined, *'development'* will be the default. Also, if a 
 `log` directory exists, Yell will place the file there (only if you have not passed
 a filename explicitly.
 
 Naturally, you can pass a `:filename` to Yell:
 
 ```ruby
-logger = Yell.new 'yell.log'
+logger = Yell.new "yell.log"
 ```
 
-To learn about how to use [log levels](https://github.com/rudionrails/yell/wiki/101-setting-the-log-level), [log formatting](https://github.com/rudionrails/yell/wiki/101-formatting-log-messages), or different [adapters](https://github.com/rudionrails/yell/wiki/101-using-adapters) see the [wiki](https://github.com/rudionrails/yell/wiki) or have a look into the examples folder.
+To learn about how to use [log levels](https://github.com/rudionrails/yell/wiki/101-setting-the-log-level), 
+[log formatting](https://github.com/rudionrails/yell/wiki/101-formatting-log-messages), or different 
+[adapters](https://github.com/rudionrails/yell/wiki/101-using-adapters) see the 
+[wiki](https://github.com/rudionrails/yell/wiki) or have a look into the examples folder.
 
 
 Copyright © 2011-2012 Rudolf Schmidt, released under the MIT license

data/Rakefile

@@ -4,23 +4,19 @@ require 'bundler'
 Bundler::GemHelper.install_tasks
 
 # === RSpec
-require 'rspec/core/rake_task'
+begin
+  require 'rspec/core/rake_task'
 
-desc "Run specs"
-RSpec::Core::RakeTask.new do |t|
-  t.rspec_opts = %w(-fs --color)
+  desc "Run specs"
+  RSpec::Core::RakeTask.new do |t|
+    t.rspec_opts = %w(--color --format progress --order random)
+    t.ruby_opts = %w(-w)
+  end
+rescue LoadError
+  task :spec do
+    abort "`gem install rspec` in order to run tests"
+  end
 end
 
 task :default => :spec
 
-
-# === Rdoc
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "inventory #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end

data/examples/001-basic-usage.rb

@@ -1,4 +1,4 @@
-#!/usr/bin/env ruby
+# encoding: utf-8
 
 require File.dirname(__FILE__) + '/../lib/yell'
 

data/examples/002.1-log-level-basics.rb

@@ -1,4 +1,4 @@
-#!/usr/bin/env ruby
+# encoding: utf-8
 
 require File.dirname(__FILE__) + '/../lib/yell'
 

data/examples/002.2-log-level-on-certain-severities-only.rb

@@ -1,4 +1,4 @@
-#!/usr/bin/env ruby
+# encoding: utf-8
 
 require File.dirname(__FILE__) + '/../lib/yell'
 

data/examples/002.3-log-level-within-range.rb

@@ -1,4 +1,4 @@
-#!/usr/bin/env ruby
+# encoding: utf-8
 
 require File.dirname(__FILE__) + '/../lib/yell'
 

data/examples/003.1-formatting-DefaultFormat.rb

@@ -1,4 +1,4 @@
-#!/usr/bin/env ruby
+# encoding: utf-8
 
 require File.dirname(__FILE__) + '/../lib/yell'
 

data/examples/003.2-formatting-BasicFormat.rb

@@ -1,4 +1,4 @@
-#!/usr/bin/env ruby
+# encoding: utf-8
 
 require File.dirname(__FILE__) + '/../lib/yell'
 

data/examples/003.3-formatting-ExtendedFormat.rb

@@ -1,4 +1,4 @@
-#!/usr/bin/env ruby
+# encoding: utf-8
 
 require File.dirname(__FILE__) + '/../lib/yell'
 

data/examples/003.4-formatting-on-your-own.rb

@@ -1,4 +1,4 @@
-#!/usr/bin/env ruby
+# encoding: utf-8
 
 require File.dirname(__FILE__) + '/../lib/yell'
 

data/lib/yell/adapters/base.rb

@@ -12,22 +12,10 @@ module Yell #:nodoc:
 
       # The main method for calling the adapter.
       #
-      # Adapter classes should provide their own implementation 
-      # of this method.
+      # The method receives the log `event` and determines whether to 
+      # actually write or not.
       def write( event )
-        nil
-      end
-
-      # Determine whether to write at the given severity.
-      #
-      # @example
-      #   write? :error
-      #
-      # @param [String,Symbol,Integer] severity The severity to ask if to write or not.
-      #
-      # @return [Boolean] true or false
-      def write?( severity )
-        @level.nil? || @level.at?( severity )
+        write!( event ) if write?( event )
       end
 
       # Close the adapter (stream, connection, etc).
@@ -35,7 +23,7 @@ module Yell #:nodoc:
       # Adapter classes should provide their own implementation 
       # of this method.
       def close
-        nil
+        raise 'Not implemented'
       end
 
       # Set the log level.
@@ -48,6 +36,28 @@ module Yell #:nodoc:
         @level = Yell::Level.new( severity )
       end
 
+      private
+
+      # The perform the actual write.
+      #
+      # Adapter classes should provide their own implementation 
+      # of this method.
+      def write!( event )
+        raise 'Not implemented'
+      end
+
+      # Determine whether to write at the given severity.
+      #
+      # @example
+      #   write? :error
+      #
+      # @param [String,Symbol,Integer] severity The severity to ask if to write or not.
+      #
+      # @return [Boolean] true or false
+      def write?( event )
+        @level.nil? || @level.at?( event.level )
+      end
+
     end
 
   end

data/lib/yell/adapters/datefile.rb

@@ -21,13 +21,6 @@ module Yell #:nodoc:
         super( options, &block )
       end
 
-      # @overload Close the file if date is expired
-      def write( event )
-        close if close?
-
-        super( event )
-      end
-
       # @overload Reset the file handle
       def close
         @filename = new_filename
@@ -38,6 +31,13 @@ module Yell #:nodoc:
 
       private
 
+      # @overload Close the file if date is expired
+      def write!( event )
+        close if close?
+
+        super( event )
+      end
+
       # Determines whether to close the file handle or not.
       #
       # It is based on the `:date_pattern` (can be passed as option upon initialize). 

data/lib/yell/adapters/io.rb

@@ -25,28 +25,9 @@ module Yell
 
         level options.fetch(:level, nil)
         format options.fetch(:format, nil)
-        colorize! options.fetch(:colorize, false)
+        colorize options.fetch(:colorize, false)
 
-        instance_eval &block if block
-      end
-
-      # Main method to calling the file adapter.
-      #
-      # The method formats the message and writes it to the file handle.
-      #
-      # @example
-      #   write( 'info', 'Hello World' )
-      def write( event )
-        message = @formatter.format( event )
-
-        # colorize if applicable
-        if colorize? and color = Colors[level]
-          message = color + message + Colors['DEFAULT']
-        end
-
-        message << "\n" unless message[-1] == ?\n # add new line if there is none
-
-        write!( message )
+        instance_eval( &block ) if block
       end
 
       # Set the format for your message.
@@ -59,20 +40,29 @@ module Yell
       end
 
       # Enable colorizing the log output.
-      def colorize!( color = true )
+      def colorize( color = true )
         @colorize = color
       end
 
-      # Determie whether to colorize the log output or nor
-      #
-      # @return [Boolean] true or false
-      def colorize?; !!@colorize; end
+      def close
+        @stream.close if @stream.respond_to? :close
 
+        @stream = nil
+      end
 
       private
 
-      # TODO: Implement Buffer to not flush immediately.
-      def write!( message )
+      # The method formats the message and writes it to the file handle.
+      def write!( event )
+        message = @formatter.format( event )
+
+        # colorize if applicable
+        if colorize? and color = Colors[event.level]
+          message = color + message + Colors['DEFAULT']
+        end
+
+        message << "\n" unless message[-1] == ?\n # add new line if there is none
+
         stream.print( message )
         stream.flush
       rescue => e
@@ -82,6 +72,9 @@ module Yell
         raise( e, caller )
       end
 
+      # Determie whether to colorize the log output or nor
+      def colorize?; !!@colorize; end
+
     end
 
   end

data/lib/yell/formatter.rb

@@ -42,7 +42,7 @@ module Yell #:nodoc:
   ExtendedFormat  = "%d [%5L] %p %h : %m"
 
 
-  def self.format( pattern, date_pattern )
+  def self.format( pattern, date_pattern = nil )
     Yell::Formatter.new( pattern, date_pattern )
   end
 
@@ -50,7 +50,6 @@ module Yell #:nodoc:
   # The +Formatter+ provides a handle to configure your log message style.
   class Formatter
 
-    #:nodoc:
     PatternTable = {
       "m" => "event.message",                 # Message
       "l" => "event.level[0]",                # Level (short), e.g.'I', 'W'
@@ -64,10 +63,14 @@ module Yell #:nodoc:
       "n" => "event.line"                     # Line where the logger was called
     }
 
-    #:nodoc:
     PatternRegexp = /([^%]*)(%\d*)?([#{PatternTable.keys.join}])?(.*)/
 
 
+    # Initializes a new +Yell::Formatter+.
+    #
+    # Upon initialization it defines a format method. `format` takes 
+    # a {Yell::Event} instance as agument in order to apply for desired log 
+    # message formatting.
     def initialize( pattern = nil, date_pattern = nil )
       @pattern      = pattern || Yell::DefaultFormat
       @date_pattern = date_pattern
@@ -75,7 +78,6 @@ module Yell #:nodoc:
       define!
     end
 
-
     private
 
     # defines the format method

data/lib/yell/logger.rb

@@ -49,7 +49,7 @@ module Yell #:nodoc:
       level @options[:level] if @options[:level]
 
       # eval the given block
-      instance_eval &block if block
+      instance_eval( &block ) if block
 
       define!
     end
@@ -82,7 +82,7 @@ module Yell #:nodoc:
       end
 
       @adapters << Yell::Adapters[ type, options, &block ]
-    rescue NameError => e
+    rescue NameError
       raise Yell::NoSuchAdapter, type
     end
 
@@ -136,7 +136,7 @@ module Yell #:nodoc:
 
     # Cycles all the adapters and writes the message
     def write( event )
-      @adapters.each { |a| a.write(event) if a.write?(event.level) }
+      @adapters.each { |a| a.write(event) }
     end
 
   end

data/lib/yell/version.rb

@@ -1,4 +1,4 @@
 module Yell #:nodoc:
-  VERSION = "0.3.1"
+  VERSION = "0.3.2"
 
 end

data/spec/spec_helper.rb

@@ -4,17 +4,11 @@ $:.unshift File.expand_path('../../lib', __FILE__)
 require 'yell'
 
 require 'rspec'
+require 'rr'
 require 'timecop'
 
 RSpec.configure do |config|
-
-  config.before do
-    Yell.config.stub!( :yaml_file ).and_return( File.dirname(__FILE__) + '/config/yell.yml' )
-  end
-
-  config.after do
-    Yell.config.reload! # to not run into caching problems during tests
-  end
+  config.mock_framework = :rr
 
 end
 

data/spec/yell/event_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+
+describe Yell::Event do
+  let(:event) { Yell::Event.new 'INFO', 'Hello World!' }
+
+  context :level do
+    subject { event.level}
+
+    it { should == 'INFO' }
+  end
+
+  context :message do
+    subject { event.message }
+
+    it { should == 'Hello World!' }
+  end
+
+  context :time do
+    subject { event.time }
+
+    let(:time) { Time.now }
+
+    before do
+      Timecop.freeze( time )
+    end
+
+    it { should == time }
+  end
+
+  context :caller do
+    let(:file) { "event.rb" }
+    let(:line) { "123" }
+    let(:method) { "test_method" }
+
+    before do
+      any_instance_of( Yell::Event ) do |e|
+        mock( e ).caller(4) { ["#{file}:#{line}:in `#{method}'"] }
+      end
+    end
+
+    context :file do
+      subject { event.file }
+
+      it  { should == file }
+    end
+
+    context :line do
+      subject { event.line }
+
+      it { should == line }
+    end
+
+    context :method do
+      subject { event.method }
+
+      it { should == method }
+    end
+  end
+
+end

data/spec/yell/formatter_spec.rb

@@ -0,0 +1,103 @@
+require 'spec_helper'
+
+describe Yell::Formatter do
+
+  let( :formatter ) { Yell::Formatter.new(subject) }
+  let( :event ) { Yell::Event.new 'INFO', 'Hello World!' }
+  let( :time ) { Time.now }
+
+  let( :format ) { formatter.format(event) }
+
+  before do
+    Timecop.freeze( time )
+  end
+
+  context "%m" do
+    subject { "%m" }
+
+    it { format.should == "Hello World!" }
+  end
+
+  context "%l" do
+    subject { "%l" }
+
+    it { format.should == "I" }
+  end
+
+  context "%L" do
+    subject { "%L" }
+
+    it { format.should == "INFO" }
+  end
+
+  context "%d" do
+    subject { "%d" }
+
+    it { format.should == time.iso8601 }
+  end
+
+  context "%p" do
+    subject { "%p" }
+
+    it { format.should == Process.pid.to_s }
+  end
+
+  context "%h" do
+    subject { "%h" }
+
+    it { format.should == Socket.gethostname }
+  end
+
+  context "caller" do
+    let( :_caller ) { ["/path/to/file.rb:123:in `test_method'"] }
+
+    before do
+      any_instance_of( Yell::Event ) do |e|
+        mock(e).caller(4) { _caller }
+      end
+    end
+
+    context "%F" do
+      subject { "%F" }
+
+      it { format.should == "/path/to/file.rb" }
+    end
+
+    context "%f" do
+      subject { "%f" }
+
+      it { format.should == "file.rb" }
+    end
+
+    context "%M" do
+      subject { "%M" }
+
+      it { format.should == "test_method" }
+    end
+
+    context "%n" do
+      subject { "%n" }
+
+      it { format.should == "123" }
+    end
+  end
+
+  context "DefaultFormat" do
+    subject { Yell::DefaultFormat }
+
+    it { format.should == "#{time.iso8601} [ INFO] #{$$} : Hello World!"  }
+  end
+
+  context "BasicFormat" do
+    subject { Yell::BasicFormat }
+
+    it { format.should == "I, #{time.iso8601} : Hello World!"  }
+  end
+
+  context "ExtendedFormat" do
+    subject { Yell::ExtendedFormat }
+
+    it { format.should == "#{time.iso8601} [ INFO] #{$$} #{Socket.gethostname} : Hello World!" }
+  end
+
+end

data/spec/yell_spec.rb

@@ -1,17 +1,24 @@
 require 'spec_helper'
 
 describe Yell do
+  subject { Yell.new }
 
-  describe "a new Yell instance" do
-    let( :logger ) { Yell.new }
+  it { should be_kind_of Yell::Logger }
 
-    it "should return a Yell::Logger" do
-      logger.should be_kind_of( Yell::Logger )
-    end
+  it "should raise NoSuchAdapter when adapter cant be loaded" do
+    lambda { Yell.new :unknownadapter }.should raise_error( Yell::NoSuchAdapter )
+  end
+
+  context :level do
+    subject { Yell.level }
+
+    it { should be_kind_of Yell::Level }
+  end
+
+  context :format do
+    subject { Yell.format( "%m" ) }
 
-    it "should raise NoSuchAdapter when adapter cant be loaded" do
-      lambda { Yell.new :unknownadapter }.should raise_error( Yell::NoSuchAdapter )
-    end
+    it { should be_kind_of Yell::Formatter }
   end
 
 end

data/yell.gemspec

@@ -18,4 +18,6 @@ Gem::Specification.new do |s|
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
+
+  s.add_development_dependency "rr"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yell
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,19 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-22 00:00:00.000000000 Z
-dependencies: []
+date: 2012-03-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rr
+  requirement: &70253484861760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70253484861760
 description: An easy to use logging library to log into files and any other self-defined
   adapters
 email: 
@@ -19,6 +30,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -43,8 +55,9 @@ files:
 - lib/yell/level.rb
 - lib/yell/logger.rb
 - lib/yell/version.rb
-- spec/spec.opts
 - spec/spec_helper.rb
+- spec/yell/event_spec.rb
+- spec/yell/formatter_spec.rb
 - spec/yell_spec.rb
 - yell.gemspec
 homepage: http://rubygems.org/gems/yell
@@ -72,7 +85,8 @@ signing_key:
 specification_version: 3
 summary: Yell - Your Extensible Logging Library
 test_files:
-- spec/spec.opts
 - spec/spec_helper.rb
+- spec/yell/event_spec.rb
+- spec/yell/formatter_spec.rb
 - spec/yell_spec.rb
 has_rdoc: 

data/spec/spec.opts

@@ -1,3 +0,0 @@
---colour
---format progress
---backtrace