gollum-site 0.1.10 → 0.1.11

data/README.md

@@ -163,6 +163,12 @@ You can customize sanitization with three options:
 
        $ gollum-site generate --allow_elements embed,object --allow_attributes src --allow_protocols irc
 
+## Ignore File
+
+If there is a file named `.gollumignore` in the root of the repository, the
+exclusions it specifies will be used to suppress gollum-site generation
+accordingly. The `.gollumignore` file uses `.gitignore` semantics.
+
 ## Example
 
 To see gollum-site in action, let's use it to generate a static site from a

data/lib/gollum-site/site.rb

@@ -1,4 +1,5 @@
 module Gollum
+
   class Site
     def self.default_layout_dir()
       ::File.join(::File.dirname(::File.expand_path(__FILE__)), "layout")
@@ -33,11 +34,7 @@ module Gollum
       items.each do |item|
         filename = ::File.basename(item.path)
         dirname = ::File.dirname(item.path)
-        if filename =~ /^_Footer./
-          # ignore
-        elsif filename =~ /^_Sidebar./
-          # ignore
-        elsif filename =~ /^_Layout.html/
+        if filename =~ /^_Layout.html/
           # layout
           @layouts[item.path] = ::Liquid::Template.parse(item.data)
         elsif @wiki.page_class.valid_page_name?(filename)
@@ -56,37 +53,17 @@ module Gollum
 
     def ls(version = 'master')
       if version == :working
-        ls_opts = {
-          :others => true,
-          :exclude_standard => true,
-          :cached => true,
-          :z => true
-        }
-
-        ls_opts_del = {
-          :deleted => true,
-          :exclude_standard => true,
-          :z => true
-        }
-
-        # if output_path is in work_tree, it should be excluded
-        if ::File.expand_path(@output_path).match(::File.expand_path(@wiki.repo.git.work_tree))
-          ls_opts[:exclude] = @output_path
-          ls_opts_del[:exclude] = @output_path
-        end
-
-        cwd = Dir.pwd # need to change directories for git ls-files -o
-        Dir.chdir(@wiki.repo.git.work_tree)
-        deleted = @wiki.repo.git.native(:ls_files, ls_opts_del).split("\0")
-        working = @wiki.repo.git.native(:ls_files, ls_opts).split("\0")
-        work_tree = (working - deleted).map do |path|
-          path = decode_git_path(path)
-          OpenStruct.new(:path => path, :data => IO.read(path))
+        return in_work_tree do
+          working = ls_files(:exclude => @output_path, :others => true, :cached => true)
+          deleted = ls_files(:exclude => @output_path, :deleted => true)
+          ignored = ignored_list(version)
+          valid_files = working - deleted - ignored
+          valid_files.map do |path|
+            OpenStruct.new(:path => path, :data => IO.read(path))
+          end
         end
-        Dir.chdir(cwd) # change back to original directory
-        return work_tree
       else
-        return @wiki.tree_map_for(version).map do |entry|
+        return @wiki.tree_map_for(version).reject {|entry| ignored? entry.path }.map do |entry|
           OpenStruct.new(:path => entry.path, :data => entry.blob(@wiki.repo).data)
         end
       end
@@ -137,5 +114,40 @@ module Gollum
       path.gsub!(/\\[rn"\\]/) { |m| eval(%("#{m.to_s}")) }
       path
     end
-  end
-end
+
+    def ignored?(path)
+      @ignored_list ||= ignored_list
+      @ignored_list.include? path
+    end
+
+    def ignored_list(version = 'master')
+      in_work_tree do
+        ignore = ls_files(:ignored => true, :exclude_from => '.gollumignore')
+        if version == :working
+          ignore += ls_files(:ignored => true, :exclude_from => '.gollumignore', :other => true)
+        else
+          ignore += ls_files(:other => true)
+        end
+        # grit does not correctly handle multiple options with the same name
+        ignore += ls_files(:ignored => true, :exclude => '.gollumignore')
+        ignore += ls_files(:ignored => true, :exclude => '.gitignore')
+        ignore += ls_files(:ignored => true, :exclude => '_Sidebar.*')
+        ignore += ls_files(:ignored => true, :exclude => '_Footer.*')
+      end
+    end
+
+    def ls_files(opts)
+      opts.merge!(:z => true, :exclude_standard => true)
+      @wiki.repo.git.native(:ls_files, opts).split("\0").map {|path| decode_git_path(path) }
+    end
+
+    def in_work_tree
+      cwd = Dir.pwd
+      Dir.chdir(@wiki.repo.git.work_tree)
+      result = yield
+      Dir.chdir(cwd)
+      result
+    end
+  end # Site
+
+end # Gollum

data/lib/gollum-site/version.rb

@@ -1,5 +1,5 @@
 module Gollum
   class Site
-    VERSION = "0.1.10"
+    VERSION = "0.1.11"
   end
 end

data/test/test_site.rb

@@ -91,6 +91,37 @@ context "Preview" do
   end
 end
 
+context "Ignorefile" do
+  setup do
+    @path = testpath("examples/test_ignorefile.git")
+    @repo = Grit::Repo.init(@path)
+    File.open(@path + '/.gollumignore', 'w') { |f| f.write("Ignore*.*") }
+    File.open(@path + '/Home.md', 'w') { |f| f.write("Home file.") }
+    File.open(@path + '/IgnoreRepo.md', 'w') { |f| f.write("Ignore this repo file.") }
+    @repo.add(@path)
+    @repo.commit_all("Initial commit.")
+    # Add untracked working files
+    File.open(@path + '/IgnoreWorking.md', 'w') { |f| f.write("Ignore this working file.") }
+    File.open(@path + '/UseWorking.md', 'w') { |f| f.write("Use me.") }
+    @site = Gollum::Site.new(@path, {
+                               :output_path => testpath("examples/site"),
+                               :version => :working
+                             })
+    @site.generate()
+  end
+
+  test "working site has no ignored files" do
+    diff = Dir[@site.output_path + "/**/*"].
+      map { |f| f.sub(@site.output_path, "") }
+    assert_equal(["/Home.html", "/UseWorking.html"], diff)
+  end
+
+  teardown do
+    FileUtils.rm_r(@site.output_path)
+    FileUtils.rm_r(@path)
+  end
+end
+
 context "Sanitization" do
   setup do
     @path = Dir.mktmpdir('gollumsite')

metadata

@@ -2,7 +2,7 @@
 name: gollum-site
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.10
+  version: 0.1.11
 platform: ruby
 authors: 
 - Daniel Reverri
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-20 00:00:00 Z
+date: 2011-12-10 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: gollum
@@ -604,7 +604,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: gollum-site
-rubygems_version: 1.7.2
+rubygems_version: 1.8.8
 signing_key: 
 specification_version: 3
 summary: Static site generator for Gollum Wikis