dokkit 0.4.1 → 0.4.2

data/spec/dokkit/logging/observers/console_spec.rb

@@ -1,68 +0,0 @@
-#                                                                          
-# File 'consolelog_spec.rb' created on 23 feb 2008 at 16:40:31.                    
-# See 'dokkit.rb' or +LICENSE+ for licence information.                      
-#                                                                          
-# (c) 2006, 2007, 2008 Andrea Fazzi <andrea.fazzi@alca.le.it> (and contributors). 
-#                                                                          
-# To execute this spec run:                                            
-#                                                                          
-# spec spec/consolelog_spec.rb                                                  
-#                                                                          
-
-
-$LOAD_PATH.unshift(File.expand_path(File.join(File.dirname(__FILE__),'../../../../lib')))
-
-require 'rubygems'
-require 'spec'
-require 'dokkit'
-require 'dokkit/logging/observers/console'
-require 'spec/spec_helper.rb'
-
-describe Dokkit::Logging::Observer::Console, ' when initialized' do
-  it 'should reference to a logger instance and attach to it' do
-    @logger = mock('logger')
-    @logger.should_receive(:attach)
-    @consolelog = Dokkit::Logging::Observer::Console.new(@logger)    
-    @consolelog.logger.should_not be_nil
-  end
-end
-
-describe Dokkit::Logging::Observer::Console, ' when logger notifies' do
-  include SpecHelper::CaptureOutput
-  before do
-    @logger = mock('logger')
-    @logger.stub!(:attach)
-    @consolelog = Dokkit::Logging::Observer::Console.new(@logger)
-  end
-  describe ' an error message' do
-    it 'should send the error message to the console' do
-      @logger.stub!(:last_message).and_return({ :text => 'error message', :level => Dokkit::Logging::ERROR })
-      lambda { @consolelog.update }.should raise_error(RuntimeError, /\[ERROR\] error message/)
-    end
-  end
-  describe ' a warning message' do
-    it 'should send the warning message to the console' do
-      @logger.stub!(:last_message).and_return({ :text => 'warning message', :level => Dokkit::Logging::WARNING })
-      capture_stderr do
-        @consolelog.update
-      end.should match(/\[WARNING\] warning message/)
-    end
-  end
-  describe ' an info message' do
-    it 'should send the info message to the console' do
-      @logger.stub!(:last_message).and_return({ :text => 'info message', :level => Dokkit::Logging::INFO })
-      capture_stdout do
-        @consolelog.update
-      end.should match(/\[INFO\] info message/)
-    end
-  end  
-  describe ' a debug message' do
-    it 'should send the debug message the console' do
-      @logger.stub!(:last_message).and_return({ :text => 'debug message', :level => Dokkit::Logging::DEBUG })
-      capture_stdout do
-        @consolelog.update
-      end.should match(/\[DEBUG\] debug message/)
-    end
-  end  
-end
-

data/spec/dokkit/resource/data_spec.rb

@@ -1,32 +0,0 @@
-#                                                                          
-# File 'data_spec.rb' created on 16 apr 2008 at 20:03:08.                    
-# See 'dokkit.rb' or +LICENSE+ for licence information.                      
-#                                                                          
-# (c)2006, 2007, 2008 Andrea Fazzi <andrea.fazzi@alca.le.it> (and contributors). 
-#                                                                          
-# To execute this spec run:                                            
-#                                                                          
-# spec spec/data_spec.rb                                                  
-#                                                                          
-
-$LOAD_PATH.unshift(File.expand_path(File.join(File.dirname(__FILE__),'../../../lib')))
-
-require 'rubygems'
-require 'spec'
-require 'dokkit/resource/data'
-require 'spec/spec_helper.rb'
-
-describe Dokkit::Resource::Data do
-  before do
-    @data = Dokkit::Resource::Data.new('doc/data/data_1')
-  end
-  it 'should respond to :source_fn' do
-    @data.should respond_to(:source_fn)
-  end
-  it 'should respond to :configuration' do
-    @data.should respond_to(:configuration)
-  end
-  it 'should return the target filename' do
-    @data.target_fn.should == 'output/data_1'
-  end
-end

