gitlab-markup 1.5.0.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5d773b18a0aefc150bf87e380d9efa3ed0c63425
+  data.tar.gz: 9021cc4c1aef932a5227a03e6ce7245f914d41fa
+SHA512:
+  metadata.gz: 06675a6df4b9b39573c2b7b9f4178ed49fe5eec73c3185548c3a550aaed65f642c11466af9a9bdaea4d6f2f4463117b96d75140ad90f234d0009a339d6826d2f
+  data.tar.gz: af0a1dba6a7e9c4335f761af703f8a58d73bcc0d9d3a7f1f0d0bac2def20cbe68ee1e8b3a80e01baf7de90f28b7780dfabb7a0c733da199c79a18b9873bcea4b

data/.gitignore

@@ -0,0 +1,5 @@
+*.pyc
+pkg/
+.bundle
+Gemfile.lock
+vendor/

data/.gitlab-ci.yml

@@ -0,0 +1,27 @@
+variables:
+  LANG: "C.UTF-8"
+
+.specs: &specs
+  cache:
+    paths:
+      - vendor/ruby
+  before_script:
+    - apt update
+    - apt install python-pip git build-essential -y
+    - pip install docutils
+    - bundle install --jobs $(nproc)
+  script:
+    - bundle exec rake test
+
+ruby-20:
+  image: ruby:2.0
+  <<: *specs
+ruby-21:
+  image: ruby:2.1
+  <<: *specs
+ruby-22:
+  image: ruby:2.2
+  <<: *specs
+ruby-23:
+  image: ruby:2.3
+  <<: *specs

data/.kick

@@ -0,0 +1,26 @@
+# take control of the growl notifications
+module GrowlHacks
+  def growl(type, subject, body, *args, &block)
+    case type
+    when Kicker::GROWL_NOTIFICATIONS[:succeeded]
+      puts subject = "Success"
+      body = body.split("\n").last
+    when Kicker::GROWL_NOTIFICATIONS[:failed]
+      subject = "Failure"
+      puts body
+      body = body.split("\n").last
+    else
+      return nil
+    end
+    super(type, subject, body, *args, &block)
+  end
+end
+
+Kicker.send :extend, GrowlHacks
+
+# no logging
+Kicker::Utils.module_eval do
+  def log(message)
+    nil
+  end
+end

data/.travis.yml

@@ -0,0 +1,21 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1.1
+  - jruby-19mode
+jdk:
+  - oraclejdk8
+notifications:
+  email: false
+git:
+  depth: 10
+before_install: sudo pip install docutils
+cache:
+  - bundler
+  - pip
+env:
+  global:
+    - "JRUBY_OPTS=-Xcext.enabled=true"
+matrix:
+ allow_failures:
+   - rvm: jruby-19mode

data/CONTRIBUTING.md

