yell 1.4.0 → 2.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f9ecfe3dde614dc7aaa4d58f6617323dfd22aa6b
-  data.tar.gz: a16b4a0ed5c83a1d722570a7d4e92eb0886856ff
+  metadata.gz: 9aae01c5c4e5cf4acfc08f3579266c32410184de
+  data.tar.gz: 54dc91a4941d54b7f4175ef2712145f668d48596
 SHA512:
-  metadata.gz: dbfd34addbe7e79d5a0264f927f64bd9808a1cc09dbe4e56fda1b09677e66cdcb20c527e86a75cbb0954bc9f9f3cfd4ef5b67b052c1d19527888fe856d43f116
-  data.tar.gz: 438d38c8cdd63f08eb32d991eacb04eb1aa1b3bd7020a017d44b954d80bc268c69132ddcc36bdd967c809a57804abfe14656d90912ab2833d878808302e936aa
+  metadata.gz: 8626bd806d18be33a32b60ca0c67be823592a75be9fa8c2f98ced0fa2b01e9af4efc959c120753a4eb68a15181ed7ba9748476c96601a3ad53f718c6b6b353af
+  data.tar.gz: 70e688475cadc7ea3d7a6add37a11a70f3214056e4d377a70c447c01824a94bb29ab23a782dbc145ce4dd3e555719bf9bf27ea4a451d2caec223be5d269eb7b2

data/.gitignore

