s4t-utils 1.0.0

data/test/data/make-s4t-project/sub-lib-skeleton

@@ -0,0 +1,3 @@
+module !REPLACE_ME_MODULE!
+  # Your code here
+end

data/test/data/make-s4t-project/test-skeleton

@@ -0,0 +1,28 @@
+# This file should be copied into a test ending in 'tests.rb' so that
+# the Rakefile knows it's a test.
+
+require "set-standalone-test-paths.rb" unless $started_from_rakefile
+require 'test/unit'
+require 's4t-utils'
+include S4tUtils
+
+## Require either the particular file under test like this:
+# require '!REPLACE_ME_FILE!/my-file'
+## or the entire package:
+# require '!REPLACE_ME_FILE!'
+
+class TestName < Test::Unit::TestCase
+  ## You probably want to include your library so that you don't have
+  ## to tack !REPLACE_ME_MODULE!:: onto every name, but I won't assume
+  ## that.
+  # include !REPLACE_ME_MODULE!
+
+  def setup
+  end
+
+  def teardown
+  end
+
+  def test_something
+  end
+end

data/test/data/make-s4t-project/version-skeleton

@@ -0,0 +1,3 @@
+module !REPLACE_ME_MODULE!
+  Version = '0.1.0'
+end

data/test/data/test-data-location-file

@@ -0,0 +1 @@
+test_data found me

data/test/error-handling-tests.rb

@@ -0,0 +1,43 @@
+$:.unshift("../lib")
+require 'test/unit'
+require 's4t-utils'
+
+
+class ErrorHandlingTests < Test::Unit::TestCase
+  include S4tUtils
+
+  def test_with_pleasant_exceptions_and_no_error
+    result = with_pleasant_exceptions {
+      "result"
+    }
+    assert_equal("result", result)
+  end
+
+  def test_with_pleasant_exceptions_prints_errors_to_stderr
+    result = capturing_stderr {
+      with_pleasant_exceptions {
+        raise Exception.new("this is the message")
+      }
+    }
+    assert_equal("this is the message\n", result)
+  end
+
+  def test_with_pleasant_exceptions_does_not_interfere_with_exit
+    assert_wants_to_exit {
+      with_pleasant_exceptions {
+        exit
+      }
+    }
+  end
+
+
+  def test_without_pleasant_exceptions_prints_warning
+    warning = capturing_stderr { 
+      assert_raises(Exception) { 
+        without_pleasant_exceptions { raise Exception.new }
+      }
+    }
+    assert_match(/Note: exception handling turned off/, warning)
+  end
+
+end

data/test/friendly-format-tests.rb

@@ -0,0 +1,15 @@
+$:.unshift("../lib")
+require 'test/unit'
+require 's4t-utils'
+
+
+class FriendlyFormatTests < Test::Unit::TestCase
+  include S4tUtils
+
+  def test_friendly_list
+    assert_equal('', friendly_list('and', []))
+    assert_equal("'a'", friendly_list('and', ['a']))
+    assert_equal("'zed' + 'alpha'", friendly_list('+', [:zed, :alpha]))
+    assert_equal("'1', '2', or '20'", friendly_list('or', [1, 2, 20]))
+  end
+end

data/test/hacks-tests.rb

@@ -0,0 +1,42 @@
+$:.unshift("../lib")
+require 'test/unit'
+require 's4t-utils'
+
+
+class ClaimsTests < Test::Unit::TestCase
+  include S4tUtils
+
+  # The name 'prog1' comes from Lisp. Couldn't think of a better one.
+  def test_prog1_returns_argument_after_executing_block
+    block_result = nil
+    prog1_result = prog1(1) {
+      block_result = 2
+    }
+    assert_equal(1, prog1_result)
+    assert_equal(2, block_result)
+  end
+
+  def test_prog1_is_also_a_module_method
+    block_result = nil
+    prog1_result = S4tUtils.prog1(1) {
+      block_result = 2
+    }
+    assert_equal(1, prog1_result)
+    assert_equal(2, block_result)
+  end
+
+  def test_arg_forwarder_forwards_one_arg
+    array = []
+    forwarder = ArgForwarder.new(array, 5)
+    forwarder.push
+    assert_equal([5], array)
+  end
+
+  def test_arg_forwarder_forwards_multiple_args
+    hash = { 1 => 'one', 2 => 'two', 3 => 'three' }
+    forwarder = ArgForwarder.new(hash, 1, 2)
+    forwarder.values_at
+    assert_equal(["one", "two", "three"], forwarder.values_at(3))
+  end
+
+end

data/test/load-path-auto-adjuster-tests.rb

