sprout 0.7.219-i686-darwin10

data/lib/sprout/tasks/git_task.rb

@@ -0,0 +1,134 @@
+require 'sprout/version_file'
+
+module Sprout
+  
+  class GitTaskError < StandardError; end
+  
+  # A Rake task for continous integration and automated deployment.
+  # This task will automatically load a +version_file+, increment
+  # the last digit (revision), create a new tag in Git with the full
+  # version number, and push tags to the remote Git repository.
+  #
+  # To use this task, simply add the following to your rakefile:
+  #
+  #   desc 'Increment revision, tag and push with git'
+  #   git :tag do |t|
+  #     t.version_file = 'version.txt'
+  #   end
+  #
+  
+  class GitTask < Rake::Task
+    # Path to a plain text file that contains a three-part version number.
+    # @see VersionFile
+    attr_accessor :version_file
+    # The remote branch to use, defaults to 'origin'.
+    attr_accessor :remote
+    # The local branch to send, defaults to 'master'.
+    attr_accessor :branch
+    # Message to use when committing after incrementing revision number.
+    # Defaults to 'Incremented revision number'.
+    attr_accessor :commit_message
+    
+    def initialize(name, app)
+      super
+      @remote = 'origin'
+      @branch = 'master'
+      @commit_message = 'Incremented revision number'
+    end
+    
+    def version
+      @version.to_s
+    end
+    
+    def define
+      validate
+      @version = VersionFile.new(version_file)
+    end
+    
+    def execute(*args)
+      super
+      # Fix numeric comparison....
+      while(get_tags.index(@version.to_tag)) do
+        @version.increment_revision
+      end
+      create_tag(@version.to_tag)
+      commit
+      push
+    end
+
+    def self.define_task(args, &block)
+      begin
+        require 'git'
+      rescue LoadError => e
+        puts "You need to install the 'git' gem. Try running: sudo gem install git"
+        raise e
+      end
+      t = super
+      yield t if block_given?
+      t.define
+      return t
+    end
+    
+    # Accessor for mocking the git gem.
+    def scm=(scm)
+      @scm = scm
+    end
+    
+    # Will open on path if no SCM exists yet.
+    def scm
+      if(@scm.nil?)
+        path = path_to_git
+        raise GitTaskError.new("We don't appear to be inside of a git repository") if path.nil?
+        @scm = Git.open(path)
+      end
+
+      @scm
+    end
+    
+    private
+    
+    def push
+      `git push #{remote} #{branch} --tags`
+    end
+    
+    def commit
+      `git commit -a -m "#{commit_message}"`
+    end
+    
+    def path_to_git
+      git = '.git'
+      parts = Dir.pwd.split(File::SEPARATOR)
+      
+      while(parts.size > 0) do
+        path = parts.join(File::SEPARATOR)
+        if(File.exists?(File.join(path, git)))
+          return path
+        end
+        parts.pop
+      end
+      
+      return nil
+    end
+    
+    def get_tags
+      return scm.tags.collect do |t|
+        t.name
+      end
+    end
+    
+    def create_tag(name)
+      scm.add_tag name
+    end
+    
+    def validate
+      raise GitTaskError.new("task.version_file is a required configuration for GitTask") if version_file.nil?
+    end
+    
+  end
+
+end
+
+# Helper method for definining the git task in a rakefile
+def git(args, &block)
+  Sprout::GitTask.define_task(args, &block)
+end

data/lib/sprout/tasks/library_task.rb

