gollum-site 0.0.1 → 0.0.2

data/README.md

@@ -7,7 +7,9 @@ Generates a static site from a Gollum Wiki.
 
 ## Installation
 
-TODO
+The easiest way to install gollum-site is with RubyGems:
+
+	$ [sudo] gem install gollum-site
 
 ## Usage
 
@@ -42,6 +44,15 @@ generation with the following data made available to it:
 * `page.author`          The author of the last edit
 * `page.date`            The date of the last edit
 
+## Default Layout
+
+A default layout is applied to the root folder for wikis that do not define a
+root layout. The default layout is the same used in gollum without the edit
+features. It's possible to generate a site without the default template using
+the "--no_default_layout" option:
+
+       $ gollum-site --no_default_layout generate
+
 ## Example
 
 To see gollum-site in action, let's use it to generate a static site from a

data/bin/gollum-site

@@ -25,7 +25,7 @@ options = {
   'base_path' => '/',
   'output_path' => '_site',
   'port' => 8000,
-  'include_default_layout' => true
+  'default_layout' => true
 }
 opts = OptionParser.new do |opts|
   opts.banner = help
@@ -46,8 +46,8 @@ opts = OptionParser.new do |opts|
     options['port'] = port
   end
 
-  opts.on("--include_default_layout", "Include a default layout if one is not present") do |include_default_layout|
-    options['include_default_layout'] = include_default_layout
+  opts.on("--no_default_layout", "Don't include a default layout") do |default_layout|
+    options['default_layout'] = !default_layout
   end
 
   opts.on_tail("--help", "Show this information") do
@@ -71,7 +71,7 @@ when 'generate'
   wiki = Gollum::Wiki.new('.', {:base_path => options['base_path']})
   site = Gollum::Site.new(wiki, {
                             :output_path => options['output_path'],
-                            :include_default_layout => options['include_default_layout']})
+                            :include_default_layout => options['default_layout']})
   site.generate(options['ref'])
 when 'serve'
   require 'webrick'

data/lib/gollum-site/site.rb

@@ -5,7 +5,9 @@ module Gollum
     def initialize(wiki, options = {})
       @wiki = wiki
       @output_path = options[:output_path] || "_site"
-      @include_default_layout = options[:include_default_layout] || true
+      if (@include_default_layout = options[:include_default_layout]).nil?
+        @include_default_layout = true
+      end
     end
 
     # Public: generate a static site

data/lib/gollum-site/version.rb

@@ -1,5 +1,5 @@
 module Gollum
   class Site
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end

data/test/test_site.rb

@@ -55,3 +55,22 @@ context "Site inherits default layout" do
     FileUtils.rm_r(@site.output_path)
   end
 end
+
+context "Site does not inherit default layout" do
+  setup do
+    @wiki = Gollum::Wiki.new(testpath("examples/test_site_no_layout.git"))
+    @site = Gollum::Site.new(@wiki,
+                             {:output_path => testpath("examples/site"),
+                             :include_default_layout => false})
+    @site.generate("master")
+  end
+
+  test "check that default layout is used" do
+    assert !File.exists?(File.join(@site.output_path, "css"))
+    assert !File.exists?(File.join(@site.output_path, "javascript"))
+  end
+
+  teardown do
+    FileUtils.rm_r(@site.output_path)
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: gollum-site
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: false
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Daniel Reverri