mako 0.0.0 → 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+--- 
+SHA1: 
+  data.tar.gz: ab05c1d4ad519e4c9b4e4d02f77c9a4ee61a23db
+  metadata.gz: 9899032ff96705b5014cdf0052c9281eeee00c88
+SHA512: 
+  data.tar.gz: 6475de9afc105faf1630cbb98a2228531a2f5403019ca071ab8b0ddd51f6b01ab85b069ccee52d01ff96cf11349fbfef8ec0578cba3c95a39face77a2246f970
+  metadata.gz: 4eddd22db26c15a87590a7780f8aac1a41d1c4530f2faee70bba9c33c0d37e92f76336019bf80613bdc2e93c8febb861b8a81c0209007339758c4018372b8e3f

data/bin/mako

@@ -3,131 +3,99 @@
 require 'trollop'
 require 'mako/scaffold'
 require 'mako/build'
-
-
-# Add some config functionality onto the hashes
-class Hash
-	def compiles_widget?
-		!self[:type].nil? && ['compile_swf', 'compile_html'].include?(self[:type])
-	end
-
-	def contains_configs?
-		!self[:type].nil? && self[:type] == 'config'
+require 'yaml'
+
+class Mako
+
+	def initialize
+		@default = {}
+		@default[:sdk]           = nil
+		@default[:dev_kit]       = File.expand_path(File.dirname(__FILE__)+"/../")+"/lib/mako/data/"
+		@default[:app_class]     = 'src/Engine.as'
+		@default[:configs]       = ['build.yaml']
+		@default[:target]        = 'compiled_widget.swf'
+		@default[:output_path]   = Dir.pwd+'/_output'
+		@default[:stop_on_fail]  = true
+		@default[:type]          = "html"
+		@default[:skip_optimize] = false
 	end
 
-	def is_package?
-		!self[:type].nil? && self[:type] == 'package'
-	end
-
-	def is_copy_type?
-		!self[:type].nil? && self[:type] == 'copy'
-	end
-end
+	def self.finalize_settings (args, global_args)
+		args.merge! global_args
 
-class String
-	def pretty
-		self.downcase.gsub(/\W/,'-').squeeze('-').chomp('-')
+		# user's environment settings
+		settings = {}
+		settings[:sdk] = ENV["MAKO_FLEX_SDK"] unless ENV["MAKO_FLEX_SDK"].nil?
+		settings[:dev_kit] = File.expand_path(File.dirname(__FILE__)+"/../")+"/lib/mako/data/"
+		settings
 	end
-end
-
-# inti defaults
-default = {}
-default[:sdk]          = nil
-default[:dev_kit]      = nil
-default[:app_class]    = 'src/Engine.as'
-default[:configs]      = ['build.yaml']
-default[:target]       = 'compiled_widget.swf'
-default[:output_path]  = Dir.pwd+'/_output'
-default[:stop_on_fail] = true
-
-SUB_COMMANDS = %w(scaffold build)
-global_args = Trollop::options do
-	banner <<-EOS
-Mako is a compiler for Materia that can create a development widget skeleton for building new widgets, or can take a developed widget and compile it into an installable .wigt file for Materia.
-
-Usage:
-	mako scaffold <widget> [options]+	Creates a scaffold of a development widget.
-	mako build    <widget> [options]+	Builds a widget for instillation into Materia.
-
-
-Options:
-EOS
-
-	opt :output_path, "Path to place all compiled", :type => :string
-	opt :watch, "Watch for changes and rebuild updated files", :type => :boolean, :default => false
-	opt :sdk, "Path to the Flex SDK", :type => :string
-	opt :configs, "Path to the build yaml to load", :type => :strings
-	opt :target, "Output swf file name", :type => :string
-	opt :skip_optimize, "Skip optimization"
-	opt :stop_on_fail, "Stop execution if compile fails", :type => :boolean
-	opt :skip_package, "Don't build packages?", :type => :boolean, :default => false
-	stop_on SUB_COMMANDS
-end
-
-cmd = ARGV.shift # get the subcommand
-
-args = case cmd
-	when "scaffold"
-    	Trollop::options do
-			banner <<-EOS
-Creates a scaffold of a development widget. This can either be an html or flash widget
-
-Usage:
-	mako scaffold <widget> [options]	Creates a scaffold of a development widget.
 
