sprout 0.5.29 → 0.7.153

data/lib/{template_resolver.rb → sprout/template_resolver.rb}

@@ -1,17 +1,20 @@
 
-module PatternPark
-  #######################################
-  # TemplateResolver
-  class TemplateResolver < Hash
+module Sprout
+
+  class TemplateResolver < Hash #:nodoc:
     include Singleton
     
-    attr_accessor :replace_all, :ignore_all
+    attr_accessor :replace_all, 
+                  :ignore_all
+                  
     @@SPROUT_FILE_NAME = 'Sprout'
-    @@RENDER_IGNORE_FILES = ['asclass_config.rb', 'SWFMillTemplate.erb']
+    @@RENDER_IGNORE_FILES = ['asclass_config.rb', 'SWFMillTemplate.erb', 'Template.erb']
     @@BINARY_EXTENSIONS = ['.jpg', '.png', '.gif', '.doc', '.xls', '.exe', '.swf', 'fla', '.psd']
     @@LOG_PREFIX = ">> Created file: "
-    @@DELETE_PREFIX = ">> DELETED file: "
+    @@DELETE_PREFIX = ">> Deleted file: "
+
     def initialize
+      super
       @replace_all = false
       @ignore_all = false
     end

data/lib/{user.rb → sprout/user.rb}

@@ -1,13 +1,20 @@
+require 'platform'
+require 'sprout/log'
+require 'sprout/process_runner'
 
-module PatternPark
+module Sprout
 
-  class ExecutionError < StandardError; end
+  class ExecutionError < StandardError # :nodoc:
+  end
 
-  #############################
-  # User class
+  # The User class provides a single and consistent interface to User based paths
+  # and features so that Sprout implementation code doesn't need to be concerned
+  # with which Operating system it is running on.
+  #
   class User
     @@user = nil
 
+    # Retrieve a user instance that represents the currently logged in user on this system.
     def User.new(os=nil, impl=nil)
         if(os.nil? && impl.nil? && @@user)
           return @@user
@@ -26,41 +33,75 @@ module PatternPark
           @@user = WinUser.new
         elsif(os == :unix && impl == :macosx)
           @@user = OSXUser.new
-        elsif(os == :unix && impl == :linux)
-          @@user = UnixUser.new
+#        elsif(os == :unix && impl == :linux)
+#          @@user = UnixUser.new
         else
           @@user = UnixUser.new
         end
     end
 
-    def User.user=(user)
+    def User.user=(user) # :nodoc:
       @@user = user
     end
 
-    def User.home=(path)
+    def User.home=(path) # :nodoc:
       User.new().home = path
     end
 
+    # Pass an executable or binary file name and find out if that file exists in the system
+    # path or not
     def User.in_path?(executable)
       User.new().in_path?(executable)
     end
+    
+    # Retrieve the full path to an executable that exists in the user path
+    def User.get_exe_path(executable)
+      return User.new().get_exe_path(executable)
+    end
 
+    # Return the home path for the currently logged in user. If the user name is lbayes, this should be:
+    #
+    # Windows XP::  C:\Documents And Settings\lbayes
+    # Cygwin::  /cygdrive/c/Documents And Settings/lbayes 
+    # OS X::  /Users/lbayes
+    # Linux::   ~/
     def User.home
       User.new().home
     end
 
+    # Returns the home path for a named application based on the currently logged in user and operating system.
+    # If the user name is lbayes and the application name is Sprouts, this path will be:
+    #
+    # Windows XP::  C:\Documents And Settings\lbayes\Local Settings\Application Data\Sprouts
+    # Cygwin::  /cygdrive/c/Documents And Settings/Local Settings/Application Data/Sprouts
+    # OS X::  /Users/lbayes/Library/Sprouts
+    # Linux::   ~/.sprouts
     def User.application_home(name)
       return User.new().application_home(name)
     end
 
+    # Returns the library path on the current system. This is the general path where all applications should
+    # store configuration or session data.
+    #
+    # Windows XP::   C:\Documents And Settings\lbayes\Local Settings\Application Data
+    # Cygwin::  /cygdrive/c/Documents And Settings/lbayes/Local Settings/Application Data 
+    # OS X::   /Users/lbayes/Library
+    # Linux::   ~/
     def User.library
       return User.new().library
     end
 
+    # Execute a named tool sprout. The full sprout name should be provided to the tool parameter, and
+    # a string of shell parameters that will be sent to the tool itself.
     def User.execute(tool, options='')
       return User.new().execute(tool, options)
     end
+    
+    def User.execute_silent(tool, options='')
+      return User.new().execute_silent(tool, options)
+    end
 
+    # Execute a named tool sprout as a new thread and return that thread
     def User.execute_thread(tool, options='')
       if(Log.debug)
          return ThreadMock.new
@@ -69,25 +110,26 @@ module PatternPark
       end
     end
 
+    # Clean a path string in such a way that works for each platform. For example, Windows doesn't like
+    # it when we backslash to escape spaces in a path because that is the character they use as a delimiter.
+    # And OS X doesn't really like it when we wrap paths in quotes.
     def User.clean_path(path)
       return User.new().clean_path(path)
     end
 
-    # Called from Sprout.init_values...
-    def User.init_values
-        @@user = nil
-        @@home = nil
-    end
   end
 
   #############################
   # UnixUser class
-  class UnixUser
+  class UnixUser # :nodoc:
 
     def initialize
-      require 'open3'
+      setup_user
       @home = nil
     end
