flak 0.0.4 → 0.0.5

data/lib/flak/rake/templates/nuke.rb

@@ -0,0 +1,60 @@
+module Flak::Template
+
+  module Nuke
+
+    module Settings
+
+      extend Flak::Template::MergeEngine
+
+      def self.extended target
+        infuse target
+      end
+
+
+
+      def self.settings_modifications settings
+
+        bind = binding()
+        Flak::Errors.assert("settings[:os]", "String", bind,__FILE__)
+        Flak::Errors.assert("settings[:path_to_revision]", "String", bind,__FILE__)
+        Flak::Errors.assert("settings[:nuke_version]", "String", bind,__FILE__)
+
+
+        mods = Hash.new
+
+        case settings[:os]
+        when /linux_64/ 
+          mods[:nuke_location] = ""
+        when /darwin/
+          mods[:nuke_location] = "/Applications/Nuke#{settings[:nuke_version]}-32/Nuke#{settings[:nuke_version]}.app/Contents"
+        when /win_64/
+          mods[:nuke_location] = ""
+        end
+
+
+
+        msg = 'Problem creating mods[:nuke_release_path] from: settings[:path_to_revision],"nuke"'
+        mods[:nuke_release_path] = File.join(settings[:path_to_revision],"nuke" ) 
+
+
+        mods
+      end
+
+
+    end
+
+
+    module Tasks
+
+
+
+    end
+
+
+  end
+
+
+
+
+end
+

data/lib/flak/rake/templates/release.rb

@@ -0,0 +1,101 @@
+module Flak::Template
+
+  module Release
+
+
+
+
+
+
+    module Settings
+
+      extend Flak::Template::MergeEngine
+
+      def self.extended target
+        infuse target
+      end
+
+
+      def release_script_destination(file)     
+
+        bind = binding()
+        Flak::Errors.assert("@settings[:path_to_revision]", "String", bind,__FILE__)
+
+        File.join( @settings[:path_to_revision], 'bin', file.pathmap('%f').no_erb )   
+      end
+
+
+
+      def tar_filename
+        bind = binding()
+        Flak::Errors.assert("@settings[:product_name]", "String", bind,__FILE__)
+        Flak::Errors.assert("@settings[:product_revision]", "String", bind,__FILE__)
+        Flak::Errors.assert("@settings[:os]", "String", bind,__FILE__)
+
+        n = "#{@settings[:product_name]}-#{@settings[:product_revision]}"
+        n += "-#{@settings[:os]}" unless @settings[:agnostic]
+        n += ".tar.gz"
+        n
+      end
+
+      def file_to_tar
+        bind = binding()
+        Flak::Errors.assert("@settings[:product_name]", "String", bind,__FILE__)
+        Flak::Errors.assert("@settings[:product_revision]", "String", bind,__FILE__)
+        Flak::Errors.assert("@settings[:os]", "String", bind,__FILE__)
+
+        n = "#{@settings[:product_name]}/#{@settings[:product_revision]}"
+        n += "-#{@settings[:os]}" unless @settings[:agnostic]
+        n
+      end
+
+    end
+
+
+
+
+
+    module Tasks
+
+      def self.extended target
+        task_factory target
+      end
+
+      def self.task_factory target
+        settings = target.settings
+
+
+        desc "Build everything"
+        task :build 
+        CLEAN.include( File.dirname(settings[:build_directory])  )
+        CLOBBER.include( settings[:path_to_revision]) 
+
+        desc "Release everything"     
+        task :default => ["release"]
+
+
+
+
+        desc "Build and tar up product to tar.gz."     
+        task :tar => :release do
+          Dir.chdir( settings[:tools_directory] ) do |d|
+            sh "tar cfz #{target.tar_filename} #{target.file_to_tar}"
+          end
+        end
+
+
+
+
+      end
+
+    end
+
+
+  end
+
+
+
+
+
+end
+

data/lib/flak/rake/templates/shell.rb