@@ -0,0 +1,118 @@
+=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-#{clean_name}-library"
+    end
+    
+    # Ensure that namespaced rake tasks only use
+    # the final part for name-based features
+    def clean_name
+      return name.split(':').pop
+    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
+      if(library_path.index('.swc'))
+        @project_lib ||= ProjectModel.instance.swc_dir
+      else
+        @project_lib ||= ProjectModel.instance.lib_dir
+      end
+    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, clean_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|
+        lib_path = library_path
+        FileUtils.makedirs(destination)
+        if(File.directory?(lib_path))
+          lib_path = "#{lib_path}/."
+        end
+        FileUtils.cp_r(lib_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

data/lib/sprout/tasks/sftp_task.rb

@@ -0,0 +1,248 @@
+=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.
+
+This class has been commented out because the termios feature
+that allows users to more securely enter passwords does not
+work in a DOS shell.
+
+It would be greatly appreciate if someone refactored this to either:
+a) Get the same functionality in a cross-platform manner
+b) Only require and use termios on systems that allow it
+=end
+
+#gem 'net-ssh', '1.1.4'
+#gem 'net-sftp', '1.1.1'
+
+require 'net/ssh'
+require 'net/sftp'
+
+#require 'termios'
+
+module Sprout
+  class SFTPError < StandardError #:nodoc:
+  end
+
+  # The SFTPTask provides a simple rake task interface to the SFTP client RubyGem.
+  # This task can allow you to easily push build artifacts to a remote server 
+  # with a single shell command.
+  class SFTPTask < Rake::Task
+
+    # Collection of files that should be transmitted to the remote server
+    attr_accessor :files
+    # Host name of the server to connect to with no protocol prefix, like: sub.yourhost.com
+    attr_accessor :host
+    # Username to send to the remote host. You will be prompted for this value if it is left null. 
+    #
+    # NOTE: You should never check a file into version control with this field filled in, it is
+    # provided here as a convenience for getting set up.
+    attr_accessor :username
+    # The mode for transmitted files. Defaults to 0644
+    attr_accessor :file_mode
+    # the mode for created directories. Defaults to 0755
+    attr_accessor :dir_mode
+    # The local path to mask from transmitted files. This is key feature for automated file transmission.
+    # For example, if you are sending a file:
+    #   bin/assets/img/SomeImage.jpg
+    # into a directory on your server like:
+    #   /var/www/someproject/
+    # You don't necessarily want the 'bin' folder copied over, so you set the local_path to 'bin' like:
+    #   t.local_path = 'bin'
+    # and your server will have the file uploaded to:
+    #   /var/www/someproject/assets/img/SomeImage.jpg
+    attr_accessor :local_path
+    # The Remote base path where files should be transmitted, can be absolute or relative.
+    attr_accessor :remote_path
+    # Password to send to the remote host. You will be prompted for this value if it is left null.
+    #
+    # NOTE: You should never check a file into version control with this field filled in, it is
+    # provided here as a convenience for getting set up.
+    attr_accessor :password
+
+    def initialize(task_name, app)
+      super(task_name, app)
+      @name = name
+      @files = []
+      @dir_mode = 0755
+      @file_mode = 0644
+      @host = nil
+    end
+
+    def self.define_task(args, &block) # :nodoc:
+      t = super
+      yield t if block_given?
+    end
+    
+    def execute(*args) # :nodoc:
+      if(@files.size == 0)
+        if(@local_path)
+          expr = @local_path + '/**/**/*'
+          @files = FileList[expr]
+        else
+          raise SFTPError.new('SFTP requires either a local_path or files to be transmitted')
+        end
+      else
+        if(!@local_path)
+          @local_path = ''
+        end
+      end
+
+      if(@host.nil?)
+        raise SFTPError.new('SFTP requires non-nil host parameter')
+      end
+
+      if(@username.nil?)
+        print "Username: "
+        @username = $stdin.gets.chomp!
+        raise SFTPError.new('SFTP requires username parameter') unless @username
+      end
+
+      if(@password.nil?)
+        print "Password: "
+        @password = $stdin.gets.chomp!
+#        @password = Password.get
+        raise SFTPError.new('SFTP requires password parameter') unless @password
+      end
+    
+      if(get_confirmation)
+        puts ">> Connecting to Remote Server: #{@username}@#{@host}:#{@remote_path}"
+        
+        Net::SFTP.start(@host, @username, @password) do |sftp|
+          begin
+            dir = sftp.opendir(@remote_path)
+          rescue Net::SFTP::Operations::StatusException
+            puts "[ERROR] [#{@remote_path}] does not exist on the server"
+            return
+          end
+          for file in @files
+            next if File.stat(file).directory?
+            remote_file = remote_file_name(file)
+            put_file(file, remote_file, sftp)
+          end
+        end
+      else
+        puts "[WARNING] Publish aborted by user request"
+      end
+    end
+    
+    def put_file(local_file, remote_file, sftp) # :nodoc:
+      begin
+        create_remote_dir(remote_file, sftp)
+        
+        if(file_changed(local_file, remote_file, sftp))
+          puts ">> Pushing #{local_file} to: #{remote_file}"
+          sftp.put_file(local_file, remote_file)
+        end
+      rescue Net::SFTP::Operations::StatusException => e
+        raise unless e.code == 2
+        sftp.put_file(local_file, remote_file)
+        sftp.setstat(remote_file, :permissions => @file_mode)
+      end
+    end
+    
+    def create_remote_dir(path, sftp) # :nodoc:
+      begin
+        sftp.stat(File.dirname(path))
+      rescue Net::SFTP::Operations::StatusException => e
+        raise unless e.code == 2
+        dir = File.dirname(path.sub(@remote_path, ''))
+        parts = dir.split(File::SEPARATOR)
+        part = File.join(@remote_path, parts.shift)
+        while(part)
+          begin
+            sftp.stat(part)
+          rescue Net::SFTP::Operations::StatusException => ne
+            raise unless ne.code == 2
+            sftp.mkdir(part, :permissions => @dir_mode)
+          end
+          if(parts.size > 0)
+            part = File.join(part, parts.shift)
+          else
+            part = nil
+          end
+        end
+      end
+    end
+    
+    def file_changed(local_file, remote_file, sftp) # :nodoc:
+      local_stat = File.stat(local_file)
+      remote_stat = sftp.stat(remote_file)
+      time_difference = (local_stat.mtime > Time.at(remote_stat.mtime))
+      size_difference = (local_stat.size != remote_stat.size)
+      return (time_difference || size_difference)
+    end
+    
+    def remote_file_name(file) # :nodoc:
+      return @remote_path + file.sub(@local_path, '')
+    end
+    
+    def get_confirmation # :nodoc:
+      puts "-----------------------------------------"
+      puts "Are you sure you want to publish #{@files.size} files to:"
+      puts "#{@username}@#{@host}:#{@remote_path}? [Yn]"
+      response = $stdin.gets.chomp!
+      return (response.downcase == 'y' || response == "")
+    end
+  
+  end
+
+=begin
+  # The following implementation does not work at all on DOS machines, 
+  # is there a cross-platform way to solve the secure password prompt problem?
+  # Password handling snippet found at: http://www.caliban.org/ruby/ruby-password.shtml
+  class Password
+
+    def Password.get(message="Password: ")
+      begin
+        if $stdin.tty?
+          Password.echo false
+          print message if message
+        end
+  
+        return $stdin.gets.chomp
+      ensure
+        if $stdin.tty?
+          Password.echo true
+          print "\n"
+        end
+      end
+    end
+
+    def Password.echo(on=true, masked=false)
+      term = Termios::getattr( $stdin )
+  
+      if on
+        term.c_lflag |= ( Termios::ECHO | Termios::ICANON )
+      else # off
+        term.c_lflag &= ~Termios::ECHO
+        term.c_lflag &= ~Termios::ICANON if masked
+      end
+  
+      Termios::setattr( $stdin, Termios::TCSANOW, term )
+    end
+  end
+=end
+end
+
+
+def sftp(args, &block)
+  Sprout::SFTPTask.define_task(args, &block)
+end