flak 0.0.4 → 0.0.5

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

@@ -0,0 +1,168 @@
+module Flak::Template
+
+
+  module Delight
+    module Settings
+
+      extend Flak::Template::MergeEngine
+
+      def self.extended target
+        infuse target
+      end
+
+
+      def self.settings_modifications settings
+        mods = Hash.new
+
+        bind = binding()
+
+        Flak::Errors.assert("settings[:delight_location]", "String", bind,__FILE__)
+        Flak::Errors.assert("settings[:delight_version]", "String", bind,__FILE__)
+        Flak::Errors.assert("settings[:build_directory]", "String", bind,__FILE__)
+
+        v_loc =  File.join( "#{settings[:delight_location]}-#{settings[:delight_version]}" )
+
+
+        mods[:lib_paths] =             [  File.join( v_loc ,"lib")  ]
+
+        mods[:include_paths] =         [ File.join( v_loc ,"include")]
+
+        mods[:shader_compiler] =       File.join( v_loc, "bin","shaderdl")
+
+        mods[:shader_build_directory] =      settings[:build_directory]
+
+        mods[:libs] =                  ["3delight"]
+
+        mods[:shader_include_paths] = [ File.join( v_loc, "maya","rsl")] 
+
+        mods  
+      end
+
+
+
+
+      # all shader build files
+      def shader_files()
+        @settings[:sl_files].collect { |f| shader_file(f) }
+      end
+
+
+      # path to shader build: e.g. /hq/dev/jtools/build/2009.3/darwin/debug/goosebump.sdl
+      def shader_file(source)
+        bind = binding()
+        Flak::Errors.assert("@settings[:shader_build_directory]", "String", bind,__FILE__)
+
+        File.join(@settings[:shader_build_directory], source.gsub("/src/","/").ext('sdl'))
+      end
+
+      def shader_release_path(file)
+        bind = binding()
+        Flak::Errors.assert("@settings[:path_to_revision]", "String", bind,__FILE__)
+
+        File.join(@settings[:path_to_revision] , 'delight','shader', file.pathmap('%f'))
+      end
+
+      def delight_shader_compile_cmd(dest,src)  
+        bind = binding()
+        Flak::Errors.assert("@settings[:shader_compiler]", "String", bind,__FILE__)
+
+        include_path_string = (@settings[:sl_files].collect {|f| f.pathmap('%d')}.uniq | ( @settings[:shader_include_paths] || [] )).collect { |el| "-I#{el.to_s}" }.join(" ")
+        shader_type_string = "-DSHADER_TYPE_#{src.pathmap('%d').pathmap('%f')}"
+        "#{@settings[:shader_compiler]} #{shader_type_string}  #{include_path_string} -d #{dest} #{src}"
+      end
+
+
+      def delight_clean_cmd
+        "rm -f  #{shader_files}"
+      end
+
+
+
+
+    end
+
+
+
+
+
+    module Tasks
+      def self.extended target
+        task_factory target
+      end
+
+
+      def self.task_factory target
+        settings = target.settings
+
+
+
+        files = settings[:sl_files]
+        unless files.nil?
+
+          files.each do |f|
+
+
+
+            # file tasks to build shader from sources
+            ######################################################
+            target_shader = target.shader_file(f)    
+            file target_shader => f  do |t|
+              dest = target.make_directory_for(target_shader)
+              sh delight_shader_compile_cmd(dest,f) 
+            end
+
+            namespace settings[:name].to_sym do        
+              desc "build the #{settings[:name].to_sym} delight shaader"
+              task :build => target_shader
+            end
+            task :build => "#{settings[:name].to_sym}:build"
+            ######################################################            
+
+
+
+            # file tasks to release shaders
+            ######################################################
+            release_shader = target.shader_release_path(target_shader)
+            file release_shader => target_shader do
+              target.make_directory_for(release_shader)
+              cp target_shader, release_shader 
+            end
+
+            namespace settings[:name].to_sym do        
+              task :release => release_shader
+            end
+            task :release => "#{settings[:name].to_sym}:release"
+            ######################################################       
+
+
+          end
+
+
+          # task to clean the build files
+          ######################################################
+          namespace settings[:name].to_sym do     
+            desc "clean the #{settings[:name].to_sym} build files"
+            task :clean do
+              sh delight_clean_cmd
+            end
+          end
+          task :clean => "#{settings[:name].to_sym}:clean"
+          ######################################################
+
+
+
+
+
+
+        end
+      end
+
+    end
+
+
+  end
+
+
+
+end
+

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

