yell 0.3.0 → 0.3.1

data/README.md

@@ -36,14 +36,14 @@ Alternatively, you may define `ENV['YELL_ENV']` to set the filename. If neither
 `log` directory exists, Yell will place the file there (only if you have not passed
 a filename explicitly.
 
-Naturally, if you pass a `:filename` to Yell:
+Naturally, you can pass a `:filename` to Yell:
 
 ```ruby
 logger = Yell.new 'yell.log'
 ```
 
-Please refer to the wiki for further usage examples:  
-https://github.com/rudionrails/yell/wiki/
+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/examples/001-basic-usage.rb

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+
+require File.dirname(__FILE__) + '/../lib/yell'
+
+puts <<-EOS
+
+# On the basics, Yell works just like any other logging library. 
+#
+# However, it enriches your log messages to make it more readable. By default, 
+# it will format the given message as follows:
+
+logger = Yell.new STDOUT
+logger.info "Hello World!"
+
+#=> "2012-02-29T09:30:00+01:00 [ INFO] 65784 : Hello World!"
+#    ^                         ^       ^       ^
+#    ISO8601 Timestamp         Level   Pid     Message
+
+
+EOS
+
+puts "=== actual example ==="
+logger = Yell.new STDOUT
+logger.info "Hello World!"

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

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+
+require File.dirname(__FILE__) + '/../lib/yell'
+
+puts <<-EOS
+
+# Like many other logging libraries, Yell allows you to define from which level 
+# onwards you want to write your log message. 
+
+logger = Yell.new STDOUT, :level => :info
+
+logger.debug "This is a :debug message"
+#=> nil 
+
+logger.info "This is a :info message"
+#=> "2012-02-29T09:30:00+01:00 [ INFO] 65784 : This is a :info message"
+
+
+EOS
+
+puts "=== actual example ==="
+logger = Yell.new STDOUT, :level => :info
+
+logger.debug "This is a :debug message"
+logger.info "This is a :info message"

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

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+
+require File.dirname(__FILE__) + '/../lib/yell'
+
+puts <<-EOS
+
+# The Yell::Level parser allows you to exactly specify on which levels to log, 
+# ignoring all the others. For instance: If we want to only log at the :debug 
+# and :warn levels we simply providing an array:
+
+logger = Yell.new STDOUT, :level => [:debug, :warn]
+
+[:debug, :info, :warn, :error, :fatal].each do |level| 
+  logger.send( level, level )
+end
+#=> "2012-02-29T09:30:00+01:00 [DEBUG] 65784 : debug"
+#=> "2012-02-29T09:30:00+01:00 [ WARN] 65784 : warn"
+
+
+EOS
+
+puts "=== actual example ==="
+logger = Yell.new STDOUT, :level => [:debug, :warn]
+
+[:debug, :info, :warn, :error, :fatal].each do |level| 
+  logger.send( level, level )
+end
+

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

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+
+require File.dirname(__FILE__) + '/../lib/yell'
+
+puts <<-EOS
+
+# Additionally to writing only on specific levels, you may pass a range to 
+# the :level option:
+
+logger = Yell.new STDOUT, :level => (:debug..:warn)
+
+[:debug, :info, :warn, :error, :fatal].each do |level| 
+  logger.send( level, level )
+end
+#=> "2012-02-29T09:30:00+01:00 [DEBUG] 65784 : debug"
+#=> "2012-02-29T09:30:00+01:00 [ INFO] 65784 : info"
+#=> "2012-02-29T09:30:00+01:00 [ WARN] 65784 : warn"
+
+
+EOS
+
+puts "=== actuale example ==="
+logger = Yell.new STDOUT, :level => (:debug..:warn)
+
+[:debug, :info, :warn, :error, :fatal].each do |level| 
+  logger.send( level, level )
+end
+

data/examples/003.1-formatting-DefaultFormat.rb

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+
+require File.dirname(__FILE__) + '/../lib/yell'
+
+puts <<-EOS
+
+# The default formatting string looks like: %d [%5L] %p : %m and is used when 
+# nothing else is defined.
+
+logger = Yell.new STDOUT, :format => Yell::DefaultFormat
+logger.info "Hello World!"
+#=> "2012-02-29T09:30:00+01:00 [ INFO] 65784 : Hello World!"
+#    ^                         ^       ^       ^
+#    ISO8601 Timestamp         Level   Pid     Message
+
+
+EOS
+
+puts "=== actuale example ==="
+logger = Yell.new STDOUT, :format => Yell::DefaultFormat
+logger.info "Hello World!"
+

data/examples/003.2-formatting-BasicFormat.rb

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+
+require File.dirname(__FILE__) + '/../lib/yell'
+
+puts <<-EOS
+
+# The basic formating string looks like: %l, %d: %m.
+
+logger = Yell.new STDOUT, :format => Yell::BasicFormat
+logger.info "Hello World!"
+#=> "I, 2012-02-29T09:30:00+01:00 : Hello World!"
+#    ^  ^                          ^
+#    ^  ISO8601 Timestamp          Message
+#    Level (short)
+
+
+EOS
+
+puts "=== actuale example ==="
+logger = Yell.new STDOUT, :format => Yell::BasicFormat
+logger.info "Hello World!"
+

data/examples/003.3-formatting-ExtendedFormat.rb

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+
+require File.dirname(__FILE__) + '/../lib/yell'
+
+puts <<-EOS
+
+# The extended formatting string looks like: %d [%5L] %p %h : %m.
+
+logger = Yell.new STDOUT, :format => Yell::ExtendedFormat
+logger.info "Hello World!"
+#=> "2012-02-29T09:30:00+01:00 [ INFO] 65784 localhost : Hello World!"
+#    ^                          ^      ^     ^           ^
+#    ISO8601 Timestamp          Level  Pid   Hostname    Message
+
+
+EOS
+
+puts "=== actuale example ==="
+logger = Yell.new STDOUT, :format => Yell::ExtendedFormat
+logger.info "Hello World!"
+

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

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+
+require File.dirname(__FILE__) + '/../lib/yell'
+
+puts <<-EOS
+
+The extended formatting string looks like: %d [%5L] %p %h : %m.
+
+logger = Yell.new STDOUT, :format => "[%f:%n in `%M'] %m"
+logger.info "Hello World!"
+#=> [003.4-formatting-on-your-own.rb:20 in `<main>'] Hello World!
+#    ^                               ^      ^        ^
+#    filename                        line   method   message
+
+
+EOS
+
+puts "=== actuale example ==="
+logger = Yell.new STDOUT, :format => "[%f:%n in `%M'] %m"
+logger.info "Hello World!"
+

data/lib/yell.rb

@@ -36,7 +36,6 @@ require 'yell/adapters'
 require 'yell/logger'
 
 module Yell #:nodoc:
-  # The possible log levels
   Severities = [ 'DEBUG', 'INFO', 'WARN', 'ERROR', 'FATAL', 'UNKNOWN' ]
 
   class << self

data/lib/yell/event.rb

@@ -1,7 +1,7 @@
 module Yell #:nodoc:
 
   class Event
-    CallerRegexp = /^(.+?):(\d+)(?::in `(.*)')?/ #:nodoc:
+    CallerRegexp = /^(.+?):(\d+)(?::in `(.*)')?/
 
     # Accessor to the log level
     attr_reader :level

data/lib/yell/formatter.rb

@@ -42,7 +42,7 @@ module Yell #:nodoc:
   ExtendedFormat  = "%d [%5L] %p %h : %m"
 
 
-  def format( pattern, date_pattern ) #:nodoc:
+  def self.format( pattern, date_pattern )
     Yell::Formatter.new( pattern, date_pattern )
   end
 
@@ -57,7 +57,7 @@ module Yell #:nodoc:
       "L" => "event.level",                   # Level, e.g. 'INFO', 'WARN'
       "d" => "date(event)",                   # ISO8601 Timestamp
       "p" => "Process.pid",                   # PID
-      "h" => "Socket.gethostname rescue nil", # Hostname
+      "h" => "hostname",                      # Hostname
       "F" => "event.file",                    # Path with filename where the logger was called
       "f" => "File.basename(event.file)",     # Filename where the loger was called
       "M" => "event.method",                  # Method name where the logger was called
@@ -105,6 +105,12 @@ module Yell #:nodoc:
       @date_pattern ? event.time.strftime( @date_pattern ) : event.time.iso8601
     end
 
+    def hostname
+      require 'socket' unless defined? Socket
+
+      Socket.gethostname rescue nil
+    end
+
   end
 end
 

data/lib/yell/level.rb

@@ -2,7 +2,7 @@
 
 module Yell #:nodoc:
 
-  def level( val = nil ) #:nodoc:
+  def self.level( val = nil )
     Yell::Level.new( val )
   end
 

data/lib/yell/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yell
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
   prerelease: 
 platform: ruby
 authors:
@@ -23,6 +23,14 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- examples/001-basic-usage.rb
+- examples/002.1-log-level-basics.rb
+- examples/002.2-log-level-on-certain-severities-only.rb
+- examples/002.3-log-level-within-range.rb
+- examples/003.1-formatting-DefaultFormat.rb
+- examples/003.2-formatting-BasicFormat.rb
+- examples/003.3-formatting-ExtendedFormat.rb
+- examples/003.4-formatting-on-your-own.rb
 - lib/yell.rb
 - lib/yell/adapters.rb
 - lib/yell/adapters/.file.rb.swp