flak 0.0.5 → 0.0.6

data/.yardoc/checksums

@@ -1,4 +1,4 @@
-lib/flak.rb d340bce937784bfcd1bbebaa86084ae5af9e4a82
+lib/flak.rb ee76cae2b3d1e295f430233fef08dae83723cc9f
 lib/flak/version.rb cd35ff13292bbc0b507250bda64b36af61a34f36
 lib/flak/rake/os.rb c1b4e0d66a5df3aab590d76d5d1f37e04dd451c9
 lib/flak/thor/cli.rb 115ee363faf9e37032ad28b120b2a7de1b9f1cc1

data/Architecture.md

@@ -7,7 +7,7 @@ Flak Architecture
 When you type rake, the Rakefile is executed. It builds {Flak::Target} objects, one for the project, and one for each tool. The process is started by reading the contents of project.yml and any tool.yml file it finds. There is a project.yml at the project root and a tool.yml at the root of each tool. We call these files target files. 
 
 
-<img src= ../target.jpg />
+<img src="http://flak.s3.amazonaws.com/target.jpg"/>
 
 * The name of a target yml file is either tool.yml or project.yml. It is used to build a Target object.
 * A Target extends itself with settings, methods, and tasks from templates specified in the target yml file.
@@ -62,11 +62,11 @@ Some settings keys are required for building other settings - for example `:prod
 
     settings[:product_revision] is not a String. It is a NilClass. (environment.rb)
 
-Other keys are not required until build time - for example `:include_flag` is used when rake tasks are run, in this case during compilation. If it is missing you will still get a red error, but you will also be able to run `rake -T` to view the entire settings hash. You might see there is a typo such as `:includ_flag`
+Other keys are not required until build time - for example `:include_flag` is used when rake tasks are run, in this case during compilation. If it is missing you will still get a red error, but you will also be able to run `rake -T` to see available rake tasks, and `rake <target_name>:inspect` to view the entire settings hash. You might see there is a typo such as `:includ_flag`
 
 ##Methods##
 
-A Target object also inherits instance methods from the templates it extends. These instance methods provide functionality to the tasks that could not be provided by settings values alone. An example is building a C compile command. As these extended instance methods are only used by tasks when they are run, all the settings will be in place and therefore these methods have access to the `@settings` instance variable.
+A Target object also inherits instance methods from the templates it extends. These instance methods provide functionality to the tasks that could not be provided by settings values alone. An example is building a C compile command. As these extended instance methods are only used by tasks when they are run, all the settings will be in place and therefore these methods have access to the fully resolved settings via the `@settings` instance variable.
 
 ##Tasks##
 

data/MayaModules.md

@@ -1,2 +1,4 @@
 Maya Module Installation
 ======
+
+If a flak module contains maya tools then it will be implemented as a Maya Module. 

data/flak.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |s|
   s.version     = Flak::VERSION
   s.authors     = ["Julian Mann"]
   s.email       = ["julian.mann@gmail.com"]
-  s.homepage    = ""
+  s.homepage    = "https://bitbucket.org/rmwcs/flak"
   s.summary     = %q{build system for VFX tools}
   s.description = %q{VFX tool build and documentation framework based on rake with thor generators}
   s.add_dependency('thor')
@@ -29,6 +29,3 @@ Gem::Specification.new do |s|
   s.has_rdoc = 'yard'
 
 end
-
-
-

data/lib/flak.rb

@@ -13,6 +13,8 @@ require 'core_ext/string'
 require 'core_ext/hash'
 
 
+
+
 require 'flak/rake/file_actions'
 require 'flak/rake/os'
 require 'flak/rake/errors'

data/lib/flak/rake/template.rb

@@ -0,0 +1,16 @@
+
+
+
+# module Flak
+# 
+#   class Template
+# 
+#     def initialize
+# 
+# 
+#     end
+# 
+#   end
+# 
+# end
+

data/lib/flak/rake/template_dsl.rb

@@ -0,0 +1,147 @@
+
+######## FILE NOT IN USE
+
+
+Template.new('MayaApp') do
+
+  settings do
+
+    maya_string =''
+    case settings[:os]
+    when /linux_64/ 
+      maya_string = "maya#{settings[:maya_version]}-x64"
+    when /darwin/
+      maya_string = "maya#{settings[:maya_version]}"
+    when /win_64/
+      maya_string = "Maya#{settings[:maya_version]}"
+    end
+
+    mods = Hash.new
+
+    bind = binding()
+    Flak::Errors.assert("settings[:autodesk_location]", "String", bind,__FILE__)
+    Flak::Errors.assert("settings[:path_to_revision]", "String", bind,__FILE__)
+    mods[:maya_location] =  File.join(   settings[:autodesk_location],maya_string )
+
+
+    mods[:maya_release_path] = File.join(  settings[:path_to_revision],"maya" )
+
+    mods
+
+  end
+
+
+
+  methods do 
+
+    def outliner_icon_build_filename(file)
+      icon_build_filename("out_#{file}")
+    end
+
+    def dg_icon_build_filename(file)
+      icon_build_filename(file)
+    end
+
+    def icon_build_filename(file)
+      bind = binding()
+      Flak::Errors.assert("@settings[:build_directory]", "String", bind,__FILE__)
+      File.join(@settings[:build_directory],'icons', file.pathmap('%f').ext('xpm') ) 
+    end
+
+
+  end
+
+
+  tasks do
+
+    def self.generate_node_icon_tasks target
+      settings = target.settings
+
+
+      source_files = settings[:maya_node_icon_files]
+      unless source_files.nil?
+
+        source_files.each do |f|
+
+          ['outliner','dg'].each do |t|
+
+            build_file = target.send "#{t}_icon_build_filename", f
+
+            dest_file = destination_filepath( settings[:maya_icon_destination], build_file)
+
+            file build_file => f do |t|
+              target.make_directory_for(build_file)
+              cmd_key = "#{t}_icon_convert_cmd".to_sym
+              cmd = "#{settings[cmd_key]} #{f} #{build_file}"
+              sh cmd
+            end
+
+            file dest_file => build_file do |t|
+              target.make_directory_for(dest_file)
+              cp build_file, dest_file 
+            end         
+
+            task :release => dest_file 
+          end
+        end
+      end
+    end
+
+
+
+
+
+
+    def self.generate_icon_tasks target
+      settings = target.settings
+
+
+      source_files = settings[:maya_icon_files]
+      unless source_files.nil?
+
+        source_files.each do |f|
+
+          build_file = target.icon_build_filename f
+
+          dest_file = destination_filepath( settings[:maya_icon_destination], build_file)
+
+          file build_file => f do |t|
+            target.make_directory_for(build_file)
+            cmd = "#{settings[:icon_convert_cmd]} #{f} #{build_file}"
+            sh cmd
+          end
+
+          file dest_file => build_file do |t|
+            target.make_directory_for(dest_file)
+            cp build_file, dest_file 
+          end         
+
+          task :release => dest_file 
+
+        end
+      end
+    end
+
+
+
+
+
+
+
+    # generate tasks here
+    ################################################################################
+    def self.task_factory target
+      settings = target.settings
+      self.generate_node_icon_tasks target
+      self.generate_icon_tasks target
+    end
+
+
+
+
+  end
+
+
+
+
+end 

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

@@ -100,7 +100,5 @@ module Flak::Template
   end
 
 
-
-
 end
 

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

@@ -93,7 +93,7 @@ module Flak::Template
 
               build_file = target.send "#{t}_icon_build_filename", f
 
-              dest_file = destination_filepath( settings[:maya_icon_destination], build_file)
+              dest_file = target.destination_filepath( settings[:maya_icon_destination], build_file)
 
               file build_file => f do |t|
                 target.make_directory_for(build_file)
@@ -129,7 +129,7 @@ module Flak::Template
 
             build_file = target.icon_build_filename f
 
-            dest_file = destination_filepath( settings[:maya_icon_destination], build_file)
+            dest_file = target.destination_filepath( settings[:maya_icon_destination], build_file)
 
             file build_file => f do |t|
               target.make_directory_for(build_file)

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

@@ -1,3 +1,9 @@
+
+
+
+
+
+
 module Flak::Template
 
   module MayaApp

data/lib/flak/thor/generate.rb

@@ -50,8 +50,9 @@ module Flak
       self.name = name
       empty_directory("build") 
       directory("doc")
+      empty_directory("plugins")
       directory("config")
-
+      create_file "#{name}/LICENSE"
       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"                    )
@@ -122,7 +123,7 @@ module Flak
       def create_common_files
         empty_directory("#{name}/examples") 
         create_file "#{name}/README"
-        create_file "#{name}/LICENSE"
+        #  create_file "#{name}/LICENSE"
         # create_file "INSTALL.md"
       end
     
@@ -147,6 +148,29 @@ module Flak
       end
     end
 
+
+
+
+    desc "plugin [name]", "Create a plugin"
+    map "u" => :plugin    
+    # The plugin subcommand.  Called with: flak generate plugin <name>.
+    # Creates an example plugin with the given name inside a flak project.
+    def plugin(name)
+      self.name= name
+       template("plugin.yml.tt", "config/#{name}.yml")
+       template("plugin.rb.tt", "plugins/#{name}.rb")
+       
+       say("The plugin was created in plugins/#{name}.rb and a config file was made in config/#{name}.yml")
+       say("To use this plugin, edit tool.yml") 
+       say("Add '#{name}' to the templates section, and add files needed by this plugin to a file list")
+       say("See comments in plugins/#{name}.rb for more details")
+
+    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)

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

@@ -1,11 +1,18 @@
 require 'flak'
 
+# need this for rake > 0.8.7
 include Rake::DSL
 
 verbose(true)
 
 root = File.dirname(__FILE__)
 
+# load user plugins
+dir = "plugins"
+$LOAD_PATH.unshift(dir)
+Dir[ File.join(dir, "*.rb") ].each {|file| require File.basename(file,".rb") }
+
+# create targets
 FileList.new('**/tool.yml','project.yml').each do |path|
     Flak::Target.new(root, path).build
 end

data/lib/flak/thor/templates/plugin.rb.tt

@@ -0,0 +1,219 @@
+module Flak::Template
+
+  # This example illustrates how to make a plugin template for Flak.
+  # This is a rather complex example, intended to show all parts of the plugin.
+  # It has a 2 step build->release process. See other template modules in flak for 
+  # more and less complex examples.
+  #
+  # The module <%=name.camelize%> contains 2 modules: Settings and Tasks
+  # The settings hash and any instance methods are managed in the Settings module
+  # Rake Tasks are built in the Tasks module.
+  # Both modules must exist in a plugin
+  #
+  # This plugin example relies on some settings to be declared in <%=name%>.yml and it needs files to work on.
+  # To test the plugin as is you'll need to add the following lines to tool.yml 
+  # for the tool that will use this plugin. (without '#'s of course)
+  # <%=name%>_include_paths:
+  # - '<%=name%>_src/inc/*.*'
+  # <%=name%>_src_files:
+  # - '<%=name%>_src/geo/*.*'
+  # - '<%=name%>_src/light/*.*'
+  # - '<%=name%>_src/shader/*.*'
+  #
+  # - and make some files that fit the above file globs.
+  #
+  # Also, in the same file, add - '<%=name%>' to the list of templates
+  #
+  # You'll notice you also have <%=name%>.yml in the config directory now
+  module <%=name.camelize%>
+
+
+    module Settings
+
+      extend Flak::Template::MergeEngine
+
+      # At the time the Target object extends with this plugin's Settings module, we call {Flak::Template::MergeEngine#infuse}
+      # which takes care of reading the associated <%=name%>.yml if it exists, flattening it, merging it
+      # with the modifications made below, and finally merging the whole lot into the Target.
+      # @param target [Target] the object that will receive settings from this module
+      def self.extended target
+        infuse target
+      end
+
+      # Create new keys for the settings hash programatically.
+      # The target's settings hash is available to use to make new values. For example, building new paths from components.
+      # This method is called automatically by the infuse method above. You only need to be concerned with
+      # creating the new keys and values you want, and returning them. Merging into target's settings is taken care of.
+      # @param settings [Hash] the target's settings hash.
+      def self.settings_modifications settings
+        mods = Hash.new
+
+        bind = binding()
+        Flak::Errors.assert("settings[:<%=name%>_location]", "String", bind,__FILE__)
+        Flak::Errors.assert("settings[:<%=name%>_version]", "String", bind,__FILE__)
+        Flak::Errors.assert("settings[:build_directory]", "String", bind,__FILE__)
+
+        <%=name%>_version_location =  File.join( "#{settings[:<%=name%>_location]}-#{settings[:<%=name%>_version]}" )
+
+        mods[:<%=name%>_compiler] =       File.join( <%=name%>_version_location, "bin","fcompile")
+
+        mods[:<%=name%>_build_directory] =      settings[:build_directory]
+
+        mods[:libs] =                  ["<%=name.camelize%>"]
+
+        mods[:<%=name%>_include_paths] = [ File.join( <%=name%>_version_location, "extra","finc") ] 
+
+        mods  
+      end
+
+
+
+
+      # Generate names for output build files from the list of source files
+      # @return [Array] filenames
+      def <%=name%>_out_files()
+        @settings[:<%=name%>_src_files].collect { |f| <%=name%>_out_file(f) }
+      end
+
+      # Generate a name for an output build file.
+      # As we need @settings[:<%=name%>_build_directory], we test its existence first.
+      # We pull the original filepath apart and rebuild the way we want. In this case
+      # we turn /toolname/geo/name.ext into geo/name_geo.flib
+      # 
+      # @param source [String] source file
+      # @return [String] destination file
+      def <%=name%>_out_file(source)
+        bind = binding()
+        Flak::Errors.assert("@settings[:<%=name%>_build_directory]", "String", bind,__FILE__)
+
+        type = source.pathmap('%d').pathmap('%f')
+        dirname = source.pathmap('%d')
+        basename = source.pathmap('%f')
+        File.join(@settings[:<%=name%>_build_directory], dirname, "#{basename.pathmap('%X')}_#{type}.flib")
+      end
+
+
+
+      # As this is an example, there is no such thing as a <%=name%> compiler and we can't compile with it. 
+      # So, to show how it would work, the fictitious compile command will be written into each file.
+      # The actual command we issue is echo with a redirect into the destination.
+      # 
+      # @param src [String] the source filepath
+      # @param dest [String] the destination filepath
+      # @return [String] the full compile command
+      def <%=name%>_compile_cmd(src, dest)  
+        bind = binding()
+        Flak::Errors.assert("@settings[:<%=name%>_compiler]", "String", bind,__FILE__)
+
+        include_path_string = (@settings[:<%=name%>_src_files].collect {|f| f.pathmap('%d')}.uniq | ( @settings[:<%=name%>_include_paths] || [] )).collect { |el| "-I#{el.to_s}" }.join(" ")
+        <%=name%>_type_string = "-DFOO_TYPE_#{src.pathmap('%d').pathmap('%f').upcase}"
+        "echo The compile cmd is: #{@settings[:<%=name%>_compiler]}  #{<%=name%>_type_string}  #{include_path_string} -d #{dest} #{src} > #{dest}" 
+      end
+
+      # list of files to add to clean task
+      def <%=name%>_clean_cmd
+        "rm -f  #{<%=name%>_out_files}"
+      end
+
+
+
+
+    end
+
+
+
+
+    module Tasks
+
+      # when the target is extended with the <%=name.camelize%> Tasks module, the task_factory is called and all tasks are made.
+      def self.extended target
+        task_factory target
+      end
+
+      # task_factory creates Rake tasks. These tasks are built dynamically based on the list of
+      # sources. There are 2 types of rake tasks. tasks, and file tasks.
+      # tasks start with the task keyword. 
+      # file tasks start with the file keyword.
+      # see {http://martinfowler.com/articles/rake.html Martin Fowler's Rake page} for an explanation
+      # of Rake tasks. 
+      def self.task_factory target
+        settings = target.settings
+
+        files = settings[:<%=name%>_src_files]
+        unless files.nil?
+
+          files.each do |f|
+
+
+            # create file tasks to compile out_files from sources
+            out_file = target.<%=name%>_out_file(f)    
+            file out_file => f  do |t|
+              target.make_directory_for(out_file)
+              sh target.<%=name%>_compile_cmd(f,out_file) 
+            end
+
+
+            # add the out_file task to the ToolName:build named task
+            namespace settings[:name].to_sym do        
+              task :build => out_file
+            end
+
+
+
+
+            # create file tasks to release out_files to release destination
+            release_file = target.destination_filepath(settings[:<%=name%>_destination],out_file)
+            file release_file => out_file do
+              target.make_directory_for(release_file)
+              cp out_file, release_file 
+            end
+
+
+            # add the release_file task to the ToolName:release named task
+            namespace settings[:name].to_sym do        
+              task :release => release_file
+            end
+
+
+            # add the ToolName:release named task to the top level :release named task         
+            task :release => "#{settings[:name].to_sym}:release"
+
+          end
+
+
+          # task to clean the build files for ToolName
+          namespace settings[:name].to_sym do     
+            desc "clean the #{settings[:name].to_sym} build files"
+            task :clean do
+              sh target.<%=name%>_clean_cmd
+            end
+
+
+          end
+
+
+          # add the ToolName:clean named task to the top level :clean named task     
+          task :clean => "#{settings[:name].to_sym}:clean"
+
+
+          namespace settings[:name].to_sym do      
+            desc "build the #{settings[:name].to_sym} <%=name%> resource"  
+            task :build 
+          end
+
+
+          # add the ToolName:build named task to the top level :build named task
+          task :build => "#{settings[:name].to_sym}:build"
+
+        end
+
+
+
+      end
+
+    end
+
+  end
+
+end
+

data/lib/flak/thor/templates/plugin.yml.tt

@@ -0,0 +1,12 @@
+<%=name%>_version: '10.0.0'
+
+<%=name%>_destination: '<%=name%>/lib'
+
+os_linux_64:
+    <%=name%>_location: '/usr/<%=name%>_co'
+    
+os_darwin:
+    <%=name%>_location: '/Applications/<%=name.camelize%>Co'
+    
+os_win_64:
+    <%=name%>_location: 'C:/Program Files/<%=name.camelize%> Co'

data/lib/flak/version.rb

@@ -1,3 +1,3 @@
 module Flak
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flak
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-10 00:00:00.000000000 Z
+date: 2012-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
-  requirement: &70316772857580 !ruby/object:Gem::Requirement
+  requirement: &70196421321380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70316772857580
+  version_requirements: *70196421321380
 - !ruby/object:Gem::Dependency
   name: awesome_print
-  requirement: &70316772852520 !ruby/object:Gem::Requirement
+  requirement: &70196421317620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70316772852520
+  version_requirements: *70196421317620
 - !ruby/object:Gem::Dependency
   name: nanoc
-  requirement: &70316772852080 !ruby/object:Gem::Requirement
+  requirement: &70196421317020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70316772852080
+  version_requirements: *70196421317020
 - !ruby/object:Gem::Dependency
   name: sass
-  requirement: &70316772851280 !ruby/object:Gem::Requirement
+  requirement: &70196421316500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70316772851280
+  version_requirements: *70196421316500
 - !ruby/object:Gem::Dependency
   name: RedCloth
-  requirement: &70316772850740 !ruby/object:Gem::Requirement
+  requirement: &70196421316040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70316772850740
+  version_requirements: *70196421316040
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &70316772850000 !ruby/object:Gem::Requirement
+  requirement: &70196421315480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -76,10 +76,10 @@ dependencies:
         version: 0.7.2
   type: :development
   prerelease: false
-  version_requirements: *70316772850000
+  version_requirements: *70196421315480
 - !ruby/object:Gem::Dependency
   name: redcarpet
-  requirement: &70316772848780 !ruby/object:Gem::Requirement
+  requirement: &70196421314960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,7 +87,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70316772848780
+  version_requirements: *70196421314960
 description: VFX tool build and documentation framework based on rake with thor generators
 email:
 - julian.mann@gmail.com
@@ -116,6 +116,8 @@ files:
 - lib/flak/rake/file_actions.rb
 - lib/flak/rake/os.rb
 - lib/flak/rake/target.rb
+- lib/flak/rake/template.rb
+- lib/flak/rake/template_dsl.rb
 - lib/flak/rake/templates/cpp.rb
 - lib/flak/rake/templates/delight.rb
 - lib/flak/rake/templates/doc.rb
@@ -190,12 +192,14 @@ files:
 - lib/flak/thor/templates/maya_plugin_cpp.tt
 - lib/flak/thor/templates/name_cpp.tt
 - lib/flak/thor/templates/name_h.tt
+- lib/flak/thor/templates/plugin.rb.tt
+- lib/flak/thor/templates/plugin.yml.tt
 - lib/flak/thor/templates/product.mel.tt
 - lib/flak/thor/templates/product.sh.tt
 - lib/flak/thor/wizard.rb
 - lib/flak/version.rb
 - target.jpg
-homepage: ''
+homepage: https://bitbucket.org/rmwcs/flak
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -215,7 +219,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: flak
-rubygems_version: 1.8.10
+rubygems_version: 1.8.17
 signing_key: 
 specification_version: 3
 summary: build system for VFX tools