log_switch 0.1.0

data/.gemtest

@@ -0,0 +1 @@
+

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+gemspec
+

data/History.rdoc

@@ -0,0 +1,7 @@
+=== 0.1.0 / 2011-10-07
+
+* Features:
+  * +require+ and +extend+ to mix in to your class/module to get a single point of logging
+  * Switch on/off logging
+  * Use whatever Logger you want
+

data/README.rdoc

@@ -0,0 +1,87 @@
+= log_switch
+
+http://github.com/turboladen/log_switch
+
+== DESCRIPTION
+
+While developing other gems that required a single class/singleton style logger,
+I got tired of repeating the code to create that logger and mix it in to my base
+class.  I just wanted to be able to require something, then be able to do:
+
+  MyLib.log "some message"
+
+I also wanted to be able to programmatically turn on/off logging by doing something
+like:
+
+  MyLib.log = false
+
+This gem allows just that.  Well, almost...
+
+== FEATURES/PROBLEMS
+
+Features:
+
+* +require+ and +extend+ to mix in to your class/module to get a single point of logging
+* Switch on/off logging
+* Use whatever Logger you want
+
+== SYNOPSIS
+
+Get your app logging with a single point of logging:
+
+  require 'log_switch'
+
+  class MyThing
+    extend LogSwitch
+  end
+
+  MyThing.log "I like you, Ruby."  # => D, [2011-10-07T14:40:26.697084 #30080] DEBUG -- : I like you, Ruby.
+
+...and then you can simply switch off logging by doing:
+
+  MyThing.log = false
+  MyThing.log "You're my favorite." # => No logging occurs!
+
+By default, LogSwitch sets the log level to :debug.  You can change the default
+log level as you go:
+
+  MyThing.log_level = :warn
+  MyThing.log "Crap!"           # => W, [2011-10-07T15:30:54.012502 #32892]  WARN -- : Crap!
+
+You can pass in the log level for your Logger type too:
+
+  MyThing.log "Stuff!", :info      # => I, [2011-10-07T15:28:49.480741 #32892]  INFO -- : Stuff!
+  MyThing.log "Meow", :fatal       # => F, [2011-10-07T15:32:21.207867 #32892] FATAL -- : Meow
+
+If you have another Logger object you want to write to, no problem:
+
+  some_other_logger = Logger.new 'log.txt'
+  MyThing.logger = some_other_logger
+  MyThing.log "hi!"
+  File.open('log.txt', 'r').read    # => Logfile created on 2011-10-07 15:50:19 -0700 by logger.rb/25413
+                                    #    D, [2011-10-07T15:51:16.385798 #34026] DEBUG -- : hi!
+
+== REQUIREMENTS
+
+* Ruby 1.9.2
+* RubyGems:
+  * None!
+
+== INSTALL
+
+  $ gem install log_switch
+
+== DEVELOPERS
+
+After checking out the source, run:
+
+  $ bundle install
+
+This task will install any missing dependencies for you.
+
+== THANKS
+
+I need to thank the http://github.com/rubiii/savon project for most of the code
+here.  Somehow I ran across how they do logging and started following suit.  The
+code in +log_switch+ is almost identical to Savon's logging.
+

data/Rakefile