@@ -0,0 +1,88 @@
+$:.unshift("../lib")
+require 'test/unit'
+
+
+class AutoAdjusterTests < Test::Unit::TestCase
+  class FakePath
+    attr_reader :parent
+    def initialize(name, parent=nil)
+      @name = name
+      @parent = parent
+    end
+
+    def +(string)
+      FakePath.new(self.to_s + '/' + string, self)
+    end
+
+    def to_s; @name; end
+
+    def self.ordinary_structure_returning_third_party
+      root = FakePath.new('root')
+      lib = FakePath.new('lib', root)
+      project = FakePath.new('project', lib)
+      FakePath.new('third-party', project)
+    end
+  end
+
+  module PathHandling
+    module_function
+    def replace_path(path)
+      $:.clear
+      path.each { | element | 
+        $: << element
+      }
+    end
+
+    def with_path(path)
+      old = $:.dup
+      replace_path(path)
+      yield
+    ensure
+      replace_path(old)
+    end
+  end
+
+  include PathHandling
+  PathHandling.with_path($:.dup) {
+    require 's4t-utils/load-path-auto-adjuster'
+  }
+  include S4tUtils
+
+  def setup
+    @std_third_party = FakePath.ordinary_structure_returning_third_party
+  end
+
+  def test_notices_when_library_already_in_path
+    with_path(%w{ root lib project third-party}) {
+      assert(Hidden::Arranger.new(@std_third_party).project_lib_already_in_path?)
+    }
+  end
+
+  # The checks that the Gem path is correct are commented out below
+  # because checking the Gem path causes subdirectories to be created,
+  # thus leaving little "/gem/" droppings all over the test directory
+  # or wherever the test is run from. 
+
+  def test_adds_third_party_if_lib_already_in_path
+    with_path(%w{ local lib something-later}) {
+      Hidden::Arranger.new(@std_third_party).arrange
+      assert_equal(%w{local lib third-party something-later},
+                   $:)
+    }
+
+    # assert(Gem.path.include?("#{@std_third_party.to_s}/gems"))
+  end
+    
+
+  def test_adds_everything_if_lib_not_already_in_path
+    with_path(%w{ /bin /usr/local/bin }) {
+      Hidden::Arranger.new(@std_third_party).arrange
+      assert_equal(%w{lib third-party root /bin /usr/local/bin},
+                   $:)
+    }
+
+    # assert(Gem.path.include?("#{@std_third_party.to_s}/gems"))
+  end
+    
+
+end

data/test/rake-task-helper-tests.rb

@@ -0,0 +1,62 @@
+$:.unshift("../lib")
+require 'test/unit'
+require 's4t-utils'
+
+
+class RakeHelperTests < Test::Unit::TestCase
+  include S4tUtils
+
+  def test_generated_taskname
+    assert_equal('__generated__foo', generated_taskname('foo'))
+    assert_equal('__generated__foo', generated_taskname(:foo))
+    assert_equal('__generated__foo_barness',
+                 generated_taskname("! foo_bar-ness"))
+    assert_equal('prefix_orp', generated_taskname('orp', 'prefix_'))
+  end
+
+  def test_update_peer_subtask_name
+    assert_equal('__update_peers_s4tutils',
+                 update_peer_subtask_name('s4t-utils'))
+  end
+
+  def test_singular_test_targets_allow_plurals
+    assert_equal("{dbtest,dbtests}", broaden_test_name('dbtest'))
+  end
+
+  def test_plural_test_targets_allow_singular
+    assert_equal("{dbtest,dbtests}", broaden_test_name('dbtests'))
+  end
+
+  def test_desired_subset_can_include_pending_tests
+    local_pending_test = "pending.test.rb"
+    local_finished_test = "finished.test.html"
+    remote_pending_test = "dir/pending.x.rb"
+    remote_finished_test = "dir/fini.rb"
+
+    assert_true(pending?(local_pending_test))
+    assert_true(pending?(remote_pending_test))
+    assert_false(pending?(local_finished_test))
+    assert_false(pending?(remote_finished_test))
+
+    tests = [
+      local_pending_test, local_finished_test,
+      remote_pending_test, remote_finished_test
+    ]
+    assert_equal([local_finished_test, remote_finished_test],
+                 desired_subset(tests, false))
+    assert_equal(tests,
+                 desired_subset(tests, true))
+  end
+
+  def test_pending_has_an_exact_boundary
+    assert_false(pending?('pendingx.rb'))
+    assert_false(pending?('xpending.rb'))
+  end
+
+  def test_pending_can_use_dashes_or_dots
+    assert_true(pending?('pending-test.rb'))
+    assert_true(pending?('pending.test.rb'))
+  end
+
+
+end

data/test/set-standalone-test-paths.rb

@@ -0,0 +1,5 @@
+require 'pathname'
+
+PACKAGE_ROOT = Pathname.new(__FILE__).parent.parent.to_s
+$:.unshift("#{PACKAGE_ROOT}/lib")
+require 's4t-utils/load-path-auto-adjuster'

data/test/test-location-file

@@ -0,0 +1 @@
+test found me

data/test/test-util-tests.rb

@@ -0,0 +1,45 @@
+# This file should be copied into a test ending in 'tests.rb' so that
+# the Rakefile knows it's a test.
+
+require "set-standalone-test-paths.rb" unless $started_from_rakefile
+require 'test/unit'
+require 's4t-utils'
+include S4tUtils
+
+
+class TestUtilTestsNoInclude < Test::Unit::TestCase
+
+  def test_test_method_finds_test_directory
+    assert_equal(["test found me\n"],
+                 IO.readlines(TestUtil.test("test-location-file")))
+  end
+
+  def test_test_data_method_finds_test_data_directory
+    assert_equal(["test_data found me\n"],
+                 IO.readlines(TestUtil.test_data("test-data-location-file")))
+  end
+                 
+  def test_script_method_finds_test_data_directory
+    assert_equal("script found me\n",
+                 `ruby #{TestUtil.script("s4t-script-location-file")}`)
+  end
+end
+
+class TestUtilTestsWithInclude < Test::Unit::TestCase
+  include S4tUtils::TestUtil
+
+  def test_test_method_finds_test_directory
+    assert_equal(["test found me\n"],
+                 IO.readlines(test("test-location-file")))
+  end
+
+  def test_test_data_method_finds_test_data_directory
+    assert_equal(["test_data found me\n"],
+                 IO.readlines(test_data("test-data-location-file")))
+  end
+                 
+  def test_script_method_finds_test_data_directory
+    assert_equal("script found me\n",
+                 `ruby #{script("s4t-script-location-file")}`)
+  end
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.0
+specification_version: 1
+name: s4t-utils
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+date: 2007-07-11 00:00:00 -05:00
+summary: _Everyday Scripting with Ruby_ utilities.
+require_paths: 
+- lib
+email: marick@exampler.com
+homepage: http://s4t-utils.rubyforge.org
+rubyforge_project: s4t-utils
+description: _Everyday Scripting with Ruby_ utilities.
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- Brian Marick
+files: 
+- LICENSE.txt
+- Manifest.txt
+- NOTES.txt
+- README.txt
+- Rakefile
+- Rakefile.hoe
+- bin/make-s4t-project.rb
+- bin/s4t-script-location-file
+- data/make-s4t-project/README-skeleton
+- data/make-s4t-project/Rakefile.example
+- data/make-s4t-project/bin-skeleton
+- data/make-s4t-project/main-lib-skeleton
+- data/make-s4t-project/set-standalone-test-paths.rb
+- 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
+- lib/s4t-utils.rb
+- lib/s4t-utils/capturing-globals.rb
+- lib/s4t-utils/claims.rb
+- lib/s4t-utils/command-line.rb
+- lib/s4t-utils/error-handling.rb
+- lib/s4t-utils/friendly-format.rb
+- lib/s4t-utils/hacks.rb
+- lib/s4t-utils/load-path-auto-adjuster.rb
+- 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/svn-file-movement.rb
+- lib/s4t-utils/test-util.rb
+- lib/s4t-utils/version.rb
+- setup.rb
+- test/capturing-globals-tests.rb
+- test/data/make-s4t-project/README-skeleton
+- test/data/make-s4t-project/Rakefile.example
+- test/data/make-s4t-project/bin-skeleton
+- test/data/make-s4t-project/main-lib-skeleton
+- test/data/make-s4t-project/set-standalone-test-paths.rb
+- test/data/make-s4t-project/setup.rb
+- test/data/make-s4t-project/sub-lib-skeleton
+- test/data/make-s4t-project/test-skeleton
+- test/data/make-s4t-project/version-skeleton
+- test/data/test-data-location-file
+- test/error-handling-tests.rb
+- test/friendly-format-tests.rb
+- test/hacks-tests.rb
+- test/load-path-auto-adjuster-tests.rb
+- test/rake-task-helper-tests.rb
+- test/set-standalone-test-paths.rb
+- test/test-location-file
+- test/test-util-tests.rb
+test_files: 
+- test/capturing-globals-tests.rb
+- test/error-handling-tests.rb
+- test/friendly-format-tests.rb
+- test/hacks-tests.rb
+- test/load-path-auto-adjuster-tests.rb
+- test/rake-task-helper-tests.rb
+- test/test-util-tests.rb
+rdoc_options: 
+- --main
+- README.txt
+extra_rdoc_files: 
+- LICENSE.txt
+- Manifest.txt
+- NOTES.txt
+- README.txt
+executables: 
+- make-s4t-project.rb
+- s4t-script-location-file
+extensions: []
+
+requirements: []
+
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.1
+    version: