logsaber 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in logomatic.gemspec
+gemspec
+
+group :development, :test do
+  gem 'pry'
+  gem 'pry-theme'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Anthony Cook
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -0,0 +1,156 @@
+Logsaber
+=========
+
+A logger for a more civilized age.
+
+Philosophy/Why Logsaber?
+-------------------------
+
+Logsaber is a lot like Ruby's built in Logger class,
+but it is based on the real world experience of how I actually use loggers.
+
+The biggest difference is Logsaber's intelligent output.
+
+### Intelligent Logging
+
+If you pass a single string argument to an event method Logsaber will just log that string without any frills.
+
+But if you pass it an object like an Array:
+
+```ruby
+array = [1,2,3]
+$log.info array
+```
+
+...it will inspect the array and the output will reflect the intent:
+
+```
+2013-03-02 21:08:30.797 [ INFO] 32981 | OBJ : [1, 2, 3]
+```
+
+Even better, if you pass in two arguments, like this:
+
+```ruby
+$log.info 'using environment', ENV['MYAPP_ENV']
+```
+
+...the first will be treated as a label, and the second as an object to be inspected:
+
+```
+2013-03-02 20:11:22.630 [ INFO] 31395 | using environment : development
+```
+
+If you pass in a block:
+
+```ruby
+@log.info :heavy, 'this could be resource intensive' do
+  10000.times.to_a.last
+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
+```
+
+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'`
+
+Installation
+------------
+
+Add this line to your application's Gemfile:
+
+    gem 'logomatic'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install logomatic
+
+Setup
+-----
+
+Give it a filename and it will log to a file:
+
+```ruby
+$log = Logsaber.create './log/my_app.log'
+```
+
+Give it an IO and it will log to it:
+
+```ruby
+$log = Logsaber.create $stdout
+```
+
+Even give it a StringIO and it will log to that:
+
+```ruby
+require 'stringio'
+stringio = StringIO.create
+
+$log = Logsaber.create stringio
+```
+
+You can also set the log level on initialization (it's :info by default):
+
+```ruby
+$log = Logsaber.create $stdout, :debug
+```
+
+And you can optionally specify a program name:
+
+```ruby
+$log = Logsaber.create $stdout, :info, 'MyApp'
+```
+
+Usage
+-----
+
+Then you can use any of the logging commands:
+
+`debug`, `info`, `warn`, `error`, or `fatal`
+
+like this:
+
+```ruby
+$log.warn 'Something might be amiss here'
+```
+
+or this:
+
+```ruby
+$log.error 'PEBKAC', @user
+```
+
+Contributing
+------------
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+Author
+======
+
+    Anthony M. Cook 2013

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/logsaber/version.rb

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

data/lib/logsaber.rb

@@ -0,0 +1,100 @@
+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
+  end
+end

data/logsaber.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'logsaber/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "logsaber"
+  gem.version       = Logsaber::VERSION
+  gem.authors       = ["Anthony Cook"]
+  gem.email         = ["anthonymichaelcook@gmail.com"]
+  gem.description   = %q{A logger for a more civilized age. Intelligent logs for your applications.}
+  gem.summary       = %q{A logger for a more civilized age.}
+  gem.homepage      = "http://github.com/acook/logsaber"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency 'uspec'
+end

data/spec/logsaber_spec.rb

@@ -0,0 +1,107 @@
+require_relative 'spec_helper'
+
+test_string = 'foo'
+
+spec 'will output to a file, given a filename' do
+  filename = './test_file.log'
+  begin
+    File.delete filename
+  rescue Errno::ENOENT => e
+    # ignore if file doesn't exist
+  end
+
+  log = Logsaber.create filename
+  log.info test_string
+
+  contents = File.open(filename, 'r').gets
+  contents.include?(test_string).tap{File.delete filename}
+end
+
+require 'stringio'
+spec 'can use a StringIO' do
+  stringio = StringIO.new
+
+  log = Logsaber.create stringio
+  log.info test_string
+
+  stringio.string.include? test_string
+end
+
+spec 'can use an IO' do
+  output = capture do
+    log = Logsaber.create $stdout
+    log.info test_string
+  end
+
+  output.include?(test_string) || output
+end
+
+@log = Logsaber.create
+
+spec 'has shortcut methods' do
+  methods = [:debug, :info, :warn, :error, :fatal]
+  has = methods.map do |m|
+    @log.respond_to?(m) && m
+  end
+
+  has.all? || methods - has
+end
+
+spec 'can tell you the current minimum log level' do
+  @log.level == :info || @log.level
+end
+
+
+@output = StringIO.new
+@log = Logsaber.create @output
+
+def self.clear_log
+  @output.truncate 0
+  @output.rewind
+end
+
+def format label, info
+  "[ INFO] #{Process.pid} | #{label} : #{info}"
+end
+
+
+spec 'basic usage' do
+  clear_log
+
+  @log.info test_string
+  @output.string.include? format('MSG', test_string)
+end
+
+spec ' with details usage' do
+  clear_log
+
+  @log.info :test_string, test_string
+  @output.string.include? format(:test_string, test_string.inspect)
+end
+
+spec 'object usage' do
+  clear_log
+
+  array = [1,2,3]
+  @log.info array
+  @output.string.include? format('OBJ', array.inspect)
+end
+
+spec 'basic block usage' do
+  clear_log
+
+  @log.info 'label' do
+    'block'
+  end
+  @output.string.include?(format('label', 'block')) || @output.string
+end
+
+spec 'block with details usage' do
+  clear_log
+
+  @log.info 'label', 'details' do
+    'block'
+  end
+  @output.string.include?(format('label', '"details" | block')) || @output.string
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,27 @@
+require 'bundler/setup'
+
+Bundler.require :development, :test
+
+require 'uspec'
+
+Dir.chdir File.dirname(__FILE__)
+
+require_relative '../lib/logsaber'
+
+extend Uspec
+
+def self.capture
+  readme, writeme = IO.pipe
+  pid = fork do
+    $stdout.reopen writeme
+    readme.close
+
+    yield
+  end
+
+  writeme.close
+  output = readme.read
+  Process.waitpid(pid)
+
+  output
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: logsaber
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Anthony Cook
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: uspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A logger for a more civilized age. Intelligent logs for your applications.
+email:
+- anthonymichaelcook@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.markdown
+- Rakefile
+- lib/logsaber.rb
+- lib/logsaber/version.rb
+- logsaber.gemspec
+- spec/logsaber_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/acook/logsaber
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: A logger for a more civilized age.
+test_files:
+- spec/logsaber_spec.rb
+- spec/spec_helper.rb
+has_rdoc: