dokkit 0.2.0 → 0.3.0

data/History.txt

@@ -0,0 +1,4 @@
+== 0.3.0 / 2008-01-09
+
+* Completely removed any dependency from rote.
+

data/Manifest.txt

@@ -0,0 +1,125 @@
+History.txt
+Manifest.txt
+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/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
+spec/spec_helper.rb
+spec/taskconfig_spec.rb
+spec/templatetask_spec.rb
+tasks/annotations.rake
+tasks/doc.rake
+tasks/gem.rake
+tasks/manifest.rake
+tasks/rubyforge.rake
+tasks/setup.rb
+tasks/spec.rake
+tasks/svn.rake
+tasks/test.rake
+

data/README.txt

@@ -0,0 +1,53 @@
+dokkit
+    by Andrea Fazzi
+    http://dokkit.rubyforge.org
+
+== 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,
+docbook, plain text, ...).
+
+For more information please execute:
+
+  dokkit --help
+
+== FEATURES/PROBLEMS:
+  
+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 simple and flexible configuration system based on YAML
+
+== SYNOPSIS:
+
+  dokkit [options] [task]
+
+== REQUIREMENTS:
+
+* deplate >= 0.8.0
+* rake >= 0.8.1
+
+== INSTALL:
+
+  sudo gem install dokkit
+
+== LICENSE:
+
+Copyright (c) 2008 Andrea Fazzi
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.

data/Rakefile

