webgen 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bc28598716d6dbfc5755161abde547978815a8fb
-  data.tar.gz: 9fcab153b65bfcb25fe189174e292591153944fb
+  metadata.gz: 8014eb18c4f772caae6df97d2a0887e4a1618672
+  data.tar.gz: 8ed2ef00768fd1696394485f1785564428308a5d
 SHA512:
-  metadata.gz: a8819bc56874a30b1d5c0b63bb7f65a7fe8a104c8c8ed7c2b659db128d600a9ffd66d3e821e476b4c29775596678f83aafaf3025dee52ec715a966184cfbad50
-  data.tar.gz: e0a3b69860bdcf22c5b654f0c37529543acc7137ba5a6d5841c10fc56b10da308160451d38b4b397d22e82710b28da39deec537c7e5109db4207f2045bc33eeb
+  metadata.gz: b346a18e36607dd4262de8f5245e2d19f143433d2b3ddf2d4769216b88a18b35db8ee22728cb9a93e82d1045cbfe85595e1923d522f8d644ec9887442565292f
+  data.tar.gz: 2ebbd16b45b3a20337e53321520e05f7ed7054cbf2463538bf6d9a45e1d27269f7929f5e71edb1044ccb71d92fa37f55a90add30887e3c6fd28c58cb8f64e7cd

data/README.md

@@ -46,14 +46,14 @@ makes authoring websites easier:
 
 * No need to know the Ruby language for basic websites
 
-The main documentation lives at <http://webgen.rubyforge.org/documentation/>.
+The main documentation lives at <http://webgen.gettalong.org/documentation/>.
 
 
 ## Installation
 
 webgen is written in Ruby, so you need the Ruby interpreter on your
 system. You can get it from http://ruby-lang.org/. See
-<http://webgen.rubyforge.org/installation.html> for more information.
+<http://webgen.gettalong.org/installation.html> for more information.
 
 You can install webgen via Rubygems:
 

data/Rakefile

@@ -98,11 +98,11 @@ EOF
     s.post_install_message = <<EOF
 
 Thanks for choosing webgen! Here are some places to get you started:
-* The webgen User Documentation at <http://webgen.rubyforge.org/documentation/>
+* The webgen User Documentation at <http://webgen.gettalong.org/documentation/>
 * The mailing list archive at <http://rubyforge.org/pipermail/webgen-users/>
 * The webgen Wiki at <http://github.com/gettalong/webgen/wiki>
 
-Have a look at <http://webgen.rubyforge.org/news.html> for a list of changes!
+Have a look at <http://webgen.gettalong.org/news.html> for a list of changes!
 
 Have fun!
 
@@ -145,7 +145,7 @@ EOF
 
     s.author = 'Thomas Leitner'
     s.email = 't_leitner@gmx.at'
-    s.homepage = "http://webgen.rubyforge.org"
+    s.homepage = "http://webgen.gettalong.org"
     s.rubyforge_project = 'webgen'
   end
 
@@ -188,7 +188,7 @@ EOF
       rf.configure
       rf.login
 
-      text = "Have a look at http://webgen.rubyforge.org/news.html for the release details!"
+      text = "Have a look at http://webgen.gettalong.org/news.html for the release details!"
       rf.post_news('webgen', "webgen #{Webgen::VERSION} released", text)
       puts "done"
     end

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.1.0

data/data/webgen/basic_website_template/ext/init.rb

@@ -10,7 +10,7 @@
 # * For information on how to write extensions, have a look at the API
 #   documentation of webgen at
 #
-#     http://webgen.rubyforge.org/documentation/reference/api/
+#     http://webgen.gettalong.org/documentation/reference/api/
 #
 # * Have a look at the API documentation of Webgen::BundlerLoader to see
 #   what methods are available in init.rb files.

data/data/webgen/basic_website_template/webgen.config

@@ -12,7 +12,7 @@
 # The available configuration options can be found on the homepage in the Configuration Option
 # Reference at
 #
-#     http://webgen.rubyforge.org/documentation/reference/configuration_options.html
+#     http://webgen.gettalong.org/documentation/reference/configuration_options.html
 #
 # More info about YAML itself can be found at http://www.yaml.org/
 #####

