yell 1.1.0 → 1.2.0

data/lib/yell/adapters/base.rb

@@ -64,11 +64,21 @@ module Yell #:nodoc:
           compile!( :write!, &block )
         end
 
+        # Define your open method with this helper.
+        #
+        # @example Open a file handle
+        #   open do
+        #     @stream = ::File.open( 'test.log', ::File::WRONLY|::File::APPEND|::File::CREAT )
+        #   end
+        def open( &block )
+          compile!( :open!, &block )
+        end
+
         # Define your close method with this helper.
         #
         # @example Closing a file handle
         #   close do
-        #     @file_handle.close
+        #     @stream.close
         #   end
         def close( &block )
           compile!( :close!, &block )
@@ -152,6 +162,17 @@ module Yell #:nodoc:
         close!
       end
 
+      # Get a pretty string representation of the adapter, including
+      # the inspectable attributes.
+      #
+      # @example Inspect the formatter.
+      #   adapter.inspect
+      #
+      # @return [String] The inspection string.
+      def inspect
+        inspection = inspectables.inject( [] ) { |r, c| r << "#{c}: #{send(c).inspect}" }
+        "#<#{self.class.name} #{inspection * ', '}>"
+      end
 
       private
 
@@ -171,6 +192,14 @@ module Yell #:nodoc:
         # Not implemented
       end
 
+      # Perform the actual open.
+      #
+      # Adapter classes should provide their own implementation 
+      # of this method.
+      def open!
+        # Not implemented
+      end
+
       # Perform the actual close.
       #
       # Adapter classes should provide their own implementation 
@@ -191,6 +220,13 @@ module Yell #:nodoc:
         @level.nil? || @level.at?( event.level )
       end
 
+      # Get an array of inspected attributes for the adapter.
+      #
+      # @return [ String ] An array of pretty printed field values.
+      def inspectables
+        [ :level ]
+      end
+
     end
 
   end

data/lib/yell/adapters/datefile.rb

@@ -174,6 +174,11 @@ module Yell #:nodoc:
         end
       end
 
+      # @override
+      def inspectables
+        super.concat [:date_pattern, :header, :keep, :symlink ]
+      end
+
     end
 
     register( :datefile, Yell::Adapters::Datefile )

data/lib/yell/adapters/file.rb

@@ -9,32 +9,14 @@ module Yell #:nodoc:
 
       setup do |options|
         @filename = ::File.expand_path options.fetch(:filename, default_filename)
-
-        # sync immediately to IO (or not)
-        self.sync = options.fetch(:sync, true)
       end
 
-
-      # Sets the “sync mode” to true or false.
-      #
-      # When true (default), every log event is immediately written to the file. 
-      # When false, the log event is buffered internally.
-      attr_accessor :sync
-
-
-      private
-
-      # @overload Lazily open the file handle
-      def stream
-        synchronize { @stream or open! }
+      open do
+        @stream = ::File.open( @filename, ::File::WRONLY|::File::APPEND|::File::CREAT )
       end
 
-      def open!
-        @stream = ::File.open( @filename, ::File::WRONLY|::File::APPEND|::File::CREAT )
-        @stream.sync = sync
 
-        @stream
-      end
+      private
 
       def default_filename #:nodoc:
         logdir = ::File.expand_path("log")

data/lib/yell/adapters/io.rb

@@ -20,8 +20,14 @@ module Yell #:nodoc:
       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|
@@ -35,7 +41,12 @@ module Yell #:nodoc:
         # add new line if there is none
         message << "\n" unless message[-1] == ?\n
 
-        stream.write( message )
+        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
@@ -44,6 +55,12 @@ module Yell #:nodoc:
       end
 
 
+      # Sets the “sync mode” to true or false.
+      #
+      # When true (default), every log event is immediately written to the file. 
+      # When false, the log event is buffered internally.
+      attr_accessor :sync
+
       # Sets colored output on or off (default off)
       #
       # @example Enable colors
@@ -67,8 +84,14 @@ module Yell #:nodoc:
       # Adapter classes should provide their own implementation 
       # of this method.
       def stream
-        raise 'Not implemented'
+        synchronize { open! if @stream.nil?; @stream }
+      end
+
+      # @override
+      def inspectables
+        super.concat [:format, :colors, :sync]
       end
+
     end
 
   end

data/lib/yell/adapters/streams.rb

@@ -5,22 +5,18 @@ module Yell #:nodoc:
 
     class Stdout < Yell::Adapters::Io
 
