double_doc 1.1.0 → 1.2.0

data/README.md

@@ -1,4 +1,4 @@
-## DoubleDoc 1.0
+## DoubleDoc 1.2
 
 One of the challenges you face when writing public documention for code or APIs, is that you have to remember to update the documentation
 when ever you change the API. The main reason why this is a problem is that very often the documentation lives very for from your code.

data/lib/double_doc/html_generator.rb

@@ -14,6 +14,7 @@ module DoubleDoc
       @html_renderer = options[:html_renderer] || HtmlRenderer
       @stylesheet = options[:html_css] || DEFAULT_CSS
       @title = options[:title] || 'Documentation'
+      @exclude_from_navigation = options[:exclude_from_navigation] || []
     end
 
     def generate
@@ -62,7 +63,9 @@ module DoubleDoc
 
       @sitemap = []
 
-      @sources.each do |src|
+      navigation_sources = @sources - @exclude_from_navigation
+
+      navigation_sources.each do |src|
         path = File.basename(src).sub(/\.md$/, '.html')
         lines = File.readlines(src)
 

data/lib/double_doc/task.rb

@@ -113,7 +113,7 @@ module DoubleDoc
               `git add .`
               `git commit -n -m 'Updated Github Pages'`
               `git push origin gh-pages`
-              `git co #{git_branch}`
+              `git checkout #{git_branch}`
             end
           end
         end

data/lib/double_doc/version.rb

@@ -1,4 +1,4 @@
-## ## DoubleDoc 1.0
+## ## DoubleDoc 1.2
 module DoubleDoc
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

data/test/html_generator_test.rb

@@ -43,5 +43,48 @@ describe "the html generator" do
       output.must_match(/<a href="params.html\?foo=bar">params<\/a>/)
       output.must_match(/<a href="params.html#foo-bar">params<\/a>/)
     end
+
+  end
+
+  describe "navigation" do
+    before do
+      @input_file_one = @root + 'source/file_one.md'
+      File.open(@input_file_one, 'w') do |f|
+        f.puts "## Title One"
+      end
+
+      @input_file_two = @root + 'source/file_two.md'
+      File.open(@input_file_two, 'w') do |f|
+        f.puts "## Title Two"
+      end
+
+      @input_files = [@input_file_one, @input_file_two]
+    end
+
+    it "should generate links for each page in the navigation area" do
+      generator = DoubleDoc::HtmlGenerator.new(@input_files, {
+        :html_destination => @destination
+      })
+      generator.generate
+
+      output = File.read(@destination + 'file_one.html')
+
+      output.must_match(/<li>\s*<a class="source" href="file_one.html">Title One<\/a>\s*<\/li>/)
+      output.must_match(/<li>\s*<a class="source" href="file_two.html">Title Two<\/a>\s*<\/li>/)
+    end
+
+    it "should skip specified filed" do
+      generator = DoubleDoc::HtmlGenerator.new(@input_files, {
+        :html_destination => @destination,
+        :exclude_from_navigation => [@input_file_two]
+      })
+      generator.generate
+
+      output = File.read(@destination + 'file_one.html')
+
+      output.must_match(/<li>\s*<a class="source" href="file_one.html">Title One<\/a>\s*<\/li>/)
+      output.wont_match(/<li>\s*<a class="source" href="file_two.html">Title Two<\/a>\s*<\/li>/)
+    end
   end
+
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: double_doc
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 31
   prerelease: 
   segments: 
   - 1
-  - 1
+  - 2
   - 0
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors: 
 - Mick Staugaard
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-04-02 00:00:00 Z
+date: 2012-04-16 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: guard