toffee 0.0.1 → 0.0.2

data/README.rdoc

@@ -1,18 +1,23 @@
-= toffee
+= Toffee
+
+Candy for your "puts"-debugging!
 
 = Usage
 
-Put +.d+ (almost) anywhere in your code to print out debug information:
+Put the method call: "d" (almost) anywhere in your code to print out debug
+information:
 
   ['a', 'b', 'c'].d.first.d.upcase.d
 
 will print out:
 
-["a", "b", "c"]
-"a"
-"A"
+  ["a", "b", "c"]
+  "a"
+  "A"
+
+"d" always returns self, so it will not interfere or do any harm.
 
-= Configure the output (optional)
+== Configure the output (optional)
 
 Write to standard output (default):
 
@@ -23,19 +28,19 @@ or
   Toffee.configure(:stdout)
 
 
-Write to any object that implements +:puts+:
+Write to any object that implements ":puts":
 
   Toffee.configure(IO.new(2, 'w'))
 
 
-Write to any object that implements +:debug+:
+Write to any object that implements ":debug":
 
   Toffee.configure(Rails.logger)
 
 
 Write to any object that implements the second parameter:
 
-Toffee.configure(Rails.logger, :info)
+  Toffee.configure(Rails.logger, :info)
 
 
 Write to file using the shell command:
@@ -44,10 +49,14 @@ Write to file using the shell command:
 
   Toffee.configure('/tmp/foo.log')
 
+== Options
+
+:timestamp Turn on timestamps with true, turn if off with nil or false; to use
+a custom timestamp format, pass a string with a Time.strftime kind of format
 
 == Copyright
 
 Copyright (c) 2010 Christoph Petschnig. See LICENSE for details.
 
