logging_assist 0.1.0

data/.document

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

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/.rspec

@@ -0,0 +1 @@
+--color

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Kristian Mandrup
+
+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.markdown

@@ -0,0 +1,18 @@
+# Logging assist
+
+A *Basic* logging assistant to help debug your projects. Was originally created to make it easy to debug Generators
+Log4r is used as the logging engine which this project wraps.
+
+## Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (c) 2010 Kristian Mandrup. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,19 @@
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "logging_assist"
+    gem.summary = %Q{Assists you in adding logging to any class such as a Generator}
+    gem.description = %Q{Wraps logging in a nice and convenient way making it easy to apply on any project}
+    gem.email = "kmandrup@gmail.com"
+    gem.homepage = "http://github.com/kristianmandrup/generator_assist"
+    gem.authors = ["Kristian Mandrup"]
+    gem.add_development_dependency  "rspec",        "~> 2.0.0.beta.19"
+    gem.add_dependency              "require_all",  "~> 1.1.0"    
+    gem.add_dependency              "sugar-high",   "~> 0.2.3"    
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/logging_assist.rb

@@ -0,0 +1,4 @@
+require 'require_all'
+require 'sugar-high/module'
+
+require_all File.dirname(__FILE__) + '/logging_assist'

data/lib/logging_assist/logging.rb

@@ -0,0 +1,119 @@
+require 'active_support/inflector'
+require 'log4r'
+include Log4r
+
+module Rails::Assist::BasicLogging
+  def log
+    @log ||= Rails::Assist::Logging.new 
+  end  
+end
+
+module Rails::Assist
+  class Logging    
+
+    attr_reader :logger
+
+    def logfile
+      gen_logfile = RSpec::Generator.logfile if defined?(RSpec::Generator) 
+      gen_logfile || @logfile || 'logging.log'
+    end
+
+    def logfile= file
+      @logfile = file
+    end
+
+    # DEBUG < INFO < WARN < ERROR < FATAL
+    DEBUG_LVS = [:debug, :info, :warn, :error, :fatal]
+
+    def initialize options = {:level => :debug}
+      Log4r::Logger.global.level = Log4r::ALL
+      @logger ||= Log4r::Logger.new('logger')            
+      add_stdout options[:level]
+    end
+
+    def add_outputter outputter
+      logger.outputters << outputter
+    end      
+
+    def remove_outputter outputter
+      logger.outputters.delete(outputter)
+    end      
+
+    def debug_lv= level
+      raise ArgumentError, "Debug lv must be one of #{DEBUG_LVS}" if !DEBUG_LVS.include? lv
+      logger.each_outputter do |name, outputter|
+        outputter.level = get_lv(level)        
+      end
+    end      
+
+    def add_stdout level = :debug
+      add_outputter Log4r::StdoutOutputter.new 'console', :formatter => simple_formatter, :level => get_lv(level)
+    end
+    
+    def add_logfile level = :debug
+      add_outputter FileOutputter.new "logfile", :filename => logfile, :formatter => simple_formatter, :level => get_lv(level)
+    end    
+
+    def debug msg
+      set_log_class do
+        logger.debug "[#{@log_class}]"
+      end
+      logger.debug "#{msg}" 
+    end
+
+    def info msg
+      set_log_class do
+        logger.info "[#{@log_class}]"
+      end
+      logger.info "-- #{msg}" 
+    end
+
+    def warn msg
+      set_log_class do
+        logger.warn "[#{@log_class}]"
+      end
+      logger.warn draw_line
+      logger.warn ":: #{msg}" 
+    end
+
+    def error msg
+      set_log_class do
+        logger.warn "[#{@log_class}]"
+      end
+      logger.error draw_line
+      logger.error "! #{msg.upcase}" 
+      logger.error      
+    end
+
+    def fatal msg
+      set_log_class do
+        logger.warn "[#{@log_class}]"
+      end
+      logger.fatal draw_line :char => '='
+      logger.error "**** #{msg.upcase} ****" 
+      logger.fatal draw_line :char => '='
+    end
+
+    protected
+
+    def get_lv level = :debug
+      raise ArgumentError, "Debug lv must be one of #{DEBUG_LVS}" if !DEBUG_LVS.include? level
+      "Log4r::#{level.to_s.upcase}".constantize
+    end      
+
+    def simple_formatter
+      PatternFormatter.new(:pattern => "%m")      
+    end
+    
+    def set_log_class &block
+      if self.class != @log_class
+        @log_class = self.class 
+        yield if block
+      end
+    end
+
+    def draw_line options = {:size => 40, :char => '-'}
+      options[:char] * options[:size]
+    end             
+  end
+end

data/lib/logging_assist/namespaces.rb

@@ -0,0 +1,3 @@
+module Rails
+  modules :assist
+end

data/logging_assist.gemspec

@@ -0,0 +1,63 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{logging_assist}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Kristian Mandrup"]
+  s.date = %q{2010-09-11}
+  s.description = %q{Wraps logging in a nice and convenient way making it easy to apply on any project}
+  s.email = %q{kmandrup@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.markdown"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     ".rspec",
+     "LICENSE",
+     "README.markdown",
+     "Rakefile",
+     "VERSION",
+     "lib/logging_assist.rb",
+     "lib/logging_assist/logging.rb",
+     "lib/logging_assist/namespaces.rb",
+     "logging_assist.gemspec",
+     "spec/logging_assist/logging_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/kristianmandrup/generator_assist}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Assists you in adding logging to any class such as a Generator}
+  s.test_files = [
+    "spec/logging_assist/logging_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, ["~> 2.0.0.beta.19"])
+      s.add_runtime_dependency(%q<require_all>, ["~> 1.1.0"])
+      s.add_runtime_dependency(%q<sugar-high>, ["~> 0.2.3"])
+    else
+      s.add_dependency(%q<rspec>, ["~> 2.0.0.beta.19"])
+      s.add_dependency(%q<require_all>, ["~> 1.1.0"])
+      s.add_dependency(%q<sugar-high>, ["~> 0.2.3"])
+    end
+  else
+    s.add_dependency(%q<rspec>, ["~> 2.0.0.beta.19"])
+    s.add_dependency(%q<require_all>, ["~> 1.1.0"])
+    s.add_dependency(%q<sugar-high>, ["~> 0.2.3"])
+  end
+end
+

data/spec/logging_assist/logging_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+class Abra
+  include Rails::Assist::BasicLogging
+end
+
+describe 'BasicGenerator' do  
+  before do              
+    @abra = Abra.new
+  end
+
+  it "should log to stdout" do    
+    @abra.log.debug 'debugged msg'
+    @abra.log.info  'info msg here'    
+  end
+    
+  it "should log to logfile" do    
+    @abra.log.add_logfile    
+    @abra.log.debug 'debugged msg'
+    @abra.log.info  'info msg here'    
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'rspec'
+require 'rspec/autorun'
+require 'logging_assist'
+
+RSpec.configure do |config|  
+  config.mock_with :mocha
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification 
+name: logging_assist
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Kristian Mandrup
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-11 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 0
+        - beta
+        - 19
+        version: 2.0.0.beta.19
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: require_all
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 1
+        - 0
+        version: 1.1.0
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: sugar-high
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 2
+        - 3
+        version: 0.2.3
+  type: :runtime
+  version_requirements: *id003
+description: Wraps logging in a nice and convenient way making it easy to apply on any project
+email: kmandrup@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.markdown
+files: 
+- .document
+- .gitignore
+- .rspec
+- LICENSE
+- README.markdown
+- Rakefile
+- VERSION
+- lib/logging_assist.rb
+- lib/logging_assist/logging.rb
+- lib/logging_assist/namespaces.rb
+- logging_assist.gemspec
+- spec/logging_assist/logging_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/kristianmandrup/generator_assist
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Assists you in adding logging to any class such as a Generator
+test_files: 
+- spec/logging_assist/logging_spec.rb
+- spec/spec_helper.rb