sprout 1.0.35.pre → 1.1.2.pre

data/lib/sprout.rb

@@ -1,9 +1,140 @@
+
 lib = File.expand_path File.dirname(__FILE__)
 $:.unshift lib unless $:.include?(lib)
 
-require 'sprout/base'
+# External tools and std libs:
+require 'rake'
+require 'delegate'
+require 'logger'
+
+# Core, Process and Platform support:
+require 'sprout/version'
+require 'sprout/output_buffer'
+require 'sprout/progress_bar'
+require 'sprout/dir'
+require 'sprout/string'
+require 'sprout/errors'
+require 'sprout/platform'
+require 'sprout/process_runner'
+require 'sprout/system'
+require 'sprout/concern'
+require 'sprout/ruby_feature'
+
+##
+# This is a fix for Issue #106
+# http://code.google.com/p/projectsprouts/issues/detail?id=106
+# Which is created because the new version (1.0.1) of RubyGems
+# includes open-uri, while older versions do not.
+# When open-uri is included twice, we get a bunch of nasty
+# warnings because constants are being overwritten.
+gem_version = Gem::Version.new(Gem::RubyGemsVersion)
+if(gem_version != Gem::Version.new('1.0.1'))
+  require 'open-uri'
+end
+
+# File, Archive and Network support:
+require 'sprout/archive_unpacker'
+require 'sprout/file_target'
+require 'sprout/remote_file_loader'
+require 'sprout/remote_file_target'
+
+# External Packaging and distribution support:
+require 'sprout/rdoc_parser'
+require 'sprout/specification'
+require 'sprout/executable'
+require 'sprout/daemon'
+
+# Generators
+require 'sprout/generator'
+
+# Libraries
+require 'sprout/library'
 
 module Sprout
-  include Base
+
+  class << self
+
+    ##
+    # @return [Dir] The system-specific path to the writeable cache directory
+    # where Sprouts will look for downloaded archives.
+    #
+    #   puts ">> Sprout Cache: #{Sprout.cache}"
+    #
+    def cache
+      File.join(home, 'cache')
+    end
+
+    ##
+    # @return [Dir] The location where the currently-running version of Sprouts
+    # will write files and generators and their templates.
+    #
+    #   puts ">> Sprout home: #{Sprout.home}"
+    #
+    def home
+      File.join(current_system.application_home('sprouts'), Sprout::VERSION::MAJOR_MINOR)
+    end
+
+    ##
+    # @return [Dir] The location where Sprouts will look for generators and their
+    # templates.
+    #
+    #   puts ">> Generator Cache: #{Sprout.generator_cache}"
+    #
+    def generator_cache
+      File.join cache, 'generators'
+    end
+
+    ##
+    # @return [Sprout::System] That is currently being used to 
+    # determine features like the cache path and how external processes
+    # are executed.
+    #
+    #   system = Sprout.current_system
+    #   puts ">> System: #{system.inspect}"
+    #
+    def current_system
+      Sprout::System.create
+    end
+    
+    def stdout=(out)
+      @stdout = out
+    end
+    
+    def stdout
+      @stdout ||= $stdout
+    end
+    
+    def stdout_test
+      OutputBuffer.new 'test-stdout.log'
+    end
+    
+    def stderr=(err)
+      @stderr = err
+    end
+    
+    def stderr
+      @stderr ||= $stderr
+    end
+    
+    def stderr_test
+      OutputBuffer.new 'test-stderr.log'
+    end
+
+    ##
+    # @return [File] Path to the file from the 'caller' property of
+    # a Ruby exception.
+    #
+    # Note: It's a real bummer that this string is colon delimited -
+    # The value on Windows often includes a colon...
+    # Once again, Windows is dissed by fundamental Ruby decisions.
+    def file_from_caller caller_string
+      parts = caller_string.split(':')
+      str   = parts.shift
+      while(parts.size > 0 && !File.exists?(str))
+        str << ":#{parts.shift}"
+      end
+      str
+    end
+  end
 end
 

data/rakefile.rb

@@ -18,6 +18,8 @@ require 'rake/testtask'
 #   yard
 #
 
+CLEAN.add 'doc'
+
 namespace :test do
   Rake::TestTask.new(:units) do |t|
     t.libs << "test/unit"

