kelredd-useful 0.3.5 → 0.4.0

data/Rakefile

@@ -21,6 +21,7 @@ spec = Gem::Specification.new do |s|
 
   s.add_development_dependency("shoulda", [">= 2.10.2"])
   s.add_development_dependency("leftright", [">= 0.0.6"])
+  s.add_development_dependency("log4r", [">= 1.1.0"])
 
   s.add_dependency('json')
 end

data/lib/useful/ruby_helpers/logger.rb

@@ -0,0 +1,127 @@
+module Useful; end
+module Useful::RubyHelpers; end
+
+require 'useful/ruby_extensions/object'
+
+module Useful::RubyHelpers::Logger
+
+  module ClassMethods
+    def benchmark(*args, &block)
+      require 'benchmark'
+      name, msg, opts = handle_log_args(args)
+      result = nil
+      ms = Benchmark.measure { result = block.call }.real
+      name += ' ' unless name.empty?
+      name += '(%.1fms)' % [ms*1000]
+      log(name, msg, opts)
+      result
+    end
+
+    def log(*args)
+      name, msg, opts = handle_log_args(args)
+      opts[:level] ||= 'debug'
+      unless logger.respond_to?(opts[:level].to_s)
+        raise Exception, "no '#{opts[:level].to_s.upcase}' logger provided"
+      end
+      if name.empty? && msg.empty?
+        nil
+      else
+        returning formatted_log_msg(name, msg, opts) do |log_msg|
+          logger.send(opts[:level].to_s, log_msg)
+        end
+      end
+    end
+
+    [:debug, :info, :warn, :error].each do |level|
+      define_method(level) do |*args|
+        if args.last.kind_of?(::Hash)
+          args.last[:level] = level
+        else
+          args << {:level => level}
+        end
+        log(*args)
+      end
+    end
+
+    private
+
+    def logger
+      raise Exception, "to use these logging features, override the self.logger method and provide a log4r-style logger"
+    end
+
+    def formatted_log_msg(name, msg, opts)
+      opts[:newlines] ||= 0
+      opts[:color] = true if opts[:color].nil?
+      opts[:prefix] ||= case opts[:level].to_s
+      when 'info'
+        "*"  # green
+      when 'warn'
+        "~"  # cyan
+      when 'error'
+        "!"  # red
+      else # debug
+        "-"
+      end
+      color_level = opts[:color] ? opts[:level].to_s : 'none'
+      color = case color_level
+      when 'debug'
+        "33;1"  # yellow
+      when 'info'
+        "32;1"  # green
+      when 'warn'
+        "36;1"  # cyan
+      when 'error'
+        "31;1"  # red
+      else
+        # white
+        "0"
+      end
+      color_reg = "0;#{color}"
+      color_underlined = "4;#{color}"
+      "\e[0m#{"\n"*opts[:newlines].to_i.abs}  \e[#{color_reg}m#{opts[:prefix]}\e[0m#{opts[:prefix].empty? ? '' : '  '}\e[#{color_underlined}m#{name}\e[0m#{name.empty? ? '' : '  '}#{msg}"
+    end
+
+    def handle_log_args(args)
+      case (the_args = args.flatten).length
+      when 3
+        the_args
+      when 2
+        if the_args.last.kind_of?(::Hash)
+          ["", the_args.first, the_args.last]
+        else
+          [the_args.first, the_args.last, {}]
+        end
+      when 0
+        ["", "", {}]
+      else
+        ["", the_args.first, {}]
+      end
+    end
+  end
+
+
+
+  module InstanceMethods
+    def benchmark(*args, &block)
+      self.class.send(:benchmark, *args, &block)
+    end
+
+    def log(*args)
+      self.class.send(:log, *args)
+    end
+
+    [:debug, :info, :warn, :error].each do |level|
+      define_method(level) do |*args|
+        self.class.send(level, *args)
+      end
+    end
+  end
+
+
+
+  def self.included(receiver)
+    receiver.extend         ClassMethods
+    receiver.send :include, InstanceMethods
+  end
+
+end

data/lib/useful/version.rb

@@ -2,8 +2,8 @@ module Useful
   module Version
 
     MAJOR = 0
-    MINOR = 3
-    TINY  = 5
+    MINOR = 4
+    TINY  = 0
 
     def self.to_s # :nodoc:
       [MAJOR, MINOR, TINY].join('.')

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: kelredd-useful
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 15
   prerelease: false
   segments: 
   - 0
-  - 3
-  - 5
-  version: 0.3.5
+  - 4
+  - 0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Kelly Redding
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-28 00:00:00 -05:00
+date: 2010-08-30 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -51,9 +51,25 @@ dependencies:
   type: :development
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: json
+  name: log4r
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 1
+        - 1
+        - 0
+        version: 1.1.0
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -63,7 +79,7 @@ dependencies:
         - 0
         version: "0"
   type: :runtime
-  version_requirements: *id003
+  version_requirements: *id004
 description: 
 email: kelly@kelredd.com
 executables: []
@@ -107,6 +123,7 @@ files:
 - lib/useful/ruby_extensions/true_class.rb
 - lib/useful/ruby_extensions.rb
 - lib/useful/ruby_extensions_with_activesupport.rb
+- lib/useful/ruby_helpers/logger.rb
 - lib/useful/shoulda_macros/test_unit/classes.rb
 - lib/useful/shoulda_macros/test_unit/context.rb
 - lib/useful/shoulda_macros/test_unit/files.rb