+	def process_cmd
+		help = YAML.load_file(File.expand_path('../../lib/mako/data/strings.yaml', __FILE__))
 
-Options:
-EOS
-
-			opt :type, "The type of scaffold that is to be built. Defaults to html", :type => :string, :default => 'html'
-			opt :dev_kit, "Path to dev kit", :type => :string
+		global_args = Trollop::options do
+			banner help['mako']
+			stop_on %w(scaffold build develop test) # Subcommands
 		end
-	# Options and banner for building a widget
-	when "build"
-		Trollop::options do
-			banner <<-EOS
-Compiles a widget into a .wigt file in the output directory.
-
-Usage:
-	mako scaffold <widget> [options]	Creates a scaffold of a development widget.
 
-
-Options:
-EOS
+		cmd = ARGV.shift # get the subcommand
+
+		case cmd
+			when "scaffold"
+				args = Trollop::options do
+					banner help['scaffold']
+					opt :type, "The type of scaffold that is to be built. Defaults to html", :type => :string, :default => 'html'
+					opt :dev_kit, "Path to dev kit",                                         :type => :string
+				end
+
+				Trollop::die "Missing widget name: mako scaffold \"Widget Name\"".red if ARGV[0].nil?
+				settings = Mako.finalize_settings args, global_args
+				@default[:output_path] = Dir.pwd
+				scaffold = Scaffold.new settings, @default, args
+				scaffold.create ARGV[0]
+
+			when "build" # BUILD A WIDGET PACKAGE
+				args = Trollop::options do
+					banner help['build']
+					opt :output_path, "Path to place output",                  :short => '-o', :type => :string
+					opt :sdk, "Path to the Flex SDK",                          :short => '-k', :type => :string
+					opt :skip_optimize, "Skip optimization",                   :short => '-s'
+					opt :skip_package, "Don't build packages?",                :short => '-p', :type => :boolean, :default => false
+				end
+
+				settings = Mako.finalize_settings args, global_args
+				build = Build.new settings, @default, args
+				configs = build.prioritize :configs, args, @default
+				build.compile configs
+
+			when "develop" # BUILD FOR MATERIA PLATFORM DEVELOPMENT
+				args = Trollop::options do
+					banner help['develop']
+					opt :sdk, "Path to the Flex SDK",                          :short => '-k', :type => :string
+				end
+				Trollop::die "Missing Materia Platform sanbox dir: mako develop /dir/to/static/develop".red if ARGV[0].nil?
+				args[:output_path] = ARGV[0]
+				args[:skip_package] = true
+				args[:skip_optimize] = true
+
+				settings = Mako.finalize_settings args, global_args
+				build = Build.new settings, @defaults, args
+				configs = build.prioritize :configs, args, @default
+				build.compile configs
+
+			when "test" # Test
+				args = Trollop::options do
+					banner help['test']
+				end
+				require File.expand_path(File.dirname(__FILE__)+"/../")+"/lib/mako/test/test_scaffold.rb"
+
+			when !cmd.nil? # Unkown
+				Trollop::die "unknown subcommand #{cmd.inspect}".red
+			else # If there is no sub command at all
+				puts 'Mako Version: 1.0.0'.green
+				puts help['mako']
 		end
-	# If the sub command isn't recognized
-	when !cmd.nil?
-		Trollop::die "unknown subcommand #{cmd.inspect}".red
-	# If there is no sub command at all
-	else
-		Trollop::die "mako needs at least one sub command".red
+	end
 end
 
-args.merge! global_args
-
-# user's environment settings
-settings = {}
-settings[:sdk] = ENV["MAKO_FLEX_SDK"] unless ENV["MAKO_FLEX_SDK"].nil?
-settings[:dev_kit] = File.expand_path(File.dirname(__FILE__)+"/../")+"/lib/mako/data/"
-
-
-case cmd
-	when "scaffold"
-	# Scaffold
-		if ARGV[0].nil?
-			Trollop::die "Widget name must be defined: mako scaffold \"Widget Name\"".red
-		end
-
-		default[:output_path] = Dir.pwd
-
-		scaffold = Scaffold.new(settings, default, args)
-
-		scaffold.create ARGV[0]
-	
-	when "build"
-
-		build = Build.new(settings, default, args)
-		configs = build.prioritize(:configs, args, default)
-
-		build.compile configs
-end
+Mako.new.process_cmd()

data/lib/mako/build.rb

@@ -4,6 +4,30 @@ require 'colorize'
 require 'fileutils'
 require 'zip/zip'
 
+class String
+	def pretty
+		self.downcase.gsub(/\W/,'-').squeeze('-').chomp('-')
+	end
+end
+
+# Add some config functionality onto the hashes
+class Hash
+	def compiles_widget?
+		!self[:type].nil? && ['compile_swf', 'compile_html'].include?(self[:type])
+	end
+
+	def contains_configs?
+		!self[:type].nil? && self[:type] == 'config'
+	end
+
+	def is_package?
+		!self[:type].nil? && self[:type] == 'package'
+	end
+
+	def is_copy_type?
+		!self[:type].nil? && self[:type] == 'copy'
+	end
+end
 
 class Build < Path
 	
@@ -14,33 +38,43 @@ class Build < Path
 	end
 
 	#process_configs output, prioritize(:configs, args, default), default, settings, args
-	def compile configs, current_path=Dir.pwd
-		output = prepare_output_path @args, @default
+	def compile configs, current_path=Dir.pwd, output = nil
+		output = output.nil? ? prepare_output_path(@args, @default) : output
 		configs.each do |config|
-
-			dir = File.dirname absolute_path(config, current_path)
+			source = File.dirname absolute_path(config, current_path)
 			cfg = load_symbolized_yaml absolute_path(config, current_path)
 
+			if cfg == false
+				abort
+			end
 
+			# build.yaml describes a single creator or engine that needs to be compiled?
 			if cfg.compiles_widget?
 				if cfg[:type] == 'compile_swf'
-					compile_swc output, dir, cfg
+					compile_swc output, source, cfg
 				end
 				if cfg[:type] == 'compile_html'
-					compile_html output, dir, cfg
+					compile_html output, source, cfg
 				end
+
+			# build.yaml describes a single creator or engine that doesnt need compiling
 			elsif cfg.is_copy_type?
-				compile_copy output, dir, cfg
+				copy_to_output output, source, cfg
+
+			# build.yaml describes a list of configs to run compile on
 			elsif cfg.contains_configs?
 				# for configs that only contain other configs but arent packages
-				compile(output, cfg[:configs], dir)
+				compile output, cfg[:configs], source
+
+			# build.yaml describes a widget package (creator and engine)
 			elsif cfg.is_package?
-				# for package configs
-				if @args[:skip_package] != true
-					package(dir, output, cfg)
+				if @args[:skip_package]
+					compile_package source, output, cfg
 				else
-					compile [cfg[:engine], cfg[:creator]], dir
-					optimize_staged_files(output) unless args[:skip_optimize]
+					staging_area = Dir.mktmpdir '-mako'
+					compile_package source, staging_area, cfg
+					zip_package staging_area, output, cfg
+					FileUtils.rm_r tmp_dir, :force => true
 				end
 			else
 				puts "#{config} unknown config type".red
@@ -60,6 +94,7 @@ class Build < Path
 		if contents
 			return string_keys_to_symbols contents
 		end
+		puts "Yaml file not valid #{yaml}".red
 		false
 	end
 	
@@ -123,7 +158,7 @@ class Build < Path
 	# copy and compile any html, js, coffeescript, saas, css, or images given the settings
 	def compile_html output_dir, base_dir, config
 
-		compile_copy output_dir, base_dir, config
+		copy_to_output output_dir, base_dir, config
 
 		coffee = Dir[output_dir+'/**/*.coffee']
 		if coffee.any?
@@ -155,7 +190,7 @@ class Build < Path
 		remove_html_dev_helpers output_dir
 	end
 
-	def compile_copy output, base_dir, config
+	def copy_to_output output, base_dir, config
 
 		base_dir << '/' unless base_dir.end_with? '/'
 		output_dir = output.dup
@@ -254,64 +289,61 @@ class Build < Path
 		end
 	end
 
+	def build_staging_area source, output_dir
+		FileUtils.rm_r output_dir, :force=>true
 
