dokkit 0.3.0 → 0.4.0

data/spec/dokkit/resource/test_data/doc/pages/document_with_many_targets.ext

@@ -0,0 +1,19 @@
+---
+layout: layout
+format:
+- latex
+- text
+- custom:
+    filter:
+    - maruku-html
+    ext: html
+---
+
+This document can be rendered in the format below:
+
+ * html
+ * latex
+ * text
+ * custom
+
+The custom format use maruku filter for html rendering.

data/spec/dokkit/resource/test_data/doc/pages/document_with_nested_layout.ext

@@ -0,0 +1,13 @@
+---
+layout:
+- clear
+- nested/nested
+- container
+---
+
+This is a document thai uses a nested layout inside a layout that acts as container.
+Layouts are rendered in the same order of the array values above. That is:
+
+                            result in                                result in
+document_with_nested_layout ========> doc/layouts/nested/nested.html ========> doc/layouts/container.html 
+

data/spec/dokkit/resource/test_data/doc/pages/document_with_nil_target.ext

@@ -0,0 +1,5 @@
+---
+format:
+---
+
+Document with output format defined.

data/spec/dokkit/resource/test_data/doc/pages/document_with_not_defined_target.ext

@@ -0,0 +1,6 @@
+---
+format:
+- blah:
+---
+
+Document with not defined format.

data/spec/dokkit/resource/test_data/doc/pages/document_with_one_target.ext

@@ -0,0 +1,8 @@
+---
+format:
+- text
+---
+
+Document with text target.
+
+

data/spec/dokkit/resource/test_data/doc/pages/subdir/COMMON.yaml

@@ -0,0 +1,3 @@
+---
+key_in_common_in_subdir: key in common in subdir
+

data/spec/dokkit/resource/test_data/doc/pages/subdir/document.ext

@@ -0,0 +1,8 @@
+---
+key_in_header: value in header
+---
+
+* Title for document
+
+Body of the document
+

data/spec/dokkit/resource/test_data/doc/pages/subdir/document.yaml

@@ -0,0 +1,5 @@
+---
+key: value in document.yaml
+config: required
+layout: subdir/document
+

data/spec/dokkit/tasklib/clean_spec.rb

@@ -0,0 +1,75 @@
+#                                                                          
+# File 'clean_spec.rb' created on 14 apr 2008 at 16:00: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/clean_spec.rb                                                  
+#                                                                          
+
+$LOAD_PATH.unshift(File.expand_path(File.join(File.dirname(__FILE__),'../../../lib')))
+
+require 'rubygems'
+require 'rake'
+require 'spec'
+require 'dokkit/tasklib/clean'
+require 'spec/spec_helper.rb'
+
+describe Dokkit::TaskLib::Clean do
+  include SpecHelper::Logger
+  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
+    @logger = logger
+    @rake = Rake.application
+    @clean = Dokkit::TaskLib::Clean.new(@logger, { :output_dir => 'output', :cache_dir => '.cache'} )
+  end 
+  after do
+    Rake.application.clear
+  end
+  it 'should define a clean:output task' do
+    @rake.tasks.should include(task('clean:output'))
+  end
+  it 'should define a clean:cache task' do
+    @rake.tasks.should include(task('clean:cache'))
+  end
+  it 'should define a clean:all task' do
+    @rake.tasks.should include(task('clean:all'))
+  end  
+  describe ' when clean:output is invoked' do
+    before do
+      mkdir 'output'
+    end
+    after do
+      rm_rf 'output'
+    end
+    it 'should remove output directory' do
+      @logger.stub!(:info)
+      @rake['clean:output'].execute({ })
+      File.exists?('output').should be_false
+    end
+  end
+  describe ' when clean:cache is invoked' do
+    before do
+      mkdir '.cache'
+    end
+    after do
+      rm_rf '.cache'
+    end
+    it 'should remove cache directory' do
+      @logger.stub!(:info)
+      @rake['clean:cache'].execute({ })
+      File.exists?('.cache').should be_false
+    end
+  end
+ end
+
+
+

data/spec/dokkit/tasklib/render_spec.rb