@@ -0,0 +1,20 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'yard'
+
+# Load all extra rake task definitions
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].each { |ext| load ext }
+
+YARD::Rake::YardocTask.new do |t|
+  t.files = %w(lib/**/*.rb - History.rdoc)
+  t.options = %w(--title log_switch Documentation (#{LogSwitch::VERSION}))
+  t.options += %w(--main README.rdoc)
+end
+
+RSpec::Core::RakeTask.new
+
+# Alias for rubygems-test
+task test: :spec
+
+task default: :install
+

data/lib/log_switch/version.rb

@@ -0,0 +1,3 @@
+module LogSwitch
+  VERSION = '0.1.0'
+end

data/lib/log_switch.rb

@@ -0,0 +1,48 @@
+require_relative 'log_switch/version'
+require "logger"
+
+# LogSwitch allows for extending a class/module with a logger and, most
+# importantly, allows for turning off logging programmatically.  See the
+# +README.rdoc+ for more info.
+module LogSwitch
+
+  # Use to turn logging on or off.
+  attr_writer :log
+
+  # Tells whether logging is turned on or not.
+  def log?
+    @log != false
+  end
+
+  # Set this to the Logger you want to use.
+  attr_writer :logger
+
+  # Defaults to a +Logger+ writing to STDOUT.
+  def logger
+    @logger ||= ::Logger.new STDOUT
+  end
+
+  # Set the log level so you don't have to pass it in on your call.
+  attr_writer :log_level
+
+  # @return [Symbol] The current default log level.  Starts off as :debug.
+  def log_level
+    @log_level ||= :debug
+  end
+
+  # Logs a message using the level provided.  If no level provided, use
+  # +@log_level+.
+  #
+  # @param [String] message The message to log.
+  # @param [Symbol] level The log level to send to your Logger.
+  def log(message, level=log_level)
+    message.each_line { |line| logger.send level, line.chomp if log? }
+  end
+
+  # Sets back to defaults.
+  def reset_config!
+    self.log = true
+    self.logger = ::Logger.new STDOUT
+    self.log_level = :debug
+  end
+end

data/log_switch.gemspec

@@ -0,0 +1,29 @@
+$:.push File.expand_path("../lib", __FILE__)
+require 'log_switch/version'
+
+Gem::Specification.new do |s|
+  s.name = "log_switch"
+  s.version = LogSwitch::VERSION
+  s.authors = %w("Steve Loveless")
+  s.homepage = %q(http://github.com/turboladen/log_switch)
+  s.email = %w(steve.loveless@gmail.com)
+  s.summary = %q(Extends a class for singleton style logging that can easily be turned on and off.)
+  s.description = %q(Extends a class for singleton style logging that can easily be turned on and off.)
+
+  s.required_rubygems_version = ">=1.8.0"
+  s.required_ruby_version = Gem::Requirement.new(">= 1.9.2")
+  s.files = Dir.glob("{bin,features,lib,spec,tasks}/**/*") + Dir.glob("*.rdoc") +
+    %w(.gemtest Gemfile log_switch.gemspec Rakefile)
+  s.test_files = Dir.glob("{features,spec}/**/*")
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency("bundler", [">= 0"])
+  s.add_development_dependency("code_statistics", ["~> 0.2.13"])
+  s.add_development_dependency("metric_fu", [">= 2.0.1"])
+  s.add_development_dependency("rake", [">= 0"])
+  s.add_development_dependency("rspec", ["~> 2.6.0"])
+  s.add_development_dependency("simplecov", [">= 0"])
+  s.add_development_dependency("simplecov-rcov-text", [">= 0"])
+  s.add_development_dependency("yard", [">= 0.7.2"])
+end
+

data/spec/log_switch_spec.rb

@@ -0,0 +1,82 @@
+require_relative 'spec_helper'
+
+describe Kernel do
+  def self.get_requires
+    Dir[File.dirname(__FILE__) + '/../lib/log_switch/**/*.rb']
+  end
+
+  # Try to require each of the files in LogSwitch
+  get_requires.each do |r|
+    it "should require #{r}" do
+
+      # A require returns true if it was required, false if it had already been
+      # required, and nil if it couldn't require.
+      Kernel.require(r.to_s).should_not be_nil
+    end
+  end
+end
+
+describe "LogSwitch" do
+  around :each do |example|
+    class MyClass; extend LogSwitch; end;
+    example.run
+    MyClass.reset_config!
+  end
+
+  it { LogSwitch::VERSION.should == '0.1.0' }
+
+  describe "log" do
+    it "should default to true" do
+      MyClass.log?.should be_true
+    end
+
+    it "can log at any log level" do
+      logger = double "Logger"
+      logger.should_receive(:send).with(:meow, "stuff")
+      MyClass.logger = logger
+      MyClass.log("stuff", :meow)
+    end
+
+    it "raises when log_level isn't a Symbol" do
+      expect { MyClass.log("stuff", "meow") }.to raise_error NoMethodError
+    end
+  end
+
+  describe "log=" do
+    it "allows to set logging to false" do
+      MyClass.log = false
+      MyClass.log?.should be_false
+    end
+  end
+
+  describe "logger" do
+    it "is a Logger by default" do
+      MyClass.logger.should be_a Logger
+    end
+  end
+
+  describe "logger=" do
+    it "allows to set to use another logger" do
+      original_logger = MyClass.logger
+      another_logger = Logger.new nil
+      MyClass.logger = another_logger
+      MyClass.logger.should_not == original_logger
+    end
+  end
+
+  describe "log_level" do
+    it "defaults to :debug" do
+      MyClass.log_level.should == :debug
+    end
+  end
+
+  describe "log_level=" do
+    it "changes the level that #log(msg, level=) uses" do
+      MyClass.logger.should_receive(:debug)
+      MyClass.log("testing...")
+      MyClass.log_level = :info
+      MyClass.logger.should_receive(:info)
+      MyClass.log("testing...")
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require 'simplecov'
+require 'simplecov-rcov-text'
+
+class SimpleCov::Formatter::MergedFormatter
+  def format(result)
+    SimpleCov::Formatter::HTMLFormatter.new.format(result)
+    SimpleCov::Formatter::RcovTextFormatter.new.format(result)
+  end
+end
+
+SimpleCov.formatter = SimpleCov::Formatter::MergedFormatter
+
+SimpleCov.start do
+  add_filter "/spec"
+end
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require 'log_switch'

data/tasks/metrics.rake

@@ -0,0 +1,59 @@
+require 'metric_fu'
+
+MetricFu::Configuration.run do |config|
+  config.metrics  = [
+                      :churn,
+                      :flog,
+                      :flay,
+                      :hotspots,
+                      :rcov,
+                      :reek,
+                      :roodi,
+                      :stats,
+                    ]
+  config.graphs   = [
+                      :flog,
+                      :flay,
+                      :rcov,
+                      :reek,
+                      :roodi,
+                      :stats
+                    ]
+  config.churn    = { 
+                      start_date: "1 year ago", 
+                      minimum_churn_count: 10 
+                    }
+  config.flay     = {
+                      dirs_to_flay: %w(
+                        lib
+                        features/step_definitions
+                        features/support
+                      ),
+                      minimum_score: 10,
+                      filetypes: %w(rb) 
+                    } 
+  config.flog     = { 
+                      dirs_to_flog: %w(
+                        lib
+                        features/step_definitions
+                        features/support
+                      )
+                    }
+  config.reek     = { 
+                      dirs_to_reek: %w(
+                        lib
+                        features/step_definitions
+                        features/support
+                      )
+                    }
+  config.roodi    = { 
+                      dirs_to_roodi: %w(
+                        lib
+                        features/step_definitions
+                        features/support
+                      ),
+                      roodi_config: "tasks/roodi_config.yaml" 
+                    }
+  config.rcov[:external] = 'coverage/rcov/rcov.txt'
+  config.graph_engine = :bluff
+end

data/tasks/roodi_config.yaml

@@ -0,0 +1,14 @@
+---
+AssignmentInConditionalCheck:    { }
+CaseMissingElseCheck:            { }
+ClassLineCountCheck:             { line_count: 300 }
+ClassNameCheck:                  { pattern: !ruby/regexp /^[A-Z][a-zA-Z0-9]*$/ }
+CyclomaticComplexityBlockCheck:  { complexity: 4 }
+CyclomaticComplexityMethodCheck: { complexity: 8 }
+EmptyRescueBodyCheck:            { }
+ForLoopCheck:                    { }
+MethodLineCountCheck:            { line_count: 30 }
+MethodNameCheck:                 { pattern: !ruby/regexp /^[_a-z<>=\[\]|+-\/\*`]+[_a-z0-9_<>=~@\[\]]*[=!\?]?$/ }
+ModuleLineCountCheck:            { line_count: 300 }
+ModuleNameCheck:                 { pattern: !ruby/regexp /^[A-Z][a-zA-Z0-9]*$/ }
+ParameterNumberCheck:            { parameter_count: 5 }

data/tasks/stats.rake

@@ -0,0 +1,12 @@
+require 'code_statistics'
+
+STATS_DIRECTORIES = [
+  %w(Library            lib),
+  %w(Behavior\ tests    features/step_definitions),
+  %w(Unit\ tests        spec)
+].collect { |name, dir| [ name, "#{dir}" ] }.select { |name, dir| File.directory?(dir) }
+
+desc "Report code statistics (KLOCs, etc) from the application"
+task :stats do
+  CodeStatistics::CodeStatistics.new(*STATS_DIRECTORIES).to_s
+end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: log_switch
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- ! '"Steve'
+- Loveless"
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-10-08 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70101806784680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70101806784680
+- !ruby/object:Gem::Dependency
+  name: code_statistics
+  requirement: &70101806783740 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.13
+  type: :development
+  prerelease: false
+  version_requirements: *70101806783740
+- !ruby/object:Gem::Dependency
+  name: metric_fu
+  requirement: &70101806782920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :development
+  prerelease: false
+  version_requirements: *70101806782920
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70101806782420 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70101806782420
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70101806781700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+  type: :development
+  prerelease: false
+  version_requirements: *70101806781700
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &70101806780960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70101806780960
+- !ruby/object:Gem::Dependency
+  name: simplecov-rcov-text
+  requirement: &70101806780160 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70101806780160
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &70101806778460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.7.2
+  type: :development
+  prerelease: false
+  version_requirements: *70101806778460
+description: Extends a class for singleton style logging that can easily be turned
+  on and off.
+email:
+- steve.loveless@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/log_switch/version.rb
+- lib/log_switch.rb
+- spec/log_switch_spec.rb
+- spec/spec_helper.rb
+- tasks/metrics.rake
+- tasks/roodi_config.yaml
+- tasks/stats.rake
+- History.rdoc
+- README.rdoc
+- .gemtest
+- Gemfile
+- log_switch.gemspec
+- Rakefile
+homepage: http://github.com/turboladen/log_switch
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.8.0
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Extends a class for singleton style logging that can easily be turned on
+  and off.
+test_files:
+- spec/log_switch_spec.rb
+- spec/spec_helper.rb