dokkit 0.3.0 → 0.4.0

data/History.txt

@@ -1,3 +1,8 @@
+== 0.3.1
+
+* fixed bug #19332: now meta configuration informations are parsed
+  correctly in presence of newlines at the beginning of file.
+
 == 0.3.0 / 2008-01-09
 
 * Completely removed any dependency from rote.

data/Manifest.txt

@@ -4,115 +4,101 @@ README.txt
 Rakefile
 bin/dokkit
 lib/dokkit.rb
-lib/dokkit/app.rb
-lib/dokkit/builtintask.rb
-lib/dokkit/cachemanager.rb
-lib/dokkit/cleantask.rb
-lib/dokkit/consolelog.rb
-lib/dokkit/defaults.rb
-lib/dokkit/deplate/fmt/html-notemplate.rb
-lib/dokkit/deplate/fmt/latex-notemplate.rb
-lib/dokkit/document.rb
-lib/dokkit/dokkitlib.rb
-lib/dokkit/extension/extension.rb
-lib/dokkit/extension/filehelper.rb
-lib/dokkit/fileselection.rb
+lib/dokkit/application.rb
+lib/dokkit/cache.rb
+lib/dokkit/cache/cache.rb
+lib/dokkit/environment.rb
+lib/dokkit/environment/basic.rb
+lib/dokkit/environment/helpers.rb
+lib/dokkit/environment/helpers/extmap.rb
+lib/dokkit/environment/helpers/fileselection.rb
+lib/dokkit/factory.rb
+lib/dokkit/factory/factory.rb
 lib/dokkit/filters.rb
-lib/dokkit/filters/all.rb
-lib/dokkit/filters/base.rb
 lib/dokkit/filters/deplate.rb
 lib/dokkit/filters/maruku.rb
 lib/dokkit/filters/nil.rb
