dokkit 0.3.0 → 0.4.0

data/lib/dokkit/pathhelper.rb

@@ -1,46 +0,0 @@
-#                                                                          
-# File 'pathhelper.rb' created on 15 feb 2008 at 16:33:15.                    
-#
-# See 'dokkit.rb' or +LICENSE+ for licence information.                      
-#                                                                          
-# (C) 2006, 2007 Andrea Fazzi <andrea.fazzi@alca.le.it> (and contributors). 
-#                                                                          
-
-module Dokkit
-  module PathHelper
-    def strip_ext(fn)
-      ext = File.extname(fn)
-      fn.sub(/#{ext}/, '')
-    end
-    # Get a new filename from a given filename substituting the
-    # sub_dir portion of the given file with new_dir and the file
-    # extension with new_ext. 
-    #
-    # Example:
-    #
-    # filename_helper('output/subdir/document.output', 'output', 'doc/pages', '.in')
-    #
-    # should return:
-    #
-    # => 'doc/pages/subdir/document.in'
-    #
-    def filename_helper(fn, sub_dir, new_dir, new_ext = '')
-      ext = File.extname(fn).sub(/^\./,'') # strip leading dot
-      new_fn = fn.sub(/#{sub_dir}/, new_dir)
-      new_fn = new_fn << new_ext unless new_ext.empty?
-      new_fn
-    end    
-    def output_fn_helper(fn, output_ext, config)
-      filename_helper(fn, config.document_dir, config.output_dir, output_ext)      
-    end
-    def layout_fn_helper(fn, layout_ext, config)
-      filename_helper(fn, config.document_dir, config.layout_dir, layout_ext)
-    end        
-    def config_fn_helper(fn, config)
-      filename_helper(fn, config.document_dir, config.config_dir, '.yaml')
-    end
-    def data_fn_helper(fn, config)
-      filename_helper(fn, config.data_dir, config.output_dir)      
-    end
-  end
-end

data/lib/dokkit/recursivemerge.rb

@@ -1,59 +0,0 @@
-#                                                                          
-# File 'recursivemerge.rb' created on 17 mar 2008 at 09:37:25.                    
-#
-# See 'dokkit.rb' or +LICENSE+ for licence information.                      
-#                                                                          
-# (C) 2008 Andrea Fazzi <andrea.fazzi@alca.le.it> (and contributors). 
-#                                                                          
-
-class Hash
-  def recursive_store(key, value, other_value = nil)
-    if(value.class == Hash && other_value.class == Hash)
-      value.recursive_merge other_value
-    else
-     store(key, other_value)
-    end
-  end
-  # Hash#recursive_merge merges two arbitrarily deep hashes into a single hash. 
-  # The hash is followed recursively, so that deeply nested hashes that are at 
-  # the same level will be merged when the parent hashes are merged.
-  def recursive_merge!(other_hash, &blk)
-    if block_given?
-      merge!(other_hash, &blk)
-    else
-      merge!(other_hash) do |key, value, other_value|
-        recursive_store(key, value, other_value)
-      end
-    end
-  end
-  # Non-destructive version of Hash#recursive_merge method.
-  def recursive_merge(other_hash, &blk)
-    clone.recursive_merge!(other_hash, &blk)
-  end
-end
-
-module ConfigHash
-  def recursive_store(key, value, other_value)
-    unless (key.to_sym == :layout || key.to_sym == :config)
-      if(value.class == Hash && other_value.class == Hash)
-        value.extend ConfigHash
-        other_value.extend ConfigHash
-        value.recursive_merge other_value
-      elsif(value.class == Array && other_value.class == Array)
-        value.concat(other_value)
-      elsif(value.class == String && other_value.class == Array)
-        value.to_a.concat(other_value)
-      elsif(value.class == Array && other_value.class == String)
-        value << other_value
-      else
-        store(key, other_value)
-      end
-    else
-      if(value.class == Hash && other_value.class == Hash)
-        value.recursive_merge other_value
-      else
-        store(key, other_value)
-      end
-    end
-  end
-end

data/lib/dokkit/rendertask.rb

@@ -1,101 +0,0 @@
-#                                                                          
-# File 'rendertask.rb' created on 18 feb 2008 at 17:47:44.                    
-#
-# See 'dokkit.rb' or +LICENSE+ for licence information.                      
-#                                                                          
-# (C) 2008 Andrea Fazzi <andrea.fazzi@alca.le.it> (and contributors). 
-#                                                                          
-
-require 'rake/tasklib'
-require 'dokkit/document'
-require 'dokkit/pathhelper'
-require 'dokkit/dokkitlib'
-require 'dokkit/fileselection'
-
-module Dokkit
-  class RenderTask < DokkitLib
-    attr_accessor :documents, :data
-    def initialize(model, namespace = 'render')
-      super(model, namespace, { :check_dir => true })
-    end
-    
-    private
-    
-    def pre_block_configuration
-      @config.document_dir ||= Dokkit::DEFAULT_DOCUMENT_DIR
-      @config.data_dir ||= Dokkit::DEFAULT_DATA_DIR
-      @config.output_dir ||= Dokkit::DEFAULT_OUTPUT_DIR
-      @config.layout_dir ||= Dokkit::DEFAULT_LAYOUT_DIR
-      @config.config_dir ||= Dokkit::DEFAULT_CONFIG_DIR      
-      @config.cache_dir ||= Dokkit::DEFAULT_CACHE_DIR            
-      @documents = FileSelection.new(@config.document_dir) do |fs| 
-        fs.include('*') 
-        fs.exclude('*.yaml')
-      end
-      @documents.extend ExtMapping
-      @data = FileSelection.new(@config.data_dir) { |fs| fs.include('*') }
-    end
-    def post_block_configuration
-      data.dir = @config.data_dir
-      documents.dir = @config.document_dir
-    end
-    def define_document_task(document)
-      targets = document.targets
-      source_fn = document.document
-      targets.each do |format, target_fn|
-        file target_fn => document.prerequisites[format] do
-          dn = File.dirname(target_fn)
-          mkdir_p(dn, :verbose => false) unless File.exists?(dn)
-          @logger.info("Render #{target_fn}")
-          File.open(target_fn, 'w+') do |f|
-            f << document.render(format)
-          end
-        end
-      end
-      targets.values
-    end    
-    def define_document_tasks
-      unless documents.files.empty?
-        documents.files.collect do |source_fn|
-          blk = documents.extmapping[source_fn] if documents.extmapping
-          define_document_task Document.new(source_fn, config, &blk)
-        end
-      else @logger.error("No documents found in '#{@config.document_dir}'")
-      end
-    end
-    def define_dokkit_render_doc_task
-      dokkit_task :doc => define_document_tasks.flatten!
-      task(:doc).comment = 'Render documents'      
-    end
-    def define_dokkit_render_all_task
-      dokkit_task :all => ["#{@ns}:doc", "#{@ns}:data"]
-      task(:all).comment = 'Render documents and copy data'      
-    end
-    def define_data_task(source_fn)
-      target_fn = data_fn_helper(source_fn, config)
-      file target_fn => source_fn do
-        dn = File.dirname(target_fn)
-        mkdir_p(dn, :verbose => false) unless File.exists?(dn)
-        @logger.info("Copy #{target_fn}")
-        cp(source_fn, target_fn, :preserve => true, :verbose => false)        
-      end
-      target_fn      
-    end    
-    def define_data_tasks
-      unless data.files.empty?
-        data.files.collect do |source_fn|
-          define_data_task(source_fn)
-        end
-      end
-    end
-    def define_dokkit_copy_all_data_task
-      if data_tasks = define_data_tasks
-        dokkit_task :data => data_tasks
-      else
-        dokkit_task :data
-      end
-      task(:data).comment = 'Copy data files only'      
-    end
-  end
-end
-

data/lib/dokkit/resourcemanager.rb

@@ -1,177 +0,0 @@
-#                                                                          
-# File 'resourcemanager.rb' created on 06 feb 2008 at 21:44:10.                    
-#
-# See 'dokkit.rb' or +LICENSE+ for licence information.                      
-#                                                                          
-# (C) 2006, 2007 Andrea Fazzi <andrea.fazzi@alca.le.it> (and contributors). 
-#                                                                          
-
-require 'dokkit'
-require 'dokkit/hash'
-require 'dokkit/cachemanager'
-require 'dokkit/fileselection'
-
-DOCUMENT_DIR = 'doc/pages/'
-OUTPUT_DIR = 'output/'
-LAYOUT_DIR = 'doc/layouts/'
-CONFIG_DIR = 'doc/configs/'
-DATA_DIR = 'doc/data/'
-
-module Dokkit
-  module DocumentManager
-    attr_accessor :document_dir
-    attr_accessor :documents
-    def documentmanager_defaults
-      @document_dir = DOCUMENT_DIR
-      @documents = FileSelection.new(@document_dir) { |fs| fs.include('*') }
-    end
-  end
-  module OutputManager
-    attr_accessor :output_dir
-    attr_accessor :output_ext
-    attr_reader :outputs
-    def outputmanager_defaults
-      @output_dir = OUTPUT_DIR
-      @output_ext = '.html'
-      @outputs = { }
-    end
-    
-    private
-    
-    def collect_outputs
-      @documents.files.each do |document|
-        if(@config[document]['document'].has_key?('render'))
-          output_ext = @config[document]['document']['render']['ext'] if @config[document]['document']['render']['ext']
-          output_dir = @config[document]['document']['render']['output'] if @config[document]['document']['render']['output']
-          @outputs[document] = File.join(@output_dir, output_dir, File.basename(document)) + output_ext
-        else
-          @outputs[document] = output_fn_helper(document)
-        end
-      end
-    end
-    def output_fn_helper(fn, output_ext = @output_ext)
-      filename_helper(fn, document_dir, output_dir, output_ext)      
-    end
-  end
-  module DataManager
-    attr_accessor :data_dir
-    attr_reader :data
-    
-    def datamanager_defaults
-      @data_dir = DATA_DIR
-      @data =  Dokkit::FileSelection.new(@data_dir) { |fs| fs.include('*') }
-    end
-    def data_fn_helper(fn)
-      filename_helper(fn, data_dir, output_dir)      
-    end
-  end
-  module ConfigManager
-    attr_accessor :config_dir
-    attr_reader :configs
-    attr_reader :config
-    def configmanager_defaults
-      @config_dir = 'doc/configs/'
-      @configs = { }
-      @config = { }
-    end
-    def resolve_common_configs(document)
-      FileList.new(File.join(document_dir, '**/COMMON.yaml')).exclude(/#{File.dirname(document)}\/.*\/.*/).reverse!
-    end      
-    def collect_configs
-      @documents.files.each do |document|
-        @configs[document] = []
-        @configs[document] << (config_fn_helper(document)) if File.exists?(config_fn_helper(document))
-        @configs[document].concat(resolve_common_configs(document))
-        @configs[document] << (document + '.yaml') if File.exists?(document + '.yaml')
-      end
-      @configs      
-    end
-    
-    private
-    
-    def load_configs
-      collect_configs.each do |document, configs|
-        @config[document] = { }
-        configs.each do |fn|
-          @config[document].recursive_merge!(YAML::load(File.open(fn)))
-          if @config[document].has_key?('document') 
-            if @config[document]['document'].has_key?('config')
-              @configs[document] << @config[document]['document']['config'] + '.yaml'
-              @config[document]['document'].delete('config')
-            end
-          end
-        end
-      end
-      @config
-    end    
-    def config_fn_helper(fn)
-      filename_helper(fn, document_dir, config_dir, '.yaml')
-    end
-  end
-  module LayoutManager
-    attr_accessor :layout_dir
-    attr_reader :layouts
-    def layoutmanager_defaults
-      @layout_dir = 'doc/layouts/'
-      @layouts = { }
-    end
-    def collect_layouts
-      @documents.files.each do |document|
-        @layouts[document] = []
-        @layouts[document] << (layout_fn_helper(document)) if File.exists?(layout_fn_helper(document))
-        @layouts[document] << (document + '.html') if File.exists?(document + '.html')
-        if @config[document]['document']['layout']
-          @layouts[document] = (@config[document]['document']['layout'] + '.html') if File.exists?(@config[document]['document']['layout'] + '.html')
-        end  
-     end
-      @layouts 
-    end
-    
-    private
-    
-    def layout_fn_helper(fn)
-      filename_helper(fn, document_dir, layout_dir, '.html')
-    end    
-  end
-  class ResourceManager
-    include DocumentManager, OutputManager, ConfigManager, LayoutManager, DataManager
-    def initialize
-      set_defaults
-
-      yield self if block_given?
-
-      load_configs
-      collect_outputs
-      collect_layouts
-    end
-    
-    def set_defaults
-      documentmanager_defaults
-      outputmanager_defaults
-      configmanager_defaults
-      layoutmanager_defaults
-      datamanager_defaults
-    end
-
-    private
-
-    # Get a new filename from a given filename substituting the
-    # sub_dir portion of the given file with new_dir and the file
-    # extension with new_ext. 
-    #
-    # Example:
-    #
-    # filename_helper('output/subdir/document.output', 'output', 'doc/pages', '.in')
-    #
-    # should return:
-    #
-    # => 'doc/pages/subdir/document.in'
-    #
-    def filename_helper(fn, sub_dir, new_dir, new_ext = '')
-      ext = File.extname(fn).sub(/^\./,'') # strip leading dot
-      new_fn = fn.sub(/#{sub_dir}/, new_dir)
-      new_fn = new_fn << new_ext unless new_ext.empty? #new_fn.sub(/#{ext}$/, new_ext) unless new_ext.empty?
-      new_fn
-    end
-  end
-end

data/lib/dokkit/taskconfig.rb

@@ -1,39 +0,0 @@
-#                                                                          
-# File 'taskconfig.rb' created on 29 feb 2008 at 07:50:50.                    
-#
-# See 'dokkit.rb' or +LICENSE+ for licence information.                      
-#                                                                          
-# (C) 2008 Andrea Fazzi <andrea.fazzi@alca.le.it> (and contributors). 
-#                                                                          
-
-require 'ostruct'
-
-module Dokkit
-  class TaskConfig < OpenStruct
-    STRIP_SLASHES = /^\/?(.*?)\/*$/
-    attr_reader :config, :directories
-    def initialize(hash = nil)
-      super(hash)
-      @directories = { }
-      
-      yield self if block_given?
-      
-      strip_slashes_from_dir
-    end
-    def directories
-      methods.each do |meth|
-        @directories[meth.to_sym] = send(meth.to_sym) if (meth =~ /\_dir$/)
-      end
-      @directories
-    end
-    
-    private
-    
-    def strip_slashes_from_dir
-      directories.each do |meth, dir|
-        stripped_dir = send(meth)[STRIP_SLASHES, 1]
-        send((meth.to_s + '=').to_sym, stripped_dir)
-      end
-    end
-  end
-end

data/lib/dokkit/templatetask.rb

@@ -1,37 +0,0 @@
-#                                                                          
-# File 'templatetask.rb' created on 03 mar 2008 at 13:16:03.                    
-#
-# See 'dokkit.rb' or +LICENSE+ for licence information.                      
-#                                                                          
-# (C) 2008 Andrea Fazzi <andrea.fazzi@alca.le.it> (and contributors). 
-#                                                                          
-
-require 'dokkit/dokkitlib'
-
-module Dokkit
-  class TemplateTask < DokkitLib
-    def initialize(model, namespace = 'template')
-      super(model, namespace, { :check_dir => true })
-    end
-    
-    private
-    
-    def pre_block_configuration
-      @config.template_dir ||= Dokkit::DEFAULT_TEMPLATE_DIR
-    end
-    def define_dokkit_create_template
-      desc "Copy the template to the given directory."
-      dokkit_task 'create', :template do |t, args|
-        template_fn = File.join(@config.template_dir, args.template)
-        @logger.error("Template '#{args.template}' doesn't exist") unless File.exists?(template_fn)
-        if ARGV.size == 2
-          dest_fn = t.application.top_level_tasks.pop
-        else
-          dest_fn = File.join('doc', args.template)          
-        end
-        @logger.info("Copy template '#{File.basename(template_fn)}' to '#{dest_fn}'")
-        cp(template_fn, dest_fn, :preserve => true, :verbose => false)
-      end
-    end
-  end
-end

data/spec/app_spec.rb

@@ -1,55 +0,0 @@
-#                                                                          
-# File 'app_spec.rb' created on 20 feb 2008 at 20:15:42.                    
-# See 'dokkit.rb' or +LICENSE+ for licence information.                      
-#                                                                          
-# (c)2008 Andrea Fazzi <andrea.fazzi@alca.le.it> (and contributors). 
-#                                                                          
-# To execute this spec run:                                            
-#                                                                          
-# spec spec/app_spec.rb                                                  
-#                                                                          
-
-
-$LOAD_PATH.unshift(File.expand_path(File.join(File.dirname(__FILE__),'../lib')))
-
-require 'rubygems'
-require 'spec'
-require 'dokkit'
-require 'dokkit/app'
-require File.dirname(__FILE__) + '/spec_helper.rb'
-
-describe Dokkit::Application, ' when initialized' do
-  before do
-    @app = Dokkit.application
-  end
-  after(:all) do
-    Dokkit.release
-  end
-  it 'should instantiate a ModelTask object to manage built-in tasks' do
-    @app.builtintask.should_not be_nil
-  end
-end
-
-describe Dokkit::Application, ' running' do
-  include CaptureStdout, SpecPathHelper
-  before(:all) do
-    @initial_dir = Dir.pwd
-    Dir.chdir(File.join(File.dirname(__FILE__), SpecPathHelper::DATA_DEST_DIR))
-  end  
-  before do
-    @app = Dokkit.application
-  end
-  after do
-    Dokkit.release
-    rm_rf 'spec/data/simpledocument'
-  end
-  after(:all) do
-    Dir.chdir(@initial_dir)
-  end      
-  it 'should output the list of built-in tasks' do
-    capture_stdout do
-      @app.do_option('--tasks', nil)
-      @app.run
-    end.should match(/new documentation/)
-  end
-end

data/spec/builtintask_spec.rb

@@ -1,114 +0,0 @@
-#                                                                          
-# File 'modeltask_spec.rb' created on 23 feb 2008 at 20:33:52.                    
-# See 'dokkit.rb' or +LICENSE+ for licence information.                      
-#                                                                          
-# (c)2008 Andrea Fazzi <andrea.fazzi@alca.le.it> (and contributors). 
-#                                                                          
-# To execute this spec run:                                            
-#                                                                          
-# spec spec/modeltask_spec.rb                                                  
-#                                                                          
-
-$LOAD_PATH.unshift(File.expand_path(File.join(File.dirname(__FILE__),'../lib')))
-
-require 'rubygems'
-require 'spec'
-require 'dokkit'
-require 'dokkit/builtintask'
-require File.dirname(__FILE__) + '/spec_helper.rb'
-
-describe Dokkit::BuiltinTask, ' when initialized' do
-  before do
-    Rake.application = nil    
-    application = mock('application')
-    application.stub!(:logger)
-    @builtintask = Dokkit::BuiltinTask.new(application)
-  end
-  it 'should know the full path of dokkit installation directory' do
-    File.exists?(@builtintask.dokkit_dir).should be_true
-  end  
-  it 'should know the full path of the built-in models dir' do
-    File.exists?(@builtintask.builtin_model_dir).should be_true    
-  end
-  it 'should set a default project model' do
-    Dokkit::DEFAULT_MODEL.should == 'simpledocument'
-  end    
-  it 'should store the list of the installed models' do
-    File.exists?(File.join(@builtintask.models['simpledocument'], 'model')).should be_true    
-  end
-end
-
-describe Dokkit::BuiltinTask, ' when list task is invoked' do
-  include CaptureStdout
-  before do
-    Rake.application = nil    
-    application = mock('application')
-    application.stub!(:logger).and_return(Dokkit::Log::ConsoleLog.consolelog)        
-    @builtintask = Dokkit::BuiltinTask.new(application)
-  end
-  it 'should list the models installed on the system' do
-    capture_stdout do
-      task('list').invoke
-    end.should match(/Found model 'simpledocument'/)
-  end  
-end
-
-describe Dokkit::BuiltinTask, ' when create task is invoked' do
-  include CaptureStdout
-  before do
-    Rake.application = nil
-    ARGV.clear
-    application = mock('application')
-    application.stub!(:logger).and_return(Dokkit::Log::ConsoleLog.consolelog)
-    @builtintask = Dokkit::BuiltinTask.new(application)
-  end  
-  after do
-    rm_rf 'spec/data/simpledocument'
-  end
-  it 'should create a new documentation directory using the given model' do
-    ARGV.push('model:create[simpledocument]')    
-    ARGV.push('spec/data/simpledocument')
-    Rake.application.collect_tasks
-    task('create').invoke('simpledocument')
-    File.exists?('spec/data/simpledocument').should be_true        
-  end
-  it 'should create a new documentation directory using simpledocument as default model' do
-    ARGV.push('create')    
-    ARGV.push('spec/data/simpledocument')
-    Rake.application.collect_tasks
-    task('create').invoke
-    File.exists?('spec/data/simpledocument').should be_true    
-  end
-  it 'should inform that a new documentation directory has been created' do
-    ARGV.push('create')    
-    ARGV.push('spec/data/simpledocument')
-    Rake.application.collect_tasks
-    capture_stdout do
-      task('create').invoke    
-    end.should match(/Create '.*' based on '.*' model/)
-  end
-  it 'should raise an error if model not found' do
-    ARGV.push('create[notexists]')    
-    ARGV.push('spec/data/simpledocument')
-    Rake.application.collect_tasks    
-    lambda { 
-      task('create').invoke('spec/data/simpledocument') 
-    }.should raise_error(RuntimeError, /Model '.*' not found/)
-  end
-  it 'should raise an error if target directory exists' do
-    ARGV.push('create')    
-    ARGV.push('spec/data/test_build')
-    Rake.application.collect_tasks        
-    lambda { 
-      task('create').invoke
-    }.should raise_error(RuntimeError, /Directory '.*' exists./)
-  end
-  it 'should copy model.yaml in the target directory' do
-    ARGV.push('create')    
-    ARGV.push('spec/data/simpledocument')
-    Rake.application.collect_tasks
-    task('create').invoke    
-    File.exists?('spec/data/simpledocument/doc/configs/model.yaml').should be_true
-  end
-end
-