sprout 0.5.29 → 0.7.153

data/lib/sprout/remote_file_target.rb

@@ -0,0 +1,96 @@
+
+module Sprout
+  class RemoteFileTargetError < StandardError #:nodoc:
+  end
+
+  class RemoteFileTarget # :nodoc:
+
+    attr_writer   :archive_path
+    
+    # The user path where this gem will download and install files
+    # This value is set by the Sprout::Builder that creates this RemoteFileTarget
+    attr_accessor :install_path
+
+    # Optional md5 hash, usually set in the sprout.spec for each RemoteFileTarget
+    # If this value is set, the downloaded archive will be hashed, the hashes will
+    # be compared and if they differ, the installation process will break.
+    attr_accessor :md5
+
+    # Used for dmg archives. Absolute path to the mounted dmg (essentially it's name)
+    attr_accessor :mount_path
+
+    # Which platform will this RemoteFileTarget support.
+    # Supported options are:
+    #  * universal
+    #  * macosx
+    #  * win32
+    #  * linux
+    attr_accessor :platform
+
+    # URL where Sprouts can go to download the RemoteFileTarget archive
+    attr_accessor :url
+
+    # Relative path within the archive to the executable or binary of interest
+    def archive_path
+      @archive_path ||= ''
+    end
+
+    # Resolve this RemoteFileTarget now. This method is called by the Sprout::Builder
+    # and will download, install and unpack the described archive
+    def resolve(update=false)
+      if(url)
+        @loader = RemoteFileLoader.new
+        if(url && (update || !File.exists?(downloaded_path)))
+          download(url, downloaded_path, update)
+        end
+
+        if(!File.exists?(installed_path) || !File.exists?(File.join(installed_path, archive_path) ))
+          archive_root = File.join(install_path, 'archive')
+          install(downloaded_path, archive_root)
+        end
+      end
+    end
+    
+    # Return the basename of the executable that this RemoteFileTarget refers to
+    def executable
+      return File.basename(archive_path)
+    end
+    
+    # The root path to the unpacked archive files. This is the base path that will be added to any
+    # +archive_path+ relative paths
+    def installed_path
+      @installed_path ||= File.join(install_path, 'archive')
+      return @installed_path
+    end
+    
+    # Parent directory where archives are downloaded
+    # can be something like: ~/Library/Sprouts/cache/0.7/sprout-somesprout-tool.x.x.x/
+    def downloaded_path
+      @downloaded_path ||= File.join(install_path, file_name)
+      return @downloaded_path
+    end
+    
+    # Base file name represented by the provided +url+
+    # Will strip off any ? arguments and trailing slashes. May not play nice with Rails URLS,
+    # We expect archive file name suffixes like, zip, gzip, tar.gz, dmg, etc.
+    def file_name
+      if(url.split('').last == '/')
+        return name
+      end
+      file = url.split('/').pop
+      file = file.split('?').shift
+      return file
+    end
+    
+    private
+    def download(url, path, update=false)
+      @loader = RemoteFileLoader.new
+      @loader.get_remote_file(url, path, update, md5)
+    end
+    
+    def install(from, to)
+      @loader.unpack_downloaded_file(from, to)
+    end
+    
+  end
+end

data/lib/sprout/simple_resolver.rb

@@ -0,0 +1,88 @@
+=begin
+Copyright (c) 2007 Pattern Park
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+=end
+require 'erb'
+
+module Sprout
+
+  class SimpleResolver #:nodoc:
+
+    def initialize(template, output, files, base_dir=nil)
+      @template = template
+      @output = output
+      @files = files
+      @base_dir = base_dir
+      @ignored_files = []
+      execute
+      finish
+    end
+  
+    def execute
+      template_file = File.open(@template, 'r')
+      content = template_file.read
+      result = ERB.new(content, nil, '>').result(binding)
+
+      output_file = File.open(@output, 'w')
+      output_file.write(result)
+    
+      template_file.close
+      output_file.close
+    end
+  
+    def files
+      return @files
+    end
+
+    def finish
+      if(@ignored_files.size > 0)
+        Logger.puts '>> SimpleResolver ignored the following files because their names were invalid:'
+        @ignored_files.each do |file|
+          puts file
+        end
+      end
+    end
+  
+    def xml_edit_warning
+      return <<EOF
+    <!--
+    DO NOT EDIT THIS FILE!
+    This file was auto-generated from
+    an ERB template which can be
+    found at: 
+    #{@template}
+    -->
+EOF
+    end
+  
+    def edit_warning
+      return <<EOF
+  /*************************************
+   * DO NOT EDIT THIS FILE!
+   * This file was auto-generated from
+   * an ERB template which can be
+   * found at: 
+   * #{@template}
+   *************************************/
+EOF
+    end
+  end
+end