-lib/dokkit/logger.rb
-lib/dokkit/model.rb
-lib/dokkit/models/simpledocument/model/Rakefile
-lib/dokkit/models/simpledocument/model/doc/layouts/simpledocument.html
-lib/dokkit/models/simpledocument/model/doc/layouts/simpledocument.latex
-lib/dokkit/models/simpledocument/model/doc/layouts/simpledocument.text
-lib/dokkit/models/simpledocument/model/doc/pages/simpledocument.deplate
-lib/dokkit/models/simpledocument/model/doc/configs/simpledocument.yaml
-lib/dokkit/models/simpledocument/model/doc/data/css/style.css
-lib/dokkit/models/simpledocument/model/tasks/all.rb
-lib/dokkit/models/simpledocument/model/tasks/clean.rake
-lib/dokkit/models/simpledocument/model/tasks/render.rake
-lib/dokkit/models/simpledocument/model/tasks/setup.rb
-lib/dokkit/modeltask.rb
-lib/dokkit/pathhelper.rb
-lib/dokkit/recursivemerge.rb
-lib/dokkit/rendertask.rb
-lib/dokkit/resourcemanager.rb
-lib/dokkit/taskconfig.rb
-lib/dokkit/templatetask.rb
-spec/app_spec.rb
-spec/builtintask_spec.rb
-spec/cachemanager_spec.rb
-spec/cleantask_spec.rb
-spec/consolelog_spec.rb
-spec/data/test_build/Rakefile
-spec/data/test_build/doc/configs/document_1.yaml
-spec/data/test_build/doc/configs/required.yaml
-spec/data/test_build/doc/configs/subdir/document_4.yaml
-spec/data/test_build/doc/data/resource
-spec/data/test_build/doc/data/resource.exclude
-spec/data/test_build/doc/data/subdir/resource.insubdir
-spec/data/test_build/doc/layouts/document_1.html
-spec/data/test_build/doc/layouts/document_1.latex
-spec/data/test_build/doc/layouts/document_with_partials.html
-spec/data/test_build/doc/layouts/layout
-spec/data/test_build/doc/layouts/layout.html
-spec/data/test_build/doc/layouts/layout.html.backup
-spec/data/test_build/doc/layouts/nested.html
-spec/data/test_build/doc/layouts/partials/partial.html
-spec/data/test_build/doc/pages/COMMON.yaml
-spec/data/test_build/doc/pages/document_1
-spec/data/test_build/doc/pages/document_1.dep
-spec/data/test_build/doc/pages/document_1.yaml
-spec/data/test_build/doc/pages/document_2
-spec/data/test_build/doc/pages/document_2.dep
-spec/data/test_build/doc/pages/document_2.yaml
-spec/data/test_build/doc/pages/document_3
-spec/data/test_build/doc/pages/document_5.exclude
-spec/data/test_build/doc/pages/document_7
-spec/data/test_build/doc/pages/document_7.yaml
-spec/data/test_build/doc/pages/document_extended
-spec/data/test_build/doc/pages/document_nested
-spec/data/test_build/doc/pages/document_nested.yaml
-spec/data/test_build/doc/pages/document_nolayout.ext
-spec/data/test_build/doc/pages/document_nolayout.yaml
-spec/data/test_build/doc/pages/document_with_partials
-spec/data/test_build/doc/pages/document_with_partials.yaml
-spec/data/test_build/doc/pages/partials/COMMON.yaml
-spec/data/test_build/doc/pages/partials/circular_partial
-spec/data/test_build/doc/pages/partials/circular_partial.yaml
-spec/data/test_build/doc/pages/partials/partial
-spec/data/test_build/doc/pages/subdir/COMMON.yaml
-spec/data/test_build/doc/pages/subdir/document_4
-spec/data/test_build/doc/pages/subdir/subdir/COMMON.yaml
-spec/data/test_build/doc/pages/subdir/subdir/document_6
-spec/data/test_build/tasks/all.rb
-spec/data/test_build/tasks/clean.rake
-spec/data/test_build/tasks/render.rake
-spec/data/test_build/tasks/setup.rb
-spec/data/test_build/tasks/template.rake
-spec/data/test_build/templates/layouts/layout
-spec/data/test_build/templates/pages/template
-spec/document_spec.rb
-spec/dokkitlib_spec.rb
-spec/filehelper_spec.rb
-spec/fileselection_spec.rb
-spec/filter_base_spec.rb
-spec/filter_deplate_spec.rb
-spec/filter_maruku_spec.rb
-spec/filter_nil_spec.rb
-spec/filters_spec.rb
-spec/logger_spec.rb
-spec/model_spec.rb
-spec/pathhelper_spec.rb
-spec/recursivemerge_spec.rb
-spec/rendertask_spec.rb
+lib/dokkit/hash.rb
+lib/dokkit/logging.rb
+lib/dokkit/logging/logger.rb
+lib/dokkit/logging/observers.rb
+lib/dokkit/logging/observers/console.rb
+lib/dokkit/models/simple/Rakefile
+lib/dokkit/models/simple/doc/configs/simple.yaml
+lib/dokkit/models/simple/doc/data/html/css/style.css
+lib/dokkit/models/simple/doc/data/latex/deplate.sty
+lib/dokkit/models/simple/doc/layouts/simple.html
+lib/dokkit/models/simple/doc/layouts/simple.latex
+lib/dokkit/models/simple/doc/layouts/simple.text
+lib/dokkit/models/simple/doc/pages/simple.deplate
+lib/dokkit/models/simple/setup/setup.rb
+lib/dokkit/resource.rb
+lib/dokkit/resource/data.rb
+lib/dokkit/resource/document.rb
+lib/dokkit/resource/extensions.rb
+lib/dokkit/resource/extensions/builtin.rb
+lib/dokkit/resource/extensions/html.rb
+lib/dokkit/resource/extensions/url.rb
+lib/dokkit/resource/filenamehelper.rb
+lib/dokkit/tasklib.rb
+lib/dokkit/tasklib/clean.rb
+lib/dokkit/tasklib/render.rb
+spec/dokkit/application_spec.rb
+spec/dokkit/cache/cache_spec.rb
+spec/dokkit/dokkit_spec.rb
+spec/dokkit/environment/basic_spec.rb
+spec/dokkit/environment/helpers/extmap_spec.rb
+spec/dokkit/environment/helpers/fileselection_spec.rb
+spec/dokkit/environment/helpers/test_data/doc/pages/document_1.ext_1
+spec/dokkit/environment/helpers/test_data/doc/pages/document_2
+spec/dokkit/environment/helpers/test_data/doc/pages/document_3.ext_3
+spec/dokkit/environment/test_data/doc/data/data
+spec/dokkit/environment/test_data/doc/pages/document_1
+spec/dokkit/environment/test_data/doc/pages/document_1.yaml
+spec/dokkit/environment/test_data/doc/pages/document_2
+spec/dokkit/environment/test_data/doc/pages/subdir/document_1
+spec/dokkit/factory/factory_spec.rb
+spec/dokkit/filters/deplate_spec.rb
+spec/dokkit/filters/maruku_spec.rb
+spec/dokkit/filters/nil_spec.rb
+spec/dokkit/hash_spec.rb
+spec/dokkit/logging/logger_spec.rb
+spec/dokkit/logging/observers/console_spec.rb
+spec/dokkit/resource/data_spec.rb
+spec/dokkit/resource/document_spec.rb
+spec/dokkit/resource/extensions/html_spec.rb
+spec/dokkit/resource/extensions/url_spec.rb
+spec/dokkit/resource/filenamehelper_spec.rb
+spec/dokkit/resource/test_data/doc/configs/config_1.yaml
+spec/dokkit/resource/test_data/doc/configs/config_2.yaml
+spec/dokkit/resource/test_data/doc/configs/required.yaml
+spec/dokkit/resource/test_data/doc/configs/subdir/document.yaml
+spec/dokkit/resource/test_data/doc/layouts/container.html
+spec/dokkit/resource/test_data/doc/layouts/layout.html
+spec/dokkit/resource/test_data/doc/layouts/layout.latex
+spec/dokkit/resource/test_data/doc/layouts/nested/nested.html
+spec/dokkit/resource/test_data/doc/layouts/subdir/document.html
+spec/dokkit/resource/test_data/doc/layouts/subdir/document.latex
+spec/dokkit/resource/test_data/doc/pages/COMMON.yaml
+spec/dokkit/resource/test_data/doc/pages/document_with_many_config.ext
+spec/dokkit/resource/test_data/doc/pages/document_with_many_errors.ext
+spec/dokkit/resource/test_data/doc/pages/document_with_many_targets.ext
+spec/dokkit/resource/test_data/doc/pages/document_with_nested_layout.ext
+spec/dokkit/resource/test_data/doc/pages/document_with_nil_target.ext
+spec/dokkit/resource/test_data/doc/pages/document_with_not_defined_target.ext
+spec/dokkit/resource/test_data/doc/pages/document_with_one_target.ext
+spec/dokkit/resource/test_data/doc/pages/subdir/COMMON.yaml
+spec/dokkit/resource/test_data/doc/pages/subdir/document.ext
+spec/dokkit/resource/test_data/doc/pages/subdir/document.yaml
+spec/dokkit/tasklib/clean_spec.rb
+spec/dokkit/tasklib/render_spec.rb
+spec/dokkit/tasklib/test_data/doc/data/data_1
+spec/dokkit/tasklib/test_data/doc/pages/document_1
+spec/dokkit/tasklib/test_data/doc/pages/document_2
+spec/dokkit/test_data/dokkit/models/model1/doc/pages/model1
+spec/dokkit/test_data/dokkit/models/model2/doc/pages/model2
+spec/spec.opts
 spec/spec_helper.rb
-spec/taskconfig_spec.rb
-spec/templatetask_spec.rb
 tasks/annotations.rake
 tasks/doc.rake
 tasks/gem.rake
@@ -122,4 +108,3 @@ tasks/setup.rb
 tasks/spec.rake
 tasks/svn.rake
 tasks/test.rake
-

data/README.txt

@@ -4,11 +4,21 @@ dokkit
 
 == DESCRIPTION:
   
-dokkit is a document generator. It was inspired by rote but now
-it is completely independent from it. dokkit uses
-filters like deplate to generate output in a large variety of formats (tex, html,
+dokkit is a document generator. It was inspired by rote but now it is
+completely independent from it. dokkit uses filters like deplate and
+maruku to generate output in a large variety of formats (tex, html,
 docbook, plain text, ...).
 
+With dokkit you can:
+
+* generate static websites
+* generate many types of documents in many formats (html, tex, plain text, etc.)
+* write your documents using a simple wiki syntax and obtain high quality output
+* generate different output formats from the same source document 
+* use models to quickly generate the documents you want (technical report, invoice, howto, guides, presentation, website, etc.)
+* simply derive new documentation models from the existing ones
+* simply modify existing models to fit your needs
+
 For more information please execute:
 
   dokkit --help
@@ -17,24 +27,34 @@ For more information please execute:
   
 dokkit key features are:
 
-* a smart task system based on rake
-* a consistent documentation per-model framework organized in templates, layouts, ruby classes, configuration files, resources
-* a powerful templating system based on ERB
+* a smart building system based on rake[http://rake.rubyforge.org]
+* a documentation directory structure organized in pages, layouts, configuration files, resources
+* a templating system based on ERB
 * a simple and flexible configuration system based on YAML
+* support for partials
 
 == SYNOPSIS:
 
-  dokkit [options] [task]
+To create a new documentation environment in <dirname> run:
+
+  dokkit <dirname>
 
 == REQUIREMENTS:
 
 * deplate >= 0.8.0
+* maruku => 0.5.9
 * rake >= 0.8.1
 
 == INSTALL:
 
   sudo gem install dokkit
 
+== QUICK START
+
+  $ dokkit mydocument
+  $ cd mydocument
+  $ rake
+
 == LICENSE:
 
 Copyright (c) 2008 Andrea Fazzi

data/Rakefile

@@ -10,7 +10,7 @@ require 'dokkit'
 task :default => 'spec:run'
 
 PROJ.name = 'dokkit'
-PROJ.version = Dokkit::DOKKITVERSION
+PROJ.version = Dokkit::VERSION
 PROJ.summary = 'dokkit is an open source document generator'
 PROJ.authors = 'Andrea Fazzi'
 PROJ.email = 'andrea.fazzi@alca.le.it'
@@ -18,8 +18,7 @@ PROJ.url = 'http://dokkit.rubyforge.org'
 PROJ.description = paragraphs_of('README.txt', 1).join("\n\n")
 PROJ.changes = paragraphs_of('History.txt', 0..1).join("\n\n")
 PROJ.rubyforge_name = 'dokkit'
-#FIXME: set version numbers for the dependencies below.
 PROJ.dependencies = ['deplate', 'rake', 'maruku']
 PROJ.spec_opts << ['--format', 'specdoc', '--color']
-
+PROJ.rdoc_exclude << "models/simple"
 # EOF

data/bin/dokkit

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
 
-require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'dokkit'))
+require 'dokkit/application'
+require 'dokkit/logging'
 
 # Put your code here
-Dokkit.application.run
+Dokkit::Application.new( Dokkit::Logging::Observer::Console.new(Dokkit::Logging::Logger.new).logger ).run
 # EOF

data/lib/dokkit/application.rb

@@ -0,0 +1,159 @@
+#
+# File 'application.rb' created on 08 mag 2008 at 17:26:07.
+#
+# See 'dokkit.rb' or +LICENSE+ for licence information.
+#
+# (C)2006-2008 Andrea Fazzi <andrea.fazzi@alca.le.it> (and contributors).
+#
+
+require 'getoptlong'
+require 'fileutils'
+require 'dokkit'
+
+module Dokkit
+  class Application
+
+    OPTIONS =  [
+                [ "--usage", "-u", GetoptLong::NO_ARGUMENT,
+                  "Display usage information." ],
+                [ "--help", "-h", GetoptLong::NO_ARGUMENT,
+                  "Synonim for usage."],
+                [ "--version", "-v", GetoptLong::NO_ARGUMENT,
+                  "Display the version number and quit." ],
+                [ "--list", '-l', GetoptLong::NO_ARGUMENT,
+                  "List the available models."],
+                [ "--model", '-m', GetoptLong::REQUIRED_ARGUMENT,
+                  "Specify a documentation model" ]
+               ]
+
+    USAGE_PREAMBLE = <<-EOU
+Usage: dokkit [options] <dest_dir>
+
+Where dest_dir is the directory in which to setup the documentation
+environment.
+
+EOU
+    attr_reader :default_model
+
+    def initialize(logger, configuration = { })
+      @logger = logger
+      @configuration = configuration
+      @dokkit_dir = configuration[:dokkit_dir] || dokkit_dir
+      @user_dir = configuration[:user_dir] || relative_to_home('.dokkit')
+      @model_dir = configuration[:model_dir] || 'models'
+      @default_model = configuration[:default_model] || 'simple'
+      @models = { 'simple' => File.join(@dokkit_dir, 'dokkit/models/simple') } if @dokkit_dir
+      @models.merge!(fetch_models)
+    end
+
+    def run
+      
+      process_args
+      
+      unless ARGV.empty?
+        create_environment(ARGV.to_s)
+      else
+        do_option('--help')        
+      end
+
+    end
+
+    private
+
+    def dokkit_dir
+      lib = nil
+      $:.each do |it|
+        if File.exists?(File.join(it, 'dokkit/models/'))
+          lib = it
+          break
+        end
+      end
+      lib
+    end
+
+    def relative_to_home(path)
+      File.join(((ENV['HOMEPATH'] if RUBY_PLATFORM =~ /win32/) || ENV['HOME']), path)
+    end
+
+    def create_environment(dest_dir)
+      model = @model || @default_model
+      if @models.has_key?(model)
+        unless File.exists?(dest_dir)
+          @logger.info("Creating documentation environment based on '#{model}' on directory '#{dest_dir}'.")
+          FileUtils.cp_r(@models[model], dest_dir)
+        else
+          @logger.error("Directory '#{dest_dir}' already exists.")
+        end
+      else
+        @logger.error("Model '#{model}' not found.")
+      end
+    end
+
+    def do_option(option, value = nil)
+      case option
+      when '--usage'
+        help
+        exit
+      when '--help'
+        help
+        exit
+      when '--version'
+        puts "dokkit, version #{Dokkit::VERSION}\n"
+        exit
+      when '--list'
+        list_models
+        exit
+      when '--model'
+        @model = value
+      end
+    end
+
+    def command_line_options
+      OPTIONS.collect { |lst| lst[0..-2] }
+    end
+
+    def process_args
+      opts = GetoptLong.new(*command_line_options)
+      opts.each { |opt, value| do_option(opt, value) }
+    end
+
+    def help
+      puts
+      puts USAGE_PREAMBLE
+      puts "Recognized options are:"
+      puts
+      OPTIONS.sort.each do |long, short, mode, desc|
+        if mode == GetoptLong::REQUIRED_ARGUMENT
+          if desc =~ /\b([A-Z]{2,})\b/
+            long = long + "=#{$1}"
+          end
+        end
+        printf "  %-20s (%s)\n", long, short
+        printf "      %s\n", desc
+        puts
+      end
+    end
+
+    def model_dir
+      File.join(@dokkit_dir, @model_dir)
+    end
+
+    def fetch_models
+      models = { }
+      if File.exists?(model_dir)
+        Dir.glob(File.join(model_dir, '*')) do |model|
+          modelname = model.sub(File.join(@dokkit_dir, @model_dir), '').sub('/', '')
+          models[modelname] = model
+        end
+      end
+      models
+    end
+
+    def list_models
+      @models.each_key do |model|
+        @logger.info("Found model '#{model}'.")
+      end
+    end
+
+  end
+end

