RubyGems - s4t-utils - Versions diffs - 1.0.2 → 1.0.3 - Mend

s4t-utils 1.0.2 → 1.0.3

Files changed (13) hide show

data/History.txt +8 -0
data/Manifest.txt +2 -0
data/Rakefile.hoe +11 -0
data/homepage/index.html +16 -0
data/lib/s4t-utils.rb +1 -0
data/lib/s4t-utils/capturing-globals.rb +28 -1
data/lib/s4t-utils/hacks.rb +4 -3
data/lib/s4t-utils/os.rb +29 -0
data/lib/s4t-utils/ruby-extensions.rb +67 -0
data/lib/s4t-utils/version.rb +1 -1
data/test/capturing-globals-tests.rb +17 -0
data/test/hacks-tests.rb +30 -0
metadata +5 -3

data/History.txt CHANGED

@@ -1,3 +1,11 @@
+Version 1.0.3
+  * Added with_stdin and capturing_stdout
+  * Added set_test_paths and set_script_lib_path
+  * pi can take symbols as captions.
+  * Added without_pretty_indentation and has_exact_prefix?
+    The names were chosen to be so bad there'd be little
+    chance of name clashes.
 Version 1.0.2
   * Added user_denies as an alias for user_disputes.

data/Manifest.txt CHANGED

@@ -16,6 +16,7 @@ data/make-s4t-project/setup.rb
 data/make-s4t-project/sub-lib-skeleton
 data/make-s4t-project/test-skeleton
 data/make-s4t-project/version-skeleton
+homepage/index.html
 lib/s4t-utils.rb
 lib/s4t-utils/capturing-globals.rb
 lib/s4t-utils/claims.rb
@@ -28,6 +29,7 @@ lib/s4t-utils/more-assertions.rb
 lib/s4t-utils/os.rb
 lib/s4t-utils/rake-task-helpers.rb
 lib/s4t-utils/rakefile-common.rb
+lib/s4t-utils/ruby-extensions.rb
 lib/s4t-utils/svn-file-movement.rb
 lib/s4t-utils/test-util.rb
 lib/s4t-utils/version.rb

data/Rakefile.hoe CHANGED

@@ -20,3 +20,14 @@ Hoe.new("s4t-utils", S4tUtils::Version) do |p|
   p.url = "http://s4t-utils.rubyforge.org"
   p.remote_rdoc_dir = 'rdoc'
 end
+desc "Tag release with current version."
+task 'tag_release' do
+  root = "svn+ssh://marick@rubyforge.org/var/svn/s4t-utils"
+  from = "#{root}/trunk"
+  to = "#{root}/tags/rel-#{S4tUtils::Version}"
+  message = "Release #{S4tUtils::Version}"
+  exec = "svn copy -m '#{message}' #{from} #{to}"
+  puts exec
+  system(exec)
+end

data/homepage/index.html ADDED

@@ -0,0 +1,16 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+	"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<head>
+	<meta http-equiv="Content-type" content="text/html; charset=utf-8">
+	<title>s4t-utils</title>
+</head>
+<body>
+	<h1><i>Everyday Scripting with Ruby</i> Utilities</h1>
+	<a href="http://www.pragmaticprogrammer.com/titles/bmsft/"><img src="http://www.testing.com/blog/images/bookcover-small.png" style="float: left; border: 0; margin-right: 0.5in"/></a>
+	<p>This is the most recent version of the utilities used in <a href="http://www.exampler.com/blog/" title="Exploration Through Example">Brian Marick</a>'s <i><a href="http://www.pragmaticprogrammer.com/titles/bmsft/">Everyday Scripting with Ruby</a></i>.</p>
+	<p><a href="http://s4t-utils.rubyforge.org/rdoc/" title="s4t-utils's Documentation">Documentation</a> (rdoc)</p>
+	<p><a href="http://rubyforge.org/frs/?group_id=4026" title="RubyForge: Everyday Scripting Utilities: Project Filelist">Download</a></p>
+</body>

data/lib/s4t-utils.rb CHANGED

@@ -9,6 +9,7 @@ require 's4t-utils/hacks'
 require 's4t-utils/command-line'
 require 's4t-utils/test-util'
 require 's4t-utils/os'
+require 's4t-utils/ruby-extensions'
 require 'pp'

data/lib/s4t-utils/capturing-globals.rb CHANGED

@@ -17,6 +17,23 @@ module S4tUtils
     end
     new_stderr.string
   end
