dokkit 0.3.0 → 0.4.0

data/spec/cachemanager_spec.rb

@@ -1,107 +0,0 @@
-#                                                                          
-# File 'cachemanager_spec.rb' created on 28 gen 2008 at 18:31:31.                    
-# See 'dokkit.rb' or +LICENSE+ for licence information.                      
-#                                                                          
-# (c)2006, 2007 Andrea Fazzi <andrea.fazzi@alca.le.it> (and contributors). 
-#                                                                          
-# To execute this spec run:                                            
-#                                                                          
-# spec spec/cachemanager_spec.rb                                                  
-#                                                                          
-
-
-$LOAD_PATH.unshift File.expand_path(File.join(File.dirname(__FILE__),'../lib'))
-
-require 'rubygems'
-require 'spec'
-require 'dokkit'
-require 'dokkit/cachemanager'
-require File.dirname(__FILE__) + '/spec_helper.rb'
-
-describe Dokkit::CacheManager do
-  include SpecPathHelper
-
-  describe '#init' do
-    before do
-      mkdir base_path('.cache_test') unless File.exists?(base_path('.cache_test'))
-      File.open(base_path('.cache_test/deps.rake'), 'w') do |file|
-        file.write YAML::dump({ output_path('document_1.out') => [document_path('document_1.dep')] })
-      end
-      @cache = Dokkit::CacheManager.instance
-      @cache.init('deps.rake', base_path('.cache_test'))
-    end
-    it 'should import the cache file (if exists)' do
-      task(output_path('document_1.out')).prerequisites.should include(document_path('document_1.dep'))
-    end
-    it 'should update @deps to reflect imported tasks and dependencies' do
-      @cache.deps[output_path('document_1.out')].should == [document_path('document_1.dep')]
-    end
-    after do
-      @cache.instance_eval { @deps.clear }
-      rm_rf base_path('.cache_test')
-      @cache = nil
-    end
-  end
-  describe '#add_dependency' do
-    before do
-      @cache = Dokkit::CacheManager.instance
-      @cache.init('deps.rake', base_path('.cache_test'))
-    end  
-    it 'should add dependecies to the given task' do
-      @cache.add_dependency(output_path('document_1.out'), 'doc/pages/document_1.dep')
-      @cache.deps.should == {output_path('document_1.out') => ['doc/pages/document_1.dep']}
-      @cache.add_dependency(output_path('document_1.out'), 'doc/pages/document_2.dep')
-      @cache.add_dependency(output_path('document_1.out'), 'doc/pages/document_3.dep')
-      @cache.deps.should == {output_path('document_1.out') => [
-          'doc/pages/document_1.dep',
-          'doc/pages/document_2.dep',
-          'doc/pages/document_3.dep'
-        ]}
-    end
-    it 'should not add an existing dependency to the given task' do
-      @cache.add_dependency(output_path('document_1.out'), 'doc/pages/document_1.dep')
-      @cache.add_dependency(output_path('document_1.out'), 'doc/pages/document_1.dep')
-      @cache.add_dependency(output_path('document_1.out'), 'doc/pages/document_2.dep')
-      @cache.deps.should == {output_path('document_1.out') => ['doc/pages/document_1.dep', 'doc/pages/document_2.dep']}      
-    end
-    after do
-      @cache.instance_eval { @deps.clear }
-      rm_rf base_path('.cache_test')
-      @cache = nil
-    end      
-  end
-  describe '#clean' do
-    before do
-      @cache = Dokkit::CacheManager.instance
-      @cache.init('deps.rake', base_path('.cache_test'))
-      @cache.add_dependency(output_path('document_1.out'), 'doc/pages/document_1.dep')
-      @cache.save
-    end
-    it 'should remove cache directory from base path' do
-      @cache.clean
-      @cache.instance_eval { @deps }.should be_empty
-      File.exists?(base_path('.cache_test')).should be_false
-    end
-    after do
-      @cache.clean
-      @cache = nil
-    end      
-  end
-  describe '#save' do
-    before do
-      @cache = Dokkit::CacheManager.instance
-      @cache.init('deps.rake', base_path('.cache_test'))
-      @cache.add_dependency('output/document_1.out', 'doc/pages/document_1.dep')
-      @cache.add_dependency('output/document_1.out', 'doc/pages/document_2.dep')
-      @cache.add_dependency('output/document_1.out', 'doc/pages/document_3.dep')
-    end  
-    it 'should save the dependencies to file' do
-      @cache.save
-      File.exists?(base_path('.cache_test/deps.rake')).should be_true
-    end
-    after do
-      @cache.clean
-      @cache = nil
-    end  
-  end
-end

data/spec/cleantask_spec.rb

@@ -1,72 +0,0 @@
-#                                                                          
-# File 'clean_spec.rb' created on 19 feb 2008 at 19:30:45.                    
-# See 'dokkit.rb' or +LICENSE+ for licence information.                      
-#                                                                          
-# (c)2008 Andrea Fazzi <andrea.fazzi@alca.le.it> (and contributors). 
-#                                                                          
-# To execute this spec run:                                            
-#                                                                          
-# spec spec/clean_spec.rb                                                  
-#                                                                          
-
-
-$LOAD_PATH.unshift(File.expand_path(File.join(File.dirname(__FILE__),'../lib')))
-
-require 'rubygems'
-require 'spec'
-require 'dokkit'
-require 'dokkit/rendertask'
-require 'dokkit/cleantask'
-require File.dirname(__FILE__) + '/spec_helper.rb'
-
-describe Dokkit::CleanTask do
-  include SpecPathHelper
-  before(:all) do
-    @initial_dir = Dir.pwd
-    Dir.chdir(File.join(File.dirname(__FILE__), SpecPathHelper::DATA_TEST_DIR))    
-  end  
-  before do
-    Rake.application.clear
-    model = mock('model')
-    model.should_receive(:config).and_return(Dokkit::TaskConfig.new)        
-    @cleantask = Dokkit::CleanTask.new(model, 'clean') do |task|
-      task.config.output_dir = output_path
-    end
-    mkdir_p output_path
-    mkdir_p cache_path
-  end
-  after do
-    rmdir output_path if File.exists?(output_path)
-    rmdir cache_path if File.exists?(cache_path)    
-  end
-  after(:all) do
-    Dir.chdir(@initial_dir)
-  end
-  it 'should be initialized with the output directory' do
-    @cleantask.config.output_dir.should == output_path
-  end
-  describe ' when clean:output is invoked' do
-    it 'should remove output directory' do
-      task('clean:output').invoke
-      File.exists?(@cleantask.config.output_dir).should be_false
-    end
-  end
-  describe ' when clean:cache is invoked' do
-    before do
-      Rake.application.clear
-      model = mock('model')
-      cache = mock('cache')
-      cache.should_receive(:cache_dir).and_return(cache_path)         
-      cache.should_receive(:clean)            
-      model.should_receive(:config).and_return(Dokkit::TaskConfig.new)        
-      model.should_receive(:cache).twice.and_return(cache)            
-      @cleantask = Dokkit::CleanTask.new(model, 'clean') do |task|
-        task.config.output_dir = output_path
-      end
-    end    
-    it 'should call CacheManager#clean method to remove cache' do
-      task('clean:cache').invoke
-    end
-  end
-end
-

data/spec/data/test_build/doc/configs/document_1.yaml

@@ -1,3 +0,0 @@
----
-test_config_merge: This is to test the correct merge of document configuration keys.
-

data/spec/data/test_build/doc/configs/required.yaml

@@ -1,3 +0,0 @@
----
-required_key: required value for document_1
-  

data/spec/data/test_build/doc/configs/subdir/document_4.yaml

@@ -1,3 +0,0 @@
----
-document:
-  test_config: This is to test configuration rendering.

data/spec/data/test_build/doc/layouts/document_1.html

@@ -1,9 +0,0 @@
-<html>
-<head>
-  <title>A changed title</title>
-</head>
-<body>
-  <%= render_partial('partials/partial') %>
-  <%= @content_for_layout %>
-</body>
-</html>

data/spec/data/test_build/doc/layouts/document_with_partials.html

@@ -1,9 +0,0 @@
-<html>
-<head>
-  <title>A changed title</title>
-</head>
-<body>
-  <%= render_partial('partials/circular_partial') %>
-  <%= @content_for_layout %>
-</body>
-</html>

data/spec/data/test_build/doc/layouts/layout.html

@@ -1,8 +0,0 @@
-<html>
-<head>
-  <title>A title</title>
-</head>
-<body>
-  <%= @content_for_layout %>
-</body>
-</html>

data/spec/data/test_build/doc/layouts/layout.html.backup

@@ -1,8 +0,0 @@
-<html>
-<head>
-  <title>A title</title>
-</head>
-<body>
-  <%= @content_for_layout %>
-</body>
-</html>

data/spec/data/test_build/doc/layouts/partials/partial.html

@@ -1,4 +0,0 @@
-<div class="partial">
-<%= @content_for_layout %>
-</div>
-

data/spec/data/test_build/doc/pages/COMMON.yaml

@@ -1,6 +0,0 @@
----
-layout: document_1
-test_common_key: common value for all the documents in the current directory
-
-
-      

data/spec/data/test_build/doc/pages/document_1

