asciidoctor 1.5.8 → 2.0.0.rc.1

data/CONTRIBUTING.adoc

@@ -1,185 +0,0 @@
-= Contributing
-// settings:
-:idprefix:
-:idseparator: -
-:source-language: ruby
-:language: {source-language}
-ifdef::env-github,env-browser[:outfilesuffix: .adoc]
-// URIs:
-:uri-repo: https://github.com/asciidoctor/asciidoctor
-:uri-help-base: https://help.github.com/articles
-:uri-issues: {uri-repo}/issues
-:uri-fork-help: {uri-help-base}/fork-a-repo
-:uri-branch-help: {uri-fork-help}#create-branches
-:uri-pr-help: {uri-help-base}/using-pull-requests
-:uri-gist: https://gist.github.com
-:uri-yard: https://yardoc.org
-:uri-tomdoc: http://tomdoc.org
-
-== License Agreement
-
-By contributing changes to this repository, you agree to license your contributions under the MIT license.
-This ensures your contributions have the same license as the project and that the community is free to use your contributions.
-You also assert that you are the original author of the work that you are contributing unless otherwise stated.
-
-== Submitting an Issue
-
-We use the {uri-issues}[issue tracker on GitHub] associated with this project to track bugs and features.
-Before submitting a bug report or feature request, check to make sure it hasn't already been submitted.
-When submitting a bug report, please include a {uri-gist}[Gist] that includes any details that may help reproduce the bug, including your gem version, Ruby version, and operating system.
-
-Most importantly, since Asciidoctor is a text processor, reproducing most bugs requires that we have some snippet of text on which Asciidoctor exhibits the bad behavior.
-
-An ideal bug report would include a pull request with failing specs.
-
-== Submitting a Pull Request
-
-. {uri-fork-help}[Fork the repository].
-. Run `NOKOGIRI_USE_SYSTEM_LIBRARIES=1 bundle` to install development dependencies.
-  - If the `bundle` command is not available, run `gem install bundler` to install it.
-. {uri-branch-help}[Create a topic branch] (preferably using the pattern `issue-XYZ`, where `XYZ` is the issue number).
-. Add tests for your unimplemented feature or bug fix. (See <<writing-and-executing-tests>>)
-. Run `bundle exec rake` to run the tests.
-If your tests pass, return to step 4.
-. Implement your feature or bug fix.
-. Run `bundle exec rake` to run the tests.
-If your tests fail, return to step 6.
-. Add documentation for your feature or bug fix.
-. If your changes are not 100% documented, go back to step 8.
-. Add, commit, and push your changes.
-. {uri-pr-help}[Submit a pull request].
-
-For ideas about how to use pull requests, see the post http://blog.quickpeople.co.uk/2013/07/10/useful-github-patterns[Useful GitHub Patterns].
-
-=== Background Knowledge
-
-As Asciidoctor is built using Ruby some basic knowledge of Ruby, RubyGems and Minitest is beneficial. The following resources provide a good starting point for contributors who may not be completely comfortable with these tools:
-
-* https://www.ruby-lang.org/en/documentation/quickstart/[Ruby in 20 minutes]
-* https://www.ruby-lang.org/en/documentation/ruby-from-other-languages/[Ruby from other languages]
-* http://guides.rubygems.org/rubygems-basics/[RubyGems basics]
-* http://guides.rubygems.org/what-is-a-gem/[What is a Gem?]
-* http://blog.teamtreehouse.com/short-introduction-minitest[How to use Minitest]
-* http://www.rubyinside.com/a-minitestspec-tutorial-elegant-spec-style-testing-that-comes-with-ruby-5354.html[Minitest spec tutorial]
-* https://github.com/seattlerb/minitest/blob/master/README.rdoc[Minitest Project Documentation]
-
-While these resources don't cover everything needed they serve as a good starting off point for beginners.
-
-=== Writing and Executing Tests
-
-Tests live inside the test directory and are named <topic>_test.rb.
-For instance, tests for the different types of blocks can be found in the file test/blocks_test.rb.
-
-Within a test file, individual test cases are organized inside of contexts.
-A context is type of logical container that groups related tests together.
-
-Each test case follows the same structure:
-
-[source]
-----
-test 'description of test' do
-  # test logic
-end
-----
-
-At the moment, the tests are quite primitive.
-Here's how a typical test operates:
-
-. Defines sample AsciiDoc source
-. Renders the document to HTML or DocBook
-. Uses XPath and CSS expressions to verify expected output
-
-Here's how we might test the open block syntax:
-
-[source]
-----
-test 'should render content bounded by two consecutive hyphens as an open block' do
-  input = <<-EOS
---
-This is an open block.
---
-  EOS
-  result = render_embedded_string input
-  assert_css '.openblock', result, 1
-  assert_css '.openblock p', result, 1
-  assert_xpath '/div[@class="openblock"]//p[text()="This is an open block."]', result, 1
-end
-----
-
-As you can see, several helpers are used to facilitate the test scenario.
-The `render_embedded_string` invokes Asciidoctor's render method with the header and footer option disabled.
-This method is ideal for unit-level tests.
-If you need to test the whole document, use `render_string` instead.
-The `assert_css` and `assert_xpath` assertion methods take a CSS or XPath selector, respectively, the rendered result and the number of expected matches.
-You can also use built-in assertions in Ruby's test library.
-
-To run all the tests, simply execute `rake`:
-
- $ rake
-
-NOTE: The tests should only take a few seconds to run using Ruby 2.1.
-
-If you want to run a single test file, you can use `ruby`:
-
- $ ruby test/blocks_test.rb
-
-To test a single test case, first add the string "wip" to the beginning of the description.
-For example:
-
-[source]
-----
-test 'wip should render ...' do
-  ...
-end
-----
-
-Then, run `ruby` again, but this time pass a selector argument so it finds matching tests:
-
- $ ruby test/blocks_test.rb -n /wip/
-
-You can also turn on verbose mode if you want to see more output:
-
- $ ruby test/blocks_test.rb -n /wip/ -v
-
-Once you are done with your test, make sure to remove `wip` from the description and run all the tests again using `rake`.
-
-We plan on switching to a more elegant testing framework in the future, such as RSpec or Cucumber, in order to make the tests more clear and robust.
-
-=== Running Asciidoctor in Development Mode
-
-Asciidoctor is designed so that you can run the script directly out of the cloned repository.
-Simply execute the `asciidoctor` command directly (referencing it either by relative or absolute path).
-There's no need to install it using the `gem` command first.
-
-For example, to convert the README file, switch to the root of the project and run:
-
- $ ./bin/asciidoctor README.adoc
-
-IMPORTANT: You'll need to make sure you reference the correct relative path to the `asciidoctor` command.
-
-If you want to be able to execute the `asciidoctor` command from any directory without worrying about the relative (or absolute) path, you can setup the following Bash alias:
-
- alias asciidoctor-dev="/path/to/asciidoctor/bin/asciidoctor"
-
-Now you can execute the `asciidoctor` command from any folder as follows:
-
- $ asciidoctor-dev README.adoc
-
-== Building the API Documentation
-
-The API documentation is written in the {uri-tomdoc}[TomDoc] dialect and built using {uri-yard}[Yard].
-
-The options for Yard are configured in the [.path]_.yardopts_ file at the root of the project.
-
-To build the API documentation locally, run the following command:
-
- $ bundle exec yard
-
-The documentation will be built into the [.path]_rdoc_ folder.
-
-== Supporting Additional Ruby Versions
-
-If you would like this library to support another Ruby version, you may volunteer to be a maintainer.
-Being a maintainer entails making sure all tests run and pass on that implementation.
-When something breaks on your implementation, you will be expected to provide patches in a timely fashion.
-If critical issues for a particular implementation exist at the time of a major release, support for that Ruby version may be dropped.

