docter 1.0.0 → 1.0.1

data/CHANGELOG

@@ -1,2 +1,7 @@
+1.0.1 (6/6/2007)
+* 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 (6/3/2007)
 * First release of working code.

data/Rakefile

@@ -0,0 +1,117 @@
+require "rubygems"
+Gem::manage_gems
+require "rake/gempackagetask"
+require "spec/rake/spectask"
+require "rake/rdoctask"
+require "lib/docter"
+
+
+# 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       = "Assaf Arkin"
+  spec.email        = "arkin@intalio.com"
+  spec.homepage     = "http://#{spec.name}.rubyforge.org"
+  spec.summary      = "We has docs"
+  spec.files        = FileList["lib/**/*", "CHANGELOG", "README", "LICENSE", "Rakefile", "html/**/*"].collect
+  spec.require_path = "lib"
+  spec.autorequire  = "docter.rb"
+  spec.has_rdoc     = true
+  spec.extra_rdoc_files = ["README", "CHANGELOG", "LICENSE"]
+  spec.rdoc_options << "--title" << "Docter -- #{spec.summary}" <<
+                       "--main" << "README" << "--line-numbers" << "-inline-source"
+  spec.rubyforge_project = "buildr"
+
+  # Tested against these dependencies.
+  spec.add_dependency "facets",   "~> 1.8"
+  spec.add_dependency "RedCloth", "~> 3.0"
+  spec.add_dependency "haml",     "~> 1.5"
+  spec.add_dependency "mongrel",  "~> 1.0"
+end
+
+
+# Testing is everything.
+desc "Run test cases"
+Spec::Rake::SpecTask.new(:test) do |task|
+  task.spec_files = FileList["test/**/*.rb"]
+  task.spec_opts = [ "--format", "specdoc", "--color", "--diff" ]
+end
+
+desc "Run test cases with rcov"
+Spec::Rake::SpecTask.new(:rcov) do |task|
+  task.spec_files = FileList["test/**/*.rb"]
+  task.spec_opts = [ "--format", "specdoc", "--color", "--diff" ]
+  task.rcov = true
+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].map(&: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}"
+  end
+end
+
+namespace :upload do
+  task :packages=>["rake:package"] do |task|
+    # Read the changes for this release.
+    pattern = /(^(\d+\.\d+(?:\.\d+)?)\s+\(\d+\/\d+\/\d+\)\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 = ["gem", "tgz", "zip"].map { |ext| "pkg/#{spec.name}-#{spec.version}.#{ext}" }
+    system "rubyforge", "login"
+    files.each do |file|
+      system "rubyforge", "add_release", spec.rubyforge_project.downcase, spec.name.downcase,
+        spec.version.to_s, file, "-a", current
+    end
+    puts "Release #{spec.version} uploaded"
+  end
+end
+
+desc "Upload release to RubyForge including docs, tag SVN"
+task :release=>[ "clobber", "svn:clean?", "test", "upload:packages" ]

data/lib/docter/template.rb

@@ -20,7 +20,7 @@ module Docter
           if url =~ /^\w+:/
             unless index = @links.index(url)
               index = @links.size
-              @links << [inner_text_from(link), url]
+              @links << [url, inner_text_from(link)]
             end
             mark ? "#{link}<sup>[#{index + 1}]</sup>" : link
           else
@@ -29,9 +29,25 @@ module Docter
         end
       end
 
-      def footnote_links(cls = nil)
-        list = @links.map { |link| %{<dt>#{link.first}</dt><dd><a href="#{link.last}">#{link.last}</a></dd>} }
-        %{<dl class="#{cls}">#{list.join}</dl>}
+      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>} }
+        %{<dl class="#{cls}">#{links.join}</dl>}
+      end
+
+      def renumber_footnotes(html)
+        @footnote ||= 0
+        html.gsub(/<a href="#fn(\d+)">\1<\/a>/) {
+          # Renumber footnote references starting from the last footnote number.
+          fn = $1.to_i + @footnote
+           %{<a href="#fn#{fn}">#{fn}</a>}
+        }.gsub(/<p id="fn(\d+)"(.*?)><sup>\1<\/sup>(.*?)<\/p>/m) {
+          # Renumber footnotes the same way, and update the last footnote number.
+          @footnote += 1
+          %{<p id="fn#{@footnote}"#{$2}><sup>#{@footnote}</sup>#{$3}</p>}
+        }
       end
 
     end

data/lib/docter/ultraviolet.rb

@@ -1,3 +1,5 @@
+require "uv" # gem install ultraviolet
+
 module Docter
 
   SYNTAX_THEME = "eiffel"

data/lib/docter.rb

@@ -9,7 +9,7 @@ require "facets/core/kernel/tap"
 require "facet/kernel/__DIR__"
 
 module Docter
-  VERSION = "1.0.0".freeze
+  VERSION = "1.0.1".freeze
 end
 
 $LOAD_PATH.unshift __DIR__
@@ -30,4 +30,3 @@ require "docter/template.rb"
 require "docter/collection.rb"
 require "docter/server.rb" if defined?(Mongrel)
 require "docter/rake.rb" if defined?(Rake)
-require "docter/ultraviolet.rb" if defined?(Uv)

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.2
 specification_version: 1
 name: docter
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
-date: 2007-07-03 00:00:00 -07:00
+  version: 1.0.1
+date: 2007-07-06 00:00:00 -07:00
 summary: We has docs
 require_paths: 
 - lib
@@ -41,6 +41,7 @@ files:
 - CHANGELOG
 - README
 - LICENSE
+- Rakefile
 test_files: []
 
 rdoc_options: