RubyGems - dokkit - Versions diffs - 0.1.1 → 0.2.0 - Mend

dokkit 0.1.1 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (98) hide show

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

@@ -0,0 +1,18 @@
+#----------------------------------------------------------------------
+#
+# 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 ADDED Viewed

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

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

@@ -0,0 +1,8 @@
+<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 ADDED Viewed

@@ -0,0 +1,10 @@
+\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 ADDED Viewed

@@ -0,0 +1,8 @@
+<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 ADDED Viewed

@@ -0,0 +1,23 @@
+;; 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 ADDED Viewed

@@ -0,0 +1,23 @@
+#-------------------------------------------------------------------------
+#
+# 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 ADDED Viewed

@@ -0,0 +1,12 @@
+* 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 ADDED Viewed

@@ -0,0 +1,12 @@
+* 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 ADDED Viewed

@@ -0,0 +1,12 @@
+* 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 ADDED Viewed

@@ -0,0 +1,4 @@
+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 ADDED Viewed

@@ -0,0 +1,12 @@
+* 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 ADDED Viewed

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

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

	@@ -0,0 +1,2 @@
1	+ document:
2	+ 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 ADDED Viewed

@@ -0,0 +1,12 @@
+* 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 ADDED Viewed

@@ -0,0 +1,12 @@
+* 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 ADDED Viewed

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

data/tests/spec_page.rb ADDED Viewed

@@ -0,0 +1,25 @@
+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 ADDED Viewed

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

data/tests/test_application.rb ADDED Viewed

@@ -0,0 +1,40 @@
+#
+# 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 ADDED Viewed

@@ -0,0 +1,37 @@
+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

data/tests/test_config.rb ADDED Viewed

@@ -0,0 +1,108 @@
+require 'rubygems'
+require 'test/unit'
+require 'dokkit'
+require 'dokkit/app'
+require 'dokkit/page'
+require 'rake'
+$LOAD_PATH.unshift File.expand_path(File.join(File.dirname(__FILE__),'../lib'))
+class TestConfig < Test::Unit::TestCase
+  PROJECT_DIR = File.join(Dokkit.tests_dir, 'data/projects/simple-document/')
+  def setup
+    Dir.chdir PROJECT_DIR
+    @simple_document = Rote::Page.new(
+      {
+      :fn => 'simple_document.dpl',
+      :pages_dir => 'doc/pages',
+      :layout_dir => 'doc/layouts',
+      :config_dir => 'doc/config',
+      :layout_defext => '.html',
+      :template_defext => '.dpl'
+      }
+    )
+    @simple_document_in_subdir = Rote::Page.new(
+      {
+      :fn => 'subdir/simple_document_in_subdir.dpl',
+      :pages_dir => 'doc/pages',
+      :layout_dir => 'doc/layouts',
+      :config_dir => 'doc/config',
+      :layout_defext => '.html',
+      :template_defext => '.dpl'
+      }
+    )
+    @another_simple_document_in_subdir = Rote::Page.new(
+      {
+      :fn => 'subdir/subdir/another_simple_document_in_subdir.dpl',
+      :pages_dir => 'doc/pages',
+      :layout_dir => 'doc/layouts',
+      :config_dir => 'doc/config',
+      :layout_defext => '.html',
+      :template_defext => '.dpl'
+      }
+    )
+    @another_simple_document = Rote::Page.new(
+      {
+      :fn => 'another_simple_document.dpl',
+      :pages_dir => 'doc/pages',
+      :layout_dir => 'doc/layouts',
+      :config_dir => 'doc/config',
+      :layout_defext => '.html',
+      :template_defext => '.dpl'
+      }
+    )
+    @yet_another_simple_document = Rote::Page.new(
+      {
+      :fn => 'yet_another_simple_document.dpl',
+      :pages_dir => 'doc/pages',
+      :layout_dir => 'doc/layouts',
+      :config_dir => 'doc/config',
+      :layout_defext => '.html',
+      :template_defext => '.dpl'
+      }
+    )
+  end
+  def test_model_key
+    assert @simple_document.instance_eval { @config['model'] }
+  end
+  def test_model_name_key
+    assert @simple_document.instance_eval { @config['model']['name'] }
+  end
+  def test_model_version_key
+    assert @simple_document.instance_eval { @config['model']['version'] }
+  end
+  def test_simple_document_default_config
+    assert_equal('A simple document', @simple_document.instance_eval { @config['document']['title'] })
+  end
+  def test_simple_document_common
+    assert_nil @simple_document.instance_eval { @config['document']['author']['name'] }
+    assert_equal('A common value for documents in pages dir', @simple_document.instance_eval { @config['document']['common_key'] })
+  end
+  def test_simple_document_in_subdir_config
+    assert_equal('A simple document in a subdirectory', @simple_document_in_subdir.instance_eval { @config['document']['title'] })
+  end
+  def test_simple_document_in_subdir_common
+    assert_equal('A simple document in a subdirectory', @simple_document_in_subdir.instance_eval { @config['document']['title'] })
+    assert_equal('A common value for documents in subdir', @simple_document_in_subdir.instance_eval { @config['document']['common_key'] })
+    assert_equal('John', @simple_document_in_subdir.instance_eval { @config['document']['author']['name'] })
+  end
+  def test_another_simple_document_in_subdir_common
+    assert_equal('A simple document in a subdirectory', @another_simple_document_in_subdir.instance_eval { @config['document']['title'] })
+    assert_equal('A common value for documents in subdir/subdir', @another_simple_document_in_subdir.instance_eval { @config['document']['common_key'] })
+    assert_equal('John', @another_simple_document_in_subdir.instance_eval { @config['document']['author']['name'] })
+  end
+  def test_another_simple_document_layout
+    assert_equal(['another_simple_document.html'], @another_simple_document.instance_eval { @layout_names })
+  end
+  def test_yet_another_simple_document_layout
+    assert_equal(['yet_another_simple_document.html', 'layout_with_custom_name.html'], @yet_another_simple_document.instance_eval { @layout_names })
+  end
+  def test_yet_another_simple_document_common
+    assert_equal('A simple document with layout with custom name', @yet_another_simple_document.instance_eval { @config['document']['title'] })
+    assert_equal('John', @yet_another_simple_document.instance_eval { @config['document']['author']['name'] })
+    assert_equal('john.doe@organization.org', @yet_another_simple_document.instance_eval { @config['document']['author']['email'] })
+  end
+end

data/tests/test_core.rb ADDED Viewed

@@ -0,0 +1,12 @@
+begin
+  require 'rubygems'
+rescue LoadError
+  nil
+end
+# make sure we're testing this version, not an installed Gem!
+$LOAD_PATH.unshift File.expand_path(File.join(File.dirname(__FILE__),'../lib'))
+require 'tests/test_builtin_tasks.rb'
+require 'tests/test_dokkit_commandline.rb'

data/tests/test_dokkit_commandline.rb ADDED Viewed

@@ -0,0 +1,18 @@
+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 TestDirectoryOption < Test::Unit::TestCase
+  def setup
+    ARGV.clear
+    ARGV.push('--directory','tests/data/projects/tech_report')
+  end
+  def test_directory_option
+    Dokkit.application.load_rakefile
+    assert_equal('doc', Dokkit.application['doc'].to_s)
+  end
+end

data/tests/test_exception.rb ADDED Viewed

@@ -0,0 +1,7 @@
+def test_exception
+  raise "File doesn't exist" if !File.exists?('null')
+end
+# begin
+#   test_exception
+# end

data/tests/test_filters.rb CHANGED Viewed

	@@ -43,4 +43,4 @@ module Dokkit
43 43
44 44
45 45	end
46	-
46	+

data/tests/test_layout.rb ADDED Viewed

@@ -0,0 +1,64 @@
+#
+# File 'test_layout.rb' created on 15 ott 2007 at 13:24:26.
+# 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_layout.rb
+#
+require 'rubygems'
+require 'test/unit'
+require 'dokkit'
+require 'dokkit/app'
+require 'dokkit/page'
+$LOAD_PATH.unshift File.expand_path(File.join(File.dirname(__FILE__),'../lib'))
+class TestLayout < Test::Unit::TestCase
+  PROJECT_DIR = File.join(Dokkit.tests_dir, 'data/projects/simple_document/')
+  def setup
+    Dir.chdir PROJECT_DIR
+    @simple_document = Rote::Page.new(
+      {
+      :fn => 'simple_document.dpl',
+      :pages_dir => 'doc/pages',
+      :layout_dir => 'doc/layouts',
+      :config_dir => 'doc/config',
+      :layout_defext => '.html',
+      :template_defext => '.dpl'
+      }
+    )
+    @simple_document_without_layout = Rote::Page.new(
+      {
+      :fn => 'simple_document_without_layout.dpl',
+      :pages_dir => 'doc/pages',
+      :layout_dir => 'doc/layouts',
+      :config_dir => 'doc/config',
+      :layout_defext => '.html',
+      :template_defext => '.dpl'
+      }
+    )
+    @another_simple_document = Rote::Page.new(
+      {
+      :fn => 'another_simple_document.dpl',
+      :pages_dir => 'doc/pages',
+      :layout_dir => 'doc/layouts',
+      :config_dir => 'doc/config',
+      :layout_defext => '.html',
+      :template_defext => '.dpl'
+      }
+    )
+  end
+  def teardown
+  end
+  def test_default_layout
+    assert_equal(['simple_document.html'], @simple_document.instance_eval { @layout_names })
+    assert_equal(['simple_document.html'], @simple_document_without_layout.instance_eval { @layout_names })
+  end
+  def test_overrided_layout
+    assert_equal(['another_simple_document.html'], @another_simple_document.instance_eval { @layout_names })
+  end
+end

data/tests/test_options.rb ADDED Viewed

@@ -0,0 +1,33 @@
+begin
+  require 'rubygems'
+rescue LoadError
+  nil
+end
+# make sure we're testing this version, not an installed Gem!
+$LOAD_PATH.unshift File.expand_path(File.join(File.dirname(__FILE__),'../lib'))
+require 'test/unit'
+require 'dokkit'
+require 'dokkit/app'
+require 'rake'
+# set dokkit_lib path
+$:.each do |it|
+    if File.exists?(File.join(it,'dokkit/builtin.rake'))
+      DOKKIT_LIB = it
+      break
+    end
+end
+class TestOption < Test::Unit::TestCase
+  def test_change_dir
+    Dokkit::Application.new DOKKIT_LIB do |dokkit|
+      dokkit.do_option('--directory','/home/andrea')
+      dokkit.do_option('--tasks',nil)
+      dokkit.run
+      assert_equal('/home/andrea',Dir.pwd)
+    end
+  end
+end

data/tests/test_project_tasks.rb ADDED Viewed

@@ -0,0 +1,48 @@
+#
+# File 'test_project_tasks.rb' created on 09 ott 2007 at 17:04:01.
+# 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_project_tasks.rb
+#
+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 TestProjectTask < Test::Unit::TestCase
+  PROJECT_DIR = File.join(Dokkit.tests_dir, 'data/projects')
+  def setup
+  end
+  def teardown
+    Dokkit.application.run ['--directory', File.join(PROJECT_DIR, 'simple-document'), 'clobber']
+  end
+  def test_default_render_task
+    Dokkit.application.run ['--directory', File.join(PROJECT_DIR, 'simple-document')]
+    File.open(File.join(PROJECT_DIR, 'simple-document/html/simple_document.html')) do |file|
+      assert_equal('<html>', file.gets.chomp)
+    end
+    File.open(File.join(PROJECT_DIR, 'simple-document/html/another_simple_document.html')) do |file|
+      assert_equal('<html> <!-- Custom layout for simple_document -->', file.gets.chomp)
+    end
+    File.open(File.join(PROJECT_DIR, 'simple-document/html/simple_document_without_layout.html')) do |file|
+      assert_equal('<html>', file.gets.chomp)
+    end
+  end
+  def test_render_tex_task
+    Dokkit.application.run ['--directory', File.join(PROJECT_DIR, 'simple-document'), 'render_tex']
+    File.open(File.join(PROJECT_DIR, 'simple-document/tex/simple_document.tex')) do |file|
+      assert_match(/documentclass/, file.gets.chomp)
+    end
+    File.open(File.join(PROJECT_DIR, 'simple-document/tex/another_simple_document.tex')) do |file|
+      assert_match(/documentclass.*% custom/, file.gets.chomp)
+    end
+  end
+end