@@ -0,0 +1,125 @@
+#
+# File 'rendertask_spec.rb' created on 18 feb 2008 at 19:55:16.
+# 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/render_spec.rb
+#
+
+$LOAD_PATH.unshift(File.expand_path(File.join(File.dirname(__FILE__),'../../../lib')))
+
+require 'rubygems'
+require 'spec'
+require 'dokkit/tasklib/render'
+require 'spec/spec_helper.rb'
+
+describe Dokkit::TaskLib::Render do
+  include SpecHelper::Resource, SpecHelper::Logger
+  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
+    @rake = Rake.application
+    @document_1 = document_1
+    @document_2 = document_2
+    @data_1 = data_1
+    @resource_factory = resource_factory
+    @logger = logger
+    @render = Dokkit::TaskLib::Render.new(@logger, @resource_factory, ['doc/pages/document_1', 'doc/pages/document_2'], ['doc/data/data_1'])
+  end
+  after do
+    Rake.application.clear
+  end
+  it 'should define a render:doc task' do
+    @rake['render:doc'].should
+  end
+  it 'should define a render:data task' do
+    @rake['render:data'].should
+  end
+  it 'should define a render:all task' do
+    @rake['render:all'].prerequisites.should == ['render:doc', 'render:data']
+  end
+  describe ' when render:doc invoked' do
+    before do
+      @logger.stub!(:info)
+      @resource_factory.stub!(:get).and_return(@document_1, @document_2)
+    end
+    before do
+      @rake['render:doc'].execute({ })
+    end
+    after do
+      rm_rf 'output'
+    end
+    it 'should create the output directory' do
+      File.exists?('output').should be_true
+    end
+    it 'should create document_1.html' do
+      File.exists?('document_1.html')
+    end
+    it 'should create document_2.html' do
+      File.exists?('document_2.html')
+    end
+    it 'should create document_2.text' do
+      File.exists?('document_2.html')
+    end
+  end
+  describe ' when render:data invoked' do
+    before do
+      @logger.stub!(:info)
+      @resource_factory.stub!(:get).and_return(@data_1)
+    end
+    before do
+      @rake['render:data'].execute({ })
+    end
+    after do
+      rm_rf 'output'
+    end
+    it 'should create the output directory' do
+      File.exists?('output').should be_true
+    end
+    it 'should copy data_1' do
+      File.exists?('data_1')
+    end
+  end
+  describe ' when doc/data/data_1 has been changed' do
+    before do
+      @logger.stub!(:info)
+      @resource_factory.stub!(:get).and_return(@data_1)
+      @rake['render:data'].execute({ })
+    end
+    after do
+      rm_rf 'output'
+    end
+    it 'should re-render output/data_1' do
+      File.utime(0, Time.now, data_path('data_1'))
+      @logger.should_receive(:info).with(/copy/i)
+      @rake['render:data'].execute({ })
+    end
+  end  
+  describe ' when doc/pages/document_1 has been changed' do
+    before do
+      @logger.stub!(:info)
+      @resource_factory.stub!(:get).and_return(@document_1)
+      @rake['render:doc'].execute({ })
+    end
+    after do
+      rm_rf 'output'
+    end
+    it 'should re-render output/document_1' do
+      File.utime(0, Time.now + 2, document_path('document_1'))
+      # FIXME: logger should receive *exactly* 2 times :info message
+      # but actually it receives four.. maybe there is some issue with
+      # Rake::Task#execute .. to investigate ..
+      @logger.should_receive(:info).at_least(2).with(/render/i)
+      @rake['render:doc'].execute({ })      
+    end
+  end
+end
+

data/spec/spec.opts

@@ -0,0 +1,4 @@
+--color
+--format
+specdoc
+

data/spec/spec_helper.rb

@@ -5,57 +5,130 @@
 # (c)2006, 2007 Andrea Fazzi <andrea.fazzi@alca.le.it> (and contributors). 
 #                                                                          
 