@@ -2,12 +2,16 @@ pkg/*
 *.gem
 .bundle
 .idea
-
+.vscode
+vendor/
 # bundler
-Gemfile.lock
+Gemfile.*lock
 
 # vim
 *.swp
 
 # coverage
 /coverage
+
+# rspec
+/spec/examples/txt

data/.ruby-version

@@ -0,0 +1 @@
+2.3.1

data/.travis.yml

@@ -1,17 +1,20 @@
 language: ruby
+before_install: gem install bundler
+script: "bundle exec rspec"
 
-script: "rspec"
-
-rvm:
-  - 1.8.7
-  - 1.9.3
-  - 2.0.0
-  - jruby-18mode
-  - jruby-19mode
-  - rbx-18mode
-  - rbx-19mode
-  - ree
+matrix:
+  include:
+    - rvm: ruby-head
+    - rvm: 2.6
+    - rvm: 2.5
+    - rvm: 2.4
+    - rvm: 2.3
+    - rvm: jruby-9.1
+    - rvm: jruby-9.2
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head
 
 notifications:
-  email:
-    - me@rudionrails.com
+  on_success: change
+  on_failure: change

data/Gemfile

@@ -1,17 +1,24 @@
-source "http://rubygems.org"
+# frozen_string_literal: true
+
+source 'http://rubygems.org'
 
 # Specify your gem's dependencies in yell.gemspec
 gemspec
 
 group :development, :test do
-  gem "rake"
+  gem 'rake'
 
-  gem 'rspec-core'
+  gem 'rspec-core', '~> 3'
   gem 'rspec-expectations'
-  gem "rr"
-  gem "timecop"
+  gem 'rspec-its'
+  gem 'rspec-mocks'
 
-  gem 'simplecov', :require => false, :platform => :ruby_20
-  gem 'coveralls', :require => false, :platform => :ruby_20
-end
+  gem 'byebug', platform: :mri
+  gem 'timecop'
 
+  gem 'activesupport', '~> 5'
+
+  gem 'coveralls', require: false
+  gem 'rubocop', require: false
+  gem 'simplecov', require: false
+end

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2011-2013 Rudolf Schmidt
+Copyright (c) 2011-current Rudolf Schmidt
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,9 +1,12 @@
-# Yell [![Gem Version](https://badge.fury.io/rb/yell.png)](http://badge.fury.io/rb/yell) [![Build Status](https://travis-ci.org/rudionrails/yell.png?branch=master)](https://travis-ci.org/rudionrails/yell) [![Code Climate](https://codeclimate.com/github/rudionrails/yell.png)](https://codeclimate.com/github/rudionrails/yell) [![Coverage Status](https://coveralls.io/repos/rudionrails/yell/badge.png?branch=master)](https://coveralls.io/r/rudionrails/yell)
+# Yell [![Gem Version](https://badge.fury.io/rb/yell.svg)](http://badge.fury.io/rb/yell) [![Build Status](https://travis-ci.org/rudionrails/yell.svg?branch=master)](https://travis-ci.org/rudionrails/yell) [![Code Climate](https://codeclimate.com/github/rudionrails/yell.svg)](https://codeclimate.com/github/rudionrails/yell) [![Coverage Status](https://coveralls.io/repos/rudionrails/yell/badge.svg?branch=master)](https://coveralls.io/r/rudionrails/yell)
 
 
 **Yell - Your Extensible Logging Library** is a comprehensive logging replacement for Ruby.
 
-Yell works and is tested with ruby 1.8.7, 1.9.x, 2.0.0, jruby 1.8 and 1.9 mode, rubinius 1.8 and 1.9 as well as ree.
+Yell works and its test suite currently runs on:
+
+- ruby-head, 2.3.1, 2.2.5, 2.2.2, 2.1.0, 2.0.0 
+- jruby-head, jruby-9.1.0.0, jruby-9.0.0.0
 
 If you want to conveniently use Yell with Rails, then head over to [yell-rails](https://github.com/rudionrails/yell-rails). You'll find all the documentation in this repository, though.
 
@@ -189,6 +192,8 @@ logger.debug 'Started GET "/assets/logo.png" for 127.0.0.1 at 2013-06-20 10:18:3
 logger.debug 'Served asset /logo.png - 304 Not Modified (0ms)'
 ```
 
+### Alter log messages with modifiers
+
 
 ## Further Readings
 
@@ -201,7 +206,9 @@ logger.debug 'Served asset /logo.png - 304 Not Modified (0ms)'
 
 ### Additional Adapters
 [Syslog](https://github.com/rudionrails/yell/wiki/additional-adapters-syslog)  
+[syslog-sd](https://github.com/raymond-wells/yell-adapters-syslogsd)  
 [Graylog2 (GELF)](https://github.com/rudionrails/yell/wiki/additional-adapters-gelf)  
+[Fluentd](https://github.com/red5studios/yell-adapters-fluentd)  
 
 
 ### Development
@@ -212,5 +219,5 @@ You can find further examples and additional adapters in the [wiki](https://gith
 or have a look into the examples folder.
 
 
-Copyright © 2011-2013 Rudolf Schmidt, released under the MIT license
+Copyright © 2011-current Rudolf Schmidt, released under the MIT license
 

data/Rakefile

@@ -1,6 +1,4 @@
-$LOAD_PATH.unshift( 'lib' )
-require 'bundler'
-
+require 'bundler/gem_tasks'
 
 # Run stuff in the examples folder
 desc "Run examples"

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

@@ -7,7 +7,7 @@ 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 = Yell.new STDOUT, level: :info
 
 logger.debug "This is a :debug message"
 #=> nil 
@@ -19,7 +19,7 @@ logger.info "This is a :info message"
 EOS
 
 puts "=== actual example ==="
-logger = Yell.new STDOUT, :level => :info
+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

@@ -7,10 +7,11 @@ 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:
+# * %i[] is a built-in for an array of symbols
 
-logger = Yell.new STDOUT, :level => [:debug, :warn]
+logger = Yell.new STDOUT, level: %i[debug warn]
 
-[:debug, :info, :warn, :error, :fatal].each do |level| 
+%i[debug info warn error fatal].each do |level| 
   logger.send( level, level )
 end
 #=> "2012-02-29T09:30:00+01:00 [DEBUG] 65784 : debug"
@@ -20,9 +21,9 @@ end
 EOS
 
 puts "=== actual example ==="
-logger = Yell.new STDOUT, :level => [:debug, :warn]
+logger = Yell.new STDOUT, level: %i[debug warn]
 
-[:debug, :info, :warn, :error, :fatal].each do |level| 
+%i[debug info warn error fatal].each do |level| 
   logger.send( level, level )
 end
 

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

@@ -6,10 +6,12 @@ puts <<-EOS
 
 # Additionally to writing only on specific levels, you may pass a range to 
 # the :level option:
+# * %i[] is a built-in for an array of symbols
 
-logger = Yell.new STDOUT, :level => (:debug..:warn)
 
-[:debug, :info, :warn, :error, :fatal].each do |level| 
+logger = Yell.new STDOUT, level: (:debug..:warn)
+
+%i[debug info warn error fatal].each do |level| 
   logger.send( level, level )
 end
 #=> "2012-02-29T09:30:00+01:00 [DEBUG] 65784 : debug"
@@ -19,10 +21,10 @@ end
 
 EOS
 
-puts "=== actuale example ==="
-logger = Yell.new STDOUT, :level => (:debug..:warn)
+puts "=== actual example ==="
+logger = Yell.new STDOUT, level: (:debug..:warn)
 
-[:debug, :info, :warn, :error, :fatal].each do |level| 
+%i[debug info warn error fatal].each do |level| 
   logger.send( level, level )
 end
 

data/examples/003.1-formatting-DefaultFormat.rb

@@ -7,7 +7,7 @@ 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 = Yell.new STDOUT, format: Yell::DefaultFormat
 logger.info "Hello World!"
 #=> "2012-02-29T09:30:00+01:00 [ INFO] 65784 : Hello World!"
 #    ^                         ^       ^       ^
@@ -16,7 +16,7 @@ logger.info "Hello World!"
 
 EOS
 
-puts "=== actuale example ==="
-logger = Yell.new STDOUT, :format => Yell::DefaultFormat
+puts "=== actual example ==="
+logger = Yell.new STDOUT, format: Yell::DefaultFormat
 logger.info "Hello World!"
 

data/examples/003.2-formatting-BasicFormat.rb

@@ -6,7 +6,7 @@ puts <<-EOS
 
 # The basic formating string looks like: %l, %d: %m.
 
-logger = Yell.new STDOUT, :format => Yell::BasicFormat
+logger = Yell.new STDOUT, format: Yell::BasicFormat
 logger.info "Hello World!"
 #=> "I, 2012-02-29T09:30:00+01:00 : Hello World!"
 #    ^  ^                          ^
@@ -16,7 +16,7 @@ logger.info "Hello World!"
 
 EOS
 
-puts "=== actuale example ==="
-logger = Yell.new STDOUT, :format => Yell::BasicFormat
+puts "=== actual example ==="
+logger = Yell.new STDOUT, format: Yell::BasicFormat
 logger.info "Hello World!"
 

data/examples/003.3-formatting-ExtendedFormat.rb

@@ -6,7 +6,7 @@ puts <<-EOS
 
 # The extended formatting string looks like: %d [%5L] %p %h : %m.
 
-logger = Yell.new STDOUT, :format => Yell::ExtendedFormat
+logger = Yell.new STDOUT, format: Yell::ExtendedFormat
 logger.info "Hello World!"
 #=> "2012-02-29T09:30:00+01:00 [ INFO] 65784 localhost : Hello World!"
 #    ^                          ^      ^     ^           ^
@@ -15,7 +15,7 @@ logger.info "Hello World!"
 
 EOS
 
-puts "=== actuale example ==="
-logger = Yell.new STDOUT, :format => Yell::ExtendedFormat
+puts "=== actual example ==="
+logger = Yell.new STDOUT, format: Yell::ExtendedFormat
 logger.info "Hello World!"
 

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

@@ -6,7 +6,7 @@ puts <<-EOS
 
 # The extended formatting string looks like: %d [%5L] %p %h : %m.
 
-logger = Yell.new STDOUT, :format => "[%f:%n in `%M'] %m"
+logger = Yell.new STDOUT, format: "[%f:%n in `%M'] %m", trace: true
 logger.info "Hello World!"
 #=> [003.4-formatting-on-your-own.rb:20 in `<main>'] Hello World!
 #    ^                               ^      ^        ^
@@ -15,7 +15,7 @@ logger.info "Hello World!"
 
 EOS
 
-puts "=== actuale example ==="
-logger = Yell.new STDOUT, :format => "[%f:%n in `%M'] %m"
+puts "=== actual example ==="
+logger = Yell.new STDOUT, format: "[%f:%n in `%M'] %m", trace: true
 logger.info "Hello World!"
 

data/examples/004.1-colorizing-the-log-output.rb

@@ -6,7 +6,7 @@ puts <<-EOS
 
 You may colorize the log output on your io-based loggers loke so:
 
-logger = Yell.new STDOUT, :colors => true
+logger = Yell.new STDOUT, colors: true
 
 Yell::Severities.each do |level|
   logger.send level.downcase, level
@@ -14,8 +14,8 @@ end
 
 EOS
 
-puts "=== actuale example ==="
-logger = Yell.new STDOUT, :colors => true
+puts "=== actual example ==="
+logger = Yell.new STDOUT, colors: true
 
 Yell::Severities.each do |level|
   logger.send level.downcase, level

data/examples/005.1-repository.rb

@@ -7,7 +7,7 @@ puts <<-EOS
 # You can add a logger to the global repository.
 #
 # create a logger named 'mylog' that logs to stdout
-Yell.new :stdout, :name => 'mylog'
+Yell.new :stdout, name: 'mylog'
 
 # Later in the code, you can get your logger back
 Yell['mylog'].info "Hello World!"
@@ -15,7 +15,7 @@ Yell['mylog'].info "Hello World!"
 
 EOS
 
-puts "=== actuale example ==="
-Yell.new :stdout, :name => 'mylog'
+puts "=== actual example ==="
+Yell.new :stdout, name: 'mylog'
 Yell['mylog'].info "Hello World!"
 

data/examples/006.1-the-loggable-module.rb

@@ -10,7 +10,7 @@ puts <<-EOS
 # can use it, though, you will need to define a logger providing the :name of
 # your class.
 
-Yell.new :stdout, :name => 'Foo'
+Yell.new :stdout, name: 'Foo'
 
 # Define the class
 class Foo
@@ -26,7 +26,7 @@ EOS
 
 puts "=== actual example ==="
 
-Yell.new :stdout, :name => 'Foo'
+Yell.new :stdout, name: 'Foo'
 
 class Foo
   include Yell::Loggable

data/examples/006.2-the-loggable-module-with-inheritance.rb

@@ -10,7 +10,7 @@ puts <<-EOS
 # can use it, though, you will need to define a logger providing the :name of
 # your class.
 
-Yell.new :stdout, :name => 'Foo'
+Yell.new :stdout, name: 'Foo'
 
 # Define the class
 class Foo
@@ -28,7 +28,7 @@ EOS
 
 puts "=== actual example ==="
 
-Yell.new :stdout, :name => 'Foo'
+Yell.new :stdout, name: 'Foo'
 
 class Foo
   include Yell::Loggable

data/lib/core_ext/logger.rb

@@ -0,0 +1,17 @@
+require 'logger'
+
+class Logger
+
+  def level_with_yell=( level )
+    self.level_without_yell= level.is_a?(Yell::Level) ? Integer(level) : level
+  end
+  alias_method :level_without_yell=, :level=
+  alias_method :level=, :level_with_yell=
+
+  def add_with_yell( severity, message = nil, progname = nil, &block )
+    add_without_yell(Integer(severity), message, progname, &block)
+  end
+  alias_method :add_without_yell, :add
+  alias_method :add, :add_with_yell
+
+end

data/lib/yell/adapters/base.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require 'monitor'
 
 module Yell #:nodoc:
@@ -25,7 +23,7 @@ module Yell #:nodoc:
     #     end
     #
     #     write do |event|
-    #       message = format.format(event)
+    #       message = format.call(event)
     #
     #       STDOUT.puts message
     #     end
@@ -52,7 +50,7 @@ module Yell #:nodoc:
         #     @file_handle = File.new( '/dev/null', 'w' )
         #   end
         def setup( &block )
-          compile!( :setup!, &block )
+          compile!(:setup!, &block)
         end
 
         # Define your write method with this helper.
@@ -62,7 +60,7 @@ module Yell #:nodoc:
         #     @file_handle.puts event.message
         #   end
         def write( &block )
-          compile!( :write!, &block )
+          compile!(:write!, &block)
         end
 
         # Define your open method with this helper.
@@ -72,7 +70,7 @@ module Yell #:nodoc:
         #     @stream = ::File.open( 'test.log', ::File::WRONLY|::File::APPEND|::File::CREAT )
         #   end
         def open( &block )
-          compile!( :open!, &block )
+          compile!(:open!, &block)
         end
 
         # Define your close method with this helper.
@@ -82,7 +80,7 @@ module Yell #:nodoc:
         #     @stream.close
         #   end
         def close( &block )
-          compile!( :close!, &block )
+          compile!(:close!, &block)
         end
 
 
@@ -106,24 +104,24 @@ module Yell #:nodoc:
           m = instance_method( name )
 
           # Create a new method with leading underscore
-          define_method( "_#{name}", &block )
-          _m = instance_method( "_#{name}" )
-          remove_method( "_#{name}" )
+          define_method("_#{name}", &block)
+          _m = instance_method("_#{name}")
+          remove_method("_#{name}")
 
           # Define instance method
-          define!( name, _m, m, &block )
+          define!(name, _m, m, &block)
         end
 
         # Define instance method by given name and call the unbound
         # methods in order with provided block.
         def define!( name, _m, m, &block )
           if block.arity == 0
-            define_method( name ) do
+            define_method(name) do
               _m.bind(self).call
               m.bind(self).call
             end
           else
-            define_method( name ) do |*args|
+            define_method(name) do |*args|
               _m.bind(self).call(*args)
               m.bind(self).call(*args)
             end
@@ -155,7 +153,7 @@ module Yell #:nodoc:
         # make sure the adapter is closed and re-raise the exception
         synchronize { close }
 
-        raise( e )
+        raise(e)
       end
 
       # Close the adapter (stream, connection, etc).
@@ -172,18 +170,15 @@ module Yell #:nodoc:
         "#<#{self.class.name} #{inspection * ', '}>"
       end
 
-      private
 
-      # def reset!
-      #   super()
-      # end
+      private
 
       # Setup the adapter instance.
       #
       # Adapter classes should provide their own implementation 
       # of this method (if applicable).
       def setup!( options )
-        self.level = options[:level]
+        self.level = Yell.__fetch__(options, :level)
       end
 
       # Perform the actual write.
@@ -213,18 +208,18 @@ module Yell #:nodoc:
       # Determine whether to write at the given severity.
       #
       # @example
-      #   write? Yell::Event.new( 'INFO', 'Hwllo Wold!' )
+      #   write? Yell::Event.new( 'INFO', 'Hello Wold!' )
       #
       # @param [Yell::Event] event The log event
       #
       # @return [Boolean] true or false
       def write?( event )
-        @level.nil? || @level.at?( event.level )
+        level.nil? || level.at?(event.level)
       end
 
       # Get an array of inspected attributes for the adapter.
       def inspectables
-        [ :level ]
+        [:level]
       end
 
     end

data/lib/yell/adapters/datefile.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Yell #:nodoc:
   module Adapters #:nodoc:
 
@@ -54,16 +52,17 @@ module Yell #:nodoc:
 
       # @overload setup!( options )
       def setup!( options )
-        @date, @date_strftime = nil, nil # default; do not override --R
-
-        self.header = options.fetch(:header, true)
-        self.date_pattern = options.fetch(:date_pattern, DefaultDatePattern)
-        self.keep = options.fetch(:keep, false)
-        self.symlink = options.fetch(:symlink, true)
+        self.header = Yell.__fetch__(options, :header, default: true)
+        self.date_pattern = Yell.__fetch__(options, :date_pattern, default: DefaultDatePattern)
+        self.keep = Yell.__fetch__(options, :keep, default: false)
+        self.symlink = Yell.__fetch__(options, :symlink, default: true)
 
-        @original_filename  = ::File.expand_path options.fetch(:filename, default_filename)
+        @original_filename  = ::File.expand_path(Yell.__fetch__(options, :filename, default: default_filename))
         options[:filename]  = @original_filename
 
+        @date = Time.now
+        @date_strftime = @date.strftime(date_pattern)
+
         super
       end
 
@@ -85,7 +84,7 @@ module Yell #:nodoc:
 
       # @overload close!
       def close!
-        @filename = filename_for( @date )
+        @filename = filename_for(@date)
 
         super
       end
@@ -116,7 +115,7 @@ module Yell #:nodoc:
       # it makes the best guess by checking the last access time (which may result 
       # in false cleanups).
       def cleanup!
-        files = Dir[ @original_filename.sub( /(\.\w+)?$/, ".*\\1" ) ].sort.select do |file|
+        files = Dir[ @original_filename.sub(/(\.\w+)?$/, ".*\\1") ].sort.select do |file|
           _, pattern = header_from(file)
 
           # Select if the date pattern is nil (no header info available within the file) or
@@ -139,14 +138,16 @@ module Yell #:nodoc:
         # do nothing, because symlink is already correct
         return if ::File.symlink?(@original_filename) && ::File.readlink(@original_filename) == @filename
 
-        ::File.unlink( @original_filename ) if ::File.exist?( @original_filename )
-        ::File.symlink( @filename, @original_filename )
+        ::File.unlink(@original_filename) if ::File.exist?(@original_filename) || ::File.symlink?(@original_filename)
+        ::File.symlink(@filename, @original_filename)
       end
 
       # Symlink the original filename?
       #
       # @return [Boolean] true or false
-      def symlink?; !!symlink; end
+      def symlink?
+        !!symlink
+      end
 
       # Write the header information into the file
       def header!
@@ -156,36 +157,36 @@ module Yell #:nodoc:
       # Write header into the file?
       #
       # @return [Boolean] true or false
-      def header?; !!header; end
+      def header?
+        !!header
+      end
 
       # Sets the filename with the `:date_pattern` appended to it.
       def filename_for( date )
-        @original_filename.sub( /(\.\w+)?$/, ".#{date.strftime(date_pattern)}\\1" )
+        @original_filename.sub(/(\.\w+)?$/, ".#{date.strftime(date_pattern)}\\1")
       end
 
       # Fetch the header form the file
       def header_from( file )
-        if m = ::File.open( file, &:readline ).match( HeaderRegexp )
+        if m = ::File.open(file, &:readline).match(HeaderRegexp)
           # in case there is a Header present, we can just read from it
-          [ Time.at( m[2].to_f ), m[3] ]
+          [ Time.at(m[2].to_f), m[3] ]
         else
           # In case there is no header: we need to take a good guess
           #
           # Since the pattern can not be determined, we will just return the Posix ctime. 
           # That is NOT the creatint time, so the value will potentially be wrong!
-          [ ::File.ctime(file), nil ]
+          [::File.ctime(file), nil]
         end
       end
 
       # @overload inspectables
       def inspectables
-        super.concat [:date_pattern, :header, :keep, :symlink ]
+        super.concat %i[date_pattern header keep symlink]
       end
 
     end
 
-    register( :datefile, Yell::Adapters::Datefile )
-
   end
 end