sprout 0.5.29 → 0.7.153

data/TODO

@@ -0,0 +1,12 @@
+
+---------------------------------
+In the interest of being a better member of our growing community, 
+I have extracted the contents of this file to the googlecode site at:
+
+http://code.google.com/p/projectsprouts/issues/list?q=label:Beta1.0&can=2
+
+Please feel free to check over the available issues and see if any look appealing!
+
+If you're considering a contribution, please check in on our mailing list first just to be sure.
+(projectsprouts@googlegroups.com)
+

data/bin/sprout

@@ -9,177 +9,120 @@ rescue LoadError
   # no rubygems to load, so we fail silently
 end
 
-require 'optparse'
+$:.push(File.dirname(__FILE__) + '/../lib')
 require 'sprout'
-#require File.dirname(__FILE__) + '/../lib/sprout'
-include PatternPark
+require 'sprout/generator'
+require 'optparse'
 
 OPTIONS = {
-  :locations          => [],
+  :sources            => [],
   :project_name       => nil,
   :sprout_name        => nil,
-  :update             => false,
-  :update             => false,
-  :clean              => false
+  :requirements	      => nil,
+  :remove_all         => false
 }
 
+def fail_with(opts, message)
+  puts "[ERROR] #{message}"
+  puts ""
+  puts opts
+  exit
+end
+
 parser = OptionParser.new do |opts|
   opts.banner = <<BANNER
-Sprouts is an open-source, cross-platform project generation and configuration tool
-If you would like to edit or remove installed sprout contents or definitions,
-simply navigate to the following location:
+Sprout is an open-source, cross-platform project generation and configuration tool
 
-#{User.application_home(:sprouts)}
+Usage: #{File.basename($0)} [options] [ProjectName]
 
-Usage: #{File.basename($0)} [options]
+Examples:
 
-Options are:
-BANNER
-  opts.separator ""
-  opts.on("-s", "--sprout=NAME", String,
-          "[DEPRECATED] The name of the sprout to create (e.g., as2 as3, haxe, or mxml)"
-          ) do |name|
-            OPTIONS[:sprout_name] = name
-          end
-  opts.on("-n", "--name=NAME", String,
-          "The name of the sprout to create (e.g., as2 as3, haxe, or mxml)"
-          ) do |name|
-            OPTIONS[:sprout_name] = name
-          end
-  opts.on("-l", "--locations=URL[,URL2,URL3]", String,
-          "Insert url(s) into the http search path for sprout definitions"
-          ) do |name|
-            OPTIONS[:locations] = name.split(',')
-          end
-  opts.on("-f", "--force",
-          "Force project creation, overwrite if necessary"
-          ) do |force|
-            OPTIONS[:force] = force
-          end
-  opts.on("-u", "--update",
-          "Update the local versions of all referenced sprouts"
-          ) do 
-            OPTIONS[:update] = true
-          end
-  opts.on("-h", "--help",
-          "Show this help message.") { puts opts; exit }
-  opts.parse!(ARGV)
-  
-  if(OPTIONS[:sprout_name].nil? && OPTIONS[:update])
-    OPTIONS[:sprout_name] = ARGV.pop
-  else
-    OPTIONS[:project_name] = ARGV.pop
-  end
-end
+Create a new ActionScript 3.0 project named 'SomeProject':
+  #{File.basename($0)} -n as3 SomeProject
 
-#############################################
+Create a new ActionScript 2.0 project named 'OtherProject':
+  #{File.basename($0)} -n as2 OtherProject
 
-sprout_name         = OPTIONS[:sprout_name]
-project_name        = OPTIONS[:project_name]
-locations           = OPTIONS[:locations]
-update              = OPTIONS[:update]
-clean               = OPTIONS[:clean]
-
-#############################################
+Remove all Sprout gems and cached files:
+  #{File.basename($0)} -R
 
-# Add the provided locations to the sprout search path
-if(locations.size > 0)
-  Sprout.insert_locations(OPTIONS[:locations])
-end
+Options are:
+BANNER
+  opts.separator ""
 
