madvertise-logging 0.2.2 → 0.3.1

data/.rvmrc

@@ -1 +1 @@
-rvm use --create ruby-1.9.3-p0@madvertise-logging
+rvm use --create ruby-1.9.3-p125@madvertise-logging

data/Gemfile

@@ -3,6 +3,12 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in madvertise-logging.gemspec
 gemspec
 
+group :development do
+  gem 'rake'
+  gem 'pry'
+  gem 'pry-doc'
+end
+
 group :test do
   gem 'rspec'
   gem 'simplecov'

data/lib/madvertise/logging/improved_io.rb

@@ -0,0 +1,159 @@
+module Madvertise
+  module Logging
+
+    ##
+    # ImprovedIO is a subclass of IO with a bunch of methods reimplemented so
+    # that subclasses don't have to reimplement every IO method. Unfortunately
+    # this is necessary because Ruby does not provide a sane interface to IO
+    # like Enumerable for Arrays and Hashes.
+    #
+    class ImprovedIO < IO
+
+      def flush
+        self
+      end
+
+      def external_encoding
+        nil
+      end
+
+      def internal_encoding
+        nil
+      end
+
+      def set_encoding
+        self
+      end
+
+      def readbyte
+        getbyte.tap do |byte|
+          raise EOFError unless byte
+        end
+      end
+
+      def readchar
+        getc.tap do |char|
+          raise EOFError unless char
+        end
+      end
+
+      def readline
+        gets.tap do |string|
+          raise EOFError unless string
+        end
+      end
+
+      def tty?
+        false
+      end
+
+      def printf(format_string, *arguments)
+        write(sprintf(format_string, *arguments))
+        return nil
+      end
+
+      def print(*arguments)
+        args = if arguments.empty?
+                 [$_]
+               else
+                 arguments
+               end
+
+        write(args.join($,))
+        return nil
+      end
+
+      def putc
+      end
+
+      def puts(*arguments)
+        return nil if arguments.empty?
+
+        arguments.each do |arg|
+          if arg.is_a?(Array)
+            puts(*arg)
+          elsif arg.is_a?(String)
+            write(arg)
+          else
+            write(arg.to_s)
+          end
+        end
+
+        return nil
+      end
+
+      # provide sane aliases for IO compat
+      begin
+        alias_method :each_byte, :bytes
+        alias_method :each_char, :chars
+        alias_method :each_codepoint, :codepoints
+        alias_method :each_line, :lines
+        alias_method :each, :lines
+        alias_method :eof, :eof?
+        alias_method :isatty, :tty?
+        alias_method :sysread, :read
+        alias_method :syswrite, :write
+      rescue NameError
+        # do nothing, method may not exist in ruby 1.8
+      end
+
+      # skip these IO methods
+      [
+        :advise,
+        :autoclose=,
+        :autoclose?,
+        :binmode,
+        :binmode?,
+        :close_on_exec=,
+        :close_on_exec?,
+        :fcntl,
+        :fdatasync,
+        :fileno,
+        :fsync,
+        :ioctl,
+        :lineno,
+        :lineno=,
+        :pid,
+        :read_nonblock,
+        :stat,
+        :sysseek,
+        :tell,
+        :to_i,
+        :to_io,
+        :write_nonblock,
+      ].each do |meth|
+        begin
+          undef_method meth
+        rescue NameError
+          # do nothing, method may not exist in ruby 1.8
+        end
+      end
+
+      class << self
+        # skip these IO methods
+        [
+          :binread,
+          :binwrite,
+          :copy_stream,
+          :for_fd,
+          :foreach,
+          :open,
+          :pipe,
+          :popen,
+          :read,
+          :readlines,
+          :select,
+          :sysopen,
+          :try_convert,
+          :write,
+        ].each do |meth|
+          begin
+            undef_method meth
+          rescue NameError
+            # do nothing, method may not exist in ruby 1.8
+          end
+        end
+      end
+    end
+  end
+end

data/lib/madvertise/logging/improved_logger.rb

@@ -1,6 +1,8 @@
 require 'logger'
 require 'stringio'
 
+require 'madvertise/logging/improved_io'
+
 module Madvertise
   module Logging
 
@@ -8,9 +10,9 @@ module Madvertise
     # ImprovedLogger is an enhanced version of DaemonKits AbstractLogger class
     # with token support, buffer backend and more.
     #
-    class ImprovedLogger
+    class ImprovedLogger < ImprovedIO
 
-      # Write a copy of all log messages to STDOUT.
+      # Write a copy of all log messages to stdout.
       attr_accessor :copy_to_stdout
 
       # Program name prefix. Used as ident for syslog backends.
@@ -137,12 +139,8 @@ module Madvertise
       # @param [Exception, String] exc  The exception to log. If exc is a
       #   String no backtrace will be generated.
       def exception(exc)
-        if exc.is_a?(::Exception)
-          message = "EXCEPTION: #{exc.message}: #{clean_trace(exc.backtrace)}"
-        else
-          message = exc
-        end
-        add(:error, message, true)
+        exc = "EXCEPTION: #{exc.message}: #{clean_trace(exc.backtrace)}" if exc.is_a?(::Exception)
+        add(:error, exc, true)
       end
 
       # Save the current token and associate it with obj#object_id.
@@ -205,7 +203,7 @@ module Madvertise
 
         logger.add(severity) { message }
 
-        STDOUT.puts(message) if self.copy_to_stdout && severity >= @logger.level
+        $stdout.puts(message) if self.copy_to_stdout && severity >= @logger.level
       end
 
       def create_backend
@@ -228,8 +226,8 @@ module Madvertise
         begin
           FileUtils.mkdir_p(File.dirname(@logfile))
         rescue
-          STDERR.puts "#{@logfile} not writable, using STDERR for logging" if @logfile
-          @logfile = STDERR
+          $stderr.puts "#{@logfile} not writable, using stderr for logging" if @logfile
+          @logfile = $stderr
         end
 
         create_logger
@@ -269,10 +267,62 @@ module Madvertise
 
         # @private
         def call(severity, time, progname, msg)
-          time = time.strftime("%Y-%m-%d %H:%M:%S.") + time.usec.to_s
+          # this is so ugly because ruby 1.8 does not support %N in strftime
+          time = time.strftime("%Y-%m-%d %H:%M:%S.") + sprintf('%.6f', time.usec.to_f/1000/1000)[2..-1]
           self.class.format % [time, progname, $$, severity, msg.to_s]
         end
       end
+
+      module IOCompat
+        def close_read
+          nil
+        end
+
+        def close_write
+          close
+        end
+
+        def closed?
+          raise NotImplementedError
+        end
+
+        def sync
+          @backend != :buffer
+        end
+
+        def sync=(value)
+          raise NotImplementedError, "#{self} cannot change sync mode"
+        end
+
+        # ImprovedLogger is write-only
+        def _raise_write_only
+          raise IOError, "#{self} is a buffer-less, write-only, non-seekable stream."
+        end
+
+        [
+          :bytes,
+          :chars,
+          :codepoints,
+          :lines,
+          :eof?,
+          :getbyte,
+          :getc,
+          :gets,
+          :pos,
+          :pos=,
+          :read,
+          :readlines,
+          :readpartial,
+          :rewind,
+          :seek,
+          :ungetbyte,
+          :ungetc
+        ].each do |meth|
+          alias_method meth, :_raise_write_only
+        end
+      end
+
+      include IOCompat
     end
   end
 end

data/lib/madvertise/logging/mask.reek

@@ -0,0 +1,14 @@
+---
+LongParameterList:
+  exclude:
+    - Formatter#call
+FeatureEnvy:
+  exclude:
+    - ImprovedLogger#clean_trace
+    - ImprovedLogger#exception
+UtilityFunction:
+  exclude:
+    - ImprovedLogger#clean_trace
+LargeClass:
+  exclude:
+    - ImprovedLogger

data/lib/madvertise/logging/version.rb

@@ -1,6 +1,6 @@
 module Madvertise
   module Logging
     # @private
-    VERSION = "0.2.2"
+    VERSION = "0.3.1"
   end
 end

data/madvertise-logging.gemspec

@@ -14,7 +14,4 @@ Gem::Specification.new do |gem|
   gem.name          = "madvertise-logging"
   gem.require_paths = ["lib"]
   gem.version       = Madvertise::Logging::VERSION
-
-  gem.add_development_dependency("bundler")
-  gem.add_development_dependency("rake")
 end

data/spec/improved_logger_spec.rb

@@ -16,6 +16,10 @@ describe ImprovedLogger do
     @logger.level = :debug
   end
 
+  it "should be an IO object" do
+    @logger.should be_a(IO)
+  end
+
   it "should have a backend logger" do
     @logger.logger.should_not be_nil
   end
@@ -26,9 +30,18 @@ describe ImprovedLogger do
     @logger.logger.should == l
   end
 
-  it "should be able to log to STDOUT as well" do
+  it "should support reopening log files" do
+    @logger.close
+
+    FileUtils.rm(@logfile)
+
+    @logger.info('Reopen')
+    @logfile.should have_received_message("Reopen")
+  end
+
+  it "should be able to log to stdout as well" do
     @logger.copy_to_stdout = true
-    STDOUT.should_receive(:puts).with(/test/)
+    $stdout.should_receive(:puts).with(/test/)
 
     @logger.debug "test"
     @logfile.should have_received_message("test")
@@ -109,15 +122,6 @@ describe ImprovedLogger do
     @logfile.should_not have_received_message("EXCEPTION:")
   end
 
-  it "should support reopening log files" do
-    @logger.close
-
-    FileUtils.rm(@logfile)
-
-    @logger.info('Reopen')
-    @logfile.should have_received_message("Reopen")
-  end
-
   it "should support silencing" do
     @logger.silence do |logger|
       logger.info "This should never be logged"
@@ -178,21 +182,14 @@ describe ImprovedLogger do
     @logfile.should_not have_received_message(token2)
   end
 
-  it "should support a buffered logger" do
-    @logger = ImprovedLogger.new(:buffer)
-    @logger.level = :debug
-    @logger.info "test"
-    @logger.buffer.should match(/test/)
-  end
-
-  it "should fall back to STDERR if logfile is not writable" do
-    STDERR.should_receive(:puts).with(/not writable.*STDERR/)
+  it "should fall back to stderr if logfile is not writable" do
+    $stderr.should_receive(:puts).with(/not writable.*stderr/)
 
     @logfile = "/not/writable/spec.log"
     @logger = ImprovedLogger.new(@logfile)
     @logger.level = :debug
 
-    STDERR.should_receive(:write).with(/test/)
+    $stderr.should_receive(:write).with(/test/)
     @logger.info "test"
   end
 
@@ -200,17 +197,138 @@ describe ImprovedLogger do
     syslogger_paths = $:.select { |p| p.match(/gems\/.*syslogger-/) }
     $:.replace($: - syslogger_paths)
 
-    STDERR.should_receive(:puts).with(/using STDERR for logging/)
-    STDERR.should_receive(:write).with(/reverting to standard logger/)
+    $stderr.should_receive(:puts).with(/using stderr for logging/)
+    $stderr.should_receive(:write).with(/reverting to standard logger/)
     @logger = ImprovedLogger.new(:syslog)
     @logger.logger.should be_instance_of(Logger)
 
     $:.replace($: + syslogger_paths)
   end
 
