dokkit 0.2.0 → 0.3.0

data/tests/data/output/website_project/README

@@ -1,49 +0,0 @@
-This is the auto-generated Rote documentation source.
-
-To render it using Rote's command-line wrapper (ignoring the included
-Rakefile), type:
-
-  rote doc
-
-from the top-level directory (this one).
-
-To render using the included Rakefile (the result is the same in either
-case) type instead:
-
-  rake doc
-  
-If you prefer, you can omit the 'doc' task, since it is configured
-as the default.  
-
-In either case, you should see some output as the pages are rendered 
-and resources copied, and get output in a (created) 'html' directory.
-Once you have rendered the site, running the command again will appear
-to do nothing, because only changed resources are re-rendered. To 
-start over:
-
-  (rote|rake) clobber
-
-Alternatively, modify the page or resource files, and rerun the first
-command to transform only the modified resource.
-
-WHAT NEXT?
-
-	+ See what else you can do by typing:
-	
-			  (rote|rake) --tasks
-			  
-			  rote --usage		( with the command-line wrapper )
-			  
-  + Modify the included page template and layout to suit your needs. 
-
-  + Edit the included Rakefile to add or change tasks, or delete it
-    if you're sticking with the command-line wrapper.
-
-  + Add more pages and layouts.
-
-  + Start Rote in monitor mode, and have your changes rendered as
-    you work:
-
-        (rote|rake) doc_monitor
-
-

data/tests/data/output/website_project/Rakefile

@@ -1,82 +0,0 @@
-# Standard Rakefile for custom Rote build
-#
-# Generated from:
-# $Id: Rakefile 160 2006-01-05 21:05:44Z roscopeco $
-# 
-begin 
-  require 'rubygems'
-rescue LoadError
-  nil # optional
-end
-
-require 'rake'
-require 'rake/clean'
-require 'rote/format'
-require 'dokkit'
-require 'dokkit/filters'
-
-include Rote
-include Dokkit
-
-# Create a set of tasks with the prefix 'doc' to  build the
-# documentation set. The directory layout is as for the
-# command-line wrapper (but can be changed of course).
-#
-# This creates the following tasks:
-#
-#   * doc           - transform/copy all modified pages / resources
-#   * doc_pages     - transform all modified pages
-#   * doc_res       - copy all modified resources
-#   * doc_monitor   - Start monitor mode, transform changed files automatically
-#
-#   * [html/**/*]   - Transform single page / resource unconditionally
-#
-#   * clobber_doc   - Remove output (hooks into main 'clobber' task)
-#
-# In addition to these tasks, you may also wish to define a 'doc_refresh' task
-# to be run whenever modified resources are processed in monitor mode.
-ws = Rote::DocTask.new(:doc) do |site| 
-  site.output_dir = 'html'
-  site.layout_dir = 'doc/layouts'
-  site.config_dir = 'doc/config'
-
-  site.pages.dir = 'doc/pages'
-  site.pages.include('**/*')   
-   
-  site.res.dir = 'doc/res'
-  site.res.include('**/*')
-  
-  site.ext_mapping(/thtml|textile/, 'html') do |page|
-    page.extend Format::HTML
-    page.page_filter Rote::Filters::RedCloth.new
-  end    
-  
-  site.ext_mapping(/mhtml|markdown/, 'html') do |page|
-    page.extend Format::HTML
-    page.page_filter Rote::Filters::BlueCloth.new
-  end      
-  
-  site.ext_mapping(/rdhtml|rdoc/, 'html') do |page|
-    page.extend Format::HTML
-    page.page_filter Rote::Filters::RDoc.new
-  end      
-  
-  site.ext_mapping(/dplhtml/, 'html') do |page|
-    page.extend Format::HTML
-    page.page_filter Dokkit::Filters::Deplate.new('html-notemplate')
-  end
-
-  site.ext_mapping(/html/, 'html') do |page|
-    page.extend Format::HTML
-  end    
-end
-
-task :default => [:doc]
-
-# import user-level tasks
-import "#{ENV['HOME']}/.rotetasks.rf" if File.exists?("#{ENV['HOME']}/.rotetasks.rf")
-import 'local.rf' if File.exists?('local.rf')
-
-# TODO Define your custom tasks here
-
-

data/tests/data/output/website_project/doc/layouts/normal.thtml

@@ -1,38 +0,0 @@
-<% 
-  # This is the 'normal' layout. It can be selected with:
-  #
-  # layout 'normal'
-  #
-  # in page code. If the page itself doesn't have an '.html'
-  # extension, you will need to use:
-  #
-  #    layout 'normal.html'
-  #
-  #  instead.  
-  #
-  #  Here we just add basic HTML wrap-up, use the custom var
-  #  (@page_title) to get the title, and insert content where
-  #  we want it with @content_for_layout.  
-%>
-<html>
-  <head>
-    <%# Use our custom vars for the title %>
-    <title><%= @page_title + ' - ' + @site_title %></title>
-  </head>
-
-  <body>
-    <h1><%= @page_title %></h1>
-
-    <%# Insert page content #%>
-    <%= @content_for_layout %>
-
-    <p align='center'><hr width='80%'></p>
-    <p align='right'>
-    <span style='font-size: 8pt; color: #7c7c90'>Generated with</span><br/>
-
-      <%# use the link_rel helper to make absolute links relative to current page #%>
-      <a href='http://rote.rubyforge.org/' target='_blank'><img src='<%= link_rel '/images/rote-tiny.png' %>' alt='Rote'/></a>
-    </p>    
-  </body>
-</html>
-

data/tests/data/output/website_project/doc/pages/COMMON.rb

@@ -1,9 +0,0 @@
-# Shared code for all pages below this directory.
-#
-# This is executed for every file transformed, in the binding of 
-# the appropriate Rote::Page instance. Individual page sources
-# ([pagename].rb) override anything defined here.
-#
-# Any COMMON.rb files found in directories above this will also
-# be loaded.
-@site_title = "My site"

data/tests/data/output/website_project/doc/pages/deplate.dplhtml

@@ -1,9 +0,0 @@
-#LIST: toc
-
-* Introduzione
-
-Lista:
-
- - item 1
- - item 2
-

data/tests/data/output/website_project/doc/pages/index.rb

@@ -1,10 +0,0 @@
-# Page code for the 'index' page. We call a few methods to
-# set layout and formatting, and then create a custom variable
-# for use in the layout.
-
-# Apply the 'normal' layout
-layout 'normal'
-
-# Set a custom var for use in our layout
-@page_title = 'A sample page'
-        

data/tests/data/output/website_project/doc/pages/index.thtml

@@ -1,12 +0,0 @@
-This is a *sample* page. 
-
-<%# insert an image with relative path, using Textile !img! markup #%>
-It has a very small image:
-!<%= link_rel '/images/rote-tiny.png' %>!
-
-(Which is the same as the one at the bottom)
-
-* You should
-* Replace this
-* With your doc.
-

data/tests/data/projects/simple-document/README

@@ -1,57 +0,0 @@
-This is 'simple_document' a simple document model included in the core
-distribution of dokkit. Check http://rubyforge.org/dokkit/ for other
-models. 
-
-To modify this document simply edit 'doc/pages/simple_document.dpl'. To get further
-information about the wiki syntax to be used please check http://deplate.sf.net/
-
-To render this document in html, type:
-
-  dokkit render_html
-
-from any subdirectory contained in the top-level directory (this one).
-  
-To render this document in TeX, type:
-
-  dokkit render_tex
-
-In either case, you should get the output in a (created) 'output'
-directory:
-
-  in 'output/html' you get html output
-  in 'output/tex' you get tex output
-
-  ... and so on...
-
-Once you have rendered the document, running the command again will appear
-to do nothing, because only changed resources are re-rendered. To
-clean the output and start over:
-
-  dokkit clobber
-
-Alternatively, modify the page or resource files, and rerun 
-
-  dokkit render_html
-
-  or
-
-  dokkit render_tex
-
-to transform only the modified resource.
-
-* WHAT'S NEXT?
-
- - See what else you can do by typing:
-
-    dokkit --tasks
-
- - Modify the configuration of the document by editing
-   'doc/config/simple_document.yaml'
-
- - Create a new document by typing: 
-     
-    dokkit create_new_page new_document
-
-For further information about dokkit see http://dokkit.rubyforge.org/
-
-

data/tests/data/projects/simple-document/doc/config/author.yaml

@@ -1,4 +0,0 @@
-document:
-  author:
-    email: john.doe@organization.org
-    

data/tests/data/projects/simple-document/doc/config/model.yaml

@@ -1,18 +0,0 @@
-#----------------------------------------------------------------------
-#
-# model.yaml created on 19 set 2007 at 22:37:25.
-# See 'dokkit.rb' or LICENSE for licence information.
-#
-# (c)2007 Andrea Fazzi (and contributors).
-#
-# This is a config file for the current document. This file is written
-# using YAML so you can easily modify it using YAML syntax. For further
-# information about YAML please visit http://yaml.org.
-#
-#----------------------------------------------------------------------
-
-model:
-  name: simpledocument
-  version: 0.1.0
-  language: en
-  

data/tests/data/projects/simple-document/doc/config/simple_document.yaml

@@ -1,6 +0,0 @@
-document:
-  title: A simple document
-  author: John Doe
-
-
-

data/tests/data/projects/simple-document/doc/layouts/another_simple_document.html

@@ -1,8 +0,0 @@
-<html> <!-- Custom layout for simple_document -->
-  <head>
-    <title><%= @config['document']['title'] %></title>
-  </head>
-<body>
-  <%= @content_for_layout %>
-</body>
-</html>

data/tests/data/projects/simple-document/doc/layouts/another_simple_document.tex

@@ -1,10 +0,0 @@
-\documentclass[a4paper,10pt]{article} % custom layout for simple_document
-
-\title{<%= @config['title'] %>}
-\author{<%= @config['author'] %> 
-
-\begin{document}
-
-<%= @content_for_layout %>
-
-\end{document}

data/tests/data/projects/simple-document/doc/layouts/layout_with_custom_name.html

@@ -1,8 +0,0 @@
-<html> <!-- Custom layout with custom name for simple_document -->
-  <head>
-    <title><%= @config['document']['title'] %></title>
-  </head>
-<body>
-  <%= @content_for_layout %>
-</body>
-</html>

data/tests/data/projects/simple-document/doc/layouts/semantic.cache

@@ -1,23 +0,0 @@
-;; Object layouts/
-;; SEMANTICDB Tags save file
-(semanticdb-project-database-file "layouts/"
-  :tables (list 
-   (semanticdb-table "layout_with_custom_name.html"
-    :major-mode 'html-mode
-    :tags '(("" section nil nil [81 142]) ("" section nil nil [142 147]))
-    :file "layout_with_custom_name.html"
-    :pointmax 194
-    :unmatched-syntax 'nil
-    )
-   (semanticdb-table "another_simple_document.html"
-    :major-mode 'html-mode
-    :tags '(("" section nil nil [64 125]) ("" section nil nil [125 130]))
-    :file "another_simple_document.html"
-    :pointmax 177
-    :unmatched-syntax 'nil
-    )
-   )
-  :file "semantic.cache"
-  :semantic-tag-version "2.0pre3"
-  :semanticdb-version "2.0pre3"
-  )

data/tests/data/projects/simple-document/doc/pages/COMMON.yaml

@@ -1,23 +0,0 @@
-#-------------------------------------------------------------------------
-#
-# COMMON.yaml created on 01 ott 2007 at 15:21:20.
-# See 'dokkit.rb' or LICENSE for licence information.
-#
-# (c)2006, 2007 Andrea Fazzi <andrea.fazzi@alca.le.it> (and contributors).
-#
-# This is a config file for the current document. This file is written
-# using YAML so you can easily modify it using YAML syntax. For further
-# information about YAML please visit http://yaml.org/.
-#
-#-------------------------------------------------------------------------
-
-document:
-  title: A common title for document in pages dir
-  author:
-    name: John
-    surname: Doe
-  common_key: A common value for documents in pages dir
-  
-    
-
-

data/tests/data/projects/simple-document/doc/pages/another_simple_document.dpl

@@ -1,12 +0,0 @@
-* Abstract
-From a document of Jim{cite: author:jim}
-
-* Introduction
-
-* Main section
-
-** Subsection One
-** Subsection Two
-
-* Conclusions
-

data/tests/data/projects/simple-document/doc/pages/simple_document.dpl

@@ -1,12 +0,0 @@
-* Abstract
-From a document of Jim{cite: author:jim}
-
-* Introduction
-
-* Main section
-
-** Subsection One
-** Subsection Two
-
-* Conclusions
-

data/tests/data/projects/simple-document/doc/pages/simple_document_without_layout.dpl

@@ -1,12 +0,0 @@
-* Abstract
-From a document of Jim{cite: author:jim}
-
-* Introduction
-
-* Main section
-
-** Subsection One
-** Subsection Two
-
-* Conclusions
-

data/tests/data/projects/simple-document/doc/pages/subdir/COMMON.yaml

@@ -1,4 +0,0 @@
-document:
-  title: A simple document in a subdirectory
-  common_key: A common value for documents in subdir
-  

data/tests/data/projects/simple-document/doc/pages/subdir/simple_document_in_subdir.dpl

@@ -1,12 +0,0 @@
-* Abstract
-From a document of Jim{cite: author:jim}
-
-* Introduction
-
-* Main section
-
-** Subsection One
-** Subsection Two
-
-* Conclusions
-

data/tests/data/projects/simple-document/doc/pages/subdir/simple_document_in_subdir.yaml

@@ -1,3 +0,0 @@
-document:
-  akey: a value
-  

data/tests/data/projects/simple-document/doc/pages/subdir/subdir/COMMON.yaml

@@ -1,2 +0,0 @@
-document:
-  common_key: A common value for documents in subdir/subdir

data/tests/data/projects/simple-document/doc/pages/subdir/subdir/another_simple_document_in_subdir.dpl

@@ -1,12 +0,0 @@
-* Abstract
-From a document of Jim{cite: author:jim}
-
-* Introduction
-
-* Main section
-
-** Subsection One
-** Subsection Two
-
-* Conclusions
-

data/tests/data/projects/simple-document/doc/pages/yet_another_simple_document.dpl

@@ -1,12 +0,0 @@
-* Abstract
-From a document of Jim{cite: author:jim}
-
-* Introduction
-
-* Main section
-
-** Subsection One
-** Subsection Two
-
-* Conclusions
-

data/tests/data/projects/simple-document/doc/pages/yet_another_simple_document.yaml

@@ -1,8 +0,0 @@
-document:
-  layout: layout_with_custom_name
-  title: A simple document with layout with custom name
-  config: []
-  - author
-  - notexists
-  
-  

data/tests/gem_tests.rb

@@ -1,4 +0,0 @@
-TEST_FROM_GEM = true
-$: << File.join(File.dirname(__FILE__),'../lib')
-Dir[File.join(File.dirname(__FILE__), '**/test_*.rb')].each { |test| require test }
-

data/tests/spec_page.rb

@@ -1,25 +0,0 @@
-require 'rubygems'
-require 'spec'
-require 'dokkit'
-
-context 'A new page' do
-
-setup do
-  @config_page_complete = { :fn         => 'test.dpltex',
-                            :layout_dir => 'layouts/',
-                            :pages_dir  => 'pages/',
-                            :config_dir => 'config'
-                          }
-
-  @config_page_incomplete = { :fn => 'test.dpltex', :pages_dir  => 'pages/' }
-end
-
-specify 'should be correctly initialized if fn, layout_dir, pages_dir and config_dir are given' do
-  Rote::Page.new(@config_page_complete)
-end
-
-specify 'should have correct defaults for pages_dir, layout_dir and config_dir' do
-  Rote::Page.new(@config_page_incomplete)
-end
-
-end

data/tests/test.rb

@@ -1,2 +0,0 @@
-break test_builtin_tasks.rb:45
-break app.rb:211

data/tests/test_application.rb

@@ -1,40 +0,0 @@
-#                                                                          
-# File 'test_application.rb' created on 22 Oct 2007 at 16:25:05.                    
-# See 'dokkit.rb' or +LICENSE+ for licence information.                      
-#                                                                          
-# (c)2006, 2007 Andrea Fazzi <andrea.fazzi@alca.le.it> (and contributors). 
-#                                                                          
-# To execute this unit test run:                                            
-#                                                                          
-# ruby test/test_application.rb                                                  
-#                                                                          
-
-require 'rubygems'
-require 'test/unit'
-require 'dokkit'
-require 'dokkit/app'
-
-$LOAD_PATH.unshift File.expand_path(File.join(File.dirname(__FILE__),'../lib'))
-
-class TestApplication < Test::Unit::TestCase
-  def setup
-  end
-  def teardown
-  end
-  # The tests below need dokkit-model-simple-document gem to pass.
-  # Run:
-  # $ gem install dokkit-model-simpledocument
-  # to install the simpledocument model.
-  def test_fetch_models
-    assert(File.exists?(Dokkit.fetch_models['simple-document']))
-  end
-  def test_model_dir
-    assert(File.exists?(Dokkit.model_dir('simple-document')))
-  end
-  def test_model_layout_dir
-    assert(File.exists?(Dokkit.model_layout_dir('simple-document')))
-  end
-  def test_config_dir
-    assert(File.exists?(Dokkit.model_config_dir('simple-document')))
-  end
-end

data/tests/test_builtin_tasks.rb

@@ -1,37 +0,0 @@
-require 'rubygems'
-require 'test/unit'
-require 'dokkit'
-require 'dokkit/app'
-require 'rake'
-
-
-$LOAD_PATH.unshift File.expand_path(File.join(File.dirname(__FILE__),'../lib'))
-
-class TestBuiltinTask < Test::Unit::TestCase
-  OUTPUT_DIR = 'tests/data/output'
-  def setup
-    ARGV.clear
-  end
-  def test_builtin_task
-    Dokkit.application.init
-    Dokkit.application.define_builtin_tasks
-    assert_equal('create', Dokkit.application['create'].to_s)
-  end
-  def test_create_default_project_task
-    Dokkit.application.init
-    Dokkit.application.define_builtin_tasks
-    ARGV.push("create", "#{OUTPUT_DIR}/simple_document")
-    Dokkit.application.run
-    dir_content = Dir["#{OUTPUT_DIR}/simple_document/*"]
-    assert(!dir_content.empty? && !dir_content.include?('lib'))
-  end
-  def test_create_website_task
-    Dokkit.application.init
-    Dokkit.application.do_option('--project',"website")
-    Dokkit.application.define_builtin_tasks
-    ARGV.push("create", "#{OUTPUT_DIR}/website_project")
-    Dokkit.application.run
-    assert(Dir["#{OUTPUT_DIR}/website_project/*"].size > 1)
-  end
-end
-