-if(sprout_name.nil?)
-  puts "\n[ERROR] You MUST provide a sprout name, this is usually done with the -s [NAME] commandline option. Please enter a sprout name now:\n"
-  sprout_name = gets
-end
+  opts.on("-n", "--name NAME", String, "The name of the sprout bundle whose project generator will be executed (e.g., as2 or as3)") do |name|
+    OPTIONS[:sprout_name] = name
+  end
 
-if(update)
-  msg = <<EOF
-[WARNING] Are you sure you want to clobber all local sprout definitions referenced by "#{sprout_name}"? [Yn]
-EOF
-  puts msg
-  response = gets.chomp!
-  if(response == '' || response.downcase == 'y')
-    Sprout.update = true
-  else
-    Log.puts("[ERROR] Sprout execution terminated, please try again.")
-    exit
+  opts.on('--source [URL]', String, "Use URL as the remote source for gems") do |source|
+    OPTIONS[:sources] << source
   end
-end
 
-if(sprout_name && !project_name)
-  dir = Sprout.project_path
+  opts.on('-r', '--requirements REQUIREMENTS', String, "The specific gem version requirements for the named bundle (e.g., 0.3.2)") do |requirements|
+    OPTIONS[:requirements] = requirements
+  end
 
-  begin
-    rakefile = Sprout.rakefile
-    if(!rakefile.nil? && File.exists?(rakefile))
-      require rakefile
-      name = ProjectModel.instance.project_name
-      puts 'rakefile: ' + rakefile
-    else
-      raise LoadError.new('rakefile was not found')
-    end
-  rescue LoadError
-    name = File.basename(dir).capitalize
+  opts.on("-R", "--remove-all", "Remove all sprout gems and cached files") do
+    OPTIONS[:remove_all] = true
+    Sprout::Sprout.remove_all
   end
   
-  puts "\n[WARNING] No project name specified, please choose from the following:"
-  puts "(1) Enter Name: Let me enter a project name and execute from #{dir}"
-  puts "(2) No Project: I'm just updating some sprout definitions"
-  puts "(3) End Process: OOPs, I'll start over..."
-  if(name != nil && name != '')
-    puts "(4) Use Inferred Name: '#{name}' and load '#{sprout_name}' into #{dir}"
+  opts.on("-v", "--version", "Display the installed version of the sprout gem") do |version|
+    puts "sprout #{Sprout::VERSION::STRING}"
+    exit
   end
   
-  answer = $stdin.gets.chomp
+  opts.on("-h", "--help", "Show this help message.") do
+    puts opts
+    exit
+  end
   
-  case answer
-    when "1" :
-      puts "Enter a project name now:"
-      project_name = gets.chomp!
-    when "2" :
-    when "4" :
-      project_name = name
-    else
-      Log.puts("[ERROR] Sprout execution terminated, please try again.")
-      exit
+  opts.parse!(ARGV)
+  
+  if(OPTIONS[:sources].size > 0)
+    set_sources OPTIONS[:sources]
   end
 
-end
-
-# Create a new named Project
-if(sprout_name && project_name)
-  path = File.join(Sprout.project_path, project_name)
-  Sprout.project_path = path
-  if(File.exists?(path))
-    if(OPTIONS[:force])
-      FileUtils.rm_rf(path)
-    else
-      puts "[WARNING] Are you sure you want to destroy #{path} and all of it's contents? [Yn]"
-      result = gets.chomp!
-      if(result.downcase == 'y' || result == '')
-        FileUtils.rm_rf(path)
-      else
-        puts "[ERROR] Folder already exists at: #{path}, remove it or use -f to force project creation."
-        exit
+  if(ARGV.size > 0)
+    if(OPTIONS[:sprout_name])
+      OPTIONS[:project_name] = ARGV.pop
+      if(OPTIONS[:project_name] == "=")
+        fail_with(opts, "Invalid project name #{OPTIONS[:project_name]}")
       end
+    else
+      fail_with(opts, "You must provide a sprout name argument such as, '-n as2' or '-n as3'")
     end
+  elsif(OPTIONS[:remove_all])
+    exit
+  else
+    fail_with(opts, "Expected a sprout bundle name and project name like: 'sprout -n as2 SomeProject'")
   end