-      private
-
-      # @overload Lazily open the STDOUT stream
-      def stream
-        @stream ||= $stdout.clone
+      open do
+        @stream = $stdout.clone
       end
+
     end
 
     class Stderr < Yell::Adapters::Io
 
-      private
-
-      # @overload Lazily open the STDERR stream
-      def stream
-        @stream ||= $stderr.clone
+      open do
+        @stream = $stderr.clone
       end
+
     end
 
     register( :stdout, Yell::Adapters::Stdout )

data/lib/yell/configuration.rb

@@ -1,5 +1,6 @@
 # encoding: utf-8
 
+require 'erb'
 require 'yaml'
 
 module Yell #:nodoc:
@@ -9,7 +10,11 @@ module Yell #:nodoc:
   class Configuration
 
     def self.load!( file )
-      YAML.load_file( file )[ Yell.env ] || {}
+      # parse through ERB
+      yaml = ERB.new(File.read(file)).result
+
+      # parse through YAML
+      YAML.load(yaml)[Yell.env] || {}
     end
 
   end

data/lib/yell/event.rb

@@ -18,6 +18,7 @@ module Yell #:nodoc:
     # Prefetch those values (no need to do that on every new instance)
     @@hostname  = Socket.gethostname rescue nil
     @@pid       = Process.pid
+    @@progname  = $0
 
     # Accessor to the log level
     attr_reader :level
@@ -47,16 +48,21 @@ module Yell #:nodoc:
       @method = nil
     end
 
-    # Accessor to the pid
+    # Accessor to the hostname
     def hostname
       @@hostname
     end
 
-    # Accessor to the hostname
+    # Accessor to the pid
     def pid
       @@pid
     end
 
+    # Accessor to the progname
+    def progname
+      @@progname
+    end
+
     # Accessor to filename the log event occured
     def file
       _caller! if @file.nil?

data/lib/yell/formatter.rb

@@ -67,6 +67,7 @@ module Yell #:nodoc:
       "d" => "date(event.time)",           # ISO8601 Timestamp
       "h" => "event.hostname",             # Hostname
       "p" => "event.pid",                  # PID
+      "P" => "event.progname",             # Progname
       "t" => "event.thread_id",            # Thread ID
       "F" => "event.file",                 # Path with filename where the logger was called
       "f" => "File.basename(event.file)",  # Filename where the loger was called
@@ -84,11 +85,21 @@ module Yell #:nodoc:
     # message formatting.
     def initialize( pattern = nil, date_pattern = nil )
       @pattern      = pattern || Yell::DefaultFormat
-      @date_pattern = date_pattern
+      @date_pattern = date_pattern || :iso8601
 
       define!
     end
 
+    # Get a pretty string representation of the formatter, including
+    # the pattern and date pattern.
+    #
+    # @example Inspect the formatter.
+    #   formatter.inspect
+    #
+    # @return [String] The inspection string.
+    def inspect
+      "#<#{self.class.name} pattern: #{@pattern.inspect}, date_pattern: #{@date_pattern.inspect}>"
+    end
 
     private
 
@@ -120,7 +131,10 @@ module Yell #:nodoc:
     end
 
     def date( t )
-      @date_pattern ? t.strftime( @date_pattern ) : t.iso8601
+      case @date_pattern
+      when String then t.strftime( @date_pattern )
+      else t.iso8601
+      end
     end
 
     def message( *messages )
@@ -129,14 +143,14 @@ module Yell #:nodoc:
 
     def to_message( m )
       case m
-        when Hash
-          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]
-        else
-          m
+      when Hash
+        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]
+      else
+        m
       end
     end
 

data/lib/yell/level.rb

@@ -138,6 +138,22 @@ module Yell #:nodoc:
     end
     alias :to_int :to_i
 
+    # Get a pretty string representation of the level, including the
+    # severities.
+    #
+    # @example Inspect the level.
+    #   level.inspect
+    #
+    # @return [String] The inspection string.
+    def inspect
+      severities = Yell::Severities.each.with_index.inject( [] ) do |r, (l, i)|
+        r << l if @severities[i]
+        r
+      end
+
+      "#<#{self.class.name} severities: #{severities * ', '}>"
+    end
+
 
     private
 

data/lib/yell/logger.rb

@@ -124,6 +124,16 @@ module Yell #:nodoc:
       EOS
     end
 