@@ -1,20 +0,0 @@
-* Title for document_1
-Body of document_1
-
- * item 1
- * item 2
- * item 3
-
-<%= configuration['test_config'] %>
-
-<%= configuration['notexists'] %>
-
-<%= configuration['test_config_merge'] %>
-
-<%= "Current rendering format is: #{@format}" %>
-
-* Section
-
-<%= "This is to test embedded " + "e"+"r"+"b" + " in document_1 source file." %>
-
-

data/spec/data/test_build/doc/pages/document_1.dep

@@ -1,4 +0,0 @@
-CHANGED!!!
-
-
-

data/spec/data/test_build/doc/pages/document_1.yaml

@@ -1,11 +0,0 @@
----
-test_config: This is to test configuration rendering.
-config:
-- required
-render_in:
-- html
-- tex:
-    filters:
-    - deplate-latex
-    ext: .latex
-    output: latex

data/spec/data/test_build/doc/pages/document_2

@@ -1,9 +0,0 @@
-* Title for document_2
-Body of document_2
-
- * item 1
- * item 2
- * item 3
-
-* Section
-Body of section

data/spec/data/test_build/doc/pages/document_2.yaml

@@ -1,6 +0,0 @@
----
-document:
-  render:
-    output: document_2
-    ext: .htm
-    

data/spec/data/test_build/doc/pages/document_3

@@ -1,13 +0,0 @@
----
-key: value
-config: document_1
----
-* Title for document_3
-Body of document_3
-
- * item 1
- * item 2
- * item 3
-
-* Section
-Body of section

data/spec/data/test_build/doc/pages/document_7

@@ -1,4 +0,0 @@
-# Heading
-
-Body of the paragraph.
-

data/spec/data/test_build/doc/pages/document_7.yaml

@@ -1,5 +0,0 @@
-render_in:
-- html:
-    filters:
-    - maruku-html
-    - notexists

data/spec/data/test_build/doc/pages/document_extended

@@ -1 +0,0 @@
-Test the extension: <%= extension %>

data/spec/data/test_build/doc/pages/document_nested

@@ -1,6 +0,0 @@
----
-key: value
----
-A document that uses nested layouts.
-
-

data/spec/data/test_build/doc/pages/document_nested.yaml

@@ -1,5 +0,0 @@
----
-layout:
-- document_1
-- nested
-

data/spec/data/test_build/doc/pages/document_nolayout.ext

@@ -1,3 +0,0 @@
-* document without layout
-
-This is to test the rendering of a document without layout

data/spec/data/test_build/doc/pages/document_nolayout.yaml

@@ -1,2 +0,0 @@
----
-layout: notexists

data/spec/data/test_build/doc/pages/document_with_partials

@@ -1,3 +0,0 @@
-* Title for document_with_partials
-Body of document_with_partials
-

data/spec/data/test_build/doc/pages/document_with_partials.yaml

@@ -1,2 +0,0 @@
----
-layout: document_with_partials

data/spec/data/test_build/doc/pages/partials/COMMON.yaml

@@ -1,5 +0,0 @@
----
-layout: partials/partial
-
-
-

data/spec/data/test_build/doc/pages/partials/circular_partial

@@ -1,2 +0,0 @@
-This partial should be rendered in document_with_partials
-

data/spec/data/test_build/doc/pages/partials/circular_partial.yaml

@@ -1,3 +0,0 @@
----
-layout: document_with_partials
-

data/spec/data/test_build/doc/pages/partials/partial

@@ -1,2 +0,0 @@
-This partial should be rendered in document_with_partials
-

data/spec/data/test_build/doc/pages/subdir/COMMON.yaml

@@ -1,2 +0,0 @@
----
-test_common_key_in_subdir: common key for all the documents in the current directory

data/spec/data/test_build/doc/pages/subdir/document_4

@@ -1,11 +0,0 @@
-* Title for document_4
-Body of document_4
-
- * item 1
- * item 2
- * item 3
-
-* Section
-Body of section
-
-

data/spec/data/test_build/doc/pages/subdir/subdir/COMMON.yaml

@@ -1,2 +0,0 @@
----
-test_common_key_in_subdir_subdir: common value for all the documents in the current directory

data/spec/data/test_build/doc/pages/subdir/subdir/document_6

@@ -1,3 +0,0 @@
-* Title for document_6
-
-Content of document_6

data/spec/data/test_build/tasks/all.rb

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

data/spec/data/test_build/tasks/clean.rake

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

data/spec/data/test_build/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*', '*.dep')
-  task.data.include('**/*')
-end

data/spec/data/test_build/tasks/setup.rb

@@ -1,9 +0,0 @@
-require 'dokkit/model'
-
-MODEL = Dokkit::Model.init({'name' => 'test', 'from' => '.'}) 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/spec/data/test_build/tasks/template.rake

@@ -1,3 +0,0 @@
-require 'dokkit/templatetask'
-
-Dokkit::TemplateTask.new(MODEL, 'template')