-  FileUtils.makedirs(path)
-  str = ''
-  80.times do
-    str += '-'
-  end
-  puts str
-  puts ">> Creating Sprout #{sprout_name} at #{path}"
-  Sprout.project_name = project_name
-  TemplateResolver.instance.replace_all = true
-  sprout = Sprout.load(sprout_name)
-  sprout.execute
+
 end
 
-if(sprout_name && update && !project_name)
-  sprout = Sprout.load(sprout_name)
-  sprout.execute
+#############################################
+
+sprout_name         = OPTIONS[:sprout_name]
+sprout_requirements	= OPTIONS[:requirements]
+project_name        = OPTIONS[:project_name]
+
+#############################################
+
+puts ">> Creating new project '#{project_name}' with #{sprout_name}"
+Sprout::Sprout.project_name = project_name
+
+begin
+    # Fallback if a version was specified
+    if(sprout_requirements)
+      sprout(sprout_name, sprout_requirements)
+    end
+    # Try to run the generator against user home and existing gems first
+    Sprout::Sprout.generate(sprout_name, 'project', [project_name])
+rescue Rails::Generator::GeneratorError
+    # Failing that, try to download a sprout gem by name
+    sprout(sprout_name, sprout_requirements)
+    # Then try again....
+    Sprout::Sprout.generate(sprout_name, 'project', [project_name])
 end
 
-Log.flush
+Sprout::Log.flush

data/doc/Bundle

@@ -0,0 +1,14 @@
+
+A Sprout Bundle is a collection of Ruby code that supports a particular interest or technology. At the time of this writing, we have two bundles available.
+
+* ActionScript 2 Bundle (link[link:files/bundles/as2/README.html]) which supports ActionScript 2.0 development
+* ActionScript 3 Bundle (link[link:files/bundles/as3/README.html]) which supports ActionScript 3.0, MXML and AIR development
+
+Bundles are the named entry point that the +sprout+ shell tool uses to find project generators[link:files/doc/Generator.html].
+
+Bundles should be packaged and published to the RubyForge gem repository with very specific names as follows:
+
+sprout-#{bundle_name}-bundle where ${bundle_name} is what will be given to the -n parameter of the +sprout+ gem.
+
+The as3 bundle is released as sprout-as3-bundle on RubyForge, but we can simply enter the short name when creating new as3 projects.
+

data/doc/Generator

