sprout 0.7.246 → 1.0.0.pre

data/test/unit/boolean_param_test.rb

@@ -0,0 +1,38 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class BooleanParamTest < Test::Unit::TestCase
+  include SproutTestCase
+
+  context "a new, simple BooleanParam" do
+
+    setup do 
+      @param = Sprout::Executable::Boolean.new
+      @param.name = 'foo'
+    end
+
+    should "be hidden when false" do
+      @param.value = false
+      assert_equal '', @param.to_shell
+    end
+
+    should "default to false" do
+      assert_equal false, @param.value
+    end
+
+    should "show on true" do
+      @param.value = true
+      assert_equal '--foo', @param.to_shell
+    end
+
+    context "when configuring option parser" do
+      
+      should "update correctly" do
+        @param.show_on_false = true
+        @param.default = true
+        @param.hidden_value = false
+        assert_equal "--foo [BOOL]", @param.option_parser_declaration
+      end
+    end
+  end
+end
+

data/test/unit/executable_option_parser_test.rb

@@ -0,0 +1,142 @@
+require File.dirname(__FILE__) + '/test_helper'
+require 'test/fixtures/examples/echo_inputs'
+
+class ExecutableOptionParserTest < Test::Unit::TestCase
+  include SproutTestCase
+
+  context "a new ruby executable" do
+    
+    setup do
+      @exe = EchoInputs.new
+      @exe.abort_on_failure = false
+      @default_input = '--input=lib/sprout.rb'
+    end
+
+    should "fail without required args" do
+      assert_raises Sprout::Errors::MissingArgumentError do
+        @exe.parse! []
+      end
+    end
+
+    should "accept required args" do
+      @exe.parse! [ @default_input ]
+      assert_equal 'lib/sprout.rb', @exe.input
+    end
+
+    should "accept boolean with hidden_value" do
+      assert !@exe.truthy
+      @exe.parse! [ '--truthy', @default_input ]
+      assert @exe.truthy
+    end
+    
+    should "always accept help option" do
+      @exe.expects :puts
+      assert_raises SystemExit do
+        @exe.parse! [ '--help' ]
+      end
+    end
+
+    should "accept false boolean" do
+      assert @exe.falsey, "Should be true by default"
+      @exe.parse! [@default_input, '--falsey=false']
+      assert !@exe.falsey, "Should be false"
+    end
+
+    should "accept string" do
+      @exe.parse! [@default_input, '--string=abcd']
+      assert_equal 'abcd', @exe.string
+    end
+
+    should "accept file" do
+      @exe.parse! [@default_input, '--file=lib/sprout.rb']
+      assert_equal 'lib/sprout.rb', @exe.file
+    end
+
+    should "accept files" do
+      @exe.parse! [@default_input, '--files+=lib/sprout.rb', '--files+=lib/sprout/log.rb']
+      assert_equal ['lib/sprout.rb', 'lib/sprout/log.rb'], @exe.files
+    end
+
+    # TODO: This might not be correct behavior...
+    should "accept files with equal sign delimiter" do
+      @exe.parse! [@default_input, '--files=lib/sprout.rb', '--files=lib/sprout/log.rb']
+      assert_equal ['lib/sprout.rb', 'lib/sprout/log.rb'], @exe.files
+    end
+
+    # TODO: Not sure what's going on here...
+    should "configure required arguments" do
+      @exe.parse! [@default_input, @default_input]
+      assert_equal 'lib/sprout.rb', @exe.input
+    end
+
+    # TODO: This test ensures that the commandline description
+    # is pulled from the provided RDocs - but this turns out
+    # to be more work than I'm prepared to take on at the moment.
+    #
+    #should "use rdoc to assign parameter documentation" do
+      #skip "Not yet ready to integrate rdoc comments"
+      #doc = "A boolean parameter that defaults to true, and must be explicitly set to false in order to turn it off."
+      #assert_matches /#{doc}/, @exe.to_help
+    #end
+
+    should "fail without required param" do
+      assert_raises Sprout::Errors::MissingArgumentError do
+        @exe.parse! []
+      end
+    end
+
+    should "fail with incorrect param" do
+      assert_raises Sprout::Errors::InvalidArgumentError do
+        @exe.parse! ['--input=lib/unknown_file.rb']
+      end
+    end
+
+    context "with an unknown option" do
+      should "throw an exception" do
+        assert_raises OptionParser::InvalidOption do
+          @exe.parse! [ '--unknown-param', @default_input ]
+        end
+      end
+
+      should "abort and display help" do
+        @exe.abort_on_failure = true
+        @exe.expects :abort
+        @exe.parse! [ '--unknown-param', @default_input ]
+      end
+    end
+
+    context "with a hidden name" do
+
+      # Define the class in a place
+      # where only these tests can use it.
+      class SomeExecutable
+        include Sprout::Executable
+        add_param :debug, Boolean
+        add_param :input, String, { :hidden_name => true }
+      end
+
+      setup do
+        @exe = SomeExecutable.new
+      end
+
+      should "accept a value at the end" do
+        @exe.parse! ['--debug', 'SomeString']
+        assert @exe.debug
+        assert_equal 'SomeString', @exe.input
+      end
+
+=begin
+TODO: Get these passing...
+
+      should "fail if multiple values provided for a singular param" do
+        skip "not yet implemented"
+      end
+
+      should "accept multiple values for collection param" do
+        skip "not yet implemented"
+      end
+=end
+    end
+  end
+end
+

