asciidoctor 1.5.6.2 → 1.5.7

data/test/logger_test.rb

@@ -0,0 +1,211 @@
+# encoding: UTF-8
+unless defined? ASCIIDOCTOR_PROJECT_DIR
+  $: << File.dirname(__FILE__); $:.uniq!
+  require 'test_helper'
+end
+
+context 'Logger' do
+  MyLogger = Class.new Logger
+
+  context 'LoggerManager' do
+    test 'provides access to logger via static logger method' do
+      logger = Asciidoctor::LoggerManager.logger
+      refute_nil logger
+      assert_kind_of Logger, logger
+    end
+
+    test 'allows logger instance to be changed' do
+      old_logger = Asciidoctor::LoggerManager.logger
+      new_logger = MyLogger.new $stdout
+      begin
+        Asciidoctor::LoggerManager.logger = new_logger
+        assert_same new_logger, Asciidoctor::LoggerManager.logger
+      ensure
+        Asciidoctor::LoggerManager.logger = old_logger
+      end
+    end
+
+    test 'setting logger instance to falsy value resets instance to default logger' do
+      old_logger = Asciidoctor::LoggerManager.logger
+      begin
+        Asciidoctor::LoggerManager.logger = MyLogger.new $stdout
+        Asciidoctor::LoggerManager.logger = nil
+        refute_nil Asciidoctor::LoggerManager.logger
+        assert_kind_of Logger, Asciidoctor::LoggerManager.logger
+      ensure
+        Asciidoctor::LoggerManager.logger = old_logger
+      end
+    end
+
+    test 'creates logger instance from static logger_class property' do
+      old_logger_class = Asciidoctor::LoggerManager.logger_class
+      old_logger = Asciidoctor::LoggerManager.logger
+      begin
+        Asciidoctor::LoggerManager.logger_class = MyLogger
+        Asciidoctor::LoggerManager.logger = nil
+        refute_nil Asciidoctor::LoggerManager.logger
+        assert_kind_of MyLogger, Asciidoctor::LoggerManager.logger
+      ensure
+        Asciidoctor::LoggerManager.logger_class = old_logger_class
+        Asciidoctor::LoggerManager.logger = old_logger
+      end
+    end
+  end
+
+  context 'Logger' do
+    test 'configures default logger with progname set to asciidoctor' do
+      assert_equal 'asciidoctor', Asciidoctor::LoggerManager.logger.progname
+    end
+
+    test 'configures default logger with level set to WARN' do
+      assert_equal Logger::Severity::WARN, Asciidoctor::LoggerManager.logger.level
+    end
+
+    test 'configures default logger to write messages to $stderr' do
+      out_string, err_string = redirect_streams do |out, err|
+        Asciidoctor::LoggerManager.logger.warn 'this is a call'
+        [out.string, err.string]
+      end
+      assert_empty out_string
+      refute_empty err_string
+      assert_includes err_string, 'this is a call'
+    end
+
+    test 'configures default logger to use a formatter that matches traditional format' do
+      err_string = redirect_streams do |_, err|
+        Asciidoctor::LoggerManager.logger.warn 'this is a call'
+        Asciidoctor::LoggerManager.logger.fatal 'it cannot be done'
+        err.string
+      end
+      assert_includes err_string, %(asciidoctor: WARNING: this is a call)
+      assert_includes err_string, %(asciidoctor: FAILED: it cannot be done)
+    end
+  end
+
+  context ':logger API option' do
+    test 'should be able to set logger when invoking load API' do
+      old_logger = Asciidoctor::LoggerManager.logger
+      new_logger = MyLogger.new $stdout
+      begin
+        Asciidoctor.load 'contents', :logger => new_logger
+        assert_same new_logger, Asciidoctor::LoggerManager.logger
+      ensure
+        Asciidoctor::LoggerManager.logger = old_logger
+      end
+    end
+
+    test 'should be able to set logger when invoking load_file API' do
+      old_logger = Asciidoctor::LoggerManager.logger
+      new_logger = MyLogger.new $stdout
+      begin
+        Asciidoctor.load_file fixture_path('basic.asciidoc'), :logger => new_logger
+        assert_same new_logger, Asciidoctor::LoggerManager.logger
+      ensure
+        Asciidoctor::LoggerManager.logger = old_logger
+      end
+    end
+
+    test 'should be able to set logger when invoking convert API' do
+      old_logger = Asciidoctor::LoggerManager.logger
+      new_logger = MyLogger.new $stdout
+      begin
+        Asciidoctor.convert 'contents', :logger => new_logger
+        assert_same new_logger, Asciidoctor::LoggerManager.logger
+      ensure
+        Asciidoctor::LoggerManager.logger = old_logger
+      end
+    end
+
+    test 'should be able to set logger when invoking convert_file API' do
+      old_logger = Asciidoctor::LoggerManager.logger
+      new_logger = MyLogger.new $stdout
+      begin
+        Asciidoctor.convert_file fixture_path('basic.asciidoc'), :to_file => false, :logger => new_logger
+        assert_same new_logger, Asciidoctor::LoggerManager.logger
+      ensure
+        Asciidoctor::LoggerManager.logger = old_logger
+      end
+    end
+  end
+
+  context 'Logging' do
+    test 'including Logging gives instance methods on module access to logging infrastructure' do
+      module SampleModuleA
+        include Asciidoctor::Logging
+        def get_logger
+          logger
+        end
+      end
+
+      class SampleClassA
+        include SampleModuleA
+      end
+      assert_same Asciidoctor::LoggerManager.logger, SampleClassA.new.get_logger
+      assert SampleClassA.private_method_defined? :logger
+    end
+
+    test 'including Logging gives static methods on module access to logging infrastructure' do
+      module SampleModuleB
+        include Asciidoctor::Logging
+        def self.get_logger
+          logger
+        end
+      end
+
+      assert_same Asciidoctor::LoggerManager.logger, SampleModuleB.get_logger
+    end
+
+    test 'including Logging gives instance methods on class access to logging infrastructure' do
+      class SampleClassC
+        include Asciidoctor::Logging
+        def get_logger
+          logger
+        end
+      end
+
+      assert_same Asciidoctor::LoggerManager.logger, SampleClassC.new.get_logger
+      assert SampleClassC.private_method_defined? :logger
+    end
+
+    test 'including Logging gives static methods on class access to logging infrastructure' do
+      class SampleClassD
+        include Asciidoctor::Logging
+        def self.get_logger
+          logger
+        end
+      end
+
+      assert_same Asciidoctor::LoggerManager.logger, SampleClassD.get_logger
+    end
+
+    test 'can create an auto-formatting message with context' do
+      class SampleClassE
+        include Asciidoctor::Logging
+        def create_message cursor
+          message_with_context 'Asciidoctor was here', :source_location => cursor
+        end
+      end
+
+      cursor = Asciidoctor::Reader::Cursor.new 'file.adoc', fixturedir, 'file.adoc', 5
+      message = SampleClassE.new.create_message cursor
+      assert_equal 'Asciidoctor was here', message[:text]
+      assert_same cursor, message[:source_location]
+      assert_equal 'file.adoc: line 5: Asciidoctor was here', message.inspect
+    end
+
+    test 'writes message prefixed with program name and source location to stderr' do
+      input = <<-EOS
+[#first]
+first paragraph
+
+[#first]
+another first paragraph
+      EOS
+      messages = redirect_streams do |_, err|
+        render_embedded_string input
+        err.string
+      end
+      assert_equal 'asciidoctor: WARNING: <stdin>: line 5: id assigned to block already in use: first', messages.chomp
+    end
+  end
+end

data/test/manpage_test.rb

@@ -37,33 +37,85 @@ context 'Manpage' do
       assert_equal 'command', doc.attributes['docname']
     end
 
+    test 'should output multiple mannames in NAME section' do
+      input = SAMPLE_MANPAGE_HEADER.sub(/^command - /, 'command, alt_command - ')
+      output = Asciidoctor.convert input, :backend => :manpage, :header_footer => true
+      assert_includes output.lines, %(command, alt_command \\- does stuff\n)
+    end
+
+    test 'should skip line comments in NAME section' do
+      input = <<-EOS
+= foobar (1)
+Author Name
+:doctype: manpage
+:man manual: Foo Bar Manual
+:man source: Foo Bar 1.0
+
+== NAME
+
+// follows the form `name - description`
+foobar - puts some foo on the bar
+// a little bit of this, a little bit of that
+
+== SYNOPSIS
+
+*foobar* [_OPTIONS_]...
+
+== DESCRIPTION
+
+When you need to put some foo on the bar.
+      EOS
+
+      doc = Asciidoctor.load input, :backend => :manpage, :header_footer => true
+      assert_equal 'puts some foo on the bar', (doc.attr 'manpurpose')
+    end
+
     test 'should define default linkstyle' do
       input = SAMPLE_MANPAGE_HEADER
       output = Asciidoctor.convert input, :backend => :manpage, :header_footer => true
-      assert_includes output.lines, %(.LINKSTYLE blue R < >\n)
+      assert_includes output.lines, %(.  LINKSTYLE blue R < >\n)
     end
 
     test 'should use linkstyle defined by man-linkstyle attribute' do
       input = SAMPLE_MANPAGE_HEADER
       output = Asciidoctor.convert input, :backend => :manpage, :header_footer => true,
           :attributes => { 'man-linkstyle' => 'cyan B \[fo] \[fc]' }
-      assert_includes output.lines, %(.LINKSTYLE cyan B \\[fo] \\[fc]\n)
+      assert_includes output.lines, %(.  LINKSTYLE cyan B \\[fo] \\[fc]\n)
     end
 
     test 'should require specialchars in value of man-linkstyle attribute defined in document to be escaped' do
       input = %(:man-linkstyle: cyan R < >
 #{SAMPLE_MANPAGE_HEADER})
       output = Asciidoctor.convert input, :backend => :manpage, :header_footer => true
-      assert_includes output.lines, %(.LINKSTYLE cyan R &lt; &gt;\n)
+      assert_includes output.lines, %(.  LINKSTYLE cyan R &lt; &gt;\n)
 
       input = %(:man-linkstyle: pass:[cyan R < >]
 #{SAMPLE_MANPAGE_HEADER})
       output = Asciidoctor.convert input, :backend => :manpage, :header_footer => true
-      assert_includes output.lines, %(.LINKSTYLE cyan R < >\n)
+      assert_includes output.lines, %(.  LINKSTYLE cyan R < >\n)
     end
   end
 
   context 'Manify' do
+    test 'should unescape literal ampersand' do
+      input = %(#{SAMPLE_MANPAGE_HEADER}
+
+(C) & (R) are translated to character references, but not the &.)
+      output = Asciidoctor.convert input, :backend => :manpage
+      assert_equal '\\(co & \\(rg are translated to character references, but not the &.', output.lines.entries.last.chomp
+    end
+
+    test 'should replace em dashes' do
+      input = %(#{SAMPLE_MANPAGE_HEADER}
+
+go -- to
+
+go--to)
+      output = Asciidoctor.convert input, :backend => :manpage
+      assert_includes output, 'go \\(em to'
+      assert_includes output, 'go\\(emto'
+    end
+
     test 'should escape lone period' do
       input = %(#{SAMPLE_MANPAGE_HEADER}
 
@@ -98,7 +150,7 @@ BBB this line and the one above it should be visible)
 
 "`hello`" '`goodbye`' *strong* _weak_ `even`)
       output = Asciidoctor.convert input, :backend => :manpage
-      assert_equal '\(lqhello\(rq \(oqgoodbye\(cq \fBstrong\fP \fIweak\fP \f[CR]even\fP', output.lines.entries.last.chomp
+      assert_equal '\(lqhello\(rq \(oqgoodbye\(cq \fBstrong\fP \fIweak\fP \f(CReven\fP', output.lines.entries.last.chomp
     end
 
     test 'should escape backslashes in content' do
@@ -216,15 +268,81 @@ Please search |\c
 .URL "http://discuss.asciidoctor.org" "the forums" "|"
 before asking.', output.lines.entries[-4..-1].join
     end
+
+    test 'should be able to use monospaced text inside a link' do
+      input = %(#{SAMPLE_MANPAGE_HEADER}
+
+Enter the link:cat[`cat`] command.)
+      output = Asciidoctor.convert input, :backend => :manpage
+      assert_equal '.sp
+Enter the \c
+.URL "cat" "\f(CRcat\fP" " "
+command.', output.lines.entries[-4..-1].join
+    end
+  end
+
+  context 'MTO macro' do
+    test 'should convert inline email macro into MTO macro' do
+      input = %(#{SAMPLE_MANPAGE_HEADER}
+First paragraph.
+
+mailto:doc@example.org[Contact the doc])
+      output = Asciidoctor.convert input, :backend => :manpage
+      assert_equal '.sp
+First paragraph.
+.sp
+.MTO "doc\\(atexample.org" "Contact the doc" ""', output.lines.entries[-4..-1].join
+    end
+
+    test 'should set text of MTO macro to blank for implicit email' do
+      input = %(#{SAMPLE_MANPAGE_HEADER}
+Bugs fixed daily by doc@example.org.)
+      output = Asciidoctor.convert input, :backend => :manpage
+      assert output.end_with? 'Bugs fixed daily by \\c
+.MTO "doc\\(atexample.org" "" "."'
+    end
   end
 
   context 'Table' do
+    test 'should create header, body, and footer rows in correct order' do
+      input = %(#{SAMPLE_MANPAGE_HEADER}
+
+[%header%footer]
+|===
+|Header
+|Body 1
+|Body 2
+|Footer
+|===)
+      output = Asciidoctor.convert input, :backend => :manpage
+      assert output.end_with? 'allbox tab(:);
+lt.
+T{
+.sp
+Header
+T}
+T{
+.sp
+Body 1
+T}
+T{
+.sp
+Body 2
+T}
+T{
+.sp
+Footer
+T}
+.TE
+.sp'
+    end
+
     test 'should manify normal table cell content' do
       input = %(#{SAMPLE_MANPAGE_HEADER}
 
-[%header%footer,cols=2*]
 |===
 |*Col A* |_Col B_
+
 |*bold* |`mono`
 |_italic_ | #mark#
 |===)

data/test/options_test.rb

@@ -31,6 +31,24 @@ context 'Options' do
     assert_includes output, '.TH "ASCIIDOCTOR"'
   end
 
+  test 'should print message and return error code 1 when manpage is not found' do
+    old_manpage_path = ENV['ASCIIDOCTOR_MANPAGE_PATH']
+    begin
+      ENV['ASCIIDOCTOR_MANPAGE_PATH'] = (manpage_path = fixture_path 'no-such-file.1')
+      redirect_streams do |out, stderr|
+        exitval = Asciidoctor::Cli::Options.parse!(%w(-h manpage))
+        assert_equal 1, exitval
+        assert_equal %(asciidoctor: FAILED: manual page not found: #{manpage_path}), stderr.string.chomp
+      end
+    ensure
+      if old_manpage_path
+        ENV['ASCIIDOCTOR_MANPAGE_PATH'] = old_manpage_path
+      else
+        ENV.delete 'ASCIIDOCTOR_MANPAGE_PATH'
+      end
+    end
+  end
+
   test 'should return error code 1 when invalid option present' do
     redirect_streams do |stdout, stderr|
       exitval = Asciidoctor::Cli::Options.parse!(%w(--foobar))
@@ -58,7 +76,7 @@ context 'Options' do
   test 'should emit warning when unparsed options remain' do
     redirect_streams do |stdout, stderr|
       options = Asciidoctor::Cli::Options.parse!(%w(-b docbook - -))
-      assert options.is_a? Hash
+      assert_kind_of Hash, options
       assert_match(/asciidoctor: WARNING: extra arguments .*/, stderr.string.chomp)
     end
   end
@@ -184,6 +202,33 @@ context 'Options' do
     end
   end
 
+  test 'should set failure level to FATAL by default' do
+    options = Asciidoctor::Cli::Options.parse! %W(test/fixtures/sample.asciidoc)
+    assert_equal ::Logger::Severity::FATAL, options[:failure_level]
+  end
+
+  test 'should allow failure level to be set to WARN' do
+    %w(w warn WARN warning WARNING).each do |val|
+      options = Asciidoctor::Cli::Options.parse!(%W(--failure-level=#{val} test/fixtures/sample.asciidoc))
+      assert_equal ::Logger::Severity::WARN, options[:failure_level]
+    end
+  end
+
+  test 'should allow failure level to be set to ERROR' do
+    %w(e err ERR error ERROR).each do |val|
+      options = Asciidoctor::Cli::Options.parse!(%W(--failure-level=#{val} test/fixtures/sample.asciidoc))
+      assert_equal ::Logger::Severity::ERROR, options[:failure_level]
+    end
+  end
+
+  test 'should not allow failure level to be set to unknown value' do
+    exit_code, messages = redirect_streams do |_, err|
+      [(Asciidoctor::Cli::Options.parse! %W(--failure-level=foobar test/fixtures/sample.asciidoc)), err.string]
+    end
+    assert_equal 1, exit_code
+    assert_includes messages, 'invalid argument: --failure-level=foobar'
+  end
+
   test 'should set verbose to 2 when -v flag is specified' do
     options = Asciidoctor::Cli::Options.parse!(%w(-v test/fixtures/sample.asciidoc))
     assert_equal 2, options[:verbose]