data/test/fixtures/examples/echo_inputs.rb

@@ -5,8 +5,7 @@ require 'sprout'
 
 class CustomParameter < Sprout::Executable::Param; end
 
-class EchoInputs
-  include Sprout::Executable
+class EchoInputs < Sprout::Executable::Base
   
   ##
   # A boolean parameter that will be set to true if present.

data/test/fixtures/executable/fdb.rb

@@ -1,11 +1,7 @@
 
 module Sprout
 
-  class FDB
-
-    ####################################
-    # Begin Executable Configuration
-    include Executable
+  class FDB < Daemon
 
     set :default_prefix, '-'
 
@@ -21,12 +17,14 @@ module Sprout
     # The default executable target
     set :executable, :fdb
 
-    ####################################
-    # Begin Daemon Configuration
-    include Daemon
-
+    ##
+    # The regex for when input can be accepted again.
     set :prompt, /^\(fdb\) |\(y or n\) /
 
+    ##
+    # Force the fake to write to stderr:
+    add_action :run_with_error
+
     ##
     # Print a backtrace of all stack frames
     add_action :backtrace

data/test/fixtures/executable/flex3sdk_gem/fdb

@@ -13,22 +13,33 @@ class FakeFDB
   def gather_input
     $stdout.flush
     command = $stdin.gets.chomp!
-    if command == "run"
-      handle_run
-    elsif command == "continue"
-      handle_continue
-    elsif command == "kill"
-      handle_kill
-    elsif command == "quit"
-      handle_quit
+    parts = command.split(' ')
+    name = parts.shift
+
+    case name
+    when "run"
+      handle_run parts
+    when "break"
+      handle_break parts
+    when "continue"
+      handle_continue parts
+    when "kill"
+      handle_kill parts
+    when "y"
+      handle_confirmation parts
+    when "quit"
+      handle_quit parts
+    when "run_with_error"
+      handle_run_with_error parts
     else
-      puts ""
-      raise "Don't know how to respond to #{command}"
+      puts "FAKE FDB doesn't know how to respond to #{command}"
+      exit 1
     end
+
     gather_input
   end
 
-  def handle_run
+  def handle_run args
     str = "Waiting for Player to connect\n"
     str << "Player connected; session starting.\n"
     str << "Set breakpoints and then type 'continue' to resume the session.\n"
@@ -37,24 +48,44 @@ class FakeFDB
     printf str
   end
 
-  def handle_continue
+  def handle_break args
     str = "Breakpoint 1, AsUnitRunner() at AsUnitRunner.as:12\n"
     str << "12                core = new TextCore();\n"
     str << "(fdb) "
     printf str
   end
 
-  def handle_kill
+  def handle_continue args
+    str = "Continuing now\n"
+    str << "(fdb) "
+    printf str
+  end
+
+  def handle_kill args
     printf "Kill the program being debugged? (y or n) "
   end
 
-  def handle_quit
-    puts ">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>"
-    puts ">> EXITING NOW!"
-    exit
+  def handle_confirmation args
+    str = "Confirmation accepted\n"
+    str << "(fdb) "
+    printf str
+  end
+
+  def handle_run_with_error args
+    str = "This is an error!\n"
+    str << "This is more details about the error!\n"
+    str << "Here are even more details!\n"
+    $stderr.printf str
+    printf "(fdb) "
+  end
+
+  def handle_quit args
+    str << ">> EXITING NOW!\n"
+    puts str
+    exit! 0
   end
 
 end
 
-fdb = FakeFDB.new
+fake_fdb = FakeFDB.new
 

data/test/fixtures/executable/mxmlc.rb

@@ -33,8 +33,7 @@ module Sprout
   # Interface and descriptions found here:
   # http://livedocs.adobe.com/flex/2/docs/wwhelp/wwhimpl/common/html/wwhelp.htm?context=LiveDocs_Parts&file=00001481.html
   #
-  class MXMLC
-    include Sprout::Executable
+  class MXMLC < Sprout::Executable::Base
     
     ##
     # Enables accessibility features when compiling the Flex application or SWC file. The default value is false.

data/test/fixtures/executable/subclass/executable_subclass.rb

