flak 0.0.4 → 0.0.5

data/lib/flak/thor/target_file.rb

@@ -13,20 +13,33 @@
 
 module Flak
   module TargetFile
+    
 
+    # Generate a tool.yml target file according to options given by the user, usually through a wizard.
+    # @param name [String] name of the tool.    
+    # @param options [Hash] the options.
+    # @option options :maya_plugin_target [true, false] Whether this tool will be the target for a Maya plugin.
+    # @option options :maya_app_target [true, false] Whether this tool will be the target for a Maya standalone application.
+    # @option options :delight_target [true, false] Whether this tool will be the target for a 3delight DSO, or filter.
+    # @option options :standalone_target [true, false] Whether this tool will be the target for a standalone application.
+    # @option options :maya_scripts [true, false] Whether this tool will contain Maya MEL or Python scripts.
+    # @option options :nuke_scripts [true, false] Whether this tool will contain Nuke scripts or gizmos.
+    # @option options :shell_scripts [true, false] Whether this tool will contain shell scripts.
     def self.tool(name,options={})
       h = Hash.new
       maya_c_compile = true if options[:maya_plugin_target] || options[:maya_app_target] 
-      c_compile = true if (maya_c_compile  || options[:nuke_target] || options[:standalone_target] ) 
+      c_compile = true if (maya_c_compile || options[:standalone_target] ) 
       
-      h['name'] = name.camelize
       
-      h['maya_script_copy_files'] = ["maya/script/**/*.mel","maya/script/**/*.py","maya/script/**/*.pyc"]
-      h['maya_scripted_plugin_copy_files'] = ["maya/script/plugin/**/*.py","maya/script/plugin/**/*.pyc"]
-      h['maya_node_icon_files'] = ["maya/icons/node/*"]
-      h['maya_icon_files'] = ["maya/icons/*.jpg"]
-      h['maya_icon_copy_files'] = ["maya/icons/*.png","maya/icons/*.xbm","maya/icons/*.xpm"]
-      h['nuke_script_copy_files'] =  ["nuke/python/*.py", "nuke/gizmo/*.gizmo", "nuke/scenes/*.nk"] if options[:nuke]
+      h['name'] =  name.camelize
+      
+      h['maya_script_copy_files'] = ["maya/script/**/*.mel","maya/script/**/*.py","maya/script/**/*.pyc"] if options[:maya_scripts]
+      h['maya_scripted_plugin_copy_files'] = ["maya/script/plugin/**/*.py","maya/script/plugin/**/*.pyc"] if options[:maya_scripts]
+      h['maya_node_icon_files'] = ["maya/icons/node/*"] if options[:maya_scripts]
+      h['maya_icon_files'] = ["maya/icons/*.jpg"] if options[:maya_scripts]
+      h['maya_icon_copy_files'] = ["maya/icons/*.png","maya/icons/*.xbm","maya/icons/*.xpm"]  if options[:maya_scripts]
+      
+      h['nuke_script_copy_files'] =  ["nuke/python/*.py", "nuke/gizmo/*.gizmo", "nuke/scenes/*.nk"] if options[:nuke_scripts]
 
 
       h['include_paths'] = ["../../shared/src"] if c_compile 
@@ -34,27 +47,33 @@ module Flak
       h['libs'] = ["OpenMayaAnim","OpenMayaUI","OpenMayaRender","OpenMayaFX"]  if maya_c_compile
       h['templates'] = []
       h['templates'] << "cpp" if c_compile
-      h['templates'] << "maya" 
+      h['templates'] << "maya" if options[:maya_scripts]
       h['templates'] << "maya_plugin" if options[:maya_plugin_target]
       h['templates'] << "maya_app" if  options[:maya_app_target] 
       h['templates'] << "gl" if maya_c_compile
       h['templates'] << "delight" if options[:delight_target]
+      h['templates'] << "nuke" if options[:nuke_scripts]
+      
       h['source_files'] = []
       h['source_files'] << "src/*.cpp" if c_compile
