easy_log4r 0.0.5 → 0.1.0

data/.rvmrc

@@ -0,0 +1,48 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional,
+# Only full ruby name is supported here, for short names use:
+#     echo "rvm use 1.9.3" > .rvmrc
+environment_id="ruby-1.9.3-p194@easy_log4r"
+
+# Uncomment the following lines if you want to verify rvm version per project
+# rvmrc_rvm_version="1.15.8 (stable)" # 1.10.1 seams as a safe start
+# eval "$(echo ${rvm_version}.${rvmrc_rvm_version} | awk -F. '{print "[[ "$1*65536+$2*256+$3" -ge "$4*65536+$5*256+$6" ]]"}' )" || {
+#   echo "This .rvmrc file requires at least RVM ${rvmrc_rvm_version}, aborting loading."
+#   return 1
+# }
+
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficient compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments"
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+  [[ -s "${rvm_path:-$HOME/.rvm}/hooks/after_use" ]] &&
+    \. "${rvm_path:-$HOME/.rvm}/hooks/after_use" || true
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  rvm --create  "$environment_id" || {
+    echo "Failed to create RVM environment '${environment_id}'."
+    return 1
+  }
+fi
+
+# If you use bundler, this might be useful to you:
+# if [[ -s Gemfile ]] && {
+#   ! builtin command -v bundle >/dev/null ||
+#   builtin command -v bundle | GREP_OPTIONS= \grep $rvm_path/bin/bundle >/dev/null
+# }
+# then
+#   printf "%b" "The rubygem 'bundler' is not installed. Installing it now.\n"
+#   gem install bundler
+# fi
+# if [[ -s Gemfile ]] && builtin command -v bundle >/dev/null
+# then
+#   bundle install | GREP_OPTIONS= \grep -vE '^Using|Your bundle is complete'
+# fi

data/README.rdoc

@@ -2,7 +2,12 @@
 
 easy-log4r is a quick and simple way to start using Log4r fast. It quickly and easily creates a default logger, as well as class and instance functions that can be used to access it. In addition, it also provides a simple way to disable logging, for whatever reason, without needing to actually remove or comment out the logging code you, hopefully, peppered through your code.
 
-To get started simply `include EasyLog4r::EasyLogger` after `require easy-log4r` in your class and you're good to go!
+To get started simply put the following into your class and you're good to go! 
+
+  require 'easy-log4r'
+  include EasyLog4r::EasyLogger
+
+This gives you two default outputs, one to stdout for all levels of logging, and one to stderr for the error and fatal levels of logging.
 
 To disable logging you can `include EasyLog4r::NullLogger`. You don't need to remove the EasyLogger you include to start logging, but you can if you want to.
 
@@ -10,9 +15,19 @@ The default logger is created using the base class's name, so if you want to cus
 
 That's it! Quick, simple, easy logging using log4r.
 