@@ -1,6 +1,5 @@
 
 class ExecutableSubclass < ExecutableSuperclass
-  include Sprout::Executable
 
   add_param :subclass_param, String
 end

data/test/fixtures/executable/subclass/executable_superclass.rb

@@ -1,6 +1,5 @@
 
-class ExecutableSuperclass
-  include Sprout::Executable
+class ExecutableSuperclass < Sprout::Executable::Base
 
   set :default_prefix, '---'
 

data/test/fixtures/specification/flex4sdk.rb

@@ -1,31 +1,42 @@
-# This is a sample Sprout Specification.
-#
-# This document describes the Flex 4 SDK in terms of the libraries and executables
-# that is provides.
-#
-# Whenever this file is loaded (required) by a Ruby application that has already loaded
-# the core sprout files, the remote_file_target will be downloaded and installed,
-# and each executable and library will be available to any interested rake
-# tasks.
-#
-# An example of how one might retrieve a path to the downloaded MXMLC executable is
-# as follows:
-#
-#     Sprout.get_executable :mxmlc, 'flex4sdk', '>= 4.0.pre'
-#
-Sprout::Specification.new do |s|
 
-  s.name    = 'flex4sdk'
-  s.version = '4.0.pre'
+Sprout::Specification.new do |s|
+  # This is the Specification that loads the Flex 4 SDK,
+  # To use the Flex 4 SDK from your build tasks, you can
+  # simply update the pkg_name parameter of your build 
+  # task as follows:
+  #
+  #   mxmlc 'bin/SomeProject.swf' do |t|
+  #     t.input       = 'src/SomeProject.as'
+  #     t.pkg_name    = 'flex4'
+  #   end
+  #
+  # If you'd like to consume any of the libraries that
+  # are included with the Flex SDK, you can embed them
+  # from your Rakefile as follows:
+  #
+  #   library :f_textlayout
+  #
+  #   mxmlc 'bin/SomeProject.swf' => :f_textlayout do |t|
+  #     t.input = 'src/SomeProject.as'
+  #   end
+  #
+  # If you'd like to consume one of the localized frameworks
+  # you can set that up as follows:
+  #
+  #   library 'flex_4_es_ES'
+  #
+  #   mxmlc 'bin/SomeProject.swf' => 'flex_4_es_ES' do |t|
+  #     t.input = 'src/SomeProject.as'
+  #   end
+  #
+  s.name    = 'flex4'
+  s.version = '4.1.0.16076'
 
   s.add_remote_file_target do |t|
-    # Apply the windows-specific configuration:
-    t.platform = :universal
-    # Apply the shared platform configuration:
-    # Remote Archive:
+    t.platform     = :universal
     t.archive_type = :zip
-    t.url          = "http://download.macromedia.com/pub/labs/flex/4/flex4sdk_b2_100509.zip"
-    t.md5          = "6a0838c5cb33145fe88933778ddb966d"
+    t.url          = "http://fpdownload.adobe.com/pub/flex/sdk/builds/flex4/flex_sdk_4.1.0.16076.zip"
+    t.md5          = "4c5f3d3fa4e1f5be244679210cd852c0"
 
     # Executables: (add .exe suffix if it was passed in)
     t.add_executable :aasdoc,     "bin/aasdoc"

data/test/unit/archive_unpacker_test.rb

@@ -1,7 +1,7 @@
 require 'test_helper'
 
 class ArchiveUnpackerTest < Test::Unit::TestCase
-  include SproutTestCase
+  include Sprout::TestHelper
 
   def setup
     super

data/test/unit/boolean_param_test.rb

@@ -1,7 +1,7 @@
 require 'test_helper'
 
 class BooleanParamTest < Test::Unit::TestCase
-  include SproutTestCase
+  include Sprout::TestHelper
 
   context "a new, simple BooleanParam" do
 

data/test/unit/daemon_test.rb

@@ -2,18 +2,20 @@ require 'test_helper'
 require 'fixtures/executable/fdb'
 
 class DaemonTest < Test::Unit::TestCase
-  include SproutTestCase
+  include Sprout::TestHelper
 
   context "a new daemon delegate" do
 
     setup do
-      # Uncomment to see actual output:
-      #Sprout::Log.debug = false
       configure_fdb_fake
     end
 
     should "execute without shell params" do
       @fdb = Sprout::FDB.new
+      # For some reason, using mocha expectations are 
+      # actually stubbing the methods and breaking this
+      # test. Not sure what I'm doing wrong here...
+      #@fdb.expects(:execute_action).at_least(6)
       @fdb.run
       @fdb.break "AsUnitRunner:12"
       @fdb.continue
@@ -23,6 +25,36 @@ class DaemonTest < Test::Unit::TestCase
       @fdb.execute
     end
 
+    should "open and wait for real-time interactions" do
+      @fdb = Sprout::FDB.new
+      # For some reason, using mocha expectations are 
+      # actually stubbing the methods and breaking this
+      # test. Not sure what I'm doing wrong here...
+      #@fdb.expects(:execute_action).at_least(6)
+      @fdb.execute false
+      @fdb.run
+      @fdb.break "AsUnitRunner:12"
+      @fdb.continue
+      @fdb.kill
+      @fdb.confirm
+      @fdb.quit
+      @fdb.wait # wait for actions to finish.
+    end
+
+=begin
+    should "print errors" do
+      @fdb = Sprout::FDB.new
+      # For some reason, using mocha expectations are 
+      # actually stubbing the methods and breaking this
+      # test. Not sure what I'm doing wrong here...
+      #@fdb.expects(:execute_action).at_least(6)
+      @fdb.execute false
+      @fdb.run_with_error
+      @fdb.quit
+      @fdb.wait # wait for actions to finish.
+    end
+=end
+
     should "execute from rake task" do
       f = fdb :fdb_debug do |t|
         t.run

data/test/unit/executable_option_parser_test.rb

@@ -2,7 +2,7 @@ require 'test_helper'
 require 'fixtures/examples/echo_inputs'
 
 class ExecutableOptionParserTest < Test::Unit::TestCase
-  include SproutTestCase
+  include Sprout::TestHelper
 
   context "a new ruby executable" do
     
@@ -109,8 +109,7 @@ class ExecutableOptionParserTest < Test::Unit::TestCase
 
       # Define the class in a place
       # where only these tests can use it.
-      class SomeExecutable
-        include Sprout::Executable
+      class SomeExecutable < Sprout::Executable::Base
         add_param :debug, Boolean
         add_param :input, String, { :hidden_name => true }
       end

data/test/unit/executable_param_test.rb

@@ -1,7 +1,7 @@
 require 'test_helper'
 
 class ExecutableParamTest < Test::Unit::TestCase
-  include SproutTestCase
+  include Sprout::TestHelper
 
   context "a new, simple Executable::Param" do
 

data/test/unit/executable_test.rb

@@ -5,7 +5,7 @@ require 'fixtures/executable/subclass/executable_superclass'
 require 'fixtures/executable/subclass/executable_subclass'
 
 class ExecutableTest < Test::Unit::TestCase
-  include SproutTestCase
+  include Sprout::TestHelper
 
   context "a new executable delegate" do
 
@@ -74,8 +74,7 @@ class ExecutableTest < Test::Unit::TestCase
 
     should "raise UsageError with unknown type" do
       assert_raises Sprout::Errors::UsageError do
-        class BrokenExecutable
-          include Sprout::Executable
+        class BrokenExecutable < Sprout::Executable::Base
           add_param :broken_param, nil
         end
 
@@ -85,8 +84,7 @@ class ExecutableTest < Test::Unit::TestCase
 
     should "raise Error if type is not a Class" do
       assert_raises Sprout::Errors::UsageError do
-        class BrokenExecutable2
-          include Sprout::Executable
+        class BrokenExecutable2 < Sprout::Executable::Base
           add_param :some_name, :string
         end
       end
@@ -94,8 +92,7 @@ class ExecutableTest < Test::Unit::TestCase
 
     should "raise Error when requested param name already exists" do
       assert_raises Sprout::Errors::DuplicateMemberError do
-        class BrokenExecutable3
-          include Sprout::Executable
+        class BrokenExecutable3 < Sprout::Executable::Base
           attr_accessor :existing_method
 
           add_param :existing_method, String
@@ -105,8 +102,7 @@ class ExecutableTest < Test::Unit::TestCase
 
     should "raise Error if a block is provided to add_param" do
       assert_raises Sprout::Errors::UsageError do