data/lib/dokkit/cache/cache.rb

@@ -0,0 +1,53 @@
+#                                                                          
+# File 'cachemanager.rb' created on 28 gen 2008 at 18:31:05.                    
+#
+# See 'dokkit.rb' or +LICENSE+ for licence information.                      
+#                                                                          
+# (C)2006-2008 Andrea Fazzi <andrea.fazzi@alca.le.it> (and contributors). 
+#                                                                          
+
+require 'rake'
+require 'yaml'
+
+module Dokkit
+  class Cache
+    attr_reader :deps, :cache_dir, :cache_filename
+    
+    def initialize(cache_filename = 'deps.yaml', cache_dir = '.cache')
+      @cache_filename = cache_filename
+      @cache_dir = cache_dir
+      @complete_cache_filename = File.join(cache_dir, cache_filename)
+      load
+      at_exit { save }
+    end
+    
+    def add_dependency(source_fn, format, dep)
+      @deps[source_fn] ||= { format => [] }
+      @deps[source_fn][format] << dep unless (dep.nil? or @deps[source_fn][format].include?(dep))
+    end
+    
+    def load
+      @deps = load_from_yaml || { }
+    end
+    
+    def save
+      write_cache_to_file unless @deps.empty?
+    end
+    
+    def clean
+      @deps.clear
+    end
+
+    private
+
+    def load_from_yaml
+      YAML::load_file(@complete_cache_filename) if File.exists?(@complete_cache_filename)
+    end
+    
+    def write_cache_to_file
+      mkdir_p(cache_dir, :verbose => false) unless File.exists?(cache_dir)
+      File.open(@complete_cache_filename, 'w') { |file| file.write YAML::dump(@deps) }
+    end
+            
+  end
+end

data/lib/dokkit/{models/simpledocument/model/Rakefile → cache.rb}

@@ -1,22 +1,10 @@
 #                                                                          
-# File 'Rakefile' created on 09 ott 2007 at 16:06:57.                    
+# File 'cache.rb' created on 05 mag 2008 at 16:36:14.                    
 #
 # See 'dokkit.rb' or +LICENSE+ for licence information.                      
 #                                                                          
-# (C) 2006, 2007 Andrea Fazzi <andrea.fazzi@alca.le.it> (and contributors). 
+# (C)2006-2008 Andrea Fazzi <andrea.fazzi@alca.le.it> (and contributors). 
 #                                                                          
-# Rakefile for website project model
-
-require 'tasks/all'
-
-task :clobber => 'clean:all'
-task :default => 'render:all'
-
-
-
-
-
-
-
 
+require 'dokkit/cache/cache'