-== Upcoming updates
+== New Features
+
+=== 0.1.0
+
+You can now customize what outputters are used with easy_log4r! *Excitement!*
+
+To do so, you must:
+
+1. Use whichever method of configuration you prefer, xml or yaml, and you add a `default` attribute to the given outputter.
+2. Include `require 'easy_log4r'` before you parse the configuration file. (This is so the monkey patches to Log4r's base classes can take effect)
+3. Parse the configuration file! (You're done!)
 
-* Ability to utilize customized Outputters and Formatters as defaults for even easier customized logging.
+If you have no clue how to use a configuration file to edit Log4r, head over to https://github.com/Valarissa/easy_log4r/wiki/Log4r-Yaml-Configuration
 
 == Contributing to easy-log4r
  

data/VERSION

@@ -1 +1 @@
-0.0.5
+0.1.0

data/easy_log4r.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "easy_log4r"
-  s.version = "0.0.1"
+  s.version = "0.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Lauren Voswinkel"]
-  s.date = "2012-07-30"
+  s.date = "2012-09-20"
   s.description = "Quick, simple, easy logging with log4r that can easily be toggled"
   s.email = "lvoswink@gmail.com"
   s.extra_rdoc_files = [
@@ -18,6 +18,7 @@ Gem::Specification.new do |s|
   ]
   s.files = [
     ".document",
+    ".rvmrc",
     "Gemfile",
     "Gemfile.lock",
     "LICENSE.txt",
@@ -26,9 +27,12 @@ Gem::Specification.new do |s|
     "VERSION",
     "easy_log4r.gemspec",
     "lib/easy_log4r.rb",
+    "lib/easy_log4r/configurator.rb",
     "lib/easy_log4r/easy_logger.rb",
     "lib/easy_log4r/logger.rb",
     "lib/easy_log4r/null_logger.rb",
+    "lib/easy_log4r/outputter.rb",
+    "lib/easy_log4r/yamlconfigurator.rb",
     "test/helper.rb",
     "test/test_easy_logger.rb",
     "test/test_logger.rb",
@@ -37,7 +41,7 @@ Gem::Specification.new do |s|
   s.homepage = "http://github.com/valarissa/easy_log4r"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.24"
+  s.rubygems_version = "1.8.23"
   s.summary = "Easy logging using Log4r"
 
   if s.respond_to? :specification_version then

data/lib/easy_log4r.rb

@@ -10,4 +10,12 @@ module EasyLog4r
   require 'easy_log4r/logger'
   require 'easy_log4r/easy_logger'
   require 'easy_log4r/null_logger'
+
+  require 'log4r'
+  require 'log4r/configurator'
+  require 'log4r/yamlconfigurator'
+
+  require 'easy_log4r/outputter'
+  require 'easy_log4r/configurator'
+  require 'easy_log4r/yamlconfigurator'
 end

data/lib/easy_log4r/configurator.rb

@@ -0,0 +1,16 @@
+##
+#  Extension of base Log4r::Configurator to enable decoding of a `default`
+#  attribute in the XML definition.
+#
+class Log4r::Configurator
+  class << self
+    alias :orig_decode_outputter :decode_outputter
+  end
+
+  ##
+  # Decodes an outputter as normal, but also sets @default if it was defined in the given configuration file.
+  def self.decode_outputter(e)
+    orig_decode_outputter(e)
+    Log4r::Outputter[e.value_of('name')].default = !!e.value_of('default')
+  end
+end

data/lib/easy_log4r/logger.rb

@@ -3,6 +3,7 @@
 #
 class EasyLog4r::Logger
   require 'log4r'
+
   include Log4r
 
   ##
@@ -30,9 +31,11 @@ class EasyLog4r::Logger
   # Those outputters are a Log4r::StdoutOutputter and a Log4r::StderrOutputter, both of which have a default Log4r::Formatter
   def self.default_outputters
     return @outputters if @outputters
+
     @outputters = []
-    @outputters << default_outputter('formatted_stdout', StdoutOutputter)
-    @outputters << default_outputter('formatter_stderr', StderrOutputter)
+    @outputters << configured_default_outputters
+    @outputters << standard_outputters if @outputters.empty?
+    @outputters.flatten!
 
     return @outputters
   end
@@ -47,6 +50,20 @@ class EasyLog4r::Logger
     return out
   end
 
+  ##
+  # Gathers all Log4r::Outputters defined in the user defined configuration file.
+  def self.configured_default_outputters
+    Log4r::Outputter.default_outputters
+  end
+
+  ##
+  # Defines two standard outputters, one which prints to stdout at all levels, and one which prints to stderr for error and fatal levels.
+  def self.standard_outputters
+    @outputters << default_outputter('formatted_stdout', StdoutOutputter)
+    @outputters << default_outputter('formatted_stderr', StderrOutputter)
+    Log4r::Outputter['formatted_stderr'].level = :error
+  end
+
   ##
   # Creates or returns the default formatter.
   #

data/lib/easy_log4r/outputter.rb

@@ -0,0 +1,25 @@
+##
+#  Extension of base Log4r::Outputter class to add @default as an attribute
+#  and a class-level method to retrieve all outputters that have that attribute
+#  set.
+#
+class Log4r::Outputter
+  attr_accessor :default
+
+  ##
+  # Gathers all outputters that have @default set
+  def self.default_outputters
+    defaults = []
+    each_outputter do |outputter|
+      defaults << outputter if outputter.default?
+    end
+
+    return defaults
+  end
+
+  ##
+  # Returns whether or not @default has been set
+  def default?
+    !!@default
+  end
+end

data/lib/easy_log4r/yamlconfigurator.rb

@@ -0,0 +1,16 @@
+##
+#  Extension of base Log4r::YamlConfigurator to enable decoding of a `default`
+#  attribute in the Yaml definition.
+#
+class Log4r::YamlConfigurator
+  class << self
+    alias :orig_decode_outputter :decode_outputter
+  end
+
+  ##
+  # Decodes an outputter as normal, but also sets @default if it was defined in the given configuration file.
+  def self.decode_outputter( op )
+    orig_decode_outputter(op)
+    Log4r::Outputter[op['name']].default = !!op['default']
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: easy_log4r
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-05 00:00:00.000000000 Z
+date: 2012-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: log4r
@@ -116,6 +116,7 @@ extra_rdoc_files:
 - README.rdoc
 files:
 - .document
+- .rvmrc
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -124,9 +125,12 @@ files:
 - VERSION
 - easy_log4r.gemspec
 - lib/easy_log4r.rb
+- lib/easy_log4r/configurator.rb
 - lib/easy_log4r/easy_logger.rb
 - lib/easy_log4r/logger.rb
 - lib/easy_log4r/null_logger.rb
+- lib/easy_log4r/outputter.rb
+- lib/easy_log4r/yamlconfigurator.rb
 - test/helper.rb
 - test/test_easy_logger.rb
 - test/test_logger.rb
@@ -146,7 +150,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2910441067260595711
+      hash: -2590392929587300091
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -155,7 +159,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Easy logging using Log4r