webgen 0.5.7 → 0.5.8

data/lib/webgen/cli/webgui_command.rb

@@ -1,6 +1,7 @@
 # -*- encoding: utf-8 -*-
 
 require 'webgen/cli'
+require 'facets/kernel/silence'
 
 module Webgen::CLI
 
@@ -14,35 +15,49 @@ module Webgen::CLI
 
     # Render the website.
     def execute(args)
-      # some fixes for ramaze-2008.06
-      # - fix for Windows bug when win32console is not installed
+      # some fixes for ramaze-2009.04
+      # - fix for Windows when win32console is not installed
       # - fix for message displayed on shutdown
+      # - fix for warning message
       $:.unshift File.join(Webgen.data_dir, 'webgui', 'overrides')
       require 'win32console'
       $:.shift
-      require 'ramaze'
-      Ramaze::Log.loggers = []
+      silence_warnings do
+        begin
+          require 'ramaze/snippets/object/__dir__'
+          Object.__send__(:include, Ramaze::CoreExtensions::Object)
+          require 'ramaze'
+        rescue LoadError
+          puts "The Ramaze web framework which is needed for the webgui was not found."
+          puts "You can install it via 'gem install ramaze --version 2009.04'"
+          return
+        end
+      end
       def Ramaze.shutdown; # :nodoc:
       end
 
-      acquire Webgen.data_dir/:webgui/:controller/'*'
-      Ramaze::Global.setup do |g|
-        g.root = Webgen.data_dir/:webgui
-        g.public_root = Webgen.data_dir/:webgui/:public
-        g.view_root = Webgen.data_dir/:webgui/:view
-        g.adapter = :webrick
-        g.port = 7000
+      require File.join(Webgen.data_dir, 'webgui', 'app.rb')
+      Ramaze::Log.loggers = []
+      Ramaze.options[:middleware_compiler]::COMPILED[:dev].middlewares.delete_if do |app, args, block|
+        app == Rack::CommonLogger
       end
 
       puts 'Starting webgui on http://localhost:7000, press Control-C to stop'
+
       Thread.new do
-        sleep 2
-        puts 'Launching web browser'
-        require 'launchy'
-        Launchy.open('http://localhost:7000')
+        begin
+          require 'launchy'
+          sleep 1
+          puts 'Launching web browser'
+          Launchy.open('http://localhost:7000')
+        rescue LoadError
+          puts "Can't open browser because the launchy library was not found."
+          puts "You can install it via 'gem install launchy'"
+          puts "Please open a browser window and enter 'http://localhost:7000' into the address bar!"
+        end
       end
 
-      Ramaze.start
+      Ramaze.start(:adapter => :webrick, :port => 7000, :file => File.join(Webgen.data_dir, 'webgui', 'app.rb'))
       puts 'webgui finished'
     end
 

data/lib/webgen/configuration.rb

@@ -10,9 +10,11 @@ module Webgen
   #
   #   config.my.new.config 'value', :doc => 'some', :meta => 'info'
   #
-  # and later accessed or set using the accessor methods #[] and #[]= or a configuration
-  # helper. These helpers are defined in the Helpers module and provide easier access to complex
-  # configuration options.
+  # and later accessed or set using the accessor methods #[] and #[]= or a configuration helper.
+  # These helpers are defined in the Helpers module and provide easier access to complex
+  # configuration options. Also see the {webgen
+  # manual}[http://webgen.rubyforge.org/documentation/manual.html#website-configfile] for
+  # information about the configuration helpers.
   class Configuration
 
     # Helper class for providing an easy method to define configuration options.
@@ -55,9 +57,9 @@ module Webgen
     # The special key <tt>:action</tt> should be used for specifying how the configuration option
     # should be set:
     #
-    #   replace::  Replace the configuration option with the new values.
-    #   modify::   Replace old values with new values and add missing ones (useful for hashes and
-    #              normally the default value)
+    # [replace]  Replace the configuration option with the new values.
+    # [modify]   Replace old values with new values and add missing ones (useful for hashes and
+    #            normally the default value)
     module Helpers
 
       # Set the default meta information for source handlers.

data/lib/webgen/contentprocessor.rb

@@ -4,12 +4,12 @@ module Webgen
 
   # Namespace for all content processors.
   #
-  # = Implementing a content processor
+  # == Implementing a content processor
   #
   # Content processors are used to process the content of files, normally of files in Webgen Page
   # Format. A content processor only needs to respond to one method called +call+ and must not take
   # any parameters in the +initialize+ method. This method is invoked with a