@@ -0,0 +1,106 @@
+module Flak::Template
+
+
+  module Doc
+    module Settings
+
+      extend Flak::Template::MergeEngine
+
+      def self.extended target
+        infuse target
+      end
+
+      def self.settings_modifications settings
+
+        mods = Hash.new
+
+        bind = binding()
+        Flak::Errors.assert("settings[:product_revision]", "String", bind,__FILE__)
+        Flak::Errors.assert("settings[:release_root]", "String", bind,__FILE__)
+
+        mods[:doc_directory_name] = "#{settings[:product_revision]}-doc"
+
+        mods[:doc_destination] =  File.join(  settings[:release_root] , mods[:doc_directory_name] )
+
+        mods
+      end
+
+      def doc_default_hash(item)
+        bind = binding()
+        Flak::Errors.assert("@settings[:product_name]", "String", bind,__FILE__)
+        Flak::Errors.assert("@settings[:product_revision]", "String", bind,__FILE__)
+        Flak::Errors.assert("@settings[:author_name]", "String", bind,__FILE__)
+        Flak::Errors.assert("@settings[:author_email]", "String", bind,__FILE__)
+
+        {
+          :title => "#{@settings[:product_name].capitalize} #{item[:type]}", 
+          :description=> "#{@settings[:product_name].capitalize} #{@settings[:product_revision]} #{item[:type]}",
+          :author=> @settings[:author_name],
+          :email=> @settings[:author_email],
+          :created_at => Time.now.strftime("%d %B %Y")
+        }
+      end
+
+
+      def doc_plug_metadata(site)
+        site.items.each do |item| 
+          unless item.binary?
+            item[:type] =  "Index" if item.identifier == "/"
+            item[:type] =  "Release Notes" if item.identifier == "/release_notes/"
+            item.attributes= doc_default_hash(item).merge(item.attributes)   
+          end
+        end
+      end
+
+    end
+
+
+    module Tasks
+
+      def self.extended target
+        task_factory target
+      end
+
+
+
+      def self.task_factory target
+        settings = target.settings
+
+
+        desc "Release documentation"     
+        task :doc do
+          docroot = File.join(settings[:root],'doc')
+          Dir.chdir(docroot) do |d|
+            site = Nanoc::Site.new(YAML.load_file('config.yaml'))
+            site.config[:output_dir] =   settings[:doc_destination]  
+            target.doc_plug_metadata(site)
+
+
+            puts "Compiling site..."
+            site.compile
+            puts "Done... ;)"
+          end
+        end
+
+        namespace :doc do
+          desc "Build and tar up documentation to tar.gz."     
+          task :tar => :doc do
+            Dir.chdir( settings[:tools_directory] ) do |d|
+              sh "tar cfz #{settings[:product_name]}-#{settings[:product_revision]}-doc.tar.gz #{settings[:product_name]}/#{settings[:product_revision]}-doc"
+            end
+          end
+        end
+
+      end
+
+
+    end
+
+
+  end
+
+
+
+
+end
+

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

