webgen 0.4.7 → 0.5.0

data/lib/webgen/sipttra_format.rb

@@ -1,343 +0,0 @@
-#
-#--
-#
-# $Id: gallery.rb 569 2006-12-29 20:11:21Z thomas $
-#
-# webgen: template based static website generator
-# Copyright (C) 2004 Thomas Leitner
-#
-# This program is free software; you can redistribute it and/or modify it under the terms of the GNU
-# General Public License as published by the Free Software Foundation; either version 2 of the
-# License, or (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
-# even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
-# General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License along with this program; if not,
-# write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
-#
-#++
-#
-
-require 'yaml'
-require 'cgi'
-
-
-module Sipttra
-
-  # A simple node belonging to a Tracker. One node represents exactly one line of a sipttra file.
-  class Node
-
-    attr_accessor :tracker
-
-    # Returns the line representation of this node.
-    def to_line
-      ''
-    end
-
-  end
-
-
-  # Base class for all nodes which deal with simple text lines.
-  class TextNode < Node
-
-    # The text of the node/line.
-    attr_accessor :text
-
-    def initialize( text )
-      @text = text
-    end
-
-    def to_line
-      @text
-    end
-
-    def to_s
-      @text
-    end
-
-  end
-
-
-  # A comment is just a special text node.
-  class Comment < TextNode; end
-
-
-  # Represents a category line.
-  class Category < Node
-
-    # The name of the category.
-    attr_accessor :name
-
-    # The type of the category.
-    attr_accessor :type
-
-    def initialize( name, type = nil )
-      @name = name
-      @type = type
-      raise "Category must have a name" if name.nil?
-    end
-
-    # Returns all tickets belonging to this category.
-    def tickets
-      tickets = []
-      i = @tracker.nodes.index( self ) + 1
-      while i < @tracker.nodes.length
-        line = @tracker.nodes[i]
-        break if line.kind_of?( Category )
-        tickets << line if line.kind_of?( Ticket )
-        i += 1
-      end
-      tickets
-    end
-
-    def to_line
-      '### ' + to_s + ' ###'
-    end
-
-    def to_s
-      name + (type.nil? ? '' : ' (' + type + ')')
-    end
-
-  end
-
-
-  # Represents a ticket line.
-  class Ticket < Node
-
-    attr_accessor :name, :due_date, :belongs_to, :summary
-
-    def initialize( name, due_date, belongs_to, text = '' )
-      @name =  name
-      @due_date = due_date
-      @belongs_to = belongs_to
-      @summary = text.strip
-    end
-
-    # Returns the category to which this ticket belongs.
-    def category
-      i = @tracker.nodes.index( self ) - 1
-      i -= 1 while i >= 0 && !@tracker.nodes[i].kind_of?( Category )
-      (i < 0 ? nil : @tracker.nodes[i])
-    end
-
-    # Returns +true+ if this ticket is closed, ie. if it belongs to a category with type closed.
-    def closed?
-      category.type == 'closed'
-    end
-
-    # Returns the tickets assigned to this ticket, ie. all sub-tickets. The +type+ parameter can be
-    # one of:
-    # :open   :: all tickets with a type different from +closed+
-    # :closed :: all tickets with type +closed+
-    # :all    :: all tickets independent from type
-    def assigned_tickets( type = :all )
-      if @name.nil?
-        []
-      else
-        @tracker.tickets.select do |t|
-          t.belongs_to == @name &&
-            (type == :all || (type == :closed ? t.category.type == 'closed' : t.category.type != 'closed' ))
-        end
-      end
-    end
-
-    # Returns the detailed description for this ticket.
-    def description
-      text = []
-      line = nil
-      i = @tracker.nodes.index( self ) + 1
-      while i < @tracker.nodes.length && (line = @tracker.nodes[i]).kind_of?( AdditionalText )
-        text << line
-        i += 1
-      end
-      text.join( "\n" ).strip
-    end
-
-    # Returns the whole text for the ticket, ie. the summary and ticket joined by a line separator.
-    def all_text
-      [@summary, description].join( "\n" )
-    end
-    alias_method :to_s, :all_text
-
-    def to_line
-      s = '*'
-      s << ' ' + name unless name.nil?
-      s << ' (' + due_date + ')' unless due_date.nil?
-      s << ' [' + belongs_to + ']' unless belongs_to.nil?
-      s << (!name.nil? && due_date.nil? && belongs_to.nil? ? ':' : '' ) + (summary.empty? ? '' : ' ' + summary.to_s)
-      s
-    end
-
-  end
-
-
-  # Represents a milestone which is a special ticket.
-  class Milestone < Ticket
-
-    def initialize( *args )
-      super( *args )
-      raise "Milestone must have a name" if @name.nil?
-    end
-
-    # Like assigned_tickets but includes tickets in sub milestones.
-    def all_assigned_tickets( type = :all )
-      (assigned_tickets( type ) + sub_milestones.collect {|sm| sm.all_assigned_tickets( type )}).flatten
-    end
-
-    # A milestone is closed if all assigned tickets are closed, including the ones from the sub
-    # milestones.
-    def closed?
-      assigned_tickets( :open ).empty? && sub_milestones.all? {|sm| sm.closed?}
-    end
-
-    # Returns all direct sub milestones.
-    def sub_milestones
-      (@name.nil? ? [] : @tracker.milestones.select {|m| m.belongs_to == @name})
-    end
-
-  end
-
-
-  # Represents additional text lines for tickets. All additional text lines for one ticket are the
-  # ticket's description.
-  class AdditionalText < TextNode
-
-    def initialize( text )
-      super( text.sub( /^  /, '' ) )
-    end
-
-    def to_line
-      (@text.strip.empty? ? '' : '  ' + @text)
-    end
-
-  end
-
-
-  # The tracker is used to parse sipttra files and to change the sipttra data in memory.
-  class Tracker
-
-    IDENT_REGEXP=/\w[-.\w\d]*/
-
-    DATE_REGEXP=/\((\d\d\d\d-\d\d-\d\d)\)/
-    BELONGS_REGEXP=/\[(#{IDENT_REGEXP})\]/
-
-    TICKET_REGEXP=/^\*(?:\s(#{IDENT_REGEXP})(?=:|\s\[|\s\():?)?(?:\s#{DATE_REGEXP})?(?:\s#{BELONGS_REGEXP})?(?:$|\s(.*)$)/
-    CONTENT_REGEXP=/^\s\s(.*)$/
-    CATEGORY_REGEXP=/^(#+)\s{1,}([^(]*?)(?:\s*\((\w+)\))?\s{1,}\1$/
-
-    attr_reader :nodes, :info
-
-    def initialize( data = nil )
-      @nodes = []
-      @info = {}
-      parse( data ) if data
-    end
-
-    # Parses the given +data+ and fills the tracker with information.
-    def parse( data )
-      @nodes = []
-      @info = {}
-      level = 0
-
-      if data =~ /\A---\n/m
-        begin
-          index = data.index( "---\n", 4 ) || 0
-          @info = YAML.load( data[0...index] )
-          data = data[index..-1]
-        rescue
-        ensure
-          @info = {} unless @info.kind_of?( Hash )
-        end
-      end
-
-      data.split(/\n/).each do |line|
-        case
-        when (m = CATEGORY_REGEXP.match( line )) && category( m[2], m[3] ).nil?
-          @nodes << Category.new( m[2], m[3] )
-          level = 1
-
-        when level == 0
-          @nodes  << Comment.new( line )
-
-        when (m = TICKET_REGEXP.match( line )) && (milestone( m[1] ).nil? && ticket( m[1] ).nil?)
-          if @nodes.find_all {|child| child.kind_of?( Category )}.last.type.nil?
-            @nodes << Milestone.new( m[1], m[2], m[3], m[4] || '' )
-          else
-            @nodes << Ticket.new( m[1], m[2], m[3], m[4] || '' )
-          end
-
-        when (@nodes.last.kind_of?( Ticket ) || @nodes.last.kind_of?( AdditionalText )) &&
-            (line.empty? || (m = CONTENT_REGEXP.match( line )))
-          @nodes << AdditionalText.new( line )
-
-        else
-          @nodes << Comment.new( line )
-        end
-        @nodes.last.tracker = self
-      end
-
-    end
-
-    def check_consistency
-      # TODO what to check?
-    end
-
-    # If Bluecloth is available +text+ is considered to be in Markdown format and converted
-    # to HTML. Otherwise the unchanged text is returned.
-    def htmlize( text )
-      require 'bluecloth'
-      BlueCloth.new( text ).to_html
-    rescue
-      text
-    end
-
-    # Returns all categories.
-    def categories
-      @nodes.find_all {|child| child.kind_of?( Category ) && !child.type.nil? }
-    end
-
-    # Returns the category with the given +name+ and +type+.
-    def category( name, type )
-      categories.find {|cat| cat.name == name && cat.type == type}
-    end
-
-    # Returns all category names.
-    def category_names
-      categories.collect {|cat| cat.name}.uniq
-    end
-
-    # Returns all milestones.
-    def milestones
-      @nodes.find_all {|child| child.instance_of?( Milestone ) }
-    end
-
-    # Returns the milestone with the given +name+.
-    def milestone( name )
-      (name.nil? ? nil : milestones.find {|ms| ms.name == name})
-    end
-
-    # Returns all tickets independent from their categories.
-    def tickets
-      @nodes.find_all {|child| child.instance_of?( Ticket ) }
-    end
-
-    # Returns the ticket with the given +name+.
-    def ticket( name )
-      (name.nil? ? nil : tickets.find {|ticket| ticket.name == name})
-    end
-
-    # Returns all tickets for the category +name+ independent from the category type.
-    def tickets_for_category( name )
-      tickets.select {|t| t.category.name == name}
-    end
-
-    # Returns a string representation of the tracker which can later be used by #parse .
-    def to_s
-      @info.to_yaml.sub( /^---\s*\n/m, '' ) + "\n\n" + @nodes.collect {|line| line.to_line}.join( "\n" )
-    end
-
-  end
-
-end

data/lib/webgen/test.rb

@@ -1,202 +0,0 @@
-require 'webgen/config'
-
-Webgen::LOAD_DEFAULT_PLUGINS = false
-
-require 'test/unit'
-require 'webgen/plugin'
-
-module Webgen
-
-  # Base class for all webgen test cases. It specifies some auxilary methods helpful when developing
-  # tests.
-  class TestCase < Test::Unit::TestCase
-
-    # Sets the base fixture path and the fixture path for the test case.
-    def self.inherited( klass )
-      path = caller[0][/^.*?:/][0..-2]
-      dir, file = File.split( path )
-      parent_path, unit_tests = File.split( dir )
-
-      fpath = if dir == '.'
-                File.join( '..', 'fixtures' )
-              else
-                File.join( parent_path, 'fixtures' )
-              end
-
-      klass.instance_variable_set( :@fixture_path, File.join( fpath, File.basename( file, '.*' ) ) )
-      klass.instance_variable_set( :@base_fixture_path, fpath + '/' )
-    end
-
-    # Reimplemented to hide the base test case.
-    def self.suite
-      if self == TestCase
-        return Test::Unit::TestSuite.new('Webgen::TestCase')
-      else
-        super
-      end
-    end
-
-    # Helper method for retrieving a path name with an optionally appended filename.
-    def self.path_helper( var, filename = nil )
-      var = instance_variable_get( var )
-      (filename.nil? ? var : File.join( var, filename ) )
-    end
-
-    # If +filename+ is not specified, returns the fixture path for the test case. If +filename+ is
-    # specified, it is appended to the fixture path.
-    def self.fixture_path( filename = nil )
-      path_helper( :@fixture_path, filename )
-    end
-
-    # See TestCase.fixture_path
-    def fixture_path( filename = nil )
-      self.class.fixture_path( filename )
-    end
-
-    # Returns the base fixture path for the test case. If +filename+ is specified, it is appended to
-    # the base fixture path.
-    def self.base_fixture_path( filename = nil )
-      path_helper( :@base_fixture_path, filename )
-    end
-
-    # See TestCase.base_fixture_path
-    def base_fixture_path( filename = nil )
-      self.class.base_fixture_path( filename )
-    end
-
-  end
-
-
-  # Base class for all plugin test cases. It ensures that all needed plugins are loaded and
-  # initalized before each test and that the original environment is restored afterwards.
-  class PluginTestCase < TestCase
-
-    class << self
-
-      # Specifies +files+ as the plugin files which define the plugin which should be tested and its
-      # dependencies.
-      def plugin_files( files = nil )
-        (files.nil? ? @plugin_files.to_a + ['webgen/plugins/coreplugins/configuration.rb'] : @plugin_files = files )
-      end
-
-      # The name of the plugin which should be tested.
-      def plugin_to_test( plugin = nil )
-        @plugin_name ||= nil
-        (plugin.nil? ? @plugin_name : @plugin_name = plugin )
-      end
-
-    end
-
-    # required stdlib files sothat no warnings etc. are shown when re-requiring files
-    require 'set'
-    require 'fileutils'
-
-    def setup
-      @loader = PluginLoader.new( @wrapper = Module.new )
-
-      begin
-        self.class.plugin_files.each {|p| @loader.load_from_file( p ) }
-      rescue Exception => e
-        puts "Caught exception during loading of plugins in #setup: #{e.message} - #{e.backtrace.first}"
-      end
-
-      @manager = PluginManager.new( [@loader], @loader.plugin_classes )
-      if $VERBOSE
-        @manager.logger = Webgen::Logger.new
-        @manager.logger.level = ::Logger::DEBUG
-      end
-      @manager.plugin_config = self
-      @manager.init
-
-      if !@manager.plugins.has_key?( 'ContentConverter/Default' )
-        x = @manager.plugins['ContentConverter/Default'] = Object.new
-        def x.registered_handlers
-          formatters = Hash.new {|h, k| h[k] = proc {|c| c} }
-          def formatters.has_key?( value ); true; end
-          formatters
-        end
-      end
-
-      @plugin = @manager[self.class.plugin_to_test] if self.class.plugin_to_test
-    end
-
-    def teardown
-      @manager = nil
-      @loader = nil
-    end
-
-    def self.sample_site( filename = '' )
-      path_helper( :@base_fixture_path, File.join( 'sample_site', filename ) )
-    end
-
-    def sample_site( filename = '' )
-      self.class.sample_site( filename )
-    end
-
-    def param_for_plugin( plugin_name, param )
-      case [plugin_name, param]
-      when ['Core/Configuration', 'srcDir'] then sample_site( Webgen::SRC_DIR )
-      when ['Core/Configuration', 'outDir'] then sample_site( 'out' )
-      when ['Core/Configuration', 'websiteDir'] then sample_site
-      else PluginParamValueNotFound
-      end
-    end
-
-    def find_in_sample_site
-      files = Set.new
-      Find.find( sample_site( Webgen::SRC_DIR ) ) do |path|
-        Find.prune if File.basename( path ) =~ /^\./
-        path += '/' if FileTest.directory?(path)
-        files << path if yield( path )
-      end
-      files
-    end
-
-    def remove_consts( obj, constants )
-      constants.each do |c|
-        obj.remove_const( c )
-      end
-    end
-
-    def self.suite
-      if self == PluginTestCase
-        return Test::Unit::TestSuite.new('Webgen::TestCase')
-      else
-        super
-      end
-    end
-
-  end
-
-
-  # Base class for all plugin test cases. It ensures that all needed plugins are loaded and
-  # initalized before each test and that the original environment is restored afterwards.
-  class TagTestCase < PluginTestCase
-
-    def self.suite
-      if self == TagTestCase
-        return Test::Unit::TestSuite.new('Webgen::TestCase')
-      else
-        super
-      end
-    end
-
-    def set_config( config )
-      @plugin.set_tag_config( config, Dummy.new )
-    end
-
-  end
-
-  class Dummy
-
-    def method_missing( name, *args, &block )
-      Dummy.new
-    end
-
-  end
-
-end
-
-class Module
-  public :remove_const
-end