trac-export-wiki 1.0.0

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2010 Loren Segal
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,36 @@
+# Trac Wiki Exporter
+
+## Synopsis
+
+Exports wiki pages in Trac as HTML pages organized in categories for easy
+local viewing.
+
+## Installing
+
+    $ [sudo] gem install trac-export-wiki
+    
+## Using
+
+To use this script, you need to create a `config.yaml` file that tells the
+exporter which pages you want to export under which categories. You can
+see a sample config.yaml file in the "examples" directory. Once you've
+created your configuration file, you can call the script with:
+
+    $ trac-export-wiki config.yaml
+    
+This will download the wiki pages from your site into your current directory.
+If you want to put your files in a `docs` directory, make sure to cd there
+first:
+
+    $ mkdir docs
+    $ cd docs
+    $ trac-export-wiki ../config.yaml
+    
+You can specify some parameters on the command-line, see `trac-export-wiki --help`
+for a list of options. Specifically, you may want to only regenerate the index
+page, or not generate the index page. This is done with `-i` or `-n` respectively.
+
+## License & Author
+
+This library is written by Loren Segal and released under the MIT license.
+See the `LICENSE` file attached with this archive.

data/Rakefile

@@ -0,0 +1,33 @@
+require 'rbconfig'
+
+WINDOWS = (Config::CONFIG['host_os'] =~ /mingw|win32|cygwin/ ? true : false) rescue false
+SUDO = WINDOWS ? '' : 'sudo'
+
+task :default => :specs
+
+desc "Builds the gem"
+task :gem do
+  load 'trac-export-wiki.gemspec'
+  Gem::Builder.new(SPEC).build
+end
+
+desc "Installs the gem"
+task :install => :gem do 
+  sh "#{SUDO} gem install trac-export-wiki-1.0.0.gem --no-rdoc --no-ri"
+end
+
+begin
+  require 'spec'
+  require 'spec/rake/spectask'
+
+  desc "Run all specs"
+  Spec::Rake::SpecTask.new("specs") do |t|
+    $DEBUG = true if ENV['DEBUG']
+    t.spec_opts = ["--format", "specdoc", "--colour"]
+    t.spec_opts += ["--require", File.join(File.dirname(__FILE__), 'spec', 'spec_helper')]
+    t.spec_files = Dir["spec/**/*_spec.rb"].sort
+  end
+  task :spec => :specs
+rescue LoadError
+  warn "warn: RSpec tests not available. `gem install rspec` to enable them."
+end

data/bin/trac-export-wiki

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require File.expand_path(File.dirname(__FILE__)) + "/../lib/trac-export-wiki"
+TracWiki::CLI.new.run(*ARGV)

data/examples/config.yaml

@@ -0,0 +1,42 @@
+#username: username_here
+#password: password_here
+base_url: http://example.com/trac/soen490
+pages:
+  mgmt:
+    - BiWeeklyStatusReport
+    - Proposal
+    - ActivityPlan
+    - RiskManagement
+    - ProcessDocumentation
+    - ImpactAnalysis
+  research:
+    - CachingStrategies
+    - CachingEvaluation
+    - LoadBalancing
+    - PlanForDistributedReq
+    - ProversBenchmark
+    - ProfilingResults
+  reqs:
+    - VisionDocument
+    - SupplementarySpecification
+    - InstallationAndCommissioning
+    - Glossary
+  design:
+    - Jml4-LogicalView
+    - FirstPrototype
+    - Jml4Disco-LogicalView
+    - Jml4Disco-PhysicalView
+    - Jml4Disco-UseCaseView
+    - DevelopmentView
+  test:
+    - TestPlan
+    - BoogieTraceability
+    - PerformanceReport
+categories:
+  mgmt: 'Management, Planning & Risk Analysis Docs'
+  research: 'Research & Potential Strategies Docs'
+  reqs: 'Requirements Docs'
+  design: 'Design & Architecture'
+  test: 'Testing & Implementation'
+wiki_title: JML4 Disco Documentation
+wiki_title_prefix: Disco

data/examples/config.yaml.sample

