semantic_logger 0.6.2 → 0.7.0

data/Gemfile

@@ -0,0 +1,9 @@
+source :rubygems
+
+group :test do
+  gem "shoulda"
+  gem "mongo"
+  gem "bson_ext", :platform => 'ruby'
+end
+
+gem "sync_attr"

data/Gemfile.lock

@@ -0,0 +1,29 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.2.8)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    bson (1.7.0)
+    bson_ext (1.7.0)
+      bson (~> 1.7.0)
+    i18n (0.6.1)
+    mongo (1.7.0)
+      bson (~> 1.7.0)
+    multi_json (1.3.6)
+    shoulda (3.3.0)
+      shoulda-context (~> 1.0)
+      shoulda-matchers (~> 1.4)
+    shoulda-context (1.0.0)
+    shoulda-matchers (1.4.0)
+      activesupport (>= 3.0.0)
+    sync_attr (0.1.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bson_ext
+  mongo
+  shoulda
+  sync_attr

data/README.md

@@ -1,7 +1,10 @@
-semantic-logger-ruby
-====================
+semantic_logger
+===============
 
-* http://github.com/ClarityServices/semantic-logger-ruby
+Ruby and Rails Logger enhanced with semantic capabilities, high performance, standardized
+logging with multiple appenders
+
+* http://github.com/ClarityServices/semantic_logger
 
 ### Introduction
 
@@ -122,7 +125,33 @@ The following output will be written to file:
     2012-08-30 15:37:29.474 I [48308:ScriptThreadProcess: script/rails] Rails -- Calling external interface (5.2ms)
 
 If an exception is raised during the block the exception is logged
-at the same log level as the benchmark along with the duration and message
+at the same log level as the benchmark along with the duration and message.
+The exception will flow through to the caller unchanged
+
+```
+Parameters to benchmark_info, benchmark_debug, etc..
+
+message
+  The message for this log entry
+
+params:
+  :log_exception
+    Control whether or how an exception thrown in the block is
+    reported by SemanticLogger. Values:
+    :full
+      Log the exception class, message, and backtrace
+    :partial
+      Log the exception class and messag
+      The backtrace will not be logged
+    :off
+      Any unhandled exception from the block will not be logged
+
+  :min_duration
+    Only log if the block takes longer than this duration in ms
+
+  :payload
+    To log a custom payload along with this log entry
+```
 
 #### Logging levels
 
@@ -384,7 +413,7 @@ specific.
 
 ### Install
 
-    gem install semantic-logger
+    gem install semantic_logger
 
 To log to MongoDB
 
@@ -401,9 +430,9 @@ Want to contribute to Semantic Logger?
 
 First clone the repo and run the tests:
 
-    git clone git://github.com/ClarityServices/semantic-logger.git
-    cd semantic-logger
-    jruby -S rake test
+    git clone git://github.com/ClarityServices/semantic_logger.git
+    cd semantic_logger
+    ruby -S rake test
 
 Feel free to ping the mailing list with any issues and we'll try to resolve it.
 
@@ -412,20 +441,19 @@ Contributing
 
 Once you've made your great commits:
 
-1. [Fork](http://help.github.com/forking/) semantic-logger
+1. [Fork](http://help.github.com/forking/) semantic_logger
 2. Create a topic branch - `git checkout -b my_branch`
 3. Push to your branch - `git push origin my_branch`
-4. Create an [Issue](http://github.com/ClarityServices/semantic-logger/issues) with a link to your branch
+4. Create an [Issue](http://github.com/ClarityServices/semantic_logger/issues) with a link to your branch
 5. That's it!
 
 Meta
 ----
 
-* Code: `git clone git://github.com/ClarityServices/semantic-logger.git`
-* Home: <https://github.com/ClarityServices/semantic-logger>
-* Docs: TODO <http://ClarityServices.github.com/semantic-logger/>
-* Bugs: <http://github.com/reidmorrison/semantic-logger/issues>
-* Gems: <http://rubygems.org/gems/semantic-logger>
+* Code: `git clone git://github.com/ClarityServices/semantic_logger.git`
+* Home: <https://github.com/ClarityServices/semantic_logger>
+* Bugs: <http://github.com/reidmorrison/semantic_logger/issues>
+* Gems: <http://rubygems.org/gems/semantic_logger>
 
 This project uses [Semantic Versioning](http://semver.org/).
 

data/lib/semantic_logger.rb

@@ -1,6 +1,3 @@
-# Include sync_attr dependency
-require 'sync_attr'
-
 module SemanticLogger
   autoload :Base,   'semantic_logger/base'
   autoload :Logger, 'semantic_logger/logger'

data/lib/semantic_logger/base.rb

@@ -33,13 +33,13 @@ module SemanticLogger
             exception = log.payload
             message << " -- " << "#{exception.class}: #{exception.message}\n#{(exception.backtrace || []).join("\n")}"
           else
-            message << " -- " << log.payload.inspect
+            message << " -- " << self.class.inspect_payload(log.payload)
           end
         end
 
-        str = "#{SemanticLogger::Base.formatted_time(log.time)} #{log.level.to_s[0..0].upcase} [#{$$}:#{log.thread_name}] #{tags}#{log.name} -- #{message}"
-        str << " (#{'%.1f' % log.duration}ms)" if log.duration
-        str
+        duration_str = log.duration ? "(#{'%.1f' % log.duration}ms) " : ''
+
+        "#{SemanticLogger::Base.formatted_time(log.time)} #{log.level.to_s[0..0].upcase} [#{$$}:#{log.thread_name}] #{tags}#{duration_str}#{log.name} -- #{message}"
       end
     end
 
@@ -113,25 +113,33 @@ module SemanticLogger
           @level_index <= #{index}
         end
 
-        # Log the duration of the supplied block
-        #   If an exception occurs in the block the exception is logged using the
-        #   same log level. The exception will flow through to the caller unchanged
-        def benchmark_#{level}(message, payload = nil)
+        def benchmark_#{level}(message, params = nil)
           raise "Mandatory block missing" unless block_given?
+          log_exception = params.nil? ? :full : params[:log_exception]
+          min_duration  = params.nil? ? 0.0   : (params[:min_duration] || 0.0)
+          payload       = params.nil? ? nil   : params[:payload]
           if @level_index <= #{index}
             start = Time.now
             begin
               result = yield
               end_time = Time.now
-              # Add scoped payload
-              if self.payload
-                payload = payload.nil? ? self.payload : self.payload.merge(payload)
+              duration = 1000.0 * (end_time - start)
+
+              # Only log if the block took longer than 'min_duration' to complete
+              if duration >= min_duration
+                # Add scoped payload
+                if self.payload
+                  payload = payload.nil? ? self.payload : self.payload.merge(payload)
+                end
+                log Log.new(:#{level}, self.class.thread_name, name, message, payload, end_time, duration, tags, #{index})
               end
-              log Log.new(:#{level}, self.class.thread_name, name, message, payload, end_time, 1000.0 * (end_time - start), tags, #{index})
               result
             rescue Exception => exc
-              # TODO Need to be able to have both an exception and a Payload
-              log Log.new(:#{level}, self.class.thread_name, name, message, exc, Time.now, 1000.0 * (Time.now - start), tags, #{index})
+              if log_exception == :full
+                log Log.new(:#{level}, self.class.thread_name, name, message, exc, Time.now, 1000.0 * (Time.now - start), tags, #{index})
+              elsif log_exception == :partial
+                log Log.new(:#{level}, self.class.thread_name, name, "\#{message} -- \#{exception.class}: \#{exception.message}", payload, end_time, 1000.0 * (end_time - start), tags, #{index})
+              end
               raise exc
             end
           else
@@ -262,6 +270,17 @@ module SemanticLogger
       end
     end
 
+    if RUBY_VERSION.to_f >= 1.9
+      # With Ruby 1.9 calling .to_s on a hash now returns { 'a' => 1 }
+      def self.inspect_payload(payload)
+        payload.to_s
+      end
+    else
+      def self.inspect_payload(payload)
+        payload.inspect
+      end
+    end
+
     # Internal method to return the log level as an internal index
     # Also supports mapping the ::Logger levels to SemanticLogger levels
     def self.map_level_to_index(level)

data/lib/semantic_logger/logger.rb

@@ -1,3 +1,6 @@
+require 'thread'
+require 'sync_attr'
+
 # Logger is the interface used by
 #
 # Logger maintains the logging name to be used for all log entries generated
@@ -63,13 +66,17 @@ module SemanticLogger
     #   logger = SemanticLogger::Logger.new('MyClass')
     #
     # Parameters:
-    #  application: A class, module or a string with the application/class name
-    #               to be used in the logger
-    #  options:
-    #    :level   The initial log level to start with for this logger instance
-    def initialize(klass, level=self.class.default_level)
+    #  application
+    #    A class, module or a string with the application/class name
+    #    to be used in the logger
+    #
+    #  level
+    #    The initial log level to start with for this logger instance
+    #    Default: SemanticLogger::Logger.default_level
+    #
+    def initialize(klass, level=nil)
       @name = klass.is_a?(String) ? klass : klass.name
-      self.level = level
+      self.level = level || self.class.default_level
     end
 
     # Returns [Integer] the number of log entries that have not been written

data/lib/semantic_logger/version.rb

@@ -1,3 +1,3 @@
 module SemanticLogger #:nodoc
-  VERSION = "0.6.2"
+  VERSION = "0.7.0"
 end

data/nbproject/private/private.properties

@@ -0,0 +1 @@
+platform.active=Ruby_0

data/nbproject/private/private.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project-private xmlns="http://www.netbeans.org/ns/project-private/1">
+    <editor-bookmarks xmlns="http://www.netbeans.org/ns/editor-bookmarks/1"/>
+</project-private>

data/nbproject/private/rake-d.txt

@@ -0,0 +1,4 @@
+clean=
+clobber=
+gem=
+test=

data/nbproject/project.properties

@@ -0,0 +1,7 @@
+javac.classpath=
+main.file=main.rb
+platform.active=JRuby
+source.encoding=UTF-8
+spec.src.dir=spec
+src.dir=lib
+test.src.dir=test

data/nbproject/project.xml

@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://www.netbeans.org/ns/project/1">
+    <type>org.netbeans.modules.ruby.rubyproject</type>
+    <configuration>
+        <data xmlns="http://www.netbeans.org/ns/ruby-project/1">
+            <name>semantic_logger</name>
+            <source-roots>
+                <root id="src.dir"/>
+            </source-roots>
+            <test-roots>
+                <root id="test.src.dir"/>
+                <root id="spec.src.dir"/>
+            </test-roots>
+        </data>
+    </configuration>
+</project>

data/test/appender_file_test.rb

@@ -6,14 +6,14 @@ require 'test/unit'
 require 'shoulda'
 require 'logger'
 require 'semantic_logger'
-require 'test/mock_logger'
+require 'stringio'
 
 # Unit Test for SemanticLogger::Appender::File
 #
 class AppenderFileTest < Test::Unit::TestCase
   context SemanticLogger::Appender::File do
     setup do
-      @time = Time.parse("2012-08-02 09:48:32.482")
+      @time = Time.new
       @io = StringIO.new
       @appender = SemanticLogger::Appender::File.new(@io)
       @hash = { :session_id => 'HSSKLEU@JDK767', :tracking_number => 12345 }

data/test/appender_wrapper_test.rb

@@ -1,19 +1,20 @@
 # Allow test to be run in-place without requiring a gem install
 $LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
+$LOAD_PATH.unshift File.dirname(__FILE__)
 
 require 'rubygems'
 require 'test/unit'
 require 'shoulda'
 require 'logger'
 require 'semantic_logger'
-require 'test/mock_logger'
+require 'mock_logger'
 
 # Unit Test for SemanticLogger::Appender::Wrapper
 #
 class AppenderWrapperTest < Test::Unit::TestCase
   context SemanticLogger::Appender::Wrapper do
     setup do
-      @time = Time.parse("2012-08-02 09:48:32.482")
+      @time = Time.new
       @mock_logger = MockLogger.new
       @appender = SemanticLogger::Appender::Wrapper.new(@mock_logger)
       @hash = { :session_id => 'HSSKLEU@JDK767', :tracking_number => 12345 }

data/test/logger_test.rb

@@ -6,7 +6,6 @@ require 'test/unit'
 require 'shoulda'
 require 'logger'
 require 'semantic_logger'
-require 'test/mock_logger'
 
 # Unit Test for SemanticLogger::Logger
 class LoggerTest < Test::Unit::TestCase
@@ -71,24 +70,41 @@ class LoggerTest < Test::Unit::TestCase
         end
 
         context "Ruby Logger" do
-
           # Ensure that any log level can be logged
           Logger::Severity.constants.each do |level|
             should "log Ruby logger #{level} info" do
               @logger.level = Logger::Severity.const_get(level)
-              #assert_equal level.downcase.to_sym, @logger.level
-              if level == 'UNKNOWN'
+              if level.to_s == 'UNKNOWN'
                 assert_equal Logger::Severity.const_get('ERROR')+1, @logger.send(:level_index)
               else
                 assert_equal Logger::Severity.const_get(level)+1, @logger.send(:level_index)
               end
-              #         @logger.send(level, 'hello world', @hash) { "Calculations" }
-              #         SemanticLogger::Logger.flush
-              #         assert_match /\d+-\d+-\d+ \d+:\d+:\d+.\d+ \w \[\d+:.+\] LoggerTest -- hello world -- Calculations -- #{@hash_str}/, @mock_logger.message
             end
           end
         end
 
+        context "benchmark" do
+          # Ensure that any log level can be benchmarked and logged
+          SemanticLogger::LEVELS.each do |level|
+            should "log #{level} info" do
+              assert_equal "result", @logger.send("benchmark_#{level}".to_sym, 'hello world') { "result" }
+              SemanticLogger::Logger.flush
+              assert_match /\d+-\d+-\d+ \d+:\d+:\d+.\d+ \w \[\d+:.+\] \(\d+\.\dms\) LoggerTest -- hello world/, @mock_logger.message
+            end
+
+            should "log #{level} info with payload" do
+              assert_equal "result", @logger.send("benchmark_#{level}".to_sym, 'hello world', :payload => @hash) { "result" }
+              SemanticLogger::Logger.flush
+              assert_match /\d+-\d+-\d+ \d+:\d+:\d+.\d+ \w \[\d+:.+\] \(\d+\.\dms\) LoggerTest -- hello world -- #{@hash_str}/, @mock_logger.message
+            end
+
+            should "not log #{level} info when block is faster than :min_duration" do
+              assert_equal "result", @logger.send("benchmark_#{level}".to_sym, 'hello world', :min_duration => 0.5) { "result" }
+              SemanticLogger::Logger.flush
+              assert_nil @mock_logger.message
+            end
+          end
+        end
 
       end
     end

metadata

@@ -1,58 +1,59 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: semantic_logger
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 6
-  - 2
-  version: 0.6.2
+version: !ruby/object:Gem::Version
+  version: 0.7.0
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Reid Morrison
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-09-18 00:00:00 -04:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-10-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: sync_attr
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: shoulda
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+  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
-  version_requirements: *id002
-description: Machine readable document oriented logging with support for MongoDB and text files
-email: 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Machine readable document oriented logging with support for MongoDB and
+  text files
+email:
 - reidmo@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
-- bson_client.log
+files:
 - FUTURE.rb
+- Gemfile
+- Gemfile.lock
 - init.txt
 - lib/semantic_logger/appender/file.rb
 - lib/semantic_logger/appender/mongodb.rb
@@ -63,6 +64,12 @@ files:
 - lib/semantic_logger/version.rb
 - lib/semantic_logger.rb
 - LICENSE.txt
+- nbproject/private/config.properties
+- nbproject/private/private.properties
+- nbproject/private/private.xml
+- nbproject/private/rake-d.txt
+- nbproject/project.properties
+- nbproject/project.xml
 - Rakefile
 - README.md
 - test/appender_file_test.rb
@@ -70,35 +77,31 @@ files:
 - test/appender_wrapper_test.rb
 - test/logger_test.rb
 - test/mock_logger.rb
-has_rdoc: true
 homepage: https://github.com/ClarityServices/semantic_logger
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
+      hash: 3405593264048637508
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Semantic Logger for Ruby, and Ruby on Rails
 test_files: []
-