airake 0.1.6 → 0.1.7

data/History.txt

@@ -1,3 +1,9 @@
+== 0.1.7 2007-09-03
+
+* FCSH warnings are to not trigger compile error
+* Made additional options available via rake ENV
+* Other refactoring
+
 == 0.1.6 2007-08-31
 
 * Fixing task bugs

data/License.txt

@@ -17,4 +17,7 @@ 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.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+
+Portions of this work are derived from Sprout (http://code.google.com/p/projectsprouts/).

data/README.txt

@@ -8,15 +8,12 @@ To include adl and adt (from Apollo SDK):
   
 == Creating an AIR project
 
-  airake path/to/MyProject com.company.MyProject
-  
-will build a project scaffold with application name of MyProject and application id (used for AIR descriptor) of com.company.MyProject
-
-The project includes as3corelib and flexunit, and test scaffolding as well.  
+  airake MyProject
   
 == Tasks
 
-  Run: rake --tasks 
+  # View all tasks
+  rake --tasks
 
   # Compiling
   rake air:compile 
@@ -44,3 +41,35 @@ The project includes as3corelib and flexunit, and test scaffolding as well.
 
   # Package AIR file
   rake air:package
+  
+== Adding other tasks
+
+Add tasks to the rakefile, for example:
+
+  # Run ADL for Catalog mxml
+  task :catalog do
+    ENV["MXML"] = "src/catalog/Catalog.mxml"
+    Rake::Task["air:adl"].invoke
+  end
+
+== Override default settings for Rakefile
+
+This is experimental. In the Rakefile, specify:
+
+  # Override default settings, this is experimental
+  # cwd = File.expand_path(File.dirname(__FILE__))
+  #ENV["MXMLC_PATH"] = "mxmlc"
+  #ENV["ADT_PATH"] = "adt"
+  #ENV["BIN_DIR"] = "#{cwd}/bin"
+  #ENV["SRC_DIR"] = "#{cwd}/src"
+  #ENV["LIB_DIR"] = "#{cwd}/lib"
+  #ENV["TEST_DIR"] = "#{cwd}/test"
+  #ENV["APPXML_PATH"] = "#{cwd}/src/MyProject-app.xml"
+  #ENV["AIR_PATH"] = "#{cwd}/bin/MyProject.air"
+  #ENV["SWF_PATH"] = "#{cwd}/bin/MyProject.swf"
+  #ENV["MXMLC_EXTRA_OPTS"] = ...
+  #ENV["ADL_EXTRA_OPTS"] = ...
+  #ENV["ADT_EXTRA_OPTS"] = ...
+  #ENV["MXMLC_COMMAND"] = ...
+  #ENV["ADL_COMMAND"] = ...
+  #ENV["ADT_COMMAND"] = ...

data/app_generators/airake/templates/README

@@ -5,18 +5,11 @@ To include mxmlc, adl and adt (from Flex Builder):
   
 To include adl and adt (from Apollo SDK):
   export PATH="/Applications/ApolloSDK/bin:$PATH"
-  
-== Creating an AIR project
-
-  airake path/to/MyProject com.company.MyProject
-  
-will build a project scaffold with application name of MyProject and application id (used for AIR descriptor) of com.company.MyProject
-
-The project includes as3corelib and flexunit, and test scaffolding as well.  
-  
+    
 == Tasks
 
-  Run: rake --tasks 
+  # View all tasks
+  rake --tasks 
 
   # Compiling
   rake air:compile 
@@ -44,3 +37,35 @@ The project includes as3corelib and flexunit, and test scaffolding as well.
 
   # Package AIR file
   rake air:package
+  
+== Adding other tasks
+
+Add tasks to the rakefile, for example:
+
+  # Run ADL for Catalog mxml
+  task :catalog do
+    ENV["MXML"] = "src/catalog/Catalog.mxml"
+    Rake::Task["air:adl"].invoke
+  end
+
+== Override default settings for Rakefile
+
+This is experimental. In the Rakefile, specify:
+
+  # Override default settings, this is experimental
+  # cwd = File.expand_path(File.dirname(__FILE__))
+  #ENV["MXMLC_PATH"] = "mxmlc"
+  #ENV["ADT_PATH"] = "adt"
+  #ENV["BIN_DIR"] = "#{cwd}/bin"
+  #ENV["SRC_DIR"] = "#{cwd}/src"
+  #ENV["LIB_DIR"] = "#{cwd}/lib"
+  #ENV["TEST_DIR"] = "#{cwd}/test"
+  #ENV["APPXML_PATH"] = "#{cwd}/src/MyProject-app.xml"
+  #ENV["AIR_PATH"] = "#{cwd}/bin/MyProject.air"
+  #ENV["SWF_PATH"] = "#{cwd}/bin/MyProject.swf"
+  #ENV["MXMLC_EXTRA_OPTS"] = ...
+  #ENV["ADL_EXTRA_OPTS"] = ...
+  #ENV["ADT_EXTRA_OPTS"] = ...
+  #ENV["MXMLC_COMMAND"] = ...
+  #ENV["ADL_COMMAND"] = ...
+  #ENV["ADT_COMMAND"] = ...

data/app_generators/airake/templates/Rakefile

@@ -1,6 +1,5 @@
 require 'rubygems'
 require 'airake'
-require 'pathname'
 
 ENV["BASE_DIR"] ||= File.expand_path(File.dirname(__FILE__))
 
@@ -8,8 +7,11 @@ ENV["BASE_DIR"] ||= File.expand_path(File.dirname(__FILE__))
 ENV["MXML"] ||= "src/<%= app_name %>.mxml"
 ENV["MXML_TEST"] ||= "test/Test.mxml"
 
+# For task list run, rake --tasks
+
 # Uncomment for custom FCSH settings
 #ENV["FCSH_IP"] ||= "127.0.0.1"
 #ENV["FCSH_PORT"] ||= "20569"
 
-# For task list run, rake --tasks
+# For debug
+#ENV["DEBUG"] = "true"

data/lib/airake/fcsh.rb

@@ -26,6 +26,7 @@ module PatternPark
 
   class FCSHError < StandardError; end
   class FCSHConnectError < FCSHError; end  
+  class FCSHCompileError < FCSHError; end
 
   class FCSH
   
@@ -54,22 +55,24 @@ module PatternPark
       start_time = Time.now
 
       error_found = false
+      warning_found = false
       begin
         @socket = TCPSocket.open(@ip, @port) do |s|
           puts ">> Opened connection to fcshd on #{@ip}:#{@port}"
           s.puts args
           s.close_write
-          while(line = s.gets)
-            break if (line.match(/^\[PROMPT\]/))
-            error_found = true if (line.match(/^\[FCSH ERROR\]/))
-            puts line
+          while line = s.gets
+            break if line =~ /^\[PROMPT\]/
+            error_found = true if line =~ /^\[FCSH ERROR\]/
+            warning_found = true if line =~ /^\[FCSH WARNING\]/
+            puts line             
           end
         end
       rescue StandardError => e
         raise FCSHConnectError.new("[FCSH] Unable to connect to FCSHD process")
       end
     
-      raise FCSHError.new("[ERROR] Compile error encountered") if error_found
+      raise FCSHCompileError.new("[ERROR] Compile error encountered") if error_found
 
       end_time = Time.now - start_time
       puts "[FCSH] Compilation complete in: #{end_time} seconds"

data/lib/airake/fcshd.rb

@@ -80,9 +80,15 @@ module PatternPark
       
       compile_errors = false
       e = Thread.new {
-        while(line = fcsh.e.gets)
-          io.puts "[FCSH ERROR] #{line}"
-          compile_errors = true
+        while line = fcsh.e.gets
+          if line.strip.empty?
+            io.puts " "
+          elsif line =~ /.?: Warning: .?/
+            io.puts "[FCSH WARNING] #{line}"
+          else
+            io.puts "[FCSH ERROR] #{line}"
+            compile_errors = true            
+          end
         end
       }
 

data/lib/airake/project.rb

@@ -1,69 +1,127 @@
+require 'pathname'
+
 module Airake 
   # Project settings for AIR app
   class Project
   
-    attr_reader :project_name, :mxmlc_path, :adt_path
+    attr_reader :project_name
     attr_reader :base_dir, :bin_dir, :src_dir, :lib_dir, :test_dir
     attr_reader :mxml_path, :appxml_path, :air_path, :swf_path
     attr_reader :debug
+    
+    attr_reader :mxmlc_path, :adt_path, :adl_path
+    attr_reader :mxmlc_command, :adt_command, :adl_command, :mxmlc_extra_opts
+    
+    Options = [ :mxmlc_path, :adt_path, :bin_dir, :src_dir, :lib_dir, :test_dir, 
+      :appxml_path, :air_path, :swf_path, :debug, :mxmlc_command, :adt_command, 
+      :adl_command, :mxmlc_extra_opts, :adl_extra_opts, :adt_extra_opts ]
   
+    # Settings
+    # Specify base directory, the path to Project.mxml (relative) and options.
+    # Options override default settings, see Options class var.
     def initialize(base_dir, mxml_path, options = {})
-      @mxmlc_path = "mxmlc"
-      @adt_path = "adt"
-
       @base_dir = base_dir
-      @bin_dir = File.join(base_dir, "bin")
-      @src_dir = File.join(base_dir, "src")
-      @lib_dir = File.join(base_dir, "lib")
-      @test_dir = File.join(base_dir, "test")
-    
-      @project_name = File.basename(mxml_path, ".mxml")
       @mxml_path = mxml_path
-      mxml_dir = File.expand_path(File.dirname(mxml_path))
+      
+      @mxmlc_path = options[:mxmlc_path] || "mxmlc"
+      @adt_path = options[:adt_path] || "adt"
+      @adl_path = options[:adl] || "adl"
+      
+      @bin_dir = options[:bin_dir] || File.join(base_dir, "bin")
+      @src_dir = options[:src_dir] || File.join(base_dir, "src")
+      @lib_dir = options[:lib_dir] || File.join(base_dir, "lib")
+      @test_dir = options[:test_dir] || File.join(base_dir, "test")
     
-      @appxml_path = options[:appxml_path] || "#{mxml_dir}/#{project_name}-app.xml"
+      @project_name = File.basename(@mxml_path, ".mxml")      
+      mxml_dir = File.expand_path(File.dirname(@mxml_path))    
+      @appxml_path = options[:appxml_path] || File.join(mxml_dir, "#{project_name}-app.xml")
     
       # Dest package files
-      @air_path = options[:air_path] || "#{@bin_dir}/#{project_name}.air"
-      @swf_path = options[:swf_path] || "#{@bin_dir}/#{project_name}.swf"
+      @air_path = options[:air_path] || File.join(@bin_dir, "#{project_name}.air")
+      @swf_path = options[:swf_path] || File.join(@bin_dir, "#{project_name}.swf")
     
-      @debug = options[:debug] || false
+      @debug = options[:debug].is_a?(TrueClass) || options[:debug] == "true"
+      
+      @mxmlc_extra_opts = options[:mxmlc_extra_opts]
+      @adl_extra_opts = options[:adl_extra_opts]
+      @adt_extra_opts = options[:adt_extra_opts]
+      
+      @mxmlc_command = options[:mxmlc_command] || load_mxmlc_command
+      @adt_command = options[:adt_command] || load_adt_command
+      @adl_command = options[:adl_command] || load_adl_command
     end
     
+    # Run the ADT
     def run_adt
       run(adt_command)
     end
   
+    # Run the Flex compiler
     def run_mxmlc    
       run(mxmlc_command)
     end
   
+    # Run the Adobe Debug Launcher
     def run_adl
       run(adl_command)
     end
     
-    def mxmlc_command
-      "#{@mxmlc_path} +configname=air #{source_path_option} -library-path+=#{@lib_dir} -output #{@swf_path} #{debug_option} -disable-incremental-optimizations=true -- #{@mxml_path}"
-    end
-  
-    def adt_command
-      "#{@adt_path} -package #{relative_path(@air_path)} #{relative_path(@appxml_path)} #{relative_path(@swf_path)}"
-    end
-  
-    def adl_command
-      "adl #{@appxml_path} #{@base_dir}"
-    end        
-    
-    # Create project from ENV (for rake tasks)
+    # Create project using parameters from rake ENV
+    # You can set any of the options via ENV; just upcase it. <tt>:foo_bar => ENV["FOO_BAR"]</tt>
+    # Booleans must be "true" for true and false for anything else.
     def self.new_from_rake(env, is_test = false)
       base_dir = env["BASE_DIR"]
       mxml = is_test ? env["MXML_TEST"] : env["MXML"]
-      options = { :debug => env["DEBUG"] }
+      
+      # For any option check to see if its in the ENV      
+      options = {}
+      Options.each do |option_key|
+        env_key = option_key.to_s.upcase
+        options[option_key] = env[env_key] if env.has_key?(env_key)
+      end
+      puts "Using options: #{options.inspect}" unless options.empty?
       self.new(base_dir, mxml, options)
     end
     
   protected     
-        
+  
+    # Get the mxmlc command
+    def load_mxmlc_command
+      command = []
+      command << @mxmlc_path
+      command << "+configname=air"
+      command << source_path_option
+      command << "-library-path+=#{@lib_dir}"
+      command << "-output #{@swf_path}"
+      command << debug_option
+      command << @mxmlc_extra_opts
+      command << "-disable-incremental-optimizations=true"
+      command << "-- #{@mxml_path}"
+      command.compact.join(" ")
+    end
+
+    # Get the ADT command
+    def load_adt_command
+      command = []
+      command << @adt_path
+      command << @adt_extra_opts
+      command << "-package #{relative_path(@air_path)}"
+      command << relative_path(@appxml_path)
+      command << relative_path(@swf_path)
+      command.compact.join(" ")
+    end
+
+    # Get the ADL command
+    def load_adl_command
+      command = []
+      command << @adl_path
+      command << @adl_extra_opts
+      command << @appxml_path
+      command << @base_dir
+      command.compact.join(" ")
+    end
+    
+    # List of directories in lib/ for source_path +=
     def lib_source_paths
       Dir["#{@lib_dir}/*"].collect { |f| f if File.directory?(f) }.compact + [ @test_dir, @src_dir ]
     end

data/lib/airake/version.rb

@@ -2,7 +2,7 @@ module Airake #:nodoc:
   module VERSION #:nodoc:
     MAJOR = 0
     MINOR = 1
-    TINY  = 6
+    TINY  = 7
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.4
 specification_version: 1
 name: airake
 version: !ruby/object:Gem::Version 
-  version: 0.1.6
-date: 2007-08-31 00:00:00 -04:00
+  version: 0.1.7
+date: 2007-09-03 00:00:00 -04:00
 summary: Adobe AIR tasks
 require_paths: 
 - lib