@@ -0,0 +1,35 @@
+A SproutGenerator is a set of specifically configured folders and files that have been placed in a particular, expected location on disk.
+The Sprout generator feature is a minor modification to the standard Rails generators.
+
+Sprouts modifies the underlying Rails Generator implementation mainly by changing where it looks for available, named generators. This was an importat change that will help prevent Sprout projects from clobbering generators that are intended for Rails support and vice versa. We also have a slightly different requirement in that we need support for multiple languages or technologies while Rails is able to simply expect that it's generating Ruby code. 
+
+Generators can exist in multiple different locations on disk, to learn how to create a new generator, see the Rails documentation[http://wiki.rubyonrails.org/rails/pages/UnderstandingGenerators].
+
+To use a new or existing generator, simply enter it's name from within a project after calling
+  script/generate
+
+When a string is passed to the generate command, sprouts will look in the following locations in the following order with 'name' being the generator name that you have requested:
+* #{project_path}/generators/#{name}
+* #{project_path}/script/generators/#{name}
+* #{project_path}/vendor/generators/#{name}
+* #{Sprout::Sprout.sprout_cache}/generators/#{Sprout::ProjectModel.language}/#{name}
+* All Rubygems with a name ending with '-bundle' and with contents that match '/lib/sprout/**/generators/[name]'
+
+This means that when you have a new project and enter:
+  script/generate foo
+
+We will first look in your project for, 'generators/foo', 'script/generators/foo' and 'vendor/generators/foo'.
+
+Assuming no viable generator is found in your project, we will then look in your Sprout::Sprout sprout_cache for a folder named 'generators/foo'.
+
+Assuming no viable generator is found in your system wide path, we will begin looking inside of installed Ruby Gems. The expected gem will have a file at:
+
+  lib/sprout/**/generators/foo/foo_generator.rb
+
+If no named generator is found in any of these places an exception will be encountered.
+
+Sprouts generators can be initiated from one of two places, either from a project directory with script/generate or directly from the Sprout gem.
+
+When executing generators directly from the Sprout gem, you must send in a bundle base name and know that only 'project' generators found in that bundle will be executed.
+
+When executing generators from a project, the Sprout::ProjectModel language parameter is used to determine the bundle (if necessary), and then the Generator name is used to execute any found generator.

data/doc/Library

@@ -0,0 +1,63 @@
+
+A Library is simply shared code. Some libraries are distributed with only source, others are only pre-compiled binaries (SWC for ActionScript libraries), and still others are made available in both forms. 
+
+The Sprout::LibraryTask will download and copy a remote library sprout gem.
+The remote archive can include (or reference) either source or a pre-compiled
+file. For ActionScript libraries, this would be a SWC file.
+
+This task is integrated with some of the compiler tasks in such
+a way that if an Sprout::MXMLCTask has any number of library tasks in
+it's prerequisites list, each of those libraries will be added
+to the compiler directive appropriately.
+
+Following is a simple example of a library task. Using only
+this simple task definition, the Adobe corelib library sprout gem
+will be downloaded, installed and copied to your Sprout::ProjectModel +lib_dir+.
+  
+  library :corelib
+
+By adding this named task as a prerequisite to your compilation task,
+that SWC will also be added to the Sprout::MXMLCTask +library_path+ parameter.
+
+  mxmlc 'bin/SomeProject.swf' => :corelib
+
+You can also specify a particular library gem version if the library
+has changed since your project began.
+
+  library :asunit3 do |t|
+    t.version = '3.0.1'
+  end
+
+This will ensure that only that particular library version is used for this project.
+
+You may want to refer to a library using a particular task name, but have it
+use a different library sprout gem. This can be done using the gem_name parameter
+as follows:
+
+  library :asunit do |t|
+    t.gem_name = 'sprout-asunit3-library'
+  end
+
+This may be useful because now the AsUnit[http://www.asunit.org] sources will be installed to:
+  lib/asunit
+instead of:
+  lib/asunit3
+and you can now depend on this library as simply +:asunit+ in your compiler tasks.
+
+You can easily create your own library gems using the Sprout::GemWrapTask and then
+refer to them by gem name. 
+
+In order to share your library tasks, you will need to
+do one of the following:
+
+* Tell interested developers to manually install your library gem
+* Upload your gem to any Rubyforge[http://www.rubyforge.org] project file releases area.
+    If your gem name begins with 'sprout-' and ends with '-library', you (and others) can refer to it by only
+    the string in between that prefix and suffix. Otherwise, you (and others) will always have
+    to set the gem_name parameter to the full name of your custom library.
+* Submit your library for inclusion from the ProjectSprouts[http://www.projectsprouts.org] project.
+* Add your gem to your own custom gem_server[http://rambleon.org/2007/04/19/creating-your-own-gem-server/], and set up your rakefiles to pull from that server
+
+You can search for all available libraries as follows:
+  gem search -r sprout-*library
+Only results that begin with 'sprout-' are known, valid libraries.

data/doc/Task

@@ -0,0 +1,21 @@
+In Sprouts, a Task is referring to a Rake[http://rake.rubyforge.org/] Task.
+
+Rake is the automated build to written in Ruby. This tool is similar to Ant[http://ant.apache.org/] and Make[http://www.gnu.org/software/make/] if you're familiar with those technologies.
+
+The main thing that differentiates Rake from it's competitors is the fact that Rake tasks are defined and configured in Ruby code rather than XML or C. This lets us more easily avoid repetition throughout a rakefile, and we gain the full power of the Ruby language to apply to our build scripts.
+
+Essentially, Rake allows us to write and maintain much smaller, more digestible build scripts.
+
+To learn more about Rake, check out Martin Fowler's seminal article[http://martinfowler.com/articles/rake.html] on the subject.
+
+At the time of this writing, Sprouts makes the following Rake tasks available:
+* Core Sprout::SFTPTask
+* Core Sprout::ZipTask
+* Core Sprout::LibraryTask
+* As3Bundle Sprout::AsDocTask
+* As3Bundle Sprout::AsUnitTask
+* As3Bundle Sprout::COMPCTask
+* As3Bundle Sprout::MXMLCTask
+* As2Bundle Sprout::MTASCTask
+* As2Bundle Sprout::SWFMillTask
+

data/doc/Tool

@@ -0,0 +1,20 @@
+  
+A Tool is a Ruby Gem that usually refers to an executable or binary application. 
+These applications are either natively cross platform, or the Ruby Gem should include a 
+YAML document that tells Sprouts where to go in order to get the appropriate binary for 
+which platform the user is currently running.
+
+CLI Tools are usually referenced by subclasses of Sprout::ToolTask.
+
+Once installed, many Tool Sprouts are made available from your path. For example
+if you install the sprout-mtasc-tool gem, from that point forward you can execute mtasc
+from the terminal as follows:
+
+  mtasc -help # Should throw an error
+  sudo gem install sprout-mtasc-tool
+  mtasc -help # Should download and execute mtasc
+
+Using just Sprout tools by themselves, we now have have the ability to install and manage
+requisite executables across platforms with zero configuration.
+
+In reality, 'Tool Sprouts' are actually nothing more than a naming convention and expected gem configuration, but once those requirements are met, the core Sprout::Sprout can do some important work with them.

data/lib/platform.rb

@@ -1,8 +1,7 @@
 #
 # platform.rb: naive platform detection for Ruby
-# author: Matt Mower <self@mattmower.com>
+# author: Matt Mower
 #
-
 # == Platform
 #
 # Platform is a simple module which parses the Ruby constant
@@ -38,7 +37,7 @@
 #
 # ruby platform.rb
 #
-module Platform
+module Platform #:nodoc:
    os = nil
    impl = nil
    arch = nil

data/lib/progress_bar.rb

@@ -8,15 +8,19 @@
 # You can redistribute it and/or modify it under the terms
 # of Ruby's license.
 #
+# Modified by Luke Bayes to support progress display on 
+# multiple simultaneous connections
 
-class ProgressBar
+require 'singleton'
+
+class ProgressBar # :nodoc:[all]
   VERSION = "0.9"
   def self.new(title, total)
     return ProgressBarManager.instance.add(title, total)
   end
 end
 
-class ProgressBarImpl
+class ProgressBarImpl # :nodoc:[all]
   
   def initialize (title, total, out = STDERR)
     @title = title
@@ -42,7 +46,6 @@ class ProgressBarImpl
                 :title_width,
                 :bar_mark
 
-  private
   def fmt_bar
     bar_width = do_percentage * @terminal_width / 100
     sprintf("|%s%s|", 
@@ -104,15 +107,15 @@ class ProgressBarImpl
     if @current == 0
       "ETA:  --:--:--"
     else
-      elapsed = Time.now - @start_time
-      eta = elapsed * @total / @current - elapsed;
-      sprintf("ETA:  %s", format_time(eta))
+      elapsed_time = Time.now - @start_time
+      estimated_time = elapsed_time * @total / @current - elapsed_time
+      sprintf("ETA:  %s", format_time(estimated_time))
     end
   end
 
   def elapsed
-    elapsed = Time.now - @start_time
-    sprintf("Time: %s", format_time(elapsed))
+    elapsed_time = Time.now - @start_time
+    sprintf("Time: %s", format_time(elapsed_time))
   end
   
   def eol
@@ -128,14 +131,18 @@ class ProgressBarImpl
   end
 
   def get_width
-    return 80
+#    return 80
     # FIXME: I don't know how portable it is.
     default_width = 80
     begin
       tiocgwinsz = 0x5413
       data = [0, 0, 0, 0].pack("SSSS")
       if @out.ioctl(tiocgwinsz, data) >= 0 then
-        rows, cols, xpixels, ypixels = data.unpack("SSSS")
+        unpacked = data.unpack("SSSS")
+        cols = unpacked[1]
+        # Commented this because Aptana was complaining about
+        # The unused variables
+        # rows, cols, xpixels, ypixels = data.unpack("SSSS")
         if cols >= 0 then cols else default_width end
       else
         default_width
@@ -153,10 +160,10 @@ class ProgressBarImpl
     line = sprintf(@format, *arguments)
 
     width = get_width
-    if line.length == width - 1 
+    if(line.length == width - 1)
       @out.print(line + eol)
       @out.flush
-    elsif line.length >= width
+    elsif(line.length >= width)
       @terminal_width = [@terminal_width - (line.length - width + 1), 0].max
       if @terminal_width == 0 then @out.print(line + eol) else show end
     else # line.length < width - 1
@@ -237,13 +244,27 @@ class ProgressBarImpl
   end
 end
 
-class ReversedProgressBar < ProgressBar
+# Used instead of $stderr when Log.debug == true
+# This helps keep us from junking up unit test
+# output with download status messages
+class MockOutput  # :nodoc:[all]
+  def print(str)
+  end
+  
+  def puts(str)
+  end
+
+  def flush
+  end
+end
+
+class ReversedProgressBar < ProgressBar  # :nodoc:[all]
   def do_percentage
     100 - super
   end
 end
 
-class ProgressBarOutputStream
+class ProgressBarOutputStream  # :nodoc:[all]
   attr_reader :title
   
   def initialize(mgr)
@@ -265,7 +286,7 @@ class ProgressBarOutputStream
   
 end
 
-class ProgressBarManager
+class ProgressBarManager # :nodoc:[all]
   include Singleton
   
   def initialize
@@ -276,9 +297,9 @@ class ProgressBarManager
   end
   
   def add(title, total1)
-    if(@bars[title])
-      raise Error.new
-    end
+#    if(@bars[title])
+#      raise StandardError.new
+#    end
     @outs[title] = ProgressBarOutputStream.new(self)
     @bars[title] = ProgressBarImpl.new(title, total1, @outs[title])
   end
@@ -292,21 +313,16 @@ class ProgressBarManager
   end
   
   def flush
-    str = ""
-    
     @bars.keys.each do |title|
       print(title)
     end
     
-    finished = true
     @bars.values.each do |bar|
       if(bar.finished?)
         print(bar.title)
         @outio.print "\n"
         @outs.delete(bar.title)
         @bars.delete(bar.title)
-      else
-        finished = false
       end
     end
   end

data/lib/sprout/builder.rb

@@ -0,0 +1,35 @@
+
+module Sprout
+
+  # accepts a destination path and a sprout specification
+  # and will download and unpack the platform-specific
+  # archives that are identified in the spec
+  class Builder # :nodoc:
+    
+    class BuilderError < StandardError #:nodoc:
+    end
+
+    def self.build(file_targets_yaml, destination)
+      data = nil
+      
+      File.open(file_targets_yaml, 'r') do |f|
+        data = f.read
+      end
+      
+      usr = User.new
+      platform = usr.platform.to_s
+      
+      targets = YAML.load(data)
+      targets.each do |target|
+        if(target.platform == 'universal' || target.platform == platform)
+          target.install_path = FileUtils.mkdir_p(destination)
+          target.resolve
+          return target
+        end
+      end
+      raise BuilderError.new("Sprout::Builder.build failed, unsupported platform or unexpected yaml")
+    end
+    
+  end
+end
+

data/lib/sprout/commands/generate.rb

@@ -0,0 +1,14 @@
+# Shamelessly copied from Ruby On Rails
+# Which happens to share the same MIT license!
+
+=begin
+#require "#{RAILS_ROOT}/config/environment"
+require 'rubygems'
+gem 'activesupport', '>= 2.0.2'
+require 'generator'
+#require 'generator/scripts/generate'
+require 'sprout'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+Rails::Generator::Scripts::Generate.new.run(ARGV)
+=end

data/lib/sprout/general_tasks.rb

@@ -0,0 +1,5 @@
+
+require 'sprout/tasks/sftp_task'
+require 'sprout/tasks/zip_task'
+require 'sprout/tasks/gem_wrap_task'
+require 'sprout/tasks/library_task'