data/test/unit/executable_param_test.rb

@@ -0,0 +1,76 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class ExecutableParamTest < Test::Unit::TestCase
+  include SproutTestCase
+
+  context "a new, simple Executable::Param" do
+
+    setup do 
+      @param = Sprout::Executable::Param.new
+    end
+
+    should "be invisible until value set" do
+      assert !@param.visible?
+    end
+
+    should "return empty string with no value" do
+      assert_equal '', @param.to_shell
+    end
+
+    should "raise if required and nil" do
+      @param.required = true
+      assert_raises Sprout::Errors::MissingArgumentError do
+        @param.to_shell
+      end
+    end
+
+    context "with simple values" do
+
+      setup do
+        @param.name = :foo
+        @param.value = 'bar'
+      end
+
+      should "not raise if required and has value" do
+        @param.required = true
+        assert @param.to_shell
+      end
+
+      should "accept a name and value" do
+        assert_equal '--foo=bar', @param.to_shell
+      end
+
+      should "accept space delimiter" do
+        @param.delimiter = ' '
+        assert_equal '--foo bar', @param.to_shell
+      end
+
+      should "accept arbitrary delimiter" do
+        @param.delimiter = ' ||= '
+        assert_equal '--foo ||= bar', @param.to_shell
+      end
+
+      should "accept empty prefix" do
+        @param.prefix = ''
+        assert_equal 'foo=bar', @param.to_shell
+      end
+
+      should "accept arbitrary prefix" do
+        @param.prefix = '++++'
+        assert_equal '++++foo=bar', @param.to_shell
+      end
+
+      should "accept hidden_name attribute" do
+        @param.hidden_name = true
+        assert_equal 'bar', @param.to_shell
+      end
+
+      should "accept hidden_value attribute" do
+        @param.hidden_value = true
+        assert_equal '--foo', @param.to_shell
+      end
+
+    end
+  end
+end
+

data/test/unit/executable_test.rb

