gollum-lib 4.0.3-java

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MTBlOGQ3ZDA1OTc3ZDRhNDQxYWEyZWFmMDQxN2Q3ODUzNTlmZjkzNw==
+  data.tar.gz: !binary |-
+    NmQzNTQ4YTg4YTI1NGZkNTI0NGQyY2FmN2FjMWRhNWE3N2U2MzI0YQ==
+SHA512:
+  metadata.gz: !binary |-
+    ZjI0YjMxZDQ4NjQ2ZmVmODY0YjNiNmFiMWExZWI4ZDNkZGI5MjBhOTQyNGI2
+    ODlmNGYwYjYxNzNkZjJiNDNkMDIwZTdjNWZhNzQxNTRmZWRiYjJlYWZlNTEw
+    OTM2ZjEyZWY4YmQwN2Y2MjU0MjNjZTg3ZmU2MDJhZjljYTJiOTA=
+  data.tar.gz: !binary |-
+    ZTc4MTZkNDM3OGE4YmY5YzI3NzYxZDRkMWM1MTFiMTgzZTk4M2RlZGFkOGQz
+    NjdhNTNkN2ViYTJhMjllOWRkNzg4ZGVjMjYyY2IxMzc3NWMyNTlkMWIwMjEz
+    YzJlYzJhNDhhZDMxMjA3Njc2MzM5YmI4NTNmMTQ0ZmM0MWQ4YWE=

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec :name => RUBY_PLATFORM == 'java' ? 'gollum-lib_java' : 'gollum-lib'

data/HISTORY.md

