afurmanov-clicase 0.1.5

data/.gitignore

@@ -0,0 +1,5 @@
+pkg
+doc
+Manifest
+clicase/**
+

data/MIT-LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2009, Aleksandr Furmanov <afurmanov@rushpost.com>
+
+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,16 @@
+= CliCase - Macros for testing Ruby command line apps with Shoulda or Test::Unit
+
+When you start thinking about writing ruby command line utility you likely want to start with writing test. Assuming command line parsing is in CliApp#run you prabably want to write something like:
+
+  class CliTest < Test::Unit::TestCase
+    run_command_line_as {CliApp.run}
+  
+    run_with_options ["--help"] do
+      assert_successful_run
+      assert_out_contains /Usage:/
+    end
+  end
+
+
+Work in progress...
+

data/Rakefile

@@ -0,0 +1,18 @@
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "clicase"
+    gemspec.summary = "Macros for testing Ruby command line apps with Shoulda or Test::Unit."
+    gemspec.email = "afurmanov@rushpost.com"
+    gemspec.homepage = "http://github.com/afurmanov/clicase"
+    gemspec.description = <<END
+CliCase extends TestCase with macros simplifying testing command line apps written in Ruby. These macros allow
+to specify command line entry point, run command line and assert execution results. Works with Test::Unit or with Shoulda.
+END
+    gemspec.authors = ["Aleksandr Furmanov"]
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install jeweler"
+end

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:minor: 1
+:patch: 5
+:major: 0

data/clicase.gemspec

@@ -0,0 +1,54 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{clicase}
+  s.version = "0.1.5"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Aleksandr Furmanov"]
+  s.date = %q{2009-07-29}
+  s.description = %q{CliCase extends TestCase with macros simplifying testing command line apps written in Ruby. These macros allow
+to specify command line entry point, run command line and assert execution results. Works with Test::Unit or with Shoulda.
+}
+  s.email = %q{afurmanov@rushpost.com}
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "MIT-LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION.yml",
+     "clicase.gemspec",
+     "lib/clicase.rb",
+     "test/cli_app.rb",
+     "test/shoulda/cli_test.rb",
+     "test/test.rb",
+     "test/test_helper.rb",
+     "test/unit/cli_test.rb"
+  ]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/afurmanov/clicase}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.2}
+  s.summary = %q{Macros for testing Ruby command line apps with Shoulda or Test::Unit.}
+  s.test_files = [
+    "test/cli_app.rb",
+     "test/shoulda/cli_test.rb",
+     "test/test.rb",
+     "test/test_helper.rb",
+     "test/unit/cli_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

data/lib/clicase.rb

@@ -0,0 +1,109 @@
+module CliCase
+  module ClassMethods
+    attr_accessor :exit_status, :cli_output, :error, :error_stack, :cli_block
+    
+    def run_command_line_as(&block)
+      self.cli_block = block
+    end
+  end #ClassMethods
+  
+  module InstanceMethods
+    def run_with_options(options)
+      with_ARGV_set_to(options) {execute}
+    end
+    
+    private
+    def execute
+      self.class.cli_block.call
+    end
+    
+    def with_ARGV_set_to(options)
+      ignore_assignment_to_const_warning { Object.const_set(:ARGV, options) }
+      yield
+    end
+
+    def ignore_assignment_to_const_warning 
+      warnings_option = $-w
+      $-w = nil
+      begin
+        yield
+      ensure
+        $-w = warnings_option
+      end
+    end
+  end #InstanceMethods
+  
+  module Macros
+    def run_with_options(options, name = nil, &block)
+      raise RuntimeError, "Command is not defined: 'run_command_line_as()' must be called first." unless 
+        self.cli_block
+      test_name = name || "after running with options '#{options.join(', ')}'"
+      generate_test test_name do 
+        with_ARGV_set_to options do
+          begin 
+            Test::Unit::TestCase.exit_status = 0
+            Test::Unit::TestCase.error = ""
+            Test::Unit::TestCase.error_stack = ""
+            Test::Unit::TestCase.cli_output = ""
+            #It used to be $stdout = StringIO.new(...), but it does not work well with rdebug
+            class <<$stdout
+              alias_method :original_write, :write
+              def write(*s)
+                #original_write(s)
+                Test::Unit::TestCase.cli_output << s.to_s if Test::Unit::TestCase.cli_output
+              end
+            end
+            execute
+          rescue SystemExit => exit_error
+            Test::Unit::TestCase.exit_status = exit_error.status
+          rescue Exception => error
+            Test::Unit::TestCase.error_stack = error.backtrace.join("\n")
+            Test::Unit::TestCase.error = error.message
+          ensure
+            class <<$stdout
+              remove_method :write, :original_write
+            end
+          end
+          instance_eval(&block)
+        end
+      end
+    end
+    
+    private
+    def generate_test(name, &block)
+      if defined? Shoulda 
+        should(name, &block)
+      else
+        test_name = ("test_".concat name).strip.to_sym
+        self.send(:define_method, test_name, &block)
+      end
+    end
+  end #Macros
+  
+  module Assertions
+    def assert_successful_run
+      expect_message = "Should run successfully, but"
+      assert_equal 0, Test::Unit::TestCase.exit_status, "#{expect_message} exit status is #{Test::Unit::TestCase.exit_status}"
+      assert Test::Unit::TestCase.error.empty?, "#{expect_message} exception '#{Test::Unit::TestCase.error}' has been thrown. Exception stack:\n" + Test::Unit::TestCase.error_stack
+    end
+    
+    def assert_failed_run
+      flunk "Expects either thrown error or exit status not 0." if 0 == Test::Unit::TestCase.exit_status && Test::Unit::TestCase.error.empty?
+    end
+
+    def assert_out_contains regex
+      assert_match regex, Test::Unit::TestCase.cli_output
+    end
+  end #Assertions
+end
+
+module Test 
+  module Unit
+    class TestCase
+      extend CliCase::ClassMethods
+      include CliCase::InstanceMethods
+      extend CliCase::Macros
+      include CliCase::Assertions
+    end
+  end
+end

data/test/cli_app.rb

@@ -0,0 +1,25 @@
+require 'optparse'
+
+module CliApp
+  class <<self
+    def run
+      OptionParser.new do |opts|
+        opts.banner = "Usage: cli.rb [options]\nCommand line test app."
+        
+        opts.on( "--option OPTIONIAL", "run with OPTIONIAL") do |option|
+          puts option
+        end
+        
+        opts.on_tail("-h", "--help", "show help") do
+          puts opts
+          #exit NB!
+        end      
+      end.parse!
+    end
+  end
+end
+
+
+if $0 == __FILE__
+  CliApp.run
+end

data/test/shoulda/cli_test.rb

@@ -0,0 +1,20 @@
+require 'rubygems'
+require 'shoulda'
+require File.dirname(__FILE__) + '/../test'
+
+class CliShouldaSpecificTest < Test::Unit::TestCase
+  run_command_line_as {CliApp.run}
+  
+  context "outer" do
+    run_with_options ["--option", "OUTER"] do 
+      assert_out_contains /OUTER/
+    end
+    context "inner" do
+      run_with_options ["--option", "INNER"] do 
+        assert_out_contains /INNER/
+      end
+    end
+  end
+end
+
+

data/test/test.rb

@@ -0,0 +1,34 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class CliUsageTest < Test::Unit::TestCase
+  run_command_line_as {CliApp.run}
+  
+  run_with_options ["--help"] do
+    assert_successful_run
+    assert_out_contains /Usage:/
+  end
+
+  run_with_options [], "running with no arguments" do
+    assert_successful_run
+  end
+
+  run_with_options ["--option", "PRINT_THIS"] do
+    assert_successful_run
+    assert_out_contains /PRINT_THIS/
+  end
+  
+  run_with_options [], "run_with_options could be used within block" do
+    assert_successful_run
+    run_with_options []
+  end
+  
+  run_with_options ["--invalid-option"], "running with invalid option" do
+    assert_failed_run
+  end
+end
+
+class CliTestNoCommandLineDefined < Test::Unit::TestCase
+  def test_failure_when_command_line_defined
+    assert_raise(RuntimeError) {self.class.run_with_options []}
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'test/unit'
+require 'lib/clicase'
+require File.dirname(__FILE__) + '/cli_app'

data/test/unit/cli_test.rb

@@ -0,0 +1,3 @@
+#If Shoulda still has been loaded - unload it
+Object.send(:remove_const, :Shoulda) rescue nil
+require File.dirname(__FILE__) + '/../test'

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification 
+name: afurmanov-clicase
+version: !ruby/object:Gem::Version 
+  version: 0.1.5
+platform: ruby
+authors: 
+- Aleksandr Furmanov
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-29 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: CliCase extends TestCase with macros simplifying testing command line apps written in Ruby. These macros allow to specify command line entry point, run command line and assert execution results. Works with Test::Unit or with Shoulda.
+email: afurmanov@rushpost.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- .gitignore
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- VERSION.yml
+- clicase.gemspec
+- lib/clicase.rb
+- test/cli_app.rb
+- test/shoulda/cli_test.rb
+- test/test.rb
+- test/test_helper.rb
+- test/unit/cli_test.rb
+has_rdoc: true
+homepage: http://github.com/afurmanov/clicase
+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: Macros for testing Ruby command line apps with Shoulda or Test::Unit.
+test_files: 
+- test/cli_app.rb
+- test/shoulda/cli_test.rb
+- test/test.rb
+- test/test_helper.rb
+- test/unit/cli_test.rb