@@ -0,0 +1,237 @@
+require File.dirname(__FILE__) + '/test_helper'
+require 'test/fixtures/executable/mxmlc'
+require 'test/unit/fake_other_executable'
+
+class ExecutableTest < Test::Unit::TestCase
+  include SproutTestCase
+
+  context "a new executable delegate" do
+
+    setup do
+      @tool = FakeOtherExecutableTask.new
+    end
+
+    should "accept boolean param" do
+      @tool.boolean_param = true
+      assert @tool.boolean_param
+      assert_equal "--boolean-param", @tool.to_shell
+    end
+
+    should "accept a string param" do
+      @tool.string_param = "string1"
+      assert_equal "string1", @tool.string_param
+      assert_equal "--string-param=string1", @tool.to_shell
+    end
+
+    should "not share parameter values across instances" do
+      first = FakeOtherExecutableTask.new
+      second = FakeOtherExecutableTask.new
+      first.string_param = 'value1'
+      second.string_param = 'value2'
+      assert first.string_param != second.string_param
+    end
+
+    should "accept strings param" do
+      @tool.strings_param << 'string1'
+      @tool.strings_param << 'string2'
+
+      assert_equal ['string1', 'string2'], @tool.strings_param
+      assert_equal "--strings-param+=string1 --strings-param+=string2", @tool.to_shell
+    end
+
+    should "accept number param" do
+      @tool.number_param = 1234
+      assert_equal 1234, @tool.number_param
+    end
+
+    should "accept parameter alias" do
+      @tool.strings_param << "a"
+      @tool.sp << "b"
+
+      assert_equal ["a", "b"], @tool.sp
+    end
+
+    should "raise UsageError with unknown type" do
+      assert_raises Sprout::Errors::UsageError do
+        class BrokenExecutable
+          include Sprout::Executable
+          add_param :broken_param, nil
+        end
+
+        tool = BrokenExecutable.new
+      end
+    end
+
+    should "raise Error if type is not a Class" do
+      assert_raises Sprout::Errors::UsageError do
+        class BrokenExecutable2
+          include Sprout::Executable
+          add_param :some_name, :string
+        end
+      end
+    end
+
+    should "raise Error when requested param name already exists" do
+      assert_raises Sprout::Errors::DuplicateMemberError do
+        class BrokenExecutable3
+          include Sprout::Executable
+          attr_accessor :existing_method
+
+          add_param :existing_method, String
+        end
+      end
+    end
+
+    should "raise Error if a block is provided to add_param" do
+      assert_raises Sprout::Errors::UsageError do
+        class BrokenExecutable4
+          include Sprout::Executable
+          add_param :name, String do
+            # this is no longer how it's done...
+          end
+        end
+      end
+    end
+
+    should "define a new method" do
+      class WorkingTool
+        include Sprout::Executable
+        add_param :custom_name, String
+      end
+
+      tool1 = WorkingTool.new
+      tool1.custom_name = "Foo Bar"
+      assert_equal "Foo Bar", tool1.custom_name
+
+      tool2 = WorkingTool.new
+      tool2.custom_name = "Bar Baz"
+      assert_equal "Bar Baz", tool2.custom_name
+    end
+
+    should "accept custom reader" do
+      class WorkingTool
+        include Sprout::Executable
+        add_param :custom1, String, { :reader => :read_custom }
+        def read_custom
+          "#{@custom1} world"
+        end
+      end
+
+      tool = WorkingTool.new
+      tool.custom1 = 'hello'
+      assert_equal 'hello world', tool.custom1
+    end
+
+    should "accept custom writer" do
+      class WorkingTool
+        include Sprout::Executable
+        add_param :custom2, String, { :writer => :write_custom }
+        def write_custom(value)
+          @custom2 = "#{value} world"
+        end
+      end
+
+      tool = WorkingTool.new
+      tool.custom2 = 'hello'
+      assert_equal 'hello world', tool.custom2
+    end
+
+    # TODO: Ensure that file, files, path and paths
+    # validate the existence of the references.
+
+    # TODO: Ensure that a helpful error message is thrown
+    # when assignment operator is used on collection params
+  end
+
+  context "a new mxmlc task" do
+
+    setup do
+      @tool = Sprout::MXMLC.new
+      @mxmlc_executable = File.join(fixtures, 'executable', 'flex3sdk_gem', 'mxmlc')
+    end
+
+    should "accept input" do
+      @tool.input = "test/fixtures/executable/src/Main.as"
+      assert_equal "test/fixtures/executable/src/Main.as", @tool.input
+      assert_equal "test/fixtures/executable/src/Main.as", @tool.to_shell
+    end
+
+    should "accept default gem name" do
+      assert_equal 'flex4sdk', @tool.pkg_name
+    end
+
+    should "override default gem name" do
+      @tool.pkg_name = 'flex5sdk'
+      assert_equal 'flex5sdk', @tool.pkg_name
+    end
+
+    should "accept default gem version" do
+      assert_equal '>= 1.0.pre', @tool.pkg_version
+    end
+
+    should "override default gem version" do
+      @tool.pkg_version = '1.1.pre'
+      assert_equal '1.1.pre', @tool.pkg_version
+    end
+
+    should "accept default gem executable" do
+      assert_equal :mxmlc, @tool.executable
+    end
+
+    should "override default gem executable" do
+      @tool.executable = :compc
+      assert_equal :compc, @tool.executable
+    end
+
+    should "accept configuration as a file task" do
+      @tool = mxmlc 'bin/SomeFile.swf' do |t|
+        t.source_path << 'test/fixtures/executable/src'
+        t.input = 'test/fixtures/executable/src/Main.as'
+      end
+      assert_equal 'bin/SomeFile.swf', @tool.output
+      assert_equal "--output=bin/SomeFile.swf --source-path+=test/fixtures/executable/src test/fixtures/executable/src/Main.as", @tool.to_shell
+    end
+
+    should "accept configuration with prereqs as a file task" do
+      task :other_task
+      @tool = mxmlc 'bin/SomeFile.swf' => [:clean, :other_task] do |t|
+        t.source_path << 'test/fixtures/executable/src'
+        t.input = 'test/fixtures/executable/src/Main.as'
+      end
+      assert_equal 'bin/SomeFile.swf', @tool.output
+      assert_equal "--output=bin/SomeFile.swf --source-path+=test/fixtures/executable/src test/fixtures/executable/src/Main.as", @tool.to_shell
+    end
+
+    should "to_shell input" do
+      @tool.debug = true
+      @tool.source_path << "test/fixtures/executable/src"
+      assert_equal "--debug --source-path+=test/fixtures/executable/src", @tool.to_shell
+    end
+
+    should "execute the registered executable" do
+      # Configure stub executable:
+      @tool.input = 'test/fixtures/executable/src/Main.as'
+      @tool.source_path << 'test/fixtures/executable/src'
+      @tool.debug = true
+      response = OpenStruct.new(:path => @mxmlc_executable)
+      Sprout::Executable.expects(:load).with(:mxmlc, 'flex4sdk', '>= 1.0.pre').returns response
+
+      # Ensure the exe file mode is NOT valid:
+      File.chmod 0644, @mxmlc_executable
+      first = File.stat(@mxmlc_executable).mode
+
+      # Execute the stub executable:
+      @tool.execute
+
+      # Ensure the file mode was updated:
+      assert "non-executable file mode should be updated by execute", first != File.stat(@mxmlc_executable).mode
+    end
+
+    should "include prerequisites" do
+      @tool.input = 'test/fixtures/executable/src/Main.as'
+      file_task = @tool.to_rake('bin/SomeProject.swf')
+      assert_equal 2, file_task.prerequisites.size
+    end
+  end
+end
+