-  # Webgen::ContentProcessor::Context object that provides the whole context (especially the content
+  # Webgen::Context object that provides the whole context (especially the content
   # and the node chain) and the method needs to return this object. During processing a content
   # processor normally changes the content of the context but it does not need to.
   #
@@ -21,7 +21,7 @@ module Webgen
   # be a short name without special characters or spaces and the value is the class name, not as
   # constant but as a string.
   #
-  # = Sample Content Processor
+  # == Sample Content Processor
   #
   # The following sample content processor checks for a meta information +replace_key+ and replaces
   # strings of the form <tt>replace_key:path/to/node</tt> with a link to the specified node if it is
@@ -55,7 +55,6 @@ module Webgen
   #
   module ContentProcessor
 
-    autoload :Context, 'webgen/contentprocessor/context'
     autoload :Tags, 'webgen/contentprocessor/tags'
     autoload :Blocks, 'webgen/contentprocessor/blocks'
     autoload :Maruku, 'webgen/contentprocessor/maruku'
@@ -80,7 +79,7 @@ module Webgen
       klass.nil? ? nil : WebsiteAccess.website.cache.instance(klass)
     end
 
-    # Helper class for accessing content processors in a Webgen::ContentProcessor::Context object.
+    # Helper class for accessing content processors in a Webgen::Context object.
     class AccessHash
 
       # Check if a content processor called +name+ exists.

data/lib/webgen/contentprocessor/blocks.rb

@@ -33,6 +33,8 @@ module Webgen::ContentProcessor
 
         if attr['node'] == 'first'
           used_chain.shift while used_chain.length > 0 && !used_chain.first.node_info[:page].blocks.has_key?(attr['name'])
+        elsif attr['node'] == 'current'
+          used_chain = context[:chain].dup
         end
         block_node = used_chain.first
 

data/lib/webgen/contentprocessor/builder.rb

@@ -6,14 +6,17 @@ module Webgen::ContentProcessor
   # library.
   class Builder
 
+    include Deprecated
+
     # Process the content of +context+ which needs to be valid Ruby code. The special variable +xml+
     # should be used to construct the XML content.
     def call(context)
       require 'builder'
 
-      node = context.content_node
-      ref_node = context.ref_node
-      dest_node = context.dest_node
+      website = deprecate('website', 'context.website', context.website)
+      node = deprecate('node', 'context.node', context.content_node)
+      ref_node = deprecate('ref_node', 'context.ref_node', context.ref_node)
+      dest_node = deprecate('dest_node', 'context.dest_node', context.dest_node)
 
       xml = ::Builder::XmlMarkup.new(:indent => 2)
       eval(context.content, binding, context.ref_node.absolute_lcn)

data/lib/webgen/contentprocessor/erb.rb

@@ -5,13 +5,16 @@ module Webgen::ContentProcessor
   # Processes embedded Ruby statements.
   class Erb
 
+    include Deprecated
+
     # Process the Ruby statements embedded in the content of +context+.
     def call(context)
       require 'erb'
 
-      node = context.content_node
-      ref_node = context.ref_node
-      dest_node = context.dest_node
+      website = deprecate('website', 'context.website', context.website)
+      node = deprecate('node', 'context.node', context.content_node)
+      ref_node = deprecate('ref_node', 'context.ref_node', context.ref_node)
+      dest_node = deprecate('dest_node', 'context.dest_node', context.dest_node)
 
       erb = ERB.new(context.content)
       erb.filename = context.ref_node.absolute_lcn

data/lib/webgen/contentprocessor/erubis.rb

@@ -5,7 +5,7 @@ module Webgen::ContentProcessor
   # Processes embedded Ruby statements with the +erubis+ library.
   class Erubis
 
-    include Webgen::WebsiteAccess
+    include Deprecated
 
     # Process the Ruby statements embedded in the content of +context+.
     def call(context)
@@ -13,17 +13,18 @@ module Webgen::ContentProcessor
       # including Erubis because of problem with resolving Erubis::XmlHelper et al
       self.class.class_eval "include ::Erubis"
 
-      node = context.content_node
-      ref_node = context.ref_node
-      dest_node = context.dest_node
+      website = deprecate('website', 'context.website', context.website)
+      node = deprecate('node', 'context.node', context.content_node)
+      ref_node = deprecate('ref_node', 'context.ref_node', context.ref_node)
+      dest_node = deprecate('dest_node', 'context.dest_node', context.dest_node)
 