-Inspiration and part of the code taken from
+Inspiration and parts of the code taken from
 Jan Lelis (http://github.com/janlelis/zucker)

data/lib/toffee/d.rb

@@ -9,7 +9,6 @@ module Kernel
   # TODO: check, if there is already a method named d
   # show a warning in that case!
 
-  #def d(*args, &block)
   def d(*args)
     if args.empty?
       tap do

data/lib/toffee/toffee.rb

@@ -1,5 +1,7 @@
 module Toffee
 
+  DEFAULT_TIMESTAMP_FORMAT = '%Y-%m-%d %H:%M:%S '
+
   # There are several ways, where debugging output can be directed to:
   # STDOUT, :stdout     Standard out is the default destination
   # Any other Object that responds to :puts
@@ -31,6 +33,14 @@ module Toffee
     # Toffee.configure('/tmp/foo.log')  write to file using the shell command:
     #                                   $ echo "my output here" > /tmp/foo.log
     #
+    # Hash with options:
+    #
+    # :timestamp                        prepend a timestamp on each log message
+    #                                   use true to turn logging on; turn it off
+    #                                   by passing nil or false; pass a string
+    #                                   value to supply a custom format (like
+    #                                   with Time.strftime); default is true
+    #
     def configure(*args)
       raise ArgumentError if args.empty?
 
@@ -41,7 +51,7 @@ module Toffee
         raise TypeError.new("Argument two should be kind'a Symbol.") if method && !method.kind_of?(Symbol)
       end
 
-      options = args.last
+      options = args.last || {}
 
       init_configuration
 
@@ -58,7 +68,7 @@ module Toffee
           if target.respond_to?(method)
             [:logger, target, method]
           else
-            raise TypeError.new("Target object does not respond to method :#{method}.")
+            raise ArgumentError.new("Target object does not respond to method :#{method}.")
           end
         else # no method was given
           if target.respond_to?(:debug)
@@ -71,10 +81,20 @@ module Toffee
 
       # TODO: implement much, much more features
 
-      # option :with_timestamp
+      # option :timestamp
+      if options.key?(:timestamp)
+        timestamp = options.delete(:timestamp)
+        @@configuration[:timestamp] = timestamp
+        @@configuration[:timestamp_format] = timestamp if timestamp.kind_of?(String)
+      end
+
+
+      # option :with_file_position
 
-      # option :with_backtrace
+      # option :stacktrace
       
+      # option :prefix, :suffix
+
       self
     end
 
@@ -88,12 +108,21 @@ module Toffee
     # write to STDOUT, or to the destination that was configured
     def output(string)
       init_configuration
+
+      string = prepend_timestamp(string) if @@configuration[:timestamp]
+      
       case @@configuration[:target_type]
       when :io then @@configuration[:target].puts(string)
       when :file then %x{echo "#{string.gsub('"', '\\"')}" >> #{@@configuration[:target]}}
       when :logger then @@configuration[:target].send(@@configuration[:method], string)
       end
     end
+
+    private
+
+    def prepend_timestamp(string)
+      Time.new.strftime(@@configuration[:timestamp_format] || DEFAULT_TIMESTAMP_FORMAT) << string
+    end
     
   end
 

data/spec/spec_helper.rb

@@ -7,3 +7,14 @@ require 'spec/autorun'
 Spec::Runner.configure do |config|
   
 end
+
+class SpecLogger
+  attr_reader :output
+  def test_log(output)
+    @output ||= []
+    @output << output
+  end
+  def clear_log
+    @output = []
+  end
+end

data/spec/test-apps/STDOUT_app.rb

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+$:.unshift(File.join(File.dirname(__FILE__), "..", "..", "lib"))
+
+require 'toffee'
+
+Toffee.configure STDOUT
+
+('x'.d * 3.d).d
+

data/spec/test-apps/all_defaults_app.rb

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+# Test: don't set any configuration properties, only use defaults
+
+$:.unshift(File.join(File.dirname(__FILE__), "..", "..", "lib"))
+
+require 'toffee'
+
+('x'.d * 3.d).d
+

data/spec/test-apps/stdout_symbol_app.rb

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+$:.unshift(File.join(File.dirname(__FILE__), "..", "..", "lib"))
+
+require 'toffee'
+
+Toffee.configure :stdout
+
+('x'.d * 3.d).d
+

data/spec/toffee_spec.rb

@@ -1,7 +1,101 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
+require 'logger'
+
 describe "Toffee" do
-  it "fails" do
-    fail "hey buddy, you should probably rename this file and start specing for real"
+
+  before :all do
+    @log_obj = Logger.new(STDOUT)
+    @spec_logger = SpecLogger.new
   end
+
+  it "configure does some checks on its arguments" do
+    # check argument must be given
+    lambda {Toffee.configure}.should raise_exception ArgumentError
+
+    # second argument must be a Symbol or Hash
+    lambda {Toffee.configure(:foo, Time)}.should raise_exception TypeError
+    lambda {Toffee.configure(@log_obj, :error)}.should_not raise_exception
+    # will result in logging to :debug
+    lambda {Toffee.configure(@log_obj, :a => 1)}.should_not raise_exception
+
+    # try to log to write protected file
+    lambda {Toffee.configure('/etc/oh-no-this-must-not-work.log')}.should raise_exception IOError
+
+    # method must be valid
+    lambda {Toffee.configure(@log_obj, :foo)}.should raise_exception ArgumentError
+
+    # test for default :debug method
+    lambda {Toffee.configure(Time)}.should raise_exception TypeError
+  end
+
+  it "writes to STDOUT, when no configuration was made" do
+    %x{#{File.join(File.dirname(__FILE__), 'test-apps/all_defaults_app.rb')}}.should == %{"x"\n3\n"xxx"\n}
+  end
+
+  it "accepts various configurations for STDOUT" do
+    %x{#{File.join(File.dirname(__FILE__), 'test-apps/all_defaults_app.rb')}}.should == %{"x"\n3\n"xxx"\n}
+    %x{#{File.join(File.dirname(__FILE__), 'test-apps/STDOUT_app.rb')}}.should == %{"x"\n3\n"xxx"\n}
+    %x{#{File.join(File.dirname(__FILE__), 'test-apps/stdout_symbol_app.rb')}}.should == %{"x"\n3\n"xxx"\n}
+  end
+
+  it "works with any object that implements a 'puts' method" do
+
+  end
+
+  it "writes to a file when configured with a string value" do
+    
+  end
+
+  it "writes to an object with an arbitrary method name" do
+
+  end
+
+  it "writes to any object with a 'debug' method" do
+
+  end
+
+  it "truncates a file to zero length with the 'clear' method" do
+
+  end
+
+  it "writes timestamps when configured to do so" do
+    # turn off timestamping by passing nil
+    Toffee.configure @spec_logger, :test_log, :timestamp => nil
+    'foo'.d
+    @spec_logger.output.last.should == '"foo"'
+
+    # turn on timestamp and use the default format
+    Toffee.configure :timestamp => true
+    'foo'.d
+    time_result = Time.utc(*@spec_logger.output.last[0..(Toffee::DEFAULT_TIMESTAMP_FORMAT.size)].gsub(/[: ]/, '-').split('-'))
+    # there should not be more than half a second in between
+    (Time.new - time_result).should < 0.5
+
+
+    # turn off timestamping passing false
+    Toffee.configure :timestamp => false
+    'foo'.d
+    @spec_logger.output.last.should == '"foo"'
+
+
+    # turn on timestamp and use the default format
+    Toffee.configure :timestamp => '[%Y|%m|%d|%H|%M|%S] '
+    'foo'.d
+    time_result = Time.utc(*@spec_logger.output.last[1..20].split('|'))
+    # there should not be more than half a second in between
+    (Time.new - time_result).should < 0.5
+
+    Toffee.configure :timestamp => false
+    @spec_logger.clear_log
+  end
+
+  it "can compute multiple calls to 'configure'" do
+
+  end
+
+  it "gives correct file position and call stack output" do
+
+  end
+
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: toffee
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: false
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Christoph Petschnig
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-06 00:00:00 +02:00
+date: 2010-08-16 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -50,6 +50,9 @@ files:
 - LICENSE
 - README.rdoc
 - spec/spec_helper.rb
+- spec/test-apps/all_defaults_app.rb
+- spec/test-apps/STDOUT_app.rb
+- spec/test-apps/stdout_symbol_app.rb
 - spec/toffee_spec.rb
 has_rdoc: true
 homepage: http://github.com/cpetschnig/toffee
@@ -87,4 +90,7 @@ specification_version: 3
 summary: Give "puts"-debugging some candy
 test_files: 
 - spec/spec_helper.rb
+- spec/test-apps/all_defaults_app.rb
+- spec/test-apps/STDOUT_app.rb
+- spec/test-apps/stdout_symbol_app.rb
 - spec/toffee_spec.rb