@@ -0,0 +1,58 @@
+# The base URL to the trac page (excluding /wiki)
+base_url: http://example.com/trac/myproject
+
+# Optional authentication information, uncomment below.
+# You can also specify this information via the command-line (-u/-p).
+#username: username_here
+#password: password_here
+
+# The list of pages within separated categories
+# The category should be listed first, followed by a list of pages
+pages:
+  # Make sure to include the category short-name first
+  mgmt:
+    - BiWeeklyStatusReport
+    - Proposal
+    - ActivityPlan
+    - RiskManagement
+    - ProcessDocumentation
+    - ImpactAnalysis
+  research:
+    - CachingStrategies
+    - CachingEvaluation
+    - LoadBalancing
+    - PlanForDistributedReq
+    - ProversBenchmark
+    - ProfilingResults
+  reqs:
+    - VisionDocument
+    - SupplementarySpecification
+    - InstallationAndCommissioning
+    - Glossary
+  design:
+    - Jml4-LogicalView
+    - FirstPrototype
+    - Jml4Disco-LogicalView
+    - Jml4Disco-PhysicalView
+    - Jml4Disco-UseCaseView
+    - DevelopmentView
+  test:
+    - TestPlan
+    - BoogieTraceability
+    - PerformanceReport
+    
+# The full titles and order of the category short-names. These titles will be 
+# listed in the order they are given on the index.html page.
+categories:
+  mgmt: 'Management, Planning & Risk Analysis Docs'
+  research: 'Research & Potential Strategies Docs'
+  reqs: 'Requirements Docs'
+  design: 'Design & Architecture'
+  test: 'Testing & Implementation'
+  
+# The wiki title listed on the index.html page
+wiki_title: JML4 Disco Documentation
+
+# The wiki short title used in the <title> of individual wiki pages
+# in the form: "SHORT_TITLE - WIKI_PAGE_TITLE"
+wiki_title_prefix: Disco

data/lib/trac-export-wiki.rb

@@ -0,0 +1,234 @@
+#!/usr/bin/ruby
+require 'net/https'
+require 'open-uri'
+require 'hpricot'
+require 'fileutils'
+require 'optparse'
+
+module TracWiki
+  class HashStruct < Hash
+    def self.[](*hash)
+      case hash.first
+      when Hash
+        super(*hash.first.map {|k, v| [k.to_sym, v] }.flatten(1))
+      else
+        i = 0
+        super(*hash.map {|e| e = i % 2 == 0 ? e.to_sym : e; i += 1; e })
+      end
+    end
+    
+    def []=(key, value)
+      super(key.to_sym, value)
+    end
+    
+    def method_missing(sym, *args, &block)
+      if has_key?(sym.to_sym)
+        self[sym.to_sym]
+      else
+        super
+      end
+    end
+  end
+  
+  DefaultConfiguration = HashStruct[
+    :username => nil,
+    :password => nil,
+    :base_url => nil,
+    :destination_path => '.',
+    :pages => {},
+    :categories => [],
+    :wiki_title => "Trac Wiki Pages",
+    :wiki_title_prefix => "Wiki",
+    :no_index => false,
+    :only_index => false,
+  ].freeze
+  
+  class CLI
+    attr_accessor :config
+    
+    def initialize
+      self.config = DefaultConfiguration.dup
+    end
+    
+    def run(*args)
+      args = args.dup
+      opts = OptionParser.new
+      opts.banner = "Usage: trac-export-wiki [options] config.yaml"
+      opts.on('-u', '--username USERNAME') {|username| config[:username] = username }
+      opts.on('-p', '--password PASSWORD') {|password| config[:password] = password }
+      opts.on('-b', '--base-url URL') {|url| config[:base_url] = url }
+      opts.on('-t', '--wiki-title TITLE') {|title| config[:wiki_title] = title }
+      opts.on('-T', '--wiki-title-prefix TITLE') {|title| config[:wiki_title_prefix] = title }
+      opts.on('-i', '--only-index') { config[:only_index] = true }
+      opts.on('-n', '--no-index') { config[:no_index] = true }
+      opts.parse!(args)
+      parse_from_yaml(args.first) if args.size > 0
+      Exporter.new(config).export
+    end
+
+    private
+    
+    def parse_from_yaml(file)
+      require 'yaml'
+      config.update HashStruct[YAML.load_file(file)]
+    end
+  end
+  
+  class Exporter
+    # common HTML elements to remove (expressed with css selectors)
+    ELEMENTS_TO_REMOVE = ["html > head > link",
+                          "html > head > style",
+                          "html > head > script",
+                          "html > body > script",
+                          "div#banner",
+                          "div#header",
+                          "div#search",
+                          "div#ctxtnav",
+                          "div#metanav",
+                          "div#mainnav",
+                          "div.buttons",
+                          "div#altlinks",
+                          "div#footer",
+                          "h3#tkt-changes-hdr",
+                          "ul.tkt-chg-list"]
+                          
+    attr_accessor :config
+    
+    def initialize(config = DefaultConfiguration)
+      self.config = config
+    end
+    
+    def export
+      write_pages unless config.only_index
+      generate_index unless config.no_index
+    end
+    
+    private
+
+    def write_pages
+      config.pages.each do |category, page_names|
+        page_names.each do |page|
+          print "Exporting \"" + page + "\"... "
+          Page.new(page, category).export(config)
+          puts "done."
+        end
+      end
+    end
+
+    def generate_index
+      print "Exporting index..."
+      index = <<-eof
+        <html>
+          <head>
+            <title>#{config.wiki_title}</title>
+          </head>
+          <body>
+            <h1>#{config.wiki_title}</h1>
+      eof
+      config.categories.each do |line|
+        cat, name = *line
+        index += "<h2>#{name}</h2>\n"
+        index += "<ul>\n"
+        config.pages.select {|k,v| k == cat }.each do |cat, docs|
+          docs.each do |doc|
+            fname = Page.new(doc, cat).filename
+            index += "<li><a href='#{fname}'>#{doc}</a>\n"
+          end
+        end
+        index += "</ul>\n"
+      end
+      index += <<-eof
+          </body>
+        </html>
+      eof
+      File.open('index.html', "w") { |f| f.write(index) }
+
+      puts "done."
+    end
+  end
+  
+  class Page
+    attr_accessor :page_title, :category, :filename, :config
+    
+    def initialize(page_title, category = nil)
+      self.page_title = page_title
+      self.category = category
+      self.filename = File.join(*[category, page_title.gsub(/([a-z])([A-Z])/,'\1-\2').split(/\?/).first.downcase + '.html'].compact)
+    end
+    
+    def export(config)
+      self.config = config
+      
+      # load the wiki page
+  	  doc = Hpricot(read_asset(page_title))
+
+      # search for each element and remove it from the doc
+      Exporter::ELEMENTS_TO_REMOVE.each { |e| doc.search(e).remove }
+
+      # set title
+      doc.search("html > head").at("title").inner_html = "#{config.wiki_title_prefix} - " + page_title.gsub(/([a-z])([A-Z])/,'\1 \2')
+
+      # add link to css
+      updir = "../" * category.split(/\//).size
+      css = %Q(<link rel="stylesheet" type="text/css" href="#{updir}style.css" />)
+      charset = %Q(<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />)
+      doc.search("html > head").append(css + charset)
+
+      # give toc's parent ol a class
+      ol = doc.search("html > body > div.wiki-toc > ol").first
+      ol.raw_attributes = ol.attributes.to_hash.merge('class' => 'top-most') unless ol.nil?
+
+      # change the toc's li's class names
+      doc.search("html > body > div.wiki-toc > ol").search("li.active").set(:class => 'toc') rescue nil
+
+      # create category directory if it does not exist
+      FileUtils.mkdir_p(File.dirname(filename)) rescue nil
+
+      # find all images
+      doc.search("//img").each do |img|
+          imgfile = img.attributes['src']
+          short_imgfile = File.basename(imgfile).split(/\?/).first
+
+          # change image attribute in source
+          img.raw_attributes = img.attributes.to_hash.merge("src" => File.join('images', short_imgfile))
+
+          # make image directory
+          outdir = File.join(File.dirname(filename), 'images')
+          FileUtils.mkdir_p(outdir)
+
+          # write image to file
+          begin
+            uri = URI.parse(config.base_url)
+            contents = read_asset(imgfile, "#{uri.scheme}://#{uri.host}")
+            File.open(File.join(outdir, short_imgfile), "wb") do |f|
+                f.write(contents)
+            end
+          rescue OpenURI::HTTPError
+          end
+      end
+
+      # write HTML to file
+      File.open(filename, "w") { |f| f.write(doc.to_html) }
+      print "wrote #{filename}... "
+    rescue StandardError => bang
+      print "(Oops! " + bang.message + ") "
+    end
+    
+    private
+    
+    def read_asset(asset, base = nil)
+      base ||= File.join(config.base_url, "wiki")
+      open(File.join(base, asset), open_options).read
+    end
+
+    def open_options
+      @open_options ||= config.username ? 
+        {:http_basic_authentication => [config.username, config.password]} : {}
+    end
+  end
+end 
+
+class Net::HTTP
+    alias :old_verify_mode :verify_mode=
+    def verify_mode=(x) old_verify_mode(OpenSSL::SSL::VERIFY_NONE) end
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification 
+name: trac-export-wiki
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Loren Segal
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-11 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hpricot
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: Exports Trac wiki pages as local HTML files
+email: lsegal@soen.ca
+executables: 
+- trac-export-wiki
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- bin/trac-export-wiki
+- lib/trac-export-wiki.rb
+- examples/config.yaml
+- examples/config.yaml.sample
+- LICENSE
+- README.md
+- Rakefile
+has_rdoc: yard
+homepage: http://github.com/lsegal/trac-export-wiki
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: trac-export-wiki
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Exports Trac wiki pages as local HTML files.
+test_files: []
+