-	def package source, output_dir, cfg
-
-		# setup all the directories
-		output_dir = output_dir.dup # output_dir is frozen typically and I don't know ruby enough to understand why
-		output_dir << '/' unless output_dir.end_with? '/'
-		source << '/' unless source.end_with? '/'
-		name = load_yaml(source+'install.yaml')['general']['name'].pretty
-		stage = Dir::pwd+'/wigt'
-		FileUtils.rm_r stage, :force=>true
-
-		Dir::mkdir stage
-		Dir::mkdir stage+'/swf'
-		Dir::mkdir stage+'/img'
-		Dir::mkdir stage+'/img/screen-shots'
-		Dir::mkdir stage+'/_score-modules'
-		Dir::mkdir stage+'/_assets'
+		Dir::mkdir output_dir
+		Dir::mkdir output_dir+'/swf'
+		Dir::mkdir output_dir+'/img'
+		Dir::mkdir output_dir+'/img/screen-shots'
+		Dir::mkdir output_dir+'/_score-modules'
+		Dir::mkdir output_dir+'/_assets'
 
 		# copy everything to where it needs to be
-		FileUtils.cp_r Dir[source+'swf/*'], stage+'/swf'
-		FileUtils.cp_r Dir[source+'img/*'], stage+'/img'
-		FileUtils.cp_r Dir[source+'_icons/*'], stage+'/img'
-		FileUtils.cp_r Dir[source+'_screen-shots/*'], stage+'/img/screen-shots'
-		FileUtils.cp_r Dir[source+'_assets/*'], stage+'/_assets'
-		FileUtils.cp   source+'install.yaml', stage+'/install.yaml'
-		FileUtils.cp   source+'demo.yaml', stage+'/demo.yaml'
+		FileUtils.cp_r Dir[source+'swf/*'], output_dir+'/swf'
+		FileUtils.cp_r Dir[source+'img/*'], output_dir+'/img'
+		FileUtils.cp_r Dir[source+'_icons/*'], output_dir+'/img'
+		FileUtils.cp_r Dir[source+'_screen-shots/*'], output_dir+'/img/screen-shots'
+		FileUtils.cp_r Dir[source+'_assets/*'], output_dir+'/_assets'
+		FileUtils.cp   source+'install.yaml', output_dir+'/install.yaml'
+		FileUtils.cp   source+'demo.yaml', output_dir+'/demo.yaml'
 
 		if File::exists? source+'_score/score_module.php'
-			FileUtils.cp source+'_score/score_module.php', stage+'/_score-modules/score_module.php'
-			FileUtils.cp source+'_score/test_score_module.php', stage+'/_score-modules/test_score_module.php'
+			FileUtils.cp source+'_score/score_module.php', output_dir+'/_score-modules/score_module.php'
+			FileUtils.cp source+'_score/test_score_module.php', output_dir+'/_score-modules/test_score_module.php'
 		end
 
-		# run makobuild on each part of this package
-		# this will typically be once per engine/creator of this package
-		if File::exists? source+'build.yaml'
-			command = "mako --configs #{source}build.yaml --output-path #{stage}/ --skip-package"
-			command << " --skip-optimize" if @args[:skip_optimize]
-			command << " build"
-			unless system command
-				FileUtils.rm_r stage, :force=>true
-				abort "Package Failure".red
-			end
-		end
+		output_dir
+	end
+
+	def compile_package source, output_dir, cfg
+		source << '/' unless source.end_with? '/'
+
+		stage = build_staging_area source, output_dir
 
-		optimize_staged_files(stage) unless @args[:skip_optimize]
+		compile [cfg[:engine], cfg[:creator]], Dir.pwd, stage
+		optimize_staged_files(output_dir) unless @args[:skip_optimize]
+	end
+
+
+	def zip_package source, output_dir, cfg
+		# setup all the directories
+		output_dir = output_dir.dup # output_dir is frozen typically and I don't know ruby enough to understand why
+		output_dir << '/' unless output_dir.end_with? '/'
+		source << '/' unless source.end_with? '/'
+		name = load_yaml(source+'install.yaml')['general']['name'].pretty
 
 		# zip it
 		zip_file = "#{output_dir}#{name}.wigt"
 		FileUtils.rm zip_file, :force=>true
 		Zip::ZipFile.open(zip_file, Zip::ZipFile::CREATE) do |zip|
-			Dir[stage+'/**/**'].each do |file|
-				zip.add file.sub(stage+'/', ''), file
+			Dir[source+'**/**'].each do |file|
+				zip.add file.sub(source, ''), file
 			end
 		end
 
 		# done, cleanup
 		puts "[Package Finished] #{name} #{zip_file}".green
-		FileUtils.rm_r stage, :force=>true
 	end
 	
 	def optimize_staged_files path