logsaber 0.0.1 → 1.0.0

data/.rvmrc

@@ -0,0 +1 @@
+rvm --create ruby-1.9.3-p385@logsaber

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 1.9.2
+  - rbx-19mode
+  - ruby-head
+script: bundle exec ruby spec/log_spec.rb
+before_install:
+  - gem update bundler
+before_script:
+  - bundle exec gem list

data/README.markdown

@@ -3,10 +3,17 @@ Logsaber
 
 A logger for a more civilized age.
 
-Philosophy/Why Logsaber?
--------------------------
+- Edge Logsaber   README: https://github.com/acook/logsaber#readme
+- Release version README: http://rubydoc.info/gems/logsaber/file/README.markdown
 
-Logsaber is a lot like Ruby's built in Logger class,
+[![Build Status](https://travis-ci.org/acook/logsaber.png?branch=master)](https://travis-ci.org/acook/logsaber)
+[![Code Climate](https://codeclimate.com/github/acook/logsaber.png)](https://codeclimate.com/github/acook/logsaber)
+[![Dependency Status](https://gemnasium.com/acook/logsaber.png)](https://gemnasium.com/acook/logsaber)
+
+Philosophy / Why Logsaber?
+--------------------------
+
+Logsaber is a lot like Ruby's built in [Logger](http://www.ruby-doc.org/stdlib-1.9.3/libdoc/logger/rdoc/Logger.html) class,
 but it is based on the real world experience of how I actually use loggers.
 
 The biggest difference is Logsaber's intelligent output.
@@ -51,40 +58,59 @@ end
 ...Logsaber will intelligently evaluate it and format your output sanely:
 
 ```
-2013-03-02 21:20:04.715 [ INFO] 32981 | heavy : \"this could be resource intensive\" | 9999
+2013-03-02 21:20:04.715 [ INFO] 32981 | heavy : "this could be resource intensive" | 9999
 ```
 
-Also, since blocks are lazy loaded, they won't be evaluated at all if the severity is below the log level threshold, this is really important if your debug output is resource intensive.
+Also, since blocks are lazy loaded, they won't be evaluated at all if the severity is below the log level threshold,
+this is really important if your debug output is resource intensive.
 
 ### Ruby Logger Limitations Surpassed
 
 There's also some complaints about the native Logger than I address:
 
-1. You can't specify the log level on instantiation
-  - Logsaber lets you set the log level when you create it:
-    `$log = Logsaber.create file, :warn`
-  - But you can still change the default later:
-    `$log.level = :info`
-2. You must specify the "progname" for every event
-  - Logsaber lets you set the app name when you create it:
-    `$log = Logsaber.create file, :warn, 'MyApp'`
-  - Or change it to something else at any time:
-    `$log.appname = 'SomethingElse'`
+1. You can't specify the log level on instantiation.
 
-Installation
-------------
+  Logsaber lets you set the log level when you create it:
+
+  ```ruby
+  $log = Logsaber.create level: :warn
+  ```
+
+  But you can still change the default later:
 
-Add this line to your application's Gemfile:
+  ```ruby
+  $log.level = :info
+  ```
 
-    gem 'logomatic'
+2. You must specify the "progname" for every event.
 
-And then execute:
+  Logsaber lets you set your app's name when you create it:
 
-    $ bundle
+  ```ruby
+  $log = Logsaber.create appname: 'MyApp'
+  ```
+
+  Or change it to something else at any time:
+
+  ```ruby
+  $log.appname = 'SomethingElse'
+  ```
+
+  ...and the output will look like this:
+
+  ```
+  2013-03-03 16:50:43.595 [ INFO] SomethingElse:8881 | MSG : ohai
+  ```
+
+Installation
+------------
 
-Or install it yourself as:
+Use [Bundler](http://gembundler.com):
 
-    $ gem install logomatic
+```ruby
+# in your Gemfile
+gem 'logsaber'
+```
 
 Setup
 -----
@@ -95,13 +121,13 @@ Give it a filename and it will log to a file:
 $log = Logsaber.create './log/my_app.log'
 ```
 
-Give it an IO and it will log to it:
+Or you log to an IO (`$stdout` is the default, good for debugging):
 
 ```ruby
 $log = Logsaber.create $stdout
 ```
 
-Even give it a StringIO and it will log to that:
+It can even log to a StringIO (good for test environments):
 
 ```ruby
 require 'stringio'
@@ -110,16 +136,22 @@ stringio = StringIO.create
 $log = Logsaber.create stringio
 ```
 
-You can also set the log level on initialization (it's :info by default):
+You can also set the log level on initialization (it's `:info` by default):
+
+```ruby
+$log = Logsaber.create level: :debug
+```
+
+And you can optionally specify the name of your app (which is `nil` by default, it's displayed next to the pid in the output):
 
 ```ruby
-$log = Logsaber.create $stdout, :debug
+$log = Logsaber.create appname: 'MyApp'
 ```
 
-And you can optionally specify a program name:
+Example with all options:
 
 ```ruby
-$log = Logsaber.create $stdout, :info, 'MyApp'
+Logsaber.create 'my_app.log', level: :debug, appname: 'MyApp'
 ```
 
 Usage
@@ -135,12 +167,20 @@ like this:
 $log.warn 'Something might be amiss here'
 ```
 
-or this:
+or like this:
 
 ```ruby
 $log.error 'PEBKAC', @user
 ```
 
+or maybe:
+
+```ruby
+@log.debug "What is this I don't even." do
+  big_data.inspect
+end
+```
+
 Contributing
 ------------
 

data/lib/logsaber.rb

@@ -1,100 +1,11 @@
 require 'logsaber/version'
-
-class Logsaber
-  def self.create new_output = $stdout, new_level = :info, new_appname = nil
-    log = self.new
-
-    log.output =
-      if new_output.is_a? String then
-        File.new new_output, 'a'
-      else
-        new_output
-      end
-
-    log.level = new_level
-    log.appname = new_appname
-
-    log
-  end
-  attr_accessor :output, :level, :appname, :time_format
-
-  DEFAULT_TIME_FORMAT ||= '%Y-%m-%d %H:%M:%S.%L'
-  SEVERITY_LEVELS ||= [:debug, :info, :warn, :error, :fatal]
-
-  SEVERITY_LEVELS.each do |method_name|
-    eval <<-END_OF_METHOD
-      def #{method_name} *args, &block
-        log :#{method_name}, *args, &block
-      end
-    END_OF_METHOD
-  end
-
-  def level= new_level
-    @level = new_level if SEVERITY_LEVELS.include? new_level
-  end
-
-  def time_format
-    @time_format ||= DEFAULT_TIME_FORMAT
-  end
-
-  protected
-
-  def log severity, *details
-    return unless loggable? severity
-    label, info, object = extract_details details, block_given?
-
-    if block_given? then
-      result = yield
-
-      info << ' | ' unless info.empty?
-      info << result.to_s
-
-      object = result
-    end
-
-    message = format severity, "#{label} : #{info}"
-    output.puts message
-    output.flush
-
-    object
-  end
-
-  def extract_details details, given_block
-    primary, secondary, object = details
-
-    if details.length == 2 then
-      [primary.to_s, secondary.inspect, object || secondary]
-    elsif given_block then
-      [primary, secondary.to_s, object]
-    elsif [String, Numeric].any?{|klass| primary.is_a? klass} then
-      ['MSG', primary, object || primary]
-    else
-      ['OBJ', primary.to_s, object || primary]
-    end
-  end
-
-  def loggable? severity
-    SEVERITY_LEVELS.index(severity) >= SEVERITY_LEVELS.index(level)
-  end
-
-  def format severity, contents
-    %Q{#{timestamp} [#{severity_info severity}] #{process_info} | #{contents}}
-  end
-
-  def process_info
-    pid = Process.pid.to_s
-    appname? ? "#{appname}:#{pid}" : pid
-  end
-
-  def severity_info severity
-    severity.to_s.upcase.rjust 5
-  end
-
-  def timestamp
-    Time.now.strftime time_format
-  end
-
-  def appname?
-    !!@appname
+require 'logsaber/formatter'
+require 'logsaber/log'
+require 'logsaber/options'
+require 'logsaber/entry'
+
+module Logsaber
+  def self.create *args, &block
+    Log.create *args, &block
   end
 end

data/lib/logsaber/entry.rb

@@ -0,0 +1,66 @@
+module Logsaber
+  class Entry
+    def self.create all_details, &block
+      all_details << block.call if block
+      new all_details.length, all_details.shift, Array(all_details)
+    end
+
+    def initialize length, primary, secondary
+      @length, @primary, @secondary = length, primary, secondary
+    end
+    attr :length, :primary, :secondary
+
+    def parse
+      [text, value]
+    end
+
+    protected
+
+    def value
+      secondary.last || primary
+    end
+
+    def text
+      "#{label} : #{info}"
+    end
+
+    def label
+      if !secondary.empty? then
+        view primary
+      elsif primary.is_a? String then
+        'MSG'
+      else
+        'OBJ'
+      end
+    end
+
+    def info
+      if secondary.empty? then
+        view primary
+      else
+        details
+      end
+    end
+
+    def details
+      secondary.map{|item| analyze item }.join ' | '
+    end
+
+    def view object
+      viewable?(object) ? object.to_s : object.inspect
+    end
+
+    def analyze object
+      analyzeable?(object) ? object : object.inspect
+    end
+
+    def viewable? object
+      object && (analyzeable?(object) || object.is_a?(Symbol))
+    end
+
+    def analyzeable? object
+      object.is_a?(String) && !object.empty?
+    end
+
+  end
+end

data/lib/logsaber/formatter.rb

@@ -0,0 +1,63 @@
+module Logsaber
+  class Formatter
+    DEFAULT_TIME_FORMAT ||= '%Y-%m-%d %H:%M:%S.%L'
+
+    def initialize color = nil
+      @color = color
+    end
+    attr_accessor :time_format, :log, :color
+
+    def set_log new_log
+      self.log = new_log
+      self
+    end
+
+    def time_format
+      @time_format ||= DEFAULT_TIME_FORMAT
+    end
+
+    def color!
+      @color = SimpleColor.new
+    end
+
+    def color?
+      !!@color
+    end
+
+    def format severity, contents
+      index = log.class::SEVERITY_LEVELS.index(severity)
+      text  = layout severity, contents
+
+      if color? then
+        color.colorize index, text
+      else
+        text
+      end
+    end
+
+    def layout severity, contents
+      %(#{timestamp} [#{severity_info severity}] #{process_info} | #{contents})
+    end
+
+    def timestamp
+      Time.now.strftime time_format
+    end
+
+    def severity_info severity
+      severity.to_s.upcase.rjust 5
+    end
+
+    def process_info
+      pid = Process.pid.to_s
+      appname? ? "#{appname}:#{pid}" : pid
+    end
+
+    def appname?
+      !!appname
+    end
+
+    def appname
+      log.appname
+    end
+  end
+end

data/lib/logsaber/log.rb

@@ -0,0 +1,75 @@
+module Logsaber
+  class Log
+    class << self
+      def create *args
+        default_options = {
+          output: $stdout,
+          level: :info,
+          appname: nil,
+          formatter: Logsaber::Formatter.new
+        }
+        options = Options.extract_from args, default_options, :output
+
+        self.new *options
+      end
+    end
+
+    SEVERITY_LEVELS ||= [:debug, :info, :warn, :error, :fatal, :off]
+
+    def initialize output, level, appname, formatter
+      @output    = outputize output
+      @level     = level.to_sym
+      @appname   = appname
+      @formatter = formatter.set_log self
+
+      unless SEVERITY_LEVELS.include? @level then
+        raise "Invalid level: #{level.inspect}.\nUse one of: #{SEVERITY_LEVELS}"
+      end
+    end
+
+    attr_accessor :output, :level, :appname, :formatter
+
+    SEVERITY_LEVELS.each do |method_name|
+      next if method_name == :off
+
+      eval <<-END_OF_METHOD
+        def #{method_name} *args, &block
+          log :#{method_name}, *args, &block
+        end
+      END_OF_METHOD
+    end
+
+    protected
+
+    def log severity, *details, &block
+      return unless loggable? severity
+      message, object = Entry.create(details, &block).parse
+
+      out format(severity, message)
+      object
+    end
+
+    def out text
+      output.puts text
+      output.flush
+    end
+
+    def format *args
+      formatter.format *args
+    end
+
+    def loggable? severity
+      SEVERITY_LEVELS.index(severity) >= SEVERITY_LEVELS.index(level)
+    end
+
+    def outputize new_output
+      if new_output.is_a? String then
+        File.new new_output, 'a'
+      elsif new_output.respond_to? :puts then
+        new_output
+      else
+        raise "invalid output object: #{new_output.inspect}"
+      end
+    end
+  end
+end

data/lib/logsaber/options.rb

@@ -0,0 +1,15 @@
+module Logsaber
+  class Options < OpenStruct
+    def self.extract_from args, defaults = {}, primary = nil
+      options = args.last.is_a?(Hash) ? args.pop : Hash.new
+      options[primary] = args.shift if primary && args.first
+
+      new defaults.merge(options)
+    end
+
+    def to_a
+      @table.values
+    end
+    alias_method :to_ary, :to_a
+  end
+end

data/lib/logsaber/simple_color.rb

@@ -0,0 +1,21 @@
+module Logsaber
+  class SimpleColor
+    attr_accessor colors
+
+    def colorize index, text = nil, &block
+      "#{color index}#{text || yield}#{esc 0}"
+    end
+
+    def color index
+      esc colors[index]
+    end
+
+    def colors
+      @colors = [31, 0, 33, 31, '31;1']
+    end
+
+    def esc seq
+      "\e[#{seq}m"
+    end
+  end
+end

data/lib/logsaber/version.rb

@@ -1,3 +1,3 @@
-class Logsaber
-  VERSION = "0.0.1"
+module Logsaber
+  VERSION = "1.0.0"
 end

data/spec/{logsaber_spec.rb → log_spec.rb}

@@ -72,11 +72,11 @@ spec 'basic usage' do
   @output.string.include? format('MSG', test_string)
 end
 
-spec ' with details usage' do
+spec 'with details usage' do
   clear_log
 
   @log.info :test_string, test_string
-  @output.string.include? format(:test_string, test_string.inspect)
+  @output.string.include? format(:test_string, test_string)
 end
 
 spec 'object usage' do
@@ -102,6 +102,50 @@ spec 'block with details usage' do
   @log.info 'label', 'details' do
     'block'
   end
-  @output.string.include?(format('label', '"details" | block')) || @output.string
+  @output.string.include?(format('label', 'details | block')) || @output.string
 end
 
+spec 'accepts appname during creation' do
+  clear_log
+
+  log = Logsaber.create output: @output, appname: 'MyAwesomeApp'
+
+  log.info 'ohai'
+  @output.string.include?("[ INFO] MyAwesomeApp:#{Process.pid} | MSG : ohai") || @output.string
+end
+
+spec 'setting level to :off will prevent any logging' do
+  output = capture do
+    log = Logsaber.create level: :off
+
+    log.debug 'debug'
+    log.info 'info'
+    log.warn 'warn'
+    log.error 'error'
+    log.fatal 'fatal'
+  end
+
+  output.empty? || output
+end
+
+spec 'there is no "off" method' do
+  !@log.respond_to? :off
+end
+
+spec 'timestamp format is mutable' do
+  clear_log
+
+  @log.formatter.time_format = 'xxx%Yxxx'
+  @log.info test_string
+  @log.formatter.time_format = Logsaber::Formatter::DEFAULT_TIME_FORMAT
+
+  match = @output.string.match /(xxx\d\d\d\dxxx) (#{Regexp.escape format('MSG', test_string)})/
+  !match[0].nil? && !match[1].nil? || match rescue @output.string
+end
+
+spec 'Log#log allows many items' do
+  clear_log
+
+  @log.info :foo, '1', '2', '3'
+  @output.string.include? format('foo', '1 | 2 | 3')
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: logsaber
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-04 00:00:00.000000000 Z
+date: 2013-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: uspec
@@ -35,14 +35,21 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rvmrc
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.markdown
 - Rakefile
 - lib/logsaber.rb
+- lib/logsaber/entry.rb
+- lib/logsaber/formatter.rb
+- lib/logsaber/log.rb
+- lib/logsaber/options.rb
+- lib/logsaber/simple_color.rb
 - lib/logsaber/version.rb
 - logsaber.gemspec
-- spec/logsaber_spec.rb
+- spec/log_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/acook/logsaber
 licenses: []
@@ -69,6 +76,5 @@ signing_key:
 specification_version: 3
 summary: A logger for a more civilized age.
 test_files:
-- spec/logsaber_spec.rb
+- spec/log_spec.rb
 - spec/spec_helper.rb
-has_rdoc: