airake 0.3.2 → 0.4.0

data/History.txt

@@ -1,3 +1,7 @@
+=== 0.4.0 2008-01-28
+
+* Using a config file (airake.yml), breaking backwards compatibility, sorry!
+
 == 0.3.2 2008-01-19
 
 * Refactoring amxmlc command into mxmlc command to work for regular flash projects

data/app_generators/airake/airake_generator.rb

@@ -43,6 +43,7 @@ class AirakeGenerator < RubiGen::Base
       m.template "Rakefile", "Rakefile"
       m.template "descriptor_M6.xml", "src/#{app_name}-app.xml"
       m.template "application.mxml", "src/#{app_name}.mxml"
+      m.template "airake.yml", "airake.yml"
       
       # Icons
       m.directory "src/assets/app_icons"

data/app_generators/browsair/browsair_generator.rb

@@ -45,7 +45,8 @@ class BrowsairGenerator < RubiGen::Base
       # Source
       m.directory "src"      
       m.template "descriptor_M6.xml", "src/#{app_name}-app.xml"
-      m.template "application.mxml", "src/#{app_name}.mxml"      
+      m.template "application.mxml", "src/#{app_name}.mxml"    
+      m.template "airake.yml", "airake.yml"  
             
       # Icons
       if icon_src_path.blank?

data/app_generators/shared/Rakefile

@@ -1,18 +1,8 @@
 require 'rubygems'
 require 'airake'
 
-# Specify certificate path
-ENV["CERTIFICATE"] ||= "cert.pfx"
-
-# dirname $0
-ENV["BASE_DIR"] ||= File.expand_path(File.dirname(__FILE__))
-
-# MXML options
-ENV["MXML"] ||= "src/<%= app_name %>.mxml"
-ENV["MXML_TEST"] ||= "test/Test.mxml"
-
-# Assets to package, can be multiple items, e.g. "src/assets/app_icons src/assets/tray_icons"
-ENV["ASSETS"] ||= "src/assets"
+ENV["AIRAKE_ROOT"] = File.dirname(__FILE__)
+ENV["AIRAKE_ENV"] = "development"
 
 # Aliases
 task :test => [ "air:test" ] do; end

data/lib/airake/project.rb

@@ -1,67 +1,77 @@
-module Airake #:nodoc
+module Airake
 
   #
   # Project for AIR application
   #
   class Project
   
-    attr_reader :base_dir, :bin_dir, :src_dir, :lib_dir, :test_dir
+    attr_reader :base_dir, :src_dirs, :lib_dir
     attr_reader :mxml_path, :appxml_path, :air_path, :swf_path
     attr_reader :debug, :assets, :certificate
-    attr_reader :build_env
     
-    # Options to override defaults
-    Options = [ :bin_dir, :src_dir, :lib_dir, :test_dir, 
-      :appxml_path, :air_path, :swf_path, :debug, :certificate, :assets,
-      :amxmlc_path, :adl_path, :adt_path, :asdoc_path, :amxmlc_extra_opts, :adl_extra_opts, :adt_extra_opts, :asdoc_extra_opts ]
-
     # Build project:
     #
-    #   base_dir: Base (project) directory
-    #   mxml_path: Path to the ProjectName.mxml (relative)
-    #   options: 
-    #     bin_dir: Path to generated output, defaults to 'bin'
-    #     src_dir: Path to source, defaults to 'src'
-    #     lib_dir: Path to lib directory, defaults to 'lib'
-    #     test_dir: Path to test directory, defaults to 'test'
-    #     appxml_path: Path to application descriptor, defaults to '<mxml_dir>/<ProjectName>-app.xml'. Default assumes the app xml is in same directory as the root mxml.
-    #     air_path: Path to AIR file, defaults to '<bin_dir>/<ProjectName>.air'
-    #     swf_path: Path to SWF file, defaults to '<bin_dir>/<ProjectName.swf'
+    #   env: development, test
+    #   base_dir: Base (project) directory, if nil, AirakeRoot is used
+    #   options: If nil, loaded from airake.yml in root. (All paths relative to base directory)
+    #     mxml_path: Path to the ProjectName.mxml
+    #     appxml_path: Path to application descriptor
+    #     src_dirs: Paths to source
+    #     lib_dir: Path to lib directory
+    #     air_path: Path to AIR file
+    #     swf_path: Path to SWF file
     #     debug: "true" or "false"
     #     assets: Path to assets
     #     certificate: Path to certificate
-    #     
+    # 
     # Other options:
-    #   :mxmlc_path, :adt_path, :adl_path, :asdoc_path, :mxmlc_extra_opts, :adt_extra_opts, :adl_extra_opts, :asdoc_extra_opts
+    #   mxmlc_path, adt_path, adl_path, asdoc_path, mxmlc_extra_opts, adt_extra_opts, adl_extra_opts, asdoc_extra_opts
     #     
-    def initialize(base_dir, mxml_path, options = {}, build_env = :normal)
-      raise ArgumentError, "Invalid MXML path: #{mxml_path}" if mxml_path.blank?
+    def initialize(env = nil, base_dir = nil, options = nil)            
+      
+      env = ENV["AIRAKE_ENV"] if env.nil?      
+      base_dir = ENV["AIRAKE_ROOT"] if base_dir.nil?
+      raise "Need to specify an AIRAKE_ROOT (project root)" if base_dir.blank?
       
-      mxml_dir = File.expand_path(File.dirname(mxml_path))
-      project_name = File.basename(mxml_path, ".mxml")
+      if options.nil?
+        conf_path = File.join(base_dir, "airake.yml")
+        unless File.exist?(conf_path)
+          raise <<-EOS 
+        
+            You are missing your #{conf_path} configuration file.
+          
+            For existing projects, please regenerate an airake project and look at Rakefile and airake.yml for an example.
+          
+          EOS
+        end
+        
+        options = YAML.load_file(File.join(base_dir, "airake.yml"))
+        env_options = options[env]
+        options = options.merge(env_options) if env_options
+        options.symbolize_keys!
+      end
       
       @base_dir = base_dir
-      @mxml_path = File.join(mxml_dir, "#{project_name}.mxml")
-      @build_env = build_env
       
-      @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")                  
+      @mxml_path = File.join(base_dir, options[:mxml_path])      
+      @appxml_path = File.join(base_dir, options[:appxml_path])
       
-      @appxml_path = options[:appxml_path] || File.join(mxml_dir, "#{project_name}-app.xml")
+      @src_dirs = options[:src_dirs].collect { |src_dir| File.join(base_dir, src_dir) }      
+      @lib_dir = File.join(base_dir, options[:lib_dir]) if options[:lib_dir]
       
       # Dest package files
-      @air_path = options[:air_path] || File.join(@bin_dir, "#{project_name}.air")
-      @swf_path = options[:swf_path] || File.join(@bin_dir, "#{project_name}.swf")
+      @air_path = File.join(base_dir, options[:air_path])      
+      @swf_path = File.join(base_dir, options[:swf_path])      
     
       # Debug options
-      @debug = options[:debug].is_a?(TrueClass) || options[:debug] == "true"                  
+      @debug = options[:debug]
       
       with_keyed_options([ :assets, :certificate, :mxmlc_path, :adt_path, :adl_path, :asdoc_path, 
         :mxmlc_extra_opts, :adt_extra_opts, :adl_extra_opts, :asdoc_extra_opts ], options)
+        
+      ensure_exists([ @mxml_path, @appxml_path, *@src_dirs ])
     end
-    
+        
     # Flex compiler command (under AIR) for this project
     def amxmlc
       mxmlc({ :config_name => "air" })
@@ -69,16 +79,10 @@ module Airake #:nodoc
     
     # Flex compiler command for this project
     def mxmlc(options = {})
-      src_dirs = case build_env
-        when :normal then [ @src_dir ]
-        when :test then [ @src_dir, @test_dir ]
-        else raise "Invalid build_env setting: #{build_env}"
-        end
-
       options = options.merge({ :swf_path => @swf_path, :mxml_path => @mxml_path, :lib_dir => @lib_dir, 
-        :src_dirs => src_dirs, :debug => @debug, :mxmlc_extra_opts => @mxmlc_extra_opts, 
+        :src_dirs => @src_dirs, :debug => @debug, :mxmlc_extra_opts => @mxmlc_extra_opts, 
         :mxmlc_path => @mxmlc_path })
-        
+                
       Airake::Commands::Mxmlc.new(options)
     end
     
@@ -100,50 +104,21 @@ module Airake #:nodoc
     # AS docs
     def asdoc
       src_dirs = [ @src_dir ]
-      options = { :lib_dir => @lib_dir, :src_dirs => src_dirs, :asdoc_extra_opts => @asdoc_extra_opts,
+      options = { :lib_dir => @lib_dir, :src_dirs => @src_dirs, :asdoc_extra_opts => @asdoc_extra_opts,
         :asdoc_path => @asdoc_path }        
       Airake::Commands::Asdoc.new(options)
     end
     
-    # List of files to remove on clean
-    def to_clean
-      case build_env
-      when :normal then [ swf_path, air_path ]
-      when :test then [ swf_path ]
+    # Remove files
+    def clean
+      paths = [ swf_path, air_path ]
+      paths.each do |path|
+        FileUtils.rm(path, :verbose => true) if File.exist?(path)
       end
     end
+
+  protected
         
-    #
-    # Create project using parameters from rake ENV:
-    #
-    #   BASE_DIR: Path to project base
-    #   MXML: Path to mxml file
-    #   MXML_TEST: In test environment, path to test mxml file
-    # 
-    # You can override any of the project options via ENV; just upcase it. <tt>:foo_bar => ENV["FOO_BAR"]</tt>
-    #
-    # This shouldn't really be here, but a Rakefile is a bad place to be :O
-    #
-    # Booleans must be "true" for true
-    #
-    def self.new_from_rake(env, build_env = :normal)
-      base_dir = env["BASE_DIR"]
-      mxml = case build_env
-        when :test then env["MXML_TEST"]
-        when :normal then env["MXML"]
-        else raise "Invalid build env: #{build_env}"
-        end
-      
-      # 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, build_env)
-    end
-    
     # Load options into instance vars
     def with_keyed_options(keys, options) 
       keys.each do |key|        
@@ -152,6 +127,12 @@ module Airake #:nodoc
       end
     end
     
+    def ensure_exists(paths)
+      paths.each do |path|
+        raise "Path not found: #{path}" unless File.exist?(path)
+      end
+    end
+    
   end
   
 end

data/lib/airake/tasks/air.rake

@@ -3,7 +3,7 @@ namespace :air do
   desc "Compile"
   task :compile => :clean do
     begin
-      project = Airake::Project.new_from_rake(ENV)
+      project = Airake::Project.new
       fcsh = PatternPark::FCSH.new_from_rake(ENV)
       fcsh.execute([ project.base_dir, project.amxmlc.compile ])      
     rescue PatternPark::FCSHConnectError => e
@@ -13,17 +13,25 @@ namespace :air do
   end
 
   desc "Test"
-  task :test => :clean do
-    ENV["DEBUG"] = "true" unless ENV.has_key?("DEBUG")
-    test_project = Airake::Project.new_from_rake(ENV, :test)
+  task :test do
+    ENV["AIRAKE_ENV"] = "test"
+    Rake::Task["air:clean"].invoke
+    
+    test_project = Airake::Project.new
     Airake::Runner.run(test_project.amxmlc, :compile)
     Airake::Runner.run(test_project.adl, :launch)
   end
   
   desc "Generate certificate"
   task :certificate do 
+    
     pfx_file = ENV["CERTIFICATE"]
     
+    unless pfx_file
+      project = Airake::Project.new    
+      pfx_file = project.certificate
+    end
+    
     if pfx_file.blank? || pfx_file == "path/to/certificate.pfx"
       print "Certificate file (to create; e.g. cert.pfx): "
       pfx_file = STDIN.gets.chomp!      
@@ -39,7 +47,7 @@ namespace :air do
     
     puts "Will generate a certificate file at: #{pfx_file}"
     
-    project = Airake::Project.new_from_rake(ENV)
+    project = Airake::Project.new
     optionals = {}
 
     print "Specify common name (e.g. SelfSign, ADigitalID) [SelfSign]: "
@@ -70,9 +78,14 @@ namespace :air do
   task :check_certificate do 
     pfx_file = ENV["CERTIFICATE"]
     
+    unless pfx_file
+      project = Airake::Project.new    
+      pfx_file = project.certificate
+    end
+    
     if pfx_file.blank? || pfx_file == "path/to/certificate.pfx"
       raise <<-EOS
-          No certificate path found (or not set). Please specify ENV[\"CERTIFICATE\"] = \"path/to/certificate.pfx\" in Rakefile. 
+          No certificate path found (or not set). Please specify ENV[\"CERTIFICATE\"] = \"path/to/certificate.pfx\" in Rakefile. Or certificate: path/to/cert.pfx in airake.yml.
           If you don't have a certificate run rake air:certificate to generate one.
       EOS
     end
@@ -85,7 +98,7 @@ namespace :air do
     
   desc "Package only"
   task :package_only do
-    project = Airake::Project.new_from_rake(ENV)
+    project = Airake::Project.new
     Airake::Runner.run(project.adt, :package)
   end
   
@@ -98,7 +111,7 @@ namespace :air do
   
   desc "Launch ADL only"
   task :adl_only do 
-    project = Airake::Project.new_from_rake(ENV)
+    project = Airake::Project.new
     Airake::Runner.run(project.adl, :launch)
   end
   
@@ -140,22 +153,14 @@ namespace :air do
   
   desc "Docs"
   task :docs do
-    project = Airake::Project.new_from_rake(ENV)
+    project = Airake::Project.new
     Airake::Runner.run(project.asdoc, :generate)
   end
   
   desc "Clean"
   task :clean do 
-    project = Airake::Project.new_from_rake(ENV)
-    paths = project.to_clean
-    
-    # Test 
-    test_project = Airake::Project.new_from_rake(ENV, :test)
-    paths += project.to_clean
-    
-    paths.each do |path|
-      FileUtils.rm(path, :verbose => true) if File.exist?(path)
-    end
+    project = Airake::Project.new
+    project.clean
   end
   
 end

data/lib/airake/version.rb

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

data/lib/airake.rb

@@ -1,3 +1,7 @@
+require 'rubygems'
+require 'yaml'
+require 'active_support'
+
 $:.unshift File.dirname(__FILE__)
 
 module Airake; end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: airake
 version: !ruby/object:Gem::Version 
-  version: 0.3.2
+  version: 0.4.0
 platform: ""
 authors: 
 - Gabriel Handford, Min Kim
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-01-20 00:00:00 -05:00
+date: 2008-01-24 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency