sprout 0.7.219-i686-darwin10

data/lib/sprout/generator/named_base.rb

@@ -0,0 +1,227 @@
+
+module Sprout
+  module Generator #:nodoc:
+    
+    class NamedBaseError < StandardError #:nodoc:
+    end
+    
+    # The NamedBase is a good default base class for ActionScript class Generators.
+    # This class will accept the first command line argument and create
+    # many helpful properties for concrete generators to use.
+    #
+    # Can accept class names in following formats:
+    #   * src/package/package/ClassName.as
+    #   * test/package/package/ClassName.as
+    #   * package/package/ClassName
+    #   * package.package.ClassName
+    #
+    # Regardless of which format the name was sent in, the helper
+    # methods should provide valid results
+    #
+    class NamedBase < RubiGen::Base
+
+      # Fully qualified class named including package name like 'flash.display.Sprite'
+      attr_reader :full_class_name
+      # Path to the class file relative to your src_dir like 'flash/display/Sprite.as'
+      attr_reader :class_file
+      # The directory that contains the file, relative to your src_dir like 'flash/diplay'
+      attr_reader :class_dir
+      # The unqualified name of the class like 'Sprite'
+      attr_reader :class_name
+      # The package name of the class like 'flash.display'
+      attr_reader :package_name
+
+      def initialize(runtime_args, runtime_options = {})
+        super
+
+        rakefile = Sprout.project_rakefile
+        if(rakefile && File.exists?(rakefile))
+           load rakefile
+        end
+        @model = ProjectModel.instance
+
+        # Had to stop throwing on no args because the suite generator does
+        # not require the user to send in a class name....
+        #usage("Final argument must be a name parameter") if runtime_args.empty?
+        @args = runtime_args.dup
+        assign_names! @args.shift
+      end
+
+      # Quick access to the source directory identified by your project model
+      def src_dir
+        return model.src_dir
+      end
+      
+      # Quick access to the test directory identified by your project model
+      def test_dir
+        return model.test_dir
+      end
+      
+      # Quick access to the library directory identified by your project model
+      def lib_dir
+        return model.lib_dir
+      end
+      
+      # The path to your project. This will either be the directory from which
+      # the sprout gem was executed, or the nearest ancestor directory that
+      # contains a properly named rakefile.
+      def project_path
+        return model.project_path
+      end
+      
+      # The project_name that was either sent to the sprout gem or 
+      # defined in your rakefile project model
+      def project_name
+        @project_name ||= (Sprout.project_name || model.project_name)
+      end
+      
+      # The technology language that is stored in your project model usually (as2 or as3)
+      def language
+        return model.language
+      end
+
+      # Name of possible test case for this class_name
+      def test_case_name
+        @test_case_name ||= class_name + 'Test'
+      end
+      
+      # Full name of the possible test case for this class_name
+      def full_test_case_name
+        full_class_name + 'Test'
+      end
+
+      # Full path to the parent directory that contains the class
+      # like 'src/flash/display' for flash.display.Sprite class.
+      def full_class_dir
+        @full_class_dir ||= File.join(src_dir, class_dir)
+        # pull trailing slash for classes in the root package
+        @full_class_dir.gsub!(/\/$/, '')
+        @full_class_dir
+      end
+
+      # Full path to the class file from your project_path like 'src/flash/display/Sprite.as'
+      def full_class_path
+        @full_class_path ||= File.join(src_dir, class_file)
+      end
+
+      # Filesystem path to the folder that contains the TestCase file
+      def full_test_dir
+        @full_test_dir ||= full_class_dir.gsub(src_dir, test_dir)
+      end
+      
+      # Filesystem path to the TestCase file
+      def full_test_case_path
+        @full_test_case_path ||= File.join(full_test_dir, test_case_name + '.as')
+      end
+
+      # Path to the in-project generate script
+      # pulled out for DOS branching
+      def generate_script_path
+        usr = User.new
+        if(usr.is_a?(WinUser) && !usr.is_a?(CygwinUser))
+          return File.join(class_name, 'script', "generate.rb")
+        else
+          return File.join(class_name, 'script', "generate")
+        end
+      end
+      
+      def instance_name
+        name = class_name.dup;
+        char = name[0, 1]
+        name[0, 1] = char.downcase
+        if(name.size > 10)
+          name = 'instance'
+        end
+        return name
+      end
+
+      # Will return whether the user originally requested a class name
+      # that looks like a test case (e.g., name.match(/Test$/) )
+      def user_requested_test
+        @user_requested_test ||= false
+      end
+
+      # Glob that is used to search for test cases and build 
+      # up the test suites
+      def test_glob
+        return @test_glob ||= '**/**/?*Test.as'
+      end
+      
+      def test_glob=(glob)
+        @test_glob = glob
+      end
+
+      # Collection of all test case files either assigned or found
+      # using the test_glob as provided.
+      def test_cases
+        @test_cases ||= Dir.glob(test_dir + test_glob)
+      end
+      
+      def test_cases=(collection)
+        @test_cases = collection
+      end
+      
+      # Get the list of test_cases (which are files) as a 
+      # list of fully qualified class names
+      def test_case_classes
+        @test_case_classes = self.test_cases.dup
+        @test_case_classes.collect! do |file|
+          actionscript_file_to_class_name(file)
+        end
+        @test_case_classes
+      end
+
+      # Transform a file name in the source or test path
+      # to a fully-qualified class name
+      def actionscript_file_to_class_name(file)
+        name = file.dup
+        name.gsub!(/^#{Dir.pwd}\//, '')
+        name.gsub!(/^#{test_dir}\//, '')
+        name.gsub!(/^#{src_dir}\//, '')
+        name.gsub!(/.as$/, '')
+        name.gsub!(/#{File::SEPARATOR}/, '.')
+        return name
+      end
+      
+      protected
+
+      def banner
+        "Usage: #{$0} [options] packagename.ClassName"
+      end
+
+      def model
+        @model ||= ProjectModel.instance
+      end
+
+      def assign_names!(name)
+        # trim file name suffix in case it was submitted
+        name.gsub!(/\//, '.')
+        name.gsub!(/\.as$/, '')
+        name.gsub!(/\.mxml$/, '')
+        if(model)
+          # Pull leading src_dir from class name if submitted
+          name.gsub!(/^#{src_dir}\./, '')
+          name.gsub!(/^#{test_dir}\./, '')
+        end
+
+        if(name.match(/Test$/))
+          @user_requested_test = true
+          name = name.gsub(/Test$/, '')
+        end
+        if(name.match(/^I/) || name.match(/able$/))
+          @user_requested_interface = true
+        end
+
+        @full_class_name = name
+        parts = name.split('.')
+        @class_name = parts.pop
+        @package_name = parts.join('.')
+        @class_file = @full_class_name.split('.').join(File::SEPARATOR) + '.as'
+        @class_dir = File.dirname(@class_file)
+        if(@class_dir == '.')
+          @class_dir = ''
+        end
+      end
+    end
+  end
+end

data/lib/sprout/log.rb

@@ -0,0 +1,46 @@
+
+module Sprout #:nodoc:
+  
+  class Log #:nodoc:
+    @@debug = false
+    @@output = ''
+    @@printout = ''
+    
+    def Log.debug=(debug)
+      @@debug = debug
+    end
+    
+    def Log.debug
+      return @@debug
+    end
+    
+    def Log.puts(msg)
+      @@output << msg + "\n"
+      Log.flush
+    end
+    
+    def Log.print(msg)
+      @@printout << msg
+      Log.flush_print
+    end
+    
+    def Log.printf(msg)
+      @@printout << msg
+      Log.flush_print
+    end
+    
+    def Log.flush_print
+      if(!Log.debug)
+        $stdout.print @@printout
+        @@printout = ''
+      end
+    end
+    
+    def Log.flush
+      if(!Log.debug)
+        $stdout.puts @@output
+        @@output = ''
+      end
+    end
+  end
+end

data/lib/sprout/process_runner.rb

@@ -0,0 +1,111 @@
+
+module Sprout #:nodoc:
+  class ProcessRunnerError < StandardError # :nodoc:
+  end
+  
+  class ProcessRunner #:nodoc:
+    attr_reader :pid,
+                :r,
+                :w,
+                :e
+    
+    def initialize(*command)
+      @command = command
+      begin
+        @alive = true
+        usr = User.new()
+        if(usr.is_a?(WinUser) && !usr.is_a?(CygwinUser))
+          gem 'win32-open3', '0.2.5'
+          require 'win32/open3'
+          Open3.popen3(*@command) do |w, r, e, pid|
+          	@w = w
+          	@r = r
+          	@e = e
+          	@pid = pid
+          end
+        else
+          require 'open4'
+          @pid, @w, @r, @e = open4.popen4(*@command)
+        end
+      rescue Errno::EACCES => e
+        update_executable_mode(*@command)
+        @pid, @w, @r, @e = open4.popen4(*@command)
+      rescue Errno::ENOENT => e
+        @alive = false
+        part = command[0].split(' ').shift
+        raise ProcessRunnerError.new("The expected executable was not found for command [#{part}], please check your system path and/or sprout definition")
+      end
+    end
+    
+    def update_executable_mode(*command)
+      parts = command.join(' ').split(' ')
+      str = parts.shift
+      while(parts.size > 0)
+        if(File.exists?(str))
+          FileUtils.chmod(744, str)
+          return
+        else
+          str << " #{parts.shift}"
+        end
+      end
+    end
+    
+    def alive?
+      @alive = update_status
+    end
+    
+    def kill
+      Process.kill(9, pid)
+    end
+    
+    def close
+      update_status
+    end
+    
+    def update_status
+      pid_int = Integer("#{ @pid }")
+      begin
+        Process::kill 0, pid_int
+        true
+      rescue Errno::ESRCH
+        false
+      end
+    end
+    
+    def readpartial(count)
+      @r.readpartial(count)
+    end
+    
+    def readlines
+      @r.readlines
+    end
+    
+    def flush
+      @w.flush
+    end
+    
+    def getc
+      @r.getc
+    end
+    
+    def print(msg)
+      @w.print msg
+    end
+    
+    def puts(msg)
+      @w.puts(msg)
+    end
+    
+    def close_write
+      @w.close_write
+    end
+    
+    def read
+      return @r.read
+    end
+    
+    def read_err
+      return @e.read
+    end
+  end
+end

data/lib/sprout/project_model.rb

@@ -0,0 +1,278 @@
+
+module Sprout
+  # The ProjectModel gives you a place to describe your project so that you
+  # don't need to repeat yourself throughout a rakefile.
+  #
+  # The default set of properties are also used from code generators, library tasks and sometimes tools.
+  #
+  # The ProjectModel can be configured as follows:
+  #   project_model :model do |p|
+  #     p.name          = 'SomeProject'
+  #     p.source_path   << 'somedir/otherdir'
+  #     p.library_path  << 'somedir'
+  #   end
+  #
+  # This class should have some reasonable default values, but can be modified from any rakefile.
+  # If you don't find some properties that you'd like on the ProjectModel, you can simply add 
+  # new properties and use them however you wish. 
+  #
+  # Arbitrary properties can be added as follows:
+  #   m = project_model :model do |p|
+  #     p.unknown_property = 'someValue'
+  #   end
+  # 
+  #   puts "Unknown Property: #{m.unknown_property}"
+  #
+  # The ProjectModel is typically treated as if it is a Singleton, and many helper tasks
+  # will automatically go look for their model at:
+  # 
+  #   Sprout::ProjectModel.instance
+  #
+  # Unlike a real Singleton, this static property will actually be populated with the most
+  # recently instantiated ProjectModel, and any well-behaved helper task will also
+  # allow you to send in a model as a prerequisite.
+  #
+  #   project_model :model_a
+  #   project_model :model_b
+  #
+  #   desc 'Compile and run a'
+  #   debug :debug_a => :model_a
+  #
+  #   desc 'Compile and run b'
+  #   debug :debug_b => :model_b
+  #
+  class ProjectModel < Hash
+    
+    # Relative path to the folder where compile time assets will be stored
+    attr_accessor :asset_dir
+    # The folder where binary files will be created. Usually this is where any build artifacts like SWF files get placed.
+    attr_accessor :bin_dir
+    # The Background Color of the SWF file
+    attr_accessor :background_color
+    # Contributors to the SWF file
+    attr_accessor :contributors
+    # If you don't want to use the default compiler for your language
+    # set it manually here.
+    # Possible values are:
+    # * sprout-flex2sdk-tool
+    # * sprout-flex3sdk-tool
+    # * sprout-flex4sdk-tool (Experimental)
+    # * sprout-mtasc-tool
+    attr_accessor :compiler_gem_name
+    # The version number of the compiler gem to use
+    attr_accessor :compiler_gem_version
+    # The primary creator of the SWF file
+    attr_accessor :creator
+    # Directory where documentation should be placed.
+    attr_accessor :doc_dir
+    # CSS documents that should be individually compiled
+    # for runtime stylesheet loading.
+    attr_accessor :external_css
+    # The default frame rate of the SWF file
+    attr_accessor :frame_rate
+    # The default height of the SWF file
+    # _(This value is overridden when embedded in an HTML page)_
+    attr_accessor :height
+    # The technology language that is being used, right now this value can be 'as2', 'as3' or 'mxml'.
+    # Code generators take advantage of this setting to determine which templates to use
+    # and build tasks use this setting to determin the input file suffix (.as or .mxml).
+    attr_accessor :language
+    # The relative path to your library directory. Defaults to 'lib'
+    #
+    # Any remote .SWC and source libraries that are referenced in your rakefile will be installed
+    # into this directory. Source libraries will be placed in a folder that matches the library name,
+    # while SWCs will be simply placed directly into the lib_dir.
+    attr_accessor :lib_dir
+    # Array of sprout library symbols
+    attr_accessor :libraries
+    # The Array of SWC paths to add to all compilation tasks
+    attr_accessor :library_path
+    # The locale for the SWF file
+    attr_accessor :locale
+    # A collection of Flex Module root source files. If this collection
+    # has items added to it, the deploy task will generate a 'link_report' from
+    # the main application compilation and then consume it as 'load_externs' for 
+    # each module compilation.
+    attr_accessor :modules
+    # Organization responsible for this SWF file
+    attr_accessor :organization
+    # The production file that this Project will generate
+    attr_accessor :output
+    # Terminal command to preprocessor application that accepts STDIN and returns on STDOUT
+    attr_accessor :preprocessor
+    # Folder where preprocessed files will be created. Defaults to '.preprocessed'
+    attr_accessor :preprocessed_path
+    # The real name of the project, usually capitalized like a class name 'SomeProject'
+    attr_accessor :project_name
+    # The folder where compile time skins can be loaded from
+    attr_accessor :skin_dir
+    # The skin file that will be generated
+    attr_accessor :skin_output
+    # The Array of source paths to add to all compilation tasks
+    # _Do not add task-specific paths (like lib/asunit) to this value_
+    attr_accessor :source_path
+    # The relative path to your main source directory. Defaults to 'src'
+    attr_accessor :src_dir
+    # Enforce strict type checking
+    attr_accessor :strict
+    # The relative path to the directory where swc files should be kept.
+    # This value defaults to lib_dir
+    attr_accessor :swc_dir
+    # Relative path to the folder that contains your test cases
+    attr_accessor :test_dir
+    # The test executable
+    attr_accessor :test_output
+    # The test runner SWF height
+    attr_accessor :test_height
+    # The test runner SWF width
+    attr_accessor :test_width
+    # Tasks that can, will use the Flex Compiler SHell.
+    attr_accessor :use_fcsh
+    # Flash Player Tasks will launch using the Flex Debugger.
+    attr_accessor :use_fdb
+    # The default width of the SWF file
+    # _(This value is overridden when embedded in an HTML page)_
+    attr_accessor :width
+
+    # Static method that returns the most recently instantiated ProjectModel,
+    # or instantiates one if none have been created yet.
+    def self.instance
+      @@instance ||= ProjectModel.new
+      yield @@instance if block_given?
+      return @@instance
+    end
+    
+    # Decorates the static instance method.
+    def self.setup
+      @@instance ||= ProjectModel.new
+      yield @@instance if block_given?
+      return @@instance
+    end
+
+    def self.destroy # :nodoc:
+      @@instance = nil
+    end
+
+    def initialize
+      super
+      @project_name   = ''
+      @doc_dir        = 'doc'
+      @src_dir        = 'src'
+      @lib_dir        = 'lib'
+      @swc_dir        = 'lib'
+      @bin_dir        = 'bin'
+      @test_dir       = 'test'
+      @asset_dir      = 'assets'
+      @skin_dir       = File.join(@asset_dir, 'skins')
+      @frame_rate     = 24
+      @language       = 'as3'
+
+      @external_css   = []
+      @libraries      = []
+      @library_path   = []
+      @modules        = []
+      @source_path    = []
+
+      @model_dir      = nil
+      @view_dir       = nil
+      @controller_dir = nil
+      
+      @test_height    = 550
+      @test_width     = 900
+      @@instance      = self
+    end
+    
+    # Path to the project directory from which all other paths are created
+    def project_path
+      return Sprout.project_path
+    end
+    
+    def model_dir=(dir)
+      @model_dir = dir
+    end
+    
+    # Simple MVC helper for project-wide models if your project is called 'SomeProject'
+    # this will default to:
+    #   SomeProject/src/someproject/models
+    def model_dir
+      if(@model_dir.nil?)
+        @model_dir = File.join(src_dir, project_name.downcase, 'models')
+      end
+      return @model_dir
+    end
+    
+    def view_dir=(dir)
+      @view_dir = dir
+    end
+
+    # Simple MVC helper for project-wide views if your project is called 'SomeProject'
+    # this will default to:
+    #   SomeProject/src/someproject/views
+    def view_dir
+      if(@view_dir.nil?)
+        @view_dir = File.join(src_dir, project_name.downcase, 'views')
+      end
+      return @view_dir
+    end
+    
+    def controller_dir=(dir)
+      @controller_dir = dir
+    end
+
+    # Simple MVC helper for project-wide views if your project is called 'SomeProject'
+    # this will default to:
+    #   SomeProject/src/someproject/controllers
+    def controller_dir
+      if(@controller_dir.nil?)
+        @controller_dir = File.join(src_dir, project_name.downcase, 'controllers')
+      end
+      return @controller_dir
+    end
+    
+    # Alias for project_name
+    def name=(name)
+      @project_name = name
+    end
+    
+    def name
+      @project_name
+    end
+    
+    def to_s
+      return "[Sprout::ProjectModel project_name=#{project_name}]"
+    end
+    
+    protected
+    
+    def method_missing(method_name, *args)
+      method_name = method_name.to_s
+      if method_name =~ /=$/
+        super if args.size > 1
+        self[method_name[0...-1]] = args[0]
+      else
+        super unless has_key?(method_name) and args.empty?
+        self[method_name]
+      end
+    end
+  end
+end
+
+# Helper method to expose the project model as a Rake Task
+def project_model(task_name)
+  model = Sprout::ProjectModel.new
+  yield model if block_given?
+
+  t = task task_name
+
+  def t.project_model=(model)
+    @model = model
+  end
+
+  def t.project_model
+    return @model
+  end
+    
+  t.project_model = model
+  return model
+end
+