@@ -0,0 +1,11 @@
+# v4.0.2 /2015-0119
+
+* Bugfixes
+
+# v4.0.1 /2014-12-04
+
+* Security fix for [remote code execution issue](https://github.com/gollum/gollum/issues/913). Please update!
+
+# v0.0.1 / 2013-03-19
+
+* First release, extrated from https://github.com/gollum/gollum

data/LICENSE

@@ -0,0 +1,21 @@
+(The MIT License)
+
+Copyright (c) Tom Preston-Werner, Rick Olson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the 'Software'), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,286 @@
+gollum lib -- A wiki built on top of Git
+========================================
+
+[![Gem Version](https://badge.fury.io/rb/gollum-lib.svg)](http://badge.fury.io/rb/gollum-lib)
+[![Build Status](https://travis-ci.org/gollum/gollum-lib.svg?branch=master)](https://travis-ci.org/gollum/gollum-lib)
+[![Dependency Status](https://gemnasium.com/gollum/gollum-lib.svg)](https://gemnasium.com/gollum/gollum-lib)
+
+## DESCRIPTION
+
+[Gollum](https://github.com/gollum/gollum) is a simple wiki system built on
+top of Git that powers GitHub Wikis.
+
+Gollum-lib is the Ruby API that allows you to retrieve raw or formatted wiki
+content from a Git repository, write new content to the repository, and collect
+various meta data about the wiki as a whole.
+
+Gollum-lib follows the rules of [Semantic Versioning](http://semver.org/) and uses
+[TomDoc](http://tomdoc.org/) for inline documentation.
+
+## SYSTEM REQUIREMENTS
+
+- Python 2.5+ (2.7.3 recommended)
+- Ruby 1.9.3+ (1.9.3 recommended)
+- Unix like operating system (OS X, Ubuntu, Debian, and more)
+- Will not work on Windows (because of [grit](https://github.com/github/grit))
+
+## INSTALLATION
+
+The best way to install Gollum-lib is with RubyGems:
+
+```bash
+$ [sudo] gem install gollum-lib
+```
+
+If you're installing from source, you can use [Bundler][bundler] to pick up all the
+gems:
+
+```bash
+$ bundle install
+```
+
+In order to use the various formats that Gollum supports, you will need to
+separately install the necessary dependencies for each format. You only need
+to install the dependencies for the formats that you plan to use.
+
+* [AsciiDoc](http://www.methods.co.nz/asciidoc/) -- `gem install asciidoctor`
+* [Creole](http://wikicreole.org/) -- `gem install creole`
+* [Markdown](http://daringfireball.net/projects/markdown/) -- `gem install redcarpet`
+* [GitHub Flavored Markdown](https://help.github.com/articles/github-flavored-markdown) -- `gem install github-markdown`
+* [Org](http://orgmode.org/) -- `gem install org-ruby`
+* [Pod](http://search.cpan.org/dist/perl/pod/perlpod.pod) -- `Pod::Simple::HTML` comes with Perl >= 5.10. Lower versions should install Pod::Simple from CPAN.
+* [RDoc](http://rdoc.sourceforge.net/)
+* [ReStructuredText](http://docutils.sourceforge.net/rst.html) -- `easy_install docutils`
+* [Textile](http://www.textism.com/tools/textile/) -- `gem install RedCloth`
+* [MediaWiki](http://www.mediawiki.org/wiki/Help:Formatting) -- `gem install wikicloth`
+
+[bundler]: http://gembundler.com/
+
+## SYNTAX
+
+Gollum supports a variety of formats and extensions (Markdown, MediaWiki, Textile, …).
+On top of these formats Gollum lets you insert headers, footers, links, image, math and more.
+
+Check out the [Gollum Wiki](https://github.com/gollum/gollum/wiki) for all of Gollum's formats and syntactic options.
+
+## API DOCUMENTATION
+
+Initialize the `Gollum::Repo` object:
+
+```ruby
+# Require rubygems if necessary
+require 'rubygems'
+
+# Require the Gollum library
+require 'gollum-lib'
+
+# Create a new Gollum::Wiki object by initializing it with the path to the
+# Git repository.
+wiki = Gollum::Wiki.new("my-gollum-repo.git")
+# => <Gollum::Wiki>
+```
+
+By default, internal wiki links are all absolute from the root. To specify a different
+base path, you can specify the `:base_path` option:
+
+```ruby
+wiki = Gollum::Wiki.new("my-gollum-repo.git", :base_path => "/wiki")
+```
+
+Note that `base_path` just modifies the links.
+
+Get the latest version of the given human or canonical page name:
+
+```ruby
+page = wiki.page('page-name')
+# => <Gollum::Page>
+
+page.raw_data
+# => "# My wiki page"
+
+page.formatted_data
+# => "<h1>My wiki page</h1>"
+
+page.format
+# => :markdown
+
+vsn = page.version
+# => <Gollum::Git::Commit>
+
+vsn.id
+# => '3ca43e12377ea1e32ea5c9ce5992ec8bf266e3e5'
+```
+
+Get the footer (if any) for a given page:
+
+```ruby
+page.footer
+# => <Gollum::Page>
+```
+
+Get the header (if any) for a given page:
+
+```ruby
+page.header
+# => <Gollum::Page>
+```
+
+Get a list of versions for a given page:
+
+```ruby
+vsns = wiki.page('page-name').versions
+# => [<Gollum::Git::Commit, <Gollum::Git::Commit, <Gollum::Git::Commit>]
+
+vsns.first.id
+# => '3ca43e12377ea1e32ea5c9ce5992ec8bf266e3e5'
+
+vsns.first.authored_date
+# => Sun Mar 28 19:11:21 -0700 2010
+```
+
+Get a specific version of a given canonical page file:
+
+```ruby
+wiki.page('page-name', '5ec521178e0eec4dc39741a8978a2ba6616d0f0a')
+```
+
+Get the latest version of a given static file:
+
+```ruby
+file = wiki.file('asset.js')
+# => <Gollum::File>
+
+file.raw_data
+# => "alert('hello');"
+
+file.version
+# => <Gollum::Git::Commit>
+```
+
+Get a specific version of a given static file:
+
+```ruby
+wiki.file('asset.js', '5ec521178e0eec4dc39741a8978a2ba6616d0f0a')
+```
+
+Get an in-memory Page preview (useful for generating previews for web
+interfaces):
+
+```ruby
+preview = wiki.preview_page("My Page", "# Contents", :markdown)
+preview.formatted_data
+# => "<h1>Contents</h1>"
+```
+
+Methods that write to the repository require a Hash of commit data that takes
+the following form:
+
+```ruby
+commit = { :message => 'commit message',
+           :name => 'Tom Preston-Werner',
+           :email => 'tom@github.com' }
+```
+
+Write a new version of a page (the file will be created if it does not already
+exist) and commit the change. The file will be written at the repo root.
+
+```ruby
+wiki.write_page('Page Name', :markdown, 'Page contents', commit)
+```
+
+Update an existing page. If the format is different than the page's current
+format, the file name will be changed to reflect the new format.
+
+```ruby
+page = wiki.page('Page Name')
+wiki.update_page(page, page.name, page.format, 'Page contents', commit)
+```
+
+To delete a page and commit the change:
+
+```ruby
+wiki.delete_page(page, commit)
+```
+
+Register or unregister a hook to be called after a page commit:
+
+```ruby
+Gollum::Hook.register(:post_commit, :hook_id) do |committer, sha1|
+  # Your code here
+end
+
+Gollum::Hook.unregister(:post_commit, :hook_id)
+```
+
+## WINDOWS FILENAME VALIDATION
+
+Note that filenames on windows must not contain any of the following characters `\ / : * ? " < > |`. See [this support article](http://support.microsoft.com/kb/177506) for details.
+
+## CONTRIBUTE
+
+If you'd like to hack on Gollum-lib, start by forking the repo on GitHub:
+
+http://github.com/gollum/gollum-lib
+
+To get all of the dependencies, install the gem first. The best way to get
+your changes merged back into core is as follows:
+
+1. Clone down your fork
+1. Create a thoughtfully named topic branch to contain your change
+1. Hack away
+1. Add tests and make sure everything still passes by running `rake`
+1. If you are adding new functionality, document it in the README
+1. Do not change the version number, I will do that on my end
+1. If necessary, rebase your commits into logical chunks, without errors
+1. Push the branch up to GitHub
+1. Send a pull request to the gollum/gollum-lib project.
+
+## RELEASING
+
+Gollum-lib uses [Semantic Versioning](http://semver.org/). Having `x.y.z` :
+
+For z releases:
+
+```bash
+$ rake bump
+$ rake release
+```
+
+For x.y releases:
+
+```bash
+$ rake gemspec
+$ rake release
+```
+
+## BUILDING THE GEM FROM MASTER
+
+```bash
+$ gem uninstall -aIx gollum-lib
+$ git clone https://github.com/gollum/gollum-lib.git
+$ cd gollum-lib
+gollum-lib$ rake build
+gollum-lib$ rake install
+```
+
+## RUN THE TESTS
+
+```bash
+$ bundle install
+$ bundle exec rake test
+```
+
+## WORK WITH TEST REPOS
+
+An example of how to add a test file to the bare repository `lotr.git`.
+
+```bash
+$ mkdir tmp; cd tmp
+$ git clone ../lotr.git/ .
+Cloning into '.'...
+done.
+$ git log
+$ echo "test" > test.md
+$ git add . ; git commit -am "Add test"
+$ git push ../lotr.git/ master
+```

data/Rakefile

@@ -0,0 +1,187 @@
+require 'rubygems'
+require 'rake'
+require 'date'
+
+#############################################################################
+#
+# Helper functions
+#
+#############################################################################
+
+def name
+  @name ||= Dir['*.gemspec'].first.split('.').first
+end
+
+def version
+  line = File.read("lib/gollum-lib/version.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/gollum-lib/version.rb")
+  old_version_line = old_file[/^\s*VERSION\s*=\s*.*/]
+  new_version = next_version
+  # replace first match of old version with new version
+  old_file.sub!(old_version_line, "    VERSION = '#{new_version}'")
+
+  File.write("lib/gollum-lib/version.rb", old_file)
+
+  new_version
+end
+
+def date
+  Date.today.to_s
+end
+
+def rubyforge_project
+  name
+end
+
+def gemspec_file
+  "gemspec.rb"
+end
+
+def gemspecs
+  ["#{name}.gemspec", "#{name}_java.gemspec"]
+end
+
+def gem_files
+  ["#{name}-#{version}.gem", "#{name}-#{version}-java.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
+
+desc "Build and install"
+task :install => :build do
+  sh "gem install --local --no-ri --no-rdoc pkg/#{name}-#{version}.gem"
+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 --rebase origin master"
+  sh "git tag v#{version}"
+  sh "git push origin master"
+  sh "git push origin v#{version}"
+  sh "gem push pkg/#{name}-#{version}.gem"
+  sh "gem push pkg/#{name}-#{version}-java.gem"
+end
+
+desc 'Publish to rubygems. Same as release'
+task :publish => :release
+
+desc 'Build gem'
+task :build => :gemspec do
+  sh "mkdir -p pkg"
+  gemspecs.each do |gemspec|
+    sh "gem build #{gemspec}"
+  end
+  gem_files.each do |gem_file|
+    sh "mv #{gem_file} pkg"
+  end
+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, :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|Guardfile)/ }.
+    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