@@ -0,0 +1,49 @@
+# Contributing
+
+This project adheres to the [Open Code of Conduct][code-of-conduct]. By participating, you are expected to honor this code.
+[code-of-conduct]: http://todogroup.org/opencodeofconduct/#GitHub%20Markup/opensource@github.com
+
+This library's only job is to decide which markup format to use and call out to an external library to convert the markup to HTML (see the [README](README.md) for more information on how markup is rendered on GitHub.com).
+
+If you are having an issue with:
+
+* **Syntax highlighting** - see [github/linguist](https://github.com/github/linguist/blob/master/CONTRIBUTING.md#fixing-syntax-highlighting)
+* **Markdown on GitHub** - contact support@github.com
+* **Styling issues on GitHub** - see [primer/markdown](https://github.com/primer/markdown)
+
+Anything else - [search open issues](https://github.com/github/markup/issues) or create an issue and and we'll help point you in the right direction.
+
+## Submitting a Merge Request
+
+1. Fork it.
+2. Create a branch (`git checkout -b my_markup`)
+3. Commit your changes (`git commit -am "Added Snarkdown"`)
+4. Push to the branch (`git push origin my_markup`)
+5. Open a [Merge Request][1]
+6. Enjoy a refreshing Diet Coke and wait
+
+## Testing
+
+To run the tests:
+
+    $ rake
+
+If nothing complains, congratulations!
+
+## Releasing a new version
+
+If you are the current maintainer of this gem:
+
+0. Bump the version number in `lib/github-markup.rb`, adhering to [Semantic Versioning](http://semver.org/)
+0. Update `HISTORY.md`
+0. Test the latest version on GitHub
+  0. Build the new version with `rake build`
+  0. Copy `pkg/gitlab-markup*.gem` to `vendor/cache` in your local checkout of GitHub
+  0. Update the version for `gitlab-markup` in the `Gemfile`
+  0. Run `bundle update --local gitlab-markup`
+  0. Run any relevant tests and test it manually from the browser.
+0. Push the new gem release with `rake release`. If you don't have permission to release to rubygems.org, contact one of the existing owners (`gem owners github-markup`) and ask them to add you.
+
+[1]: https://gitlab.com/gitlab-org/gitlab-markup/merge_requests
+[r2h]: lib/github/commands/rest2html
+[r2hc]: lib/github/markups.rb#L51

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+gemspec
+
+gem "posix-spawn", :platforms => :ruby
+gem "redcarpet", :platforms => :ruby
+gem "kramdown", :platforms => :jruby
+gem "RedCloth"
+gem "rdoc", "~>3.6"
+gem "org-ruby", "~> 0.9"
+gem "creole", "~>0.5.0"
+gem "wikicloth", "=0.8.1", :platforms => :ruby
+gem "asciidoctor", "= 1.5.2"
+gem "rake"

data/HISTORY.md

@@ -0,0 +1,128 @@
+## 1.5.0 (2016-10-13)
+
+* GitLab CI support
+* Fixed `.pod` test files to use newer syntax.
+* Changes to support Python 3 (it's not out-of-the box yet, you still need to patch code)
+* Gem published as 'gitlab-markup'
+
+## 1.3.3 (2015-02-17)
+
+* Address a slight typo with `POSIX` [#456](https://github.com/github/markup/pull/456)
+
+[Full changelog](https://github.com/github/markup/compare/v1.3.2...v1.3.3)
+
+## 1.3.2 (2015-02-17)
+
+* RST: Output code instead of tt for inline literals [#370](https://github.com/github/markup/pull/370)
+* RST: Add IDs to headers so that `.. contents` works with `.. sectnum` [#391](https://github.com/github/markup/pull/391)
+
+[Full changelog](https://github.com/github/markup/compare/v1.3.1...v1.3.2)
+
+## 1.3.1 (2014-11-13)
+
+* Fix name error when trying to use newer versions of RedCarpet [#387](https://github.com/github/markup/pull/387)
+
+[Full changelog](https://github.com/github/markup/compare/v1.3.0...v1.3.1)
+
+## 1.3.0 (2014-09-11)
+
+* Extend the field limit for tables to 50 characters for RST [#306](https://github.com/github/markup/pull/306)
+* Add `.mkdn` as a supported markdown extension [#308](https://github.com/github/markup/pull/308)
+* Upgrade wikicloth to 0.8.1 [#317](https://github.com/github/markup/pull/317)
+* Force encoding of posix-spawn output [#338](https://github.com/github/markup/pull/338)
+* Add `.rmd` as a supported markdown extension [#343](https://github.com/github/markup/pull/343)
+
+[Full changelog](https://github.com/github/markup/compare/v1.2.1...v1.3.0)
+
+## 1.2.1 (2014-04-23)
+
+* Disable RST warnings [#290](https://github.com/github/markup/pull/290)
+
+[Full changelog](https://github.com/github/markup/compare/v1.2.0...v1.2.1)
+
+## 1.1.1 (2014-04-03)
+
+* Upgrade to org-ruby 0.9.1
+* Set default encoding to UTF-8 for Python 2
+
+## 1.1.0 (2014-03-10)
+
+* Raise GitHub::Markup::CommandError if external command exits with a non-zero status.
+* Remove support for literate Haskell (see #266)
+
+## 0.5.1 (2010-09-30)
+
+* Support relative path links in rdoc
+
+## 0.5.0 (2010-07-07)
+
+* Added creole support
+
+## 0.4.0 (2010-04-23)
+
+* Removed man page support until it's ready.
+
+## 0.3.3 (2010-03-29)
+
+* UTF-8 works with ReST now.
+
+## 0.3.2 (2010-03-25)
+
+* Improved test runner
+* Forgive ReST problems that aren't user errors.
+
+## 0.3.1 (2010-03-22)
+
+* Add .rst.txt extension
+* Fix ASCII encoding error while using print u'\u010c' non-ASCII char and similar.
+
+## 0.3.0 (2010-03-11)
+
+* man rendering
+* `github-markup` command line runner
+
+## 0.2.2 (2010-02-09)
+
+* pod fixes from Ricardo Signes
+
+## 0.2.1 (2010-01-25)
+
+* ReST fixes from Michael Jones
+
+## 0.2.0 (2010-01-10)
+
+* org-mode support
+
+## 0.1.7 (2009-11-17)
+
+* Ditch asciidoc2html, call asciidoc directly
+
+## 0.1.6 (2009-11-17)
+
+* mdown
+
+## 0.1.5 (2009-11-17)
+
+* Actually, if we can't render a thing then don't. Not once, not never.
+
+## 0.1.4 (2009-11-17)
+
+* Bugfix: Missing commands return the input (instead of nothing)
+
+## 0.1.3 (2009-11-02)
+
+* Strip the INDEX comments from POD
+
+## 0.1.2 (2009-11-02)
+
+* Renamed to `github-markup`
+* Bugfix: POD rendering works now, not just index
+
+## 0.1.1 (2009-11-02)
+
+* Added `GitHub::Markup.can_render?` helper.
+* Bugfix: Actually check file extensions
+
+## 0.1.0 (2009-11-02)
+
+* First release

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 GitHub
+
+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,58 @@
+GitHub Markup
+=============
+
+[![build status](https://gitlab.com/gitlab-org/gitlab-markup/badges/master/build.svg)](https://gitlab.com/gitlab-org/gitlab-markup/commits/master)
+
+This library is the first step of a journey that every markup file in a repository goes on before it is rendered on GitHub.com:
+
+0. This library converts the raw markup to HTML. See the list of [supported markup formats](#markups) below.
+0. The HTML is sanitized, aggressively removing things that could harm you and your kin—such as `script` tags, inline-styles, and `class` or `id` attributes. See the [sanitization filter](https://github.com/jch/html-pipeline/blob/master/lib/html/pipeline/sanitization_filter.rb) for the full whitelist.
+0. Syntax highlighting is performed on code blocks. See [github/linguist](https://github.com/github/linguist#syntax-highlighting) for more information about syntax highlighting.
+0. The HTML is passed through other filters in the [html-pipeline](https://github.com/jch/html-pipeline) that add special sauce, such as [emoji](https://github.com/jch/html-pipeline/blob/master/lib/html/pipeline/emoji_filter.rb), [task lists](https://github.com/github/task_list/blob/master/lib/task_list/filter.rb), [named anchors](https://github.com/jch/html-pipeline/blob/master/lib/html/pipeline/toc_filter.rb), [CDN caching for images](https://github.com/jch/html-pipeline/blob/master/lib/html/pipeline/camo_filter.rb), and  [autolinking](https://github.com/jch/html-pipeline/blob/master/lib/html/pipeline/autolink_filter.rb).
+0. The resulting HTML is rendered on GitHub.com.
+
+Please see our [contributing guidelines](CONTRIBUTING.md) before reporting an issue.
+
+Markups
+-------
+
+The following markups are supported.  The dependencies listed are required if
+you wish to run the library. You can also run `script/bootstrap` to fetch them all.
+
+* [.markdown, .mdown, .mkdn, .md](http://daringfireball.net/projects/markdown/) -- `gem install redcarpet` (https://github.com/vmg/redcarpet)
+* [.textile](http://www.textism.com/tools/textile/) -- `gem install RedCloth`
+* [.rdoc](http://rdoc.sourceforge.net/) -- `gem install rdoc -v 3.6.1`
+* [.org](http://orgmode.org/) -- `gem install org-ruby`
+* [.creole](http://wikicreole.org/) -- `gem install creole`
+* [.mediawiki, .wiki](http://www.mediawiki.org/wiki/Help:Formatting) -- `gem install wikicloth`
+* [.rst](http://docutils.sourceforge.net/rst.html) -- `easy_install docutils`
+* [.asciidoc, .adoc, .asc](http://asciidoc.org/) -- `gem install asciidoctor` (http://asciidoctor.org)
+* [.pod](http://search.cpan.org/dist/perl/pod/perlpod.pod) -- `Pod::Simple::HTML`
+  comes with Perl >= 5.10. Lower versions should install [Pod::Simple](http://search.cpan.org/~dwheeler/Pod-Simple-3.28/lib/Pod/Simple.pod) from CPAN.
+
+Installation
+-----------
+
+```
+gem install github-markup
+```
+
+Usage
+-----
+
+```ruby
+require 'github/markup'
+GitHub::Markup.render('README.markdown', "* One\n* Two")
+```
+
+Or, more realistically:
+
+```ruby
+require 'github/markup'
+GitHub::Markup.render(file, File.read(file))
+```
+
+Contributing
+------------
+
+See [Contributing](CONTRIBUTING.md)

data/Rakefile

@@ -0,0 +1,17 @@
+#!/usr/bin/env rake
+
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -I lib -r bundler/setup -r github/markup"
+end
+
+task :default => :test

data/bin/github-markup

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift File.dirname(__FILE__) + "/../lib"
+require 'github/markup'
+
+if ARGV[0] && File.exists?(file = ARGV[0])
+  puts GitHub::Markup.render(file)
+else
+  puts "usage: #$0 FILE"
+end

data/gitlab-markup.gemspec

@@ -0,0 +1,25 @@
+require File.expand_path("../lib/github-markup", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name          = "gitlab-markup"
+  s.version       = GitHub::Markup::VERSION
+  s.summary       = "The code GitHub uses to render README.markup"
+  s.description   = "This gem is used by GitHub to render any fancy markup such " +
+                    "as Markdown, Textile, Org-Mode, etc. Fork it and add your own!"
+  s.authors       = ["Chris Wanstrath"]
+  s.email         = "chris@ozmm.org"
+  s.homepage      = "https://gitlab.com/gitlab-org/gitlab-markup"
+  s.license       = "MIT"
+
+  s.files         = `git ls-files`.split($\)
+  s.executables   = s.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = %w[lib]
+
+  s.add_development_dependency 'activesupport', '~> 4.0'
+  s.add_development_dependency 'minitest', '~> 5.4.3'
+  s.add_development_dependency 'html-pipeline', '~> 1.0'
+  s.add_development_dependency 'sanitize', '~> 2.1.0'
+  s.add_development_dependency 'nokogiri', '~> 1.6.1'
+  s.add_development_dependency 'nokogiri-diff', '~> 0.2.0'
+end

data/lib/github-markup.rb

@@ -0,0 +1,6 @@
+module GitHub
+  module Markup
+    VERSION = '1.5.0.pre'
+    Version = VERSION
+  end
+end

data/lib/github/commands/rest2html

@@ -0,0 +1,200 @@
+#!/usr/bin/env python
+"""
+rest2html - A small wrapper file for parsing ReST files at GitHub.
+
+Written in 2008 by Jannis Leidel <jannis@leidel.info>
+
+Brandon Keepers <bkeepers@github.com>
+Bryan Veloso <bryan@revyver.com>
+Chris Wanstrath <chris@ozmm.org>
+Dave Abrahams <dave@boostpro.com>
+Garen Torikian <garen@github.com>
+Gasper Zejn <zejn@kiberpipa.org>
+Michael Jones <m.pricejones@gmail.com>
+Sam Whited <sam@samwhited.com>
+Tyler Chung <zonyitoo@gmail.com>
+Vicent Marti <tanoku@gmail.com>
+
+To the extent possible under law, the author(s) have dedicated all copyright
+and related and neighboring rights to this software to the public domain
+worldwide. This software is distributed without any warranty.
+
+You should have received a copy of the CC0 Public Domain Dedication along with
+this software. If not, see <http://creativecommons.org/publicdomain/zero/1.0/>.
+"""
+
+__author__ = "Jannis Leidel"
+__license__ = "CC0"
+__version__ = "0.1"
+
+import sys
+import os
+
+# This fixes docutils failing with unicode parameters to CSV-Table. The -S
+# switch and the following 3 lines can be removed after upgrading to python 3.
+if sys.version_info[0] < 3:
+    reload(sys)
+    sys.setdefaultencoding('utf-8')
+
+import site
+
+try:
+    import locale
+    locale.setlocale(locale.LC_ALL, '')
+except:
+    pass
+
+import codecs
+import io
+
+from docutils import nodes
+from docutils.parsers.rst import directives, roles
+from docutils.parsers.rst.directives.body import CodeBlock
+from docutils.core import publish_parts
+from docutils.writers.html4css1 import Writer, HTMLTranslator
+
+SETTINGS = {
+    'cloak_email_addresses': False,
+    'file_insertion_enabled': False,
+    'raw_enabled': True,
+    'strip_comments': True,
+    'doctitle_xform': True,
+    'sectsubtitle_xform': True,
+    'initial_header_level': 2,
+    'report_level': 5,
+    'syntax_highlight': 'none',
+    'math_output': 'latex',
+    'field_name_limit': 50,
+}
+
+
+class DoctestDirective(CodeBlock):
+    """Render Sphinx 'doctest:: [group]' blocks as 'code:: python'
+    """
+
+    def run(self):
+        """Discard any doctest group argument, render contents as python code
+        """
+        self.arguments = ['python']
+        return super(DoctestDirective, self).run()
+
+
+class GitHubHTMLTranslator(HTMLTranslator):
+
+    # removes the <div class="document"> tag wrapped around docs
+    # see also: http://bit.ly/1exfq2h (warning! sourceforge link.)
+    def depart_document(self, node):
+        HTMLTranslator.depart_document(self, node)
+        self.html_body.pop(0)  # pop the starting <div> off
+        self.html_body.pop()   # pop the ending </div> off
+
+    # technique for visiting sections, without generating additional divs
+    # see also: http://bit.ly/NHtyRx
+    # the a is to support ::contents with ::sectnums: http://git.io/N1yC
+    def visit_section(self, node):
+        id_attribute = node.attributes['ids'][0]
+        self.body.append('<a name="%s"></a>\n' % id_attribute)
+        self.section_level += 1
+
+    def depart_section(self, node):
+        self.section_level -= 1
+
+    def visit_literal_block(self, node):
+        classes = node.attributes['classes']
+        if len(classes) >= 2 and classes[0] == 'code':
+            language = classes[1]
+            del classes[:]
+            self.body.append(self.starttag(node, 'pre', lang=language))
+        else:
+            self.body.append(self.starttag(node, 'pre'))
+
+    # always wrap two-backtick rst inline literals in <code>, not <tt>
+    # this also avoids the generation of superfluous <span> tags
+    def visit_literal(self, node):
+        self.body.append(self.starttag(node, 'code', suffix=''))
+
+    def depart_literal(self, node):
+        self.body.append('</code>')
+
+    def visit_table(self, node):
+        classes = ' '.join(['docutils', self.settings.table_style]).strip()
+        self.body.append(
+            self.starttag(node, 'table', CLASS=classes))
+
+    def depart_table(self, node):
+        self.body.append('</table>\n')
+
+    def depart_image(self, node):
+        uri = node['uri']
+        ext = os.path.splitext(uri)[1].lower()
+        # we need to swap RST's use of `object` with `img` tags
+        # see http://git.io/5me3dA
+        if ext == ".svg":
+            # preserve essential attributes
+            atts = {}
+            for attribute, value in node.attributes.items():
+                # we have no time for empty values
+                if value:
+                    if attribute == "uri":
+                        atts['src'] = value
+                    else:
+                        atts[attribute] = value
+
+            # toss off `object` tag
+            self.body.pop()
+        # add on `img` with attributes
+            self.body.append(self.starttag(node, 'img', **atts))
+        self.body.append(self.context.pop())
+
+
+def kbd(name, rawtext, text, lineno, inliner, options=None, content=None):
+
+    return [nodes.raw('', '<kbd>%s</kbd>' % text, format='html')], []
+
+
+def main():
+    """
+    Parses the given ReST file or the redirected string input and returns the
+    HTML body.
+
+    Usage: rest2html < README.rst
+           rest2html README.rst
+    """
+    try:
+        text = codecs.open(sys.argv[1], 'r', 'utf-8').read()
+    except IOError:  # given filename could not be found
+        return ''
+    except IndexError:  # no filename given
+        if sys.version_info[0] < 3: # python 2.x
+            text = sys.stdin.read()
+        else: # python 3
+            input_stream = io.TextIOWrapper(sys.stdin.buffer, encoding='utf-8')
+            text = input_stream.read()
+
+    writer = Writer()
+    writer.translator_class = GitHubHTMLTranslator
+
+    roles.register_canonical_role('kbd', kbd)
+
+    # Render source code in Sphinx doctest blocks
+    directives.register_directive('doctest', DoctestDirective)
+
+    parts = publish_parts(text, writer=writer, settings_overrides=SETTINGS)
+    if 'html_body' in parts:
+        html = parts['html_body']
+
+        # publish_parts() in python 2.x return dict values as Unicode type
+        # in py3k Unicode is unavailable and values are of str type
+        if isinstance(html, str):
+            return html
+        else:
+            return html.encode('utf-8')
+    return ''
+
+if __name__ == '__main__':
+    if sys.version_info[0] < 3: # python 2.x
+        sys.stdout.write("%s%s" % (main(), "\n"))
+    else: # python 3
+        output_stream = io.TextIOWrapper(sys.stdout.buffer, encoding='utf-8')
+        output_stream.write("%s%s" % (main(), "\n"))
+    sys.stdout.flush()