data/lib/sprout/tasks/gem_wrap_task.rb

@@ -0,0 +1,192 @@
+=begin
+Copyright (c) 2007 Pattern Park
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+TODO: Update mxmlc task
+ * Update mxmlc to include all advanced options
+ * Clean up default values
+ * Investigate jruby support, especially:
+    http://livedocs.adobe.com/flex/201/html/wwhelp/wwhimpl/common/html/wwhelp.htm?context=LiveDocs_Book_Parts&file=compilers_123_09.html
+=end
+
+module Sprout
+  class GemWrapError < StandardError #:nodoc:
+  end
+
+  # Creates a ruby gem from a slightly simpler rake task than what gems provides.
+  # Adds support for adding a sprout.spec file to your new gem which is usually useful
+  # for tool or library sprout gems.
+  class GemWrapTask < Rake::Task
+    # The full name of the gem to create like:
+    #   t.gem_name = 'sprout-as3-bundle'
+    attr_writer :gem_name
+    # The type of sprout to create, defaults to 'library'
+    # Other possible values are, 'bundle' and 'tool'
+    attr_writer :sprout_type
+    # Full string rubygem version for this sprout, usually in three parts like:
+    #  t.version = '0.0.1'
+    attr_writer :version
+    # Folder that the newly-created gem should be placed in
+    attr_writer :package
+    # Summary or short description for the gem
+    attr_writer :summary
+    # The author that created the gem
+    attr_writer :author
+    # Email address for interested users to send questions to
+    attr_writer :email
+    # Homepage where users can learn more about this gem
+    attr_writer :homepage
+    # A string remote file specification usually something like:
+    # 
+    #   t.sprout_spec   =<<EOF
+    #   - !ruby/object:Sprout::RemoteFileTarget 
+    #     platform: universal
+    #     url: http://as3flickrlib.googlecode.com/files/flickr-.87.zip
+    #     archive_path: flickr-.87/src
+    #   EOF
+    attr_writer :sprout_spec
+
+    def self.define_task(args, &block)
+      t = super
+      yield t if block_given?
+      t.define
+    end
+
+    def define # :nodoc:
+      define_gem_name
+      define_extensions(extensions)
+    end
+
+    def initialize(task_name, app) # :nodoc:
+      super
+      @sprout_type    = "library"
+      @package        = "pkg"
+      @summary        = "#{task_name}"
+      @email          = "projectsprouts@googlegroups.com"
+      @homepage       = "http://www.projectsprouts.org"
+    end
+  
+    def execute(*args) # :nodoc:
+      super
+      raise GemWrapError.new("A version must be provided to produce a Gem!") unless @version
+      @summary = "#{name} #{@sprout_type} generated by Sprout::GemWrapTask" unless @summary
+
+      FileUtils.mkdir_p(gem_package)
+      render_sprout_spec(gem_package, @sprout_spec) if @sprout_spec
+#      render_extensions(gem_package, extensions) if extensions.size
+
+      Dir.chdir(gem_package) do
+  
+        spec = Gem::Specification.new do |s|
+          files           = []
+          s.platform      = Gem::Platform::RUBY
+          s.version       = @version
+          s.author        = @author if @author
+          s.summary       = @summary
+          s.name          = @gem_name
+          s.email         = @email
+          s.homepage      = @homepage
+          s.rubyforge_project = 'sprout'
+          s.requirements << {'sprout', '>= 0.7.1'}
+          gem_dependencies.each do |dep|
+            s.requirements << dep
+          end
+          if(File.exists?('sprout.spec'))
+            files << 'sprout.spec'
+          end
+          if(extensions.size > 0)
+            files << 'ext'
+          end
+          zipped_extensions.each do |ext|
+            files << File.join('ext', File.basename(ext))
+          end
+          s.files         = files
+        end
+        Gem::Builder.new(spec).build
+      end
+
+      FileUtils.mv("#{gem_package}/#{@gem_name}-#{@version}.gem", @package)  
+      FileUtils.rm_rf(gem_package)
+    end
+    
+    # Add a gem dependency either with only the gem name
+    # or with a full name and version hash like:
+    # 
+    #   t.add_dependency('sprout-flashplayer-tool')
+    # or
+    #   t.add_dependency('sprout-flashplayer-tool' => '9.115.0')
+    #
+    def add_dependency(args)
+      gem_dependencies << args
+    end
+
+    def gem_dependencies
+      return @gem_dependencies ||= []
+    end
+    
+    # Add files to include in the gem/ext folder
+    def extensions
+      return @extensions ||= []
+    end
+    
+    private
+
+    def gem_package
+      @gem_package ||= File.join(@package, @gem_name)
+    end
+
+    def zipped_extensions
+      return @zipped_extensions ||= []
+    end
+
+    def define_gem_name
+      @gem_name = "sprout-#{name}-#{@sprout_type}" if !@gem_name
+    end
+
+    def define_extensions(exts)
+      exts.each do |ext|
+        if(File.directory?(ext))
+          full = File.expand_path(ext)
+          t = nil
+
+          zip full do |t|
+            t.input = full
+            t.output = File.join(gem_name, 'ext', File.basename(full) + '.zip')
+          end
+          puts "pwd: #{Dir.pwd} out #{t.output}"
+          zipped_extensions << File.expand_path(t.output)
+          prerequisites << t.output
+        end
+      end
+    end
+
+    def render_sprout_spec(target, spec)
+      File.open(File.join(target, 'sprout.spec'), 'w') do |f|
+        f.write(spec)
+      end
+    end
+
+  end
+end
+
+def gem_wrap(args, &block)
+  Sprout::GemWrapTask.define_task(args, &block)
+end