@@ -1,167 +1,25 @@
-# Rakefile for dokkit
-#
-# (C) 2006, 2007 Andrea Fazzi <andrea.fazzi@alca.le.it> (and contributors).
-#
-
-$:.unshift('lib')
-
-require 'rake/gempackagetask'
-require 'rake/contrib/rubyforgepublisher'
-require 'rake/clean'
-require 'rake/testtask'
-require 'rake/rdoctask'
-
-# Versioning scheme: MAJOR.MINOR.PATCH
-# MAJOR bumps when API is broken backwards
-# MINOR bumps when the API is broken backwards in a very slight/subtle (but not fatal) way
-# -OR when a new release is made and propaganda is sent out.
-# PATCH is bumped for every API addition and/or bugfix (ideally for every commit)
-# Later DamageControl can bump PATCH automatically.
-#
-# REMEMBER TO KEEP PKG_VERSION IN SYNC WITH THE CHANGES FILE!
-#
-# Determine the current version of the software
-
-if `ruby -Ilib ./bin/dokkit --version` =~ /\S+$/
-  CURRENT_VERSION = $&
-else
-  CURRENT_VERSION = "0.0.0"
-end
-
-PKG_NAME = "dokkit"
-PKG_VERSION = CURRENT_VERSION
-PKG_FILE_NAME = "#{PKG_NAME}-#{PKG_VERSION}"
-PKG_FILES = FileList.new( ['lib/**/*', 'bin/*', '[A-Z]*', 'tests/**/*'] ) do |fl| 
-  fl.exclude(/TEMPLATE\./).to_a
-end
-
-task :default => [:gem]
-
-rd = Rake::RDocTask.new do |rd|
-  rd.title = "dokkit"
-  rd.main = "README"
-  rd.rdoc_files.include("[A-Z]*", "lib/**/*.rb", "tests/*.rb")
-  rd.rdoc_dir = "doc/rdoc"
-end	
-
-task :man do
-  sh "rd2 -r rd/rd2man-lib.rb bin/dokkit | gzip > doc/man/dokkit.1.gz"
-end
-
-# ====================================================================
-# Create a task that will package the software into distributable
-# tar, zip and gem files.
-
-spec = Gem::Specification.new do |s|
-  
-  #### Basic information.
-
-  s.name = PKG_NAME
-  s.version = PKG_VERSION
-  s.summary = "Ruby Documentation toolKit"
-  s.description = <<-EOF
-    dokkit is an open source document generator based on rote.
-  EOF
-
-  s.files = PKG_FILES.to_a
-  s.require_path = 'lib'
-  s.autorequire = 'dokkit'
-  s.bindir = "bin"                               # Use these for applications.
-  s.executables = ["dokkit"]
-  s.default_executable = "dokkit"
-
-  s.add_dependency('deplate', '>= 0.8')
-  s.add_dependency('rote', '>= 0.3.4')
-  s.add_dependency('rake')
-  s.add_dependency('syntax')
-
-  #### Documentation and testing.
-
-  s.has_rdoc = true
-  s.extra_rdoc_files = rd.rdoc_files.reject { |fn| fn =~ /\.rb$/ }.to_a
-  s.rdoc_options <<
-    '--title' <<  'dokkit' <<
-    '--main' << 'README' <<
-    '--line-numbers'
-
-  #### Author and project details.
-
-  s.author = "Andrea Fazzi"
-  s.email = "andrea.fazzi@alca.le.it"
-  s.homepage = "http://dokkit.rubyforge.org/"
-  s.rubyforge_project = "dokkit"
-end
-
-desc "Build Gem"
-Rake::GemPackageTask.new(spec) do |pkg|
-  pkg.need_zip = true
-  pkg.need_tar = true
-end
-
-# Support Tasks ------------------------------------------------------
-
-desc "Look for TODO and FIXME tags in the code"
-task :todo do
-  Pathname.new(File.dirname(__FILE__)).egrep(/#.*(FIXME|TODO|TBD|DEPRECATED)/) do |match|
-    puts match
-  end
-end
-
-task :release => [:verify_env_vars, :release_files, :publish_doc, :publish_news]
-
-task :verify_env_vars do
-  raise "RUBYFORGE_USER environment variable not set!" unless ENV['RUBYFORGE_USER']
-  raise "RUBYFORGE_PASSWORD environment variable not set!" unless ENV['RUBYFORGE_PASSWORD']
-end
-
-task :publish_doc => [:rdoc] do
-  if user = ENV['RUBYFORGE_USER']
-    Rake::SshDirPublisher.new(
-      "#{user}@rubyforge.org",
-      "/var/www/gforge-projects/dokkit/rdoc/",
-      "doc/rdoc/"
-    ).upload
-  else
-    $stderr << "Skipping documentation upload - Need to set RUBYFORGE_USER to your rubyforge.org user name\n"
-  end
-end
-
-desc "Release files on RubyForge"
-task :release_files => [:gem] do
-  require 'meta_project'
-  require 'rake/contrib/xforge'
-  release_files = FileList[
-    "pkg/#{PKG_FILE_NAME}.gem"
-  ]
-
-  Rake::XForge::Release.new(MetaProject::Project::XForge::RubyForge.new('dokkit')) do |release|
-    # Never hardcode user name and password in the Rakefile!
-    release.user_name = ENV['RUBYFORGE_USER']
-    release.password = ENV['RUBYFORGE_PASSWORD']
-    release.files = release_files.to_a
-    release.release_name = "#{PKG_NAME} #{PKG_VERSION}"
-    # The rest of the options are defaults (among others, release_notes and release_changes, parsed from CHANGES)
-  end
-end
-
-desc "Publish news on RubyForge"
-task :publish_news => [:gem] do
-  release_files = FileList[
-    "pkg/#{PKG_FILE_NAME}.gem"
-  ]
-  Rake::XForge::NewsPublisher.new(MetaProject::Project::XForge::RubyForge.new('dokkit')) do |news|
-    # Never hardcode user name and password in the Rakefile!
-    news.user_name = ENV['RUBYFORGE_USER']
-    news.password = ENV['RUBYFORGE_PASSWORD']
-  end
-end
-
-desc "Tag the working tree and copy it to dokkit-core/tags/REL_X_Y_Z on RubyForge"
-task :tag do
-  reltag = "REL_#{PKG_VERSION.gsub(/\./, '_')}"
-  puts "Tagging current head with [#{reltag}]"
-  sh "svn copy ./ svn+ssh://#{ENV['RUBYFORGE_USER']}@rubyforge.org/var/svn/dokkit/dokkit-core/tags/#{reltag}/ -m \"tag #{reltag}\"" if ENV['RUBYFORGE_USER']
-end
-
-
-
+# Look in the tasks/setup.rb file for the various options that can be
+# configured in this Rakefile. The .rake files in the tasks directory
+# are where the options are used.
+
+load 'tasks/setup.rb'
+
+ensure_in_path 'lib'
+require 'dokkit'
+
+task :default => 'spec:run'
+
+PROJ.name = 'dokkit'
+PROJ.version = Dokkit::DOKKITVERSION
+PROJ.summary = 'dokkit is an open source document generator'
+PROJ.authors = 'Andrea Fazzi'
+PROJ.email = 'andrea.fazzi@alca.le.it'
+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']
+
+# EOF

data/bin/dokkit

@@ -1,63 +1,7 @@
-#                                                                          
-# File 'dokkit' created on 09 ott 2007 at 15:57:46.                    
-#
-# See 'dokkit.rb' or LICENSE for licence information.                      
-#                                                                          
-# (c)2006, 2007 Andrea Fazzi <andrea.fazzi@alca.le.it> (and contributors). 
-#
-# Commandline launcher for Dokkit.
-# Get set up with library paths, however we're installed.
-#                                                                          
+#!/usr/bin/env ruby
 
-=begin
-
-= NAME
-dokkit - Ruby Documentation toolKit
-
-= SYNOPSIS
-
-dokkit [options] [task1] .. [taskN]
-
-= DESCRIPTION
-
-dokkit is a documentation environment. It is based on rote and it uses deplate to generate output in a large variety of formats (tex, html, docbook, plain text, ...).
-
-For more information please execute:
-
-$ dokkit --help
-
-= OPTIONS
-
-For a complete list of the options please execute:
- 
-$ dokkit --help
-
-= AUTHOR
-
-Andrea Fazzi <andrea.fazzi@alca.le.it>
-
-= SEE ALSO
-
-ruby(1)
-
-=end
-
-def croak
-  puts "Cannot locate Dokkit libraries - Do you need to set $DOKKIT_LIB?"
-  exit(1)
-end
-
-begin
-  require 'rubygems'
-rescue LoadError
-  nil # just ignore, don't use gems
-end
-
-require 'dokkit'
-require 'dokkit/app'
-
-croak unless Dokkit.dokkit_lib
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'dokkit'))
 
+# Put your code here
 Dokkit.application.run
-
-
+# EOF