data/Gemfile

@@ -1,60 +0,0 @@
-source 'https://rubygems.org'
-
-# Look in asciidoctor.gemspec for runtime and development dependencies
-gemspec
-
-group :development do
-  ruby_version = Gem::Version.new RUBY_VERSION
-  gem 'concurrent-ruby', '~> 1.0.0' unless ruby_version < (Gem::Version.new '1.9.3')
-  if ruby_version < (Gem::Version.new '2.2.0')
-    if ruby_version < (Gem::Version.new '2.1.0')
-      if ruby_version < (Gem::Version.new '2.0.0')
-        gem 'haml', '~> 4.0.0'
-        if ruby_version < (Gem::Version.new '1.9.3')
-          gem 'cucumber', '~> 1.3.0'
-          gem 'nokogiri', '~> 1.5.0'
-          gem 'slim', '~> 2.1.0'
-          gem 'thread_safe', '0.3.6'
-          gem 'tilt', '2.0.7'
-        else
-          gem 'nokogiri', '~> 1.6.0'
-          gem 'slim', '<= 3.0.7'
-        end
-      else
-        gem 'nokogiri', '~> 1.6.0'
-      end
-    else
-      gem 'nokogiri', '~> 1.7.0' if Gem::Platform.local =~ 'x86-mingw32' || Gem::Platform.local =~ 'x64-mingw32'
-      # pin nokogiri because XPath behavior changed on JRuby starting in 1.8.3 (see sparklemotion/nokogiri#1803)
-      gem 'nokogiri', '1.8.2' if RUBY_ENGINE == 'jruby'
-      gem 'racc', '~> 1.4.0' if RUBY_VERSION == '2.1.0' && RUBY_ENGINE == 'rbx'
-    end
-  else
-    # pin nokogiri because XPath behavior changed on JRuby starting in 1.8.3 (see sparklemotion/nokogiri#1803)
-    gem 'nokogiri', '1.8.2' if RUBY_ENGINE == 'jruby'
-  end
-end
-
-group :doc do
-  gem 'yard'
-  gem 'yard-tomdoc'
-end
-
-# enable this group to use Guard for continuous testing
-# after removing comments, run `bundle install` then `guard`
-#group :guardtest do
-#  gem 'guard'
-#  gem 'guard-test'
-#  gem 'libnotify'
-#  gem 'listen', :github => 'guard/listen'
-#end
-
-group :ci do
-  gem 'simplecov', '~> 0.14.1'
-  if ENV['SHIPPABLE']
-    gem 'simplecov-csv', '~> 0.1.3'
-    gem 'ci_reporter', '~> 2.0.0'
-    gem 'ci_reporter_minitest', '~> 1.0.0'
-    #gem 'ci_reporter_cucumber', '~> 1.0.0'
-  end
-end

