gollum-lib 0.0.1

data/Rakefile

@@ -0,0 +1,171 @@
+require 'rubygems'
+require 'rake'
+require 'date'
+
+#############################################################################
+#
+# Helper functions
+#
+#############################################################################
+
+def name
+  @name ||= Dir['*.gemspec'].first.split('.').first
+end
+
+def version
+  line = File.read("lib/#{name}.rb")[/^\s*VERSION\s*=\s*.*/]
+  line.match(/.*VERSION\s*=\s*['"](.*)['"]/)[1]
+end
+
+# assumes x.y.z all digit version
+def next_version
+  # x.y.z
+  v = version.split '.'
+  # bump z
+  v[-1] = v[-1].to_i + 1
+  v.join '.'
+end
+
+def bump_version
+  old_file = File.read("lib/#{name}.rb")
+  old_version_line = old_file[/^\s*VERSION\s*=\s*.*/]
+  new_version = next_version
+  # replace first match of old vesion with new version
+  old_file.sub!(old_version_line, "  VERSION = '#{new_version}'")
+
+  File.write("lib/#{name}.rb", old_file)
+
+  new_version
+end
+
+def date
+  Date.today.to_s
+end
+
+def rubyforge_project
+  name
+end
+
+def gemspec_file
+  "#{name}.gemspec"
+end
+
+def gem_file
+  "#{name}-#{version}.gem"
+end
+
+def replace_header(head, header_name)
+  head.sub!(/(\.#{header_name}\s*= ').*'/) { "#{$1}#{send(header_name)}'"}
+end
+
+#############################################################################
+#
+# Standard tasks
+#
+#############################################################################
+
+task :default => :test
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test' << '.'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+desc "Generate RCov test coverage and open in your browser"
+task :coverage do
+  require 'rcov'
+  sh "rm -fr coverage"
+  sh "rcov test/test_*.rb"
+  sh "open coverage/index.html"
+end
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -r ./lib/#{name}.rb"
+end
+
+#############################################################################
+#
+# Custom tasks (add your own tasks here)
+#
+#############################################################################
+
+desc "Update version number and gemspec"
+task :bump do
+  puts "Updated version to #{bump_version}"
+  # Execute does not invoke dependencies.
+  # Manually invoke gemspec then validate.
+  Rake::Task[:gemspec].execute
+  Rake::Task[:validate].execute
+end
+
+#############################################################################
+#
+# Packaging tasks
+#
+#############################################################################
+
+desc 'Create a release build'
+task :release => :build do
+  unless `git branch` =~ /^\* master$/
+    puts "You must be on the master branch to release!"
+    exit!
+  end
+  sh "git commit --allow-empty -a -m 'Release #{version}'"
+  sh "git pull"
+  sh "git tag v#{version}"
+  sh "git push origin master"
+  sh "git push origin v#{version}"
+  sh "gem push pkg/#{name}-#{version}.gem"
+end
+
+desc 'Build gem'
+task :build => :gemspec do
+  sh "mkdir -p pkg"
+  sh "gem build #{gemspec_file}"
+  sh "mv #{gem_file} pkg"
+end
+
+desc 'Update gemspec'
+task :gemspec => :validate do
+  # read spec file and split out manifest section
+  spec = File.read(gemspec_file)
+  head, manifest, tail = spec.split("  # = MANIFEST =\n")
+
+  # replace name version and date
+  replace_header(head, :name)
+  replace_header(head, :version)
+  replace_header(head, :date)
+  #comment this out if your rubyforge_project has a different name
+  replace_header(head, :rubyforge_project)
+
+  # determine file list from git ls-files
+  files = `git ls-files`.
+    split("\n").
+    sort.
+    reject { |file| file =~ /^\./ }.
+    reject { |file| file =~ /^(rdoc|pkg|test|Home\.md|\.gitattributes)/ }.
+    map { |file| "    #{file}" }.
+    join("\n")
+
+  # piece file back together and write
+  manifest = "  s.files = %w[\n#{files}\n  ]\n"
+  spec = [head, manifest, tail].join("  # = MANIFEST =\n")
+  File.open(gemspec_file, 'w') { |io| io.write(spec) }
+  puts "Updated #{gemspec_file}"
+end
+
+desc 'Validate lib files and version file'
+task :validate do
+  libfiles = Dir['lib/*'] - ["lib/#{name}.rb", "lib/#{name}"]
+  unless libfiles.empty?
+    puts "Directory `lib` should only contain a `#{name}.rb` file and `#{name}` dir."
+    exit!
+  end
+  unless Dir['VERSION*'].empty?
+    puts "A `VERSION` file at root level violates Gem best practices."
+    exit!
+  end
+end

data/config.rb

@@ -0,0 +1,28 @@
+# Example gollum config
+# gollum ../wiki --config config.rb
+#
+# or run from source with
+#
+# bundle exec bin/gollum ../wiki/ --config config.rb
+
+# Remove const to avoid
+# warning: already initialized constant FORMAT_NAMES
+#
+# only remove if it's defined.
+# constant Gollum::Page::FORMAT_NAMES not defined (NameError)
+Gollum::Page.send :remove_const, :FORMAT_NAMES if defined? Gollum::Page::FORMAT_NAMES
+# limit to one format
+Gollum::Page::FORMAT_NAMES = { :markdown  => "Markdown" }
+
+=begin
+Valid formats are:
+{ :markdown  => "Markdown",
+  :textile   => "Textile",
+  :rdoc      => "RDoc",
+  :org       => "Org-mode",
+  :creole    => "Creole",
+  :rest      => "reStructuredText",
+  :asciidoc  => "AsciiDoc",
+  :mediawiki => "MediaWiki",
+  :pod       => "Pod" }
+=end

data/docs/sanitization.md

@@ -0,0 +1,32 @@
+Sanitization Rules
+==================
+
+Gollum uses the [Sanitize](http://wonko.com/post/sanitize) gem for HTML
+sanitization.
+
+See `lib/gollum.rb` for actual settings.
+
+## ALLOWED TAGS
+
+a, abbr, acronym, address, area, b, big, blockquote, br, button, caption,
+center, cite, code, col, colgroup, dd, del, dfn, dir, div, dl, dt, em,
+fieldset, font, form, h1, h2, h3, h4, h5, h6, hr, i, img, input, ins, kbd,
+label, legend, li, map, menu, ol, optgroup, option, p, pre, q, s, samp,
+select, small, span, strike, strong, sub, sup, table, tbody, td, textarea,
+tfoot, th, thead, tr, tt, u, ul, var
+
+## ALLOWED ATTRIBUTES
+
+abbr, accept, accept-charset, accesskey, action, align, alt, axis, border,
+cellpadding, cellspacing, char, charoff, charset, checked, cite, class, clear,
+cols, colspan, color, compact, coords, datetime, dir, disabled, enctype, for,
+frame, headers, height, href, hreflang, hspace, id, ismap, label, lang,
+longdesc, maxlength, media, method, multiple, name, nohref, noshade, nowrap,
+prompt, readonly, rel, rev, rows, rowspan, rules, scope, selected, shape,
+size, span, src, start, summary, tabindex, target, title, type, usemap,
+valign, value, vspace, width
+
+## ALLOWED PROTOCOLS
+
+a href: http, https, mailto
+img src: http, https

data/gollum-lib.gemspec

@@ -0,0 +1,74 @@
+Gem::Specification.new do |s|
+  s.specification_version = 2 if s.respond_to? :specification_version=
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.rubygems_version = '0.0.1'
+  s.required_ruby_version = ">= 1.8.7"
+
+  s.name              = 'gollum-lib'
+  s.version           = '0.0.1'
+  s.date              = '2013-03-19'
+  s.rubyforge_project = 'gollum-lib'
+
+  s.summary     = "A simple, Git-powered wiki."
+  s.description = "A simple, Git-powered wiki with a sweet API and local frontend."
+
+  s.authors  = ["Tom Preston-Werner", "Rick Olson"]
+  s.email    = 'tom@github.com'
+  s.homepage = 'http://github.com/gollum/gollum-lib'
+
+  s.require_paths = %w[lib]
+
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.extra_rdoc_files = %w[README.md LICENSE]
+
+  s.add_dependency('grit', '~> 2.5.0')
+  s.add_dependency('github-markup', ['>= 0.7.5', '< 1.0.0'])
+  s.add_dependency('github-markdown', '~> 0.5.3')
+  s.add_dependency('pygments.rb', '~> 0.4.2')
+  s.add_dependency('sanitize', '~> 2.0.3')
+  s.add_dependency('nokogiri', '~> 1.5.6')
+  s.add_dependency('stringex', '~> 1.5.1')
+
+  s.add_development_dependency('RedCloth', '~> 4.2.9')
+  s.add_development_dependency('mocha', '~> 0.13.2')
+  s.add_development_dependency('org-ruby', '~> 0.8.1')
+  s.add_development_dependency('shoulda', '~> 3.3.2')
+  s.add_development_dependency('wikicloth', '~> 0.8.0')
+  s.add_development_dependency('rake', '~> 10.0.3')
+  s.add_development_dependency('pry', '~> 0.9.12')
+  # required by pry
+  s.add_development_dependency('rb-readline', '~> 0.4.2')
+  s.add_development_dependency('minitest-reporters', '>= 0.5.0')
+
+  # = MANIFEST =
+  s.files = %w[
+    Gemfile
+    HISTORY.md
+    LICENSE
+    README.md
+    Rakefile
+    config.rb
+    docs/sanitization.md
+    gollum-lib.gemspec
+    lib/gollum-lib.rb
+    lib/gollum-lib/blob_entry.rb
+    lib/gollum-lib/committer.rb
+    lib/gollum-lib/file.rb
+    lib/gollum-lib/file_view.rb
+    lib/gollum-lib/git_access.rb
+    lib/gollum-lib/gitcode.rb
+    lib/gollum-lib/grit_ext.rb
+    lib/gollum-lib/helpers.rb
+    lib/gollum-lib/markup.rb
+    lib/gollum-lib/markups.rb
+    lib/gollum-lib/page.rb
+    lib/gollum-lib/pagination.rb
+    lib/gollum-lib/sanitization.rb
+    lib/gollum-lib/web_sequence_diagram.rb
+    lib/gollum-lib/wiki.rb
+    licenses/licenses.txt
+  ]
+  # = MANIFEST =
+
+  s.test_files = s.files.select { |path| path =~ /^test\/test_.*\.rb/ }
+end

data/lib/gollum-lib.rb

@@ -0,0 +1,53 @@
+# ~*~ encoding: utf-8 ~*~
+# stdlib
+require 'digest/md5'
+require 'digest/sha1'
+require 'ostruct'
+
+# external
+require 'grit'
+require File.expand_path('../gollum-lib/grit_ext', __FILE__)
+require 'github/markup'
+require 'sanitize'
+
+# internal
+require File.expand_path('../gollum-lib/git_access', __FILE__)
+require File.expand_path('../gollum-lib/committer', __FILE__)
+require File.expand_path('../gollum-lib/pagination', __FILE__)
+require File.expand_path('../gollum-lib/blob_entry', __FILE__)
+require File.expand_path('../gollum-lib/wiki', __FILE__)
+require File.expand_path('../gollum-lib/page', __FILE__)
+require File.expand_path('../gollum-lib/file', __FILE__)
+require File.expand_path('../gollum-lib/file_view', __FILE__)
+require File.expand_path('../gollum-lib/markup', __FILE__)
+require File.expand_path('../gollum-lib/markups', __FILE__)
+require File.expand_path('../gollum-lib/sanitization', __FILE__)
+require File.expand_path('../gollum-lib/web_sequence_diagram', __FILE__)
+
+# Set ruby to UTF-8 mode
+# This is required for Ruby 1.8.7 which gollum still supports.
+$KCODE = 'U' if RUBY_VERSION[0,3] == '1.8'
+
+module Gollum
+  VERSION = '0.0.1'
+
+  def self.assets_path
+    ::File.expand_path('gollum/frontend/public', ::File.dirname(__FILE__))
+  end
+
+  class Error < StandardError; end
+
+  class DuplicatePageError < Error
+    attr_accessor :dir
+    attr_accessor :existing_path
+    attr_accessor :attempted_path
+
+    def initialize(dir, existing, attempted, message = nil)
+      @dir            = dir
+      @existing_path  = existing
+      @attempted_path = attempted
+      super(message || "Cannot write #{@dir}/#{@attempted_path}, found #{@dir}/#{@existing_path}.")
+    end
+  end
+end
+

data/lib/gollum-lib/blob_entry.rb

@@ -0,0 +1,95 @@
+# ~*~ encoding: utf-8 ~*~
+module Gollum
+  class BlobEntry
+    # Gets the String SHA for this blob.
+    attr_reader :sha
+
+    # Gets the full path String for this blob.
+    attr_reader :path
+
+    # Gets the Fixnum size of this blob.
+    attr_reader :size
+
+    # Gets the Fixnum mode of this blob.
+    attr_reader :mode
+
+    def initialize(sha, path, size = nil, mode = nil)
+      @sha  = sha
+      @path = path
+      @size = size
+      @mode = mode
+      @dir  = @name = @blob = nil
+    end
+
+    # Gets the normalized directory path String for this blob.
+    def dir
+      @dir ||= self.class.normalize_dir(::File.dirname(@path))
+    end
+
+    # Gets the file base name String for this blob.
+    def name
+      @name ||= ::File.basename(@path)
+    end
+
+    # Gets a Grit::Blob instance for this blob.
+    #
+    # repo - Grit::Repo instance for the Grit::Blob.
+    #
+    # Returns an unbaked Grit::Blob instance.
+    def blob(repo)
+      @blob ||= Grit::Blob.create(repo,
+        :id => @sha, :name => name, :size => @size, :mode => @mode)
+    end
+
+    # Gets a Page instance for this blob.
+    #
+    # wiki - Gollum::Wiki instance for the Gollum::Page
+    #
+    # Returns a Gollum::Page instance.
+    def page(wiki, commit)
+      blob = self.blob(wiki.repo)
+      page = wiki.page_class.new(wiki).populate(blob, self.dir)
+      page.version = commit
+      page
+    end
+
+    # Gets a File instance for this blob.
+    #
+    # wiki - Gollum::Wiki instance for the Gollum::File
+    #
+    # Returns a Gollum::File instance.
+    def file(wiki, commit)
+      blob = self.blob(wiki.repo)
+      file = wiki.file_class.new(wiki).populate(blob, self.dir)
+      file.version = commit
+      file
+    end
+
+    def inspect
+      %(#<Gollum::BlobEntry #{@sha} #{@path}>)
+    end
+
+    # Normalizes a given directory name for searching through tree paths.
+    # Ensures that a directory begins with a slash, or
+    #
+    #   normalize_dir("")      # => ""
+    #   normalize_dir(".")     # => ""
+    #   normalize_dir("foo")   # => "/foo"
+    #   normalize_dir("/foo/") # => "/foo"
+    #   normalize_dir("/")     # => ""
+    #   normalize_dir("c:/")   # => ""
+    #
+    # dir - String directory name.
+    #
+    # Returns a normalized String directory name, or nil if no directory
+    # is given.
+    def self.normalize_dir(dir)
+      return '' if dir =~ /^.:\/$/
+      if dir
+        dir = ::File.expand_path(dir, '/')
+        dir = '' if dir == '/'
+      end
+      dir
+    end
+  end
+end