easy_log4r 0.0.2

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,17 @@
+source "http://rubygems.org"
+
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+gem "log4r", ">= 0"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "shoulda-context", ">= 0"
+  gem "rdoc", "~> 3.12"
+  gem "jeweler", "~> 1.8.4"
+  gem 'simplecov', ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,40 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.2.7)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    git (1.2.5)
+    i18n (0.6.0)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.4)
+    log4r (1.1.10)
+    multi_json (1.3.6)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    shoulda (3.1.1)
+      shoulda-context (~> 1.0)
+      shoulda-matchers (~> 1.2)
+    shoulda-context (1.0.0)
+    shoulda-matchers (1.2.0)
+      activesupport (>= 3.0.0)
+    simplecov (0.6.4)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.5.3)
+    simplecov-html (0.5.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  jeweler (~> 1.8.4)
+  log4r
+  rdoc (~> 3.12)
+  shoulda
+  shoulda-context
+  simplecov

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Lauren Voswinkel
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,31 @@
+= easy-log4r
+
+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 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.
+
+The default logger is created using the base class's name, so if you want to customize a particular logger's outputters using an XML or YAML file, feel free to do so using the normal methods, remembering to give the logger the class's name. (ex: 'MyClass')
+
+That's it! Quick, simple, easy logging using log4r.
+
+== Upcoming updates
+
+* Ability to utilize customized Outputters and Formatters as defaults for even easier customized logging.
+
+== Contributing to easy-log4r
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2012 Lauren Voswinkel. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,45 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "easy_log4r"
+  gem.homepage = "http://github.com/valarissa/easy_log4r"
+  gem.license = "MIT"
+  gem.summary = %Q{Easy logging using Log4r}
+  gem.description = %Q{Quick, simple, easy logging with log4r that can easily be toggled}
+  gem.email = "lvoswink@gmail.com"
+  gem.authors = ["Lauren Voswinkel"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "easy-log4r #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.2

data/easy_log4r.gemspec

@@ -0,0 +1,70 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "easy_log4r"
+  s.version = "0.0.1"
+
+  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.description = "Quick, simple, easy logging with log4r that can easily be toggled"
+  s.email = "lvoswink@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "easy_log4r.gemspec",
+    "lib/easy_log4r.rb",
+    "lib/easy_log4r/easy_logger.rb",
+    "lib/easy_log4r/logger.rb",
+    "lib/easy_log4r/null_logger.rb",
+    "test/helper.rb",
+    "test/test_easy_logger.rb",
+    "test/test_logger.rb",
+    "test/test_null_logger.rb"
+  ]
+  s.homepage = "http://github.com/valarissa/easy_log4r"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.24"
+  s.summary = "Easy logging using Log4r"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<log4r>, [">= 0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<shoulda-context>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+    else
+      s.add_dependency(%q<log4r>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<shoulda-context>, [">= 0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<log4r>, [">= 0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<shoulda-context>, [">= 0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+  end
+end
+

data/lib/easy_log4r/easy_logger.rb

@@ -0,0 +1,5 @@
+module EasyLog4r::EasyLogger
+  def self.included(base)
+    EasyLog4r::Logger.add_logger(base, EasyLog4r::Logger.get_logger(base))
+  end
+end

data/lib/easy_log4r/logger.rb

@@ -0,0 +1,31 @@
+class EasyLog4r::Logger
+  require 'log4r'
+  include Log4r
+
+  def self.add_logger(base, logger)
+    base.class_variable_set(:@@log4r, logger)
+    base.instance_eval{ def log4r; class_variable_get(:@@log4r); end }
+    base.class_eval{ def log4r; class_variable_get(:@@log4r); end }
+  end
+
+  def self.default_logger(name)
+    logger = null_logger(name)
+    formatter = Log4r::PatternFormatter.new(:pattern => "[%l] %d %c :: %m")
+    logger.outputters = [Log4r::StdoutOutputter.new(:formatter => formatter),
+                         Log4r::StderrOutputter.new(:formatter => formatter)]
+    return logger
+  end
+
+  def self.null_logger(name)
+    logger = Log4r::Logger.new(name)
+    logger.outputters = []
+
+    return logger
+  end
+
+  def self.get_logger(base, null=false)
+    clas = base.to_s
+    logger = null ? null_logger(clas) : Log4r::Logger[clas]
+    return logger || default_logger(clas)
+  end
+end

data/lib/easy_log4r/null_logger.rb

@@ -0,0 +1,5 @@
+module EasyLog4r::NullLogger
+  def self.included(base)
+    EasyLog4r::Logger.add_logger(base, EasyLog4r::Logger.get_logger(base, :null))
+  end
+end

data/lib/easy_log4r.rb

@@ -0,0 +1,5 @@
+class EasyLog4r
+  require 'easy_log4r/logger'
+  require 'easy_log4r/easy_logger'
+  require 'easy_log4r/null_logger'
+end

data/test/helper.rb

@@ -0,0 +1,23 @@
+require 'simplecov'
+SimpleCov.start do
+  add_filter "/test/"
+end
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'easy_log4r'
+
+class Test::Unit::TestCase
+end

data/test/test_easy_logger.rb

@@ -0,0 +1,21 @@
+require 'helper'
+
+class BaseClass
+end
+
+class TestEasyLogger < Test::Unit::TestCase
+  
+  def include_logger
+    BaseClass.class_eval{ include EasyLog4r::EasyLogger }
+  end
+
+  should "create log4r method on base class" do
+    include_logger
+    assert_respond_to BaseClass, :log4r
+  end
+
+  should "create log4r method on class instance" do
+    include_logger
+    assert_respond_to BaseClass.new, :log4r
+  end
+end

data/test/test_logger.rb

@@ -0,0 +1,42 @@
+require 'helper'
+
+class BaseClass
+end
+
+class TestLogger < Test::Unit::TestCase
+  context "self.get_logger" do
+    should "return a Log4r::Logger" do
+      assert EasyLog4r::Logger.get_logger(BaseClass).is_a?(Log4r::Logger)
+    end
+
+    should "return a Log4r::Logger with the name 'BaseClass'" do
+      logger = EasyLog4r::Logger.get_logger(BaseClass)
+      assert logger.name == 'BaseClass'
+    end
+
+    should "return a Log4r::Logger with no Outputters if specified" do
+      logger = EasyLog4r::Logger.get_logger(BaseClass, :null)
+      assert logger.outputters.length == 0
+    end
+
+    should "return an existing Log4r::Logger if one exists" do
+      orig_logger = Log4r::Logger.new('BaseClass')
+      logger = EasyLog4r::Logger.get_logger(BaseClass)
+      assert logger == orig_logger
+    end
+  end
+
+  context "self.default_logger" do
+    should "return a Log4r::Logger with outputters" do
+      logger = EasyLog4r::Logger.default_logger('BaseClass')
+      assert logger.outputters.length != 0
+    end
+  end
+
+  context "self.null_logger" do
+    should "return a Log4r::Logger with no outputters" do
+      logger = EasyLog4r::Logger.null_logger('BaseClass')
+      assert logger.outputters.length == 0
+    end
+  end
+end

data/test/test_null_logger.rb

@@ -0,0 +1,21 @@
+require 'helper'
+
+class BaseClass
+end
+
+class TestNullLogger < Test::Unit::TestCase
+  
+  def include_logger
+    BaseClass.class_eval{ include EasyLog4r::NullLogger }
+  end
+
+  should "create log4r method on base class" do
+    include_logger
+    assert_respond_to BaseClass, :log4r
+  end
+
+  should "create log4r method on class instance" do
+    include_logger
+    assert_respond_to BaseClass.new, :log4r
+  end
+end

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification
+name: easy_log4r
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Lauren Voswinkel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: log4r
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: shoulda-context
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Quick, simple, easy logging with log4r that can easily be toggled
+email: lvoswink@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- easy_log4r.gemspec
+- lib/easy_log4r.rb
+- lib/easy_log4r/easy_logger.rb
+- lib/easy_log4r/logger.rb
+- lib/easy_log4r/null_logger.rb
+- test/helper.rb
+- test/test_easy_logger.rb
+- test/test_logger.rb
+- test/test_null_logger.rb
+homepage: http://github.com/valarissa/easy_log4r
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -759292738703420716
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Easy logging using Log4r
+test_files: []