+  # Run the block, capturing output to $stdout in a string.
+  # That string is the method's return value.
+  #
+  # Note: this assigns to $stdout, which is deprecated in
+  # favor of $stdout.reopen. However, reopen can't take a
+  # StringIO as an argument.
+  def capturing_stdout
+    new_stdout = StringIO.new
+    $stdout = new_stdout
+    begin
+      yield
+    ensure
+      $stdout = STDOUT
+    end
+    new_stdout.string
+  end
   # Run the block, replacing the values of environment variables
   # with the values given in the hash _settings_. The environment
@@ -44,7 +61,7 @@ module S4tUtils
       ENV['HOME'] = '.'
       yield
     ensure
-      ENV['HOME'] = @old_home
+      ENV['HOME'] = old_home
     end
   end
@@ -89,5 +106,15 @@ module S4tUtils
       ARGV.replace(old_argv)
     end
   end
+  def with_stdin(string)
+    old_stdin = $stdin
+    $stdin = StringIO.new(string)
+    yield
+  ensure
+    $stdin = old_stdin
+  end
 end

data/lib/s4t-utils/hacks.rb CHANGED

@@ -21,13 +21,14 @@ module S4tUtils
   #     pi [1, 2, 3], 'input'    # => 'input: [1, 2, 3]
   #
   # The _arg_ is printed using +inspect+. If _leader_ isn't given,
-  # nothing is printed before _arg_.
+  # nothing is printed before _arg_. _leader_ can be a string or symbol.
   #
   # pi returns its _arg_, which is occasionally useful for sticking
   # debugging into the middle of complicated expressions.
   def pi(arg, leader=nil)
-     leader = (leader == nil) ? '' : leader + ': '
-     prog1(arg) { puts leader + arg.inspect }
+    leader = leader.to_s if leader
+    leader = (leader == nil) ? '' : leader + ': '
+    prog1(arg) { puts leader + arg.inspect }
    end

data/lib/s4t-utils/os.rb CHANGED

@@ -23,6 +23,35 @@ module S4tUtils
       end
     end
   end
+  # Find and set the paths a test needs to run, given the normal
+  # Ruby directory structure. _given_ is something below the test directory.
+  # PACKAGE_ROOT becomes the root of
+  # the structure. PACKAGE_ROOT/lib and PACKAGE_ROOT itself are
+  # put on the front of the path (the latter is so that
+  # tests can require 'test/something'.
+  def set_test_paths(given)
+    return if S4tUtils.const_defined?("PACKAGE_ROOT")
+    path = File.expand_path(given)
+    i = path.index("/test/")
+    S4tUtils.const_set("PACKAGE_ROOT", path[0...i])
+    $:.unshift("#{PACKAGE_ROOT}/lib")
+    $:.unshift("#{PACKAGE_ROOT}")
+  end
+  module_function :set_test_paths
+  # If the _given_ file lives as a script inside a typical Ruby development
+  # structure, put ../lib at the front of the path. That includes files
+  # from there in preference to old gems lying around.
+  def set_script_lib_path(given)
+    path = File.expand_path(given)
+    p = lambda { | x | File.join(File.dirname(path), '..', x) }
+    l = p['lib']
+    t = p['test']
+    s = p['setup.rb']
+    $:.unshift(l) if File.exists?(l) && File.exists?(t) && File.exists?(s)
+  end
+  module_function :set_script_lib_path
 end

data/lib/s4t-utils/ruby-extensions.rb ADDED

