flak 0.0.2 → 0.0.3

data/lib/flak/rake/base.rb

@@ -112,7 +112,7 @@ module Flak
       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
@@ -124,10 +124,10 @@ module Flak
       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] )
 
@@ -199,7 +199,7 @@ module Flak
         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]
 
 
@@ -298,6 +298,10 @@ module Flak
 
       task :default => ["release"]
 
+
+
+
+
       task :inspect do
         ap  @settings
       end

data/lib/flak/rake/doc.rb

@@ -16,7 +16,7 @@ module Flak
     def default_hash(item)
       {
         :title => "#{@settings[:product_name].capitalize} #{item[:type]}", 
-        :description=> "#{@settings[:product_revision]} #{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")
@@ -39,25 +39,30 @@ module Flak
     def doc_instance_tasks
 
 
-     # namespace :doc do
 
-        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_release_root]  
-            plug_metadata(site)
-            puts "Compiling site..."
-            site.compile
-            puts "Done... ;)"
-          end
 
+      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_release_root]  
+          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[:target_release_path] ) 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/mod.rb

@@ -0,0 +1,31 @@
+
+
+module Flak
+
+  module Mod
+
+    def self.resolve_settings( existing_settings )
+
+      f = existing_settings[:root] + '/config/mod.yml' 
+      h =Flak::Base.flatten_settings(f,existing_settings[:configuration], existing_settings[:os] )
+
+      h
+    end
+
+
+    def mod_instance_tasks
+      
+      desc "Build and tar up product to tar.gz."     
+      task :tar => :release do
+        Dir.chdir( @settings[:target_release_path] ) do |d|
+          sh "tar cfz #{@settings[:product_name]}-#{@settings[:product_revision]}.tar.gz #{@settings[:product_name]}/#{@settings[:product_revision]}"
+        end
+      end
+      
+    end
+    
+    
+  end
+
+end
+

data/lib/flak/thor/generate.rb

@@ -12,7 +12,7 @@ module Flak
     ############################ P R O J E C T ###############################
     ##########################################################################
 
-    TEMPLATES = ["env", "cpp", "delight","gl","mac","maya","maya_app","maya_plugin", "nuke", "doc"]
+    TEMPLATES = ["env", "cpp", "delight","gl","mac","maya","maya_app","maya_plugin", "nuke", "doc", "mod"]
 
     MAYA_PLUGIN_TEMPLATES = ["cpp", "gl","maya","maya_plugin"]
 
@@ -187,16 +187,19 @@ module Flak
     desc "tutorial [name]", "Create a tutorial"
     map "u" => :tutorial    
     def tutorial(name)
-      template("tutorial.txt.tt", "doc/content/#{name}.txt")
+      template("tutorial.txt.tt", "doc/content/#{name}_tutorial.txt")
     end
 