-module SpecPathHelper
-  DATA_TEST_DIR = 'data/test_build'
-  DATA_DEST_DIR = 'data'
-  CACHE_PATH = '.cache'
-  DOCUMENT_PATH = 'doc/pages'
-  DATA_PATH = 'doc/data'
-  CONFIG_PATH = 'doc/configs'
-  LAYOUT_PATH = 'doc/layouts'
-  TEMPLATE_PATH = 'templates'
-  OUTPUT_PATH = 'output'
-  def base_path(fn = '')
-    File.join('.', fn)
-  end
-  def cache_path(fn = '')
-    File.join(base_path, CACHE_PATH, fn).sub(/^\.\//, '').sub(/\/$/, '')
+$LOAD_PATH.unshift(File.expand_path(File.join(File.dirname(__FILE__),'../lib')))
+
+require 'dokkit/hash'
+
+module SpecHelper
+  module Path
+    TEST_DATA = 'test_data'
+    DATA_DEST_DIR = 'data'
+    CACHE_PATH = '.cache'
+    DOCUMENT_PATH = 'doc/pages'
+    DATA_PATH = 'doc/data'
+    CONFIG_PATH = 'doc/configs'
+    LAYOUT_PATH = 'doc/layouts'
+    TEMPLATE_PATH = 'templates'
+    OUTPUT_PATH = 'output'
+    def base_path(fn = '')
+      File.join('.', fn)
+    end
+    def cache_path(fn = '')
+      File.join(base_path, CACHE_PATH, fn).sub(/^\.\//, '').sub(/\/$/, '')
+    end
+    def document_path(fn = '')
+      File.join(base_path, DOCUMENT_PATH, fn).sub(/^\.\//, '').sub(/\/$/, '')
+    end
+    def config_path(fn = '')
+      File.join(base_path, CONFIG_PATH, fn).sub(/^\.\//, '').sub(/\/$/, '')
+    end
+    def layout_path(fn = '')
+      File.join(base_path, LAYOUT_PATH, fn).sub(/^\.\//, '').sub(/\/$/, '')
+    end
+    def data_path(fn = '')
+      File.join(base_path, DATA_PATH, fn).sub(/^\.\//, '').sub(/\/$/, '')
+    end
+    def output_path(fn = '')
+      File.join(base_path, OUTPUT_PATH, fn).sub(/^\.\//, '').sub(/\/$/, '')
+    end      
   end
-  def document_path(fn = '')
-    File.join(base_path, DOCUMENT_PATH, fn).sub(/^\.\//, '').sub(/\/$/, '')
+  module Logger
+    def logger
+      mock('logger', 
+           :info  => nil,
+           :error => nil,
+           :warn  => nil,
+           :debug => nil)
+    end
   end
-  def config_path(fn = '')
-    File.join(base_path, CONFIG_PATH, fn).sub(/^\.\//, '').sub(/\/$/, '')
+  module Resource
+    include Path
+    def document_1
+      mock('document_1', 
+           :source_fn => 'doc/pages/document_1',
+           :targets => { :html => nil, :text => nil },
+           :target_for => 'output/document_1.html',
+           :deps_for => ['doc/pages/document_1'],
+           :render => nil
+      )
+    end
+    def document_2
+      mock('document_2', 
+           :source_fn => 'doc/pages/document_2',
+           :targets => { :html => nil },
+           :target_for => 'output/document_1.html',
+           :deps_for => ['doc/pages/document_2'],
+           :render => nil
+           )
+    end
+    def data_1
+      mock('data_1', 
+           :target_fn => 'output/data_1', 
+           :source_fn => 'doc/data/data_1'
+      )
+    end
+    def resource_factory
+      mock('resource_factory')
+    end
+    def filter_factory
+      mock('filter_factory')
+    end
   end
-  def layout_path(fn = '')
-    File.join(base_path, LAYOUT_PATH, fn).sub(/^\.\//, '').sub(/\/$/, '')
+  module Cache
+    def cache
+      mock('cache', :load => nil, 
+           :deps => { }, 
+           :add_dependency => nil)
+    end
   end
-  def data_path(fn = '')
-    File.join(base_path, DATA_PATH, fn).sub(/^\.\//, '').sub(/\/$/, '')
+  module Configuration
+    def configuration
+      { :document_dir => 'doc/pages',
+        :data_dir => 'doc/data',
+        :layout_dir => 'doc/layouts',
+        :config_dir => 'doc/configs',
+        :cache_dir => '.cache',
+        :output_dir => 'output'
+      }
+    end
+    def merge_hashes(*hashes)
+      config = { }
+      hashes.each do |hash|
+        config.recursive_merge!(YAML::load(File.read(hash))) if File.exists?(hash.to_s)
+        config.recursive_merge!(hash) if hash.is_a?(Hash)
+      end
+      config.delete('config')
+      config
+    end
   end
-  def output_path(fn = '')
-    File.join(base_path, OUTPUT_PATH, fn).sub(/^\.\//, '').sub(/\/$/, '')
-  end  
-end
-
-module CaptureStdout
-  def capture_stdout
-    s = StringIO.new
-    oldstdout = $stdout
-    $stdout = s
-    yield
-    s.string
-  ensure
-    $stdout = oldstdout    
+  module CaptureOutput
+    def capture_stdout
+      s = StringIO.new
+      oldstdout = $stdout
+      $stdout = s
+      yield
+      s.string
+    ensure
+      $stdout = oldstdout    
+    end
+    def capture_stderr
+      s = StringIO.new
+      oldstdout = $stderr
+      $stderr = s
+      yield
+      s.string
+    ensure
+      $stderr = oldstdout    
+    end      
   end
-  def capture_stderr
-    s = StringIO.new
-    oldstdout = $stderr
-    $stderr = s
-    yield
-    s.string
-  ensure
-    $stderr = oldstdout    
-  end  
 end
-