-        class BrokenExecutable4
-          include Sprout::Executable
+        class BrokenExecutable4 < Sprout::Executable::Base
           add_param :name, String do
             # this is no longer how it's done...
           end
@@ -115,8 +111,7 @@ class ExecutableTest < Test::Unit::TestCase
     end
 
     should "define a new method" do
-      class WorkingTool
-        include Sprout::Executable
+      class WorkingTool < Sprout::Executable::Base
         add_param :custom_name, String
       end
 
@@ -130,8 +125,7 @@ class ExecutableTest < Test::Unit::TestCase
     end
 
     should "accept custom reader" do
-      class WorkingTool
-        include Sprout::Executable
+      class WorkingTool < Sprout::Executable::Base
         add_param :custom1, String, { :reader => :read_custom }
         def read_custom
           "#{@custom1} world"
@@ -144,8 +138,7 @@ class ExecutableTest < Test::Unit::TestCase
     end
 
     should "accept custom writer" do
-      class WorkingTool
-        include Sprout::Executable
+      class WorkingTool < Sprout::Executable::Base
         add_param :custom2, String, { :writer => :write_custom }
         def write_custom(value)
           @custom2 = "#{value} world"

data/test/unit/fake_other_executable.rb

@@ -1,8 +1,7 @@
 
 class CustomFakeParameter < Sprout::Executable::StringParam; end
 
-class FakeOtherExecutableTask
-  include Sprout::Executable
+class FakeOtherExecutableTask < Sprout::Executable::Base
 
   add_param :boolean_param, Boolean
   add_param :custom_param,  CustomFakeParameter

data/test/unit/file_param_test.rb

@@ -1,7 +1,7 @@
 require 'test_helper'
 
 class FileParamTest < Test::Unit::TestCase
-  include SproutTestCase
+  include Sprout::TestHelper
 
   context "a new FileParam" do
 

data/test/unit/file_target_test.rb

@@ -1,7 +1,7 @@
 require 'test_helper'
 
 class FileTargetTest < Test::Unit::TestCase
-  include SproutTestCase
+  include Sprout::TestHelper
 
   context "a file target" do
     setup do

data/test/unit/files_param_test.rb

@@ -1,7 +1,7 @@
 require 'test_helper'
 
 class FilesParamTest < Test::Unit::TestCase
-  include SproutTestCase
+  include Sprout::TestHelper
 
   context "a new FilesParam" do
 

data/test/unit/generator_generator_test.rb

@@ -3,7 +3,7 @@ require 'test_helper'
 require 'sprout/generators/generator/generator_generator'
 
 class GeneratorGeneratorTest < Test::Unit::TestCase
-  include SproutTestCase
+  include Sprout::TestHelper
 
   context "A new generator generator" do
 

data/test/unit/generator_test.rb

@@ -1,7 +1,7 @@
 require 'test_helper'
 
 class GeneratorTest < Test::Unit::TestCase
-  include SproutTestCase
+  include Sprout::TestHelper
 
   context "The Sprout::Generator" do
 

data/test/unit/library_generator_test.rb

@@ -2,7 +2,7 @@ require 'test_helper'
 require 'sprout/generators/library/library_generator'
 
 class LibraryGeneratorTest < Test::Unit::TestCase
-  include SproutTestCase
+  include Sprout::TestHelper
 
   context "A generated library" do
 

data/test/unit/library_test.rb

@@ -1,7 +1,7 @@
 require 'test_helper'
 
 class LibraryTest < Test::Unit::TestCase
-  include SproutTestCase
+  include Sprout::TestHelper
 
   context "a new archive library" do
     setup do

data/test/unit/osx_system_test.rb

@@ -1,7 +1,7 @@
 require 'test_helper'
 
 class OSXSystemTest < Test::Unit::TestCase
-  include SproutTestCase
+  include Sprout::TestHelper
 
   context "new osx system" do
 

data/test/unit/path_param_test.rb

@@ -1,7 +1,7 @@
 require 'test_helper'
 
 class PathParamTest < Test::Unit::TestCase
-  include SproutTestCase
+  include Sprout::TestHelper
 
   context "a new PathParam" do