yell 1.3.0 → 1.4.0

data/lib/yell/adapters/file.rb

@@ -7,16 +7,21 @@ module Yell #:nodoc:
     # for logging into files.
     class File < Yell::Adapters::Io
 
-      setup do |options|
+      private
+
+      # @overload setup!( options )
+      def setup!( options )
         @filename = ::File.expand_path options.fetch(:filename, default_filename)
-      end
 
-      open do
-        @stream = ::File.open( @filename, ::File::WRONLY|::File::APPEND|::File::CREAT )
+        super
       end
 
+      # @overload open!
+      def open!
+        @stream = ::File.open( @filename, ::File::WRONLY|::File::APPEND|::File::CREAT )
 
-      private
+        super
+      end
 
       def default_filename #:nodoc:
         logdir = ::File.expand_path("log")

data/lib/yell/adapters/io.rb

@@ -4,57 +4,19 @@ module Yell #:nodoc:
   module Adapters #:nodoc:
 
     class Io < Yell::Adapters::Base
-      include Yell::Formatter::Helpers
+      include Yell::Helpers::Formatter
 
       # The possible unix log colors
-      Colors = {
-        0   => "\e[32;1m",  # green;bold
-        # 1   => "\e[0m",     # white
-        2   => "\e[33;1m",  # yello;bold
-        3   => "\e[31;1m",  # red;bold
-        4   => "\e[35;1m",  # magenta;bold
-        5   => "\e[36m",    # cyan
-        -1  => "\e[0m"      # NONE
+      TTYColors = {
+        0   => "\033[1;32m",  # green
+        1   => "\033[0m",     # normal
+        2   => "\033[1;33m",  # yellow
+        3   => "\033[1;31m",  # red
+        4   => "\033[1;35m",  # magenta
+        5   => "\033[1;36m",  # cyan
+        -1  => "\033[0m"      # normal
       }
 
-      setup do |options|
-        @stream = nil
-
-        # colorize the log output (default: false)
-        self.colors = options.fetch(:colors, false)
-
-        # format the log message (default: nil)
-        self.format = options.fetch(:format, nil)
-
-        # sync immediately to IO (default: true)
-        self.sync = options.fetch(:sync, true)
-      end
-
-      write do |event|
-        message = format.format(event)
-
-        # colorize if applicable
-        if colors and color = Colors[event.level]
-          message = color + message + Colors[-1]
-        end
-
-        # add new line if there is none
-        message << "\n" unless message[-1] == ?\n
-
-        stream.syswrite( message )
-      end
-
-      open do
-        @stream.sync = self.sync if @stream.respond_to? :sync
-        @stream.flush            if @stream.respond_to? :flush
-      end
-
-      close do
-        @stream.close if @stream.respond_to? :close
-        @stream = nil
-      end
-
-
       # Sets the “sync mode” to true or false.
       #
       # When true (default), every log event is immediately written to the file. 
@@ -79,6 +41,48 @@ module Yell #:nodoc:
 
       private
 
+      # @overload setup!( options )
+      def setup!( options )
+        @stream = nil
+
+        self.colors = options.fetch(:colors, false)
+        self.format = options.fetch(:format, nil)
+        self.sync = options.fetch(:sync, true)
+
+        super
+      end
+
+      # @overload write!( event )
+      def write!( event )
+        message = format.format(event)
+
+        # colorize if applicable
+        if colors and color = TTYColors[event.level]
+          message = color + message + TTYColors[-1]
+        end
+
+        message << "\n" unless message[-1] == ?\n
+        stream.syswrite( message )
+
+        super
+      end
+
+      # @overload open!
+      def open!
+        @stream.sync = self.sync if @stream.respond_to? :sync
+        @stream.flush            if @stream.respond_to? :flush
+
+        super
+      end
+
+      # @overload close!
+      def close!
+        @stream.close if @stream.respond_to? :close
+        @stream = nil
+
+        super
+      end
+
       # The IO stream
       #
       # Adapter classes should provide their own implementation 
@@ -87,7 +91,7 @@ module Yell #:nodoc:
         synchronize { open! if @stream.nil?; @stream }
       end
 
-      # @override
+      # @overload inspectables
       def inspectables
         super.concat [:format, :colors, :sync]
       end

data/lib/yell/adapters/streams.rb

@@ -5,16 +5,24 @@ module Yell #:nodoc:
 
     class Stdout < Yell::Adapters::Io
 
-      open do
+      private
+
+      # @overload open!
+      def open!
         @stream = $stdout.clone
+        super
       end
 
     end
 
     class Stderr < Yell::Adapters::Io
 
-      open do
+      private
+
+      # @overload open!
+      def open!
         @stream = $stderr.clone
+        super
       end
 
     end

data/lib/yell/configuration.rb

@@ -13,7 +13,7 @@ module Yell #:nodoc:
       yaml = YAML.load( ERB.new(File.read(file)).result )
 
       # in case we have ActiveSupport
-      if yaml.respond_to?( :with_indifference_access )
+      if yaml.respond_to?(:with_indifference_access)
         yaml = yaml.with_indifferent_access
       end
 

data/lib/yell/event.rb

@@ -65,23 +65,23 @@ module Yell #:nodoc:
 
     # Accessor to filename the log event occured
     def file
-      @file || (_caller!; @file)
+      @file || (backtrace!; @file)
     end
 
     # Accessor to the line the log event occured
     def line
-      @line || (_caller!; @line)
+      @line || (backtrace!; @line)
     end
 
     # Accessor to the method the log event occured
     def method
-      @method || (_caller!; @method)
+      @method || (backtrace!; @method)
     end
 
 
     private
 
-    def _caller!
+    def backtrace!
       if m = CallerRegexp.match(@caller)
         @file, @line, @method = m[1..-1]
       else

data/lib/yell/formatter.rb

@@ -1,5 +1,4 @@
 # encoding: utf-8
-
 require 'time'
 
 module Yell #:nodoc:
@@ -46,21 +45,8 @@ module Yell #:nodoc:
 
   # The +Formatter+ provides a handle to configure your log message style.
   class Formatter
-    module Helpers
-      # Accessor to the format
-      attr_reader :format
-
-      # Set the format for your message.
-      def format=( pattern )
-        @format = case pattern
-          when Yell::Formatter then pattern
-          when false then Yell::Formatter.new( Yell::NoFormat )
-          else Yell::Formatter.new( *pattern )
-        end
-      end
-    end
 
-    PatternTable = {
+    Table = {
       "m" => "message(*event.messages)",   # Message
       "l" => "level(event.level)[0,1]",    # Level (short), e.g.'I', 'W'
       "L" => "level(event.level)",         # Level, e.g. 'INFO', 'WARN'
@@ -75,7 +61,7 @@ module Yell #:nodoc:
       "n" => "event.line"                  # Line where the logger was called
     }
 
-    PatternRegexp = /([^%]*)(%\d*)?(#{PatternTable.keys.join('|')})?(.*)/
+    Matcher = /([^%]*)(%\d*)?(#{Table.keys.join('|')})?(.*)/
 
 
     # Initializes a new +Yell::Formatter+.
@@ -91,7 +77,7 @@ module Yell #:nodoc:
       define_format_method!
     end
 
-    # Get a pretty string representation of the formatter, including the pattern and date pattern.
+    # Get a pretty string
     def inspect
       "#<#{self.class.name} pattern: #{@pattern.inspect}, date_pattern: #{@date_pattern.inspect}>"
     end
@@ -117,26 +103,27 @@ module Yell #:nodoc:
       buff, args, _pattern = "", [], @pattern.dup
 
       while true
-        match = PatternRegexp.match( _pattern )
+        match = Matcher.match(_pattern)
 
         buff << match[1] unless match[1].empty?
         break if match[2].nil?
 
         buff << match[2] + 's'
-        args << PatternTable[ match[3] ]
+        args << Table[ match[3] ]
 
         _pattern = match[4]
       end
 
-      instance_eval %-
+      instance_eval <<-EOS, __FILE__, __LINE__
         def format( event )
-          sprintf( "#{buff}", #{args.join(',')} )
+          sprintf("#{buff}", #{args.join(',')})
         end
-      -
+      EOS
     end
 
     # The iso8601 implementation of the standard Time library is more than
-    # twice as slow than using strftime. So, we just implement it ourselves.
+    # twice as slow compared to using strftime. So, we just implement
+    # it ourselves --R
     def iso8601( t )
       zone = if t.utc?
         "-00:00"
@@ -163,8 +150,7 @@ module Yell #:nodoc:
         m.map { |k,v| "#{k}: #{v}" }.join( ", " )
       when Exception
         backtrace = m.backtrace ? "\n\t#{m.backtrace.join("\n\t")}" : ""
-
-        "%s: %s%s" % [m.class, m.message, backtrace]
+        sprintf("%s: %s%s", m.class, m.message, backtrace)
       else
         m
       end

data/lib/yell/helpers/adapters.rb

@@ -0,0 +1,51 @@
+# encoding: utf-8
+module Yell #:nodoc:
+  module Helpers #:nodoc:
+    module Adapters #:nodoc:
+
+      # Define an adapter to be used for logging.
+      #
+      # @example Standard adapter
+      #   adapter :file
+      #
+      # @example Standard adapter with filename
+      #   adapter :file, 'development.log'
+      #
+      #   # Alternative notation for filename in options
+      #   adapter :file, :filename => 'developent.log'
+      #
+      # @example Standard adapter with filename and additional options
+      #   adapter :file, 'development.log', :level => :warn
+      #
+      # @example Set the adapter directly from an adapter instance
+      #   adapter( Yell::Adapter::File.new )
+      #
+      # @param [Symbol] type The type of the adapter, may be `:file` or `:datefile` (default `:file`)
+      # @return [Yell::Adapter] The instance
+      # @raise [Yell::NoSuchAdapter] Will be thrown when the adapter is not defined
+      def adapter( type = :file, *args, &block )
+        options = [@options, *args].inject( Hash.new ) do |h, c|
+          h.merge( [String, Pathname].include?(c.class) ? {:filename => c} : c  )
+        end
+
+        @adapters << Yell::Adapters.new(type, options, &block)
+      end
+
+      # @private
+      def adapters
+        @adapters
+      end
+
+
+      private
+
+      def reset!
+        @adapters = []
+
+        super
+      end
+
+    end
+  end
+end
+

data/lib/yell/helpers/base.rb

@@ -0,0 +1,19 @@
+# encoding: utf-8
+module Yell #:nodoc:
+  module Helpers #:nodoc:
+    module Base #:nodoc:
+
+      private
+
+      # stub
+      def reset!
+      end
+
+      def inspectables
+        []
+      end
+
+    end
+  end
+end
+

data/lib/yell/helpers/formatter.rb

@@ -0,0 +1,31 @@
+# encoding: utf-8
+module Yell #:nodoc:
+  module Helpers #:nodoc:
+    module Formatter #:nodoc:
+
+      # Set the format for your message.
+      def format=( pattern )
+        @formatter = case pattern
+        when Yell::Formatter then pattern
+        when false then Yell::Formatter.new(Yell::NoFormat)
+        else Yell::Formatter.new(*pattern)
+        end
+      end
+
+      # @private
+      def format
+        @formatter
+      end
+
+      private
+
+      def reset!
+        @formatter = Yell::Formatter.new
+
+        super
+      end
+
+    end
+  end
+end
+

data/lib/yell/helpers/level.rb

@@ -0,0 +1,36 @@
+# encoding: utf-8
+module Yell #:nodoc:
+  module Helpers #:nodoc:
+    module Level
+
+      # Set the minimum log level.
+      #
+      # @example Set the level to :warn
+      #   level = :warn
+      #
+      # @param [String, Symbol, Integer] severity The minimum log level
+      def level=( severity )
+        @level.set(severity)
+      end
+
+      # @private
+      def level
+        @level
+      end
+
+      private
+
+      def reset!
+        @level = Yell::Level.new
+
+        super
+      end
+
+      def inspectables
+        [:level] | super
+      end
+
+    end
+  end
+end
+