Module: Toffee

Defined in:
lib/toffee/toffee.rb

Constant Summary collapse

DEFAULT_TIMESTAMP_FORMAT = 
'%Y-%m-%d %H:%M:%S '

Class Method Summary collapse

Class Method Details

.clear ⇒ Object

clear the output file



102
103
104
105
106
 
# File 'lib/toffee/toffee.rb', line 102

def clear
  init_configuration
  return unless @@configuration[:target_type] == :file
  %x{echo -n > #{@@configuration[:target]}}
end

.configure(*args) ⇒ Object

Configure the output:

Toffee.configure(STDOUT) write to standard output (default) Toffee.configure(:stdout) write to standard output (default)

Toffee.configure(IO.new(2, ‘w’)) write to any object that

implements :puts

Toffee.configure(Rails.logger) write to any object that

implements :debug

Toffee.configure(Rails.logger, :info)

write to any object that
implements the second parameter

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

Raises:

  • (ArgumentError) 


44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/toffee/toffee.rb', line 44

def configure(*args)
  raise ArgumentError if args.empty?

  unless args.first.kind_of?(Hash)
    target = args.delete_at(0)
    method = args.delete_at(0) unless args.empty? || args.first.kind_of?(Hash)
    method.to_sym if method.kind_of?(String)
    raise TypeError.new("Argument two should be kind'a Symbol.") if method && !method.kind_of?(Symbol)
  end

  options = args.last || {}

  init_configuration

  if target
    @@configuration[:target_type], @@configuration[:target],
      @@configuration[:method] = if [STDOUT, :stdout].include?(target)
      [:io, STDOUT]
    elsif target.respond_to?(:puts)
      [:io, target]
    elsif target.kind_of?(String)
      raise IOError.new("Cannot write to file '#{target}'.") unless File.writable?(target) || File.writable?(File.dirname(target))
      [:file, target]
    elsif (method)
      if target.respond_to?(method)
        [:logger, target, method]
      else
        raise ArgumentError.new("Target object does not respond to method :#{method}.")
      end
    else # no method was given
      if target.respond_to?(:debug)
        [:logger, target, :debug]
      else
        raise TypeError.new("Target object does not respond to method :debug.")
      end
    end
  end

  # TODO: implement much, much more features

  # 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 :stacktrace
  
  # option :prefix, :suffix

  self
end

.init_configuration ⇒ Object

Set up the default configuration



14
15
16
 
# File 'lib/toffee/toffee.rb', line 14

def init_configuration
  @@configuration ||= {:target => STDOUT, :target_type => :io}
end

.output(string) ⇒ Object

write to STDOUT, or to the destination that was configured



109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/toffee/toffee.rb', line 109

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