dokkit 0.2.0 → 0.3.0

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

data/spec/data/test_build/tasks/render.rake

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

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

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

data/spec/document_spec.rb

@@ -0,0 +1,321 @@
+#
+# File 'document_spec.rb' created on 13 gen 2008 at 17:46:37.
+# 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/document_spec.rb
+#
+
+$LOAD_PATH.unshift File.expand_path(File.join(File.dirname(__FILE__),'../lib'))
+
+require 'rubygems'
+require 'spec'
+require 'dokkit'
+require 'dokkit/document'
+require 'dokkit/pathhelper'
+require 'dokkit/filters/all'
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe 'a configured Document instance', :shared => true do
+  include SpecPathHelper, CaptureStdout
+  before(:all) do
+    @initial_dir = Dir.pwd
+    Dir.chdir(File.join(File.dirname(__FILE__), SpecPathHelper::DATA_TEST_DIR))        
+  end
+  before do
+    @cache = Dokkit::CacheManager.instance
+    @cache.init('deps.yaml', '.cache')    
+    @config = mock('config')
+    @config.should_receive(:document_dir).at_least(1).and_return(document_path)
+    @config.should_receive(:config_dir).at_least(1).and_return(config_path)    
+    @config.should_receive(:layout_dir).at_least(1).and_return(layout_path)    
+    @config.should_receive(:output_dir).at_least(1).and_return(output_path)    
+  end
+  after(:all) do
+    Dir.chdir(@initial_dir)
+  end  
+end
+
+describe Dokkit::Document, ' when initialized with document_1' do
+
+  it_should_behave_like 'a configured Document instance'
+  
+  before do
+    @document = Dokkit::Document.new(document_path('document_1'), @config)
+  end
+  it 'should be initialized with the name of the source file' do
+    @document.document.should == document_path('document_1')
+  end
+  it 'should get the basename of the source file' do
+    @document.document_basename.should == 'document_1'
+  end
+  it 'should resolve its configuration files' do
+    @document.configs.should == [
+      config_path('document_1.yaml'),
+      document_path('COMMON.yaml'),
+      document_path('document_1.yaml'),
+      config_path('required.yaml')
+    ]
+  end
+  it 'should read the configuration files and fill a configuration hash' do
+    @document.configuration.should_not be_empty
+  end
+  it 'should read document source file' do
+    @document.source_text.should =~ /\* Title for document_1/
+  end
+  it 'should define output targets' do
+    @document.targets['html'].should == output_path('document_1.html')
+    @document.targets['tex'].should == output_path('latex/document_1.latex')
+  end
+  it 'should define layouts grouped by output target' do
+    @document.layouts['html'].should == [layout_path('document_1.html')]
+    @document.layouts['tex'].should == [layout_path('document_1.latex')]
+  end
+  it 'should know the filters to use for rendering in the given output format' do
+    @document.filter_chain['html'].should == ['deplate-html']
+    @document.filter_chain['tex'].should == ['deplate-latex']
+  end
+  it 'should return the list of prerequisites grouped by output format' do
+    @document.prerequisites['html'].should include(
+      document_path('document_1'),
+      config_path('document_1.yaml'),
+      config_path('required.yaml'),
+      document_path('document_1.yaml'),
+      document_path('COMMON.yaml'),
+      layout_path('document_1.html')
+     )
+  end
+  describe ' and rendered in html' do
+    before do
+      @result = @document.render('html')
+    end
+    it 'should execute embedded erb code and render the document' do
+      @result.should =~ /test embedded erb/
+    end
+    it 'should render the content of the configuration hash' do
+      @result.should =~ /test configuration rendering/
+      @result.should =~ /test the correct merge/
+    end
+    it 'should return a default value if a configuration key is not found' do
+      @document.configuration['notexist'].should match(/'notexist' not defined/)
+    end
+    it 'should know which is the current format' do
+      @result.should =~ /Current rendering format is: html/
+    end
+    it 'should apply filters to render in html format' do
+     @result.should =~ /\<h1.*\>.*\<\/h1\>/
+    end
+    it 'should render partial inside it' do
+     @result.should =~ /partial should be rendered/
+    end
+  end
+  describe ' and rendered in tex' do
+    before do
+      @result = @document.render('tex')
+    end
+    it 'should apply filters to render in html format' do
+     @result.should =~ /\\section\{.*\}/
+    end
+  end  
+end
+
+describe Dokkit::Document, ' when initialized with document_nolayout.ext' do
+
+  it_should_behave_like 'a configured Document instance'
+
+  before do
+    @document = Dokkit::Document.new(document_path('document_nolayout.ext'), @config)
+  end  
+  it 'should define output targets' do
+    @document.targets['html'].should == output_path('document_nolayout.html')
+  end
+  it 'should set a nil layout' do
+    @document.layouts['html'].should be_empty
+  end
+  it 'should know the filters to use for rendering in the given output format' do
+    @document.filter_chain['html'].should == ['deplate-html']
+  end
+  it 'should return the list of prerequisites grouped by output format' do
+    @document.prerequisites['html'].should include(
+      document_path('document_nolayout.ext'),
+      document_path('document_nolayout.yaml'),
+      document_path('COMMON.yaml')
+     )
+  end  
+  it 'should resolve its configuration files' do
+    @document = Dokkit::Document.new(document_path('document_nolayout.ext'), @config)     
+    @document.configs.should == [
+      document_path('COMMON.yaml'),
+      document_path('document_nolayout.yaml'),
+    ]
+  end  
+  it 'should raise a -layout not found- warning' do
+    capture_stderr do 
+      @document = Dokkit::Document.new(document_path('document_nolayout.ext'), @config) 
+    end.should match(/Layout not found/)
+  end
+  describe ' and rendered in html' do
+    before do
+      @document = Dokkit::Document.new(document_path('document_nolayout.ext'), @config)       
+      @result = @document.render('html')
+    end
+    it 'should apply filters to render in html format' do
+     @result.should =~ /\<h1.*\>.*\<\/h1\>/
+    end
+  end
+end
+
+describe Dokkit::Document, ' when initialized with subdir/document_4' do
+
+  it_should_behave_like 'a configured Document instance'
+  
+  before do
+    @document = Dokkit::Document.new(document_path('subdir/document_4'), @config)
+  end
+  it 'should get the basename of the source file' do
+    @document.document_basename == 'document_4'
+  end
+  it 'should resolve its configuration files' do
+    @document.configs.should == [
+      config_path('subdir/document_4.yaml'),
+      File.expand_path(document_path('COMMON.yaml')),
+      document_path('subdir/COMMON.yaml'),
+    ]
+  end
+  it 'should define output targets' do
+    @document.targets['html'].should == output_path('subdir/document_4.html')
+  end
+  it 'should define layouts grouped by output format' do
+    @document.layouts['html'].should == [layout_path('document_1.html')]
+  end
+  it 'should know the filters to use for rendering in the given output format' do
+    @document.filter_chain['html'].should == ['deplate-html']
+  end
+  it 'should resolve relative path' do
+    @document.relative('/images/image.img').should == '../images/image.img'
+  end
+  describe ' and rendered in html' do
+    before do
+      @result = @document.render('html')
+    end
+    it 'should apply filters to render in html format' do
+     @result.should =~ /\<h1.*\>.*\<\/h1\>/
+    end
+   end
+end
+
+describe Dokkit::Document, ' when initialized with subdir/subdir/document_6' do
+
+  it_should_behave_like 'a configured Document instance'
+  
+  before do
+    @document = Dokkit::Document.new(document_path('subdir/subdir/document_6'), @config)
+  end
+  it 'should resolve its configuration files' do
+    @document.configs.should == [
+      File.expand_path(document_path('COMMON.yaml')),
+      File.expand_path(document_path('subdir/COMMON.yaml')),
+      document_path('subdir/subdir/COMMON.yaml'),
+    ]
+  end
+  it 'should define output targets' do
+    @document.targets['html'].should == output_path('subdir/subdir/document_6.html')
+  end
+  it 'should define layouts grouped by output target' do
+    @document.layouts['html'].should == [layout_path('document_1.html')]
+  end
+end
+
+describe Dokkit::Document, ' when initialized with document_7' do
+
+  it_should_behave_like 'a configured Document instance'
+  
+  before do
+    @document = Dokkit::Document.new(document_path('document_7'), @config)
+  end
+  it 'should resolve its configuration files' do
+    @document.configs.should == [
+      document_path('COMMON.yaml'),
+      document_path('document_7.yaml'),
+    ]
+  end
+  it 'should define output targets' do
+    @document.targets['html'].should == output_path('document_7.html')
+  end
+  it 'should define layouts grouped by output target' do
+    @document.layouts['html'].should == [layout_path('document_1.html')]
+  end
+  describe ' and rendered in html using maruku filter' do
+    before do
+      @result = @document.render('html')
+    end
+    it 'should apply filters to render in html format' do
+     @result.should =~ /\<h1.*\>.*\<\/h1\>/
+    end
+  end
+  describe ' and rendered using a not defined target format' do
+    it 'should raise an error' do
+      lambda { 
+        @document.render('notexistent')
+      }.should raise_error(RuntimeError, /Don't know how to render in '.*' format!/)
+    end    
+    it 'should warn that a filter was not found' do
+      capture_stderr do
+        @document.render('html')
+      end.should match(/Filter '.*' not found/)
+    end        
+  end
+end
+
+describe Dokkit::Document, ' when initialized with document_with_partials' do
+
+  it_should_behave_like 'a configured Document instance'
+
+  before do
+    @document = Dokkit::Document.new(document_path('document_with_partials'), @config)
+  end  
+  describe ' and rendered in html' do
+    it 'should fail if a circular dependency is detected' do
+      lambda { @document.render('html') }.should raise_error(RuntimeError, /Circular dependency detected in/)      
+    end
+  end
+end
+
+describe Dokkit::Document, ' when initialized with document_nested' do
+
+  it_should_behave_like 'a configured Document instance'
+
+  before do
+    @result = Dokkit::Document.new(document_path('document_nested'), @config).render('html')
+  end  
+  describe ' and rendered in html' do
+    it 'should render nested layout' do
+      @result.should match(/<div class=\"nested\"/)
+    end
+  end
+end
+
+describe Dokkit::Document, ' when initialized with document_3' do
+
+  it_should_behave_like 'a configured Document instance'
+  
+  before do
+    @document = Dokkit::Document.new(document_path('document_3'), @config)
+  end
+  it 'should read the meta configuration inside it' do
+    @document.configuration['key'].should == 'value'
+  end
+  it 'should collect config file in meta configuration' do
+    @document.configs.should == [
+      document_path('COMMON.yaml'),
+      config_path('document_1.yaml'),
+    ]    
+  end
+  it 'should read configuration from config file' do
+    @document.configuration['test_config_merge'].should match(/test the correct merge/)
+  end
+end
+

data/spec/dokkitlib_spec.rb

@@ -0,0 +1,63 @@
+#                                                                          
+# File 'dokkitlib_spec.rb' created on 18 feb 2008 at 17:49:23.                    
+# 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/dokkitlib_spec.rb                                                  
+#                                                                          
+
+
+$LOAD_PATH.unshift(File.expand_path(File.join(File.dirname(__FILE__),'../lib')))
+
+require 'rubygems'
+require 'spec'
+require 'dokkit'
+require 'dokkit/dokkitlib'
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe Dokkit::DokkitLib, ' when initialized' do
+  include SpecPathHelper
+  
+  before do
+    class Dokkit::DokkitLib
+      private
+      def define_dokkit_task
+        dokkit_task 'test' => 'dep'
+      end
+      def pre_block_configuration
+        @config.another_test_option = 'default value'
+      end
+      def post_block_configuration
+        @config.yet_another_test_option = @config.test_option
+      end
+    end
+    model = mock('model')
+    model.should_receive(:config).and_return(OpenStruct.new)
+    @dokkittask = Dokkit::DokkitLib.new(model, 'dokkit') do |task|
+      task.config.test_dir = 'test_dir/'
+      task.config.test_option = 'test_option'
+    end
+  end
+  it 'should define a namespace for its tasks' do
+    @dokkittask.ns.should_not be_empty
+  end
+  it 'should be initialized with a configuration hash' do
+    @dokkittask.config.test_dir.should == 'test_dir/'
+    @dokkittask.config.test_option.should == 'test_option'
+  end
+  it 'should do pre configuration' do
+    @dokkittask.config.another_test_option.should == 'default value'
+  end
+  it 'should do post configuration' do
+    @dokkittask.config.yet_another_test_option.should == @dokkittask.config.test_option
+  end
+  it 'should encapsulate the tasks defined in its namespace' do
+    task('dokkit:test').prerequisites.should == ['dep']
+  end
+  it 'should define the same task only once' do
+    @dokkittask.dokkit_task('test' => 'dep').should be_nil
+  end
+end

data/spec/filehelper_spec.rb

@@ -0,0 +1,34 @@
+#                                                                          
+# File 'filehelper_spec.rb' created on 28 feb 2008 at 16:44:07.                    
+# 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/filehelper_spec.rb                                                  
+#                                                                          
+
+
+$LOAD_PATH.unshift(File.expand_path(File.join(File.dirname(__FILE__),'../lib')))
+
+require 'rubygems'
+require 'spec'
+require 'dokkit'
+require 'dokkit/extension/filehelper'
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe Dokkit::Extension::FileHelper do
+  before do
+    @document = mock('document')
+    @document.extend Dokkit::Extension::FileHelper
+  end
+  it 'should resolve the absolute path name' do
+    @taskconfig = mock('taskconfig')
+    @taskconfig.should_receive(:document_dir).and_return('doc/pages')
+    @document.should_receive(:taskconfig).and_return(@taskconfig)
+    @document.should_receive(:document).and_return('doc/pages/subdir/document.ext')
+    @document.relative('/images/image.img').should == '../images/image.img'
+  end
+end
+