gollum-lib 0.0.1 → 1.0.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YTAyOTk5OTcxZDkyNzQ2NmQzMDg4ZjBhMmQ1ZWE3NWJiYjcyNGFiMQ==
+    MGQxN2YxZWVjMDA0M2I0OTY5MzY4Y2JiZDg5NzkwMDA4OWZjYjg0NQ==
   data.tar.gz: !binary |-
-    ZGU3YmFiYTRmZjIwMmEwMDcyMGRmODJmNjU3NDU2ZDQ2MGE3NGQzYg==
+    MGRkOTE4YjVhMWMxNzQ2MjI3NTYxNWMwZDRhNjAyYzA3NDQwMWFiYw==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    ZDQ0OTg4MmMyZmZlM2ExZmVkMWRkZWJiNTZiNmMyMWQ5NDExNDY0NjcyZDY5
-    ZDRiOTVhNjgwMmVjMzAyMmViNTM5NjZmMTc3Zjc3ZTcxOTY2Y2E2ODMyMmY0
-    ZjE2NTQwMDNjZGZjOTU2OGY1Y2Y3OTZkNTM4NDZiMWM3YzMyYTc=
+    ZmJmNmQ3MmFhNDg5NTJmMzEzZmEyZDFkMGMyNzhlYjMxMzQ4MzUxYzllZGM0
+    ZGE5MjZmMDIyOWJkNzkyMzJhZTE0ODI0NGNkYjlhOTJjOTE4YTkxZDVhZTRk
+    ODk2YTMzMTc5MjFiMDIxZWNjYzg1Mjk4NjYzZDgyNzYwMDM3YzQ=
   data.tar.gz: !binary |-
-    YTFlNjVmOTllYTk4ZjRiOTRhZDgxNGE5MDcyN2IzYzIyNTc5N2JmMmE1NjAw
-    OGNhYjlhNzFkYWY2OGQ5ODIzNmE5ZTM1ODY0ZmZlNWQ1NzgzOTY2MjAzZjJk
-    OTI4ZDdiMGIyNzBiYmExZmE3MjdjMTM0ZGQ3YTJkNjg0ODVmNTQ=
+    ZTdiYzA3MTI3MmU2MWQwNzM1ZDIwYzY0Y2FhNTQzMzI5MTBiY2M4MzU2ZDY1
+    OGEwYmZhY2RjZGI0Mzc0MWRjN2I2YWI0ZTQwMzI1ODVmOGI3MGRkOTZjMjlk
+    ZGY5ZGY2MGViYmI3NmU0NTZkNDc1MWY1NDZjOGZmMWE1YzZmZWE=

data/HISTORY.md

@@ -1,106 +1,3 @@
-# 2.4.11 / 2013-01-08
+# v0.0.1 / 2013-03-19
 
-* Numerous security issues have been fixed. Please update to `2.4.11`
-
-# 1.4.0 / 2012-04-10
-
-* Minor
-  * Add a way to configure the `#id_prefix` property of Sanitization
-    objects.
-  * Add web sequence diagrams support
-  * Support for updating wysiwyg components when markup language changes
-  * Support RedCarpet 2.0
-  * Allow ftp and irc links in wiki markup
-  * Minor ui fixups
-
-* Bug Fixes
-  * Include the language of the code snippet when making a uniquely
-    identifiable sha of a code snippet while rendering a page.
-  * Pygments lexer forces utf8 encoding
-  * Remove MathJax, this created problems in production for us.
-    We'll look at bringing it back in future releases
-
-# 1.3.1 / 2011-07-21
-
-* Major Enhancements
-  * Allow prefixed ID attributes in headers to support internal linking
-    (#146).
-  * Markdown pages are rendered through Redcarpet by default (#176).
-* Minor Enhancements
-  * Remove Edit button on Preview pages (#164).
-  * Simplify Wiki#inspect and Page#inspect.
-* Bug Fixes
-  * Fixed broken preview functionality (#157).
-  * Fixed sidebar/footer rendering problems related to whitespace (#145).
-
-# 1.3.0 / 2011-04-25
-
-* Major Enhancements
-  * Listing of all Pages
-  * Support for running Gollum under a separate branch.
-* Minor Enhancements
-  * Fix a security issue with rendering Mathjax.
-
-# 1.2.0 / 2011-03-11
-
-* Major Enhancements
-  * Major HTML/CSS/JS overhaul.
-  * Add Sidebars (similar to Footers).
-  * Add commit reverts.
-* Minor Enhancements
-  * Optimization in source code highlighting, resulting in a huge
-    decrease in rendering time.
-  * Security fixes related to source code highlighting.
-
-* Major Enhancements
-  * Add Page sidebars, similar to Page footers.
-  * Add the ability to revert commits to the wiki.
-  * Add MediaWiki support.
-* Minor Enhancements
-  * Add `:sanitization` and `:history_sanitization` options for customizing
-    how `Sanitize.clean` modifies formatted wiki content.
-  * Add `--config` option for the command line, to specify a ruby file that is
-    run during startup.
-  * Provide access to a parsed Nokogiri::DocumentFragment during markup
-    rendering for added customization.
-* Bug Fixes
-  * Use `@wiki.page_class` in Gollum::Markup where appropriate (#63).
-  * Fix parsing of Org mode file links (#87).
-
-# 1.1.0 / 2010-10-28
-
-* Major Enhancements
-  * Optimize page write/update/delete to use Grit::Index::read_tree instead
-    of manually recreating entire index contents.
-  * Added --irb option for the gollum command.
-  * Update working dir (if present) when edited via the API (#6)
-  * Add basic `git grep` based search for repos.
-* Minor Enhancements
-  * Support a `:gollum_path` Sinatra setting for `Precious::App`
-  * Add Wiki#size to efficiently count pages without loading them.
-  * Add the correct content type when serving files from the frontend.
-  * Add --host option and default it to 127.0.0.1.
-  * Allow anchors in page links, such as `[[Abc#header]]`.
-  * All pages retrieved with a SHA add `rel="nofollow"` to all
-    page links.
-* Bug Fixes
-  * Increase minimum Sanitize version requirement to 1.1.0.
-    1.0.x versions of Sanitize require Hpricot instead of Nokogiri
-    and have bugs that may allow non-whitelisted HTML to sneak
-    through.
-  * Introduce Ruby 1.9 compatibility fixes.
-  * Commit hashes are normalized so that missing author data is replaced with
-    anonymous info.
-  * Prevent `Gollum::Wiki#write_page` from clobbering existing pages.
-  * Handle duplicate page errors in frontend.
-  * Fix bugs trying to retrieve pages with invalid names.
-  * CGI escape page names in links and redirects.
-
-# 1.0.1 / 2010-08-12
-
-* Bug Fixes
-  * Force Grit dep to 2.1 or higher.
-
-# 1.0.0 / 2010-08-12
-
-* Open Source Birthday!
+* First release, extrated from https://github.com/gollum/gollum

data/README.md

@@ -1,25 +1,23 @@
-gollum -- A wiki built on top of Git
-====================================
+gollum lib -- A wiki built on top of Git
+========================================
 
 [![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)
 
 ## DESCRIPTION
 
-Gollum is a simple wiki system built on top of Git that powers GitHub Wikis.
+[Gollum](https://github.com/gollum/gollum) is a simple wiki system built on
+top of Git that powers GitHub Wikis.
 
-Gollum wikis are simply Git repositories that adhere to a specific format.
-Gollum pages may be written in a variety of formats and can be edited in a
-number of ways depending on your needs. You can edit your wiki locally:
+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.
 
-* With your favorite text editor or IDE (changes will be visible after committing).
-* With the built-in web interface.
-* With the Gollum Ruby API.
-
-Gollum follows the rules of [Semantic Versioning](http://semver.org/) and uses
+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.8.7+ (1.9.3 recommended)
 - Unix like operating system (OS X, Ubuntu, Debian, and more)
@@ -27,14 +25,18 @@ Gollum follows the rules of [Semantic Versioning](http://semver.org/) and uses
 
 ## INSTALLATION
 
-The best way to install Gollum is with RubyGems:
+The best way to install Gollum-lib is with RubyGems:
 
-    $ [sudo] gem install gollum
+```bash
+$ [sudo] gem install gollum-lib
+```
 
 If you're installing from source, you can use [Bundler][bundler] to pick up all the
 gems:
 
-    $ bundle install
+```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
@@ -53,30 +55,6 @@ to install the dependencies for the formats that you plan to use.
 
 [bundler]: http://gembundler.com/
 
-## RUNNING
-
-To view and edit your Gollum repository locally via the built in web
-interface, simply install the Gollum gem, navigate to your repository via the
-command line, and run the executable:
-
-    $ gollum
-
-This will start up a web server running the Gollum frontend and you can view
-and edit your wiki at http://localhost:4567. To get help on the command line
-utility, you can run it like so:
-
-    $ gollum --help
-
-Note that the gollum server will not run on Windows because of [an issue](https://github.com/rtomayko/posix-spawn/issues/9) with posix-spawn (which is used by Grit).
-
-## REPO STRUCTURE
-
-A Gollum repository's contents are designed to be human editable. Page content
-is written in `page files` and may be organized into directories any way you
-choose. Special footers can be created in `footer files`. Other content
-(images, PDFs, etc) may also be present and organized in the same way.
-
-
 ## PAGE FILES
 
 Page files may be written in any format supported by
@@ -95,9 +73,11 @@ Gollum recognizes the following extensions:
 
 You may also register your own extensions and parsers:
 
-    Gollum::Markup.register(:angry, "Angry") do |content|
-      content.upcase
-    end
+```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.
@@ -116,7 +96,7 @@ 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
+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.
@@ -144,11 +124,14 @@ 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:
+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 -->
 
-`<!-- --- 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.
 
-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:
@@ -180,8 +163,8 @@ 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)
+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:
@@ -317,7 +300,7 @@ 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 (new in v2.1)
+Gollum has a special tag to insert a table of contents:
 
     [[_TOC_]]
 
@@ -325,12 +308,11 @@ 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.
-The `:universal_toc` is not enabled by default.  To set the option,
-add the option to the `:wiki_options` hash before starting the
-frontend app:
+table of contents at the top of all your wiki pages if it is enabled:
 
-    Precious::App.set(:wiki_options, {:universal_toc => true})
+```ruby
+Gollum::Wiki.new("my-gollum-repo.git", {:universal_toc => true})
+```
 
 ## SYNTAX HIGHLIGHTING
 
@@ -364,9 +346,9 @@ As an extra feature, you can syntax highlight a file from your repository, allow
 you keep some of your sample code in the main repository. The code-snippet is
 updated when the wiki is rebuilt. You include github code like this:
 
-    ```html:gollum/gollum/master/test/file_view/1_file.txt```
+    ```html:github:gollum/gollum-lib/master/test/file_view/1_file.txt```
 
-This will make the builder look at the **github user**, in the **gollum project**,
+This will make the builder look at the **gollum user**, in the **gollum-lib project**,
 in the **master branch**, at path **test/file_view/1_file.txt**. It will be
 rewritten to:
 
@@ -376,7 +358,7 @@ rewritten to:
     </ol>
     ```
 
-Which will be parsed as HTML code during the Pygments run, and thereby coloured 
+Which will be parsed as HTML code during the Pygments run, and thereby coloured
 appropriately.
 
 ## MATHEMATICAL EQUATIONS
@@ -408,161 +390,152 @@ You can replace the string "blue-modern" with any supported style.
 
 ## API DOCUMENTATION
 
-The Gollum API 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.
-
-Initialize the Gollum::Repo object:
+Initialize the `Gollum::Repo` object:
 
-    # Require rubygems if necessary
-    require 'rubygems'
+```ruby
+# Require rubygems if necessary
+require 'rubygems'
 
-    # Require the Gollum library
-    require 'gollum'
+# 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:
-
-    wiki = Gollum::Wiki.new("my-gollum-repo.git", :base_path => "/wiki")
+# 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>
+```
 
-Note that base_path just modifies the links. To map gollum to a non-root location:
+By default, internal wiki links are all absolute from the root. To specify a different
+base path, you can specify the `:base_path` option:
 
-- Use the gollum binary: `gollum path/to/wiki --base-path mywiki`
-- Define config.ru with `map`. See [#532](https://github.com/gollum/gollum/issues/532) for an example.
+```ruby
+wiki = Gollum::Wiki.new("my-gollum-repo.git", :base_path => "/wiki")
+```
 
-> :base_path     - String base path for all Wiki links.
->
-> The String base path to prefix to internal links. For example, when set
-> to "/wiki", the page "Hobbit" will be linked as "/wiki/Hobbit". Defaults
-> to "/".
+Note that `base_path` just modifies the links.
 
 Get the latest version of the given human or canonical page name:
 
-    page = wiki.page('page-name')
-    # => <Gollum::Page>
+```ruby
+page = wiki.page('page-name')
+# => <Gollum::Page>
 
-    page.raw_data
-    # => "# My wiki page"
+page.raw_data
+# => "# My wiki page"
 
-    page.formatted_data
-    # => "<h1>My wiki page</h1>"
+page.formatted_data
+# => "<h1>My wiki page</h1>"
 
-    page.format
-    # => :markdown
+page.format
+# => :markdown
 
-    vsn = page.version
-    # => <Grit::Commit>
+vsn = page.version
+# => <Grit::Commit>
 
-    vsn.id
-    # => '3ca43e12377ea1e32ea5c9ce5992ec8bf266e3e5'
+vsn.id
+# => '3ca43e12377ea1e32ea5c9ce5992ec8bf266e3e5'
+```
 
 Get the footer (if any) for a given page:
 
-    page.footer
-    # => <Gollum::Page>
-    
+```ruby
+page.footer
+# => <Gollum::Page>
+```
+
 Get the header (if any) for a given page:
 
-    page.header
-    # => <Gollum::Page>
+```ruby
+page.header
+# => <Gollum::Page>
+```
 
 Get a list of versions for a given page:
 
-    vsns = wiki.page('page-name').versions
-    # => [<Grit::Commit, <Grit::Commit, <Grit::Commit>]
+```ruby
+vsns = wiki.page('page-name').versions
+# => [<Grit::Commit, <Grit::Commit, <Grit::Commit>]
 
-    vsns.first.id
-    # => '3ca43e12377ea1e32ea5c9ce5992ec8bf266e3e5'
+vsns.first.id
+# => '3ca43e12377ea1e32ea5c9ce5992ec8bf266e3e5'
 
-    vsns.first.authored_date
-    # => Sun Mar 28 19:11:21 -0700 2010
+vsns.first.authored_date
+# => Sun Mar 28 19:11:21 -0700 2010
+```
 
 Get a specific version of a given canonical page file:
 
-    wiki.page('page-name', '5ec521178e0eec4dc39741a8978a2ba6616d0f0a')
+```ruby
+wiki.page('page-name', '5ec521178e0eec4dc39741a8978a2ba6616d0f0a')
+```
 
 Get the latest version of a given static file:
 
-    file = wiki.file('asset.js')
-    # => <Gollum::File>
+```ruby
+file = wiki.file('asset.js')
+# => <Gollum::File>
 
-    file.raw_data
-    # => "alert('hello');"
+file.raw_data
+# => "alert('hello');"
 
-    file.version
-    # => <Grit::Commit>
+file.version
+# => <Grit::Commit>
+```
 
 Get a specific version of a given static file:
 
-    wiki.file('asset.js', '5ec521178e0eec4dc39741a8978a2ba6616d0f0a')
+```ruby
+wiki.file('asset.js', '5ec521178e0eec4dc39741a8978a2ba6616d0f0a')
+```
 
 Get an in-memory Page preview (useful for generating previews for web
 interfaces):
 
-    preview = wiki.preview_page("My Page", "# Contents", :markdown)
-    preview.formatted_data
-    # => "<h1>Contents</h1>"
+```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:
 
-    commit = { :message => 'commit message',
-               :name => 'Tom Preston-Werner',
-               :email => 'tom@github.com' }
+```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.
 
-    wiki.write_page('Page Name', :markdown, 'Page contents', commit)
+```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.
 
-    page = wiki.page('Page Name')
-    wiki.update_page(page, page.name, page.format, 'Page contents', commit)
+```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:
 
-    wiki.delete_page(page, commit)
-
-### RACK
-
-You can also run gollum with any rack-compatible server by placing this config.ru
-file inside your wiki repository. This allows you to utilize any Rack middleware
-like Rack::Auth, OmniAuth, etc.
-
-    #!/usr/bin/env ruby
-    require 'rubygems'
-    require 'gollum/frontend/app'
-
-    gollum_path = File.expand_path(File.dirname(__FILE__)) # CHANGE THIS TO POINT TO YOUR OWN WIKI REPO
-    Precious::App.set(:gollum_path, gollum_path)
-    Precious::App.set(:default_markup, :markdown) # set your favorite markup language
-    Precious::App.set(:wiki_options, {:universal_toc => false})
-    run Precious::App
-
-Your Rack middleware can pass author details to Gollum in a Hash in the session under the 'gollum.author' key.
+```ruby
+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.
-
-## CONFIG FILE
-
-Gollum optionally takes a `--config file`. See [config.rb](https://github.com/gollum/gollum/blob/master/config.rb) for an example.
-
-## CUSTOM CSS
 
-The `--css` flag will inject `custom.css` from the root of your git repository into each page. `custom.css` must be commited to git or you will get a 302 redirect to the create page.
+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, start by forking the repo on GitHub:
+If you'd like to hack on Gollum-lib, start by forking the repo on GitHub:
 
-http://github.com/gollum/gollum
+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:
@@ -575,35 +548,46 @@ your changes merged back into core is as follows:
 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 project.
+1. Send a pull request to the gollum/gollum-lib project.
 
 ## RELEASING
-    x.y.z
 
-    For z releases:
-    $ rake bump
-    $ rake release
+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
+```
 
-    For x.y releases:
-    Update VERSION in lib/gollum.rb
-    $ rake gemspec
-    $ rake release
-    
 ## BUILDING THE GEM FROM MASTER
-    $ gem uninstall -aIx gollum
-    $ git clone https://github.com/gollum/gollum.git
-    $ cd gollum
-    gollum$ rake build
-    gollum$ gem install --no-ri --no-rdoc pkg/gollum*.gem
-    
+
+```bash
+$ 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
+```
+
 ## RUN THE TESTS
 
-    bundle install
-    bundle exec rake test
+```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.
+An example of how to add a test file to the bare repository `lotr.git`.
 
 ```bash
 $ mkdir tmp; cd tmp

data/docs/sanitization.md

@@ -4,7 +4,7 @@ Sanitization Rules
 Gollum uses the [Sanitize](http://wonko.com/post/sanitize) gem for HTML
 sanitization.
 
-See `lib/gollum.rb` for actual settings.
+See `lib/gollum-lib/sanitization.rb` for actual settings.
 
 ## ALLOWED TAGS
 
@@ -28,5 +28,6 @@ valign, value, vspace, width
 
 ## ALLOWED PROTOCOLS
 
-a href: http, https, mailto
-img src: http, https
+a href: http, https, mailto, ftp, irc, apt
+img src: http, https
+form action: http, https

data/gollum-lib.gemspec

@@ -5,8 +5,8 @@ Gem::Specification.new do |s|
   s.required_ruby_version = ">= 1.8.7"
 
   s.name              = 'gollum-lib'
-  s.version           = '0.0.1'
-  s.date              = '2013-03-19'
+  s.version           = '1.0.0'
+  s.date              = '2013-04-02'
   s.rubyforge_project = 'gollum-lib'
 
   s.summary     = "A simple, Git-powered wiki."
@@ -26,19 +26,20 @@ Gem::Specification.new do |s|
   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('nokogiri', '~> 1.5.9')
   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('shoulda', '~> 3.4.0')
   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')
+  s.add_development_dependency 'minitest-reporters', '~> 0.14.10'
+  s.add_development_dependency('nokogiri-diff', '~> 0.1.2')
 
   # = MANIFEST =
   s.files = %w[
@@ -47,7 +48,6 @@ Gem::Specification.new do |s|
     LICENSE
     README.md
     Rakefile
-    config.rb
     docs/sanitization.md
     gollum-lib.gemspec
     lib/gollum-lib.rb
@@ -63,6 +63,7 @@ Gem::Specification.new do |s|
     lib/gollum-lib/markups.rb
     lib/gollum-lib/page.rb
     lib/gollum-lib/pagination.rb
+    lib/gollum-lib/remote_code.rb
     lib/gollum-lib/sanitization.rb
     lib/gollum-lib/web_sequence_diagram.rb
     lib/gollum-lib/wiki.rb

data/lib/gollum-lib.rb

@@ -29,7 +29,7 @@ require File.expand_path('../gollum-lib/web_sequence_diagram', __FILE__)
 $KCODE = 'U' if RUBY_VERSION[0,3] == '1.8'
 
 module Gollum
-  VERSION = '0.0.1'
+  VERSION = '1.0.0'
 
   def self.assets_path
     ::File.expand_path('gollum/frontend/public', ::File.dirname(__FILE__))

data/lib/gollum-lib/gitcode.rb

@@ -9,9 +9,9 @@ module Gollum
     def initialize path
       raise(ArgumentError, 'path is nil or empty') if path.nil? or path.empty?
 
-      @uri = URI::HTTP.build({ 
-        :path   => self.unchomp(path), 
-        :host   => 'raw.github.com', 
+      @uri = URI::HTTP.build({
+        :path   => self.unchomp(path),
+        :host   => 'raw.github.com',
         :scheme => 'https',
         :port   => 443 })
     end

data/lib/gollum-lib/markup.rb

@@ -5,7 +5,7 @@ require 'pygments'
 require 'base64'
 
 require File.expand_path '../helpers', __FILE__
-require File.expand_path '../gitcode', __FILE__
+require File.expand_path '../remote_code', __FILE__
 
 # initialize Pygments
 Pygments.start
@@ -78,7 +78,7 @@ module Gollum
 
       data = @data.dup
       data = extract_metadata(data)
-      data = extract_gitcode(data)
+      data = extract_remote_code(data)
       data = extract_code(data)
       data = extract_wsd(data)
       data = extract_tags(data)
@@ -138,7 +138,7 @@ module Gollum
           node = Nokogiri::XML::Node.new('ul', doc)
           tail = tail.add_child(node)
           tail_level += 1
-        end          
+        end
         while tail_level > level
           tail = tail.parent
           tail_level -= 1
@@ -457,33 +457,34 @@ module Gollum
 
     #########################################################################
     #
-    # Gitcode - fetch code from github search path and replace the contents
-    #           to a code-block that gets run the next parse.
+    # Remote code - fetch code from url and replace the contents to a
+    #               code-block that gets run the next parse.
     #           Acceptable formats:
     #              ```language:local-file.ext```
     #              ```language:/abs/other-file.ext```
-    #              ```language:gollum/gollum/master/somefile.txt```
+    #              ```language:https://example.com/somefile.txt```
     #
     #########################################################################
 
-    def extract_gitcode data
-      data.gsub /^[ \t]*``` ?([^:\n\r]+):([^`\n\r]+)```/ do
-        contents = ''
-        # Use empty string if $2 is nil.
-        uri = $2 || ''
-        # Detect local file.
-        if uri[0..6] != 'gollum/'
-            if file = self.find_file(uri, @wiki.ref)
-              contents = file.raw_data
-            else
-              # How do we communicate a render error?
-              next "File not found: #{CGI::escapeHTML(uri)}"
-            end
+    def extract_remote_code data
+      data.gsub /^[ \t]*``` ?([^:\n\r]+):((http)?[^`\n\r]+)```/ do
+        language = $1
+        uri = $2
+        protocol = $3
+
+        # Detect local file
+        if protocol.nil?
+          if file = self.find_file(uri, @wiki.ref)
+            contents = file.raw_data
+          else
+            # How do we communicate a render error?
+            next "File not found: #{CGI::escapeHTML(uri)}"
+          end
         else
-          contents = Gollum::Gitcode.new(uri).contents
+          contents = Gollum::RemoteCode.new(uri).contents
         end
 
-        "```#{$1}\n#{contents}\n```\n"
+        "```#{language}\n#{contents}\n```\n"
       end
     end
 

data/lib/gollum-lib/markups.rb

@@ -1,3 +1,4 @@
+# ~*~ encoding: utf-8 ~*~
 module Gollum
   class Markup
     register(:markdown,  "Markdown", :regexp => /md|mkdn?|mdown|markdown/)
@@ -10,4 +11,4 @@ module Gollum
     register(:mediawiki, "MediaWiki", :regexp => /(media)?wiki/)
     register(:pod,       "Pod")
   end
-end
+end

data/lib/gollum-lib/remote_code.rb

@@ -0,0 +1,39 @@
+# ~*~ encoding: utf-8 ~*~
+require 'net/http'
+require 'net/https' # ruby 1.8.7 fix, remove at upgrade
+require 'uri'
+require 'open-uri'
+
+module Gollum
+  class RemoteCode
+    def initialize path
+      raise(ArgumentError, 'path is nil or empty') if path.nil? or path.empty?
+      @uri = URI(path)
+    end
+
+    def contents
+      @contents ||= req @uri
+    end
+
+    private
+
+      def req uri, cut = 1
+        return "Too many redirects or retries" if cut >= 10
+        http = Net::HTTP.new uri.host, uri.port
+        http.use_ssl = true
+        resp = http.get uri.path, {
+          'Accept'        => 'text/plain',
+          'Cache-Control' => 'no-cache',
+          'Connection'    => 'keep-alive',
+          'User-Agent'    => 'Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:15.0) Gecko/20100101 Firefox/15.0'
+        }
+        code = resp.code.to_i
+        return resp.body if code == 200
+        return "Not Found" if code == 404
+        return "Unhandled Response Code #{code}" unless code == 304 or not resp.header['location'].nil?
+        loc = URI.parse resp.header['location']
+        uri2 = loc.relative? ? (uri + loc) : loc # overloads (+)
+        req uri2, (cut + 1)
+      end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gollum-lib
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Tom Preston-Werner
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-19 00:00:00.000000000 Z
+date: 2013-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grit
@@ -93,14 +93,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.5.6
+        version: 1.5.9
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.5.6
+        version: 1.5.9
 - !ruby/object:Gem::Dependency
   name: stringex
   requirement: !ruby/object:Gem::Requirement
@@ -163,14 +163,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 3.3.2
+        version: 3.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 3.3.2
+        version: 3.4.0
 - !ruby/object:Gem::Dependency
   name: wikicloth
   requirement: !ruby/object:Gem::Requirement
@@ -231,16 +231,30 @@ dependencies:
   name: minitest-reporters
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.14.10
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.14.10
+- !ruby/object:Gem::Dependency
+  name: nokogiri-diff
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.1.2
 description: A simple, Git-powered wiki with a sweet API and local frontend.
 email: tom@github.com
 executables: []
@@ -254,7 +268,6 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- config.rb
 - docs/sanitization.md
 - gollum-lib.gemspec
 - lib/gollum-lib.rb
@@ -270,6 +283,7 @@ files:
 - lib/gollum-lib/markups.rb
 - lib/gollum-lib/page.rb
 - lib/gollum-lib/pagination.rb
+- lib/gollum-lib/remote_code.rb
 - lib/gollum-lib/sanitization.rb
 - lib/gollum-lib/web_sequence_diagram.rb
 - lib/gollum-lib/wiki.rb

data/config.rb

@@ -1,28 +0,0 @@
-# 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