sprout 0.7.198 → 0.7.201

data/lib/sprout/process_runner.rb

@@ -76,6 +76,10 @@ module Sprout #:nodoc:
       @w.puts(msg)
     end
     
+    def close_write
+      @w.close_write
+    end
+    
     def read
       return @r.read
     end

data/lib/sprout/project_model.rb

@@ -98,6 +98,10 @@ module Sprout
     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

data/lib/sprout/tasks/tool_task.rb

@@ -30,17 +30,13 @@ module Sprout
   #
   class ToolTask < Rake::FileTask
     
-    # Arguments to be prepended in front of the command line output
-    attr_accessor :prepended_args
-    # Arguments to appended at the end of the command line output
-    attr_accessor :appended_args
-    
     def initialize(name, app) # :nodoc:
       super
-      @prepended_args   = nil
-      @appended_args    = nil
-      @default_gem_name = nil
-      @default_gem_path = nil
+      @preprocessed_path = nil
+      @prepended_args    = nil
+      @appended_args     = nil
+      @default_gem_name  = nil
+      @default_gem_path  = nil
       initialize_task
     end
     
@@ -115,8 +111,80 @@ module Sprout
 
       return result
     end
+
+    # Arguments to be prepended in front of the command line output
+    def prepended_args=(args)
+      @prepended_args = args
+    end
+    
+    # Returns arguments that were prepended in front of the command line output
+    def prepended_args
+      @prepended_args
+    end
+    
+    # Arguments to appended at the end of the command line output
+    def appended_args=(args)
+      @appended_args = args
+    end
+    
+    # Returns arguments that were appended at the end of the command line output
+    def appended_args
+      @appended_args
+    end
+    
+    # Command line arguments to execute preprocessor.
+    # The preprocessor execution should accept text via STDIN and return its processed content via STDOUT.
+    #
+    # In the following example, the +MXMLCTask+ has been configured to use the C preprocessor (cpp) and
+    # place the processed output into a +_preprocessed+ folder, instead of the hidden default folder at 
+    # .preprocessed.
+    #
+    # One side effect of the cpp tool is that it adds 2 carriage returns to the top of any processed files,
+    # so we have simply piped its output to the tail command which then strips those carriage returns from
+    # all files - which retains accurate line numbers for any compiler error messages.
+    #
+    #   mxmlc 'bin/SomeProject.swf' => :corelib do |t|
+    #     t.input                     = 'src/SomeProject.as'
+    #     t.default_size              = '800 600'
+    #     t.preprocessor              = 'cpp -D__DEBUG=true -P - - | tail -c +3'
+    #     t.preprocessed_path         = '_preprocessed'
+    #   end
+    #
+    # Any source files found in this example project can now take advantage of any tools, macros or syntax
+    # available to CPP. For example, the +__DEBUG+ variable is now defined and can be accessed in ActionScript
+    # source code as follows:
+    #
+    #   public static const DEBUG:Boolean = __DEBUG;
+    #
+    # Any commandline tool identified on this attribute will be provided the content of each file on STDIN and 
+    # whatever it returns to STDOUT will be written into the +preprocessed_path+. This means that we can 
+    # take advantage of the entire posix tool chain by piping inputs and outputs from one tool to another.
+    # Whatever the last tool returns will be handed off to the concrete compiler.
+    def preprocessor=(preprocessor)
+      @preprocessor = preprocessor
+    end
+
+    def preprocessor
+      @preprocessor
+    end
+
+    # Path where preprocessed files are stored. Defaults to '.preprocessed'
+    def preprocessed_path=(preprocessed_path)
+      @preprocessed_path = preprocessed_path
+    end
+    
+    def preprocessed_path
+      @preprocessed_path ||= '.preprocessed'
+    end
+    
+    def display_preprocess_message # :nodoc:
+      if(!preprocessor.nil?)
+        puts ">> Preprocessed text files in: #{File.join(Dir.pwd, preprocessed_path)} with #{preprocessor}"
+      end
+    end
     
     def execute(*args)
+      display_preprocess_message
       #puts ">> Executing #{File.basename(exe)} #{to_shell}"
       exe = Sprout.get_executable(gem_name, gem_path, gem_version)
       User.execute(exe, to_shell)
@@ -319,15 +387,16 @@ module Sprout
   # rake tasks for Command Line Interface (CLI) compilers.
   #
   class TaskParam
-    attr_accessor :name
-    attr_accessor :type
-    attr_accessor :validator
+    attr_accessor :belongs_to
     attr_accessor :description
-    attr_accessor :visible
     attr_accessor :hidden_name
     attr_accessor :hidden_value
+    attr_accessor :name
+    attr_accessor :preprocessable
     attr_accessor :required
-    attr_accessor :belongs_to
+    attr_accessor :type
+    attr_accessor :validator
+    attr_accessor :visible
 
     attr_writer   :prefix
     attr_writer   :value
@@ -433,6 +502,94 @@ module Sprout
       result << "def #{name}=(#{type})\n  @#{name} = #{type}\nend\n\n"
       return result
     end