-  it "should support a syslog backend" do
-    @logger = ImprovedLogger.new(:syslog)
-    @logger.level = :debug
-    @logger.logger.should be_instance_of(Syslogger)
+  context "should behave like write-only IO and" do
+    it "should close on close_write" do
+      @logger.should_receive(:close)
+      @logger.close_write
+    end
+
+    it "should be in sync mode" do
+      @logger.sync.should == true
+    end
+
+    it "should return self on flush" do
+      @logger.flush.should == @logger
+    end
+
+    it "should return self on set_encoding" do
+      @logger.set_encoding.should == @logger
+    end
+
+    it "should ne be a tty" do
+      @logger.tty?.should == false
+    end
+
+    it "should support printf" do
+      @logger.printf("%.2f %s", 1.12345, "foo")
+      @logfile.should have_received_message("1.12 foo")
+    end
+
+    it "should support print" do
+      $,, old = ' ', $,
+      @logger.print("foo", "bar", 123, ["baz", 345])
+      @logfile.should have_received_message("foo bar 123 baz 345")
+      $, = old
+    end
+
+    it "should support puts" do
+      @logger.puts("a", "b")
+      @logfile.should have_received_message("b")
+      @logger.puts(["c", "d"])
+      @logfile.should have_received_message("b")
+      @logger.puts(1, 2, 3)
+      @logfile.should have_received_message("3")
+    end
+
+    it "should implement readbyte, readchar, readline" do
+      {
+        :readbyte => :getbyte,
+        :readchar => :getc,
+        :readline => :gets,
+      }.each do |m, should|
+        @logger.should_receive(should)
+        lambda {
+          @logger.send(m)
+        }.should raise_error(IOError)
+      end
+    end
+
+    it "should not implement closed?" do
+      lambda {
+        @logger.closed?
+      }.should raise_error(NotImplementedError)
+    end
+
+    it "should not implement sync=" do
+      lambda {
+        @logger.sync = false
+      }.should raise_error(NotImplementedError)
+    end
+
+    [
+      :bytes,
+      :chars,
+      :codepoints,
+      :lines,
+      :eof?,
+      :getbyte,
+      :getc,
+      :gets,
+      :pos,
+      :pos=,
+      :read,
+      :readlines,
+      :readpartial,
+      :rewind,
+      :seek,
+      :ungetbyte,
+      :ungetc
+    ].each do |m|
+      it "should raise IOError for method #{m}" do
+        lambda {
+          @logger.send(m)
+        }.should raise_error(IOError)
+      end
+    end
+  end
+
+  context "buffer backend" do
+    before(:each) do
+      @logger = ImprovedLogger.new(:buffer)
+      @logger.level = :debug
+    end
+
+    it "should support a buffered logger" do
+      @logger.info "test"
+      @logger.buffer.should match(/test/)
+    end
+
+    it "should not be in sync mode" do
+      @logger.sync.should == false
+    end
   end
+
+  context "syslog backend" do
+    before(:each) do
+      @logger = ImprovedLogger.new(:syslog)
+      @logger.level = :debug
+    end
+
+    it "should have a syslog backend" do
+      @logger.logger.should be_instance_of(Syslogger)
+    end
+
+    it "should be in sync mode" do
+      @logger.sync.should == true
+    end
+  end
+
 end

data/spec/multi_logger_spec.rb

@@ -14,13 +14,13 @@ describe MultiLogger do
     buflog = ImprovedLogger.new(:buffer)
     @ml.attach(buflog)
 
-    STDERR.should_receive(:write).with(/test1/)
+    $stderr.should_receive(:write).with(/test1/)
     @ml.info("test1")
     buflog.buffer.should match(/test1/)
 
     @ml.detach(buflog)
 
-    STDERR.should_receive(:write).with(/test2/)
+    $stderr.should_receive(:write).with(/test2/)
     @ml.info("test2")
     buflog.buffer.should_not match(/test2/)
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: madvertise-logging
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,30 +9,8 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-30 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: &17876120 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: *17876120
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: &17874940 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: *17874940
+date: 2012-04-06 00:00:00.000000000 Z
+dependencies: []
 description: Advanced logging classes with buffer backend, transactions, multi logger,
   etc
 email:
@@ -50,7 +28,9 @@ files:
 - README.md
 - Rakefile
 - lib/madvertise-logging.rb
+- lib/madvertise/logging/improved_io.rb
 - lib/madvertise/logging/improved_logger.rb
+- lib/madvertise/logging/mask.reek
 - lib/madvertise/logging/multi_logger.rb
 - lib/madvertise/logging/version.rb
 - madvertise-logging.gemspec
@@ -75,7 +55,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4131016161241756641
+      hash: 2162367042257566853
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -84,10 +64,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4131016161241756641
+      hash: 2162367042257566853
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.17
 signing_key: 
 specification_version: 3
 summary: Advanced logging classes with buffer backend, transactions, multi logger,