flak 0.0.1 → 0.0.2

data/README.textile

@@ -0,0 +1,59 @@
+h1. Flak
+
+h2. _Flak is Under development - there are hardly any docs or anything at the moment. Best not to use until this message goes away_
+
+h2. What is flak?
+
+Flak is a framework to help you write VFX tools. You will find it especially useful if you write tools for Maya but it also helps you write shell scripts, Nuke tools, 3delight shaders and more. 
+
+Flak projects use Rake (Ruby Make), so there are common configuration files across all platforms.
+
+Flak also encourages good documentation by setting up a website skeleton based on "nanoc":http://http://nanoc.stoneship.org/. There are templates for an introduction page, release notes, installation guide, and tutorials so you can concentrate on content and let flak handle presentation at compile time. In addition there are Maya tools to generate flak documentation for nodes and commands.
+
+h2. Project structure
+
+A flak project produces a module at build time. We'll use the word 'project' for the local source, and 'module' for the compiled result. 
+
+A module contains any number of tools, each of which can have at most one compiled target plus any number of scripts, icons or other support files. As such, your local flak project contains a subdirectory containing source files for each tool. In addition, the project will contain project wide-configuration files and a documentation tree.
+
+Each tool directory contains a structure where you arrange your source code. This structure is flexible, although sensible defaults will be set up at generation time.
+
+h2. Example workflow
+
+Lets say you want a project called flintstone with tools fred and wilma. You would issue the generate command for the project:
+
+    flak generate project flintstone
+
+It will ask a few questions about the kind of module you want to make. Then:
+
+    cd flintstone
+    flak generate tool fred
+    flak generate tool wilma
+
+There are shortcuts: g = generate, p = project, t = tool. So the commands above could be entered as:
+
+    flak g p flintstone
+    flak g t fred
+    flak g t wilma
+
+At this point, you have a skeleton project set up. Then you would edit config files where necessary, write your code and documentation and finally type:
+
+    rake
+    rake doc
+
+This will build and release the module and the documentation site. Whether you release locally or in a shared location, users can install the module by in their environment by running the install script: 
+<pre><path to module>/bin/INSTALL_FLINTSTONE</pre>
+
+There's much more coolness which we'll get into. So now you've seen how easy it is to develop using flak, lets get started.
+
+h2. Getting flak
+
+Flak is a ruby gem. So update rubygems, just to be sure, then install the gem:
+
+    gem update --system
+
+    gem install flak
+
+
+
+    

data/flak.gemspec

@@ -22,9 +22,9 @@ Gem::Specification.new do |s|
   # s.add_development_dependency "rspec"
   s.add_runtime_dependency "awesome_print"
   s.add_runtime_dependency "nanoc"
+  s.add_runtime_dependency "RedCloth"
+  s.add_runtime_dependency "sass"
 
-
-  
 end
 
 

data/lib/flak.rb

@@ -8,350 +8,25 @@ require 'erb'
 require "thor"
 require "thor/group"
 require "ap"
-
+require 'nanoc'
 require 'core_ext/string'
 
-require 'flak/cpp'
-require 'flak/delight'
-require 'flak/doc'
-require 'flak/gl'
-require 'flak/mac'
-require 'flak/max'
-require 'flak/maya'
-require 'flak/maya_app'
-require 'flak/maya_plugin'
-require 'flak/nuke'
-require 'flak/target'
+require 'flak/rake/cpp'
+require 'flak/rake/delight'
+require 'flak/rake/doc'
+require 'flak/rake/gl'
+require 'flak/rake/mac'
+require 'flak/rake/max'
+require 'flak/rake/maya'
+require 'flak/rake/maya_app'
+require 'flak/rake/maya_plugin'
+require 'flak/rake/nuke'
+require 'flak/rake/target'
+require 'flak/rake/base'
+
 require 'flak/version'
+require 'flak/thor/wizard'
+require 'flak/thor/target_file'
 require 'flak/thor/generate'
 require 'flak/thor/cli'
 
-
-
-module Flak
-
-  # return a slightly nicer OS string than the 
-  # RUBY_PLATFORM variable
-  def self.os
-    case RUBY_PLATFORM 
-    when /64-linux/ 
-      'linux_64'
-    when /i686_linux/
-      'linux_32'
-    when /darwin/
-      'darwin'
-    when /i386-cygwin/
-      'win_64'
-    end
-  end
-
-
-
-  # merge_setting TODO - move to a Hash#merge block
-  # if the same key is being offered and the value is an array, then we merge the arrays.
-  # otherwise it is a string, so the new one overrides the existing one. 
-  def self.merge_setting(hash, setting_key, setting_value)
-    if hash.has_key?(setting_key)
-      if setting_value.kind_of?(Array) 
-        hash[setting_key.to_sym] |= setting_value
-      else
-        hash[(setting_key.to_sym)] = setting_value
-      end
-    else
-      hash[(setting_key.to_sym)] = setting_value
-    end
-    hash
-  end
-
-
-  # given a yml settings file, resolve the configuration and OS
-  # and return the new flattened hash 
-  def self.merge_settings(hash1,hash2) 
-    hash2.each do |k,v|
-      merge_setting(hash1,k,v)
-    end
-    hash1
-  end
-
-  # given a yml settings file, resolve the configuration and OS
-  # and return the new flattened hash 
-  def self.flatten_settings(yml,configuration, os) 
-
-    h = Hash.new
-    y_hash = YAML::load_file( yml) || {}
-    y_hash.each do |k,v|
-
-      # root level settings
-      ################
-      if ( ! ((k =~/^os_.*/) || (k =~/^configuration_.*/)) ) 
-        h =Flak.merge_setting(h,k.to_sym, v)
-      else
-
-        # os specific settings
-        ################
-        if (k == "os_#{os}" )  
-          # puts "OS => #{os}"
-          v.each do |k1,v1|
-            if (k1 =~ /^configuration_.*/ ) 
-              if (k1 == "configuration_#{configuration}" )  
-                v1.each do |k2,v2|
-                  h =Flak.merge_setting(h,k2.to_sym, v2)
-                end
-              end
-            else
-              h=Flak.merge_setting(h,k1.to_sym, v1)
-            end
-          end
-        else
-          # configuration settings (not os specific)
-          ################
-          if (k == "configuration_#{configuration}" )  
-            v.each do |k1,v1|
-              h=Flak.merge_setting(h,k1.to_sym, v1)
-            end
-          end
-          ################
-        end
-
-      end
-      ################      
-    end
-    # ap h
-    h
-  end
-
-
-  # method responsible for returning a flat and comprehensive 
-  # settings hash by gathering all the base config settings from 
-  # yaml and generating others programatically. 
-  # This settings hash will be used by targets, and by the 
-  # release mechanism.
-  def self.resolve_settings( existing_settings )
-
-    # bootstrap to get the configuration and the os up front because these are needed to 
-    # handle the logic to extract the right configuration and os settings from this and 
-    # all subsequent yml files
-    # f = File.dirname(File.dirname(__FILE__))  + '/config/base.yml' 
-    # tmp = YAML::load_file( base_file )
-    
-    f = existing_settings[:root] + '/config/env.yml' 
-    h =Flak.flatten_settings(f, existing_settings[:configuration], existing_settings[:os] )
-    h[:root] = existing_settings[:root] 
-    h[:os] = Flak.os
-
-    # after this point we get values from the hash (h) wherever possible - 
-    # Why? - because h is the flattened hash - meaning that configuration and OS specific
-    # settings will be correct. For example, product_revision may be different for debug and release
-   # sr = File.dirname(File.dirname(File.dirname(__FILE__)))
-   # sr = File.join("/cygdrive/c/cygwin",sr) if (Flak.os == 'win_64')
-    
-    #h.merge!({:os => Flak.os})
-
-    h[:build_dir] = File.join("build", h[:product_revision] , h[:os])
-    h[:release_root] = File.join(h[:target_release_path], h[:product_name])
-
-
-    h[:versioned_os_release_path] =  File.join( h[:release_root] , "#{h[:product_revision]}-#{h[:os]}" )
-    h[:doc_dirname] = "#{h[:product_revision]}-doc"
-    h[:doc_release_root] =  File.join( h[:release_root] , h[:doc_dirname] )
-
-    #  ap h
-    
-
-    h
-  end
-
-  # in order to make a symlink, we need to remove it 
-  # if it already exists
-  def self.rebuild_symlink(target_file,new_file)
-    if File.symlink?(new_file)
-      File.unlink(new_file)
-    end
-    File.symlink(target_file, new_file)
-  end
-  
-  # if we just copy src to dest and dest exists and is a directory, 
-  # then the src is put in the dest, as opposed to overwriting it. For
-  # this reason, we delete dest first.
-  def self.copy_over(src,dest)
-    remove_file(dest, true) 
-    cp_r src, dest
-  end
-  
-  
-  # make a directory for a file
-  def self.make_dir_for(file)
-    FileUtils.mkdir_p file.pathmap('%d')
-  end
-
-
-  ####################################################################################
-  ######################### I N S T A N C E   M E T H O D S ##########################
-  ####################################################################################
-  def filename
-    f = @settings[:name]
-    f = f.ext(@settings[:target_extension] ) unless @settings[:target_extension].nil?
-    f = File.join(@settings[:build_dir],f) 
-  end
-
-
-  def shell_script_release_path(file)     
-    File.join(@settings[:versioned_os_release_path], 'bin', file.pathmap('%f'))   
-  end
-
-
-  def write_erb_template(erb_file,released_file, opts={})
-    if (!(opts[:no_force] && File.exists?(released_file) ))
-      product_name = @settings[:product_name]
-      template = ERB.new( File.read(erb_file) , 0, "%<>")
-      File.open(released_file, 'w') do |f|
-        f.puts(template.result(binding))
-        f.chmod(opts[:chmod].to_i)   if opts[:chmod]
-      end
-    end
-  end
-
-
-
-  def base_instance_tasks
-
-    namespace @settings[:name].to_sym do     
-
-      if  @settings[:name] == 'jRelease'  
-        desc "Build everything"
-        task :build 
-
-        clobber_list = [File.dirname(@settings[:build_dir]) , @settings[:versioned_os_release_path]]
-        CLOBBER.include( clobber_list )   
-      end
-
-
-
-      # We want to release erb files by binding them using ERB. To help identify erb files we define them in
-      # yaml files under the key <type>_erb_files e.g. shell_erb_files or maya_script_erb_files for example
-
-      ##############################################
-      erb_keys = @settings.keys.find_all {|el|  ( el.to_s =~ /^.*_erb_files$/)}
-
-      erb_keys.each do |k|
-        type = k.to_s.gsub("_erb_files", "") #  shell or mel
-        files_key = type.to_sym        # :shell or :mel
-
-        release_path_proc = "#{type}_release_path".to_sym
-
-        # ap [type, files_key, release_path_proc]
-
-        files = @settings[k]
-        unless files.nil?
-
-          files.each do |f|
-
-            # if a filename is a key in the settings hash
-            # and that key is a string, replace the filename with the 
-            # value. Also, get rid of the erb extension
-            # For example, if @settings[:product_name] is 'jtools' then
-            # product_name.csh.erb becomes jtools.csh
-            filename_key = f.pathmap('%f').gsub(/\..*/,'').to_sym
-            
-            
-            # hack chmod for INSTALL - really must find a better way soon
-            write_erb_opts = (filename_key == :INSTALL) ?  {:chmod => 0755} : {}
-            
-            
-            
-            f_resolved = f.pathmap('%f').pathmap('%n')
-            #ap filename_key
-            if @settings.has_key?(filename_key) 
-
-              #if @settings[filename_key].kind_of?(Symbol) 
-              f_resolved = "#{@settings[filename_key]}#{f_resolved.pathmap('%x')}"
-             # puts f_resolved
-              #end
-            end
-
-            released_file = self.send release_path_proc, f_resolved
-
-           
-            file released_file => f do
-
-              Flak.make_dir_for(released_file)
-              write_erb_template(f,released_file,write_erb_opts) 
-            end
-            
-            desc  "bind and release ERB #{released_file.pathmap('%f')}"
-            task released_file.pathmap('%f') => released_file
-            
-            task :release => released_file.pathmap('%f') 
-          end
-        end
-      end
-      ##############################################
-
-
-
-      # @settings[:copy_only] is an array of file types that should be copied
-      # for example ruby files. 
-      # If so, there should be a proc called ruby_release_path which responsible for generating the release path
-      # this smells a bit - not sure if it can be fixed - we will see
-      ##############################################
-      copy_keys = @settings.keys.find_all {|el|  ( el.to_s =~ /^.*_copy_files$/)}
-
-      copy_keys.each do |k|
-        type = k.to_s.gsub("_copy_files", "")
-       
-        #@settings[:copy_only].each do |type| 
-        #files_key = "#{type}_files".to_sym
-        release_path_proc = "#{type}_release_path".to_sym
-        files = @settings[k]
-     
-        ap files  if release_path_proc == "shell_script_release_path"
-
-        #files = @settings[files_key]
-        unless files.nil?
-
-          files.each do |f|
-            released_file = self.send release_path_proc, f
-            file released_file => f do
-              Flak.make_dir_for(released_file)
-              sh "cp -r #{f}  #{released_file}" 
-              File.chmod 0755, released_file if (type == 'shell'  )
-            end
-            task :release => released_file
-          end
-        end
-      end
-      ##############################################
-
-      desc  "See resolved configuration settings for #{@settings[:name].to_sym}"
-      task :inspect do
-        ap  @settings
-      end
-
-      desc "Release #{@settings[:name].to_sym}"
-      task :release # => [:rebuild_label_link ]
-
-
-      # every target needs the ability to initialize a doc hierarchy
-      # so this is where it goes
-      namespace :doc do
-  
-  
-
-      end  # namespace doc
-
-    end # namespace name
-
-    task :release => "#{@settings[:name].to_sym}:release"
-    
-    task :default => ["release"]
-
-    task :inspect do
-      ap  @settings
-    end
-    
-  end
-
-
-
-
-end

