gjastrab-puremvc-gen 0.1.1

data/conf/config/pmvcgen.log.properties

@@ -0,0 +1,25 @@
+##### =============== ERROR MESSAGES =============== #####
+log.invalid.properties	= All required properties have not been set.  Please verify you are including the necessary .properties files.
+log.no.core.namespace	= core.namespace is not set!  The PureMVC-Gen convention is to specify this in a proj.properties file.
+log.no.pmvcgen.home		= The PMVC_GEN_HOME environment variable is not set!  Be sure to set it and point it to the location of your PureMVCGen directory.
+
+##### =============== GENERATION MESSAGES =============== #####
+log.gen.facade				= Creating PureMVC Facade class: ${core.namespace}.${app.prefix}Facade
+log.gen.macro.command		= Creating PureMVC MacroCommand class => ${cmd.name}
+log.gen.simple.command		= Creating PureMVC SimpleCommand class => ${cmd.name}
+log.gen.startup.command		= Creating PureMVC StartupCommand
+log.gen.prepare.command		= Creating PureMVC PrepareActorsCommand
+log.gen.mediator.command	= Creating PureMVC Mediator class => ${mediator.name}
+log.gen.proxy.command		= Creating PureMVC Proxy class => ${proxy.name}
+
+##### =============== PROMPT MESSAGES =============== #####
+log.prompt.command.name		= Enter the name of the command you'd like to create.  (i.e., <YourCommandName> generates ==> <YourCommandName>Command.as)
+log.prompt.command.constant	= Enter the name of the constant to be associated with the command.
+log.prompt.mediator.name	= Enter the name of the mediator you'd like to create.  (i.e., <YourMediatorName> generates ==> <YourMediatorName>Mediator.as)
+log.prompt.proxy.name		= Enter the name of the proxy you'd like to create.  (i.e., <YourProxyName> generates ==> <YourProxyName>Proxy.as)
+
+##### =============== PROMPT MESSAGES =============== #####
+log.fail.command.name		= You must enter a name for the command!
+log.fail.command.constant	= You must enter a constant for the comman!
+log.fail.mediator.name		= You must enter a name for the mediator!
+log.fail.proxy.name			= You must enter a name for the proxy!

data/conf/config/pmvcgen.properties

@@ -0,0 +1,7 @@
+##### =============== PureMVC GEN PROPERTIES =============== #####
+model.dir		= model
+view.dir		= view
+controller.dir	= controller
+events.dir		= events
+
+templates.dir	= templates

data/conf/example/author.properties

@@ -0,0 +1,2 @@
+author.name		= Greg Jastrab
+author.email	= greg@smartlogicsolutions.com

data/conf/example/proj.properties

@@ -0,0 +1,9 @@
+##### =============== PROJECT PROPERTIES =============== #####
+app.prefix		= PMVCGen
+project.name	= PMVCGenDemo
+core.namespace	= net.slsdev.utils.pmvc.demo
+core.dir		= net/slsdev/utils/pmvc/demo
+version			= 1.0
+
+##### =============== PureMVC PROPERTIES =============== #####
+pmvc.flavor		= standard

data/conf/templates/Event.tpl

@@ -0,0 +1,55 @@
+@copy@
+package @namespace@.@events@ {
+    
+    import flash.events.Event;
+    
+    /**
+     * Event description here.
+     *
+     * @langversion ActionScript 3.0
+     * @author @author.name@ @author.email@
+     * @date @today@
+     * @version @version@
+     */
+    public class @event.name@ extends Event {
+        
+        /* --- Variables --- */
+        
+        //pmvcgen:varconsts
+        
+        /* === Variables === */
+        
+        /* --- Constructor --- */
+        
+        public function @event.name@(type:String) {
+            super(type);
+        }
+        
+        /* === Constructor === */
+        
+        /* --- Functions --- */
+        
+        /**
+         * Clones the @event.name@.
+         *
+         * @return Duplicates an instance of an Event subclass
+         */
+        public function clone():Event {
+            var evt:@event.name@ = new @event.name@(type);
+            return evt;
+        }
+        
+        /**
+         * Formats the event to a string.
+         *
+         * @return Returns a string containing all the properties of the Event object
+         */
+        override public function toString():String {
+            return formatToString("@event.name@", "type");
+        }
+        
+        /* === Functions === */
+        
+    }
+    
+}

data/conf/templates/standard/Application.tpl

@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="utf-8"?>
+<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml"
+                creationComplete="facade.startup(this)">
+
+	<mx:Script>
+		<![CDATA[
+			import @namespace@.@app.prefix@Facade;
+
+			private var facade:@app.prefix@Facade = @app.prefix@Facade.getInstance();
+		]]>
+	</mx:Script>
+
+</mx:Application>

data/conf/templates/standard/Facade.tpl

@@ -0,0 +1,51 @@
+package @namespace@ {
+	
+	import @namespace@.@ctrls@.*;
+	
+	import org.puremvc.as3.patterns.facade.Facade;
+	
+	/**
+	 * Application Facade.
+	 *
+	 * @langversion ActionScript 3.0
+	 * @author @author.name@ @author.email@
+	 * @date @today@
+	 * @version @version@
+	 */
+	public class @app.prefix@Facade extends Facade {
+	   
+		/* --- Variables --- */
+		
+		public static const STARTUP:String = "startup";
+
+		//pmvcgen:varconsts
+		
+		/* === Variables === */
+		
+		/* --- Functions --- */
+		
+		public static function getInstance():@app.prefix@Facade {
+			if(instance == null)
+				instance = new @app.prefix@Facade();
+			return instance as @app.prefix@Facade;
+		}
+		
+		/**
+		 * Starts up @project.name@.
+		 *
+		 * @param app reference to the application
+		 */
+		public function startup(app:@project.name@):void {
+			sendNotification(STARTUP, app);
+		}
+		
+		override protected function initializeController():void {
+			super.initializeController();
+			//pmvcgen:register commands
+		}
+		
+		/* === Functions === */
+		
+	}
+	
+}

data/conf/templates/standard/MacroCommand.tpl

@@ -0,0 +1,24 @@
+package @namespace@.@ctrls@ {
+	
+	//pmvcgen:import commands
+	
+	import org.puremvc.as3.interfaces.INotification;
+	import org.puremvc.as3.patterns.command.MacroCommand;
+	
+	/**
+	 * @command.name@ command.
+	 *
+	 * @langversion ActionScript 3.0
+	 * @author @author.name@ @author.email@
+	 * @date @today@
+	 * @version @version@
+	 */
+	public class @command.name@Command extends MacroCommand {
+	   
+		override protected function initializeMacroCommand():void {
+			//pmvcgen:chain simple commands
+		}
+		
+	}
+	
+}

data/conf/templates/standard/Mediator.tpl

@@ -0,0 +1,57 @@
+package @namespace@.@view@ {
+	
+	import @namespace@.@facade@;
+	
+	import org.puremvc.as3.interfaces.INotification;
+	import org.puremvc.as3.patterns.mediator.Mediator;
+	
+	/**
+	 * @mediator.name@ mediator.
+	 *
+	 * @langversion ActionScript 3.0
+	 * @author @author.name@ @author.email@
+	 * @date @today@
+	 * @version @version@
+	 */
+	public class @mediator.name@Mediator extends Mediator {
+	   
+		/* --- Variables --- */
+		
+		public static const NAME:String = "@mediator.name@Mediator";
+		
+		/* === Variables === */
+		
+		/* --- Constructor --- */
+		
+		/**
+		 * Constructor.
+		 *
+		 * @param viewComponent view component for mediator
+		 */
+		public function @mediator.name@Mediator(viewComponent:Object) {
+			super(NAME, viewComponent);
+		}
+		
+		/* === Constructor === */
+		
+		/* --- Functions --- */
+		
+		override public function handleNotification(note:INotification):void {
+		}
+
+		override public function listNotificationInterests():Array {
+			return [
+			];
+		}
+		
+		/* === Functions === */
+		
+		/* --- Public Accessors --- */
+		
+		public function get YOURVIEWNAME():YOURVIEWOBJ { return viewComponent as YOURVIEWOBJ; }
+		
+		/* === Public Accessors === */
+		
+	}
+	
+}

data/conf/templates/standard/Proxy.tpl

@@ -0,0 +1,50 @@
+package @namespace@.@model@ {
+	
+	import @namespace@.@facade@;
+	
+	import org.puremvc.as3.patterns.proxy.Proxy;
+	
+	/**
+	 * @proxy.name@ proxy.
+	 *
+	 * @langversion ActionScript 3.0
+	 * @author @author.name@ @author.email@
+	 * @date @today@
+	 * @version @version@
+	 */
+	public class @proxy.name@Proxy extends Proxy {
+	   
+		/* --- Variables --- */
+		
+		public static const NAME:String = "@proxy.name@Proxy";
+		
+		/* === Variables === */
+		
+		/* --- Constructor --- */
+		
+		/**
+		 * Constructor.
+		 *
+		 * @param data data model for proxy
+		 */
+		public function @proxy.name@Proxy(data:Object=null) {
+			super(NAME, data);
+		}
+		
+		/* === Constructor === */
+		
+		/* --- Functions --- */
+		
+		//addfunctions
+		
+		/* === Functions === */
+		
+		/* --- Public Accessors --- */
+		
+		public function get dataObject():Object { return data; }
+		
+		/* === Public Accessors === */
+		
+	}
+	
+}

data/conf/templates/standard/SimpleCommand.tpl

@@ -0,0 +1,24 @@
+package @namespace@.@ctrls@ {
+
+	//pmvcgen:insert imports
+	
+	import org.puremvc.as3.interfaces.INotification;
+	import org.puremvc.as3.patterns.command.SimpleCommand;
+	
+	/**
+	 * @command.name@ command.
+	 *
+	 * @langversion ActionScript 3.0
+	 * @author @author.name@ @author.email@
+	 * @date @today@
+	 * @version @version@
+	 */
+	public class @command.name@Command extends SimpleCommand {
+	   
+		override public function execute(note:INotification):void {
+			//pmvcgen:insert command logic
+		}
+		
+	}
+	
+}

data/lib/pure_m_v_c_gen.rb

@@ -0,0 +1,25 @@
+require 'rubygems'
+require 'cmdparse'
+require 'pure_m_v_c_gen/version'
+
+PMVC_GEN_LIB = File.join(File.dirname(__FILE__), '..', 'lib', 'pure_m_v_c_gen')
+require File.join(PMVC_GEN_LIB, 'ant_checker')
+
+unless PureMVCGen::AntChecker.has_ant_installed?
+  err = <<-EOL
+    You must have ANT installed to run puremvc-gen.
+    Install it! ==> http://ant.apache.org
+    If you have it installed, ensure it is on your path.
+  EOL
+  puts err
+  exit 1
+end
+
+ANT_BIN = PureMVCGen::AntChecker.on_windows? ? PureMVCGen::AntChecker.get_windows_ant : "ant"
+
+CMD_PATH = File.join(PMVC_GEN_LIB, 'commands')
+
+require File.join(CMD_PATH, 'command_extensions')
+require File.join(CMD_PATH, 'check_command')
+require File.join(CMD_PATH, 'initialize_command')
+require File.join(CMD_PATH, 'new_command')

data/lib/pure_m_v_c_gen/ant_checker.rb

@@ -0,0 +1,53 @@
+module PureMVCGen
+  class AntChecker
+    
+    # Determines if ANT is installed on the system
+    def self.has_ant_installed?
+      AntChecker.find_in_path("ant")
+    end
+    
+    # Searches the path, looking for the given utility. If an executable
+    # file is found that matches the parameter, this returns true.
+    def self.find_in_path(utility)
+     path = self.get_path
+     suffixes = self.on_windows? ? self.windows_executable_extensions : [""]
+
+     path.each do |dir|
+       suffixes.each do |sfx|
+         file = File.join(dir, utility + sfx)
+         return true if File.executable?(file)
+       end
+     end
+
+     false
+    end
+    
+    def self.get_path
+      (ENV['PATH'] || "").split(File::PATH_SEPARATOR)
+    end
+    
+    # Locates the ant executable or BAT file and returns the full path to it
+    def self.get_windows_ant
+      ext = %w(.exe .bat)
+      path = self.get_path
+      
+      path.each do |dir|
+        ext.each do |sfx|
+          file = File.join(dir, "ant" + sfx)
+          return File.expand_path(file) if File.executable?(file)
+        end
+      end
+      
+      nil
+    end
+    
+    def self.on_windows?
+     RUBY_PLATFORM =~ /mswin|mingw/
+    end
+
+    def self.windows_executable_extensions
+     %w(.exe .bat .com .cmd)
+    end
+    
+    end
+end

data/lib/pure_m_v_c_gen/commands/check_command.rb

@@ -0,0 +1,16 @@
+module PureMVCGen
+  module Commands
+    class CheckCommand < CmdParse::Command
+  
+      def initialize
+        super('check', false)
+        self.short_desc = "Validates that all required property settings are current detected"
+      end
+  
+      def execute(args)
+        call_ant "validate-properties"
+      end
+      
+    end
+  end
+end

data/lib/pure_m_v_c_gen/commands/command_extensions.rb

@@ -0,0 +1,14 @@
+module CmdParse
+  class Command
+    # injects our common options
+    def default_options(&block)
+      CmdParse::OptionParserWrapper.new do |opt|
+        opt.on("-h", "--help") do
+          self.show_help
+          exit
+        end
+        yield(opt)
+      end
+    end
+  end
+end