lll 1.2.0 → 1.3.0

data/.gitignore

@@ -1,7 +1,6 @@
+instructions
 *.sw?
 .DS_Store
 coverage
 rdoc
 pkg
-.idea
-*.gemspec

data/VERSION

@@ -1 +1 @@
-1.2.0
+1.3.0

data/lib/lll.rb

@@ -6,33 +6,38 @@
 # Enumerable members are output on separate lines
 
 def lll msg = nil, &block
-  s = " "
-  expression_string = ''
-  expression_value = 0
-  if block_given?
-    s << msg + ': ' if msg
-    expression_string = block.call
-    expression_value = eval(expression_string, block)
-    s << expression_string + ' = '
-    if expression_value.respond_to?(:each) && !expression_value.is_a?(String) && !expression_value.is_a?(Nokogiri::HTML::Document)
-      s << " \n"
-      expression_value.each { |e| s << ' ' << e.inspect << " \n" }
+  Lll.lll msg, block
+end
+
+module Lll
+  def self.lll msg, block = nil
+    output_string = " "
+    expression_value = 0
+    if block
+      output_string << msg + ': ' if msg
+      expression_string = block.call
+      expression_value = eval(expression_string, block)
+      output_string << expression_string + ' = '
+      if expression_value.respond_to?(:each) && !expression_value.is_a?(String) && !expression_value.is_a?(Nokogiri::HTML::Document)
+        output_string << " \n"
+        expression_value.each { |e| output_string << ' ' << e.inspect << " \n" }
+      else
+        output_string << expression_value.inspect << " \n"
+      end
     else
-      s << expression_value.inspect << " \n"
+      output_string << msg if msg
+      output_string << " \n"
     end
-  else
-    s << msg if msg
-    s << " \n"
-  end
 
-  reverse_video_color_code = "\e[7m"
-  reset_color_code = "\e[0m"
-  
-  s = reverse_video_color_code + s + reset_color_code
-  s << 'lll: ' + caller.first.to_s + ' ' + Time.now.strftime('%X')
+    Kernel.puts format(output_string, ENV['TERM'] != 'dumb')
+    Rails.logger.debug(format(output_string)) if defined?(Rails) && Rails.logger
 
-  Kernel.puts s
-  Rails.logger.debug s if defined?(Rails) && Rails.logger
+    expression_value
+  end
 
-  expression_value
+  def self.format output_string, colorize = true
+    string = output_string
+    string =  "\e[7m" + string + "\e[0m" if colorize
+    string + "lll: #{caller[2].to_s} #{Time.now.strftime('%X')}"
+  end
 end

data/lll.gemspec

@@ -0,0 +1,108 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{lll}
+  s.version = "1.3.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Mark Wilden"]
+  s.date = %q{2010-11-26}
+  s.description = %q{= lll
+
+lll() is used in debugging to display an expression and its value.
+
+=== Motivation
+
+One of the most basic tools in debugging is printing out the values of
+variables (or other expressions) during program execution:
+
+    puts user_name
+
+Sometimes you need to label these values so you know what they're
+referring to, especially if you're outputting a lot of them:
+
+    puts "user_name = #{message}"
+
+lll() does the labelling automatically: 
+
+    lll{'user_name'}
+
+The expression is passed as a string inside a block. It's useful to
+create a text editor macro that outputs <tt>lll{''}</tt> and leaves the
+cursor inside the apostrophes.
+
+=== Other benefits
+
+Output goes to standard output and the Rails log (if available).
+
+Output is displayed in reverse video, so it's easy to pick out from the
+log or console.
+
+lll() uses #inspect to output the expression. It outputs Enumerable
+members (except strings) on separate lines.
+
+Output is tagged with the file and line number where it appears, so
+you can easily find lll's that you forgot to take out. The time of
+day (but not the date) is also printed, so you don't waste time
+looking at old output.
+
+=== Outputting additional text
+
+Sometimes you want to include some other string, along with the label
+and value like this:
+
+    puts "After polling the queue, user_name = #{user_name}"
+
+You can pass a string to lll() to print a string:
+
+    lll("After polling the queue"){'user_name'}
+
+And because lll() outputs in reverse video, and to the Rails log, it can
+be useful to simply print a string without an expression:
+
+    lll "After read_user"
+
+=== Copyright
+
+Copyright (c) 2009 Mark Wilden. See LICENSE for details.
+}
+  s.email = %q{mark@mwilden.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "doc/README_rdoc.html",
+     "lib/lll.rb",
+     "lll.gemspec",
+     "test/test.rb"
+  ]
+  s.homepage = %q{http://github.com/mwilden/lll}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Output labeled data when debugging}
+  s.test_files = [
+    "test/test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 1
-  - 2
+  - 3
   - 0
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors: 
 - Mark Wilden
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-11 00:00:00 -07:00
+date: 2010-11-26 00:00:00 -08:00
 default_executable: 
 dependencies: []
 
@@ -95,6 +95,7 @@ files:
 - VERSION
 - doc/README_rdoc.html
 - lib/lll.rb
+- lll.gemspec
 - test/test.rb
 has_rdoc: true
 homepage: http://github.com/mwilden/lll