double_doc 1.0.6 → 1.0.7

data/lib/double_doc/html_generator.rb

@@ -5,34 +5,43 @@ require 'fileutils'
 
 module DoubleDoc
   class HtmlGenerator
+    DEFAULT_CSS = File.expand_path("../../templates/screen.css", File.dirname(__FILE__)).freeze
+
     def initialize(sources, options)
       @sources = sources
       @template_file = options[:html_template] || File.expand_path("../../templates/default.html.erb", File.dirname(__FILE__))
       @output_directory = Pathname.new(options[:html_destination])
       @html_renderer = options[:html_renderer] || HtmlRenderer
-      @stylesheet = options[:html_css] || 'screen.css'
+      @stylesheet = options[:html_css] || DEFAULT_CSS
       @title = options[:title] || 'Documentation'
     end
 
     def generate
+      FileUtils.mkdir_p(@output_directory)
+
       copy_assets
+      generated_files = [@output_directory + File.basename(@stylesheet)]
 
       @sources.each do |src|
         dst = @output_directory + File.basename(src).sub(/\.md$/, '.html')
         puts "#{src} -> #{dst}"
         FileUtils.mkdir_p(File.dirname(dst))
         File.open(dst, 'w') do |out|
-          markdown = File.new(src).read
+          markdown = self.class.convert_links_to_html!(File.new(src).read)
+
           body = @html_renderer.render(markdown)
           html = template.result(
             :title         => @title,
             :body          => body,
-            :css           => @stylesheet,
+            :css           => File.basename(@stylesheet),
             :sitemap       => sitemap
           )
           out.write(html)
         end
+        generated_files << dst
       end
+
+      clean_other_files(generated_files)
     end
 
     def sitemap
@@ -64,8 +73,8 @@ module DoubleDoc
     end
 
     def copy_assets
-      if @stylesheet == 'screen.css'
-        FileUtils.cp(File.expand_path("../../templates/screen.css", File.dirname(__FILE__)), @output_directory)
+      if @stylesheet == DEFAULT_CSS
+        FileUtils.cp(DEFAULT_CSS, @output_directory)
       end
     end
 
@@ -73,6 +82,18 @@ module DoubleDoc
       @template ||= Erubis::Eruby.new(File.read(@template_file))
     end
 
+    def clean_other_files(except)
+      files_to_delete = Dir.glob(@output_directory + '**/*') - except.map(&:to_s)
+      FileUtils.rm_rf(files_to_delete)
+    end
+
+    def self.convert_links_to_html!(markdown)
+      markdown.gsub!(/(\[[^\]]+\]\([^\)]+)\.md([^\)]*)\)/) do |match|
+        $1 + '.html' + $2 + ')'
+      end
+      markdown
+    end
+
     class SitemapItem
       attr_reader :title, :path, :id, :children
       attr_accessor :parent

data/lib/double_doc/task.rb

@@ -1,5 +1,6 @@
 require 'rake'
 require 'pathname'
+require 'tmpdir'
 require 'double_doc/import_handler'
 require 'double_doc/html_generator'
 
@@ -47,7 +48,7 @@ module DoubleDoc
     def initialize(task_name, options)
       md_dst   = Pathname.new(options[:md_destination])
       html_dst = Pathname.new(options[:html_destination]) if options[:html_destination]
-      sources  = FileList[*options[:sources]]
+      sources  = FileList[*options[:sources]].uniq
 
       destinations = [md_dst, html_dst].compact
       destinations.each do |dst|
@@ -58,16 +59,19 @@ module DoubleDoc
       generate_task = task(task_name => destinations) do |t, args|
         import_handler = DoubleDoc::ImportHandler.new(options[:root] || Rake.original_dir)
 
+        generated_md_files = []
+
         sources.each do |src|
           dst = md_dst + File.basename(src)
           puts "#{src} -> #{dst}"
           File.open(dst, 'w') do |out|
             out.write(import_handler.resolve_imports(File.new(src)))
           end
+          generated_md_files << dst
         end
 
         if html_dst || args[:html_destination]
-          html_generator = DoubleDoc::HtmlGenerator.new(FileList[(md_dst + '*.md').to_s].sort, options.merge(args))
+          html_generator = DoubleDoc::HtmlGenerator.new(generated_md_files, options.merge(args))
           html_generator.generate
         end
 

data/lib/double_doc/version.rb

@@ -1,4 +1,4 @@
 ## ## DoubleDoc 1.0
 module DoubleDoc
-  VERSION = "1.0.6"
+  VERSION = "1.0.7"
 end

data/test/html_generator_test.rb

@@ -0,0 +1,51 @@
+require 'test_helper'
+require 'pathname'
+require 'tmpdir'
+
+describe "the html generator" do
+  before do
+    @root = Pathname.new(Dir.mktmpdir)
+    @input_file_name  = @root + 'source/input.md'
+    @destination      = @root + 'destination'
+    @output_file_name = @destination + 'input.html'
+    Dir.mkdir(@root + 'source')
+    Dir.mkdir(@destination)
+    @generator = DoubleDoc::HtmlGenerator.new([@input_file_name], { :html_destination => @destination })
+  end
+
+  after do
+    FileUtils.rm_rf(@root)
+  end
+
+  describe "#generate" do
+    before do
+      File.open(@input_file_name, 'w') do |f|
+        f.puts "## Hello"
+        f.puts "and some text and a link to [the other file](other.md)"
+        f.puts "and a link with params [params](params.md?foo=bar)"
+        f.puts "and a link with a fragment [params](params.md#foo-bar)"
+      end
+
+      File.open(@destination + 'some_trash.html', 'w') do |f|
+        f.puts 'what ever'
+      end
+
+      @generator.generate
+    end
+
+    it "should put an html document in the destination directory" do
+      assert File.exist?(@output_file_name), 'did not create the html file'
+    end
+
+    it "should convert .md links to .html links" do
+      output = File.read(@output_file_name)
+      output.must_match(/<a href="other.html">the other file<\/a>/)
+      output.must_match(/<a href="params.html\?foo=bar">params<\/a>/)
+      output.must_match(/<a href="params.html#foo-bar">params<\/a>/)
+    end
+
+    it "should clean the destination for other files" do
+      assert !File.exist?(@destination + 'some_trash.html'), 'did not clean the destination directory'
+    end
+  end
+end

metadata

@@ -1,118 +1,90 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: double_doc
-version: !ruby/object:Gem::Version 
-  hash: 27
+version: !ruby/object:Gem::Version
+  version: 1.0.7
   prerelease: 
-  segments: 
-  - 1
-  - 0
-  - 6
-  version: 1.0.6
 platform: ruby
-authors: 
+authors:
 - Mick Staugaard
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-02-27 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  prerelease: false
-  requirement: *id001
-  type: :development
+date: 2012-02-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: guard
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
+  requirement: &70252209375540 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  prerelease: false
-  requirement: *id002
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
+  prerelease: false
+  version_requirements: *70252209375540
+- !ruby/object:Gem::Dependency
   name: minitest
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
+  requirement: &70252209375120 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
   prerelease: false
-  requirement: *id003
-  type: :runtime
+  version_requirements: *70252209375120
+- !ruby/object:Gem::Dependency
   name: rake
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id004 !ruby/object:Gem::Requirement 
+  requirement: &70252209374700 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  prerelease: false
-  requirement: *id004
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
+  prerelease: false
+  version_requirements: *70252209374700
+- !ruby/object:Gem::Dependency
   name: erubis
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id005 !ruby/object:Gem::Requirement 
+  requirement: &70252209374280 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 1
-        segments: 
-        - 2
-        - 1
-        version: "2.1"
-  prerelease: false
-  requirement: *id005
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
+  prerelease: false
+  version_requirements: *70252209374280
+- !ruby/object:Gem::Dependency
   name: redcarpet
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id006 !ruby/object:Gem::Requirement 
+  requirement: &70252209373780 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 15
-        segments: 
-        - 0
-        - 2
-        version: "0.2"
-  prerelease: false
-  requirement: *id006
+      - !ruby/object:Gem::Version
+        version: '2.1'
   type: :runtime
+  prerelease: false
+  version_requirements: *70252209373780
+- !ruby/object:Gem::Dependency
   name: pygments.rb
-description: A simple framework for writing and generating beautiful documentation for your code
-email: 
+  requirement: &70252209373280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70252209373280
+description: A simple framework for writing and generating beautiful documentation
+  for your code
+email:
 - mick@staugaard.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - lib/double_doc/doc_extractor.rb
 - lib/double_doc/html_generator.rb
 - lib/double_doc/html_renderer.rb
@@ -126,40 +98,33 @@ files:
 - templates/screen.css
 - README.md
 - test/doc_extractor_test.rb
+- test/html_generator_test.rb
 - test/test_helper.rb
 homepage: http://staugaard.github.com/double_doc
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Documentation right where you want it
-test_files: 
+test_files:
 - test/doc_extractor_test.rb
+- test/html_generator_test.rb
 - test/test_helper.rb