dokkit 0.3.0 → 0.4.0

data/spec/document_spec.rb

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

@@ -1,63 +0,0 @@
-#                                                                          
-# 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/fileselection_spec.rb

@@ -1,101 +0,0 @@
-#                                                                          
-# File 'fileselect_spec.rb' created on 07 feb 2008 at 15:46:04.                    
-# 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/fileselect_spec.rb                                                  
-#                                                                          
-
-
-$LOAD_PATH.unshift(File.expand_path(File.join(File.dirname(__FILE__),'../lib')))
-
-require 'rubygems'
-require 'spec'
-require 'dokkit'
-require 'dokkit/fileselection'
-require File.dirname(__FILE__) + '/spec_helper.rb'
-
-describe Dokkit::FileSelection, ' when initialized' do
-  include SpecPathHelper
-  before(:all) do
-    @initial_dir = Dir.pwd
-    Dir.chdir(File.join(File.dirname(__FILE__), SpecPathHelper::DATA_TEST_DIR))        
-  end  
-  it 'should set the current dir as default base path' do
-    fs = Dokkit::FileSelection.new
-    fs.base_dir.should == '.'
-  end
-  it 'should set the given directory as the base path for all operations' do
-    fs = Dokkit::FileSelection.new(document_path)
-    fs.base_dir.should == document_path
-  end
-  
-  after(:all) do
-    Dir.chdir(@initial_dir)
-  end  
-end
-
-describe Dokkit::FileSelection, ' when extended with ExtMapping' do
-  include SpecPathHelper
-  before(:all) do
-    @initial_dir = Dir.pwd
-    Dir.chdir(File.join(File.dirname(__FILE__), SpecPathHelper::DATA_TEST_DIR))
-    @fs = Dokkit::FileSelection.new(document_path) do |fs|
-      fs.include('*')
-    end
-    @fs.extend Dokkit::ExtMapping
-  end  
-  it 'should map an extension for document_1' do
-    @fs.extend(/document_1$/) { "extended" }    
-    @fs.extmapping.should have(1).items
-    @fs.extmapping[document_path('document_1')].call.should == "extended"
-  end
-  it 'should map an extension for all documents' do
-    @fs.extend { "extended" }
-    @fs.extmapping.should have(18).items    
-  end
-  after(:all) do
-    Dir.chdir(@initial_dir)
-  end  
-end
-
-describe Dokkit::FileSelection, '#files' do
-  include SpecPathHelper
-  before(:all) do
-    @initial_dir = Dir.pwd
-    Dir.chdir(File.join(File.dirname(__FILE__), SpecPathHelper::DATA_TEST_DIR))            
-  end  
-  it 'should return an array with the list of the included files in the given directory' do
-    Dokkit::FileSelection.new(document_path) do |fs|
-      fs.include('*')
-    end.files.should have(18).items
-  end
-  it 'should not include files that was explicity excluded' do
-    Dokkit::FileSelection.new(document_path) do |fs| 
-      fs.exclude('*.exclude') 
-    end.files.should_not include(document_path('document_5.exclude'))
-  end
-  it 'should include only the files that was explicity included' do
-    Dokkit::FileSelection.new(document_path) do |fs|
-      fs.include('*.yaml')
-    end.files.should include(document_path('COMMON.yaml'))
-  end
-  it 'should not include the same files' do
-    Dokkit::FileSelection.new(document_path) do |fs|
-      fs.include('*')
-      fs.include('*')
-    end.files.should have(18).items
-  end
-  it 'should not include directory' do
-    Dokkit::FileSelection.new(document_path) do |fs|
-      fs.include('**/*')
-    end.files.should_not include(document_path('subdir'))
-  end
-  after(:all) do
-    Dir.chdir(@initial_dir)
-  end    
-end
-

data/spec/filter_base_spec.rb

@@ -1,29 +0,0 @@
-#                                                                          
-# File 'filter_base_spec.rb' created on 18 feb 2008 at 14:48:04.                    
-# 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/filter_base_spec.rb                                                  
-#                                                                          
-
-
-$LOAD_PATH.unshift(File.expand_path(File.join(File.dirname(__FILE__),'../lib')))
-
-require 'rubygems'
-require 'spec'
-require 'dokkit'
-require 'dokkit/filters/base'
-require File.dirname(__FILE__) + '/spec_helper.rb'
-
-describe Dokkit::Filters::Base do
-  before do
-    @filter = Dokkit::Filters::Base.new
-  end
-  it 'should define an instance method to transform the given text' do
-    @result = @filter.filter('text to transform').should be_nil
-  end
-end
-

data/spec/filters_spec.rb

@@ -1,37 +0,0 @@
-#                                                                          
-# File 'filter_spec.rb' created on 15 feb 2008 at 22:25:12.                    
-# 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/filter_spec.rb                                                  
-#                                                                          
-
-
-$LOAD_PATH.unshift(File.expand_path(File.join(File.dirname(__FILE__),'../lib')))
-
-require 'rubygems'
-require 'spec'
-require 'dokkit'
-require 'dokkit/filters'
-require File.dirname(__FILE__) + '/spec_helper.rb'
-
-describe Dokkit::Filters do
-  it 'should register new filters' do
-    Filter = mock('Filter')
-    @filter = mock('filter')
-    Filter.should_receive(:new).and_return(@filter)    
-    @filter.should_receive(:class).and_return('Filter')    
-    Dokkit::Filters.register('filter') do
-      Filter.new
-    end
-    Dokkit::Filters['filter'].class.should == 'Filter'
-  end
-  it 'should raise an error if a non existent filter is called' do
-    lambda { 
-      Dokkit::Filters['notexists']
-    }.should raise_error(RuntimeError, /Filter '.*' is not defined!/)
-  end
-end

data/spec/model_spec.rb

@@ -1,45 +0,0 @@
-#                                                                          
-# File 'model_spec.rb' created on 10 mar 2008 at 13:36:29.                    
-# 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/model_spec.rb                                                  
-#                                                                          
-
-
-$LOAD_PATH.unshift(File.expand_path(File.join(File.dirname(__FILE__),'../lib')))
-
-require 'rubygems'
-require 'spec'
-require 'dokkit' 
-require 'dokkit/model'
-require File.dirname(__FILE__) + '/spec_helper.rb'
-
-describe Dokkit::Model, ' when initialized' do
-  include SpecPathHelper
-  before(:all) do
-    @initial_dir = Dir.pwd
-    Dir.chdir(File.join(File.dirname(__FILE__), SpecPathHelper::DATA_TEST_DIR))    
-  end  
-  before do
-    @model = Dokkit::Model.init do |model|
-      model.config.cache_dir = cache_path
-    end
-  end
-  after(:all) do
-    Dir.chdir(@initial_dir)
-  end  
-  it 'should be instantiated only once' do
-    Dokkit::Model.init.object_id.should == @model.object_id
-  end
-  it 'should be initialized with a name' do
-    Dokkit::Model.init('simpledocument').name == 'simpledocument'
-  end
-  it 'should instantiate a TaskConfig object' do
-    @model.config.class.should == Dokkit::TaskConfig
-  end
-end
-

data/spec/pathhelper_spec.rb

@@ -1,62 +0,0 @@
-#                                                                          
-# File 'pathhelper_spec.rb' created on 15 feb 2008 at 16:36:50.                    
-# 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/pathhelper_spec.rb                                                  
-#                                                                          
-
-
-$LOAD_PATH.unshift(File.expand_path(File.join(File.dirname(__FILE__),'../lib')))
-
-require 'rubygems'
-require 'spec'
-require 'dokkit'
-require 'dokkit/pathhelper'
-require File.dirname(__FILE__) + '/spec_helper.rb'
-
-describe Dokkit::PathHelper do
-  include SpecPathHelper
-  before do
-    @config = mock('config')
-  end
-  it 'should define a method to transform source file path and extension' do
-    source_fn = File.join(SpecPathHelper::DOCUMENT_PATH, 'document')
-    filename_helper(source_fn, SpecPathHelper::DOCUMENT_PATH, 'newdir', '.newext').should == 'newdir/document.newext'
-    source_fn = File.join(SpecPathHelper::DOCUMENT_PATH, 'subdir/document')
-    filename_helper(source_fn, SpecPathHelper::DOCUMENT_PATH, 'newdir', '.newext').should == 'newdir/subdir/document.newext'
-  end
-  it 'should return a configuration filename given a source filename' do
-    @config.should_receive(:document_dir).and_return(SpecPathHelper::DOCUMENT_PATH)
-    @config.should_receive(:config_dir).and_return(SpecPathHelper::CONFIG_PATH)
-    source_fn = File.join(SpecPathHelper::DOCUMENT_PATH, 'document')
-    config_fn_helper(source_fn, @config).should == 'doc/configs/document.yaml'
-  end
-  it 'should return a layout filename given a source filename' do
-    @config.should_receive(:document_dir).twice.and_return(SpecPathHelper::DOCUMENT_PATH)
-    @config.should_receive(:layout_dir).twice.and_return(SpecPathHelper::LAYOUT_PATH)
-    source_fn = File.join(SpecPathHelper::DOCUMENT_PATH, 'document')
-    layout_fn_helper(source_fn, '.html', @config).should == 'doc/layouts/document.html'
-    source_fn = File.join(SpecPathHelper::DOCUMENT_PATH, 'subdir/document')
-    layout_fn_helper(source_fn, '.html', @config).should == 'doc/layouts/subdir/document.html'    
-  end
-  it 'should return a target filename given a source filename' do
-    @config.should_receive(:document_dir).and_return(SpecPathHelper::DOCUMENT_PATH)
-    @config.should_receive(:output_dir).and_return(SpecPathHelper::OUTPUT_PATH)
-    source_fn = File.join(SpecPathHelper::DOCUMENT_PATH, 'document')
-    output_fn_helper(source_fn, '.html', @config).should == 'output/document.html'
-  end  
-  it 'should return a target data filename given a source data filename' do
-    @config.should_receive(:data_dir).and_return(SpecPathHelper::DATA_PATH)
-    @config.should_receive(:output_dir).and_return(SpecPathHelper::OUTPUT_PATH)
-    source_fn = File.join(SpecPathHelper::DATA_PATH, 'resource')
-    data_fn_helper(source_fn, @config).should == 'output/resource'
-  end
-  it 'should define a method to strip extension from file' do
-    strip_ext('test.ext').should == 'test'
-    strip_ext('.test.ext.ext').should == '.test.ext'
-  end
-end