dokkit 0.3.0 → 0.4.0

data/lib/dokkit/deplate/fmt/html-notemplate.rb

@@ -1,21 +0,0 @@
-# latex-notemplate.rb
-# @Author:      Andrea Fazzi (andrea.fazzi AT alca.le.it)
-# @Website:     http://alca.le.it/
-# @License:     GPL (see http://www.gnu.org/licenses/gpl.txt)
-# @Created:     04-Dic-2006.
-# @Last Change: 04-Dic-2006.
-# @Revision:    0.1
-
-require 'deplate/fmt/html'
-
-class Deplate::Formatter::HTMLNoTemplate < Deplate::Formatter::HTML
-  self.myname = "html-notemplate"
-  self.rx     = /html?(-notemplate)?/i
-
-
-  def prepare
-  end
-
-  def add_package(pkg, *options)
-  end
-end

data/lib/dokkit/deplate/fmt/latex-notemplate.rb

@@ -1,24 +0,0 @@
-# latex-notemplate.rb
-# @Author:      Luca Greco (luca.greco AT alca.le.it)
-# @Website:     http://alca.le.it/
-# @License:     GPL (see http://www.gnu.org/licenses/gpl.txt)
-# @Created:     16-Oct-2006.
-# @Last Change: 16-Oct-2006.
-# @Revision:    0.1
-
-require 'deplate/fmt/latex'
-
-class Deplate::Formatter::LatexNoTemplate < Deplate::Formatter::LaTeX
-  self.myname = "latex-notemplate"
-  self.rx     = /(la)?tex(-notemplate)?/i
-
-  def prepare
-  end
-
-  def initialize_deplate_sty  
-  end
-  
-  def add_package(pkg, *options)
-  end
-end
-

data/lib/dokkit/document.rb

@@ -1,221 +0,0 @@
-#
-# File 'document.rb' created on 13 gen 2008 at 18:49:57.
-#
-# See 'dokkit.rb' or +LICENSE+ for licence information.
-#
-# (C) 2006, 2007 Andrea Fazzi <andrea.fazzi@alca.le.it> (and contributors).
-#
-
-require 'ostruct'
-require 'yaml'
-require 'erb'
-require 'dokkit/logger'
-require 'dokkit/consolelog'
-require 'dokkit/pathhelper'
-require 'dokkit/cachemanager'
-require 'dokkit/recursivemerge'
-require 'dokkit/pathhelper'
-require 'dokkit/filters/all'
-require 'dokkit/extension/filehelper'
-
-module Dokkit
-  class Document
-    DEFAULT_FILTER_CHAIN = { 
-      'html' => ['deplate-html'],
-      'latex' => ['deplate-latex'],
-      'text' => ['deplate-text'],
-      'nil' => ['nil']
-    }    
-    include Extension::FileHelper, PathHelper
-    attr_reader :document, :taskconfig
-    attr_reader :document_basename
-    attr_reader :configs, :targets, :layouts
-    attr_reader :filter_chain
-    attr_reader :configuration
-    attr_reader :source_text
-    attr_reader :prerequisites
-    attr_reader :logger
-    def initialize(document, taskconfig, rendered = [], &blk)
-      @logger = Log::ConsoleLog.consolelog
-      @document, @taskconfig, @rendered = document, taskconfig, rendered
-      @document_basename = File.basename(document)
-      @stripped_document = strip_ext(@document)
-      @layouts, @targets, @prerequisites, @filter_chain = { }, { }, { }, { }
-      @configs = []      
-      @configuration = Hash.new do |h, k|
-        @logger.warn("Configuration key '#{k}' not defined in '#{targets[@format]}'!")
-        h[k] = "'#{k}' not defined!"
-      end
-      @configuration.extend ConfigHash
-      @source_text = read_source
-      @cache = CacheManager.instance
-      
-      yield self if block_given?
-      
-      collect_resources
-    end
-    def render(format)
-      @format = format
-      unless @source_text.nil?
-        erb = ERB.new(@source_text)
-        erb.filename = @document
-        @content_for_layout = apply_filters(erb.result(binding), format)
-      end
-      unless @layouts[format].empty?
-       @layouts[format].each do |layout_fn|
-         erb = ERB.new(File.read(layout_fn)) 
-         erb.filename = layout_fn
-         @content_for_layout = erb.result(binding)
-       end  
-      end
-      @content_for_layout
-    end
-    
-    private
-
-    def extract_meta!(text)
-      meta_regexp = /\A-{3}$(.*?)-{3}$/m
-      meta = text.scan(meta_regexp).to_s
-      text.sub!(meta_regexp, '')
-      return meta
-    end
-    def render_partial(document_fn, format = @format, &blk)
-      unless @rendered.include?(document)
-        result = Document.new(File.join(@taskconfig.document_dir, document_fn), @taskconfig, @rendered << document, &blk).render(format)
-        @cache.add_dependency(targets[format], File.join(@taskconfig.document_dir, document_fn))
-        @rendered.clear
-      else
-        @logger.error("Circular dependency detected in '#{document}', aborting.")
-      end
-      result
-    end
-    def collect_resources
-      collect_configs
-      collect_targets
-      collect_layouts
-      collect_prerequisites
-    end    
-    def collect_prerequisites
-      @targets.each_key do |format|
-        @prerequisites[format] = []
-        @prerequisites[format] << document
-        @prerequisites[format].concat @configs
-        @prerequisites[format].concat(@layouts[format]) if @layouts[format]
-        @prerequisites
-      end
-    end
-    def collect_configs
-      @configs << (config_fn_helper(@stripped_document, @taskconfig)) if File.exists?(config_fn_helper(@stripped_document, @taskconfig))
-      @configs.concat(resolve_common_configs(File.dirname(@document)))
-      @configs << (@stripped_document + '.yaml') if File.exists?(@stripped_document + '.yaml')
-      
-      meta_configuration = YAML::load(extract_meta!(@source_text))
-      if meta_configuration
-        if meta_configuration.has_key?('config')
-          (@configs << get_config_fns(meta_configuration['config'])).flatten!
-          meta_configuration.delete('config')
-        end        
-      end
-      
-      @configs.each do |config_fn|
-        @configuration.recursive_merge!(YAML::load(File.open(config_fn)))
-        if @configuration.has_key?('config')
-          (@configs << get_config_fns(@configuration['config'])).flatten!
-          @configuration.delete('config')
-        end
-      end
-      
-      @configuration.recursive_merge!(meta_configuration) if meta_configuration  
-    end
-    def resolve_common_configs(dir, arr = [])
-      parent = File.expand_path(File.join(dir, '..'))
-      resolve_common_configs(parent, arr) unless parent == dir # at root    
-      fn = File.join(dir,'COMMON.yaml')    
-      arr << fn if (File.exists?(fn) && File.readable?(fn))
-      arr      
-    end
-    def build_config_fn(fn)
-      result_fn = fn
-      if File.extname(fn).empty?
-        result_fn += '.yaml'
-      end
-      result_fn = File.join(@taskconfig.config_dir, result_fn)
-    end
-    def get_config_fns(configuration)
-      if configuration.is_a?(String)
-        result = build_config_fn(configuration)
-      elsif configuration.is_a?(Array)
-        result = configuration.collect do |fn|
-          fn = build_config_fn(fn)
-        end
-      else
-        @logger.fail('Invalid config file value.')
-      end
-      result
-    end
-    def collect_targets
-      if @configuration.has_key?('render_in')
-        @configuration['render_in'].each do |fmt|
-          if fmt.class != Hash
-            @targets[fmt] = output_fn_helper(@stripped_document, ".#{fmt}", @taskconfig)
-            @filter_chain[fmt] = DEFAULT_FILTER_CHAIN[fmt]
-          else
-            fmt.each do |format, configuration|
-              if(configuration.empty?)
-                @targets[format] = output_fn_helper(@stripped_document, ".#{format}")
-                @filter_chain[fmt] = DEFAULT_FILTER_CHAIN[fmt]                
-              else
-                output, ext = @taskconfig.output_dir, ".#{format}"
-                ext = configuration['ext'] if configuration.has_key?('ext')
-                output = File.join(@taskconfig.output_dir, configuration['output']) if configuration.has_key?('output')
-                @targets[format] = File.join(output, strip_ext(@document_basename) + ext)
-                if configuration.has_key?('filters')
-                  @filter_chain[format] = configuration['filters']
-                end
-              end
-            end
-          end
-        end
-      else
-        @targets['html'] = output_fn_helper(@stripped_document, '.html', @taskconfig)
-        @filter_chain['html'] = DEFAULT_FILTER_CHAIN['html']
-      end
-    end
-    def collect_layouts
-      @targets.each do |format, target|
-        layout_fn = []        
-        layout_ext = File.extname(target)
-        layout_fn << (layout_fn_helper(@stripped_document, layout_ext, @taskconfig)) if File.exists?(layout_fn_helper(@stripped_document, layout_ext, @taskconfig))
-        layout_fn << (@stripped_document + layout_ext) if File.exists?(@stripped_document + layout_ext)
-        if @configuration.has_key?('layout')
-          @configuration['layout'].each do |layout|
-            config_layout_fn = strip_ext(layout)
-            layout_fn << File.join(@taskconfig.layout_dir, config_layout_fn + layout_ext) if File.exists?(File.join(@taskconfig.layout_dir, config_layout_fn + layout_ext))
-            layout_fn << (config_layout_fn + layout_ext) if File.exists?(config_layout_fn + layout_ext)
-          end
-        end
-        @logger.warn("Layout not found for '#{target}'!") if layout_fn.empty?
-        @layouts[format] = layout_fn.uniq.reverse
-      end
-    end
-    def read_source
-      File.read(document)
-    end
-    def apply_filters(text, target)
-      filters = []
-      chain = @filter_chain[target]
-      if chain
-        @filter_chain[target].each do |name|
-          begin
-            filters << Filters[name]
-          rescue
-            @logger.warn("Filter '#{name}' not found, ignored.")
-          end
-        end
-        filters.inject(text) { |s, f| f.filter(s) }
-      else
-        @logger.error("Don't know how to render in '#{target}' format!")
-      end
-    end
-  end
-end

data/lib/dokkit/dokkitlib.rb

@@ -1,68 +0,0 @@
-#                                                                          
-# File 'dokkitlib.rb' created on 18 feb 2008 at 17:54:20.                    
-#
-# See 'dokkit.rb' or +LICENSE+ for licence information.                      
-#                                                                          
-# (C) 2008 Andrea Fazzi <andrea.fazzi@alca.le.it> (and contributors). 
-#                                                                          
-
-require 'ostruct'
-require 'rake'
-require 'rake/tasklib'
-require 'dokkit/defaults'
-require 'dokkit/taskconfig'
-require 'dokkit/pathhelper'
-require 'dokkit/consolelog'
-
-module Dokkit
-  class DokkitLib < Rake::TaskLib
-    include PathHelper, Rake::TaskManager
-    attr_reader :ns
-    attr_reader :logger
-    attr_reader :model
-    attr_accessor :config
-    def initialize(model, namespace = 'dokkit', opts = { })      
-      @ns = namespace
-      @model = model
-      @config = model.config
-      @logger = Log::ConsoleLog.consolelog
-      
-      pre_block_configuration
-      
-      yield self if block_given?
-      
-      post_block_configuration
-      
-      check_directories if opts[:check_dir]
-      define_dokkit_tasks 
-    end
-    def dokkit_task(*args, &block)
-      task_name, arg_names, needs = resolve_args(args.dup)
-      task(*args, &block) unless Rake::Task.task_defined?("#{@ns}:#{task_name}")
-    end
-    
-    private
-    
-    def check_directories
-      unless @config.directories.empty?
-        @config.directories.each_value do |dir|
-          @logger.error("Directory '#{dir}' does not exist") unless (dir =~ /output|cache/ || File.exists?(dir))
-        end
-      end
-    end
-    def pre_block_configuration
-      nil
-    end
-    def post_block_configuration
-      nil
-    end
-    def define_dokkit_tasks
-      namespace @ns do
-        private_methods.select { |meth| meth =~ /define_dokkit_/ and not meth =~ /define_dokkit_tasks/ }.each do |method|
-          self.send(method)
-        end
-      end
-    end
-  end
-end
-