@@ -0,0 +1,189 @@
+module Flak::Template
+  module Environment
+
+    module Settings
+
+      extend Flak::Template::MergeEngine
+
+      def self.extended target
+        infuse target
+      end
+
+
+      def self.settings_modifications settings
+
+        mods = Hash.new
+
+        bind = binding()
+
+        Flak::Errors.assert("settings[:product_revision]", "String", bind,__FILE__)
+        Flak::Errors.assert("settings[:os]", "String", bind,__FILE__)
+        Flak::Errors.assert("settings[:configuration]", "String", bind,__FILE__)
+        Flak::Errors.assert("settings[:tools_directory]", "String", bind,__FILE__)
+        Flak::Errors.assert("settings[:product_name]", "String", bind,__FILE__)
+
+        mods[:build_directory] = File.join( "build", settings[:product_revision] , settings[:os], settings[:configuration])
+
+        mods[:release_root] = File.join(settings[:tools_directory], settings[:product_name])
+
+        mods[:path_to_revision] =  File.join( mods[:release_root] , settings[:product_revision] )
+
+        mods[:path_to_revision] += "-#{settings[:os]}" unless settings[:agnostic] 
+
+        mods
+      end
+
+
+      def destination_filepath(relative_path, file)
+        bind = binding()
+        Flak::Errors.assert("@settings[:path_to_revision]", "String", bind,__FILE__)
+        File.join(@settings[:path_to_revision] , relative_path , file.pathmap('%f').no_erb)
+      end
+
+
+    end
+
+
+    module Tasks
+
+      def self.extended target
+        task_factory target
+      end
+
+      # We want to release erb files by binding them using ERB. 
+      # To help identify erb files we define them as Filelists in
+      # yaml files under the key <identifier>_erb_files 
+      # e.g. shell_erb_files or maya_script_erb_files 
+      # for the identifiers: shell, and maya_script respectively
+      def self.generate_erb_tasks target
+        settings = target.settings
+
+        namespace settings[:name].to_sym do     
+
+          erb_keys = settings.keys.find_all {|el|  ( el.to_s =~ /^.*_erb_files$/)}
+
+          erb_keys.each do |k|
+            identifier = k.to_s.gsub("_erb_files", "") #  shell or mel
+            files_key = identifier.to_sym        # :shell or :mel
+            destination_path_key = "#{identifier}_destination".to_sym
+
+            write_erb_opts = {:chmod => 0755}
+
+            files = settings[k]
+            unless files.nil?
+              files.each do |f|
+
+                if settings.has_key? destination_path_key
+                  destination_file = target.destination_filepath( settings[destination_path_key], f)
+                else
+                  destination_file = target.send destination_path_key, f    
+                end
+
+                file destination_file => f do
+                  target.make_directory_for(destination_file)
+                  target.write_erb_template(f,destination_file,write_erb_opts) 
+                end
+
+                # desc  "bind and release ERB #{destination_file.pathmap('%f')}"
+                task destination_file.pathmap('%f') => destination_file
+
+                task :release => destination_file.pathmap('%f') 
+
+
+              end
+            end
+          end
+        end
+
+      end
+
+
+
+      def self.generate_copy_tasks target
+        settings = target.settings
+
+        namespace settings[:name].to_sym do     
+
+          # 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|
+            identifier = k.to_s.gsub("_copy_files", "")
+
+            # destination_path_proc = "#{identifier}_destination".to_sym
+            destination_path_key = "#{identifier}_destination".to_sym
+
+
+
+            files = settings[k]
+
+            unless files.nil?
+
+              files.each do |f|
+
+                if settings.has_key? destination_path_key
+                  destination_file = target.destination_filepath(settings[destination_path_key], f)
+                else
+                  destination_file = target.send destination_path_key, f    
+                end
+
+                file destination_file => f do
+                  target.make_directory_for(destination_file)
+                  sh "cp -r #{f}  #{destination_file}" 
+                  File.chmod 0755, destination_file
+                end
+                task :release => destination_file
+              end
+            end
+          end
+          ##############################################
+        end
+
+
+      end
+
+
+      def self.generate_inspect_and_release_tasks target
+        settings = target.settings
+
+        namespace settings[:name].to_sym do     
+
+          desc  "See resolved configuration settings for #{settings[:name].to_sym}"
+          task :inspect do
+            ap  settings
+          end
+
+          desc "Release #{settings[:name].to_sym}"
+          task :release 
+
+        end 
+        task :release => "#{settings[:name].to_sym}:release"
+
+      end
+
+
+
+
+
+      def self.task_factory target
+        self.generate_erb_tasks target
+        self.generate_copy_tasks target
+        self.generate_inspect_and_release_tasks target
+      end
+
+
+    end
+
+
+  end
+
+
+
+
+
+end
+