+
+    protected
+    
+    def should_preprocess?
+      return preprocessable && !belongs_to.preprocessor.nil?
+    end
+    
+    def prepare_preprocessor_paths(paths)
+      processed = []
+      paths.each do |path|
+        processed << prepare_preprocessor_path(path)
+      end
+      return processed
+    end
+    
+    def prepare_preprocessor_files(files)
+      processed = []
+      files.each do |file|
+        processed << prepare_preprocessor_file(file)
+      end
+      return processed
+    end
+    
+    def cleaned_preprocessed_path(path)
+      File.join(belongs_to.preprocessed_path, path.gsub('../', 'backslash/'))
+    end
+    
+    def prepare_preprocessor_path(path)
+      processed_path = cleaned_preprocessed_path(path)
+      FileUtils.mkdir_p(processed_path)
+      files = FileList[path + file_expression]
+      files.each do |input_file|
+        prepare_preprocessor_file(input_file)
+      end
+      
+      return processed_path
+    end
+    
+    def prepare_preprocessor_file(input_file)
+      output_file = cleaned_preprocessed_path(input_file)
+      setup_preprocessing_file_tasks(input_file, output_file)
+      return output_file
+    end
+    
+    def text_file?(file_name)
+      [/\.as$/, /\.txt$/, /\.mxml$/, /\.xml$/, /\.js$/, /\.html$/, /\.htm$/].select { |regex|
+        if(file_name.match(regex))
+          return true
+        end
+      }.size > 0
+    end
+    
+    def setup_preprocessing_file_tasks(input_file, output_file)
+      return if(File.directory?(input_file))
+      CLEAN.add(belongs_to.preprocessed_path) if(!CLEAN.index(belongs_to.preprocessed_path))
+      
+      file input_file
+      file output_file => input_file do
+        dir = File.dirname(output_file)
+        if(!File.exists?(dir))
+          FileUtils.mkdir_p(dir)
+        end
+        File.open(input_file, 'r') do |readable|
+          File.open(output_file, 'w+') do |writable|
+            if(text_file?(input_file))
+              preprocess_content(readable, writable, belongs_to.preprocessor, input_file)
+            else
+              writable.write(readable.read)
+            end
+          end
+        end
+      end
+      belongs_to.prerequisites << output_file
+    end
+    
+    def preprocess_content(readable, writable, processor, file)
+      process = ProcessRunner.new(processor)
+      process.puts(readable.read)
+      process.close_write
+      result = process.read
+      error = process.read_err
+      if(error.size > 0)
+        belongs_to.display_preprocess_message
+        FileUtils.rm_rf(belongs_to.preprocessed_path)
+        raise ExecutionError.new("[ERROR] Preprocessor failed on file #{file} #{error}")
+      end
+      writable.write(result)
+    end
     
   end
 
@@ -456,16 +613,32 @@ module Sprout
 
   # Concrete param object for :file values
   class FileParam < TaskParam # :nodoc:
+
     def prepare_prerequisites
       if(value && value != belongs_to.name.to_s)
-        file value
-        belongs_to.prerequisites << value
+        if(should_preprocess?)
+          @value = prepare_preprocessor_file(value)
+        else
+          file value
+          belongs_to.prerequisites << value
+        end
       end
     end
   end
 
   # Concrete param object for :path values
-  class PathParam < FileParam # :nodoc:
+  class PathParam < TaskParam # :nodoc:
+
+    def prepare_prerequisites
+      if(value && value != belongs_to.name.to_s)
+        if should_preprocess?
+          @value = prepare_preprocessor_path(value)
+        else
+          file value
+          belongs_to.prerequisites << value
+        end
+      end
+    end
   end
 
   # Concrete param object for :boolean values
@@ -540,26 +713,36 @@ module Sprout
     end
 
     def prepare_prerequisites
-      value.each do |f|
-        file f
-        belongs_to.prerequisites << f
+      if should_preprocess?
+        @value = prepare_preprocessor_files(value)
+      else
+        value.each do |f|
+          file f
+          belongs_to.prerequisites << f
+        end
       end
     end
+
   end
 
   # Concrete param object for collections of paths
   class PathsParam < FilesParam # :nodoc:
 
     def prepare_prerequisites
-      usr = User.new
-      value.each do |f|
-        files = FileList[f + file_expression]
-        files.each do |req_file|
-          file req_file
-          belongs_to.prerequisites << req_file
+      if should_preprocess?
+        @value = prepare_preprocessor_paths(value)
+      else
+        value.each do |path|
+          files = FileList[path + file_expression]
+          files.each do |f|
+            file f
+            belongs_to.prerequisites << f
+          end
         end
       end
     end
+    
+
   end
 
   # Concrete param object for collections of files

data/lib/sprout/version.rb

@@ -2,7 +2,7 @@ module Sprout
   module VERSION #:nodoc:
     MAJOR = 0
     MINOR = 7
-    TINY  = 198
+    TINY  = 201
 
     STRING = [MAJOR, MINOR, TINY].join('.')
     MAJOR_MINOR = [MAJOR, MINOR].join('.')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: sprout
 version: !ruby/object:Gem::Version 
-  version: 0.7.198
+  version: 0.7.201
 platform: ruby
 authors: 
 - Luke Bayes
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-01-09 00:00:00 -08:00
+date: 2009-01-13 00:00:00 -08:00
 default_executable: sprout
 dependencies: 
 - !ruby/object:Gem::Dependency