data/Rakefile

@@ -1,129 +0,0 @@
-def prepare_test_env
-  # rather than hardcoding gc settings in test task,
-  # could use https://gist.github.com/benders/788695
-  ENV['RUBY_GC_MALLOC_LIMIT'] = 128_000_000.to_s
-  ENV['RUBY_GC_OLDMALLOC_LIMIT'] = 128_000_000.to_s
-  if RUBY_VERSION >= '2.1'
-    ENV['RUBY_GC_HEAP_INIT_SLOTS'] = 800_000.to_s
-    ENV['RUBY_GC_HEAP_FREE_SLOTS'] = 800_000.to_s
-    ENV['RUBY_GC_HEAP_GROWTH_MAX_SLOTS'] = 250_000.to_s
-    ENV['RUBY_GC_HEAP_GROWTH_FACTOR'] = 1.25.to_s
-  else
-    ENV['RUBY_FREE_MIN'] = 800_000.to_s
-  end
-end
-
-begin
-  require 'rake/testtask'
-  Rake::TestTask.new(:test) do |t|
-    prepare_test_env
-    puts %(LANG: #{ENV['LANG']}) if ENV.key? 'TRAVIS_BUILD_ID'
-    t.libs << 'test'
-    t.pattern = 'test/**/*_test.rb'
-    t.verbose = true
-    t.warning = true
-  end
-  task :default => 'test:all'
-rescue LoadError
-end
-
-begin
-  require 'cucumber/rake/task'
-  Cucumber::Rake::Task.new(:features) do |t|
-    t.cucumber_opts = %w(-f progress)
-  end
-rescue LoadError
-end
-
-def ci_setup_tasks
-  tasks = []
-  begin
-    require 'ci/reporter/rake/minitest'
-    tasks << 'ci:setup:minitest'
-    # FIXME reporter for Cucumber tests not activating
-    #require 'ci/reporter/rake/cucumber'
-    #tasks << 'ci:setup:cucumber'
-  rescue LoadError
-  end if ENV['SHIPPABLE'] && RUBY_VERSION >= '1.9.3'
-  tasks
-end
-
-desc 'Activates coverage and JUnit-style XML reports for tests'
-task :coverage => ci_setup_tasks do
-  # exclude coverage run for Ruby 1.8.7 or (disabled) if running on Travis CI
-  ENV['COVERAGE'] = 'true' if RUBY_VERSION >= '1.9.3' # && (ENV['SHIPPABLE'] || !ENV['TRAVIS_BUILD_ID'])
-  ENV['CI_REPORTS'] = 'shippable/testresults'
-  ENV['COVERAGE_REPORTS'] = 'shippable/codecoverage'
-end
-
-namespace :test do
-  desc 'Run unit and feature tests'
-  task :all => [:test, :features]
-end
-
-begin
-  require 'bundler/gem_tasks'
-rescue LoadError
-end
-
-desc 'Open an irb session preloaded with this library'
-task :console do
-  sh 'bundle console', :verbose => false
-end
-
-namespace :build do
-desc 'Trigger builds for all dependent projects on Travis CI'
-  task :dependents do
-    if ENV['TRAVIS'].to_s == 'true'
-      next unless ENV['TRAVIS_PULL_REQUEST'].to_s == 'false' &&
-          ENV['TRAVIS_TAG'].to_s.empty? &&
-          (ENV['TRAVIS_JOB_NUMBER'].to_s.end_with? '.1')
-    end
-    # NOTE The TRAVIS_TOKEN env var must be defined in Travis interface.
-    # Retrieve this token using the `travis token` command.
-    # The GitHub user corresponding to the Travis user must have write access to the repository.
-    # After granting permission, sign into Travis and resync the repositories.
-    next unless (token = ENV['TRAVIS_TOKEN'])
-    require 'json'
-    require 'net/http'
-    require 'open-uri'
-    require 'yaml'
-    %w(
-      asciidoctor/asciidoctor.js
-      asciidoctor/asciidoctorj
-      asciidoctor/asciidoctorj/asciidoctorj-1.6.0
-      asciidoctor/asciidoctor-diagram
-      asciidoctor/asciidoctor-reveal.js
-    ).each do |project|
-      org, name, branch = project.split '/', 3
-      branch ||= 'master'
-      project = [org, name, branch] * '/'
-      header = {
-        'Content-Type' => 'application/json',
-        'Accept' => 'application/json',
-        'Travis-API-Version' => '3',
-        'Authorization' => %(token #{token})
-      }
-      if (commit_hash = ENV['TRAVIS_COMMIT'])
-        commit_memo = %( (#{commit_hash.slice 0, 8})\n\nhttps://github.com/#{ENV['TRAVIS_REPO_SLUG'] || 'asciidoctor/asciidoctor'}/commit/#{commit_hash})
-      end
-      config = YAML.load open(%(https://raw.githubusercontent.com/#{project}/.travis-upstream-only.yml)) {|fd| fd.read } rescue {}
-      payload = {
-        'request' => {
-          'branch' => branch,
-          'message' => %(Build triggered by Asciidoctor#{commit_memo}),
-          'config' => config
-        }
-      }.to_json
-      (http = Net::HTTP.new 'api.travis-ci.org', 443).use_ssl = true
-      request = Net::HTTP::Post.new %(/repo/#{org}%2F#{name}/requests), header
-      request.body = payload
-      response = http.request request
-      if response.code == '202'
-        puts %(Successfully triggered build on #{project} repository)
-      else
-        warn %(Unable to trigger build on #{project} repository: #{response.code} - #{response.message})
-      end
-    end
-  end
-end

data/bin/asciidoctor-safe

@@ -1,15 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'rubygems' unless defined? Gem
-
-if File.exist?(asciidoctor = (File.expand_path '../../lib/asciidoctor', __FILE__))
-  require asciidoctor
-else
-  require 'asciidoctor'
-end
-require 'asciidoctor/cli'
-
-invoker = Asciidoctor::Cli::Invoker.new(ARGV + ['-S', 'safe'])
-GC.start
-invoker.invoke!
-exit invoker.code

data/features/open_block.feature

@@ -1,92 +0,0 @@
-# language: en
-Feature: Open Blocks
-  In order to group content in a generic container
-  As a writer
-  I want to be able to wrap content in an open block
-
-
-  Scenario: Render an open block that contains a paragraph to HTML
-  Given the AsciiDoc source
-    """
-    --
-    A paragraph in an open block.
-    --
-    """
-  When it is converted to html
-  Then the result should match the HTML source
-    """
-    <div class="openblock">
-    <div class="content">
-    <div class="paragraph">
-    <p>A paragraph in an open block.</p>
-    </div>
-    </div>
-    </div>
-    """
-
-
-  Scenario: Render an open block that contains a paragraph to DocBook
-  Given the AsciiDoc source
-    """
-    --
-    A paragraph in an open block.
-    --
-    """
-  When it is converted to docbook
-  Then the result should match the XML source
-    """
-    <simpara>A paragraph in an open block.</simpara>
-    """
-
-
-  Scenario: Render an open block that contains a paragraph to HTML (alt)
-  Given the AsciiDoc source
-    """
-    --
-    A paragraph in an open block.
-    --
-    """
-  When it is converted to html
-  Then the result should match the HTML structure
-    """
-    .openblock
-      .content
-        .paragraph
-          p A paragraph in an open block.
-    """
-
-
-  Scenario: Render an open block that contains a paragraph to DocBook (alt)
-  Given the AsciiDoc source
-    """
-    --
-    A paragraph in an open block.
-    --
-    """
-  When it is converted to docbook
-  Then the result should match the XML structure
-    """
-    simpara A paragraph in an open block.
-    """
-
-
-  Scenario: Render an open block that contains a list to HTML
-  Given the AsciiDoc source
-    """
-    --
-    * one
-    * two
-    * three
-    --
-    """
-  When it is converted to html
-  Then the result should match the HTML structure
-    """
-    .openblock
-      .content
-        .ulist
-          ul
-            li: p one
-            li: p two
-            li: p three
-    """