-    desc "install_guide [name]", "Create an install guide"
-    map "i" => :tutorial    
-    def tutorial(name)
-      template("install_guide.txt.tt", "doc/content/#{name}.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
 
+     
 
 
 

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

@@ -4,15 +4,14 @@
 
 
 # INSTALL script for mac and linux - the purpose of this script is to:
-# Write lines at the bottom of bashrc to source the product.sh file
+# 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 product_up = "<%%= @settings[:product_name].upcase %>"
-set product_version =  "<%%= self.settings[:product_revision]  %>"
+set product_version =  "<%%= self.settings[:product_revision] %>"
 set product = "<%%=  @settings[:product_name] %>"
-set product_up = "<%%= @settings[:product_name].upcase %>"
 
 set rootdir = `dirname $0`
 set rootdir = `cd $rootdir && pwd`    # ensure absolute path
@@ -23,15 +22,16 @@ set full_path_to_this_script = ${rootdir}/${base}
 echo "full path to script : ${full_path_to_this_script}"
 
 set tools = $full_path_to_this_script:h:h:h:h
+set version_dir = $full_path_to_this_script:h:h:t
 
-set product_inst_dir = ${tools}/${product}
+set product_install_dir = ${tools}/<%%= @settings[:product_name] %>
 echo "**************************************************************" 
 echo ""
 
 echo  "working from : ${tools}"
 pushd ${tools}
 
-echo "${product} install directory is: ${product_inst_dir}"
+echo "<%%= @settings[:product_name] %> install directory is: ${product_install_dir}"
 
 set install_platform = ""
 set maya_ver_dir =""
@@ -81,32 +81,33 @@ endif
 set modules_dir = "${maya_app_dir}/${maya_ver_dir}/modules"
 mkdir -p $modules_dir
 
-set the_product_dir = ${product_inst_dir}/${product_version}-${install_platform}
+set the_product_dir = ${product_install_dir}/${version_dir}
 set the_maya_module = ${the_product_dir}"/maya"
 
 <% if project_options[:maya_module] -%>
-echo "+ ${product} ${product_version} ${the_maya_module}" > ${modules_dir}/${product}
-echo "writing + ${product} ${product_version} ${the_maya_module} to ${modules_dir}/${product}"
+echo "+ <%%= @settings[:product_name] %> <%%= self.settings[:product_revision] %> ${the_maya_module}" > ${modules_dir}/<%%= @settings[:product_name] %>
+echo "writing + <%%= @settings[:product_name] %> <%%= self.settings[:product_revision] %> ${the_maya_module} to ${modules_dir}/<%%= @settings[:product_name] %>"
 <% else -%>
-# echo "+ ${product} ${product_version} ${the_maya_module}" > ${modules_dir}/${product}
-# echo "writing + ${product} ${product_version} ${the_maya_module} to ${modules_dir}/${product}"
+# Uncomment the next 2 lines if you want this script to set up the <%%= @settings[:product_name] %> maya module file
+# echo "+ <%%= @settings[:product_name] %> <%%= self.settings[:product_revision] %> ${the_maya_module}" > ${modules_dir}/<%%= @settings[:product_name] %>
+# echo "writing + <%%= @settings[:product_name] %> <%%= self.settings[:product_revision] %> ${the_maya_module} to ${modules_dir}/<%%= @settings[:product_name] %>"
 <% end -%>
 
 if (-f ${HOME}/.bashrc) then
-	cp  ${HOME}/.bashrc  ${HOME}/.bashrc.${product}.bck
-	cat ${HOME}/.bashrc.${product}.bck | grep -v "#.*added by ${product}" > ${HOME}/.bashrc
+	cp  ${HOME}/.bashrc  ${HOME}/.bashrc.<%%= @settings[:product_name] %>.bck
+	cat ${HOME}/.bashrc.<%%= @settings[:product_name] %>.bck | grep -v "#.*added by <%%= @settings[:product_name] %>" > ${HOME}/.bashrc
 
-	echo "appending ${product} source commands to  ${HOME}/.bashrc"
+	echo "appending <%%= @settings[:product_name] %> source commands to  ${HOME}/.bashrc"
 	
-	echo "# The following lines have been added by ${product}"  >> ${HOME}/.bashrc
-	echo 'export '${product_up}'="'${the_product_dir}'" # added by '${product} >> ${HOME}/.bashrc
-	echo '[[ -e "${'${product_up}'}/bin/'${product}'.sh" ]] && . "${'${product_up}'}/bin/'${product}'.sh" # added by '${product}  >> ${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 ""
 	echo "*********NOW RUN THESE COMMANDS OR OPEN A NEW SHELL***********" 
 	echo ""
-	echo "export ${product_up}=${the_product_dir}"
-	echo '. ${'${product_up}'}/bin/'${product}'.sh'
+	echo "export <%%= @settings[:product_name].upcase %>=${the_product_dir}"
+	echo '. ${<%%= @settings[:product_name].upcase %>}/bin/<%%= @settings[:product_name] %>.sh'
 	echo ""
 	echo "**************************************************************" 
 

data/lib/flak/thor/templates/doc/content/assets/css/include.scss

@@ -9,6 +9,9 @@ $toc_headings_bg_color : #aa251b;
 $reliance_blue : #0c4ca3;
 $reliance_light_blue: $reliance_blue + #333;
 $toc_current_bg_color:#f1c7bf;
+$code_block_color:#eaeef9;
+$code_block_border_color:#b8c2e3;
+
 @mixin shadow_box {
   box-shadow: 0px 2px  5px #606060;
 }

data/lib/flak/thor/templates/doc/content/assets/css/page.scss

@@ -30,14 +30,26 @@ p {
 
 
 
+
+	code {
+		display:inline-block;
+		border-radius:5px;
+		border : 1px solid $code_block_border_color;
+		//	width:auto;
+		font-size: 1.1em;
+
+		background-color:$code_block_color;
+		line-height:1.2em;
+		//	color:$src_code_color;
+		padding: 0.05em 1em;
+	}
 	pre {
 		width:50%;
-	}
 
-	code {
-		font-size: 1.4em;
-		color:$src_code_color;
-		padding-left: 10px;
+		code {
+			line-height:1.5em;
+		}
+
 	}
 
 	hr {
@@ -132,10 +144,24 @@ p {
 	}
 
 
-	.logo {
-		border:0;
-		clear: both;
-		margin:1em 0 0 1em;
+	#logos {
+		//	clear: both;
+		display:table-row;
+		padding:1em 0 0 1em;
+		li {
+			padding:1em 0 0 1em;
+			list-style:none;
+			display:table-cell;
+			.logo {
+				border:0;
+			}
+			.module_logo {
+				height:50px;
+				width:auto;
+			}
+		}
+
+
 	}
 
 	.meta_container {	
@@ -177,7 +203,7 @@ p {
 		font-stretch: condensed;
 		font-size: 1.2em;
 
-		
+
 		.toc_block {
 			//	border: 1px solid $borders_color;
 			// background-color: #ff9;	
@@ -215,7 +241,7 @@ p {
 	}
 
 	#footer {
-				
+
 		border-top: 1px solid $borders_color;
 		background-color: $bg1_color;
 		ul {
@@ -227,7 +253,7 @@ p {
 				list-style:none;
 				width:20%;
 				img {
-						padding: 0 2em;
+					padding: 0 2em;
 					max-height:50px;
 					width:auto;
 				}

data/lib/flak/thor/templates/doc/layouts/default.html

@@ -20,29 +20,9 @@
 			</li>	
 		</ol>
 		<%= vfxoverflow_ribbon %>
-		<div id="footer">
-			<ul>
-				<li class="footer_image">
-					 <a href="http://www.mirovideoconverter.com/"><img  src="site_images/miro_logo_bw.png" title="miro video converter" /></a>
-				</li>
-				<li class="footer_image">
-					 <a href="http://www.thefoundry.co.uk/support/"><img  src="site_images/nuke.png" title="nuke support" /></a>
-				</li>
-				<li class="footer_image">
-					 <a href="http://download.autodesk.com/global/docs/maya2012/en_us/index.html"><img  src="site_images/maya.png" title="maya 2012 help" /></a>
-				</li>
-				<li class="footer_image">
-					 <a href="http://www.python.org/about/help/"><img  src="site_images/python.png" title="python help" /></a>
-				</li>
-				<li class="footer_image">
-					 <a href="http://www.chaosgroup.com/en/2/support.html"><img  src="site_images/vray.png" title="vray support" /></a>
-				</li>
-				<li class="footer_image">
-					 <a href="https://renderman.pixar.com/forum/support.php"><img  src="site_images/prman.png" title="renderman support" /></a>
-				</li>
-			</ul>
 
-		</div>
+		<%= footer %>
+
 	</div>
 	
 	

data/lib/flak/thor/templates/doc/lib/helpers.rb

@@ -107,8 +107,12 @@ end
 # create markup for the header header
 def create_header
   body =  '<div id="header">'
+
+  body +='<ul id="logos">'
   r = "site_images/logo.jpg"
-  body +=  '<a href="http://www.reliancemediaworks.com/"><img class="logo" src="'+r+'" alt="logo" /></a>'
+  body +=  '<li><a href="http://www.reliancemediaworks.com/"><img class="logo" src="'+r+'" alt="logo" /></a></li>'
+  body +=  '<li><a href="images/module_logo.png"><img class="module_logo" src="images/module_logo.png" /></a></li>'
+  body +='</ul>'
   body += "<h3><b>#{@item[:type]}: </b> #{@item[:title]} </h3>"
   body += '</div>'  
 end
@@ -143,5 +147,24 @@ def create_meta
 
 end
 
+LOGOS = [
+  [ "www.mirovideoconverter.com" , "miro_logo_bw.png", "miro video converter"],
+  [ "www.thefoundry.co.uk/support" , "nuke.png", "nuke support"],
+  [ "download.autodesk.com/global/docs/maya2012/en_us/index.html" , "maya.png", "maya 2012 help"],
+  [ "www.python.org/about/help" , "python.png", "python help"],
+  [ "www.chaosgroup.com/en/2/support.html" , "vray.png", "vray support"],
+  [ "renderman.pixar.com/forum/support.php" , "prman.png", "renderman support"]
+]
+
+def footer
+  str = 	'<div id="footer"><ul>'
+  arr = LOGOS.collect do |logo|
+    '<li class="footer_image"><a href="http://'+logo[0]+'"><img  src="site_images/'+ logo[1]+'" title="'+logo[2]+'" /></a></li>'
+  end
+  str += arr.join("\n")
+  str += '</ul></div>'
+  str
+
+end
 
 

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

@@ -8,10 +8,8 @@ configuration:              "debug"
 # The name of your product of course.
 product_name:               "<%= name %>"
 
-# The revision number for your product. You can set it to any string
-# but it is recommended to include the name of the product so it can 
-# be recognized when it is deployed.
-product_revision:           "<%= name %>-0.0.1"
+# The revision number for your product. You can set it to any string.
+product_revision:           "0.0.1"
 
 # set to true if you dont want the os name appended to the release directory.
 # For example, if the module contains only cross platform scripts, there is

data/lib/flak/version.rb

@@ -1,3 +1,3 @@
 module Flak
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/flak.rb

@@ -23,6 +23,7 @@ require 'flak/rake/maya_plugin'
 require 'flak/rake/nuke'
 require 'flak/rake/target'
 require 'flak/rake/base'
+require 'flak/rake/mod'
 
 require 'flak/version'
 require 'flak/thor/wizard'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flak
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-02-27 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
-  requirement: &70319437889160 !ruby/object:Gem::Requirement
+  requirement: &70332259564940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70319437889160
+  version_requirements: *70332259564940
 - !ruby/object:Gem::Dependency
   name: awesome_print
-  requirement: &70319437886500 !ruby/object:Gem::Requirement
+  requirement: &70332259562220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70319437886500
+  version_requirements: *70332259562220
 - !ruby/object:Gem::Dependency
   name: nanoc
-  requirement: &70319437886080 !ruby/object:Gem::Requirement
+  requirement: &70332259561800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70319437886080
+  version_requirements: *70332259561800
 - !ruby/object:Gem::Dependency
   name: RedCloth
-  requirement: &70319437885660 !ruby/object:Gem::Requirement
+  requirement: &70332259593100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70319437885660
+  version_requirements: *70332259593100
 - !ruby/object:Gem::Dependency
   name: sass
-  requirement: &70319444337200 !ruby/object:Gem::Requirement
+  requirement: &70332259592680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70319444337200
+  version_requirements: *70332259592680
 description: VFX tool build and documentation framework based on rake with thor generators
 email:
 - julian.mann@gmail.com
@@ -92,6 +92,7 @@ files:
 - lib/flak/rake/maya.rb
 - lib/flak/rake/maya_app.rb
 - lib/flak/rake/maya_plugin.rb
+- lib/flak/rake/mod.rb
 - lib/flak/rake/nuke.rb
 - lib/flak/rake/target.rb
 - lib/flak/thor/cli.rb
@@ -135,6 +136,7 @@ files:
 - lib/flak/thor/templates/doc/content/install_guide.txt.tt
 - lib/flak/thor/templates/doc/content/release_notes.txt.tt
 - lib/flak/thor/templates/doc/content/scenes/.empty_directory
+- lib/flak/thor/templates/doc/content/scenes/module_logo.psd
 - lib/flak/thor/templates/doc/content/tutorial.txt.tt
 - lib/flak/thor/templates/doc/layouts/default.html
 - lib/flak/thor/templates/doc/lib/helpers.rb
@@ -147,6 +149,7 @@ files:
 - lib/flak/thor/templates/maya.tt
 - lib/flak/thor/templates/maya_app.tt
 - lib/flak/thor/templates/maya_plugin.tt
+- lib/flak/thor/templates/mod.tt
 - lib/flak/thor/templates/nuke.tt
 - lib/flak/thor/templates/product.mel.tt
 - lib/flak/thor/templates/product.sh.tt