Merge branch 'master' into symbol-levels

.gitignore

@@ -2,7 +2,8 @@ pkg/*
 *.gem
 .bundle
 .idea
-
+.vscode
+vendor/
 # bundler
 Gemfile.*lock
 

.travis.yml

@@ -7,10 +7,11 @@ matrix:
     - rvm: ruby-head
     - rvm: 2.6
     - rvm: 2.5
+    - rvm: 2.4
     - rvm: 2.3
-    - rvm: jruby-head
-    - rvm: jruby-9.1
-    - rvm: jruby-9.2
+  allow_failures:
+    # ruby-head is always finicky with bundler and such
+    - rvm: ruby-head
 
 notifications:
   on_success: change

examples/002.1-log-level-basics.rb

@@ -7,7 +7,7 @@
 # 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 @@
 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"

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

@@ -7,10 +7,11 @@
 # 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 @@
 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
 

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

@@ -6,10 +6,12 @@
 
 # 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 @@
 
 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
 

examples/003.1-formatting-DefaultFormat.rb

@@ -7,7 +7,7 @@
 # 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 @@
 
 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!"
 

examples/003.2-formatting-BasicFormat.rb

@@ -6,7 +6,7 @@
 
 # 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 @@
 
 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!"
 

examples/003.3-formatting-ExtendedFormat.rb

@@ -6,7 +6,7 @@
 
 # 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 @@
 
 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!"
 

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

@@ -6,7 +6,7 @@
 
 # The extended formatting string looks like: %d [%5L] %p %h : %m.
 
-logger = Yell.new STDOUT, :format => "[%f:%n in `%M'] %m", :trace => true
+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 @@
 
 EOS
 
-puts "=== actuale example ==="
-logger = Yell.new STDOUT, :format => "[%f:%n in `%M'] %m", :trace => true
+puts "=== actual example ==="
+logger = Yell.new STDOUT, format: "[%f:%n in `%M'] %m", trace: true
 logger.info "Hello World!"
 

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

@@ -6,16 +6,16 @@
 
 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
 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

examples/005.1-repository.rb

@@ -7,15 +7,15 @@
 # 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!"
 
 
 EOS
 
-puts "=== actuale example ==="
-Yell.new :stdout, :name => 'mylog'
+puts "=== actual example ==="
+Yell.new :stdout, name: 'mylog'
 Yell['mylog'].info "Hello World!"
 

examples/006.1-the-loggable-module.rb

@@ -10,7 +10,7 @@
 # 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 @@ class Foo
 
 puts "=== actual example ==="
 
-Yell.new :stdout, :name => 'Foo'
+Yell.new :stdout, name: 'Foo'
 
 class Foo
   include Yell::Loggable

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

@@ -10,7 +10,7 @@
 # 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 @@ class Bar < Foo; end
 
 puts "=== actual example ==="
 
-Yell.new :stdout, :name => 'Foo'
+Yell.new :stdout, name: 'Foo'
 
 class Foo
   include Yell::Loggable

lib/yell/adapters/base.rb

@@ -208,7 +208,7 @@ def close!
       # 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
       #

lib/yell/adapters/datefile.rb

@@ -52,12 +52,12 @@ class Datefile < Yell::Adapters::File
 
       # @overload setup!( options )
       def setup!( options )
-        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)
+        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(Yell.__fetch__(options, :filename, :default => default_filename))
+        @original_filename  = ::File.expand_path(Yell.__fetch__(options, :filename, default: default_filename))
         options[:filename]  = @original_filename
 
         @date = Time.now
@@ -182,7 +182,7 @@ def header_from( file )
 
       # @overload inspectables
       def inspectables
-        super.concat [:date_pattern, :header, :keep, :symlink ]
+        super.concat %i[date_pattern header keep symlink]
       end
 
     end

lib/yell/adapters/file.rb

@@ -9,7 +9,7 @@ class File < Yell::Adapters::Io
 
       # @overload setup!( options )
       def setup!( options )
-        @filename = ::File.expand_path(Yell.__fetch__(options, :filename, :default => default_filename))
+        @filename = ::File.expand_path(Yell.__fetch__(options, :filename, default: default_filename))
 
         super
       end

lib/yell/adapters/io.rb

@@ -42,9 +42,9 @@ def colorize!; @colors = true; end
       def setup!( options )
         @stream = nil
 
-        self.colors = Yell.__fetch__(options, :colors, :default => false)
+        self.colors = Yell.__fetch__(options, :colors, default: false)
         self.formatter = Yell.__fetch__(options, :format, :formatter)
-        self.sync = Yell.__fetch__(options, :sync, :default => true)
+        self.sync = Yell.__fetch__(options, :sync, default: true)
 
         super
       end

lib/yell/formatter.rb

@@ -13,15 +13,15 @@ module Yell #:nodoc:
   # No format on the log message
   #
   # @example
-  #   logger = Yell.new STDOUT, :format => false
+  #   logger = Yell.new STDOUT, format: false
   #   logger.info "Hello World!"
   #   #=> "Hello World!"
   NoFormat = "%m"
 
   # Default Format
   #
   # @example
-  #   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!"
   #   #    ^                         ^       ^       ^
@@ -31,7 +31,7 @@ module Yell #:nodoc:
   # Basic Format
   #
   # @example
-  #   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!"
   #   #    ^  ^                          ^
@@ -42,7 +42,7 @@ module Yell #:nodoc:
   # Extended Format
   #
   # @example
-  #   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!"
   #   #    ^                          ^      ^     ^           ^

lib/yell/helpers/adapter.rb

@@ -10,10 +10,10 @@ module Adapter #:nodoc:
       #   adapter :file, 'development.log'
       #
       #   # Alternative notation for filename in options
-      #   adapter :file, :filename => 'developent.log'
+      #   adapter :file, filename: 'developent.log'
       #
       # @example Standard adapter with filename and additional options
-      #   adapter :file, 'development.log', :level => :warn
+      #   adapter :file, 'development.log', level: :warn
       #
       # @example Set the adapter directly from an adapter instance
       #   adapter Yell::Adapter::File.new

lib/yell/loggable.rb

@@ -6,7 +6,7 @@ module Yell #:nodoc:
   # provide it with the name of your class.
   #
   # @example
-  #   Yell.new :stdout, :name => 'Foo'
+  #   Yell.new :stdout, name: 'Foo'
   #
   #   class Foo
   #     include Yell::Loggable