-      h['shell_script_copy_files'] = ["shell/script/*"] 
-       YAML::dump(h)
+      h['shell_script_copy_files'] = ["shell/script/*"]  if options[:shell_scripts]
+      YAML::dump(h)
     end
 
+    # Generate a project.yml target file according to options given by the user, usually through a wizard.
+    # @param name [String] name of the project.    
+    # @param options [Hash] the options.
+    # @option options :maya_module [true, false] Whether this project will build a Maya module. 
     def self.project(name,options={})
       h = Hash.new
-      h['name'] = "FlakProject#{name.camelize}"
+      h['name'] = "#{name.camelize}Project"
       if options[:maya_module]
-        h['maya_script_copy_files'] = ["config/script/maya/*.mel","config/script/maya/*.py","config/script/maya/*.pyc"]
-        h['maya_script_erb_files'] = ["config/script/maya/erb/*.mel.erb","config/script/maya/erb/*.py.erb"]
-        h['templates'] = ["maya", "doc","mod"]
+        h['maya_script_copy_files'] = ["script/maya/*.mel","script/maya/*.py","script/maya/*.pyc"]
+        h['maya_script_erb_files'] = ["script/maya/erb/*.mel.erb","script/maya/erb/*.py.erb"]
+        h['templates'] = ["release","maya", "doc"]
       end
-      h['shell_script_copy_files'] = ["config/script/shell/*.sh"] 
-      h['shell_script_erb_files'] = ["config/script/shell/erb/*.erb"] 
+      h['release_script_copy_files'] = ["script/shell/*.sh"] 
+      h['release_script_erb_files'] = ["script/shell/erb/*.erb"] 
       YAML::dump(h)
     end
 

data/lib/flak/thor/templates/INSTALL.tt

@@ -7,7 +7,7 @@
 # Write lines at the bottom of bashrc to source the <%%=  @settings[:product_name] %>.sh file
 # Write the Maya modules file if this is a module, and put it in the maya app dir modules directory
 
-set maya_ver =  "<%%= self.settings[:maya_version] %>"
+set maya_ver =  "<%%=  @settings[:maya_version] %>"
 
 set product_up = "<%%= @settings[:product_name].upcase %>"
 set product_version =  "<%%= self.settings[:product_revision] %>"
@@ -100,8 +100,8 @@ if (-f ${HOME}/.bashrc) then
 	echo "appending <%%= @settings[:product_name] %> source commands to  ${HOME}/.bashrc"
 	
 	echo "# The following lines have been added by <%%= @settings[:product_name] %>"  >> ${HOME}/.bashrc
-	echo 'export <%%= @settings[:product_name].upcase %>="'${the_product_dir}'" # added by '<%%= @settings[:product_name] %> >> ${HOME}/.bashrc
-	echo '[[ -e "${<%%= @settings[:product_name].upcase %>}/bin/<%%= @settings[:product_name] %>.sh" ]] && . "${<%%= @settings[:product_name].upcase %>}/bin/<%%= @settings[:product_name] %>.sh" # added by '<%%= @settings[:product_name] %>  >> ${HOME}/.bashrc
+	echo 'export <%%= @settings[:product_name].upcase %>="'${the_product_dir}'" # added by <%%= @settings[:product_name] %>' >> ${HOME}/.bashrc
+	echo '[[ -e "${<%%= @settings[:product_name].upcase %>}/bin/<%%= @settings[:product_name] %>.sh" ]] && . "${<%%= @settings[:product_name].upcase %>}/bin/<%%= @settings[:product_name] %>.sh" # added by <%%= @settings[:product_name] %>' >> ${HOME}/.bashrc
 
 	echo ""
 	echo "*********NOW RUN THESE COMMANDS OR OPEN A NEW SHELL***********" 

data/lib/flak/thor/templates/Rakefile.tt

@@ -1,10 +1,12 @@
 require 'flak'
 
+include Rake::DSL
+
 verbose(true)
 
 root = File.dirname(__FILE__)
 
-FileList.new('**/target.yml').each do |path|
-    Flak::Target.new(root, path)
+FileList.new('**/tool.yml','project.yml').each do |path|
+    Flak::Target.new(root, path).build
 end
 

