RubyGems - lll - Versions diffs - 1.0.0 - Mend

lll 1.0.0

Files changed (9) hide show

data/.document ADDED

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore ADDED

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE ADDED

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Mark Wilden
+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 ADDED

@@ -0,0 +1,58 @@
+= 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.

data/Rakefile ADDED

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'rake'
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "lll"
+    gem.summary = %Q{Output labeled data when debugging}
+    gem.email = "mark@mwilden.com"
+    gem.homepage = "http://github.com/mwilden/lll"
+    gem.authors = ["Mark Wilden"]
+    gem.description = File.read(File.join(File.dirname(__FILE__),'README.rdoc'))
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end

data/VERSION ADDED

	@@ -0,0 +1 @@
1	+ 1.0.0

data/doc/README_rdoc.html ADDED

@@ -0,0 +1,139 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+	"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+	<meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
+	<title>File: README.rdoc [RDoc Documentation]</title>
+	<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet" />
+	<script src="./js/jquery.js" type="text/javascript"
+		charset="utf-8"></script>
+	<script src="./js/thickbox-compressed.js" type="text/javascript"
+		charset="utf-8"></script>
+	<script src="./js/quicksearch.js" type="text/javascript"
+		charset="utf-8"></script>
+	<script src="./js/darkfish.js" type="text/javascript"
+		charset="utf-8"></script>
+</head>
+<body class="file">
+	<div id="metadata">
+		<div id="project-metadata">
+			<div id="fileindex-section" class="section project-section">
+				<h3 class="section-header">Files</h3>
+				<ul>
+					<li class="file"><a href="./README_rdoc.html">README.rdoc</a></li>
+				</ul>
+			</div>
+			<div id="classindex-section" class="section project-section">
+				<h3 class="section-header">Class Index
+					<span class="search-toggle"><img src="./images/find.png"
+						height="16" width="16" alt="[+]"
+						title="show/hide quicksearch" /></span></h3>
+				<form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
+				<fieldset>
+					<legend>Quicksearch</legend>
+					<input type="text" name="quicksearch" value=""
+						class="quicksearch-field" />
+				</fieldset>
+				</form>
+				<ul class="link-list">
+				</ul>
+				<div id="no-class-search-results" style="display: none;">No matching classes.</div>
+			</div>
+		</div>
+	</div>
+	<div id="documentation">
+		<h1>lll</h1>
+<p>
+lll() is used in debugging to display an expression and its value.
+</p>
+<h3>Motivation</h3>
+<p>
+One of the most basic tools in debugging is printing out the values of
+variables (or other expressions) during program execution:
+</p>
+<pre>
+    puts user_name
+</pre>
+<p>
+Sometimes you need to label these values so you know what they&#8217;re
+referring to, especially if you&#8217;re outputting a lot of them:
+</p>
+<pre>
+    puts &quot;user_name = #{message}&quot;
+</pre>
+<p>
+lll() does the labelling automatically:
+</p>
+<pre>
+    lll{'user_name'}
+</pre>
+<p>
+The expression is passed as a string inside a block. It&#8217;s useful to
+create a text editor macro that outputs <tt>lll{''}</tt> and leaves the
+cursor inside the apostrophes.
+</p>
+<h3>Other benefits</h3>
+<p>
+Output goes to standard output and the Rails log (if available).
+</p>
+<p>
+Output is displayed in reverse video, so it&#8217;s easy to pick out from
+the log or console.
+</p>
+<p>
+lll() uses inspect to output the expression. It outputs Enumerable members
+(except strings) on separate lines.
+</p>
+<h3>Outputting additional text</h3>
+<p>
+Sometimes you need to include some other string, along with the label and
+value:
+</p>
+<pre>
+    puts &quot;After polling the queue, user_name = #{user_name}&quot;
+</pre>
+<p>
+You can pass a string to lll() to print a string:
+</p>
+<pre>
+    lll(&quot;After polling the queue&quot;){'user_name'}
+</pre>
+<p>
+And because lll() outputs in reverse video, and to the Rails log, it can be
+useful to simply print a string without an expression:
+</p>
+<pre>
+    lll &quot;After read_user&quot;
+</pre>
+<h3>Copyright</h3>
+<p>
+Copyright &#169; 2009 Mark Wilden. See LICENSE for details.
+</p>
+	</div>
+	<div id="validator-badges">
+		<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+		<p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
+			Rdoc Generator</a> 1.1.6</small>.</p>
+	</div>
+</body>
+</html>

data/lib/lll.rb ADDED

@@ -0,0 +1,37 @@
+# Used in debugging to display an expression and its value. Examples:
+#   x = 1
+#   lll{'x'} #=> x = 1
+#   lll("a message"){'x'} #=> a message: x = 1
+#   lll "a message" #=> a message
+# 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)
+      s << " \n"
+      expression_value.each { |e| s << ' ' << e.inspect << " \n" }
+    else
+      s << expression_value.inspect << " \n"
+    end
+  else
+    s << msg if msg
+    s << " \n"
+  end
+  color_code_for_value = "\e[7m"
+  color_code_for_location = ""
+  stop_color_code = "\e[0m"
+  s = color_code_for_value + s + stop_color_code
+  s << color_code_for_location + ' ' + caller.first.to_s + ' ' + Time.now.strftime('%X') + ' ' + stop_color_code
+  Kernel.puts s
+  Rails.logger.debug s if defined?(Rails) && Rails.logger
+end

metadata ADDED

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: lll
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Mark Wilden
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2010-01-17 00:00:00 -08:00
+default_executable:
+dependencies: []
+description: |
+  = 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.
+email: mark@mwilden.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.rdoc
+files:
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- doc/README_rdoc.html
+- lib/lll.rb
+has_rdoc: true
+homepage: http://github.com/mwilden/lll
+licenses: []
+post_install_message:
+rdoc_options:
+- --charset=UTF-8
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: "0"
+  version:
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: "0"
+  version:
+requirements: []
+rubyforge_project:
+rubygems_version: 1.3.5
+signing_key:
+specification_version: 3
+summary: Output labeled data when debugging
+test_files: []