toffee 0.0.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Christoph Petschnig
+
+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.rdoc

@@ -0,0 +1,53 @@
+= toffee
+
+= Usage
+
+Put +.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"
+
+= Configure the output (optional)
+
+Write to standard output (default):
+
+  Toffee.configure(STDOUT)
+
+or
+
+  Toffee.configure(:stdout)
+
+
+Write to any object that implements +:puts+:
+
+  Toffee.configure(IO.new(2, 'w'))
+
+
+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)
+
+
+Write to file using the shell command:
+
+  $ echo "my output here" > /tmp/foo.log
+
+  Toffee.configure('/tmp/foo.log')
+
+
+== Copyright
+
+Copyright (c) 2010 Christoph Petschnig. See LICENSE for details.
+
+Inspiration and part of the code taken from
+Jan Lelis (http://github.com/janlelis/zucker)

data/lib/toffee/d.rb

@@ -0,0 +1,24 @@
+# This part was very much inspired by Jan Lelis and his talk at RUG-B on
+# August 5th, 2010
+# Find his code at http://github.com/janlelis/zucker/blob/master/lib/zucker/D.rb
+
+# Copyright (c) 2010 Jan Lelis
+
+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
+        Toffee.output(block_given? ? yield(self) : self.inspect)
+      end
+    else
+      raise ArgumentError, "Toffee: .d - The parser thought that the code after .d are method arguments... Please don't put a space after d or use .d() or .d{} in this case!"
+#      eval ...
+    end
+  end
+
+end

data/lib/toffee/toffee.rb

@@ -0,0 +1,100 @@
+module Toffee
+
+  # 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
+  # A filename; append to this file using system command `echo "foo" >> /tmp/my-file
+  # A logger object, that responds to the second argument
+
+  class << self
+
+    # Set up the default configuration
+    def init_configuration
+      @@configuration ||= {:target => STDOUT, :target_type => :io}
+    end
+
+    # 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
+    #
+    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 TypeError.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 :with_timestamp
+
+      # option :with_backtrace
+      
+      self
+    end
+
+    # clear the output file
+    def clear
+      init_configuration
+      return unless @@configuration[:target_type] == :file
+      %x{echo -n > #{@@configuration[:target]}}
+    end
+
+    # write to STDOUT, or to the destination that was configured
+    def output(string)
+      init_configuration
+      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
+    
+  end
+
+end

data/lib/toffee.rb

@@ -0,0 +1,2 @@
+require 'toffee/toffee'
+require 'toffee/d'

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'toffee'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

data/spec/toffee_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Toffee" do
+  it "fails" do
+    fail "hey buddy, you should probably rename this file and start specing for real"
+  end
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification 
+name: toffee
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Christoph Petschnig
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-06 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+description: Debugging convenience for your ruby application
+email: info@purevirtual.de
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- lib/toffee.rb
+- lib/toffee/d.rb
+- lib/toffee/toffee.rb
+- LICENSE
+- README.rdoc
+- spec/spec_helper.rb
+- spec/toffee_spec.rb
+has_rdoc: true
+homepage: http://github.com/cpetschnig/toffee
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Give "puts"-debugging some candy
+test_files: 
+- spec/spec_helper.rb
+- spec/toffee_spec.rb