+    
+    def setup_user
+    end
 
     def home=(path)
       @home = path
@@ -108,7 +150,7 @@ module PatternPark
 
       begin
         return @home = File.expand_path("~")
-      rescue StandardError => ex
+      rescue StandardError
         if File::ALT_SEPARATOR
           return @home = "C:\\"
         else
@@ -119,9 +161,11 @@ module PatternPark
 
     def get_exe_path(executable)
       paths = get_paths
+      file = nil
       paths.each do |path|
-  if(File.exists?(File.join(path, executable)))
-          return File.join(path, executable)
+        file = File.join(path, executable)
+        if(File.exists?(file))
+          return file
         end
       end
       return nil
@@ -149,19 +193,11 @@ module PatternPark
       end
     end
 
-    def get_process_runner(command)
-      return ProcessRunner.new(command)
-    end
-
     def execute(tool, options='')
-      tool = Sprout.load(tool)
-      if(tool.executable)
-        target = get_exe_path(tool.executable)
-      else
-        target = tool.archive_path
-      end
-      Log.puts(">> Execute: #{File.basename(target)} #{options}")
-      runner = get_process_runner("#{clean_path(target)} #{options}")
+      Log.puts(">> Execute: #{File.basename(tool)} #{options}")
+      tool = clean_path(tool)
+      runner = ProcessRunner.new("#{tool} #{options}")
+    
       result = runner.read
       error = runner.read_err
       if(result.size > 0)
@@ -172,6 +208,11 @@ module PatternPark
       end
     end
 
+    def execute_silent(tool, options='')
+      tool = clean_path(tool)
+      return ProcessRunner.new("#{tool} #{options}")
+    end
+    
     def execute_thread(tool, options='')
       return Thread.new {
         execute(tool, options)
@@ -197,7 +238,7 @@ module PatternPark
     end
   end
 
-  class OSXUser < UnixUser
+  class OSXUser < UnixUser # :nodoc:
     @@LIBRARY = 'Library'
 
     def library
@@ -214,14 +255,17 @@ module PatternPark
     end
   end
 
-  class WinUser < UnixUser
+  class WinUser < UnixUser # :nodoc:
     @@LOCAL_SETTINGS = "Local\ Settings"
     @@APPLICATION_DATA = "Application\ Data"
 
     def initialize
-      require 'win32/open3'
+      super
       @home = nil
     end
+    
+    def setup_user
+    end
 
     def home
       usr = super
@@ -258,14 +302,17 @@ module PatternPark
     end
   end
 
-  class CygwinUser < WinUser
+  class CygwinUser < WinUser # :nodoc:
 
     def initialize
-      require 'open3'
+      super
       @home = nil
       @win_home = nil
       @win_home_cyg_path = nil
     end
+    
+    def setup_user
+    end
 
     def clean_path(path)
       if(path.index(' '))
@@ -294,7 +341,7 @@ module PatternPark
 
   end
 
-  class VistaUser < WinUser
+  class VistaUser < WinUser # :nodoc:
     def home
       profile = ENV['USERPROFILE']
       if(profile)
@@ -304,7 +351,7 @@ module PatternPark
     end
   end
 
-  class ThreadMock
+  class ThreadMock # :nodoc:
     def alive?
       return false
     end

data/lib/sprout/version.rb

@@ -1,9 +1,10 @@
-module Sprout #:nodoc:
+module Sprout
   module VERSION #:nodoc:
     MAJOR = 0
-    MINOR = 5
-    TINY  = 30
+    MINOR = 7
+    TINY  = 153
 
     STRING = [MAJOR, MINOR, TINY].join('.')
+    MAJOR_MINOR = [MAJOR, MINOR].join('.')
   end
 end

data/lib/sprout/zip_util.rb

@@ -0,0 +1,61 @@
+
+module Sprout
+  class ZipUtil #:nodoc:
+
+    # Pack up an archive from a directory on disk
+    def self.pack(input, archive, excludes)
+      Zip::ZipFile.open(archive, Zip::ZipFile::CREATE) do |zip|
+        add_file_to_zip(zip, input, excludes)
+      end
+    end
+    
+    # Unpack an archive to a directory on disk
+    def self.unpack(archive, destination)
+      Zip::ZipFile.open(archive) do |zip|
+        unpack_file(zip, destination)
+      end
+    end
+    
+    def self.unpack_file(zip, destination, path='')
+      if(zip.file.file?(path))
+        File.open(File.join(destination, path), 'w') do |dest|
+          zip.file.open(path) do |src|
+            dest.write src.read
+          end
+        end
+      else
+        Dir.mkdir(File.join(destination, path))
+        zip.dir.foreach(path) do |dir|
+          unpack_file(zip, destination, File.join(path, dir))
+        end
+      end
+    end
+
+    def self.add_file_to_zip(zip, path, excludes)
+      if(File.directory?(path))
+        zip.dir.mkdir(path)
+        Dir.open(path).each do |child|
+          if(!excluded?(child, excludes))
+            add_file_to_zip(zip, File.join(path, child), excludes)
+          end
+        end
+      else
+        File.open(path) do |src|
+          zip.file.open(path, 'w') do |dest|
+            dest.write src.read
+          end
+        end
+      end
+    end
+
+    def self.excluded?(str, excludes)
+      excludes.each do |exc|
+        if(str == exc)
+          return true
+        end
+      end
+      return false
+    end
+
+  end
+end