@@ -0,0 +1,67 @@
+#!/usr/bin/env ruby
+#
+#  Created by Brian Marick on 2007-09-27.
+#  Copyright (c) 2007. All rights reserved.
+# After some time trying to write libraries that used facets or extensions
+# and didn't conflict with other libraries that used (for example) active_support,
+# I give up. I'm going to copy the methods I need, rename them to something so
+# bad there'll never be a conflict, and see if that's more painful.
+class String
+  # What everyone calls starts_with?
+  def has_exact_prefix?(prefix)
+   index(prefix) == 0
+  end
+  # Copied from the extensions library (http://extensions.rubyforge.org)
+  #
+  # Trims a string:
+  # - removes one initial blank line
+  # - removes trailing spaces on each line
+  # - if +margin+ is given, removes initial spaces up to and including
+  #   the margin on each line, plus one space
+  #
+  # This is designed specifically for working with inline documents.
+  # Here-documents are great, except they tend to go against the indentation
+  # of your code.  This method allows a convenient way of using %{}-style
+  # documents.  For instance:
+  #
+  #   USAGE = %{
+  #     | usage: prog [-o dir] -h file...
+  #     |   where
+  #     |     -o dir         outputs to DIR
+  #     |     -h             prints this message
+  #   }.without_pretty_indentation("|")
+  #
+  #   # USAGE == "usage: prog [-o dir] -h file...\n  where"...
+  #   # (note single space to right of margin is deleted)
+  #
+  # Note carefully that if no margin string is given, then there is no
+  # clipping at the beginning of each line and your string will remain
+  # indented.
+  def without_pretty_indentation(margin=nil)
+    s = self.dup
+    # Remove initial blank line.
+    s.sub!(/\A[ \t]*\n/, "")
+    # Get rid of the margin, if it's specified.
+    unless margin.nil?
+      margin_re = Regexp.escape(margin || "")
+      margin_re = /^[ \t]*#{margin_re} ?/
+      s.gsub!(margin_re, "")
+    end
+    # Remove trailing whitespace on each line
+    s.gsub!(/[ \t]+$/, "")
+    s
+  end
+  #
+  # Indents the string +n+ spaces.
+  # Taken from extensions (extensions.rubyforge.org), except that this
+  # version doesn't take a negative argument.
+  #
+  def indent_by(n)
+    n = n.to_int
+    gsub(/^/, " "*n)
+  end
+end

data/lib/s4t-utils/version.rb CHANGED

@@ -1,3 +1,3 @@
 module S4tUtils
-  Version = '1.0.2'
+  Version = '1.0.3'
 end

data/test/capturing-globals-tests.rb CHANGED

@@ -38,5 +38,22 @@ class CapturingGlobalsTests < Test::Unit::TestCase
       assert_equal('steak', ARGV[1])
     }
   end
+  def test_with_stdin
+    with_stdin("line1\nline2") do
+      assert_equal("line1\n", readline)
+      assert_equal("line2", readline)
+    end
+  end
+  def test_with_nested_stdin
+    with_stdin("line1\nline2") do
+      assert_equal("line1\n", readline)
+      with_stdin("intermediate") do
+        assert_equal("intermediate", readline)
+      end
+      assert_equal("line2", readline)
+    end
+  end
 end

data/test/hacks-tests.rb CHANGED

@@ -38,5 +38,35 @@ class ClaimsTests < Test::Unit::TestCase
     forwarder.values_at
     assert_equal(["one", "two", "three"], forwarder.values_at(3))
   end
+  def test_pi_prints_to_standard_output_using_inspect
+    result = capturing_stdout do
+      pi [1, 2, 3], "caption"
+    end
+    assert_equal("caption: [1, 2, 3]\n", result)
+  end
+  def test_pi_does_not_need_a_caption
+    result = capturing_stdout do
+      pi [1, 2, 3]
+    end
+    assert_equal("[1, 2, 3]\n", result)
+  end
+  def test_pi_can_take_a_symbol_as_a_caption
+    result = capturing_stdout do
+      pi [1, 2, 3], :caption
+    end
+    assert_equal("caption: [1, 2, 3]\n", result)
+  end
+  def test_pi_returns_a_useful_value
+    result = capturing_stdout do
+      val = pi([1, 2, 3], 'val')
+      assert_equal([1, 2, 3], val)
+    end
+    assert_equal("val: [1, 2, 3]\n", result)
+  end
 end

metadata CHANGED

@@ -3,8 +3,8 @@ rubygems_version: 0.9.0
 specification_version: 1
 name: s4t-utils
 version: !ruby/object:Gem::Version
-  version: 1.0.2
-date: 2007-07-27 00:00:00 -05:00
+  version: 1.0.3
+date: 2007-09-27 00:00:00 -05:00
 summary: _Everyday Scripting with Ruby_ utilities.
 require_paths:
 - lib
@@ -47,6 +47,7 @@ files:
 - data/make-s4t-project/sub-lib-skeleton
 - data/make-s4t-project/test-skeleton
 - data/make-s4t-project/version-skeleton
+- homepage/index.html
 - lib/s4t-utils.rb
 - lib/s4t-utils/capturing-globals.rb
 - lib/s4t-utils/claims.rb
@@ -59,6 +60,7 @@ files:
 - lib/s4t-utils/os.rb
 - lib/s4t-utils/rake-task-helpers.rb
 - lib/s4t-utils/rakefile-common.rb
+- lib/s4t-utils/ruby-extensions.rb
 - lib/s4t-utils/svn-file-movement.rb
 - lib/s4t-utils/test-util.rb
 - lib/s4t-utils/version.rb
@@ -114,5 +116,5 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.2
+        version: 1.3.0
     version: