kramdown-asciidoc 1.0.0.alpha.13 → 1.0.0.rc.1

data/Rakefile

@@ -1,3 +0,0 @@
-Dir.glob('tasks/*.rake').each {|file| load file }
-
-task default: %w(spec)

data/spec/api_spec.rb

@@ -1,228 +0,0 @@
-require_relative 'spec_helper'
-
-describe Kramdown::AsciiDoc do
-  context '#convert' do
-    it 'converts Markdown to AsciiDoc' do
-      input = <<~EOS
-      ---
-      title: Document Title
-      ---
-
-      Body content.
-      EOS
-
-      expected = <<~EOS
-      = Document Title
-
-      Body content.
-      EOS
-
-      (expect subject.convert input).to eql expected
-    end
-
-    it 'encodes Markdown source to UTF-8' do
-      input = %(bien s\u00fbr !).encode Encoding::ISO_8859_1
-      output = subject.convert input
-      (expect output.encoding).to eql Encoding::UTF_8
-      (expect output).to eql %(bien s\u00fbr !\n)
-    end
-
-    it 'converts CRLF newlines in Markdown source to LF newlines' do
-      input = %(\r\n\r\none\r\ntwo\r\nthree\r\n)
-      output = subject.convert input
-      (expect output.encoding).to eql Encoding::UTF_8
-      (expect output).to eql %(one\ntwo\nthree\n)
-    end
-
-    it 'converts CR newlines in Markdown source to LF newlines' do
-      input = %(\r\rone\rtwo\rthree\r)
-      output = subject.convert input
-      (expect output.encoding).to eql Encoding::UTF_8
-      (expect output).to eql %(one\ntwo\nthree\n)
-    end
-
-    it 'writes AsciiDoc to string path specified by :to option' do
-      the_output_file = output_file 'convert-to-string-path.adoc'
-      (expect subject.convert 'Converted using the API', to: the_output_file).to be_nil
-      (expect (IO.read the_output_file)).to eql %(Converted using the API\n)
-    end
-
-    it 'creates intermediary directories when writing to string path specified by :to option' do
-      the_output_file = output_file 'path/to/convert-to-string-path.adoc'
-      the_output_dir = (Pathname.new the_output_file).dirname
-      (expect subject.convert 'Converted using the API', to: the_output_file).to be_nil
-      (expect the_output_dir).to exist
-    end
-
-    it 'writes AsciiDoc to pathname specified by :to option' do
-      the_output_file = Pathname.new output_file 'convert-to-pathname.adoc'
-      (expect subject.convert 'Converted using the API', to: the_output_file).to be_nil
-      (expect the_output_file.read).to eql %(Converted using the API\n)
-    end
-
-    it 'creates intermediary directories when writing to pathname specified by :to option' do
-      the_output_file = Pathname.new output_file 'path/to/convert-to-pathname.adoc'
-      (expect subject.convert 'Converted using the API', to: the_output_file).to be_nil
-      (expect the_output_file.dirname).to exist
-    end
-
-    it 'writes AsciiDoc to IO object specified by :to option' do
-      old_stdout, $stdout = $stdout, StringIO.new
-      begin
-        (expect subject.convert 'text', to: $stdout).to be_nil
-        (expect $stdout.string).to eql %(text\n)
-      ensure
-        $stdout = old_stdout
-      end
-    end
-
-    it 'does not mutate options argument' do
-      the_output_file = Pathname.new output_file 'convert-with-options.adoc'
-      opts = { encode: true, to: the_output_file, attributes: {} }
-      hash = opts.hash
-      (expect subject.convert '**File > Save**', opts).to be_nil
-      (expect the_output_file.read).to eql %(:experimental:\n\nmenu:File[Save]\n)
-      (expect opts.hash).to eql hash
-    end
-
-    it 'adds line feed (EOL) to end of output document if non-empty' do
-      (expect subject.convert 'paragraph').to end_with ?\n
-    end
-
-    it 'does not add line feed (EOL) to end of output document if empty' do
-      (expect subject.convert '').to be_empty
-    end
-
-    it 'duplicates value of :attributes option' do
-      input = <<~EOS
-      # Document Title
-      
-      # Part 1
-      
-      ## Chapter A
-
-      so it begins
-      EOS
-
-      expected = <<~EOS
-      = Document Title
-      :doctype: book
-      
-      = Part 1
-      
-      == Chapter A
-
-      so it begins
-      EOS
-
-      (expect subject.convert input, attributes: (attributes = {})).to eql expected
-      (expect attributes).to be_empty
-    end
-  end
-
-  context '#convert_file' do
-    let(:source) { 'Markdown was *here*, but it has become **AsciiDoc**!' }
-    let(:expected_output) { %(Markdown was _here_, but it has become *AsciiDoc*!\n) }
-    let!(:the_source_file) { (output_file %(convert-file-api-#{object_id}.md)).tap {|file| IO.write file, source } }
-
-    it 'converts Markdown file to AsciiDoc file' do
-      the_output_file = output_file %(convert-file-api-#{object_id}.adoc)
-      (expect subject.convert_file the_source_file).to be_nil
-      (expect Pathname.new the_output_file).to exist
-      (expect (IO.read the_output_file)).to eql expected_output
-    end
-
-    it 'writes output file to string path specified by :to option' do
-      the_output_file = output_file 'convert-file-to-string-path.adoc'
-      (expect subject.convert_file the_source_file, to: the_output_file).to be_nil
-      (expect (IO.read the_output_file)).to eql expected_output
-    end
-
-    it 'creates intermediary directories when writing to string path specified by :to option' do
-      the_output_file = output_file 'path/to/convert-file-to-string-path.adoc'
-      the_output_dir = (Pathname.new the_output_file).dirname
-      (expect subject.convert_file the_source_file, to: the_output_file).to be_nil
-      (expect the_output_dir).to exist
-    end
-
-    it 'writes output file to pathname specified by :to option' do
-      the_output_file = Pathname.new output_file 'convert-file-to-pathname.adoc'
-      (expect subject.convert_file the_source_file, to: the_output_file).to be_nil
-      (expect (the_output_file.read)).to eql expected_output
-    end
-
-    it 'creates intermediary directories when writing to pathname specified by :to option' do
-      the_output_file = Pathname.new output_file 'path/to/convert-file-to-pathname.adoc'
-      (expect subject.convert_file the_source_file, to: the_output_file).to be_nil
-      (expect the_output_file.dirname).to exist
-    end
-
-    it 'returns output as string if value of :to option is falsy' do
-      (expect subject.convert_file the_source_file, to: nil).to eql expected_output
-    end
-
-    it 'writes output to IO object specified by :to option' do
-      output_sink = StringIO.new
-      (expect subject.convert_file the_source_file, to: output_sink).to be_nil
-      (expect output_sink.string).to eql expected_output
-    end
-
-    it 'writes output file as UTF-8 regardless of default external encoding' do
-      source = %(tr\u00e8s bien !)
-      the_output_file = output_file 'force-encoding.adoc'
-      script_file = output_file 'force-encoding.rb'
-      IO.write script_file, <<~EOS
-      require 'kramdown-asciidoc'
-      Kramdoc.convert '#{source}', to: '#{the_output_file}'
-      EOS
-      # NOTE internal encoding must also be set for test to work on JRuby
-      `#{ruby} -E ISO-8859-1:ISO-8859-1 #{Shellwords.escape script_file}`
-      (expect IO.read the_output_file, mode: 'r:UTF-8').to eql %(#{source}\n)
-    end
-
-    it 'does not mutate options argument' do
-      another_source_file = Pathname.new output_file 'convert-file-with-options.md'
-      another_source_file.write '**File > Save**'
-      the_output_file = Pathname.new output_file 'convert-file-with-options.adoc'
-      opts = { to: the_output_file, attributes: {} }
-      hash = opts.hash
-      (expect subject.convert_file another_source_file, opts).to be_nil
-      (expect the_output_file.read).to eql %(:experimental:\n\nmenu:File[Save]\n)
-      (expect opts.hash).to eql hash
-    end
-
-    it 'passes result through postprocess callback if given' do
-      the_output_file = output_file %(convert-file-api-#{object_id}.adoc)
-      postprocess = -> (asciidoc) { asciidoc.gsub 'become', 'become glorious' }
-      (expect subject.convert_file the_source_file, postprocess: postprocess).to be_nil
-      (expect Pathname.new the_output_file).to exist
-      (expect (IO.read the_output_file)).to eql %(Markdown was _here_, but it has become glorious *AsciiDoc*!\n)
-    end
-
-    it 'passes krawdown document to postprocess method if arity is not 1' do
-      the_output_file = output_file %(convert-file-api-#{object_id}.adoc)
-      postprocess = -> (asciidoc, kramdown_doc) { asciidoc.gsub 'Markdown', kramdown_doc.options[:input] }
-      (expect subject.convert_file the_source_file, postprocess: postprocess).to be_nil
-      (expect Pathname.new the_output_file).to exist
-      (expect (IO.read the_output_file)).to eql %(GFM was _here_, but it has become *AsciiDoc*!\n)
-    end
-
-    it 'uses original source if postprocess callback returns falsy' do
-      the_output_file = output_file %(convert-file-api-#{object_id}.adoc)
-      postprocess = -> (asciidoc) { nil }
-      (expect subject.convert_file the_source_file, postprocess: postprocess).to be_nil
-      (expect Pathname.new the_output_file).to exist
-      (expect (IO.read the_output_file)).to eql %(Markdown was _here_, but it has become *AsciiDoc*!\n)
-    end
-  end
-end
-
-describe Kramdoc do
-  it 'supports Kramdoc as an alias for Kramdown::AsciiDoc' do
-    (expect Kramdoc).to eql Kramdown::AsciiDoc
-  end
-
-  it 'can be required using the alias kramdoc' do
-    require 'kramdoc'
-  end
-end

data/spec/cli_spec.rb

@@ -1,300 +0,0 @@
-require_relative 'spec_helper'
-require 'kramdown-asciidoc/cli'
-
-describe Kramdown::AsciiDoc::Cli do
-  # NOTE override subject to return class object; RSpec returns instance of class by default
-  subject { Kramdown::AsciiDoc::Cli }
-
-  before :each do
-    @old_stdin, $stdin = $stdin, StringIO.new
-    @old_stdout, $stdout = $stdout, StringIO.new
-    @old_stderr, $stderr = $stderr, StringIO.new
-  end
-
-  after :each do
-    $stdin, $stdout, $stderr = @old_stdin, @old_stdout, @old_stderr
-  end
-
-  context 'option flags' do
-    it 'returns non-zero exit status and displays usage when no arguments are given' do
-      expected = 'kramdoc: Please specify a Markdown file to convert.'
-      (expect subject.run []).to eql 1
-      (expect $stderr.string.chomp).to eql expected
-      (expect $stdout.string.chomp).to start_with 'Usage: kramdoc'
-    end
-
-    it 'returns non-zero exit status and displays usage when more than one argument is given' do
-      expected = 'kramdoc: extra arguments detected (unparsed arguments: bar.md)'
-      (expect subject.run %w(foo.md bar.md)).to eql 1
-      (expect $stderr.string.chomp).to eql expected
-      (expect $stdout.string.chomp).to start_with 'Usage: kramdoc'
-    end
-
-    it 'returns non-zero exit status when invalid argument is given' do
-      (expect subject.run %w(--invalid-option)).to eql 1
-      (expect $stderr.string.chomp).to eql 'kramdoc: invalid option: --invalid-option'
-      (expect $stdout.string.chomp).to start_with 'Usage: kramdoc'
-    end
-
-    it 'displays version when -v flag is used' do
-      (expect subject.run %w(-v)).to eql 0
-      (expect $stdout.string.chomp).to eql %(kramdoc #{Kramdown::AsciiDoc::VERSION})
-    end
-
-    it 'displays help when -h flag is used' do
-      (expect subject.run %w(-h)).to eql 0
-      (expect $stdout.string.chomp).to start_with 'Usage: kramdoc'
-    end
-
-    it 'computes output file from input file' do
-      the_source_file = output_file 'implicit-output.md'
-      the_output_file = output_file 'implicit-output.adoc'
-      IO.write the_source_file, 'This is just a test.'
-      (expect subject.run the_source_file).to eql 0
-      (expect (IO.read the_output_file).chomp).to eql 'This is just a test.'
-    end
-
-    it 'writes output to file specified by the -o option' do
-      the_source_file = output_file 'explicit-output.md'
-      the_output_file = output_file 'my-explicit-output.adoc'
-      IO.write the_source_file, 'This is only a test.'
-      (expect subject.run %W(-o #{the_output_file} #{the_source_file})).to eql 0
-      (expect (IO.read the_output_file).chomp).to eql 'This is only a test.'
-    end
-
-    it 'ensures directory of explicit output file exists before writing' do
-      the_source_file = output_file 'ensure-output-dir.md'
-      the_output_file = output_file 'path/to/output/file.adoc'
-      IO.write the_source_file, 'Everything is going to be fine.'
-      (expect subject.run %W(-o #{the_output_file} #{the_source_file})).to eql 0
-      (expect (IO.read the_output_file).chomp).to eql 'Everything is going to be fine.'
-    end
-
-    it 'prevents computed output file from overwriting input file' do
-      the_source_file = output_file 'implicit-conflict.adoc'
-      IO.write the_source_file, 'No can do.'
-      expected = %(kramdoc: input and output cannot be the same file: #{the_source_file})
-      (expect subject.run the_source_file).to eql 1
-      (expect $stderr.string.chomp).to eql expected
-    end
-
-    it 'prevents explicit output file from overwriting input file' do
-      the_source_file = output_file 'explicit-conflict.md'
-      the_output_file = the_source_file
-      IO.write the_source_file, 'No can do.'
-      expected = %(kramdoc: input and output cannot be the same file: #{the_source_file})
-      (expect subject.run %W(-o #{the_output_file} #{the_source_file})).to eql 1
-      (expect $stderr.string.chomp).to eql expected
-    end
-
-    it 'writes output to stdout when -o option equals -' do
-      the_source_file = scenario_file 'p/single-line.md'
-      (expect subject.run %W(-o - #{the_source_file})).to eql 0
-      (expect $stdout.string.chomp).to eql 'A paragraph that consists of a single line.'
-    end
-
-    it 'reads input from stdin when argument is -' do
-      $stdin.puts '- list item'
-      $stdin.rewind
-      (expect subject.run %w(-o - -)).to eql 0
-      (expect $stdout.string.chomp).to eql '* list item'
-    end
-
-    it 'writes output to stdout when input comes from stdin and -o option is not specified' do
-      $stdin.puts '- list item'
-      $stdin.rewind
-      (expect subject.run '-').to eql 0
-      (expect $stdout.string.chomp).to eql '* list item'
-    end
-
-    it 'writes output to file specified by -o option when input comes from stdin' do
-      the_output_file = output_file 'output-from-stdin.adoc'
-      $stdin.puts '- list item'
-      $stdin.rewind
-      (expect subject.run %W(-o #{the_output_file} -)).to eql 0
-      (expect (IO.read the_output_file).chomp).to eql '* list item'
-    end
-
-    it 'removes leading blank lines and trailing whitespace from source' do
-      the_source_file = output_file 'leading-trailing-space.md'
-      IO.write the_source_file, <<~EOS
-      \n\n\n\n
-      # Heading
-
-      Body content.#{'  '}
-      \n\n\n\n
-      EOS
-      (expect subject.run %W(-o - #{the_source_file})).to eql 0
-      (expect $stdout.string.chomp).to eql %(= Heading\n\nBody content.)
-    end
-
-    it 'converts all newlines to line feed characters' do
-      the_source_file = output_file 'newlines.md'
-      IO.write the_source_file, %(\r\n\r\n# Document Title\r\n\r\nFirst paragraph.\r\n\r\nSecond paragraph.\r\n)
-      (expect subject.run %W(-o - #{the_source_file})).to eql 0
-      (expect $stdout.string.chomp).to eql %(= Document Title\n\nFirst paragraph.\n\nSecond paragraph.)
-    end
-
-    it 'processes front matter in source' do
-      the_source_file = output_file 'front-matter.md'
-      IO.write the_source_file, <<~EOS
-      ---
-      title: Document Title
-      ---
-      Body content.
-      EOS
-      (expect subject.run %W(-o - #{the_source_file})).to eql 0
-      (expect $stdout.string.chomp).to eql %(= Document Title\n\nBody content.)
-    end
-
-    it 'replaces explicit toc in source' do
-      the_source_file = output_file 'toc.md'
-      IO.write the_source_file, <<~EOS
-      # Guide
-
-      <!-- TOC depthFrom:2 depthTo:6 -->
-      - [Prerequisites](#prerequisites)
-      - [Installation](#installation)
-      - [Deployment](#deployment)
-      <!-- /TOC -->
-
-      ...
-      EOS
-      (expect subject.run %W(-o - #{the_source_file})).to eql 0
-      (expect $stdout.string.chomp).to eql %(= Guide\n:toc: macro\n\ntoc::[]\n\n...)
-    end
-
-    it 'reads Markdown source using specified format' do
-      the_source_file = output_file 'format-markdown.md'
-      IO.write the_source_file, '#Heading'
-      (expect subject.run %W(-o - --format=markdown #{the_source_file})).to eql 0
-      (expect $stdout.string.chomp).to eql '= Heading'
-    end
-
-    it 'removes directory prefix from image references specified by the --imagesdir option' do
-      the_source_file = scenario_file 'img/implicit-imagesdir.md'
-      expected = IO.read scenario_file 'img/implicit-imagesdir.adoc'
-      (expect subject.run %W(-o - --imagesdir=images #{the_source_file})).to eql 0
-      (expect $stdout.string).to eql expected
-    end
-
-    it 'wraps output as specified by the --wrap option' do
-      the_source_file = scenario_file 'wrap/ventilate.md'
-      expected = IO.read scenario_file 'wrap/ventilate.adoc'
-      (expect subject.run %W(-o - --wrap=ventilate #{the_source_file})).to eql 0
-      (expect $stdout.string).to eql expected
-    end
-
-    it 'does not escape bare URLs when --auto-links is used' do
-      the_source_file = scenario_file 'a/bare-url.md'
-      expected = IO.read scenario_file 'a/bare-url.adoc'
-      (expect subject.run %W(-o - --auto-links #{the_source_file})).to eql 0
-      (expect $stdout.string).to eql expected
-    end
-
-    it 'escapes bare URLs when --no-auto-links is used' do
-      the_source_file = scenario_file 'a/no-auto-links.md'
-      expected = IO.read scenario_file 'a/no-auto-links.adoc'
-      (expect subject.run %W(-o - --no-auto-links #{the_source_file})).to eql 0
-      (expect $stdout.string).to eql expected
-    end
-
-    it 'shifts headings by offset when --heading-offset is used' do
-      the_source_file = scenario_file 'heading/offset.md'
-      expected = IO.read scenario_file 'heading/offset.adoc'
-      (expect subject.run %W(-o - --heading-offset=-1 #{the_source_file})).to eql 0
-      (expect $stdout.string).to eql expected
-    end
-
-    it 'auto generates IDs for section titles when --auto-ids is used' do
-      the_source_file = scenario_file 'heading/auto_ids/no-ids.md'
-      expected = IO.read scenario_file 'heading/auto_ids/no-ids.adoc'
-      (expect subject.run %W(-o - --auto-ids #{the_source_file})).to eql 0
-      (expect $stdout.string).to eql expected
-    end
-
-    it 'adds prefix specified by --auto-id-prefix to any auto-generated section title ID' do
-      the_source_file = scenario_file 'heading/auto_ids/explicit-id.md'
-      expected = <<~EOS
-      [#_heading-1]
-      = Heading 1
-
-      [#_heading]
-      == Heading
-
-      [#_heading-2]
-      == Heading
-
-      [#explicit-id]
-      === Heading 3
-
-      [#_back-to-heading-2]
-      == Back to Heading 2
-      EOS
-      (expect subject.run %W(-o - --auto-id-prefix=_ --auto-ids #{the_source_file})).to eql 0
-      (expect $stdout.string).to eql expected
-    end
-
-    it 'uses separator specified by --auto-id-separator to any auto-generated section title ID' do
-      the_source_file = scenario_file 'heading/auto_ids/explicit-id.md'
-      expected = <<~EOS
-      [#_heading_1]
-      = Heading 1
-
-      [#_heading]
-      == Heading
-
-      [#_heading_2]
-      == Heading
-
-      [#explicit-id]
-      === Heading 3
-
-      [#_back_to_heading_2]
-      == Back to Heading 2
-      EOS
-      (expect subject.run %W(-o - --auto-id-prefix=_ --auto-id-separator=_ --auto-ids #{the_source_file})).to eql 0
-      (expect $stdout.string).to eql expected
-    end
-
-    it 'drops ID if matches auto-generated value when --lazy-ids is used' do
-      the_source_file = scenario_file 'heading/lazy_ids/explicit-ids.md'
-      expected = IO.read scenario_file 'heading/lazy_ids/explicit-ids.adoc'
-      (expect subject.run %W(-o - --lazy-ids #{the_source_file})).to eql 0
-      (expect $stdout.string).to eql expected
-    end
-
-    it 'adds specified attributes to document header' do
-      the_source_file = scenario_file 'root/header-and-body.md'
-      (expect subject.run %W(-o - -a idprefix -a idseparator=- #{the_source_file})).to eql 0
-      expected = <<~EOS
-      = Document Title
-      :idprefix:
-      :idseparator: -
-
-      Body content.
-      EOS
-      (expect $stdout.string).to eql expected
-    end
-
-    it 'passes through HTML when --no-html-to-native flag is used' do
-      the_source_file = scenario_file 'html_element/native.md'
-      (expect subject.run %W(-o - --no-html-to-native #{the_source_file})).to eql 0
-      expected = <<~EOS
-      +++<p>++++++<strong>+++strong emphasis (aka bold)+++</strong>+++ +++<em>+++emphasis (aka italic)+++</em>+++ +++<code>+++monospace+++</code>++++++</p>+++
-      EOS
-      (expect $stdout.string).to eql expected
-    end
-
-    it 'reads arguments from ARGV by default' do
-      old_ARGV = ARGV.dup
-      ARGV.replace %w(-v)
-      begin
-        (expect subject.run).to eql 0
-        (expect $stdout.string.chomp).to eql %(kramdoc #{Kramdown::AsciiDoc::VERSION})
-      ensure
-        ARGV.replace old_ARGV
-      end
-    end
-  end
-end