@@ -0,0 +1,54 @@
+module Flak::Template
+
+  module Shell
+
+
+
+
+    module Settings
+
+      extend Flak::Template::MergeEngine
+
+      def self.extended target
+        infuse target
+      end
+
+
+
+
+      def shell_script_destination(file)     
+        bind = binding()
+        Flak::Errors.assert("@settings[:path_to_revision]", "String", bind,__FILE__)
+
+        File.join(@settings[:path_to_revision], 'bin', file.pathmap('%f'))   
+      end
+
+
+    end
+
+
+
+
+    module Tasks
+
+      def self.extended target
+        task_factory target
+      end
+
+      def self.task_factory target
+        settings = target.settings
+
+      end
+
+    end
+
+
+
+
+  end
+
+
+
+
+end
+

data/lib/flak/thor/cli.rb

@@ -1,7 +1,12 @@
 
 module Flak
+  
+  
+  # Registers generate as a flak task
   class CLI < Thor
     map "g" => :generate    
     register(Generate, 'generate', 'generate <something>', 'Type flak generate for more help.')
   end
+  
+  
 end

data/lib/flak/thor/generate.rb

@@ -1,210 +1,154 @@
 module Flak
 
+
+
+  # Thor tasks that generate files
   class Generate < Thor
 
     include Thor::Actions
 
     attr_accessor :name, :tool_options, :project_options
-
-
-
-    # PROJECT 
-
-    TEMPLATES = ["env", "cpp", "delight","gl","mac","maya","maya_app","maya_plugin", "nuke", "doc", "mod"]
-
-    MAYA_PLUGIN_TEMPLATES = ["cpp", "gl","maya","maya_plugin"]
-
-    MAYA_APP_TEMPLATES = ["cpp", "gl","maya","maya_app"]
-
-
+    
+    # Provide source_root so that templates can be found
     def self.source_root
       File.join(File.dirname(__FILE__), "templates")
     end
 
-    no_tasks do
 
+    no_tasks do
+      
+      # Get project options from a wizard and cache them
       def project_options
         @project_options ||= Flak::Wizard.project_options
       end
-
+      
+      # Get tool options from a wizard and cache them
       def tool_options
         @tool_options ||= Flak::Wizard.tool_options
       end
-
     end
 
+
     desc "project [name]", "Create a project"
     map "p" => :project    
+    # The project subcommand.  Called with: flak generate project <name>.
+    # Creates a flak project and populates it with files as specified by the users answers to the project wizard.
     def project(name)
       empty_directory(name) 
       inside name do  
-    #  g = GenerateProject.new(name)
-    #  g.configure
-       invoke :config
-     end
+        invoke :config
+      end
     end
 
-    desc "config [name]", "Makes all config and project based files"
+
+    desc "config [name]", "Create config files in a project"
+    map "c" => :config    
+    # The config subcommand.  Called with: flak generate config <name>.
+    # This is the same as the project subcommand, except it works from inside an existing project.
     def config(name)
       opts = self.project_options
-      self.name= name
+      self.name = name
       empty_directory("build") 
       directory("doc")
+      directory("config")
 
-      template( "product.mel.tt" ,    "config/script/maya/erb/#{name}.mel.erb"            )
-      template(  "INSTALL.tt"     ,   "config/script/shell/erb/INSTALL_#{name.upcase}.erb")
-      template(  "product.sh.tt"  ,   "config/script/shell/#{name}.sh"                    )
+      template( "product.mel.tt" ,    "script/maya/erb/#{name}.mel.erb"            ) if opts[:maya_module]
+      template(  "INSTALL.tt"     ,   "script/shell/erb/INSTALL_#{name.upcase}.erb")
+      template(  "product.sh.tt"  ,   "script/shell/#{name}.sh"                    )
 
-      create_file  "target.yml" do 
+      create_file  "project.yml" do 
         Flak::TargetFile.project(name,opts)
       end
 
