pandoc-ruby 2.0.1 → 2.1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c07c31b644c343bcd4ab9371b2128579ced7577e
-  data.tar.gz: 983a9f0c36bd180077d4449bb51639cb22edf5e7
+SHA256:
+  metadata.gz: 8e8ca5b1e67ee24b1ce6da71e7d66b79c01de59784bca75862c37463c8b7c149
+  data.tar.gz: f6beef0283cf065db5f496449230fbf70fee63e699ebc8b5e3002440c707df78
 SHA512:
-  metadata.gz: cf592d887248d4d8f5131a8aebf55fcd4bf9b990cd34efd4058fc39629ccdc891d5ba40a8c470866d4448afedda6812bccd108aaf1ef49ddddaaf09ab8dec056
-  data.tar.gz: 8d6e6a5e741360555372e5054d625612b7fe2a6c8a4437768c57972d35d76f9919b632b6fece80421d4607b265454bdc09f806d5d6a6a4c58eb1ad87bfe3f579
+  metadata.gz: f5389c2016eee54a1fd8d4238b0579c10ffc7ee35ee97a362eb90a44e6798aa9196674af80cb9abc3228db19aadd4e93e1ecf02d6229fd4231bd9bc947755b78
+  data.tar.gz: 2039942ca2d81756b3ce3077bcf1eb8c64347fe256d0c1ced34406f55028e84f788f289de484eb3c3350184a014c42c9b5ff54aed660ea74b0ef549398d8662b

data/Gemfile

@@ -6,8 +6,9 @@ source 'http://rubygems.org'
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.
 group :development, :test do
-  gem 'minitest', '~>5.8.3'
-  gem 'mocha', '~>1.1.0'
+  gem 'minitest'
+  gem 'mocha'
   gem 'rake'
   gem 'rdoc'
+  gem 'rubocop'
 end

data/Gemfile.lock

@@ -1,23 +1,52 @@
 GEM
   remote: http://rubygems.org/
   specs:
-    json (1.8.3)
-    metaclass (0.0.4)
-    minitest (5.8.4)
-    mocha (1.1.0)
-      metaclass (~> 0.0.1)
-    rake (11.1.2)
-    rdoc (4.2.2)
-      json (~> 1.4)
+    ast (2.4.2)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
+    minitest (5.20.0)
+    mocha (2.1.0)
+      ruby2_keywords (>= 0.0.5)
+    parallel (1.23.0)
+    parser (3.2.2.4)
+      ast (~> 2.4.1)
+      racc
+    psych (5.1.1.1)
+      stringio
+    racc (1.7.3)
+    rainbow (3.1.1)
+    rake (13.1.0)
+    rdoc (6.6.0)
+      psych (>= 4.0.0)
+    regexp_parser (2.8.2)
+    rexml (3.2.6)
+    rubocop (1.57.2)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.2.2.4)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.30.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
+    ruby2_keywords (0.0.5)
+    stringio (3.0.9)
+    unicode-display_width (2.5.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  minitest (~> 5.8.3)
-  mocha (~> 1.1.0)
+  minitest
+  mocha
   rake
   rdoc
+  rubocop
 
 BUNDLED WITH
-   1.12.2
+   2.2.28

data/README.md

@@ -1,74 +1,77 @@
 # PandocRuby
 
+[![Build Status](https://img.shields.io/github/actions/workflow/status/xwmx/pandoc-ruby/tests.yml?branch=master)](https://github.com/xwmx/pandoc-ruby/actions)
+[![Gem Version](https://img.shields.io/gem/v/pandoc-ruby)](http://rubygems.org/gems/pandoc-ruby)
+[![Gem Downloads](https://img.shields.io/gem/dt/pandoc-ruby)](http://rubygems.org/gems/pandoc-ruby)
+
 PandocRuby is a wrapper for [Pandoc](http://johnmacfarlane.net/pandoc/), a
 Haskell library with command line tools for converting one markup format to
 another.
 
-Pandoc can convert documents in markdown, reStructuredText, textile, HTML,
-DocBook, LaTeX, or MediaWiki markup to a variety of formats, including
-markdown, reStructuredText, HTML, LaTeX, ConTeXt, PDF, RTF, DocBook XML,
-OpenDocument XML, ODT, GNU Texinfo, MediaWiki markup, groff man pages,
-HTML slide shows, EPUB, and Microsoft Word docx.
-
-*This documentation is for version 2 and higher. For version 1 documentation
-[see here](https://github.com/alphabetum/pandoc-ruby/blob/v1.0.0/README.markdown).*
+Pandoc can convert documents from a variety of formats including markdown,
+reStructuredText, textile, HTML, DocBook, LaTeX, and MediaWiki markup to a
+variety of other formats, including markdown, reStructuredText, HTML, LaTeX,
+ConTeXt, PDF, RTF, DocBook XML, OpenDocument XML, ODT, GNU Texinfo, MediaWiki
+markup, groff man pages, HTML slide shows, EPUB, Microsoft Word docx, and more.
 
 ## Installation
 
-First, make sure to
-[install Pandoc](http://johnmacfarlane.net/pandoc/installing.html).
+First, [install Pandoc](http://johnmacfarlane.net/pandoc/installing.html).
 
-Next, add PandocRuby to your Gemfile
+PandocRuby is available on [RubyGems](http://rubygems.org/gems/pandoc-ruby):
 
-```ruby
-gem 'pandoc-ruby'
+```bash
+gem install pandoc-ruby
 ```
 
-or install PandocRuby from [RubyGems](http://rubygems.org/gems/pandoc-ruby).
+To install with [Bundler](https://bundler.io/), add the following to your
+Gemfile:
 
-```bash
-gem install pandoc-ruby
+```ruby
+gem 'pandoc-ruby'
 ```
 
+Then run `bundle install`
+
 ## Usage
 
 ```ruby
 require 'pandoc-ruby'
-@converter = PandocRuby.new('# Markdown Title', :from => :markdown, :to => :rst)
+@converter = PandocRuby.new('# Markdown Title', from: :markdown, to: :rst)
 puts @converter.convert
 ```
 
-This takes the Markdown formatted file and converts it to reStructuredText.
+This takes the Markdown formatted string and converts it to reStructuredText.
 
 You can also use the `#convert` class method:
 
 ```ruby
-puts PandocRuby.convert('# Markdown Title', :from => :markdown, :to => :html)
+puts PandocRuby.convert('# Markdown Title', from: :markdown, to: :html)
 ```
 
 Other arguments are simply converted into command line options, accepting
-symbols or strings for options without arguments and hashes of strings or
-symbols for options with arguments.
+symbols and strings for options and hashes for options with arguments.
 
 ```ruby
-PandocRuby.convert('# Markdown Title', :s, {:f => :markdown, :to => :rst}, 'no-wrap', :table_of_contents)
+PandocRuby.convert('# Markdown Title', :s, {f: :markdown, to: :rst}, '--wrap=none', :table_of_contents)
 ```
 
 is equivalent to
 
 ```bash
-echo "# Markdown Title" | pandoc -s -f markdown --to=rst --no-wrap --table-of-contents
+echo "# Markdown Title" | pandoc -s -f markdown --to=rst --wrap=none --table-of-contents
 ```
 
 Also provided are `#to_[writer]` instance methods for each of the writers,
 and these can also accept options:
 
 ```ruby
-PandocRuby.new("# Some title").to_html(:no_wrap)
-# => "<div id=\"some-title\"><h1>Some title</h1></div>"
+PandocRuby.new('# Example').to_html(:ascii)
+# => "<h1 id="example">Example</h1>"
 # or
-PandocRuby.new("# Some title").to_rst
-# => "Some title\n=========="
+PandocRuby.new("# Example").to_rst
+# => "Example
+#     ======="
 ```
 
 Similarly, there are class methods for each of the readers, so readers
@@ -79,23 +82,55 @@ PandocRuby.html("<h1>hello</h1>").to_latex
 # => "\\section{hello}"
 ```
 
-PandocRuby assumes the `pandoc` executable is via your environment's `$PATH`
+Available readers and writers are can be found in the following
+variables:
+- [`PandocRuby::READERS`](lib/pandoc-ruby.rb#L10)
+- [`PandocRuby::STRING_WRITERS`](lib/pandoc-ruby.rb#L48)
+- [`PandocRuby::BINARY_WRITERS`](lib/pandoc-ruby.rb#L104)
+- [`PandocRuby::WRITERS`](lib/pandoc-ruby.rb#L113)
+
+PandocRuby assumes the `pandoc` executable is in your environment's `$PATH`
 variable.  If you'd like to set an explicit path to the `pandoc` executable,
 you can do so with  `PandocRuby.pandoc_path = '/path/to/pandoc'`
 
+### Converting Files
+
 PandocRuby can also take an array of one or more file paths as the first
 argument. The files will be concatenated together with a blank line between
 each and used as input.
 
 ```ruby
 # One file path as a single-element array.
-PandocRuby.html(['/path/to/file1.html']).to_markdown
+PandocRuby.new(['/path/to/file1.docx'], from: 'docx').to_html
 # Multiple file paths as an array.
-PandocRuby.html(['/path/to/file1.html', '/path/to/file2.html']).to_markdown
+PandocRuby.new(['/path/to/file1.docx', '/path/to/file1.docx'], from: 'docx').to_html
+```
+
+If you are trying to generate a standalone file with full file headers rather
+than just a marked up fragment, remember to pass the `:standalone` option so
+the correct header and footer are added.
+
+```ruby
+PandocRuby.new("# Some title", :standalone).to_rtf
+```
+
+### Extensions
+
+Pandoc [extensions](https://pandoc.org/MANUAL.html#extensions) can be
+used to modify the behavior of readers and writers. To use an extension,
+add the extension with a `+` or `-` after the reader or writer name:
+
+```ruby
+# Without extension:
+PandocRuby.new("Line 1\n# Heading", from: 'markdown_strict').to_html
+# => "<p>Line 1</p>\n<h1>Heading</h1>\n"
+
+# With `+blank_before_header` extension:
+PandocRuby.new("Line 1\n# Heading", from: 'markdown_strict+blank_before_header').to_html
+# => "<p>Line 1 # Heading</p>\n
 ```
 
-Available format readers and writers are available in the `PandocRuby::READERS`
-and `PandocRuby::WRITERS` constants.
+### More Information
 
 For more information on Pandoc, see the
 [Pandoc documentation](http://johnmacfarlane.net/pandoc/)
@@ -103,24 +138,15 @@ or run `man pandoc`
 ([also available here](http://johnmacfarlane.net/pandoc/pandoc.1.html)).
 
 If you'd prefer a pure-Ruby extended markdown interpreter that can output a
-few different formats, take a look at [Maruku](http://maruku.rubyforge.org/).
-If you want to use the full reStructuredText syntax from within Ruby, check
-out [RbST](https://github.com/alphabetum/rbst), a docutils wrapper.
+few different formats, take a look at
+[kramdown](https://kramdown.gettalong.org/). If you want to use the full
+reStructuredText syntax from within Ruby, check out
+[RbST](https://github.com/xwmx/rbst), a docutils wrapper.
 
 This gem was inspired by [Albino](http://github.com/github/albino). For a
 slightly different approach to using Pandoc with Ruby, see
 [Pandoku](http://github.com/dahlia/pandoku).
 
-## Additional Notes
-
-If you are trying to generate a standalone file with full file headers rather
-than just a marked up fragment, remember to pass the `:standalone` option so
-the correct header and footer are added.
-
-```ruby
-PandocRuby.new("# Some title", :standalone).to_rtf
-```
-
 ## Note on Patches/Pull Requests
 
 * Fork the project.

data/Rakefile

@@ -1,12 +1,10 @@
-# encoding: utf-8
-
 require 'rubygems'
 require 'bundler'
 begin
   Bundler.setup(:default, :development)
 rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts 'Run `bundle install` to install missing gems'
+  warn e.message
+  warn 'Run `bundle install` to install missing gems'
   exit e.status_code
 end
 require 'rake'
@@ -29,3 +27,34 @@ Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_files.include('README*')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
+
+require './lib/pandoc-ruby.rb'
+desc <<HEREDOC
+  Regenerate test files in existing formats.
+HEREDOC
+task :regenerate_files do
+  extensions = []
+  files_dir = File.join(File.dirname(__FILE__), 'test', 'files')
+
+  Dir.glob(File.join(files_dir, 'format*')) do |f|
+    extensions << f.match(/format\.(\w+)\Z/)[1]
+  end
+
+  from_content = File.read(File.join(files_dir, 'format.markdown'))
+
+  extensions.each do |to|
+    next if to == 'markdown'
+
+    to_file = File.join(files_dir, "format.#{to}")
+
+    converted_content = PandocRuby.convert(
+      from_content,
+      :from => 'markdown',
+      :to   => to
+    )
+
+    File.open(to_file, 'w') do |file|
+      file.write(converted_content)
+    end
+  end
+end