webgen 0.5.3 → 0.5.4

data/lib/webgen/page.rb

@@ -55,7 +55,9 @@ module Webgen
       # the information. The +meta_info+ parameter can be used to provide default meta information.
       def from_data(data, meta_info = {})
         md = /(#{RE_META_INFO})?(.*)/m.match(normalize_eol(data))
-        raise(WebgenPageFormatError, 'Invalid structure of meta information part') if md[1].nil? && data =~ RE_META_INFO_START
+        if md[1].nil? && data =~ RE_META_INFO_START
+          raise WebgenPageFormatError, 'Found start line for meta information block but no valid meta information block'
+        end
         meta_info = meta_info.merge(md[1].nil? ? {} : parse_meta_info(md[1]))
         blocks = parse_blocks(md[2] || '', meta_info)
         new(meta_info, blocks)
@@ -74,7 +76,9 @@ module Webgen
       def parse_meta_info(data)
         begin
           meta_info = YAML::load(data)
-          raise(WebgenPageFormatError, 'Invalid structure of meta information part') unless meta_info.kind_of?(Hash)
+          unless meta_info.kind_of?(Hash)
+            raise WebgenPageFormatError, "Invalid structure of meta information block: expected YAML hash but found #{meta_info.class}"
+          end
         rescue ArgumentError => e
           raise WebgenPageFormatError, e.message
         end
@@ -91,14 +95,14 @@ module Webgen
         scanned.each_with_index do |block_data, index|
           options, content = *block_data
           md = RE_BLOCKS_OPTIONS.match(options.to_s)
-          raise(WebgenPageFormatError, "Found invalid blocks starting line") if content =~ /\A---/ || md.nil?
-          options = Hash[*md[1].to_s.scan(/(\w+):([^\s]*)/).flatten]
+          raise(WebgenPageFormatError, "Found invalid blocks starting line for block #{index+1}: #{options}") if content =~ /\A---/ || md.nil?
+          options = Hash[*md[1].to_s.scan(/(\w+):([^\s]*)/).map {|k,v| [k, YAML::load(v)]}.flatten]
           options = (meta_info['blocks']['default'] || {} rescue {}).
             merge((meta_info['blocks'][index+1] || {} rescue {})).
             merge(options)
 
           name = options.delete('name') || (index == 0 ? 'content' : 'block' + (index + 1).to_s)
-          raise(WebgenPageFormatError, "Same name used for more than one block: #{name}") if blocks.has_key?(name)
+          raise(WebgenPageFormatError, "Previously used name '#{name}' also used for block #{index+1}") if blocks.has_key?(name)
           content ||= ''
           content.gsub!(/^(\\+)(---.*?)$/) {|m| "\\" * ($1.length / 2) + $2}
           content.strip!

data/lib/webgen/sourcehandler/base.rb

@@ -102,49 +102,69 @@ module Webgen::SourceHandler
   #
   module Base
 
-    include Webgen::Loggable
-
-    # Construct the output name for the given +path+. First it is checked if a node with the
-    # constructed output name already exists. If it exists, the language part is forced to be in the
-    # output name and the resulting output name is returned.
+    # This module is used for defining all methods that can be used for creating output paths.
     #
-    # The parameter +style+ (which uses the meta information +output_path_style+ from the path's
-    # meta information hash) defines how the output name should be built (more information about
-    # this in the user documentation).
-    def output_path(parent, path, style = path.meta_info['output_path_style'])
-      name = construct_output_path(parent, path, style)
-      name += '/'  if path.path =~ /\/$/ && name !~ /\/$/
-      if node_exists?(parent, path, name)
-        name = construct_output_path(parent, path, style, true)
-        name += '/'  if path.path =~ /\/$/ && name !~ /\/$/
+    # All public methods of this module are considered to be output path creation methods and must
+    # have the following parameters:
+    # +parent+:: the parent node
+    # +path+:: the path for which the output name should be created
+    # +use_lang_part+:: controls whether the output path name has to include the language part
+    module OutputPathHelpers
+
+      # Default method for creating an output path for +parent+ and source +path+.
+      #
+      # The automatically set parameter +style+ (which uses the meta information +output_path_style+
+      # from the path's meta information hash) defines how the output name should be built (more
+      # information about this in the user documentation).
+      def standard_output_path(parent, path, use_lang_part, style = path.meta_info['output_path_style'])
+        result = style.collect do |part|
+          case part
+          when String  then part
+          when :lang   then use_lang_part ? path.meta_info['lang'] : ''
+          when :ext    then path.ext.empty? ? '' : '.' + path.ext
+          when :parent then temp = parent; temp = temp.parent while temp.is_fragment?; temp.path
+          when :year, :month, :day
+            ctime = path.meta_info['created_at']
+            if !ctime.kind_of?(Time)
+              raise "Invalid meta info 'created_at' for #{path}, needed because of used output path style"
+            end
+            ctime.send(part).to_s.rjust(2, '0')
+          when Symbol  then path.send(part)
+          when Array   then part.include?(:lang) && !use_lang_part ? '' : standard_output_path(parent, path, use_lang_part, part)
+          else ''
+          end
+        end
+        result.join('')
       end
-      name
+
     end
 
-    # Utility method for constructing the output name.
-    def construct_output_path(parent, path, style, use_lang_part = nil)
+    include Webgen::Loggable
+    include OutputPathHelpers
+
+    # Construct the output name for the given +path+ and +parent+. First it is checked if a node
+    # with the constructed output name already exists. If it exists, the language part is forced to
+    # be in the output name and the resulting output name is returned.
+    def output_path(parent, path)
+      method = path.meta_info['output_path'] + '_output_path'
       use_lang_part = if path.meta_info['lang'].nil? # unlocalized files never get a lang in the filename!
                         false
-                      elsif use_lang_part.nil?
+                      else
                         Webgen::WebsiteAccess.website.config['sourcehandler.default_lang_in_output_path'] ||
                           Webgen::WebsiteAccess.website.config['website.lang'] != path.meta_info['lang']
-                      else
-                        use_lang_part
                       end
-      result = style.collect do |part|
-        case part
-        when String  then part
-        when :lang   then use_lang_part ? path.meta_info['lang'] : ''
-        when :ext    then path.ext.empty? ? '' : '.' + path.ext
-        when :parent then temp = parent; temp = temp.parent while temp.is_fragment?; temp.path
-        when Symbol  then path.send(part)
-        when Array   then part.include?(:lang) && !use_lang_part ? '' : construct_output_path(parent, path, part, use_lang_part)
-        else ''
+      if OutputPathHelpers.public_instance_methods(false).include?(method)
+        name = send(method, parent, path, use_lang_part)
+        name += '/'  if path.path =~ /\/$/ && name !~ /\/$/
+        if node_exists?(parent, path, name)
+          name = send(method, parent, path, (path.meta_info['lang'].nil? ? false : true))
+          name += '/'  if path.path =~ /\/$/ && name !~ /\/$/
         end
+        name
+      else
+        raise "Unknown method for creating output path: #{method}"
       end
-      result.join('')
     end
-    private :construct_output_path
 
     # Check if the node alcn and output path which would be created by #create_node exists. The
     # +output_path+ to check for can individually be set.

data/lib/webgen/tag/menu.rb

@@ -68,9 +68,8 @@ module Webgen::Tag
 
     # Check if the menus for +node+ have changed.
     def node_changed?(node)
-      return if !node.node_info[:tag_menu_menus] || @inside_node_changed
+      return if !node.node_info[:tag_menu_menus]
 
-      @inside_node_changed = true  #TODO: better solution for this race condition?
       node.node_info[:tag_menu_menus].each do |(params, cn_alcn), cached_tree|
         cn = node.tree[cn_alcn]
         menu_tree = menu_tree_for_lang(cn.lang, cn.tree.root)
@@ -88,7 +87,6 @@ module Webgen::Tag
           break
         end
       end
-      @inside_node_changed = false
     end
 
     # Wrapper method for returning the specific menu tree for +content_node+.

data/lib/webgen/version.rb

@@ -1,6 +1,6 @@
 module Webgen
 
   # The version of webgen.
-  VERSION = '0.5.3'
+  VERSION = '0.5.4'
 
 end

data/test/test_configuration.rb

@@ -54,6 +54,13 @@ class TestConfiguration < Test::Unit::TestCase
     assert_equal(['**/*.page'], @config['sourcehandler.patterns']['Other'])
     assert_raise(ArgumentError) { @config.patterns([5,6]) }
     assert_raise(ArgumentError) { @config.patterns('Page' => 5) }
+
+    @config.default_processing_pipeline('Page' => 'tags,maruku')
+    assert_equal('tags,maruku', @config['sourcehandler.default_meta_info']['Webgen::SourceHandler::Page']['blocks']['default']['pipeline'])
+    @config.default_processing_pipeline('Other' => 'tags,maruku')
+    assert_equal('tags,maruku', @config['sourcehandler.default_meta_info']['Other']['blocks']['default']['pipeline'])
+    assert_raise(ArgumentError) { @config.default_processing_pipeline([5,6]) }
+    assert_raise(ArgumentError) { @config.default_processing_pipeline('Page' => [5,6]) }
   end
 
 end

data/test/test_contentprocessor_erubis.rb

@@ -0,0 +1,47 @@
+require 'ostruct'
+require 'helper'
+require 'test/unit'
+require 'webgen/tree'
+require 'webgen/page'
+require 'webgen/contentprocessor'
+
+class TestContentProcessorErubis < Test::Unit::TestCase
+
+  include Test::WebsiteHelper
+
+  def test_call
+    obj = Webgen::ContentProcessor::Erubis.new
+    root = Webgen::Node.new(Webgen::Tree.new.dummy_root, '/', '/')
+    node = Webgen::Node.new(root, 'test', 'test')
+    context = Webgen::ContentProcessor::Context.new(:doit => 'hallo', :chain => [node])
+
+    context.content = '<%= context[:doit] %>6'
+    assert_equal('hallo6', obj.call(context).content)
+
+    context.content = '<%= 5* %>'
+    assert_raise(RuntimeError) { obj.call(context) }
+
+    context.content = "<% for i in [1] %>\n<%= i %>\n<% end %>"
+    assert_equal("1\n", obj.call(context).content)
+    @website.config['contentprocessor.erubis.options'][:trim] = false
+    context.content = "<% for i in [1] %>\n<%== i %>\n<% end %>"
+    assert_equal("\n1\n", obj.call(context).content)
+
+    context[:block] = OpenStruct.new
+    context[:block].options = {'erubis_trim' => true}
+    context.content = "<% for i in [1] %>\n<%== i %>\n<% end %>"
+    assert_equal("1\n", obj.call(context).content)
+    context[:block].options['erubis_use_pi'] = true
+    context.content = "<?rb for i in [1] ?>\n@{i}@\n<?rb end ?>"
+    assert_equal("1\n", obj.call(context).content)
+    context[:block] = nil
+
+    @website.config['contentprocessor.erubis.use_pi'] = true
+    context.content = "<?rb for i in [1] ?>\n@{i}@\n<?rb end ?>"
+    assert_equal("1\n", obj.call(context).content)
+
+    page = Webgen::Page.from_data("--- pipeline:erubis erubis_trim:false erubis_use_pi:false\n<% for i in [1] %>\n<%== i %>\n<% end %>")
+    assert_equal("\n1\n", page.blocks['content'].render(context).content)
+  end
+
+end

data/test/test_contentprocessor_rdiscount.rb

@@ -0,0 +1,15 @@
+require 'test/unit'
+require 'webgen/node'
+require 'webgen/tree'
+require 'webgen/contentprocessor'
+
+class TestContentProcessorRDiscount < Test::Unit::TestCase
+
+  def test_call
+    @obj = Webgen::ContentProcessor::RDiscount.new
+    node = Webgen::Node.new(Webgen::Node.new(Webgen::Tree.new.dummy_root, '/', '/'), 'test', 'test')
+    context = Webgen::ContentProcessor::Context.new(:content => '# header', :chain => [node])
+    assert_equal("<h1>header</h1>\n", @obj.call(context).content)
+  end
+
+end

data/test/test_node.rb

@@ -158,6 +158,14 @@ class TestNode < Test::Unit::TestCase
     node.node_info[:used_nodes] << @tree.dummy_root.absolute_lcn
     node.changed?
     assert_equal(1, calls)
+
+    # Test circular depdendence
+    other_node = Webgen::Node.new(@tree.dummy_root, '/other', 'test.l', {'lang' => 'de', :test => :value})
+    other_node.dirty = node.created = false
+    node.dirty = false
+    other_node.node_info[:used_nodes] = [node.absolute_lcn]
+    node.node_info[:used_nodes] = [other_node.absolute_lcn]
+    node.changed?
   end
 
   def test_meta_info_changed

data/test/test_page.rb

@@ -97,13 +97,14 @@ class TestPage < Test::Unit::TestCase
     --- name:block
     content doing -
     with?: with some things
-    --- other:optins
+    --- other:options test1:true test2:false test3:542
   meta_info: {}
   blocks:
     - name: block
       content: "content doing -\\nwith?: with some things"
     - name: block2
       content: ''
+      options: {other: options, test1: true, test2: false, test3: 542}
 
 # block with seemingly block start line it
 - in: |
@@ -118,6 +119,9 @@ class TestPage < Test::Unit::TestCase
 EOF
 
   INVALID=<<EOF
+# invalid meta info: none specified
+- "---\\n---"
+
 # invalid meta info: no hash
 - |
   ---
@@ -166,6 +170,7 @@ EOF
         index += 1
         assert_equal(b['name'], d.blocks[index].name, "test item #{oindex} - name")
         assert_equal(b['content'], d.blocks[index].content, "test item #{oindex} - content")
+        assert_equal(b['options'] || {}, d.blocks[index].options, "test item #{oindex} - options")
         assert_same(d.blocks[index], d.blocks[b['name']])
       end
     end

data/test/test_sourcehandler_base.rb

@@ -4,6 +4,7 @@ require 'webgen/tree'
 require 'webgen/node'
 require 'webgen/path'
 require 'webgen/sourcehandler/base'
+require 'time'
 
 class TestSourceHandlerBase < Test::Unit::TestCase
 
@@ -30,35 +31,48 @@ class TestSourceHandlerBase < Test::Unit::TestCase
   end
 
   def test_output_path
+    node = Webgen::Node.new(Webgen::Tree.new.dummy_root, 'test/', 'test')
+    assert_raise(RuntimeError) { @obj.output_path(node, path_with_meta_info('test.page', 'output_path' => 'non'))}
+  end
+
+  def test_standard_output_path
     @tree = Webgen::Tree.new
     node = Webgen::Node.new(@tree.dummy_root, 'test/', 'test', {'lang' => 'de', :test => :value})
 
-    output_path_style = [:parent, :cnbase, ['.', :lang], :ext]
-
-    path = Webgen::Path.new('path.html')
-    assert_equal('test/path.html', @obj.output_path(node, path, output_path_style))
-    path = Webgen::Path.new('path.en.html')
-    assert_equal('test/path.html', @obj.output_path(node, path, output_path_style))
-    path = Webgen::Path.new('path.eo.html')
-    assert_equal('test/path.eo.html', @obj.output_path(node, path, output_path_style))
-    path = Webgen::Path.new('dir/')
-    assert_equal('test/dir/', @obj.output_path(node, path, output_path_style))
+    path = path_with_meta_info('path.html')
+    assert_equal('test/path.html', @obj.output_path(node, path))
+    path = path_with_meta_info('path.en.html')
+    assert_equal('test/path.html', @obj.output_path(node, path))
+    path = path_with_meta_info('path.eo.html')
+    assert_equal('test/path.eo.html', @obj.output_path(node, path))
+    path = path_with_meta_info('dir/')
+    assert_equal('test/dir/', @obj.output_path(node, path))
 
     other = Webgen::Node.new(node, 'test/path.html', 'other.page')
-    path = Webgen::Path.new('path.html')
-    assert_equal('test/path.html', @obj.output_path(node, path, output_path_style))
-    path = Webgen::Path.new('path.en.html')
-    assert_equal('test/path.en.html', @obj.output_path(node, path, output_path_style))
+    path = path_with_meta_info('path.html')
+    assert_equal('test/path.html', @obj.output_path(node, path))
+    path = path_with_meta_info('path.en.html')
+    assert_equal('test/path.en.html', @obj.output_path(node, path))
 
-    path = Webgen::Path.new('#frag')
-    assert_equal('test/path.html#frag', @obj.output_path(other, path, output_path_style))
+    path = path_with_meta_info('#frag')
+    assert_equal('test/path.html#frag', @obj.output_path(other, path))
     frag = Webgen::Node.new(other, 'test/path.html#frag', '#frag')
-    path = Webgen::Path.new('#frag1')
-    assert_equal('test/path.html#frag1', @obj.output_path(frag, path, output_path_style))
+    path = path_with_meta_info('#frag1')
+    assert_equal('test/path.html#frag1', @obj.output_path(frag, path))
+
+    path = path_with_meta_info('/')
+    assert_equal('/', @obj.output_path(@tree.dummy_root, path))
+    path = path_with_meta_info('/', 'output_path_style' => [:parent, 'hallo', 56])
+    assert_equal('hallo/', @obj.output_path(@tree.dummy_root, path))
 
-    path = Webgen::Path.new('/')
-    assert_equal('/', @obj.output_path(@tree.dummy_root, path, output_path_style))
-    assert_equal('hallo/', @obj.output_path(@tree.dummy_root, path, [:parent, 'hallo', 56]))
+    assert_raise(RuntimeError) do
+      path = path_with_meta_info('path.html', 'output_path_style' => [:parent, :year, '/', :month, '/', :cnbase, :ext])
+      @obj.output_path(node, path)
+    end
+    time = Time.parse('2008-09-04 08:15')
+    path = path_with_meta_info('path.html', 'output_path_style' => [:parent, :year, '/', :month, '/', :day, '-', :cnbase, :ext],
+                               'created_at' => time)
+    assert_equal('test/2008/09/04-path.html', @obj.output_path(node, path))
   end
 
   def test_content

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: webgen
 version: !ruby/object:Gem::Version 
-  version: 0.5.3
+  version: 0.5.4
 platform: ruby
 authors: 
 - Thomas Leitner
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-08-25 00:00:00 +02:00
+date: 2008-09-08 00:00:00 +02:00
 default_executable: webgen
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -162,6 +162,26 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 0.2.29
     version: 
+- !ruby/object:Gem::Dependency 
+  name: erubis
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.6.2
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rdiscount
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.9
+    version: 
 description: webgen is used to generate static websites from templates and content files (which can be written in a markup language). It can generate dynamic content like menus on the fly and comes with many powerful extensions.
 email: t_leitner@gmx.at
 executables: 
@@ -340,8 +360,10 @@ files:
 - doc/contentprocessor/blocks.page
 - doc/contentprocessor/builder.page
 - doc/contentprocessor/erb.page
+- doc/contentprocessor/erubis.page
 - doc/contentprocessor/haml.page
 - doc/contentprocessor/maruku.page
+- doc/contentprocessor/rdiscount.page
 - doc/contentprocessor/rdoc.page
 - doc/contentprocessor/redcloth.page
 - doc/contentprocessor/sass.page
@@ -394,8 +416,10 @@ files:
 - lib/webgen/contentprocessor/builder.rb
 - lib/webgen/contentprocessor/context.rb
 - lib/webgen/contentprocessor/erb.rb
+- lib/webgen/contentprocessor/erubis.rb
 - lib/webgen/contentprocessor/haml.rb
 - lib/webgen/contentprocessor/maruku.rb
+- lib/webgen/contentprocessor/rdiscount.rb
 - lib/webgen/contentprocessor/rdoc.rb
 - lib/webgen/contentprocessor/redcloth.rb
 - lib/webgen/contentprocessor/sass.rb
@@ -465,8 +489,10 @@ files:
 - test/test_contentprocessor_builder.rb
 - test/test_contentprocessor_context.rb
 - test/test_contentprocessor_erb.rb
+- test/test_contentprocessor_erubis.rb
 - test/test_contentprocessor_haml.rb
 - test/test_contentprocessor_maruku.rb
+- test/test_contentprocessor_rdiscount.rb
 - test/test_contentprocessor_rdoc.rb
 - test/test_contentprocessor_redcloth.rb
 - test/test_contentprocessor_sass.rb