dokkit 0.3.0 → 0.4.0

data/spec/rendertask_spec.rb

@@ -1,374 +0,0 @@
-#                                                                          
-# File 'rendertask_spec.rb' created on 18 feb 2008 at 19:55:16.                    
-# 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/rendertask_spec.rb                                                  
-#                                                                          
-
-
-$LOAD_PATH.unshift(File.expand_path(File.join(File.dirname(__FILE__),'../lib')))
-
-require 'rubygems'
-require 'spec'
-require 'dokkit/cachemanager'
-require 'dokkit/rendertask'
-require File.dirname(__FILE__) + '/spec_helper.rb'
-
-describe 'a non configured RenderTask instance', :shared => true 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 = mock('model')
-    model.should_receive(:config).and_return(Dokkit::TaskConfig.new)        
-    @rendertask = Dokkit::RenderTask.new(model)
-  end
-  after do
-    rm_rf output_path
-    rm_rf cache_path
-    Rake.application = nil
-  end
-  after(:all) do
-    Dir.chdir(@initial_dir)
-  end
-end
-
-describe 'a configured RenderTask instance', :shared => true 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 = mock('model')
-    model.should_receive(:config).and_return(Dokkit::TaskConfig.new)
-    @cache = Dokkit::CacheManager.instance
-    @cache.init('deps.yaml', cache_path)
-    @rendertask = Dokkit::RenderTask.new(model, 'render') do |task|
-      task.config.output_dir = output_path
-      task.config.config_dir = config_path
-      task.config.layout_dir = layout_path
-      task.documents.dir = document_path
-      task.documents.include('**/*')
-      task.documents.exclude('*_extended', '**/*.exclude', '**/*.yaml', '**/*.dep', '**/*partial*')      
-      task.data.dir = data_path
-      task.data.include('**/*')
-      task.data.exclude('**/*.exclude')            
-    end    
-  end
-  after do
-    rm_rf output_path
-    @cache.clean
-    Rake.application = nil
-  end
-  after(:all) do
-    Dir.chdir(@initial_dir)
-  end
-end
-
-describe 'a RenderTask instance initialized with a configuration hash and a block', :shared => true do
-  include SpecPathHelper  
-  before(:all) do
-    @initial_dir = Dir.pwd
-    Dir.chdir(File.join(File.dirname(__FILE__), SpecPathHelper::DATA_TEST_DIR))    
-  end
-  before do
-    @config = mock('config')
-    @config.should_receive(:document_dir).at_least(1).and_return(document_path + '/subdir')
-    @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(:data_dir).at_least(1).and_return(data_path + '/subdir')
-    @config.should_receive(:output_dir).at_least(1).and_return(output_path)
-    @config.should_receive(:cache_dir).at_least(1).and_return(cache_path)    
-    @config.should_receive(:directories).twice.and_return({
-        :document_dir => @config.document_dir,
-        :config_dir => @config.config_dir,
-        :layout_dir => @config.layout_dir,
-        :data_dir => @config.data_dir,
-        :output_dir => @config.output_dir,
-        :cache_dir => @config.cache_dir        
-      })
-    model = mock('model')
-    model.should_receive(:config).and_return(@config)        
-    @rendertask = Dokkit::RenderTask.new(model, 'render') do |task|
-      task.documents.include('*')
-      task.data.include('*')
-    end
-  end
-  after do
-    rm_rf output_path
-    rm_rf cache_path
-    Rake.application = nil
-  end
-  after(:all) do
-    Dir.chdir(@initial_dir)
-  end
-end
-
-describe 'a configured RenderTask instance with an extension block', :shared => true do
-  include SpecPathHelper  
-  before(:all) do
-    @initial_dir = Dir.pwd
-    Dir.chdir(File.join(File.dirname(__FILE__), SpecPathHelper::DATA_TEST_DIR))
-  end
-  before do
-    module Extension
-      def extension
-        "Extension"
-      end
-    end
-    model = mock('model')
-    model.should_receive(:config).and_return(Dokkit::TaskConfig.new)        
-    @rendertask =  Dokkit::RenderTask.new(model, 'render') do |task|
-      task.config.output_dir = output_path
-      task.config.config_dir = config_path
-      task.config.layout_dir = layout_path
-      task.config.document_dir = document_path
-      task.config.data_dir = data_path      
-      task.documents.include('**/*')
-      task.documents.exclude('**/*.exclude', '**/*.yaml', '**/*.dep')
-      task.data.include('**/*')
-      task.data.exclude('**/*.exclude')
-      task.documents.extend(/document_extended$/) { |document| document.extend Extension }
-    end
-  end
-  after do
-    rm_rf output_path
-    rm_rf cache_path
-    Rake.application = nil
-  end
-  after(:all) do
-    Dir.chdir(@initial_dir)
-  end
-end
-
-describe Dokkit::RenderTask, ' when initialized with an empty document dir' do
-  it_should_behave_like 'a non configured RenderTask instance'
-  before do
-    Rake.application.clear
-  end
-  it 'should raise an empty dir error' do
-    lambda { 
-      model = mock('model')
-      model.should_receive(:config).and_return(Dokkit::TaskConfig.new)          
-      @empty =  Dokkit::RenderTask.new(model, 'render') do |task|
-        task.documents.exclude('**/*')
-      end
-      puts @empty.documents.files
-    }.should raise_error(RuntimeError, /No documents found in \'.*\'/)
-  end
-end
-
-describe Dokkit::RenderTask, ' when initialized without a block' do
-  it_should_behave_like 'a non configured RenderTask instance'
-  
-  it 'should be initialized with a default document_dir' do
-    @rendertask.config.document_dir.should == document_path
-    @rendertask.documents.dir == document_path
-  end
-  it 'should be initialized with a default layout_dir' do
-    @rendertask.config.layout_dir.should == layout_path
-  end  
-  it 'should be initialized with a default config_dir' do
-    @rendertask.config.config_dir.should == config_path
-  end
-  it 'should be initialized with a default data_dir' do
-    @rendertask.config.data_dir.should == data_path
-    @rendertask.data.dir.should == data_path
-  end  
-end
-
-describe Dokkit::RenderTask, ' when initialized with a configuration hash and a block' do
-it_should_behave_like 'a RenderTask instance initialized with a configuration hash and a block'
-  
-  it 'should be initialized with a default document_dir' do
-    @rendertask.config.document_dir.should == File.join(document_path, 'subdir')
-    @rendertask.documents.dir.should == File.join(document_path, 'subdir')
-  end
-  it 'should be initialized with the list of documents to render' do
-    @rendertask.documents.files.should have(1).items
-    @rendertask.documents.files.should == [document_path('subdir/document_4')]
-  end  
-  it 'should be initialized with a default layout_dir' do
-    @rendertask.config.layout_dir.should == layout_path
-  end  
-  it 'should be initialized with a default config_dir' do
-    @rendertask.config.config_dir.should == config_path
-  end
-  it 'should be initialized with a default data_dir' do
-    @rendertask.config.data_dir.should == File.join(data_path, 'subdir')
-    @rendertask.data.dir.should == File.join(data_path, 'subdir')
-  end  
-end
-
-describe Dokkit::RenderTask, ' when initialized with a configuration block' do
-  it_should_behave_like 'a configured RenderTask instance'
-
-  it 'should be initialized with the config dir' do
-    @rendertask.config.config_dir.should == config_path
-  end
-  it 'should be initialized with the layout dir' do
-    @rendertask.config.layout_dir.should == layout_path
-  end
-  it 'should be initialized with the data dir' do
-    @rendertask.config.data_dir == data_path
-  end
-  it 'should be initialized with the output dir' do
-    @rendertask.config.output_dir == output_path
-  end
-  it 'should be initialized with the list of documents to render' do
-    @rendertask.documents.files.should have(8).items
-    @rendertask.documents.files.should include(
-      document_path('document_1'),
-      document_path('document_2'),
-      document_path('document_3'),
-      document_path('subdir/document_4'),
-      document_path('subdir/subdir/document_6')
-     )
-  end
-  it 'should be initialized with the list of data to copy' do
-    @rendertask.data.files.should have(2).items
-    @rendertask.data.files.should include(
-      data_path('resource'),
-      data_path('subdir/resource.insubdir')
-     )
-  end  
-  it 'should define single document task and prerequisites' do
-    task(output_path('document_1.html')).prerequisites.should have(6).items    
-    task(output_path('document_1.html')).prerequisites.should include(
-      document_path('document_1'), 
-      config_path('document_1.yaml'),
-      document_path('COMMON.yaml'),
-      document_path('document_1.yaml'),
-      config_path('required.yaml'),
-      layout_path('document_1.html')
-    )
-    task(output_path('latex/document_1.latex')).prerequisites.should have(6).items
-    task(output_path('latex/document_1.latex')).prerequisites.should include(
-      document_path('document_1'),
-      config_path('document_1.yaml'),
-      document_path('COMMON.yaml'),
-      document_path('document_1.yaml'),
-      config_path('required.yaml'),
-      layout_path('document_1.latex')
-    )
-  end
-  it 'should define a render all documents task and prerequisites' do
-    task('render:doc').prerequisites.should have(9).items
-    task('render:doc').prerequisites.should include(
-      output_path('document_7.html'),
-      output_path('document_1.html'),
-      output_path('latex/document_1.latex'),
-      output_path('document_nolayout.html'),
-      output_path('document_2.html'),
-      output_path('document_3.html'),
-      output_path('subdir/subdir/document_6.html'),
-      output_path('subdir/document_4.html')
-    )
-  end
-  it 'should define a data task to copy single data file from data_dir to output_dir' do
-    task(output_path('resource')).prerequisites.should == [data_path('resource')]
-    task(output_path('subdir/resource.insubdir')).prerequisites.should == [data_path('subdir/resource.insubdir')]    
-  end
-  it 'should define a copy_all_data task to copy all data from data_dir to output_dir' do
-    task('render:data').prerequisites.should == [
-      output_path('resource'),
-      output_path('subdir/resource.insubdir')
-    ]
-  end
-  it 'should define a render task to render the documents and copy the data' do
-    task('render:all').prerequisites.should == ['render:doc', 'render:data']
-  end
-end
-
-describe Dokkit::RenderTask, ' when configured with not existent directories' do
-  include SpecPathHelper  
-  before(:all) do
-    @initial_dir = Dir.pwd
-    Dir.chdir(File.join(File.dirname(__FILE__), SpecPathHelper::DATA_TEST_DIR))
-  end
-  it 'should raise an error if document_dir does not exist' do
-    lambda {
-      model = mock('model')
-      model.should_receive(:config).and_return(Dokkit::TaskConfig.new)      
-      @rendertask = Dokkit::RenderTask.new(model, 'render') do |task|
-        task.config.output_dir = output_path
-        task.config.config_dir = 'notexist'
-        task.config.layout_dir = 'notexist'
-        task.config.document_dir = 'notexist'
-        task.config.data_dir = 'notexist'      
-        task.documents.include('**/*')
-        task.documents.exclude('**/*.exclude', '**/*.yaml', '**/*.dep')      
-        task.data.include('**/*')
-        task.data.exclude('**/*.exclude')            
-      end            
-    }.should raise_error(RuntimeError, /Directory '.*' does not exist/) 
-  end
-  after do
-    rm_rf output_path
-    rm_rf cache_path
-    Rake.application = nil
-  end
-  after(:all) do
-    Dir.chdir(@initial_dir)
-  end
-end
-
-describe Dokkit::RenderTask, ' when data task is invoked' do
-  it_should_behave_like 'a configured RenderTask instance'
-
-  it 'should copy resources from data_dir to output_dir' do
-    task('render:data').invoke
-    File.exists?(File.join(output_path('resource'))).should be_true
-  end
-  it 'should copy resources from data_dir/subdir to output_dir/subdir' do
-    task('render:data').invoke
-    File.exists?(File.join(data_path, 'subdir', 'resource.insubdir')).should be_true
-  end
-  it 'should not copy resources that were explicity excluded' do
-    task('render:data').invoke
-    File.exists?(File.join(output_path('resource.exclude'))).should be_false
-  end
-end
-
-describe Dokkit::RenderTask, ' when a single file task is invoked' do
-  it_should_behave_like 'a configured RenderTask instance'  
-
-  it 'should render document_1.html' do
-    task(output_path('document_1.html')).invoke    
-    File.exists?(output_path('document_1.html')).should be_true
-  end
-  it 'should render document_1.latex' do
-    task(output_path('latex/document_1.latex')).invoke    
-    File.exists?(output_path('latex/document_1.latex')).should be_true
-  end  
-end
-
-describe Dokkit::RenderTask, ' when the render task is invoked' do
-  it_should_behave_like 'a configured RenderTask instance'  
-
-  it 'should create document_1.html, document_2.html, latex/document_1.latex, document_3.html, subdir/document_4, subdir/subdir/document_6' do
-    task('render:all').invoke
-    File.exists?(output_path('document_1.html')).should be_true
-    File.exists?(output_path('latex/document_1.latex')).should be_true
-    File.exists?(output_path('document_2.html')).should be_true
-    File.exists?(output_path('document_3.html')).should be_true
-    File.exists?(output_path('subdir/document_4.html')).should be_true    
-    File.exists?(output_path('subdir/subdir/document_6.html')).should be_true        
-  end
-end
-
-describe Dokkit::RenderTask, ' when the render task is invoked for document_extended' do
-  it_should_behave_like 'a configured RenderTask instance with an extension block'
-  
-  it 'should render extended variable' do
-    task(output_path('document_extended.html')).invoke    
-    File.read(output_path('document_extended.html')).should match(/Extension/)
-  end
-end

data/spec/taskconfig_spec.rb

@@ -1,45 +0,0 @@
-#                                                                          
-# File 'taskconfig_spec.rb' created on 29 feb 2008 at 07:45:54.                    
-# 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/taskconfig_spec.rb                                                  
-#                                                                          
-
-
-$LOAD_PATH.unshift(File.expand_path(File.join(File.dirname(__FILE__),'../lib')))
-
-require 'rubygems'
-require 'spec'
-require 'dokkit'
-require 'dokkit/taskconfig'
-require File.dirname(__FILE__) + '/spec_helper.rb'
-
-describe Dokkit::TaskConfig, ' when initialized' do
-  before do
-    @taskconfig = Dokkit::TaskConfig.new do |config|
-      config.a_dir = 'a_dir/'
-      config.a_sub_dir  = 'a_dir/subdir/'
-      config.another_dir = 'another_dir///'
-      config.right_dir = 'right_dir'
-     end
-  end
-  it 'should strip extra slashes from keys with _dir suffix' do
-    @taskconfig.a_dir.should == 'a_dir'
-    @taskconfig.a_sub_dir.should == 'a_dir/subdir'
-    @taskconfig.another_dir.should == 'another_dir'
-    @taskconfig.right_dir.should == 'right_dir'    
-  end
-  it 'should return directory hash' do
-    @taskconfig.directories.should == {
-      :a_dir => 'a_dir',
-      :a_sub_dir => 'a_dir/subdir',
-      :another_dir => 'another_dir',
-      :right_dir => 'right_dir'
-    }
-  end
-end
-

data/spec/templatetask_spec.rb

@@ -1,72 +0,0 @@
-#                                                                          
-# File 'templatetask_spec.rb' created on 03 mar 2008 at 13:11:41.                    
-# 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/templatetask_spec.rb                                                  
-#                                                                          
-
-
-$LOAD_PATH.unshift(File.expand_path(File.join(File.dirname(__FILE__),'../lib')))
-
-require 'rubygems'
-require 'spec'
-require 'dokkit'
-require 'dokkit/templatetask'
-require File.dirname(__FILE__) + '/spec_helper.rb'
-
-describe Dokkit::TemplateTask 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
-    ARGV.clear
-    Rake.application.clear
-    model = mock('model')
-    model.should_receive(:config).and_return(Dokkit::TaskConfig.new)
-    @templatetask = Dokkit::TemplateTask.new(model)
-  end
-  after do
-    rm document_path('template') if File.exists?(document_path('template'))
-    rm layout_path('newlayout') if File.exists?(layout_path('newlayout'))    
-  end
-  after(:all) do
-    Dir.chdir(@initial_dir)
-  end
-  it 'should be initialized with the template dir' do
-    @templatetask.config.template_dir.should == SpecPathHelper::TEMPLATE_PATH
-  end
-  describe ' when create task is invoked' do
-    it 'should copy the given template from template dir to document dir' do
-      task('template:create').invoke('pages/template')
-      File.exists?(document_path('template')).should be_true
-    end
-    it 'should copy the given template from template dir to the given dir' do
-      ARGV.push('template:create[layouts/layout]')
-      ARGV.push('doc/layouts/newlayout')
-      Rake.application.collect_tasks
-      task('template:create').invoke('layouts/layout')
-      File.exists?(layout_path('newlayout')).should be_true
-    end
-    it 'should raise an error if the template file does not exist' do
-      lambda {
-        task('template:create').invoke('pages/notexist') 
-      }.should raise_error(RuntimeError, /Template \'.*\' doesn't exist/)
-    end
-    it 'should inform that the template was copied successfully' do
-      ARGV.push('template:create[layouts/layout]')
-      ARGV.push('doc/layouts/newlayout')
-      Rake.application.collect_tasks
-      capture_stdout {
-        task('template:create').invoke('layouts/layout')        
-      }.should match(/Copy template \'.*\' to/)
-    end
-  end
-end
-
-