data/lib/flak/thor/templates/{cpp.tt → config/cpp.yml.tt}

@@ -1,16 +1,14 @@
-target_release_prefix:      'bin'
-
 os_linux_64:
     compiler:               '/opt/gcc412/bin/gcc412'
     linker:                 '/opt/gcc412/bin/g++412'
     archiver:               '/usr/bin/ar rv'
+    target_extension: 		''
     dso_options:
     -                       '-shared'
     include_paths:
     -                       '/usr/X11R6/include'
     -                       '/usr/include'
-    libs:
-    -                       'Foundation'
+    libs: []
     lib_paths:
     -                       '/usr/lib64'
     -                       '/usr/X11R6/lib'
@@ -52,6 +50,7 @@ os_darwin:
     compiler:              '/usr/bin/gcc'
     linker:                 '/usr/bin/g++'
     archiver:              '/usr/bin/libtool  -static -arch_only i386'
+    target_extension: 		''
     dso_options:
     -                       '-bundle'
     include_paths:
@@ -63,8 +62,7 @@ os_darwin:
     -                       '-arch  x86_64'
     object_flag:            '-o '
     outputfile_flag:        '-o '
-    libs:
-    -                       'Foundation'
+    libs: []
     lib_flag:               '-l'
     libpath_flag:           '-L'
     include_flag:           '-I'
@@ -104,8 +102,7 @@ os_win_64:
     -                       'C:/Program Files (x86)/Microsoft SDKs/Windows/v7.0A/Lib/x64'
     dso_options:
     -                       '/DLL'
-    libs:
-    -                       'Foundation'
+    libs: []
     lib_ext:                '.lib'
     lib_flag:               ''
     libpath_flag:           '/LIBPATH:'
@@ -114,6 +111,7 @@ os_win_64:
     object_flag:            '/Fo'
     outputfile_flag:        '/OUT:'
     object_extension:       'obj'
+    target_extension: 		''
     linker_options:
     -                       '/OPT:NOREF'
     -                       '/INCREMENTAL:NO'

data/lib/flak/thor/templates/{delight.tt → config/delight.yml.tt}

@@ -1,6 +1,6 @@
 delight_version: '10.0.12'
 
-target_release_prefix: 'delight/procedural'
+# target_release_prefix: 'delight/procedural'
 
 shader_release_prefix: 'delight/shader'
 

data/lib/flak/thor/templates/{env.tt → config/environment.yml.tt}

@@ -35,18 +35,17 @@ author_email:               "<%= ENV['USER'] %>@example.com"
 # on the OS. For a full list of keys, 
 # type in a shell at the project root: 
 # rake -T | grep inspect 
-# and run one of the rake commands for a tool
+# and run one of the rake commands for a tool or the project.
 os_darwin:   
-    target_release_path:    "/Users/<%= ENV['USER'] %>/tools"
+    tools_directory:    "${HOME}/tools"
 os_linux_64:   
     configuration_debug: 
-        target_release_path: "/home/<%= ENV['USER'] %>/tools"
+        tools_directory: "${HOME}/tools"
     configuration_release: 
-        target_release_path: "/big/server/tools"
+        tools_directory: "/big/server/tools"
 os_win_64:
     configuration_debug: 
-        target_release_path: "/cygdrive/c/cygwin/home/<%= ENV['USER'] %>/tools"
+        tools_directory: "/cygdrive/c/cygwin/${HOME}/tools"
     configuration_release: 
-        target_release_path: "/cygdrive/big/server/Tools" 
-
+        tools_directory: "/cygdrive/big/server/Tools" 
 

data/lib/flak/thor/templates/{maya.tt → config/maya.yml.tt}

@@ -4,7 +4,15 @@ dg_convert_cmd: 'convert  -resize 32x32'
 
 outliner_convert_cmd: 'convert  -resize 20x20'
 