-      # templates
-      TEMPLATES.each do |t|
-        template("#{t}.tt", "config/#{t}.yml")
-      end
-
       # rakefile
       copy_file  "Rakefile.tt",  "Rakefile.rb"
       copy_file  "gitignore.tt",  ".gitignore"
     end
     
-    
-    
-    
-    ##########################################################################
-    ############################### T O O L ##################################
-    ##########################################################################
 
 
-    desc "tool [name]", "Make a tool"
-    #method_options  %w( maya_script -s) => :boolean,  %w( maya_app -a)  => :boolean,   %w( maya_plugin -p) => :boolean
+
+    desc "tool [name]", "Create a tool"
     map "t" => :tool    
+    # The tool subcommand.  Called with: flak generate tool <name>.
+    # Creates a tool inside a flak project and populates it with files as specified by the users answers to the tool wizard.
     def tool(name)
-
       opts = self.tool_options
       self.name= name
-
-
-      create_file  "#{name}/target.yml" do 
+      create_file  "#{name}/tool.yml" do 
         Flak::TargetFile.tool(name,opts)
       end
+       create_common_files
+       create_maya_script_tree  if opts[:maya_scripts]
+       create_nuke_script_tree if opts[:nuke_scripts]
+       create_shell_script_tree  if opts[:shell_scripts]
+       create_maya_plugin_files if opts[:maya_plugin_target]
+       create_app_files if opts[:maya_app_target] || opts[:standalone_target] 
+       create_delight_tools_tree if opts[:delight_target]
 
-      inside name, :verbose => true do 
-        invoke :create_common_files
-        invoke :create_maya_script_tree
-        invoke :create_nuke_script_tree
-        invoke :create_shell_script_tree
-        invoke :create_maya_plugin_files if opts[:maya_plugin_target]
-        invoke :create_maya_app_files if opts[:maya_app_target]
-        invoke :create_nuke_plugin_files if opts[:nuke_target]
-        invoke :create_delight_tools_trsee if opts[:delight_target]
-      end
-      #end
     end
 
-    #####################################
-    desc "create_maya_plugin_files [name]", "Makes files needed for Maya plugin development"
-    def create_maya_plugin_files(name)
-      invoke :create_maya_app_files
-      create_file "src/plugin.cpp"
-    end
-    #####################################
-
-    #####################################
-    desc "maya_app_tool [name]", "Makes tool files needed for Maya app development"
-    def create_maya_app_files(name)
-     # invoke :create_maya_tree
-      create_file "src/#{name}.cpp"
-      create_file "src/#{name}.h"
-    end
-    #####################################
-
-    #####################################
-    desc "create_nuke_tree [name]", "Makes tool files needed for nuke development"
-    def create_nuke_plugin_files(name)
-      create_file "src/#{name}.cpp"
-      create_file "src/#{name}.h"
-    end
-    #####################################
-
-    #####################################
-    desc "create_delight_tree [name]", "Makes tool files needed for delight development"
-    def create_delight_tools_tree(name)
-      empty_directory('delight/shader/include') 
-      empty_directory('delight/shader/light') 
-      empty_directory('delight/shader/surface') 
-      empty_directory('delight/shader/displacement') 
-      empty_directory('delight/shader/atmosphere') 
-      empty_directory('delight/shader/interior') 
-      empty_directory('delight/dso') 
-      empty_directory('delight/filter') 
-    end
-    #####################################
-
-    #####################################
-    desc "create_common_files [name]", "Makes files that will be in every tool"
-    def create_common_files(name)
-      empty_directory('examples') 
-      create_file "README.md"
-      create_file "LICENSE.md"
-      create_file "INSTALL.md"
-    end
-    #####################################
+    no_tasks do
 