data/lib/dokkit/extension/filehelper.rb

@@ -1,25 +0,0 @@
-#                                                                          
-# File 'filehelper.rb' created on 28 feb 2008 at 16:40:57.                    
-#
-# See 'dokkit.rb' or +LICENSE+ for licence information.                      
-#                                                                          
-# (C) 2008 Andrea Fazzi <andrea.fazzi@alca.le.it> (and contributors). 
-#                                                                          
-
-require 'dokkit/extension/extension'
-
-module Dokkit
-  module Extension
-    module FileHelper
-      def relative(href)
-        thr = href
-        if thr.is_a?(String) && href[0,1] == '/'     
-          dtfn = File.dirname(document[/^#{taskconfig.document_dir}\/(.*)/,1]) + '/'
-          count = dtfn == './' ? 0 : dtfn.split('/').length
-          thr = ('../' * count) + href[1..href.length]
-        end        
-        thr
-      end      
-    end
-  end
-end

data/lib/dokkit/fileselection.rb

@@ -1,44 +0,0 @@
-#                                                                          
-# File 'fileselection.rb' created on 07 feb 2008 at 15:52:42.                    
-#
-# See 'dokkit.rb' or +LICENSE+ for licence information.                      
-#                                                                          
-# (C) 2006, 2007 Andrea Fazzi <andrea.fazzi@alca.le.it> (and contributors). 
-#                                                                          
-
-require 'rake'
-
-module Dokkit
-  module ExtMapping
-    attr_reader :extmapping
-    def extend(regexp=/.*/, &blk)
-      @extmapping ||= { }
-      (files.select { |file| file =~ regexp }).each do |file|
-        @extmapping[file] = blk
-      end
-    end
-  end
-  class FileSelection
-    attr_accessor :base_dir
-    alias :dir :base_dir
-    alias :dir= :base_dir=
-    def initialize(base_dir = '.')
-      @base_dir = base_dir
-      @includes = []
-      @excludes = []
-      yield self if block_given?
-    end
-    def include(*patterns)
-      patterns.each { |pattern| @includes << pattern }
-    end
-    def exclude(*patterns)
-      patterns.each { |pattern| @excludes << pattern }
-    end
-    def files
-      FileList.new(@base_dir) do |fl|
-        fl.exclude *@excludes.collect { |exclude| File.join(@base_dir, exclude) } unless @excludes.empty?
-        fl.include *@includes.collect { |include| File.join(@base_dir, include) } unless @includes.empty?
-      end.uniq.select { |fn| not File.directory?(fn) }
-    end
-  end
-end

data/lib/dokkit/filters/all.rb

@@ -1,18 +0,0 @@
-#                                                                          
-# File 'all_filters.rb' created on 18 feb 2008 at 17:13:12.                    
-#
-# See 'dokkit.rb' or +LICENSE+ for licence information.                      
-#                                                                          
-# (C) 2008 Andrea Fazzi <andrea.fazzi@alca.le.it> (and contributors). 
-#                                                                          
-
-require 'dokkit/filters/base'
-
-Dir[File.join(File.dirname(__FILE__), '*.rb')].each do |fn|
-  begin
-    require fn unless fn =~ /[\\\/]base.rb$/ or fn == 'all.rb'
-  rescue LoadError
-    nil
-  end
-end
-

data/lib/dokkit/model.rb

@@ -1,34 +0,0 @@
-#                                                                          
-# File 'model.rb' created on 10 mar 2008 at 13:39:48.                    
-#
-# See 'dokkit.rb' or +LICENSE+ for licence information.                      
-#                                                                          
-# (C) 2008 Andrea Fazzi <andrea.fazzi@alca.le.it> (and contributors). 
-#                                                                          
-
-require 'yaml'
-require 'dokkit/taskconfig'
-require 'dokkit/cachemanager'
-
-module Dokkit
-  class Model
-    class << self
-      def init(name = 'model', &blk)
-        @model ||= Model.new(name, &blk)
-      end
-    end
-    attr_accessor :config
-    attr_reader :name, :cache
-    def initialize(name, &blk)
-      @name = name
-      @config = TaskConfig.new       
-              
-      yield self if block_given?
-
-      @cache = CacheManager.instance
-      @cache.init('deps.yaml', @config.cache_dir)
-      
-      self      
-    end
-  end
-end

data/lib/dokkit/models/simpledocument/model/doc/layouts/simpledocument.html

@@ -1,9 +0,0 @@
-<html>
-<link href="<%= relative('/css/style.css') %>" rel="stylesheet" type="text/css" media="screen" />
-<head>
-  <title>A changed title</title>
-</head>
-<body>
-  <%= @content_for_layout %>
-</body>
-</html>

data/lib/dokkit/models/simpledocument/model/doc/pages/simpledocument.deplate

@@ -1,102 +0,0 @@
----
-title: The simpledocument model
-render_in:
-- html
-- latex
-- text
----
-
-%% Dynamic generation of the Table of Contents.
-%% Generate TOC only if formatter is different from html.
-
-#IF: fmt==html-notemplate
-#VAR: headings=plain
-#ELSE
-#LIST: toc
-----8<----
-#ENDIF
-
-
-* Description of the model
-
-This is a simple document model for ''dokkit''. You can use this model
-as a base to create simple documents like tutorials, howtos, technical
-reports, etc.
-
-* Edit and render your document
-
-To edit the content of the document simply edit
-''simpledocument.deplate'' in ''doc/pages'' folder or create a new
-file in ''doc/pages'' directory.
-
-To get further information about the deplate wiki syntax please check
-[[http://deplate.sf.net/deplate.html][deplate]] homepage.
-
-To render this document in ''html'', ''tex'' and ''plain text'', open a terminal and type:
-
-#Verbatim <<EOB
-$ dokkit ## or rake
-EOB
-
-from the top-level directory or from any subdirectory contained in it.
-  
-You should get the output files in the 'output' folder.
-
-* Rendering the modified parts of the document and cleaning up
-
-Once you have rendered the document, running the ''dokkit'' command again will
-appear to do nothing, because only changed resources are re-rendered.
-To clean the output and start over run:
-
-#Verbatim <<EOB
-$ dokkit clobber
-EOB
-
-Note that if you modify any part of the document then you must re-run
-''dokkit'' command in order to apply changes and to re-generate the
-desidered output. 
-
-So, once you have modified your document, run:
-
-#Verbatim <<EOB
-$ dokkit ## or rake
-EOB
-
-Only the modified resources will be transformed.
-
-* Configure the documentation environment
-
-To configure your documentation environment edit the *.rake files in
-''tasks'' folder.
-
-* How to get other ''dokkit'' models
-
-To search for other document models open a terminal and type:
-
-#Verbatim <<EOB
-$ gem list dokkit-model
-EOB
-
-To get a particular model named <model_name> run:
-
-#Verbatim <<EOB
-$ gem install dokkit-model-<model_name>
-EOB
-
-or check http://rubyforge.org/projects/dokkit/. 
-
-* What's next?
-
- * See what else you can do by typing:
-
-   ''$ dokkit --tasks''
-
-
- - Modify the configuration of the document by editing
-   ''doc/config/simpledocument.yaml''.
-
- - Override the default layout creating in custom layouts in ''doc/layouts''.
-
-For further information about ''dokkit'' see http://dokkit.rubyforge.org/.
-
-

data/lib/dokkit/models/simpledocument/model/tasks/all.rb

@@ -1,3 +0,0 @@
-require 'tasks/setup'
-
-Dir.glob('tasks/*.rake').each {|fn| import fn}

data/lib/dokkit/models/simpledocument/model/tasks/clean.rake

@@ -1,3 +0,0 @@
-require 'dokkit/cleantask'
-
-Dokkit::CleanTask.new(MODEL, 'clean')

data/lib/dokkit/models/simpledocument/model/tasks/render.rake

@@ -1,8 +0,0 @@
-require 'dokkit/rendertask'
-
-Dokkit::RenderTask.new(MODEL, 'render') do |task|
-  task.config.data_dir = 'doc/data'
-  task.documents.include('**/*')
-  task.documents.exclude('**/*.yaml', '**/*_extended', '**/*partial*')
-  task.data.include('**/*')
-end

data/lib/dokkit/models/simpledocument/model/tasks/setup.rb

@@ -1,9 +0,0 @@
-require 'dokkit/model'
-
-MODEL = Dokkit::Model.init('simpledocument') do |model|
-  model.config.document_dir = 'doc/pages'
-  model.config.config_dir = 'doc/configs'
-  model.config.layout_dir = 'doc/layouts'
-  model.config.output_dir = 'output'
-  model.config.cache_dir = '.cache'
-end

data/lib/dokkit/modeltask.rb

@@ -1,83 +0,0 @@
-#                                                                          
-# File 'modeltask.rb' created on 23 feb 2008 at 20:45:10.                    
-#
-# See 'dokkit.rb' or +LICENSE+ for licence information.                      
-#                                                                          
-# (C) 2008 Andrea Fazzi <andrea.fazzi@alca.le.it> (and contributors). 
-#                                                                          
-
-require 'yaml'
-require 'dokkit'
-require 'dokkit/dokkitlib'
-
-module Dokkit
-  class ModelTask < DokkitLib
-    attr_reader :models
-    def initialize(model, namespace = 'model')
-      super(model, namespace)
-    end
-    def pre_block_configuration
-      @config.local_dir ||= DEFAULT_LOCAL_DIR
-      @config.search_in ||= [:dokkit_dir, :local_dir]
-    end
-    def post_block_configuration
-      fetch_models
-    end
-    def dokkit_dir
-      lib = nil
-      unless lib = ENV['DOKKIT_LIB']
-        $:.each do |it|
-          if File.exists?(File.join(it, 'dokkit/app.rb'))
-            lib = it
-            break
-          end
-        end
-      end
-      lib      
-    end
-    def builtin_model_dir
-      File.join(dokkit_dir, 'dokkit/models')      
-    end
-    
-    private
-    
-    def from_location(location)
-      return builtin_model_dir if location == :dokkit_dir
-      return File.expand_path(File.join('~', @config.local_dir)) if location == :local_dir
-    end
-    def fetch_models
-      @models = { }
-      config.search_in.each do |location|
-        Dir.glob(File.join(from_location(location), '**/Rakefile')).each do |model|
-          @models[model.scan(/models\/(.*)\/Rakefile/).flatten.to_s] = File.dirname(model)
-        end      
-      end
-    end
-    def define_dokkit_list_model_task
-      desc 'List the installed models'
-      dokkit_task 'list' do
-        @models.each do |modelname, path|
-          @logger.info("Found model '#{modelname}' in #{path}")
-        end
-      end
-    end    
-    def define_dokkit_create_task
-      desc 'Bootstrap a new documentation project'
-      dokkit_task 'create', :model do |t, args|
-        model = args.model || DEFAULT_MODEL
-        if ARGV.size == 2
-          dest_dir = t.application.top_level_tasks.pop
-        else
-          @logger.error('A target directory must be provided.')          
-        end        
-        @logger.error("Directory '#{dest_dir}' exists.") if File.exists?(dest_dir)
-        @logger.error("Model '#{model}' not found.") unless @models[model]
-        @logger.info("Create '#{dest_dir}' based on '#{model}' model.")       
-        cp_r(@models[model], dest_dir)        
-        File.open(File.join(dest_dir, 'tasks/model.yaml'), 'w') do |file|
-          file << { 'name' => model, 'from' => @models[model] }.to_yaml   
-        end
-      end
-    end
-  end
-end