docter 1.1.1 → 1.1.3

data/CHANGELOG

@@ -1,14 +1,35 @@
+1.1.3 (2008-04-15)
+* Changed: Now using Syntax by default for syntax highlighting, which works
+equally well on JRuby.
+* Changed: Fixed copying of resources with nested directories.
+* Removed: Dependency on Facets.
+
+1.1.2 (2007-01-25)
+* Changed: list_links now limits itself so HTTP URLs (no mailto:, FTP).
+* Changed: Upgraded to HAML 1.8.
+* Fixed:   list_links returns URLs in alphabetical order (of title)
+capitializing first letter of title.
+* Fixed:   list_links no longer returns URLs that have no title.
+* Fixed:   Generated IDs for headers conform to HTML spec (i.e. a-z, 0-9,
+hyphen, underscore, colon and period).
+* Fixed:   Empty ToC no longer included in HTML.
+
 1.1.1 (2007-01-03)
 * Fixed: Upgraded to Facets 2.2.1 to prevent conflict with Buildr.
 
 1.1.0 (2007-01-03)
 * Changed: Now using YAML for nested ToC.
-* Fixed: Sleek upload with changelog for each release courtesy of Anatol Pomozov.
+* Fixed: Sleek upload with changelog for each release courtesy of Anatol
+Pomozov.
 
 1.0.1 (2007-06-06)
-* Added: renumber_footnotes to template for handling footnote numbering when creating a single page. 
-* Changed: Ultraviolet no longer used as default syntax highlighting, must require separately.
-* Changed: footnote_links is now list_links and the new method eliminates duplicates (based on URL), sorts alphabetically (the text component) and capitalizes the text description.
+* Added: renumber_footnotes to template for handling footnote numbering when
+creating a single page.
+* Changed: Ultraviolet no longer used as default syntax highlighting, must
+require separately.
+* Changed: footnote_links is now list_links and the new method eliminates
+duplicates (based on URL), sorts alphabetically (the text component) and
+capitalizes the text description.
 
 1.0.0 (2007-06-03)
 * First release of working code.

data/DISCLAIMER

@@ -0,0 +1,7 @@
+Apache Buildr is an effort undergoing incubation at The Apache Software
+Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of
+all newly accepted projects until a further review indicates that the
+infrastructure, communications, and decision making process have stabilized in
+a manner consistent with other successful ASF projects. While incubation status
+is not necessarily a reflection of the completeness or stability of the code,
+it does indicate that the project has yet to be fully endorsed by the ASF.

data/NOTICE

@@ -0,0 +1,43 @@
+=========================================================================
+==  NOTICE file for use with the Apache License, Version 2.0,          ==
+==  in this case for the Apache Buildr distribution.                   ==
+=========================================================================
+
+Apache Docter (part of Apache Buildr)
+This product includes software developed at
+The Apache Software Foundation (http://www.apache.org/).
+
+COPYRIGHT NOTICES
+-----------------
+Copyright 2007 Intalio
+
+This product includes software developed by Intalio
+http://www.intalio.com
+
+
+THIRD-PARTY DEPENDENCIES
+------------------------
+Even though those dependencies aren't shipped with Docter, Docter needs 
+the third-party libraries listed below to run. According licenses are 
+bundled under the etc/legal directory (when available).
+
+* HAML - http://haml.hamptoncatlin.com/
+Licensed under MIT
+Copyright (c) 2006-2007 Hampton Catlin
+
+* highline - http://rubyforge.org/projects/highline
+Licensed under the Ruby License
+Copyright 2005 Gray Productions
+Copyright 2007 Jeremy Hinegardner
+
+* Rake - http://rubyforge.org/projects/rake 
+Licensed under MIT/X Consortium
+Copyright 2003, 2004 by Jim Weirich
+
+* RedCloth - http://whytheluckystiff.net/ruby/redcloth/ 
+Licensed under BSD
+Copyright 2004 why the lucky stiff (and his puppet organizations.)
+
+* Syntax -- http://syntax.rubyforge.org/
+Licensed under BSD
+Copyright 2005 Jamis Buck

data/Rakefile

@@ -1,102 +1,54 @@
-require 'rubygems'
-Gem::manage_gems
-require 'rake/gempackagetask'
-require 'rake/rdoctask'
-require 'rubyforge'
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with this
+# work for additional information regarding copyright ownership.  The ASF
+# licenses this file to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
+# License for the specific language governing permissions and limitations under
+# the License.
 
 
 # Gem specification comes first, other tasks rely on it.
-spec = Gem::Specification.new do |spec|
-  spec.name         = 'docter'
-  spec.version      = File.read(__FILE__.pathmap('%d/lib/docter.rb')).scan(/VERSION\s*=\s*(['"])(.*)\1/)[0][1]
-  spec.author       = 'Apache Buildr'
-  spec.email        = 'buildr-user@incubator.apache.org'
-  spec.homepage     = 'http://incubator.apache.org/buildr/'
-  spec.summary      = 'We has docs'
-  spec.files        = FileList['lib/**/*', 'CHANGELOG', 'README', 'LICENSE', 'Rakefile', 'html/**/*'].collect
-  spec.require_path = 'lib'
-  spec.has_rdoc     = true
-  spec.extra_rdoc_files = ['README', 'CHANGELOG', 'LICENSE']
-  spec.rdoc_options << '--title' << "Docter -- #{spec.summary}" <<
-                       '--main' << 'README' << '--line-numbers' << '--inline-source' << '-p' <<
-                       '--webcvs' << 'http://svn.apache.org/repos/asf/incubator/buildr/docter/trunk/'
-  spec.rubyforge_project = 'buildr'
-
-  # Tested against these dependencies.
-  spec.add_dependency 'facets',   '~> 2.2'
-  spec.add_dependency 'RedCloth', '~> 3.0'
-  spec.add_dependency 'haml',     '~> 1.7'
-  spec.add_dependency 'mongrel',  '~> 1.1'
-end
-
-
-# Packaging and local installation.
-Rake::GemPackageTask.new(spec) do |pkg|
-  pkg.need_tar = true
-  pkg.need_zip = true
-end
-
-desc 'Install the package locally'
-task :install=>:package do |task|
-  system 'gem', 'install', "pkg/#{spec.name}-#{spec.version}.gem"
-end
-
-desc 'Uninstall previously installed packaged'
-task :uninstall do |task|
-  system 'gem', 'uninstall', spec.name, '-v', spec.version.to_s
-end
-
-
-desc 'Generate RDoc documentation'
-rdoc = Rake::RDocTask.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = spec.name
-  rdoc.options  = spec.rdoc_options
-  rdoc.rdoc_files.include('lib/**/*.rb')
-  rdoc.rdoc_files.include spec.extra_rdoc_files
-end
-
-task('clobber') { rm_rf [rdoc.rdoc_dir.to_s] }
-
-
-# Commit to SVN, upload and do the release cycle.
-namespace :svn do
-  task :clean? do |task|
-    status = `svn status`.reject { |line| line =~ /\s(pkg|html)$/ }
-    fail "Cannot release unless all local changes are in SVN:\n#{status}" unless status.empty?
-  end
-  
-  task :tag do |task|
-    cur_url = `svn info`.scan(/URL: (.*)/)[0][0]
-    new_url = cur_url.sub(/trunk$/, "tags/#{spec.version.to_s}")
-    system 'svn', 'remove', new_url, '-m', 'Removing old copy' rescue nil
-    system 'svn', 'copy', cur_url, new_url, '-m', "Release #{spec.version.to_s}"
+def spec
+  Gem::Specification.new do |spec|
+    spec.name         = 'docter'
+    spec.version      = File.read(__FILE__.pathmap('%d/lib/docter.rb')).scan(/VERSION\s*=\s*(['"])(.*)\1/)[0][1]
+    spec.author       = 'Apache Buildr'
+    spec.email        = 'buildr-user@incubator.apache.org'
+    spec.homepage     = 'http://incubator.apache.org/buildr/'
+    spec.summary      = 'We has docs'
+    spec.files        = FileList['lib/**/*', 'README', 'CHANGELOG', 'LICENSE', 'NOTICE', 'DISCLAIMER',
+                                 'Rakefile'].collect
+    spec.require_path = 'lib'
+    spec.has_rdoc     = true
+    spec.extra_rdoc_files = ['README', 'CHANGELOG', 'LICENSE', 'NOTICE', 'DISCLAIMER']
+    spec.rdoc_options << '--title' << "Docter -- #{spec.summary}" <<
+                         '--main' << 'README' << '--line-numbers' << '--inline-source' << '-p' <<
+                         '--webcvs' << 'http://svn.apache.org/repos/asf/incubator/buildr/docter/trunk/'
+    spec.rubyforge_project = 'buildr'
+
+    # Tested against these dependencies.
+    spec.add_dependency 'RedCloth',    '~> 3.0'
+    spec.add_dependency 'haml',        '~> 1.8'
+    spec.add_dependency 'mongrel',     '~> 1.1'
+    spec.add_dependency 'syntax',      '~> 1.0'
+    spec.add_dependency 'rake',        '~> 0.8'
   end
 end
 
-namespace :upload do
-  task :packages=>['rake:package'] do |task|
-    # Read the changes for this release.
-    pattern = /(^(\d+\.\d+(?:\.\d+)?)\s+\(\d{4}-\d{2}-\d{2}\)\s*((:?^[^\n]+\n)*))/
-    changelog = File.read(__FILE__.pathmap('%d/CHANGELOG'))
-    changes = changelog.scan(pattern).inject({}) { |hash, set| hash[set[1]] = set[2] ; hash }
-    current = changes[spec.version.to_s]
-    if !current && spec.version.to_s =~ /\.0$/
-      current = changes[spec.version.to_s.split('.')[0..-2].join('.')] 
-    end
-    fail "No changeset found for version #{spec.version}" unless current
 
-    puts "Uploading #{spec.name} #{spec.version}"
-    files = %w( gem tgz zip ).map { |ext| "pkg/#{spec.name}-#{spec.version}.#{ext}" }
-    rubyforge = RubyForge.new
-    rubyforge.login    
-    File.open('.changes', 'w'){|f| f.write(current)}
-    rubyforge.userconfig.merge!('release_changes' => '.changes',  'preformatted' => true)
-    rubyforge.add_release spec.rubyforge_project.downcase, spec.name.downcase, spec.version, *files
-    rm '.changes'
-    puts "Release #{spec.version} uploaded"
+namespace 'release' do
+ 
+  # License requirement.
+  task 'check'=>'apache:license'
+  task 'make' do
+    task('release:rubyforge').invoke
   end
-end
 
-desc 'Upload release to RubyForge including docs, tag SVN'
-task :release=>[ 'clobber', 'svn:clean?', 'upload:packages' ]
+end

data/lib/docter.rb

@@ -1,28 +1,43 @@
-# &:symbol goodness.
-require 'facets/symbol/to_proc'
-require 'facets/string/blank'
-require 'facets/kernel/tap'
-require 'facets/kernel/__DIR__'
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with this
+# work for additional information regarding copyright ownership.  The ASF
+# licenses this file to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
+# License for the specific language governing permissions and limitations under
+# the License.
+
 
 module Docter
-  VERSION = '1.1.1'.freeze
+  VERSION = '1.1.3'.freeze
 end
 
-$LOAD_PATH.unshift __DIR__
 
-require 'cgi'
-require 'erb'
-# All these Gems are optional.
-['redcloth', 'haml', 'mongrel', 'uv'].each do |gem|
-  begin
-    require gem
-  rescue LoadError
-  end
+# Ruby 1.9 conveniences.
+module Kernel #:nodoc:
+  def tap
+    yield self if block_given?
+    self
+  end unless method_defined?('tap')
+end
+
+class Symbol #:nodoc:
+  def to_proc
+    Proc.new{|*args| args.shift.__send__(self, *args)}
+  end unless method_defined?('to_proc')
 end
 
+
 require 'docter/common.rb'
 require 'docter/page.rb'
 require 'docter/template.rb'
 require 'docter/collection.rb'
-require 'docter/server.rb' if defined?(Mongrel)
-require 'docter/rake.rb' if defined?(Rake)
+require 'docter/server.rb'
+require 'docter/rake.rb'
+require 'docter/ultraviolet.rb' if defined?(Uv)

data/lib/docter/collection.rb

@@ -1,3 +1,22 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with this
+# work for additional information regarding copyright ownership.  The ASF
+# licenses this file to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
+# License for the specific language governing permissions and limitations under
+# the License.
+
+
+require 'redcloth'
+
+
 module Docter
 
   class Collection
@@ -30,21 +49,14 @@ module Docter
         @toc = ToC.from_yaml(yaml, @collection)
       end
 
-      if defined?(::RedCloth)
-        def create_from_textile(text, options)
-          html = RedCloth.new(erb_this(text, binding), [:no_span_caps]).to_html(:textile)
-          create_from_html html, options
-        end
+      def create_from_textile(text, options)
+        html = RedCloth.new(erb_this(text, binding), [:no_span_caps]).to_html(:textile)
+        create_from_html html, options
+      end
 
-        def create_from_markup(text, options)
-          html = RedCloth.new(erb_this(text, binding), [:no_span_caps]).to_html(:markup)
-          create_from_html html, options
-        end
-      else
-        def create_from_textile(text, options)
-          fail "You need to install RedCloth first:\n  gem install RedCloth"
-        end
-        alias :create_from_markup :create_from_textile
+      def create_from_markup(text, options)
+        html = RedCloth.new(erb_this(text, binding), [:no_span_caps]).to_html(:markup)
+        create_from_html html, options
       end
 
       def create_from_html(html, options)

data/lib/docter/common.rb

@@ -1,3 +1,22 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with this
+# work for additional information regarding copyright ownership.  The ASF
+# licenses this file to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
+# License for the specific language governing permissions and limitations under
+# the License.
+
+
+require 'erb'
+
+
 module Docter
 
   module HTML
@@ -10,15 +29,15 @@ module Docter
     # Returns the inner text from some HTML text, effectively stripping the tags, normalizing whitespaces
     # and stripping leading/trailing spaces.
     def inner_text_from(html)
-      html.gsub(/<(\w*).*?>(.*?)<\/\1\s*>/m, "\\2").strip.gsub(/\s+/m, ' ')
+      html.gsub(/<(\w*).*?>(.*?)<\/\1\s*>/m, '\2').strip.gsub(/\s+/m, ' ')
     end
 
     def regexp_element(name)
-      Regexp.new("<(#{name})(?:>|\s+(.*?)>)(.*?)<\\/\\1\\s*>", Regexp::MULTILINE + Regexp::IGNORECASE)
+      /<(#{name})(?:>|\s+(.*?)>)(.*?)<\/\1\s*>/mi
     end
 
     def regexp_attribute(name)
-      Regexp.new("(#{name})=([\"'])(.*?)\\2", Regexp::MULTILINE + Regexp::IGNORECASE)
+      /(#{name})=([\"'])(.*?)\2/mi
     end
 
   end
@@ -271,7 +290,7 @@ module Docter
       options = Hash === args.last ? args.pop.clone : {}
       args.each { |arg| options[arg.to_sym] = true }
       cls = %{ class="#{options[:class]}"} if options[:class]
-      %{<ol #{cls}>#{map { |entry| entry.to_html(options) }}</ol>}
+      %{<ol #{cls}>#{map { |entry| entry.to_html(options) }}</ol>} unless empty?
     end
 
   protected
@@ -335,7 +354,7 @@ module Docter
         end
       end
       if url
-        %{<li><a href="#{url}">#{title}</a>#{nested}</li>}
+        %{<li><a href='#{url}'>#{title}</a>#{nested}</li>}
       else
         %{<li>#{title}#{nested}</li>}
       end

data/lib/docter/page.rb

@@ -1,3 +1,24 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with this
+# work for additional information regarding copyright ownership.  The ASF
+# licenses this file to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
+# License for the specific language governing permissions and limitations under
+# the License.
+
+
+require 'cgi'
+require 'redcloth'
+require 'syntax/convertors/html'
+
+
 module Docter
 
   # A single documentation page. Has title, content and ToC.
@@ -155,26 +176,20 @@ module Docter
 
   private
 
-    if defined?(::RedCloth)
-      # :call-seq:
-      #   use_redcloth(format, text, options)
-      #
-      # Format may be :textile or :markdown. Runs erb_this on the text first to apply ERB code,
-      # processes code sections ({{{ ... }}}), and converts the Textile/Markdown text to HTML.
-      def use_redcloth(format, text, options)
-        text = erb_this(text)
-        # Process {{{ ... }}} code sections into pre tags.
-        text = text.gsub(/^\{\{\{([^\n]*)\n(.*?)\n\}\}\}/m) do
-          code, spec = $2, $1.scan(/^!(.*?)$/).to_s.strip
-          %{<notextile><pre class='#{spec.split(',').join(' ')}'>#{CGI.escapeHTML(code)}</pre></notextile>}
-        end
-        # Create the HTML.
-        RedCloth.new(text, [:no_span_caps]).to_html(format)
-      end
-    else
-      def use_redcloth(format, text, options)
-        fail "You need to install RedCloth first:\n  gem install RedCloth"
+    # :call-seq:
+    #   use_redcloth(format, text, options)
+    #
+    # Format may be :textile or :markdown. Runs erb_this on the text first to apply ERB code,
+    # processes code sections ({{{ ... }}}), and converts the Textile/Markdown text to HTML.
+    def use_redcloth(format, text, options)
+      text = erb_this(text)
+      # Process {{{ ... }}} code sections into pre tags.
+      text = text.gsub(/^\{\{\{([^\n]*)\n(.*?)\n\}\}\}/m) do
+        code, spec = $2, $1.scan(/^!(.*?)$/).to_s.strip
+        %{<notextile><pre class='#{spec.split(',').join(' ')}'>#{CGI.escapeHTML(code)}</pre></notextile>}
       end
+      # Create the HTML.
+      RedCloth.new(text, [:no_span_caps]).to_html(format)
     end
 
     # :call-seq:
@@ -202,8 +217,8 @@ module Docter
         tag, attributes, text = $1.downcase, $2.to_s, inner_text_from($3)
         # Make sure all H2/H3 headers have a usable ID, create once if necessary.
         id = CGI.unescape($3) if attributes[regexp_attribute('id')]
-        if id.to_s.blank?
-          id = CGI.unescapeHTML(text.downcase.gsub(' ', '_'))
+        if id.to_s.strip.empty?
+          id = CGI.unescapeHTML(text.downcase).gsub(/\s+/, '_').gsub(/[^A-Za-z0-9\-_:.]/, '')
           header = %{<#{tag} #{attributes} id='#{id}'>#{text}</#{tag}>}
         end
         if tag == 'h2'
@@ -285,4 +300,19 @@ module Docter
 
   end
 
+
+  # Syntax highlighting filter.
+  filter_for :syntax do |html|
+    html.gsub(HTML.regexp_element('pre')) do |pre|
+      attributes, code = $2, $3
+      if attributes[HTML.regexp_attribute('class')]
+        classes = $3.split(/\s+/)
+        lang = classes.first
+      end
+      unescaped = CGI.unescapeHTML(code)
+      highlight = Syntax::Convertors::HTML.for_syntax(lang).convert(unescaped, false)
+      %{<pre class="#{lang}">#{highlight}</pre>}
+    end
+  end
+
 end

data/lib/docter/rake.rb

@@ -1,3 +1,19 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with this
+# work for additional information regarding copyright ownership.  The ASF
+# licenses this file to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
+# License for the specific language governing permissions and limitations under
+# the License.
+
+
 module Docter
   module Rake
 

data/lib/docter/server.rb

@@ -1,3 +1,23 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with this
+# work for additional information regarding copyright ownership.  The ASF
+# licenses this file to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
+# License for the specific language governing permissions and limitations under
+# the License.
+
+
+require 'mongrel'
+require 'cgi'
+
+
 module Docter
 
   class MongrelHandler < Mongrel::HttpHandler
@@ -52,7 +72,7 @@ module Docter
       rescue Exception=>error
         response.start(500) do |head, out|
           head['Content-Type'] = 'text/plain'
-          error = ["#{error.class}: #{error}", error.backtrace.join('\n')]
+          error = ["#{error.class}: #{error}", error.backtrace.join("\n")]
           out.puts *error
           puts *error
         end

data/lib/docter/template.rb

@@ -1,3 +1,23 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with this
+# work for additional information regarding copyright ownership.  The ASF
+# licenses this file to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
+# License for the specific language governing permissions and limitations under
+# the License.
+
+
+require 'haml'
+require 'erb'
+
+
 module Docter
 
   # A template for formatting pages. The template is parsed once and processed using each Page to
@@ -17,10 +37,11 @@ module Docter
         @links ||= []
         content.gsub(regexp_element('a')) do |link|
           url = $3 if link =~ regexp_attribute('href')
-          if url =~ /^\w+:/
+          text = inner_text_from(link)
+          if url =~ /^\w+:/ && url != text
             unless index = @links.index(url)
               index = @links.size
-              @links << [url, inner_text_from(link)]
+              @links << [url, text]
             end
             mark ? "#{link}<sup>[#{index + 1}]</sup>" : link
           else
@@ -31,9 +52,10 @@ module Docter
 
       def list_links(cls = nil)
         # Remove duplicate links (same URL), sort by text and convert into DT/DD pairs.
-        links = @links.inject({}) { |hash, link| hash[link.first] ||= link.last ; hash }.
-          sort { |a,b| a.last <=> b.last }.
-          map { |url, text| %{<dt>#{text.capitalize}</dt><dd><a href='#{url}'>#{url}</a></dd>} }
+        links = @links.select { |url, text| url =~ /^http(s?):/ }.
+          inject({}) { |hash, link| hash[link.first] ||= link.last ; hash }.
+          sort { |a,b| a.last.downcase <=> b.last.downcase }.
+          map { |url, text| %{<dt>#{text.gsub(/^\w/) { |a| a.upcase }}</dt><dd><a href='#{url}'>#{url}</a></dd>} }
         %{<dl class='#{cls}'>#{links.join}</dl>}
       end
 
@@ -118,13 +140,13 @@ module Docter
     #   map.find('images/logo.png') => 'images/logo.png'
     #   map.find('fancy.css') => 'css/fancy.css'
     def find(path)
-      @sources.inject(nil) do |found, file|
+      @sources.inject(nil) do |found, source|
         break found if found
-        if File.directory?(file)
-          base = File.dirname(file) + '/'
-          FileList["#{file}/**/*"].find { |file| file.sub(base, '') == path }
+        if File.directory?(source)
+          base = File.join(File.dirname(source), '')
+          Dir.glob(File.join(source, "/**/*")).find { |file| file.sub(base, '') == path }
         else
-          file if File.basename(file) == path
+          source if File.basename(source) == path
         end 
       end
     end
@@ -135,17 +157,17 @@ module Docter
     # Copy resource files to the destination directory.
     def copy_resources(to_dir)
       mkpath to_dir
-      @sources.each do |file|
-        if File.directory?(file)
-          base = File.dirname(file) + '/'
-          FileList[File.join(file, '**/*')].each do |file|
-            target = File.join(to_dir, file.sub(base, ''))
-            mkpath File.dirname(target)
-            cp file, target
+      @sources.each do |src|
+        if File.directory?(src)
+          target = File.join(to_dir, File.basename(src))
+          mkpath target
+          FileList["#{src}/**/*"].reject { |path| File.directory?(path) }.each do |path|
+            mkpath File.dirname(path).gsub(/^#{src}/, target)
+            cp path, path.gsub(/^#{src}/, target)
           end
         else
-          cp file, to_dir
-        end 
+          cp src, to_dir
+        end
       end
       touch to_dir # For Rake dependency management.
     end
@@ -161,16 +183,10 @@ module Docter
 
   protected
 
-    if defined?(::Haml)
-      def create_from_haml(content, options)
-        @options = options
-        template = Haml::Engine.new(content, :filename=>@filename)
-        @process = lambda { |context| template.render(context) }
-      end
-    else
-      def create_from_haml(content, options)
-        fail "You need to install HAML first:\n  gem install haml"
-      end
+    def create_from_haml(content, options)
+      @options = options
+      template = Haml::Engine.new(content, :filename=>@filename)
+      @process = lambda { |context| template.render(context) }
     end
 
     def create_from_erb(content, options)

data/lib/docter/ultraviolet.rb

@@ -1,3 +1,19 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with this
+# work for additional information regarding copyright ownership.  The ASF
+# licenses this file to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
+# License for the specific language governing permissions and limitations under
+# the License.
+
+
 require 'uv' # gem install ultraviolet
 
 module Docter

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: docter
 version: !ruby/object:Gem::Version 
-  version: 1.1.1
+  version: 1.1.3
 platform: ruby
 authors: 
 - Apache Buildr
@@ -9,44 +9,53 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-01-03 00:00:00 -08:00
+date: 2008-04-15 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: facets
+  name: RedCloth
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: "2.2"
+        version: "3.0"
     version: 
 - !ruby/object:Gem::Dependency 
-  name: RedCloth
+  name: haml
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: "3.0"
+        version: "1.8"
     version: 
 - !ruby/object:Gem::Dependency 
-  name: haml
+  name: mongrel
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: "1.7"
+        version: "1.1"
     version: 
 - !ruby/object:Gem::Dependency 
-  name: mongrel
+  name: syntax
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: "1.1"
+        version: "1.0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rake
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "0.8"
     version: 
 description: 
 email: buildr-user@incubator.apache.org
@@ -58,19 +67,23 @@ extra_rdoc_files:
 - README
 - CHANGELOG
 - LICENSE
+- NOTICE
+- DISCLAIMER
 files: 
 - lib/docter
-- lib/docter/server.rb
-- lib/docter/template.rb
 - lib/docter/collection.rb
+- lib/docter/common.rb
+- lib/docter/page.rb
 - lib/docter/rake.rb
+- lib/docter/server.rb
+- lib/docter/template.rb
 - lib/docter/ultraviolet.rb
-- lib/docter/page.rb
-- lib/docter/common.rb
 - lib/docter.rb
-- CHANGELOG
 - README
+- CHANGELOG
 - LICENSE
+- NOTICE
+- DISCLAIMER
 - Rakefile
 has_rdoc: true
 homepage: http://incubator.apache.org/buildr/
@@ -102,7 +115,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: buildr
-rubygems_version: 1.0.1
+rubygems_version: 1.1.1
 signing_key: 
 specification_version: 2
 summary: We has docs