-      options = website.config['contentprocessor.erubis.options']
+      options = context.website.config['contentprocessor.erubis.options']
       if context[:block]
         use_pi = context[:block].options['erubis_use_pi']
         context[:block].options.select {|k,v| k =~ /^erubis_/}.
           each {|k,v| options[k.sub(/^erubis_/, '').to_sym] = v }
       end
-      erubis = if (!use_pi.nil? && use_pi) || (use_pi.nil? && website.config['contentprocessor.erubis.use_pi'])
+      erubis = if (!use_pi.nil? && use_pi) || (use_pi.nil? && context.website.config['contentprocessor.erubis.use_pi'])
                     ::Erubis::PI::Eruby.new(context.content, options)
                   else
                     ::Erubis::Eruby.new(context.content, options)

data/lib/webgen/contentprocessor/haml.rb

@@ -5,15 +5,18 @@ module Webgen::ContentProcessor
   # Processes content in Haml markup using the +haml+ library.
   class Haml
 
+    include Deprecated
+
     # Convert the content in +haml+ markup to HTML.
     def call(context)
       require 'haml'
 
       locals = {
         :context => context,
-        :node => context.content_node,
-        :ref_node => context.ref_node,
-        :dest_node => context.dest_node,
+        :website => deprecate('website', 'context.website', context.website),
+        :node => deprecate('node', 'context.node', context.content_node),
+        :ref_node => deprecate('ref_node', 'context.ref_node', context.ref_node),
+        :dest_node => deprecate('dest_node', 'context.dest_node', context.dest_node)
       }
       context.content = ::Haml::Engine.new(context.content, :filename => context.ref_node.absolute_lcn).
         render(Object.new, locals)

data/lib/webgen/contentprocessor/rdoc.rb

@@ -9,7 +9,6 @@ module Webgen::ContentProcessor
     # Convert the content in RDoc markup to HTML.
     def call(context)
       require 'rdoc/markup/to_html'
-
       context.content = ::RDoc::Markup::ToHtml.new.convert(context.content)
       context
     end

data/lib/webgen/contentprocessor/redcloth.rb

@@ -8,7 +8,9 @@ module Webgen::ContentProcessor
     # Convert the content in +context+ to HTML.
     def call(context)
       require 'redcloth'
-      context.content = ::RedCloth.new(context.content).to_html
+      doc = ::RedCloth.new(context.content)
+      doc.hard_breaks = context.website.config['contentprocessor.redcloth.hard_breaks']
+      context.content = doc.to_html
       context
     end
 

data/lib/webgen/context.rb

@@ -0,0 +1,73 @@
+# -*- encoding: utf-8 -*-
+require 'webgen/context/nodes'
+
+module Webgen
+
+  # This class represents the context object that is passed, for example, to the +call+ method of a
+  # content processor.
+  #
+  # The needed context variables are stored in the +options+ hash. You can set any options you like,
+  # however, there are three noteworthy options:
+  #
+  # [<tt>:content</tt>]
+  #   The content string that should be processed.
+  #
+  # [<tt>:processors</tt>]
+  #   Normally an AccessHash object providing access to all available content processors.
+  #
+  # [<tt>:chain</tt>]
+  #   The chain of nodes that is processed. There are some utiltity methods for getting
+  #   special nodes of the chain (see #ref_node, #content_node and #dest_node).
+  class Context
+
+    include Webgen::WebsiteAccess
+    public :website
+
+    # Processing options
+    attr_accessor :options
+
+    # Create a new Context object. You can use the +options+ hash to set needed options.
+    #
+    # The following options are set by default and can be overridden via the +options+ hash:
+    #
+    # [<tt>:content</tt>]
+    #   Is set to an empty string.
+    #
+    # [<tt>:processors</tt>]
+    #   Is set to a new AccessHash.
+    def initialize(options = {})
+      @options = {
+        :content => '',
+        :processors => Webgen::ContentProcessor::AccessHash.new
+      }.merge(options)
+    end
+
+    # Create a copy of the current object. You can use the +options+ parameter to override options
+    # of the current Context object in the newly created Context object.
+    def clone(options = {})
+      self.class.new(@options.merge(options))
+    end
+
+    # Return the value of the option +name+.
+    def [](name)
+      @options[name]
+    end
+
+    # Set the option +name+ to the given +value.
+    def []=(name, value)
+      @options[name] = value
+    end
+
+    # Return the <tt>:content</tt> option.
+    def content
+      @options[:content]
+    end
+
+    # Set the <tt>:content</tt> option to the given +value+.
+    def content=(value)
+      @options[:content] = value
+    end
+
+  end
+
+end

data/lib/webgen/context/nodes.rb

@@ -0,0 +1,36 @@
+module Webgen
+
+  class Context
+
+    # Return the node which represents the file into which everything gets rendered. This is normally
+    # the same node as <tt>#content_node</tt> but can differ in special cases. For example, when
+    # rendering the content of node called <tt>my.page</tt> into the output of the node
+    # <tt>this.page</tt>, <tt>this.page</tt> would be the +dest_node+ and <tt>my.page</tt> would be
+    # the +content_node+.
+    #
+    # The +dest_node+ is not included in the chain but can be set via the option <tt>:dest_node</tt>!
+    #
+    # The returned node should be used as source node for calculating relative paths to other nodes.
+    def dest_node
+      @options[:dest_node] || self.content_node
+    end
+
+    # Return the reference node, ie. the node which provided the original content for this context
+    # object.
+    #
+    # The returned node should be used, for example, for resolving relative paths.
+    def ref_node
+      @options[:chain] && @options[:chain].first
+    end
+
+    # Return the node that is ultimately rendered.
+    #
+    # This node should be used, for example, for retrieving meta information.
+    def content_node
+      @options[:chain] && @options[:chain].last
+    end
+    alias :node :content_node
+
+  end
+
+end

data/lib/webgen/coreext.rb

@@ -1,12 +1,13 @@
 # -*- encoding: utf-8 -*-
 
-# :nodoc:
+# :stopdoc:
 class Array
 
-  def to_hash # :nodoc:
+  def to_hash
     h = {}
     self.each {|k,v| h[k] = v}
     h
   end
 
 end
+# :startdoc:

data/lib/webgen/default_config.rb

@@ -156,9 +156,11 @@ config.contentprocessor.tags.map({
                                    :default => 'Webgen::Tag::Metainfo'
                                  }, :doc => 'Tag processor name to class map')
 
-config.contentprocessor.erubis.use_pi(false, :doc => 'Specify whether processing instructions should be used')
+config.contentprocessor.erubis.use_pi(false, :doc => 'Specifies whether processing instructions should be used')
 config.contentprocessor.erubis.options({}, :doc => 'A hash of additional options')
 
+config.contentprocessor.redcloth.hard_breaks(false, :doc => 'Specifies whether new lines are turned into hard breaks')
+
 config.tag.relocatable.path(nil, :doc => 'The path which should be made relocatable', :mandatory => 'default')
 
 config.tag.menu.start_level(1, :doc => 'The level at which the menu starts.')

data/lib/webgen/deprecated.rb

@@ -0,0 +1,53 @@
+module Webgen
+
+  class Node
+
+    def flagged(key)
+      warn("Deprecation warning: this method will be removed in one of the next releases - use Node#flagged? instead!")
+      flagged?(key)
+    end
+
+  end
+
+  def self.const_missing(const)
+    if const.to_s == 'Block'
+      warn("Deprecation warning: Webgen::Block name will be removed in one of the next releases - use Webgen::Page::Block instead!")
+      Webgen::Page::Block
+    elsif const.to_s == "WebgenPageFormatError"
+      warn("Deprecation warning: Webgen::WebgenPageFormatError name will be removed in one of the next releases - use Webgen::Page::FormatError instead!")
+      Webgen::Page::FormatError
+    else
+      super
+    end
+  end
+
+  module ContentProcessor
+
+    def self.const_missing(const)
+      if const.to_s == 'Context'
+        warn("Deprecation warning: Webgen::ContentProcessor::Context is now named Webgen::Context! This alias will be removed in one of the next releases.")
+        Webgen::Context
+      else
+        super
+      end
+    end
+
+    module Deprecated
+
+      def deprecate(old, new, obj)
+        klass = Class.new
+        klass.instance_methods.select {|m| m.to_s !~ /^(__|instance_eval|object_id)/}.each {|m| klass.__send__(:undef_method, m)}
+        result = klass.new
+        result.instance_eval { @old, @new, @obj = old, new, obj }
+        def result.method_missing(sym, *args, &block)
+          Kernel::warn("Deprecation warning (~ #{caller.first}): The alias '#{@old}' will be removed in one of the next releases - use '#{@new}' instead!")
+          @obj.send(sym, *args, &block)
+        end
+        result
+      end
+
+    end
+
+  end
+
+end