data/lib/flak/rake/base.rb

@@ -0,0 +1,312 @@
+
+
+module Flak
+
+  module Base
+    # return a slightly nicer OS string than the 
+    # RUBY_PLATFORM variable
+    def self.os
+      case RUBY_PLATFORM 
+      when /64-linux/ 
+        'linux_64'
+      when /i686_linux/
+        'linux_32'
+      when /darwin/
+        'darwin'
+      when /i386-cygwin/
+        'win_64'
+      end
+    end
+
+
+
+    # merge_setting TODO - move to a Hash#merge block
+    # if the same key is being offered and the value is an array, then we merge the arrays.
+    # otherwise it is a string, so the new one overrides the existing one. 
+    def self.merge_setting(hash, setting_key, setting_value)
+      if hash.has_key?(setting_key)
+        if setting_value.kind_of?(Array) 
+          hash[setting_key.to_sym] |= setting_value
+        else
+          hash[(setting_key.to_sym)] = setting_value
+        end
+      else
+        hash[(setting_key.to_sym)] = setting_value
+      end
+      hash
+    end
+
+
+    # given a yml settings file, resolve the configuration and OS
+    # and return the new flattened hash 
+    def self.merge_settings(hash1,hash2) 
+      hash2.each do |k,v|
+        merge_setting(hash1,k,v)
+      end
+      hash1
+    end
+
+    # given a yml settings file, resolve the configuration and OS
+    # and return the new flattened hash 
+    def self.flatten_settings(yml,configuration, os) 
+
+      h = Hash.new
+      y_hash = YAML::load_file( yml) || {} 
+      y_hash.each do |k,v|
+
+        # root level settings
+        ################
+        if ( ! ((k =~/^os_.*/) || (k =~/^configuration_.*/)) ) 
+          h =Flak::Base.merge_setting(h,k.to_sym, v)
+        else
+
+          # os specific settings
+          ################
+          if (k == "os_#{os}" )  
+            # puts "OS => #{os}"
+            v.each do |k1,v1|
+              if (k1 =~ /^configuration_.*/ ) 
+                if (k1 == "configuration_#{configuration}" )  
+                  v1.each do |k2,v2|
+                    h =Flak::Base.merge_setting(h,k2.to_sym, v2)
+                  end
+                end
+              else
+                h=Flak::Base.merge_setting(h,k1.to_sym, v1)
+              end
+            end
+          else
+            # configuration settings (not os specific)
+            ################
+            if (k == "configuration_#{configuration}" )  
+              v.each do |k1,v1|
+                h=Flak::Base.merge_setting(h,k1.to_sym, v1)
+              end
+            end
+            ################
+          end
+
+        end
+        ################      
+      end
+      # ap h
+      h
+    end
+
+
+    # method responsible for returning a flat and comprehensive 
+    # settings hash by gathering all the base config settings from 
+    # yaml and generating others programatically. 
+    # This settings hash will be used by targets, and by the 
+    # release mechanism.
+    def self.resolve_settings( existing_settings )
+
+      # bootstrap to get the configuration and the os up front because these are needed to 
+      # handle the logic to extract the right configuration and os settings from this and 
+      # all subsequent yml files
+      # f = File.dirname(File.dirname(__FILE__))  + '/config/base.yml' 
+      # tmp = YAML::load_file( base_file )
+
+      f = existing_settings[:root] + '/config/env.yml' 
+      h =Flak::Base.flatten_settings(f, existing_settings[:configuration], existing_settings[:os] )
+      h[:root] = existing_settings[:root] 
+
+      h[:os] = Flak::Base.os
+      
+      # after this point we get values from the hash (h) wherever possible - 
+      # Why? - because h is the flattened hash - meaning that configuration and OS specific
+      # settings will be correct. For example, product_revision may be different for debug and release
+      # sr = File.dirname(File.dirname(File.dirname(__FILE__)))
+      # sr = File.join("/cygdrive/c/cygwin",sr) if (Flak::Base.os == 'win_64')
+
+      #h.merge!({:os => Flak::Base.os})
+
+      h[:build_dir] = File.join("build", h[:product_revision] , h[:os])
+      h[:release_root] = File.join(h[:target_release_path], h[:product_name])
+
+      
+      h[:versioned_os_release_path] =  File.join( h[:release_root] , h[:product_revision] )
+      h[:versioned_os_release_path] += "-#{h[:os]}" unless h[:agnostic] 
+      
+      h[:doc_dirname] = "#{h[:product_revision]}-doc"
+      h[:doc_release_root] =  File.join( h[:release_root] , h[:doc_dirname] )
+
+      #  ap h
+
+
+      h
+    end
+
+    # in order to make a symlink, we need to remove it 
+    # if it already exists
+    def self.rebuild_symlink(target_file,new_file)
+      if File.symlink?(new_file)
+        File.unlink(new_file)
+      end
+      File.symlink(target_file, new_file)
+    end
+
+    # if we just copy src to dest and dest exists and is a directory, 
+    # then the src is put in the dest, as opposed to overwriting it. For
+    # this reason, we delete dest first.
+    def self.copy_over(src,dest)
+      remove_file(dest, true) 
+      cp_r src, dest
+    end
+
+
+    # make a directory for a file
+    def self.make_dir_for(file)
+      FileUtils.mkdir_p file.pathmap('%d')
+    end
+
+
+    ####################################################################################
+    ######################### I N S T A N C E   M E T H O D S ##########################
+    ####################################################################################
+    def filename
+      f = @settings[:name]
+      f = f.ext(@settings[:target_extension] ) unless @settings[:target_extension].nil?
+      f = File.join(@settings[:build_dir],f) 
+    end
+
+
+    def shell_script_release_path(file)     
+      File.join(@settings[:versioned_os_release_path], 'bin', file.pathmap('%f'))   
+    end
+
+
+    def write_erb_template(erb_file,released_file, opts={})
+      if (!(opts[:no_force] && File.exists?(released_file) ))
+        product_name = @settings[:product_name]
+        template = ERB.new( File.read(erb_file) , 0, "%<>")
+        File.open(released_file, 'w') do |f|
+          puts "template #{erb_file} #{released_file}"
+          f.puts(template.result(binding))
+          f.chmod(opts[:chmod].to_i)   if opts[:chmod]
+        end
+      end
+    end
+
+
+
+    def base_instance_tasks
+
+
+      namespace @settings[:name].to_sym do     
+
+        desc "Build everything"
+        task :build 
+
+        CLEAN.include( File.dirname(@settings[:build_dir])  ) unless CLEAN.include? File.dirname(@settings[:build_dir])
+      
+        CLOBBER.include( @settings[:versioned_os_release_path]) unless CLOBBER.include?  @settings[:versioned_os_release_path]
+
+
+        # We want to release erb files by binding them using ERB. To help identify erb files we define them in
+        # yaml files under the key <type>_erb_files e.g. shell_erb_files or maya_script_erb_files for example
+
+        ##############################################
+        erb_keys = @settings.keys.find_all {|el|  ( el.to_s =~ /^.*_erb_files$/)}
+
+        erb_keys.each do |k|
+          type = k.to_s.gsub("_erb_files", "") #  shell or mel
+          files_key = type.to_sym        # :shell or :mel
+
+          release_path_proc = "#{type}_release_path".to_sym
+
+          files = @settings[k]
+          unless files.nil?
+
+            files.each do |f|
+
+              # if a filename is a key in the settings hash
+              # and that key is a string, replace the filename with the 
+              # value. Also, get rid of the erb extension
+              # For example, if @settings[:product_name] is 'jtools' then
+              # product_name.csh.erb becomes jtools.csh
+              filename_key = f.pathmap('%f').gsub(/\..*/,'').to_sym
+
+              # hack chmod for INSTALL - really must find a better way soon
+              # write_erb_opts = (filename_key == :INSTALL) ?  {:chmod => 0755} : {}
+              write_erb_opts = {:chmod => 0755}
+
+              f_resolved = f.pathmap('%f').pathmap('%n')
+              if @settings.has_key?(filename_key) 
+                f_resolved = "#{@settings[filename_key]}#{f_resolved.pathmap('%x')}"
+              end
+
+              released_file = self.send release_path_proc, f_resolved
+
+
+              file released_file => f do
+
+                Flak::Base.make_dir_for(released_file)
+                write_erb_template(f,released_file,write_erb_opts) 
+              end
+
+              desc  "bind and release ERB #{released_file.pathmap('%f')}"
+              task released_file.pathmap('%f') => released_file
+
+              task :release => released_file.pathmap('%f') 
+            end
+          end
+        end
+        ##############################################
+
+
+
+        # copy_keys is an array of keys representing file types that should be copied
+        # for example maya_script_copy_files
+        # If so, there should be a proc called maya_script_release_path which is responsible for generating the release path
+        # this smells a bit - not sure if it can be fixed - we will see
+        ##############################################
+        copy_keys = @settings.keys.find_all {|el|  ( el.to_s =~ /^.*_copy_files$/)}
+
+        copy_keys.each do |k|
+          type = k.to_s.gsub("_copy_files", "")
+
+          release_path_proc = "#{type}_release_path".to_sym
+          files = @settings[k]
+
+          unless files.nil?
+
+            files.each do |f|
+              released_file = self.send release_path_proc, f
+              file released_file => f do
+                Flak::Base.make_dir_for(released_file)
+                sh "cp -r #{f}  #{released_file}" 
+                File.chmod 0755, released_file if (type == 'shell'  )
+              end
+              task :release => released_file
+            end
+          end
+        end
+        ##############################################
+
+        desc  "See resolved configuration settings for #{@settings[:name].to_sym}"
+        task :inspect do
+          ap  @settings
+        end
+
+        desc "Release #{@settings[:name].to_sym}"
+        task :release # => [:rebuild_label_link ]
+
+      end # namespace name
+
+      task :release => "#{@settings[:name].to_sym}:release"
+
+      task :default => ["release"]
+
+      task :inspect do
+        ap  @settings
+      end
+
+    end
+
+
+  end
+
+
+
+end