+    # Get a pretty string representation of the logger.
+    #
+    # @example Inspect the logger
+    #   logger.inspect
+    #
+    # @return [String] The inspection string.
+    def inspect
+      inspection = inspectables.inject( [] ) { |r, c| r << "#{c}: #{send(c).inspect}" }
+      "#<#{self.class.name} #{inspection * ', '}, adapters: #{@adapters.map(&:inspect) * ', '}>"
+    end
 
     private
 
@@ -149,6 +159,13 @@ module Yell #:nodoc:
       @adapters.each { |a| a.write(event) }
     end
 
+    # Get an array of inspected attributes for the adapter.
+    #
+    # @return [ String ] An array of pretty printed field values.
+    def inspectables
+      [ :name, :level ]
+    end
+
   end
 end
 

data/lib/yell/version.rb

@@ -1,7 +1,7 @@
 # encoding: utf-8
 
 module Yell #:nodoc:
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 
 end
 

data/spec/spec_helper.rb

@@ -14,10 +14,10 @@ RSpec.configure do |config|
 
   config.before do
     Yell::Repository.loggers.clear
+    Dir[ fixture_path + "/*.log" ].each { |f| File.delete f }
   end
 
   config.after do
-    Dir[ fixture_path + "/*.log" ].each { |f| File.delete f }
   end
 
   private

data/spec/yell/adapters/io_spec.rb

@@ -40,12 +40,6 @@ describe Yell::Adapters::Io do
     end
   end
 
-  context :stream do
-    it "should raise" do
-      lambda { Yell::Adapters::Io.new.send :stream }.should raise_error("Not implemented" )
-    end
-  end
-
   context :write do
     let( :event ) { Yell::Event.new(1, "Hello World") }
     let( :adapter ) { Yell::Adapters::Io.new }
@@ -63,7 +57,7 @@ describe Yell::Adapters::Io do
 
     it "should print formatted message to stream" do
       formatted = Yell::Formatter.new.format( event )
-      mock( stream ).write( formatted << "\n" )
+      mock( stream ).syswrite( formatted << "\n" )
 
       adapter.write( event )
     end

data/spec/yell/event_spec.rb

@@ -70,4 +70,8 @@ describe Yell::Event do
     it { should == Process.pid }
   end
 
+  context :progname do
+    subject { event.progname }
+    it { should == $0 }
+  end
 end

data/spec/yell/formatter_spec.rb

@@ -14,37 +14,41 @@ describe Yell::Formatter do
 
   context "%m" do
     subject { "%m" }
-    it { format.should == "Hello World!" }
+    it { format.should == event.messages.join(' ') }
   end
 
   context "%l" do
     subject { "%l" }
-    it { format.should == "I" }
+    it { format.should == Yell::Severities[event.level][0,1] }
   end
 
   context "%L" do
     subject { "%L" }
-    it { format.should == "INFO" }
+    it { format.should == Yell::Severities[event.level] }
   end
 
   context "%d" do
     subject { "%d" }
-    it { format.should == time.iso8601 }
+    it { format.should == event.time.iso8601 }
   end
 
   context "%p" do
     subject { "%p" }
-    it { format.should == Process.pid.to_s }
+    it { format.should == event.pid.to_s }
   end
 
+  context "%P" do
+    subject { "%P" }
+    it { format.should == event.progname }
+  end
   context "%t" do
     subject { "%t" }
-    it { format.should == Thread.current.object_id.to_s }
+    it { format.should == event.thread_id.to_s }
   end
 
   context "%h" do
     subject { "%h" }
-    it { format.should == Socket.gethostname }
+    it { format.should == event.hostname }
   end
 
   context "caller" do

data/spec/yell/logger_spec.rb

@@ -148,8 +148,8 @@ describe Yell::Logger do
       factory = LoggerFactory.new
       factory.logger = logger
 
-      mock( adapter.send(:stream) ).write( "#{__FILE__}, 7: foo\n" )
-      mock( adapter.send(:stream) ).write( "#{__FILE__}, 11: bar\n" )
+      mock( adapter.send(:stream) ).syswrite( "#{__FILE__}, 7: foo\n" )
+      mock( adapter.send(:stream) ).syswrite( "#{__FILE__}, 11: bar\n" )
 
       factory.foo
       factory.bar

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yell
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-03 00:00:00.000000000 Z
+date: 2012-10-30 00:00:00.000000000 Z
 dependencies: []
 description: Yell - Your Extensible Logging Library. Define multiple adapters, various
   log level combinations or message formatting options like you've never done before
@@ -111,4 +111,3 @@ test_files:
 - spec/yell/logger_spec.rb
 - spec/yell/repository_spec.rb
 - spec/yell_spec.rb
-has_rdoc: