sprout 0.7.191-mswin32

data/lib/sprout/process_runner.rb

@@ -0,0 +1,82 @@
+
+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))
+          require_gem 'win32/open3', '0.2.5'
+          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::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 alive?
+      @alive = 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 read
+      return @r.read
+    end
+    
+    def read_err
+      return @e.read
+    end
+  end
+end

data/lib/sprout/project_model.rb

@@ -0,0 +1,270 @@
+
+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
+    # 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
+    # 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
+

data/lib/sprout/remote_file_loader.rb

@@ -0,0 +1,247 @@
+
+module Sprout
+  class RemoteFileLoaderError < StandardError #:nodoc:
+  end
+  
+  class RemoteFileLoader #:nodoc:
+    include Archive::Tar
+    
+    def get_remote_file(uri, target, force=false, md5=nil)
+      if(force || !File.exists?(target))
+        response = fetch(uri.to_s)
+        if(response_is_valid?(response, md5))
+          write(response, target, force)
+        end
+      end
+    end
+    
+    def response_is_valid?(response, expected_md5sum=nil)
+      if(expected_md5sum)
+        md5 = Digest::MD5.new
+        md5 << response
+        
+        if(expected_md5sum != md5.hexdigest)
+          puts "The MD5 Sum of the downloaded file (#{md5.hexdigest}) does not match what was expected (#{expected_md5sum})."
+          puts "Would you like to install anyway? [Yn]"
+          response = $stdin.gets.chomp!
+          if(response.downcase == 'y')
+            return true
+          else
+            raise RemoteFileLoaderError.new('MD5 Checksum failed')
+          end
+        end
+      end
+      return true
+    end
+    
+    def write(response, target, force=false)
+      FileUtils.makedirs(File.dirname(target))
+      if(force && File.exists?(target))
+        File.delete(target)
+      end
+      File.open(target, 'wb') do |f|
+        f.write(response)
+      end
+    end
+    
+    def fetch(uri)
+      uri = URI.parse(uri)
+      # Download the file now to the downloads dir
+      # If the file is an archive (zip, gz, tar, tar.gz, dmg), extract to
+      # Sprouts/cache/@type/@name
+      # Check the location again...
+      progress = nil
+      response = nil
+      name = uri.path.split("/").pop
+      
+      raise RemoteFileLoaderError.new("The RemoteFileTask failed for #{name}. We can only handle HTTP requests at this time, it seems you were trying: '#{uri.scheme}'") if uri.scheme != 'http'
+      begin
+        open(uri.to_s, :content_length_proc => lambda {|t|
+          if t && t > 0
+            progress = ProgressBar.new(name, t)
+            progress.file_transfer_mode
+            progress.set(0)
+          else
+            progress = ProgressBar.new(name, 0)
+            progress.file_transfer_mode
+            progress.set(0)
+          end
+        },
+        :progress_proc => lambda {|s|
+          progress.set s if progress
+        }) {|f|
+          response = f.read
+          progress.finish
+        }
+      rescue SocketError => sock_err
+        raise RemoteFileLoaderError.new("[ERROR] #{sock_err.to_s}")
+      rescue OpenURI::HTTPError => http_err
+        raise RemoteFileLoaderError.new("[ERROR] Failed to load file from: '#{uri.to_s}'\n[REMOTE ERROR] #{http_err.io.read.strip}")
+      rescue Errno::ECONNREFUSED => econ_err
+        raise Errno::ECONNREFUSED.new("[ERROR] Connection refused at: '#{uri.to_s}'")
+      end
+
+      return response
+    end
+    
+    def unpack_downloaded_file(file_name, dir)
+      if(!File.exists?(dir))
+        if(is_zip?(file_name))
+          unpack_zip(file_name, dir)
+        elsif(is_targz?(file_name))
+          unpack_targz(file_name, dir)
+        elsif(is_dmg?(file_name))
+          unpack_dmg(file_name, dir)
+        elsif(is_swc?(file_name))
+          # just copy the swc...
+        elsif(is_rb?(file_name))
+          return
+        elsif(is_exe?(file_name))
+          FileUtils.mkdir_p(dir)
+          File.mv(file_name, dir)
+        else
+          raise UsageError.new("RemoteFileTask does not know how to unpack files of type: #{file_name}")
+        end
+      end
+    end
+    
+    def unpack_zip(zip_file, dir)
+      # Avoid the rubyzip Segmentation Fault bug
+      # at least on os x...
+      if(RUBY_PLATFORM =~ /darwin/)
+          # Unzipping on OS X
+          FileUtils.makedirs(dir)
+          zip_dir = File.expand_path(File.dirname(zip_file))
+          zip_name = File.basename(zip_file)
+          output = File.expand_path(dir)
+          #puts ">> zip_dir: #{zip_dir} zip_name: #{zip_name} output: #{output}"
+          %x(cd #{zip_dir};unzip #{zip_name} -d #{output})
+      else
+        retries = 0
+        begin
+          retries += 1
+          Zip::ZipFile::open(zip_file) do |zf|
+            zf.each do |e|
+              fpath = File.join(dir, e.name)
+              FileUtils.mkdir_p(File.dirname(fpath))
+              # Disgusting, Gross Hack to fix DOS/Ruby Bug
+              # That makes the zip library throw a ZipDestinationFileExistsError
+              # When the zip archive includes two files whose names 
+              # differ only by extension.
+              # This bug actually appears in the File.exists? implementation
+              # throwing false positives!
+              # If you're going to use this code, be sure you extract
+              # into a new, empty directory as existing files will be 
+              # clobbered...
+              begin
+                if(File.exists?(fpath) && !File.directory?(fpath))
+                  hackpath = fpath + 'hack'
+                  zf.extract(e, hackpath)
+                  File.copy(hackpath, fpath)
+                  File.delete(hackpath)
+                else
+                  zf.extract(e, fpath)
+                end
+              rescue NotImplementedError => ni_err
+                puts "[WARNING] #{ni_err} for: #{e}"
+              end
+            end
+          end
+        rescue StandardError => err
+          FileUtils.rm_rf(dir)
+          if(retries < 3)
+            puts ">> [ZIP ERROR ENCOUNTERED] trying again with: #{dir}"
+            FileUtils.makedirs(dir)
+            retry
+          end
+          raise err
+        end
+      end
+    end
+    
+    def unpack_targz(tgz_file, dir)
+      if(!File.exists?(dir))
+        FileUtils.makedirs(dir)
+      end
+      tar = Zlib::GzipReader.new(File.open(tgz_file, 'rb'))
+      Minitar.unpack(tar, dir)
+      
+      # Recurse and unpack gzipped children (Adobe did this double 
+      # gzip with the Linux FlashPlayer for some reason)
+      Dir.glob("#{dir}/**/*.tar.gz").each do |child|
+        if(child != tgz_file)
+          unpack_targz(child, File.dirname(child))
+        end
+      end
+      
+    end
+    
+    # This is actually not unpacking the FlashPlayer
+    # Binary file as expected...
+    # OSX is treated the player binary as if it is
+    # a regular text file, but if it is copied manually,
+    # the command works fine!?
+    def unpack_dmg(dmg_file, dir)
+      # 1) Mount the dmg in place
+      # 2) Recursively Copy it's contents to asproject_home
+      # 3) Unmount the dmg
+      if(mounted_path.nil?)
+        raise StandardError.new('DMG file downloaded, but the RemoteFileTask needs a mounted_path in order to mount it')
+      end
+
+      if(!File.exists?(full_mounted_path))
+        system("hdiutil mount #{dmg_file}")
+      end
+      
+      begin
+        mounted_target = File.join(full_mounted_path, extracted_file)
+  
+        # Copy the DMG contents using system copy rather than ruby utils
+        # Because OS X does something special with .app files that the
+        # Ruby FileUtils and File classes break...
+        from = mounted_target
+#        from = File.join(full_mounted_path, extracted_file)
+        to = File.join(@user.downloads, @name.to_s, extracted_file)
+        FileUtils.makedirs(File.dirname(to))
+        
+        if(File.exists?(from))
+          `ditto '#{from}' '#{to}'`
+        end
+      rescue
+        if(File.exists?(full_mounted_path))
+          system("hdiutil unmount -force \"#{full_mounted_path}\"")
+        end
+      end
+    end
+    
+    def is_exe?(file)
+      return (file.split('.').pop == 'exe')
+    end
+    
+    def is_zip?(file)
+      return (file.split('.').pop == 'zip')
+    end
+    
+    def is_targz?(file)
+      parts = file.split('.')
+      part = parts.pop
+      return (part == 'tgz' || part == 'gz' && parts.pop == 'tar')
+    end
+    
+    def is_gzip?(file)
+      return (file.split('.').pop == 'gz')
+    end
+    
+    def is_swc?(file)
+      return (file.split('.').pop == 'swc')
+    end
+    
+    def is_rb?(file)
+      return (file.split('.').pop == 'rb')
+    end
+    
+    def is_dmg?(file)
+      return (file.split('.').pop == 'dmg')
+    end
+  end
+end