data/data/webgen/passive_sources/templates/feed.template

@@ -10,7 +10,7 @@
 
   <link href="<%= context.node.feed_link %>" rel="alternate" />
   <link href="<%= context.node.url %>" rel="self" />
-  <generator uri="http://webgen.rubyforge.org/" version="<%= Webgen::VERSION %>">
+  <generator uri="http://webgen.gettalong.org/" version="<%= Webgen::VERSION %>">
     webgen - Webgen::PathHandler::Feed
   </generator>
   <updated><%= Time.now.xmlschema %></updated>

data/data/webgen/passive_sources/templates/tag.template

@@ -1,6 +1,6 @@
 --- name:tag.langbar pipeline:ruby ------------------------------------------------------------------
 context.content = context[:nodes].map do |node|
-  attrs = {'link_text' => node.lang}
+  attrs = {'link_text' => context[:config]['tag.langbar.mapping'][node.lang] || node.lang}
   attrs['class'] = 'webgen-langbar-current-lang' if context.content_node.lang == node.lang
   context.dest_node.link_to(node, node.lang, attrs)
 end.join(context[:config]['tag.langbar.separator'])

data/lib/webgen/bundle/built-in/info.yaml

@@ -772,6 +772,18 @@ options:
       tag: |
         {include_file: {filename: my_file.txt, process_output: false}}
 
+  tag.langbar.mapping:
+    summary: |
+      A hash with a mapping from language codes to display strings. If there is no mapping for a
+      language code, the language code itself is displayed.
+    syntax: |
+      `MAPPING` where `MAPPING` is a hash with the mappings
+    example:
+      config: |
+        tag.langbar.mapping: {de: Deutsch, en: English}
+      tag: |
+        {menu: {mapping: {de: Deutsch, en: English}}}
+
   tag.langbar.separator:
     summary: |
       The string that should be used as separator between the individual language parts.
@@ -1042,6 +1054,16 @@ options:
       config: |
         website.lang: de
 
+  website.link_to_current_page:
+    summary:
+      Specifies whether generated links to the current page should be used. If `false`, then a
+      `<span>` element is used instead of a `<href>` element.
+    syntax: |
+      `true` or `false`.
+    example:
+      config: |
+        website.link_to_current_page: false
+
   website.base_url:
     summary: |
       The base URL of the website. It is used to create absolute URLs when relative URLs won't
@@ -1050,7 +1072,7 @@ options:
       `URL` where `URL` is the base URL of the website
     example:
       config: |
-        website.base_url: http://webgen.rubyforge.org
+        website.base_url: http://webgen.gettalong.org
 
   website.tmpdir:
     summary: |

data/lib/webgen/bundle/built-in/init.rb

@@ -54,7 +54,7 @@ option('website.lang', 'en') do |val|
 end
 
 option('website.base_url', '', &is_string)
-
+option('website.link_to_current_page', true, &true_or_false)
 
 ########################################################################
 # Everything related to the content processor extension
@@ -309,6 +309,7 @@ option('tag.langbar.show_single_lang', true, &true_or_false)
 option('tag.langbar.show_own_lang', true, &true_or_false)
 option('tag.langbar.template', '/templates/tag.template')
 option('tag.langbar.separator', ' | ')
+option('tag.langbar.mapping', {}, &is_hash)
 
 tag.register('BreadcrumbTrail')
 option('tag.breadcrumb_trail.omit_dir_index', false &true_or_false)

data/lib/webgen/bundle_loader.rb

@@ -2,6 +2,7 @@
 
 require 'rbconfig'
 require 'yaml'
+require 'webgen/error'
 
 module Webgen
 
@@ -90,7 +91,7 @@ module Webgen
     # Load the extension bundle in the context of this BundleLoader object.
     def load(name)
       file = resolve_init_file(name)
-      raise(ArgumentError, "Extension bundle '#{name}' not found") if !file
+      raise Webgen::BundleLoadError.new(name) if !file
       file = File.expand_path(file)
       return if @loaded.include?(file)
 

data/lib/webgen/cli.rb

@@ -193,7 +193,10 @@ module Webgen
           if level == 0
             # Create website object/automatically performs initialization; needed so that custom
             # commands can be added
-            website
+            begin
+              website
+            rescue Webgen::BundleLoadError
+            end
           end
         end
       rescue

data/lib/webgen/content_processor/kramdown.rb

@@ -39,6 +39,7 @@ module Webgen
         options[:link_defs] = context.website.ext.link_definitions.merge(options[:link_defs] || {})
         doc = ::Kramdown::Document.new(context.content, options)
         context.content = CustomHtmlConverter.new(doc.root, doc.options, context).convert(doc.root)
+        context.content.encode!(doc.root.options[:encoding])
         doc.warnings.each do |warn|
           context.website.logger.warn { "kramdown warning while parsing <#{context.ref_node}>: #{warn}" }
         end

data/lib/webgen/error.rb

@@ -126,6 +126,21 @@ module Webgen
   end
 
 
+  # This error is raised when a needed bundle is not found.
+  class BundleLoadError < Error
+
+    # The name of the bundle that is missing.
+    attr_reader :bundle
+
+    # Create a new BundleLoadError.
+    def initialize(bundle)
+      super("The needed bundle '#{bundle}' is missing.", nil, nil)
+    end
+
+  end
+
+
+
   # This error is raised when a needed external command is not found.
   class CommandNotFoundError < Error
 

data/lib/webgen/path.rb

@@ -59,7 +59,7 @@ module Webgen
     def self.append(base, path)
       raise(ArgumentError, 'base needs to start with a slash (i.e. be an absolute path)') unless base[0] == ?/
       url = url(base) + url(path, false)
-      url.path << (url.fragment.nil? ? '' : "##{url.fragment}")
+      (url.path << (url.fragment.nil? ? '' : "##{url.fragment}")).encode!(path.encoding)
     end
 
     # Return +true+ if the given path string matches the given path pattern.

data/lib/webgen/path_handler/base.rb

@@ -41,14 +41,25 @@ module Webgen
           node_url.absolute? ? node_url : File.join(tree.website.config['website.base_url'], dest_path)
         end
 
-        # Does exactly the same as Node#route_to but also automatically adds the necessary item
-        # tracking information.
+        # Does exactly the same as Webgen::Node#route_to but also automatically adds the necessary
+        # item tracking information.
         def route_to(node, lang = @lang)
           tree.website.ext.item_tracker.add(self, :node_meta_info, node)
           tree.website.ext.item_tracker.add(self, :node_meta_info, node.proxy_node(lang))
           super
         end
 
+        # Does exactly the same as Webgen::Node#link_to but replaces the HTML a-tag with a span-tag
+        # depending on the configuration option 'website.link_to_current_page'.
+        def link_to(*args, &block)
+          result = super
+          if !tree.website.config['website.link_to_current_page']
+            result.sub!(/<a/, '<span').sub!(/<\/a>/, '</span>').
+              gsub!(/ (?:href|hreflang)=".*"/, '')
+          end
+          result
+        end
+
         # Return the result of the #content method on the associated path handler or +nil+ if the
         # associated path handler does not have a #content method.
         def content

data/lib/webgen/tag.rb

@@ -50,19 +50,27 @@ module Webgen
   # Following is a simple tag class example which just reverses the body text and adds some
   # information about the context to the result.
   #
+  # Put the following into the ext/init.rb file of your webgen website:
+  #
   #   class Reverser
   #
   #     def self.call(tag, body, context)
-  #       result = context[:config]['do_reverse'] ? body.reverse : body
-  #       result << "Node: " << context.content_node.alcn << " (" << context.content_node['title'] << ")"
-  #       result << "Reference node: " << context.ref_node.alcn
+  #       result = context[:config]['tag.reverser.do_reverse'] ? body.reverse : body
+  #       result << "\nNode: " << context.content_node.alcn << " (" << context.content_node['title'] << ")"
+  #       result << "\nReference node: " << context.ref_node.alcn
   #       result
   #     end
   #
   #   end
   #
-  #   website.config.define_option('reverser.do_reverse', nil, 'Actually do reverse the text')
-  #   website.ext.tag.register Reverser, :names => 'reverse', :mandatory => ['do_reverse']
+  #   website.config.define_option('tag.reverser.do_reverse', nil)
+  #   website.ext.tag.register(Reverser, :names => 'reverse',
+  #                            :config_prefix => 'tag.reverser',
+  #                            :mandatory => ['do_reverse'])
+  #
+  # Then you can use the reverser tag as follows in a page file:
+  #
+  #   {reverse:: {do_reverse: true}}This text is reversed{reverse}
   #
   class Tag
 
@@ -189,8 +197,10 @@ module Webgen
     # prefix.
     def create_config(tag, params, tdata, context)
       values = case params
-               when Hash then values_from_hash(tag, params, tdata, context)
-               when String, Array then values_for_default_mandatory(tag, params, tdata, context)
+               when Hash
+                 values_from_hash(tag, params, tdata, context)
+               when String, Array, TrueClass, FalseClass, Numeric
+                 values_for_default_mandatory(tag, params, tdata, context)
                when NilClass then {}
                else
                  raise Webgen::RenderError.new("Invalid parameter type (#{params.class})",

data/lib/webgen/version.rb

@@ -3,6 +3,6 @@
 module Webgen
 
   # The version of webgen.
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 
 end

data/man/man1/webgen.1

@@ -96,7 +96,7 @@ webgen's behaviour is affected by the following environment variables:
 If no website is specified via the \-d option and this variable is set, webgen assumes that its
 content is the webgen website directory that should be used.
 .SH SEE ALSO
-The webgen website, http://webgen.rubyforge.org/ for detailed information.
+The webgen website, http://webgen.gettalong.org/ for detailed information.
 .SH AUTHOR
 webgen was written by Thomas Leitner <t_leitner@gmx.at>
 .PP

data/test/webgen/path_handler/test_base.rb

@@ -18,7 +18,7 @@ class TestPathHandlerBase < Minitest::Test
   end
 
   def setup
-    setup_website('website.base_url' => 'http://example.com/sub')
+    setup_website
     @obj = TestPathHandler.new(@website)
   end
 
@@ -31,7 +31,6 @@ class TestPathHandlerBase < Minitest::Test
     node = @obj.create_node(path) {|n| count += 1; assert_kind_of(Webgen::PathHandler::Base::Node, n)}
     assert_equal(path, node.node_info[:path])
     assert_kind_of(Time, node.meta_info['modified_at'])
-    assert_equal('http://example.com/sub/path.html', node.url)
     assert_equal(1, count)
     assert_nil(node.content)
     def (@obj).content(node); node; end
@@ -150,4 +149,17 @@ class TestPathHandlerBase < Minitest::Test
     assert_equal(nil, @obj.node_exists?(Webgen::Path.new('/unknown'), '/unknown'))
   end
 
+  def test_base_node_methods
+    node = Webgen::PathHandler::Base::Node.new(@website.tree.dummy_root, '/', '/')
+    child_de = Webgen::PathHandler::Base::Node.new(node, 'somename.html', '/somename.html',
+                                                   {'lang' => 'de', 'title' => 'Somename'})
+    @website.config = {'website.base_url' => 'http://example.com/sub', 'website.link_to_current_page' => true}
+
+    assert_equal('http://example.com/sub/somename.html', child_de.url)
+
+    assert_equal('<a href="somename.html" hreflang="de">Somename</a>', node.link_to(child_de))
+    @website.config['website.link_to_current_page'] = false
+    assert_equal('<span>Somename</span>', node.link_to(child_de))
+  end
+
 end

data/test/webgen/tag/test_langbar.rb

@@ -28,11 +28,18 @@ class TestTagLangbar < Minitest::Test
 
     en_link = '<a class="webgen-langbar-current-lang" href="other.html" hreflang="en">en</a>'
     check_results(other, en_link, '', '', '', ' | ')
+
+    @context[:chain] = [node]
+    @context[:config] = {'tag.langbar.template' => '/tag.template', 'tag.langbar.mapping' => {'de' => 'Deutsch'}}
+    assert_equal('<a href="file.de.html" hreflang="de">Deutsch</a>', @obj.call('langbar', '', @context))
   end
 
   def check_results(node, both_true, both_false, first_false, second_false, separator)
     @context[:chain] = [node]
-    @context[:config] = {'tag.langbar.template' => '/tag.template', 'tag.langbar.separator' => separator}
+    @context[:config] = {'tag.langbar.template' => '/tag.template',
+      'tag.langbar.separator' => separator,
+      'tag.langbar.mapping' => {}
+    }
 
     @context[:config].update('tag.langbar.show_single_lang' => true, 'tag.langbar.show_own_lang' => true)
     assert_equal(both_true, @obj.call('langbar', '', @context))

data/test/webgen/test_bundle_loader.rb

@@ -40,6 +40,8 @@ EOF
   end
 
   def test_load
+    assert_raises(Webgen::BundleLoadError) { @loader.load('unknown') }
+
     @loader.load('webgen')
     assert_nil(@website.ext.bundle_infos.instance_variable_get(:@infos))
     assert_equal({}, @website.ext.bundle_infos.bundles['webgen'])

data/test/webgen/test_node.rb

@@ -31,7 +31,7 @@ class TestNode < Minitest::Test
     check_proc.call(child, node, '/somename.html', 'somename.html', 'somename.de.html',
                     '/somename.de.html', 'de', {})
 
-    ['http://webgen.rubyforge.org', 'c:\\test'].each_with_index do |abspath, index|
+    ['http://webgen.gettalong.org', 'c:\\test'].each_with_index do |abspath, index|
       cn = "test#{index}.html"
       c = Webgen::Node.new(node, cn, abspath)
       check_proc.call(c, node, abspath, cn, cn, '/' + cn, nil, {})

data/test/webgen/test_path.rb

@@ -30,6 +30,9 @@ class TestPath < Minitest::Test
     assert_equal('/test/dir', Webgen::Path.append('/other', '../test/dir'))
     assert_equal('/test', Webgen::Path.append('/', '/../test'))
     assert_equal('/dir/', Webgen::Path.append('/', '/../dir/.'))
+
+    assert_equal(Encoding::UTF_8, Webgen::Path.append('/', '/../dir/.').encoding)
+    assert_equal(Encoding::UTF_8, Webgen::Path.append('/', '/**.css').encoding)
   end
 
   def test_class_matches_pattern

data/test/webgen/test_tag.rb

@@ -67,7 +67,7 @@ class TestTag < Minitest::Test
     assert_raises(Webgen::RenderError) { @tag.call('my_tag', {}, 'body', context) }
 
     @tag.register('MyTag')
-    assert_raises(Webgen::RenderError) { @tag.call('my_tag', 5, 'body', context) }
+    assert_raises(Webgen::RenderError) { @tag.call('my_tag', Class.new, 'body', context) }
     assert_raises(Webgen::Configuration::Error) { @tag.call('my_tag', {'opt' => :value}, 'body', context) }
 
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: webgen
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Thomas Leitner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-01 00:00:00.000000000 Z
+date: 2013-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cmdparse
@@ -477,18 +477,18 @@ files:
 - test/webgen/test_utils.rb
 - test/webgen/test_website.rb
 - test/webgen/utils/test_tag_parser.rb
-homepage: http://webgen.rubyforge.org
+homepage: http://webgen.gettalong.org
 licenses:
 - GPL
 metadata: {}
 post_install_message: |2+
 
   Thanks for choosing webgen! Here are some places to get you started:
-  * The webgen User Documentation at <http://webgen.rubyforge.org/documentation/>
+  * The webgen User Documentation at <http://webgen.gettalong.org/documentation/>
   * The mailing list archive at <http://rubyforge.org/pipermail/webgen-users/>
   * The webgen Wiki at <http://github.com/gettalong/webgen/wiki>
 
-  Have a look at <http://webgen.rubyforge.org/news.html> for a list of changes!
+  Have a look at <http://webgen.gettalong.org/news.html> for a list of changes!
 
   Have fun!