-    #####################################
-    desc "create_maya_script_tree [name]", "Makes tool files needed for Maya script development"
-    def create_maya_script_tree(name)
-      self.name= name
-      empty_directory("maya/script/plugin")
-      empty_directory("maya/icons/node") 
-      template("init.mel.tt", "maya/script/#{name}.init.mel")
-    end
-    #####################################
-
-    #####################################
-    desc "create_nuke_script_tree [name]", "Makes tool files needed for nuke development"
-    def create_nuke_script_tree(name)
-      empty_directory('nuke/gizmo') 
-      empty_directory('nuke/python') 
-      empty_directory('nuke/scenes')
-    end
-    #####################################
+      #desc "create_maya_plugin_files [name]", "Makes files needed for Maya plugin development"
+      def create_maya_plugin_files
+        create_app_files
+        template("maya_plugin_cpp.tt", "#{name}/src/plugin.cpp")
+      end
 
-    #####################################
-    desc "create_shell_script_tree [name]", "Makes tool files needed for shell script development"
-    def create_shell_script_tree(name)
-      empty_directory('shell/script') 
-    end
-    #####################################
 
-    ##########################################################################
-    ############################### D O C ####################################
-    ##########################################################################
+      #desc "maya_app_tool [name]", "Makes tool files needed for Maya app development"
+      def create_app_files
+        template("name_cpp.tt", "#{name}/src/#{name}.cpp")
+        template("name_h.tt", "#{name}/src/#{name}.h"  )
+      end
 
-    desc "tutorial [name]", "Create a tutorial"
-    map "u" => :tutorial    
-    def tutorial(name)
-      template("tutorial.txt.tt", "doc/content/#{name}_tutorial.txt")
-    end
 
 
-    desc "install [name]", "Create a new install file"
-    map "i" => :install   
-    def install(name)
-      opts = self.project_options
-      self.name= name
-      template(  "INSTALL.tt"     ,   "config/script/shell/erb/INSTALL_#{name.upcase}.erb")
-    end
 
-     
+      #desc "create_delight_tree [name]", "Makes tool files needed for delight development"
+      def create_delight_tools_tree
+        empty_directory("#{name}/delight/shader/include") 
+        empty_directory("#{name}/delight/shader/light") 
+        empty_directory("#{name}/delight/shader/surface") 
+        empty_directory("#{name}/delight/shader/displacement") 
+        empty_directory("#{name}/delight/shader/atmosphere") 
+        empty_directory("#{name}/delight/shader/interior") 
+        empty_directory("#{name}/delight/dso") 
+        empty_directory("#{name}/delight/filter") 
+      end
 
+      #desc "create_common_files [name]", "Makes files that will be in every tool"
+      def create_common_files
+        empty_directory("#{name}/examples") 
+        create_file "#{name}/README"
+        create_file "#{name}/LICENSE"
+        # create_file "INSTALL.md"
+      end
+    
+      #desc "create_maya_script_tree [name]", "Makes tool files needed for Maya script development"
+      def create_maya_script_tree
+      #  self.name= name
+        empty_directory("#{name}/maya/script/plugin")
+        empty_directory("#{name}/maya/icons/node") 
+        template("init.mel.tt", "#{name}/maya/script/#{name}.init.mel")
+      end
 
+      #desc "create_nuke_script_tree [name]", "Makes tool files needed for nuke development"
+      def create_nuke_script_tree
+        empty_directory("#{name}/nuke/gizmo") 
+        empty_directory("#{name}/nuke/python") 
+        empty_directory("#{name}/nuke/scenes")
+      end
 
-    ##########################################################################
-    ############################### B A N N E R ##############################
-    ##########################################################################
+      #desc "create_shell_script_tree [name]", "Makes tool files needed for shell script development"
+      def create_shell_script_tree
+        empty_directory("#{name}/shell/script") 
+      end
+    end
 
+    # Format the help line so it reads flak generate something name,
+    # as opposed to flak generate:something name.
     def self.banner(task, namespace = false, subcommand = true)
       task.formatted_usage(self, true, subcommand).split(':').join(' ')
     end