gitlab-gollum-lib 1.1.0 → 4.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 857716d6a1f16207ab19e636ad813203a3fbb114
-  data.tar.gz: fc61538a081a5613cc9f4ac7a32a8d92def82017
+  metadata.gz: 13a758deb9f6e44c456678212eb346bed34a1b4a
+  data.tar.gz: daada1013c176851708db52282f89c63179fa09f
 SHA512:
-  metadata.gz: fc11dbb64bd056a4e8f4abb27b564c1acd467bf5f8b9a6948fa396206b4a768e01401fb7f6dcf5ed53734d998b05405c1f292a59c8e248dc8fcb39ac8d4d1e10
-  data.tar.gz: ab6744fb685b1fdd58f15f780b3551a2171cc8eb0c127425a26194f4e6745b71442f41d26abeb9c93fe64149cfdd2b5c9da6af29c8bb948ad63d185afaeee7df
+  metadata.gz: b19591dea0b63468ed1544a579d6087dd0bb85605f2ab0d3b89bddc37922172a6eefa0ac7fe396e51b819d163f43e353afef86d20ec5c0762ad2548530d1d4e2
+  data.tar.gz: db2418c60db2f9aeeb602f6c2f2c37856c6868e24465ff50d12fb55dd4991113ef057df95d4a548b4c566e3dea163832bb5375eb35333a81d4dcb5632e7ea42d

data/Gemfile

@@ -1,4 +1,2 @@
 source 'https://rubygems.org'
-
-gemspec
-gem 'rake', '~> 10.0.3'
+gemspec :name => 'gollum-lib'

data/HISTORY.md

@@ -0,0 +1,25 @@
+# v4.2.1
+
+* Performances improvements
+* Dependency updates
+
+# v4.2.0
+
+* Changes since v4.1.0:
+  ** Various performance improvements
+  ** Dependency updates
+  ** Bugfixes
+  ** New Macro for listing contents of (sub)directories: `Navigation()`
+  ** Table of Contents now supports setting max heading level 
+
+# 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

@@ -18,4 +18,4 @@ 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.
+SOFTWARE.

data/README.md

@@ -1,8 +1,9 @@
-gollum lib -- A wiki built on top of Git
+gollum lib -- A wiki built on top of Git [![build status](https://ci.gitlab.org/projects/7/status.png?ref=master)](https://ci.gitlab.org/projects/7?ref=master)
 ========================================
 
-[![Build Status](https://travis-ci.org/gollum/gollum-lib.png)](https://travis-ci.org/gollum/gollum-lib)
-[![Dependency Status](https://gemnasium.com/gollum/gollum-lib.png)](https://gemnasium.com/gollum/gollum-lib)
+[![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
 
@@ -18,10 +19,9 @@ Gollum-lib follows the rules of [Semantic Versioning](http://semver.org/) and us
 
 ## SYSTEM REQUIREMENTS
 
-- Python 2.5+ (2.7.3 recommended)
-- Ruby 1.8.7+ (1.9.3 recommended)
+- Ruby 1.9.3+ (>2.0 recommended)
 - Unix like operating system (OS X, Ubuntu, Debian, and more)
-- Will not work on Windows (because of [grit](https://github.com/github/grit))
+- Will not work on Windows with the default [grit](https://github.com/github/grit) adapter, but might work via JRuby (please let us know!)
 
 ## INSTALLATION
 
@@ -42,7 +42,7 @@ 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/) -- `brew install asciidoc` on mac or `apt-get install -y asciidoc` on Ubuntu
+* [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`
@@ -55,291 +55,12 @@ to install the dependencies for the formats that you plan to use.
 
 [bundler]: http://gembundler.com/
 
-## PAGE FILES
+## SYNTAX
 
-Page files may be written in any format supported by
-[GitHub-Markup](http://github.com/github/markup) (except roff). By default,
-Gollum recognizes the following extensions:
+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.
 
-* ASCIIDoc: .asciidoc
-* Creole: .creole
-* Markdown: .markdown, .mdown, .mkdn, .mkd, .md
-* Org Mode: .org
-* Pod: .pod
-* RDoc: .rdoc
-* ReStructuredText: .rest.txt, .rst.txt, .rest, .rst
-* Textile: .textile
-* MediaWiki: .mediawiki, .wiki
-
-You may also register your own extensions and parsers:
-
-```ruby
-Gollum::Markup.register(:angry, "Angry") do |content|
-  content.upcase
-end
-```
-
-Gollum detects the page file format via the extension, so files must have one
-of the default or registered extensions in order to be converted.
-
-Page file names may contain any printable UTF-8 character except space
-(U+0020) and forward slash (U+002F). If you commit a page file with any of
-these characters in the name it will not be accessible via the web interface.
-
-Even though page files may be placed in any directory, there is still only a
-single namespace for page names, so all page files should have globally unique
-names regardless of where they are located in the repository.
-
-The special page file `Home.ext` (where the extension is one of the supported
-formats) will be used as the entrance page to your wiki. If it is missing, an
-automatically generated table of contents will be shown instead.
-
-## SIDEBAR FILES
-
-Sidebar files allow you to add a simple sidebar to your wiki. Sidebar files
-are named `_Sidebar.ext` where the extension is one of the supported formats.
-Sidebars affect all pages in their directory and any subdirectories that do not
-have a sidebar file of their own.
-
-## HEADER FILES
-
-Header files allow you to add a simple header to your wiki. Header files must
-be named `_Header.ext` where the extension is one of the supported formats.
-Like sidebars, headers affect all pages in their directory and any
-subdirectories that do not have a header file of their own.
-
-## FOOTER FILES
-
-Footer files allow you to add a simple footer to your wiki. Footer files must
-be named `_Footer.ext` where the extension is one of the supported formats.
-Like sidebars, footers affect all pages in their directory and any
-subdirectories that do not have a footer file of their own.
-
-## HTML SANITIZATION
-
-For security and compatibility reasons Gollum wikis may not contain custom CSS
-or JavaScript. These tags will be stripped from the converted HTML. See
-`docs/sanitization.md` for more details on what tags and attributes are
-allowed.
-
-## TITLES
-
-The first defined `h1` will override the default header on a page. There are
-two ways to set a page title. The metadata syntax:
-
-    <!-- --- title: New Title -->
-
-The first `h1` tag can be set to always override the page title, without
-needing to use the metadata syntax. Start gollum with the `--h1-title` flag.
-
-## BRACKET TAGS
-
-A variety of Gollum tags use a double bracket syntax. For example:
-
-    [[Link]]
-
-Some tags will accept attributes which are separated by pipe symbols. For
-example:
-
-    [[Link|Page Title]]
-
-In all cases, the first thing in the link is what is displayed on the page.
-So, if the tag is an internal wiki link, the first thing in the tag will be
-the link text displayed on the page. If the tag is an embedded image, the
-first thing in the tag will be a path to an image file. Use this trick to
-easily remember which order things should appear in tags.
-
-Some formats, such as MediaWiki, support the opposite syntax:
-
-    [[Page Title|Link]]
-
-## PAGE LINKS
-
-To link to another Gollum wiki page, use the Gollum Page Link Tag.
-
-    [[Frodo Baggins]]
-
-The above tag will create a link to the corresponding page file named
-`Frodo-Baggins.ext` where `ext` may be any of the allowed extension types. The
-conversion is as follows:
-
-1. Replace any spaces (U+0020) with dashes (U+002D)
-2. Replace any slashes (U+002F) with dashes (U+002D)
-
-If you'd like the link text to be something that doesn't map directly to the
-page name, you can specify the actual page name after a pipe:
-
-    [[Frodo|Frodo Baggins]]
-
-The above tag will link to `Frodo-Baggins.ext` using "Frodo" as the link text.
-
-The page file may exist anywhere in the directory structure of the repository.
-Gollum does a breadth first search and uses the first match that it finds.
-
-Here are a few more examples:
-
-    [[J. R. R. Tolkien]] -> J.-R.-R.-Tolkien.ext
-    [[Movies / The Hobbit]] -> Movies---The-Hobbit.ext
-    [[モルドール]] -> モルドール.ext
-
-
-## EXTERNAL LINKS
-
-As a convenience, simple external links can be placed within brackets and they
-will be linked to the given URL with the URL as the link text. For example:
-
-    [[http://example.com]]
-
-External links must begin with either "http://" or "https://". If you need
-something more flexible, you can resort to the link syntax in the page's
-underlying markup format.
-
-
-## ABSOLUTE VS. RELATIVE VS. EXTERNAL PATH
-
-For Gollum tags that operate on static files (images, PDFs, etc), the paths
-may be referenced as either relative, absolute, or external. Relative paths
-point to a static file relative to the page file within the directory
-structure of the Gollum repo (even though after conversion, all page files
-appear to be top level). These paths are NOT prefixed with a slash. For
-example:
-
-    gollum.pdf
-    docs/diagram.png
-
-Absolute paths point to a static file relative to the Gollum repo's
-root, regardless of where the page file is stored within the directory
-structure. These paths ARE prefixed with a slash. For example:
-
-    /pdfs/gollum.pdf
-    /docs/diagram.png
-
-External paths are full URLs. An external path must begin with either
-"http://" or "https://". For example:
-
-    http://example.com/pdfs/gollum.pdf
-    http://example.com/images/diagram.png
-
-All of the examples in this README use relative paths, but you may use
-whatever works best in your situation.
-
-
-## FILE LINKS
-
-To link to static files that are contained in the Gollum repository you should
-use the Gollum File Link Tag.
-
-    [[Gollum|gollum.pdf]]
-
-The first part of the tag is the link text. The path to the file appears after
-the pipe.
-
-
-## IMAGES
-
-To display images that are contained in the Gollum repository you should use
-the Gollum Image Tag. This will display the actual image on the page.
-
-    [[gollum.png]]
-
-In addition to the simple format, there are a variety of options that you
-can specify between pipe delimiters.
-
-To specify alt text, use the `alt=` option. Default is no alt text.
-
-    [[gollum.png|alt=Gollum and his precious wiki]]
-
-To place the image in a frame, use the `frame` option. When combined with the
-`alt=` option, the alt text will be used as a caption as well. Default is no
-frame.
-
-    [[gollum.png|frame|alt=Gollum and his precious wiki]]
-
-To specify the alignment of the image on the page, use the `align=` option.
-Possible values are `left`, `center`, and `right`. Default is `left`.
-
-    [[gollum.png|align=center]]
-
-To float an image so that text flows around it, use the `float` option. When
-`float` is specified, only `left` and `right` are valid `align` options.
-Default is not floating. When floating is activated but no alignment is
-specified, default alignment is `left`.
-
-    [[gollum.png|float]]
-
-By default text will fill up all the space around the image. To control how
-much should show up use this tag to stop and start a new block so that
-additional content doesn't fill in.
-
-    [[_]]
-
-To specify a max-width, use the `width=` option. Units must be specified in
-either `px` or `em`.
-
-    [[gollum.png|width=400px]]
-
-To specify a max-height, use the `height=` option. Units must be specified in
-either `px` or `em`.
-
-    [[gollum.png|height=300px]]
-
-Any of these options may be composed together by simply separating them with
-pipes.
-
-
-## ESCAPING GOLLUM TAGS
-
-If you need the literal text of a wiki or static link to show up in your final
-wiki page, simply preface the link with a single quote (like in LISP):
-
-    '[[Page Link]]
-    '[[File Link|file.pdf]]
-    '[[image.jpg]]
-
-This is useful for writing about the link syntax in your wiki pages.
-
-## TABLE OF CONTENTS
-
-Gollum has a special tag to insert a table of contents:
-
-    [[_TOC_]]
-
-This tag is case sensitive, use all upper case.  The TOC tag can be inserted
-into the `_Header`, `_Footer` or `_Sidebar` files too.
-
-There is also a wiki option `:universal_toc` which will display a
-table of contents at the top of all your wiki pages if it is enabled:
-
-```ruby
-Gollum::Wiki.new("my-gollum-repo.git", {:universal_toc => true})
-```
-
-## MATHEMATICAL EQUATIONS
-
-Start gollum with the `--mathjax` flag. Read more about [MathJax](http://docs.mathjax.org/en/latest/index.html) on the web. Gollum uses the `TeX-AMS-MML_HTMLorMML` config with the `autoload-all` extension.
-
-Inline math:
-
-- $2^2$
-- `\\(2^2\\)`
-
-Display math:
-
-- $$2^2$$
-- [2^2]
-
-## SEQUENCE DIAGRAMS
-
-You may imbed sequence diagrams into your wiki page (rendered by
-[WebSequenceDiagrams](http://www.websequencediagrams.com) by using the
-following syntax:
-
-    {{{{{{ blue-modern
-      alice->bob: Test
-      bob->alice: Test response
-    }}}}}}
-
-You can replace the string "blue-modern" with any supported style.
+Check out the [Gollum Wiki](https://github.com/gollum/gollum/wiki) for all of Gollum's formats and syntactic options.
 
 ## API DOCUMENTATION
 
@@ -383,7 +104,7 @@ page.format
 # => :markdown
 
 vsn = page.version
-# => <Grit::Commit>
+# => <Gollum::Git::Commit>
 
 vsn.id
 # => '3ca43e12377ea1e32ea5c9ce5992ec8bf266e3e5'
@@ -407,7 +128,7 @@ Get a list of versions for a given page:
 
 ```ruby
 vsns = wiki.page('page-name').versions
-# => [<Grit::Commit, <Grit::Commit, <Grit::Commit>]
+# => [<Gollum::Git::Commit, <Gollum::Git::Commit, <Gollum::Git::Commit>]
 
 vsns.first.id
 # => '3ca43e12377ea1e32ea5c9ce5992ec8bf266e3e5'
@@ -432,7 +153,7 @@ file.raw_data
 # => "alert('hello');"
 
 file.version
-# => <Grit::Commit>
+# => <Gollum::Git::Commit>
 ```
 
 Get a specific version of a given static file:
@@ -480,28 +201,19 @@ To delete a page and commit the change:
 wiki.delete_page(page, commit)
 ```
 
-## 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.
+Register or unregister a hook to be called after a page commit:
 
-## CONTRIBUTE
-
-If you'd like to hack on Gollum-lib, start by forking the repo on GitHub:
+```ruby
+Gollum::Hook.register(:post_commit, :hook_id) do |committer, sha1|
+  # Your code here
+end
 
-http://github.com/gollum/gollum-lib
+Gollum::Hook.unregister(:post_commit, :hook_id)
+```
 
-To get all of the dependencies, install the gem first. The best way to get
-your changes merged back into core is as follows:
+## WINDOWS FILENAME VALIDATION
 
-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.
+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.
 
 ## RELEASING
 
@@ -528,7 +240,7 @@ $ gem uninstall -aIx gollum-lib
 $ git clone https://github.com/gollum/gollum-lib.git
 $ cd gollum-lib
 gollum-lib$ rake build
-gollum-lib$ gem install --no-ri --no-rdoc pkg/gollum-lib*.gem
+gollum-lib$ rake install
 ```
 
 ## RUN THE TESTS