-maya_convert_cmd: 'convert'
+icon_convert_cmd: 'convert'
+
+maya_icon_destination: 'maya/icons'
+
+maya_script_destination:  'maya/scripts'
+
+maya_scripted_plugin_destination:  'maya/plug-ins'
+
+maya_precompiled_plugin_destination:  'maya/plug-ins'
 
 os_linux_64:
     autodesk_location: '/usr/autodesk'

data/lib/flak/thor/templates/{maya_app.tt → config/maya_app.yml.tt}

@@ -1,5 +1,3 @@
-target_release_prefix: 'bin'
-
 os_linux_64:
     libs:
     - 'OpenMayalib'

data/lib/flak/thor/templates/{maya_plugin.tt → config/maya_plugin.yml.tt}

@@ -1,5 +1,3 @@
-target_release_prefix: 'maya/plug-ins'
-
 libs:
 - 'OpenMaya'
 

data/lib/flak/thor/templates/config/nuke.yml.tt

@@ -0,0 +1,3 @@
+nuke_version: ${NUKE_VERSION}
+
+nuke_script_destination: 'nuke/scripts'

data/lib/flak/thor/templates/config/release.yml.tt

@@ -0,0 +1,3 @@
+
+release_script_destination: 'bin'
+

data/lib/flak/thor/templates/config/shell.yml.tt

@@ -0,0 +1 @@
+shell_script_destination: 'bin'

data/lib/flak/thor/templates/doc/content/install_guide.txt.tt

@@ -9,56 +9,102 @@
 type: Install Guide
 ---
 
+<% @figure_counter = 1 %>
 
-<%% @figure_counter = 1 %>
+h3. Prerequsites
 
-h3. Introduction
+h4. <%= name %> requires jlib.
 
-This is an install guide. You can change the meta information, name, email etc. at the top of the original textile file in the doc directory of your module. You can have more than one install guide if you like. Just give them different filenames, like installMac.txt, installLinux.txt etc.
+So if you haven't done so already, install jlib which you can get from "defu":http://defu.herokuapp.com/
 
-Just like a tutorial, you can add movies and images. So why not go ahead and make a screencast. See the tutorial template for more examples.
+h4. This version of <%= name %> works with Maya <pre>version</pre>
 
+h4. <%= name %> requires <pre>some library</pre>
 
-<hr>
+h3. Where to get <%= name %>
 
-h3. Install on Linux
+Get the latest version of <%= name %> for your platform from "defu":http://defu.herokuapp.com/ and move it to the place you keep your tools, for example: 
 
-# Here's an ordered list, good for installation steps
-# Here's an ordered list, good for installation steps
-# Here's an ordered list, good for installation steps
+bc. /big/server/tools/
 
-<hr>
 
-h3. Install on Mac
+We'll use that path in the instructions, but be sure to substitute it with your actual location throughout this guide.
 
-# Here's an ordered list, good for installation steps
-# Here's an ordered list, good for installation steps
-# Here's an ordered list, good for installation steps
+h3. Install on Mac or Linux
+
+Extract the <%= name %> package using tar
+
+bc. cd /big/server/tools/
+tar xvf <%= name %>-0.0.1
+
+Now run the install script as the user who will be using the tool. You can do this from anywhere, but since you are currently in /big/server/tools/ enter the following command.
+
+bc. <%= name %>/0.0.1-darwin/bin/INSTALL_<%= name.upcase %>
+
+You should see the following output:
+
+bc. working from : /big/server/tools
+<%= name %> install directory is: /big/server/tools/<%= name%>
+os is: Darwin
+writing + <%= name %> 0.0.1 /big/server/tools/<%= name %>/0.0.1-darwin/maya to /Users/my_name/maya/2012-x64/modules/<%= name %>
+appending <%= name %> source commands to  /Users/my_name/.bashrc
+NOW RUN THESE COMMANDS OR OPEN A NEW SHELL:
+export <%= name.upcase %>=/big/server/tools/<%= name%>/0.0.1-darwin
+. ${<%= name.upcase %>}/bin/<%= name %>.sh
+
+
+h3. What just happened? 
+
+The <%= name %> maya directory was registered as a maya module in a file in your $MAYA_MODULE_PATH.
+
+bc. /Users/my_name/maya/2012-x64/modules/<%= name %>
+
+That means next time you start maya the <%= name %> module will be available. 
 
-<hr>
 
 h3. Install on Windows
 
-# Here's an ordered list, good for installation steps
-# Here's an ordered list, good for installation steps
-# Here's an ordered list, good for installation steps
+Windows will probably ask if you want to extract with WinRar. Do so into the folder /big/server/tools/ and double click the file.
 
-You can link to other pages in the site with embedded ruby (erb) <%%= link_to( "like this", "tutorial.html") %>. 
+h4. Create the Maya modules file
 
-Or you can use textile to link to other pages in the site or externally "like this":my_other_page.html or "this":http://www.vfxoverflow.com
+If its not there already, make the folder: C:\Users\my_name\Documents\maya\2012-x64\modules and create a plain text document called <%= name %>. Its important to make sure it has no extension. <%= name %>.txt for example will NOT work.
 
+Add the following line, 
 
-<hr>
+bc. + <%= name %> 0.0.1 /big/server/tools/<%= name %>/0.0.1-win_64/maya
 
-<%%= figure_tag('Image Title', 'You can write a caption here.','images/screenshot.jpg','left') %>
+h4. Put the <%= name %> bin directory in your PATH
 
-<hr>
+bc. <%= name.upcase %> = \big\server\tools\<%= name %>\0.0.1-win_64
+PATH =   %PATH%;%<%= name.upcase %>%\bin
 
-The  system is now set up. If you take a look in the outliner you will see magic has been done. When you press play you should see cool stuff.
+Maya.env can usually be found here:
 
-h3. Another section
+@C:\Users\my_name\Documents\maya\2012-x64\Maya.env@
+
+Next time you start maya the <%= name %> module will be available.
+
+h3. Activate in Maya.
+
+You can choose to make a menu for <%= name %>. Type the following in a MEL script editor.
+
+bc. <%= name %>("FooBar");
+
+You will see a new menu appear @FooBar@. It contains a @<%= name %>@ submenu. 
+
+If you want to put it in the main menu bar, type instead:
+
+bc. <%= name %>($gMainWindow);
+
+You now have a <%= name %> menu containing the "create" menu item, a standard "About" submenu, and a "Documentation" submenu pointing to this documentation.
+
+h3. Contributing
+
+If you want to contribute, the source is available at "bitbucket":https://bitbucket.org/rmwcs/<%= name %>. You'll need "flak":http://rubygems.org/gems/flak in that case too.
 
 h3. Done
 
 
 Have Fun!
+

data/lib/flak/thor/templates/maya_plugin_cpp.tt

@@ -0,0 +1,37 @@
+#include <maya/MStatus.h>
+#include <maya/MFnPlugin.h>
+#include <maya/MGlobal.h>
+
+
+#include "<%= name %>.h"
+
+MStatus initializePlugin( MObject obj)
+{
+
+	MStatus st;
+	
+	MString method("initializePlugin");
+
+	MFnPlugin plugin( obj, PLUGIN_VENDOR, PLUGIN_VERSION , MAYA_VERSION);
+
+	// register your plugin's nodes, commands, or whetever here.
+
+	return st;
+
+}
+
+MStatus uninitializePlugin( MObject obj)
+{
+	MStatus st;
+
+	MString method("uninitializePlugin");
+
+	MFnPlugin plugin( obj );
+
+	// deregister your plugin's nodes, commands, or whetever here.
+
+
+	return st;
+}
+
+

data/lib/flak/thor/templates/name_cpp.tt

@@ -0,0 +1,6 @@
+#include "<%= name %>.h"
+
+
+<%= name %>::<%= name %>() {}
+
+<%= name %>::~<%= name %>() {}

data/lib/flak/thor/templates/name_h.tt

@@ -0,0 +1,34 @@
+
+#ifndef _<%= name.upcase %>_H
+#define _<%= name.upcase %>_H
+
+
+class <%= name %> 
+{
+public:
+	<%= name %>();
+	virtual ~<%= name %>(); 
+
+};
+
+#endif
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+