data/spec/dokkit/resource/document_spec.rb

@@ -1,523 +0,0 @@
-#
-# File 'document_spec.rb' created on 17 apr 2008 at 18:01:58.
-# See 'dokkit.rb' or +LICENSE+ for licence information.
-#
-# (c) 2006, 2007, 2008 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/resource/document'
-require 'spec/spec_helper.rb'
-
-describe Dokkit::Resource::Document, '#include' do
-  include SpecHelper::Logger, SpecHelper::Cache, SpecHelper::Configuration, SpecHelper::Resource
-  before(:all) do
-    @initial_dir = Dir.pwd
-    Dir.chdir(File.join(File.dirname(__FILE__), SpecHelper::Path::TEST_DATA))
-  end
-  before do
-    @logger = logger
-    @filter_factory = filter_factory
-    @cache = cache
-    @document = Dokkit::Resource::Document.new('doc/pages/subdir/document.ext',
-                                               configuration,
-                                               @logger,
-                                               @cache,
-                                               @resource_factory,
-                                               @filter_factory)
-    File.stub!(:read).and_return('<%= "erb" %>')
-  end
-  after(:all) do
-    Dir.chdir(@initial_dir)
-  end
-  it 'should read the given file processing it with erb' do
-    File.should_receive(:read).with('included.html').and_return('<%= "erb" %>')
-    @document.include('included.html')
-  end
-  it 'should process the given file with erb' do
-    @erb = ERB.new('<%= "erb" %>')
-    ERB.should_receive(:new).with('<%= "erb" %>').and_return(@erb)
-    @document.include('included.html').should == "erb"
-  end
-  it 'should add the given file as dependency' do
-    @cache.should_receive(:add_dependency).with('doc/pages/subdir/document.ext', 'html', 'included.html')
-    @document.include('included.html')
-  end
-end
-
-describe Dokkit::Resource::Document, ' when inizialized with a code block' do
-  include SpecHelper::Logger, SpecHelper::Cache, SpecHelper::Configuration, SpecHelper::Resource
-  before(:all) do
-    @initial_dir = Dir.pwd
-    Dir.chdir(File.join(File.dirname(__FILE__), SpecHelper::Path::TEST_DATA))
-  end
-  before do
-    module Extension; def foo; end; end
-  end
-  before do
-    @document = Dokkit::Resource::Document.new('doc/pages/subdir/document.ext',
-                                               configuration,
-                                               logger,
-                                               cache,
-                                               resource_factory,
-                                               filter_factory) { |document| document.extend Extension }
-  end
-  after(:all) do
-    Dir.chdir(@initial_dir)
-  end
-  it 'should be extended with Extension module' do
-    @document.respond_to?(:foo).should be_true
-  end
-end
-
-describe Dokkit::Resource::Document, ' when inizialized with document.ext' do
-  include SpecHelper::Logger, SpecHelper::Cache, SpecHelper::Configuration, SpecHelper::Resource
-  before(:all) do
-    @initial_dir = Dir.pwd
-    Dir.chdir(File.join(File.dirname(__FILE__), SpecHelper::Path::TEST_DATA))
-  end
-  before do
-    @logger = logger
-    @filter_factory = filter_factory
-    @document = Dokkit::Resource::Document.new('doc/pages/subdir/document.ext',
-                                               configuration,
-                                               @logger,
-                                               cache,
-                                               @resource_factory,
-                                               @filter_factory)
-  end
-  after(:all) do
-    Dir.chdir(@initial_dir)
-  end
-  it 'should set a default output' do
-    @document.default_format.should == 'html'
-  end
-  it 'should have targets hash' do
-    @document.targets.should
-  end
-  it 'should set a default target filename for a given output format' do
-    @document.target_for(@document.default_format).should == 'output/subdir/document.html'
-  end
-  it 'should have a default filter chain for the default output format' do
-    @document.filters_for(@document.default_format).should == ['erb', 'deplate-html']
-  end
-  it 'should have a default filter chain for latex output' do
-    @document.filters_for('latex').should == ['erb', 'deplate-latex']
-  end
-  it 'should have a default filter chain for text output' do
-    @document.filters_for('text').should == ['erb', 'deplate-text']
-  end
-  it 'should fail if a filter chain for a given output format was not found' do
-    @logger.should_receive(:error).with(/defined filter/)
-    @document.filters_for('notexists')
-  end
-  it 'should return the target filename for the given format' do
-    @document.target_for('html').should == 'output/subdir/document.html'                            
-  end 
-  it 'should set the source file basename' do
-    @document.basename.should == 'document'
-  end
-  it 'should set the dirname' do
-    @document.dirname.should == 'doc/pages/subdir'
-  end
-  it 'should set the filename with path but without extension' do
-    @document.name_noext == 'doc/pages/subdir/document'
-  end
-  it 'should set name relative to document directory' do
-    @document.relativename == 'subdir/document'
-  end
-  it 'should read the content of the source file' do
-    @document.source.should match(/\* Title for document/)
-  end
-  it 'should not store header information in the source text' do
-    @document.source.should_not match(/^-{3}$(.*?)-{3}$/m)
-  end
-  it 'should configure itself through configuration files' do
-    @document.configuration.should == merge_hashes(configuration,
-                                                   'doc/configs/required.yaml',
-                                                   'doc/pages/subdir/document.yaml',
-                                                   'doc/pages/subdir/COMMON.yaml',
-                                                   'doc/pages/COMMON.yaml',
-                                                   'doc/configs/subdir/document.yaml',
-                                                   { 'key_in_header' => 'value in header'}
-                                                   )
-  end
-  it 'should collect config filenames' do
-    @document.config_fns.should == ['doc/configs/subdir/document.yaml',
-                                    File.expand_path('doc/pages/COMMON.yaml'),
-                                    File.expand_path('doc/pages/subdir/COMMON.yaml'),
-                                    'doc/pages/subdir/document.yaml',
-                                    'doc/configs/required.yaml',
-                                    'doc/pages/subdir/document.ext']
-  end
-  it 'should collect layout filenames grouped by format' do
-    @document.layouts['html'].should == ['doc/layouts/subdir/document.html']
-  end
-  it 'should collect target filename' do
-    @document.target_for('html').should == 'output/subdir/document.html'
-  end
-  it 'should store the names of its dependencies grouped by format' do
-    @document.deps_for('html').should == ['doc/pages/subdir/document.ext',
-                                          'doc/configs/subdir/document.yaml',
-                                          File.expand_path('doc/pages/COMMON.yaml'),
-                                          File.expand_path('doc/pages/subdir/COMMON.yaml'),                                     
-                                          'doc/pages/subdir/document.yaml',
-                                          'doc/configs/required.yaml',
-                                          'doc/layouts/subdir/document.html']
-  end
-  it 'should fail if config file doesn''t exist' do
-    @logger.should_receive(:error).with("Configuration file 'notexists' not found for '#{@document.source_fn}'!")
-    @document.add_config('notexists')
-  end
-  it 'should warn if a configuration key doesn''t exist' do
-    @logger.should_receive(:warn)
-    @document.configuration['notexists']
-  end
-  it 'should associate a default value for a not defined configuration key' do
-    @logger.should_receive(:warn)
-    @document.configuration['notexists'].should == @document.default_configuration_value 
-  end
-  describe ' and rendered in html' do
-    before do
-      @filter = mock('filter')
-      @filter.stub!(:filter)
-    end
-    it 'should use erb and deplate-html filters' do
-      @filter_factory.should_receive(:get).twice.with('erb', :anything).and_return(@filter)
-      @filter_factory.should_receive(:get).with('deplate-html', :anything).and_return(@filter)
-      @document.render
-    end
-  end
-
-  describe ' and rendered in a unknown format' do
-    it 'should fail if output format doesn''t exist' do
-      @logger.should_receive(:error).with(/format.*is unknown/)
-      @document.render(:format => 'notexists')
-    end
-  end
-end
-
-describe Dokkit::Resource::Document, ' when inizialized with document_with_many_targets.ext' do
-  include SpecHelper::Logger, SpecHelper::Cache, SpecHelper::Configuration, SpecHelper::Resource
-  before(:all) do
-    @initial_dir = Dir.pwd
-    Dir.chdir(File.join(File.dirname(__FILE__), SpecHelper::Path::TEST_DATA))
-  end
-  before do
-    @logger = logger
-    @logger.stub!(:warn)
-    @filter_factory = filter_factory
-    @document = Dokkit::Resource::Document.new('doc/pages/document_with_many_targets.ext',
-                                               configuration,
-                                               @logger,
-                                               cache,
-                                               @resource_factory,
-                                               @filter_factory
-                                               )
-  end
-  after(:all) do
-    Dir.chdir(@initial_dir)
-  end
-  it 'should collect all the targets grouped by format' do
-    @document.targets.should == {
-      #      'html' => { :target_fn => 'output/document_with_many_targets.html' },
-      'latex' => { :target_fn => 'output/document_with_many_targets.latex' },
-      'text' => { :target_fn => 'output/document_with_many_targets.text' },
-      'custom' => {
-        :target_fn => 'output/document_with_many_targets.html',
-        'postfilter' => ['erb'],
-        'filter' => ['maruku-html']
-      }
-    }
-  end
-  it 'should return filter_chain for custom format' do
-    @document.filters_for('custom').should == ['maruku-html']
-  end
-  #   describe ' and rendered in html format' do
-  #     it 'should produce html output' do
-  #       result = "<h1>Title</h1>"
-  #       filter = mock('filter', :filter => result)
-  #       @filter_factory.should_receive(:get).with('deplate-html').and_return(filter)
-  #       @document.render(:format => 'html').should match(/#{result}/)
-  #     end
-  #   end
-  describe ' and rendered in latex format' do
-    before do
-      @filter = mock('filter')
-      @filter.stub!(:filter)
-    end
-    it 'should use erb and deplate-latex filters' do
-      @filter_factory.should_receive(:get).twice.with('erb', :anything).and_return(@filter)
-      @filter_factory.should_receive(:get).with('deplate-latex', :anything).and_return(@filter)
-      @document.render(:format => 'latex')
-    end
-  end
-  describe ' and rendered in text format' do
-    before do
-      @filter = mock('filter')
-      @filter.stub!(:filter)
-    end
-    it 'should use erb and deplate-text filters' do
-      @filter_factory.should_receive(:get).with('erb', :anything).and_return(@filter)
-      @filter_factory.should_receive(:get).with('deplate-text', :anything).and_return(@filter)
-      @document.render(:format => 'text')
-    end
-  end
-  describe ' and rendered in custom format' do
-    it 'should produce html output using maruku' do
-      result = "<h1>Title</h1>"
-      filter = mock('filter', :filter => result)
-      @filter_factory.should_receive(:get).with('maruku-html', :anything).and_return(filter)
-      @document.render(:format => 'custom').should match(/#{result}/)
-    end
-  end
-end
-
-describe Dokkit::Resource::Document, ' when inizialized with document_with_nested_layout.ext' do
-  include SpecHelper::Logger, SpecHelper::Cache, SpecHelper::Configuration, SpecHelper::Resource, SpecHelper::Filter
-  before(:all) do
-    @initial_dir = Dir.pwd
-    Dir.chdir(File.join(File.dirname(__FILE__), SpecHelper::Path::TEST_DATA))
-  end
-  before do
-    @logger = logger
-    @filter_factory = filter_factory
-    @document = Dokkit::Resource::Document.new('doc/pages/document_with_nested_layout.ext',
-                                               configuration,
-                                               @logger,
-                                               cache,
-                                               @resource_factory,
-                                               @filter_factory
-                                               )
-  end
-  after(:all) do
-    Dir.chdir(@initial_dir)
-  end
-  it 'should collect layouts' do
-    @document.layouts['html'].should == ['doc/layouts/nested/nested.html', 'doc/layouts/container.html']
-  end
-  describe ' and rendered in html format' do
-    it 'should produce html output using layout chain'  do
-      @filter_factory.should_receive(:get).with('erb', :anything).and_return(filter('<p>some content</p>'),
-                                                                  filter('<div id="nested"><p>some content</p></div>'), 
-                                                                  filter('<html><div id="nested"><p>some content</p></div></html>'))
-      @filter_factory.should_receive(:get).with('deplate-html', :anything).and_return(filter('<p>some content</p>'))
-      render_result = @document.render
-      render_result.should match(/\A\<html\>/)
-      render_result.should match(/<div id=\"nested\"\>/)
-      render_result.should match(/some content/)
-    end
-  end
-end
-
-describe Dokkit::Resource::Document, ' when inizialized with document_with_many_config.ext' do
-  include SpecHelper::Logger, SpecHelper::Cache, SpecHelper::Configuration, SpecHelper::Resource
-  before(:all) do
-    @initial_dir = Dir.pwd
-    Dir.chdir(File.join(File.dirname(__FILE__), SpecHelper::Path::TEST_DATA))
-  end
-  before do
-    @logger = logger
-    @filter_factory = filter_factory
-    @document = Dokkit::Resource::Document.new('doc/pages/document_with_many_config.ext',
-                                               configuration,
-                                               @logger,
-                                               cache,
-                                               @resource_factory,
-                                               @filter_factory
-                                               )
-  end
-  after(:all) do
-    Dir.chdir(@initial_dir)
-  end
-  it 'should collect config files' do
-    @document.config_fns.should include(config_path('config_1.yaml'), config_path('config_2.yaml'))
-  end
-end
-
-describe Dokkit::Resource::Document, ' when inizialized with document_with_many_errors.ext' do
-  include SpecHelper::Logger, SpecHelper::Cache, SpecHelper::Configuration, SpecHelper::Resource
-  before(:all) do
-    @initial_dir = Dir.pwd
-    Dir.chdir(File.join(File.dirname(__FILE__), SpecHelper::Path::TEST_DATA))
-  end
-  before do
-    @logger = logger
-    @filter_factory = filter_factory
-  end
-  after(:all) do
-    Dir.chdir(@initial_dir)
-  end
-  it 'should warn that layouts not exist for html and custom output format' do
-    @logger.should_receive(:warn).with(/Layout.* not exists/)
-    @document = Dokkit::Resource::Document.new('doc/pages/document_with_many_errors.ext', 
-                                               configuration, 
-                                               @logger, 
-                                               cache, 
-                                               @resource_factory, 
-                                               @filter_factory)
-  end
-  it 'should not add not existent layout to deps array' do
-    @logger.stub!(:warn)
-    @document = Dokkit::Resource::Document.new('doc/pages/document_with_many_errors.ext', 
-                                               configuration, 
-                                               @logger, 
-                                               cache,
-                                               resource_factory,
-                                               @filter_factory)
-    @document.deps['html'].should_not include(nil)
-  end
-  describe ' and rendered' do
-    before do
-      @logger.stub!(:warn)
-      @document = Dokkit::Resource::Document.new('doc/pages/document_with_many_errors.ext', 
-                                                 configuration, 
-                                                 @logger, 
-                                                 cache, 
-                                                 @resource_factory,
-                                                 @filter_factory)
-    end
-    it 'should fail if rendered in :notexists format' do
-      @logger.should_receive(:error)
-      @document.render(:format => 'notexists')
-    end
-  end
-end
-
-describe Dokkit::Resource::Document, ' when inizialized with document_with_one_target' do
-  include SpecHelper::Logger, SpecHelper::Cache, SpecHelper::Configuration, SpecHelper::Resource
-  before(:all) do
-    @initial_dir = Dir.pwd
-    Dir.chdir(File.join(File.dirname(__FILE__), SpecHelper::Path::TEST_DATA))
-  end
-  before do
-    @logger = logger
-    @logger.stub!(:warn)
-    @filter_factory = filter_factory
-  end
-  before do
-    @document = Dokkit::Resource::Document.new('doc/pages/document_with_one_target.ext', 
-                                               configuration, 
-                                               @logger, 
-                                               cache, 
-                                               @resource_factory,
-                                               @filter_factory)
-  end
-  after(:all) do
-    Dir.chdir(@initial_dir)
-  end
-  it 'should correctly setup targets' do
-    @document.targets['text'].should == { :target_fn => output_path('document_with_one_target.text') }
-  end
-end
-
-# describe Dokkit::Resource::Document, ' when inizialized with document_with_nil_target' do
-#   include SpecHelper::Logger, SpecHelper::Cache, SpecHelper::Configuration, SpecHelper::Resource
-#   before(:all) do
-#     @initial_dir = Dir.pwd
-#     Dir.chdir(File.join(File.dirname(__FILE__), SpecHelper::Path::TEST_DATA))
-#   end
-#   before do
-#     @logger = logger
-#     @logger.stub!(:warn)
-#     @filter_factory = filter_factory
-#   end
-#   after(:all) do
-#     Dir.chdir(@initial_dir)
-#   end
-#   it 'should fail because target format doesn''t exist' do
-#     @logger.should_receive(:error).with(/invalid target/i)
-#     @document = Dokkit::Resource::Document.new('doc/pages/document_with_nil_target.ext', 
-#                                                configuration, 
-#                                                @logger, 
-#                                                cache, 
-#                                                @resource_factory,
-#                                                @filter_factory)
-#   end
-# end
-
-describe Dokkit::Resource::Document, ' when inizialized with document_with_not_defined_target' do
-  include SpecHelper::Logger, SpecHelper::Cache, SpecHelper::Configuration, SpecHelper::Resource
-  before(:all) do
-    @initial_dir = Dir.pwd
-    Dir.chdir(File.join(File.dirname(__FILE__), SpecHelper::Path::TEST_DATA))
-  end
-  before do
-    @logger = logger
-    @logger.stub!(:warn)
-    @filter_factory = filter_factory
-  end
-  after(:all) do
-    Dir.chdir(@initial_dir)
-  end
-  it 'should fail because target format was not defined' do
-    @logger.should_receive(:error).with(/must define format/i)
-    @document = Dokkit::Resource::Document.new('doc/pages/document_with_not_defined_target.ext', 
-                                               configuration, 
-                                               @logger, 
-                                               cache, 
-                                               @resource_factory, 
-                                               @filter_factory)
-  end
-end
-
-describe Dokkit::Resource::Document, ' when render partial' do
-  include SpecHelper::Logger, SpecHelper::Cache, SpecHelper::Configuration, SpecHelper::Resource
-  before(:all) do
-    @initial_dir = Dir.pwd
-    Dir.chdir(File.join(File.dirname(__FILE__), SpecHelper::Path::TEST_DATA))
-  end
-  before do
-    @partial = mock('partial')
-    @partial.stub!(:render)
-    @cache = mock('cache')
-    @cache.stub!(:add_dependency)
-    @resource_factory = resource_factory
-  end
-  before do
-    #     @document = Dokkit::Resource::Document.new('doc/pages/document_with_partial.ext', 
-    #                                                configuration, 
-    #                                                @logger, 
-    #                                                cache, 
-    #                                                @resource_factory,
-    #                                                @filter_factory)
-  end
-  after(:all) do
-    Dir.chdir(@initial_dir)
-  end
-  it 'should instantiate a document object'
-  it 'should cache document'
-end
-
-describe Dokkit::Resource::Document, 'post filtering' do
-  include SpecHelper::Logger, SpecHelper::Cache, SpecHelper::Configuration, SpecHelper::Resource
-  include SpecHelper::Filter
-  
-  before(:all) do
-    @initial_dir = Dir.pwd
-    Dir.chdir(File.join(File.dirname(__FILE__), SpecHelper::Path::TEST_DATA))
-  end
-  after(:all) do
-    Dir.chdir(@initial_dir)
-  end
-  before do
-    @filter_factory = filter_factory
-    @document = Dokkit::Resource::Document.new('doc/pages/document_with_postfilter.ext', 
-                                               configuration, 
-                                               logger, 
-                                               cache, 
-                                               resource_factory, 
-                                               @filter_factory)
-  end
-  it 'should postfilter the document' do
-    @filter_factory.should_receive(:get).twice.with('erb', :anything).twice.and_return(filter('filtered output'))
-    @document.render    
-  end
-end