data/lib/sprout/tasks/library_task.rb

@@ -0,0 +1,103 @@
+=begin
+Copyright (c) 2007 Pattern Park
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+=end
+
+module Sprout
+  class LibraryError < StandardError #:nodoc:
+  end
+
+  # :include: ../../../doc/Library
+  class LibraryTask < Rake::Task
+    
+    # The RubyGems gem version string for this library (e.g., +version = '0.0.1'+)
+    attr_accessor :version
+
+    attr_writer :gem_name # :nodoc:
+    attr_writer :project_lib # :nodoc:
+
+    def self.define_task(args, &block) # :nodoc:
+      t = super
+      yield t if block_given?
+      t.define
+    end
+
+    # The full gem name like 'sprout-asunit3-library'
+    def gem_name
+      @gem_name ||= "sprout-#{name}-library"
+    end
+    
+    # The path to the library source or swc that will be copied into your project.
+    # This can actually be any full or relative path on your system, but should almost
+    # always be left alone for automatic resolution.
+    def library_path
+      @library_path ||= nil
+    end
+    
+    # Override the the project folder where the library will be installed.
+    # 
+    # By default, libraries are installed into Sprout::ProjectModel +lib_dir+.
+    def project_lib
+      @project_lib ||= ProjectModel.instance.lib_dir
+    end
+    
+    # Unlike other rake tasks, Library tasks are actually 
+    # resolved at 'define' time. This allows the tool tasks
+    # to build their own dependencies (like file deps)
+    #   (I'm sure there's a better way to do this, if you know how to fix this, 
+    # and would like to contribute to sprouts, this might be a good spot for it)
+    def define
+      @file_target = sprout(gem_name, version)
+      @library_path = File.join(@file_target.installed_path, @file_target.archive_path)
+      define_file_task(library_path, project_path)
+    end
+    
+    def execute(*args) # :nodoc:
+      super
+    end
+
+    # The path within the project where this library is installed
+    def project_path
+      if(File.directory?(@library_path))
+        # library is source dir
+        File.join(project_lib, name)
+      else
+        # library is a binary (like swc, jar, etc)
+        File.join(project_lib, File.basename(@file_target.archive_path))
+      end
+    end
+    
+    private
+    
+    def define_file_task(source, destination)
+      file destination do |t|
+        FileUtils.cp_r(library_path, destination)
+      end
+      prerequisites << destination
+    end
+    
+  end
+end
+
+# Helper method for definining and accessing LibraryTask instances in a rakefile
+def library(args, &block)
+  Sprout::LibraryTask.define_task(args, &block)
+end