asciidoctor 1.5.8 → 2.0.0.rc.1

data/lib/asciidoctor/attribute_list.rb

@@ -1,4 +1,4 @@
-# encoding: UTF-8
+# frozen_string_literal: true
 module Asciidoctor
 # Public: Handles parsing AsciiDoc attribute lists into a Hash of key/value
 # pairs. By default, attributes must each be separated by a comma and quotes
@@ -11,15 +11,15 @@ module Asciidoctor
 #    attrlist = Asciidoctor::AttributeList.new('astyle')
 #
 #    attrlist.parse
-#    => {0 => 'astyle'}
+#    => { 0 => 'astyle' }
 #
 #    attrlist.rekey(['style'])
-#    => {'style' => 'astyle'}
+#    => { 'style' => 'astyle' }
 #
 #    attrlist = Asciidoctor::AttributeList.new('quote, Famous Person, Famous Book (2001)')
 #
 #    attrlist.parse(['style', 'attribution', 'citetitle'])
-#    => {'style' => 'quote', 'attribution' => 'Famous Person', 'citetitle' => 'Famous Book (2001)'}
+#    => { 'style' => 'quote', 'attribution' => 'Famous Person', 'citetitle' => 'Famous Book (2001)' }
 #
 class AttributeList
   BACKSLASH = '\\'
@@ -44,11 +44,8 @@ class AttributeList
 
   BlankRx = /[ \t]+/
 
-  # Public: Regular expressions for skipping blanks and delimiters
-  SkipRxs = {
-    :blank => BlankRx,
-    ',' => /[ \t]*(,|$)/
-  }
+  # Public: Regular expressions for skipping delimiters
+  SkipRxs = { ',' => /[ \t]*(,|$)/ }
 
   def initialize source, block = nil, delimiter = ','
     @scanner = ::StringScanner.new source
@@ -88,8 +85,7 @@ class AttributeList
   def self.rekey attributes, pos_attrs
     pos_attrs.each_with_index do |key, index|
       next unless key
-      pos = index + 1
-      if (val = attributes[pos])
+      if (val = attributes[index + 1])
         # QUESTION should we delete the positional key?
         attributes[key] = val
       end
@@ -98,6 +94,8 @@ class AttributeList
     attributes
   end
 
+  private
+
   def parse_attribute index = 0, pos_attrs = []
     single_quoted_value = false
     skip_blank
@@ -160,9 +158,8 @@ class AttributeList
           value = value.delete ' ' if value.include? ' '
           (value.split ',').each {|opt| @attributes[%(#{opt}-option)] = '' unless opt.empty? }
         else
-          @attributes[%(#{value = value.strip}-option)] = ''
+          @attributes[%(#{value}-option)] = '' unless value.empty?
         end
-        @attributes['options'] = value
       else
         if single_quoted_value && @block
           case name
@@ -227,6 +224,5 @@ class AttributeList
   def scan_to_quote quote
     @scanner.scan BoundaryRxs[quote]
   end
-
 end
 end

data/lib/asciidoctor/block.rb

@@ -1,26 +1,26 @@
-# encoding: UTF-8
+# frozen_string_literal: true
 module Asciidoctor
 # Public: Methods for managing blocks of Asciidoc content in a section.
 #
 # Examples
 #
-#   block = Asciidoctor::Block.new(parent, :paragraph, :source => '_This_ is a <test>')
+#   block = Asciidoctor::Block.new(parent, :paragraph, source: '_This_ is a <test>')
 #   block.content
 #   => "<em>This</em> is a &lt;test&gt;"
 class Block < AbstractBlock
 
   (DEFAULT_CONTENT_MODEL = {
     # TODO should probably fill in all known blocks
-    :audio => :empty,
-    :image => :empty,
-    :listing => :verbatim,
-    :literal => :verbatim,
-    :stem => :raw,
-    :open => :compound,
-    :page_break => :empty,
-    :pass => :raw,
-    :thematic_break => :empty,
-    :video => :empty
+    audio: :empty,
+    image: :empty,
+    listing: :verbatim,
+    literal: :verbatim,
+    stem: :raw,
+    open: :compound,
+    page_break: :empty,
+    pass: :raw,
+    thematic_break: :empty,
+    video: :empty,
   }).default = :simple
 
   # Public: Create alias for context to be consistent w/ AsciiDoc
@@ -43,7 +43,7 @@ class Block < AbstractBlock
   # the `lock_in_subs` method to resolve and assign the substitutions to this
   # block (which are resolved from the `subs` attribute, if specified, or the
   # default substitutions based on this block's context). If you want to use the
-  # default subs for a block, pass the option `:subs => :default`. You can
+  # default subs for a block, pass the option `subs: :default`. You can
   # override the default subs using the `:default_subs` option.
   #--
   # QUESTION should we store source_data as lines for blocks that have compound content models?
@@ -54,16 +54,16 @@ class Block < AbstractBlock
       # FIXME feels funky; we have to be defensive to get lock_in_subs to honor override
       # FIXME does not resolve substitution groups inside Array (e.g., [:normal])
       if (subs = opts[:subs])
-        # e.g., :subs => :defult
+        # e.g., subs: :defult
         # subs attribute is honored; falls back to opts[:default_subs], then built-in defaults based on context
         if subs == :default
           @default_subs = opts[:default_subs]
-        # e.g., :subs => [:quotes]
+        # e.g., subs: [:quotes]
         # subs attribute is not honored
         elsif ::Array === subs
           @default_subs = subs.drop 0
           @attributes.delete 'subs'
-        # e.g., :subs => :normal or :subs => 'normal'
+        # e.g., subs: :normal or subs: 'normal'
         # subs attribute is not honored
         else
           @default_subs = nil
@@ -71,8 +71,9 @@ class Block < AbstractBlock
           @attributes['subs'] = %(#{subs})
         end
         # resolve the subs eagerly only if subs option is specified
+        # QUESTION should we skip subsequent calls to lock_in_subs?
         lock_in_subs
-      # e.g., :subs => nil
+      # e.g., subs: nil
       else
         # NOTE @subs is initialized as empty array by super constructor
         # prevent subs from being resolved
@@ -88,7 +89,7 @@ class Block < AbstractBlock
     if (raw_source = opts[:source]).nil_or_empty?
       @lines = []
     elsif ::String === raw_source
-      @lines = Helpers.normalize_lines_from_string raw_source
+      @lines = Helpers.prepare_source_string raw_source
     else
       @lines = raw_source.drop 0
     end
@@ -101,7 +102,7 @@ class Block < AbstractBlock
   #
   #   doc = Asciidoctor::Document.new
   #   block = Asciidoctor::Block.new(doc, :paragraph,
-  #       :source => '_This_ is what happens when you <meet> a stranger in the <alps>!')
+  #       source: '_This_ is what happens when you <meet> a stranger in the <alps>!')
   #   block.content
   #   => "<em>This</em> is what happens when you &lt;meet&gt; a stranger in the &lt;alps&gt;!"
   def content

data/lib/asciidoctor/callouts.rb

@@ -1,4 +1,4 @@
-# encoding: UTF-8
+# frozen_string_literal: true
 module Asciidoctor
 # Public: Maintains a catalog of callouts and their associations.
 class Callouts
@@ -28,7 +28,7 @@ class Callouts
   #
   # Returns The unique String id of this callout
   def register li_ordinal
-    current_list << { :ordinal => li_ordinal.to_i, :id => (id = generate_next_callout_id) }
+    current_list << { ordinal: li_ordinal.to_i, id: (id = generate_next_callout_id) }
     @co_index += 1
     id
   end
@@ -93,6 +93,8 @@ class Callouts
     nil
   end
 
+  private
+
   # Internal: Generate a unique id for the callout based on the internal indexes
   #
   # Returns A unique String id for this callout

data/lib/asciidoctor/cli.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'optparse'
-require 'asciidoctor/cli/options'
-require 'asciidoctor/cli/invoker'
+require_relative 'cli/options'
+require_relative 'cli/invoker'

data/lib/asciidoctor/cli/invoker.rb

@@ -1,8 +1,9 @@
-# encoding: UTF-8
+# frozen_string_literal: true
 module Asciidoctor
   module Cli
     # Public Invocation class for starting Asciidoctor via CLI
     class Invoker
+      include Logging
 
       attr_reader :options
       attr_reader :documents
@@ -32,8 +33,8 @@ module Asciidoctor
       def invoke!
         return unless @options
 
-        old_verbose = $VERBOSE
         old_logger = old_logger_level = nil
+        old_verbose, $VERBOSE = $VERBOSE, @options[:warnings]
         opts = {}
         infiles = []
         outfile = nil
@@ -61,18 +62,14 @@ module Asciidoctor
           when :timings
             show_timings = val
           when :trace
-            # currently does nothing
+            # no assignment
           when :verbose
             case val
             when 0
               $VERBOSE = nil
-              old_logger = LoggerManager.logger
-              LoggerManager.logger = NullLogger.new
-            when 1
-              $VERBOSE = false
+              old_logger, LoggerManager.logger = logger, NullLogger.new
             when 2
-              $VERBOSE = true
-              old_logger_level, LoggerManager.logger.level = LoggerManager.logger.level, ::Logger::Severity::DEBUG
+              old_logger_level, logger.level = logger.level, ::Logger::Severity::DEBUG
             end
           else
             opts[key] = val unless val.nil?
@@ -101,16 +98,16 @@ module Asciidoctor
         if stdin
           # allows use of block to supply stdin, particularly useful for tests
           input = block_given? ? yield : STDIN
-          input_opts = opts.merge :to_file => tofile
+          input_opts = opts.merge to_file: tofile
           if show_timings
-            @documents << (::Asciidoctor.convert input, (input_opts.merge :timings => (timings = Timings.new)))
+            @documents << (::Asciidoctor.convert input, (input_opts.merge timings: (timings = Timings.new)))
             timings.print_report err, '-'
           else
             @documents << (::Asciidoctor.convert input, input_opts)
           end
         else
           infiles.each do |infile|
-            input_opts = opts.merge :to_file => tofile
+            input_opts = opts.merge to_file: tofile
             if abs_srcdir_posix && (input_opts.key? :to_dir)
               abs_indir = ::File.dirname ::File.expand_path infile
               if non_posix_env
@@ -123,29 +120,25 @@ module Asciidoctor
               end
             end
             if show_timings
-              @documents << (::Asciidoctor.convert_file infile, (input_opts.merge :timings => (timings = Timings.new)))
+              @documents << (::Asciidoctor.convert_file infile, (input_opts.merge timings: (timings = Timings.new)))
               timings.print_report err, infile
             else
               @documents << (::Asciidoctor.convert_file infile, input_opts)
             end
           end
         end
-        @code = 1 if ((logger = LoggerManager.logger).respond_to? :max_severity) && logger.max_severity && logger.max_severity >= opts[:failure_level]
+        @code = 1 if (logger.respond_to? :max_severity) && logger.max_severity && logger.max_severity >= opts[:failure_level]
       rescue ::Exception => e
         if ::SignalException === e
           @code = e.signo
-          # add extra endline if Ctrl+C is used
+          # add extra newline if Ctrl+C is used
           err.puts if ::Interrupt === e
         else
           @code = (e.respond_to? :status) ? e.status : 1
           if @options[:trace]
             raise e
           else
-            if ::RuntimeError === e
-              err.puts %(#{e.message} (#{e.class}))
-            else
-              err.puts e.message
-            end
+            err.puts ::RuntimeError === e ? %(#{e.message} (#{e.class})) : e.message
             err.puts '  Use --trace for backtrace'
           end
         end
@@ -155,7 +148,7 @@ module Asciidoctor
         if old_logger
           LoggerManager.logger = old_logger
         elsif old_logger_level
-          LoggerManager.logger.level = old_logger_level
+          logger.level = old_logger_level
         end
       end
 

data/lib/asciidoctor/cli/options.rb

@@ -1,4 +1,4 @@
-# encoding: UTF-8
+# frozen_string_literal: true
 module Asciidoctor
   module Cli
     FS = '/'
@@ -23,6 +23,7 @@ module Asciidoctor
         end
         self[:eruby] = options[:eruby] || nil
         self[:verbose] = options[:verbose] || 1
+        self[:warnings] = options[:warnings] || false
         self[:load_paths] = options[:load_paths] || nil
         self[:requires] = options[:requires] || nil
         self[:base_dir] = options[:base_dir]
@@ -39,15 +40,15 @@ module Asciidoctor
 
       def parse!(args)
         opts_parser = ::OptionParser.new do |opts|
-          opts.banner = <<-EOS
-Usage: asciidoctor [OPTION]... FILE...
-Translate the AsciiDoc source FILE or FILE(s) into the backend output format (e.g., HTML 5, DocBook 4.5, etc.)
-By default, the output is written to a file with the basename of the source file and the appropriate extension.
-Example: asciidoctor -b html5 source.asciidoc
+          opts.banner = <<~'EOS'
+          Usage: asciidoctor [OPTION]... FILE...
+          Translate the AsciiDoc source FILE or FILE(s) into the backend output format (e.g., HTML 5, DocBook 5, etc.)
+          By default, the output is written to a file with the basename of the source file and the appropriate extension.
+          Example: asciidoctor -b html5 source.asciidoc
 
           EOS
 
-          opts.on('-b', '--backend BACKEND', 'set output format backend: [html5, xhtml5, docbook5, docbook45, manpage] (default: html5)',
+          opts.on('-b', '--backend BACKEND', 'set output format backend: [html5, xhtml5, docbook5, manpage] (default: html5)',
                   'additional backends are supported via extensions (e.g., pdf, latex)') do |backend|
             self[:attributes]['backend'] = backend
           end
@@ -82,8 +83,9 @@ Example: asciidoctor -b html5 source.asciidoc
           opts.on('-a', '--attribute key[=value]', 'a document attribute to set in the form of key, key! or key=value pair',
                   'unless @ is appended to the value, this attributes takes precedence over attributes',
                   'defined in the source document') do |attr|
-            key, val = attr.split '=', 2
-            val = val ? (FORCE_ENCODING ? (val.force_encoding ::Encoding::UTF_8) : val) : ''
+            next if (attr = attr.rstrip).empty? || attr == '='
+            attr = attr.encode UTF_8 unless attr.encoding == UTF_8
+            key, _, val = attr.partition '='
             self[:attributes][key] = val
           end
           opts.on('-T', '--template-dir DIR', 'a directory containing custom converter templates that override the built-in converter (requires tilt gem)',
@@ -118,42 +120,47 @@ Example: asciidoctor -b html5 source.asciidoc
           end
           opts.on('--failure-level LEVEL', %w(warning WARNING error ERROR), 'set minimum logging level that triggers a non-zero exit code: [WARN, ERROR] (default: FATAL)') do |level|
             level = 'WARN' if (level = level.upcase) == 'WARNING'
-            self[:failure_level] = ::Logger::Severity.const_get level
+            self[:failure_level] = ::Logger::Severity.const_get level, false
           end
-          opts.on('-q', '--quiet', 'suppress warnings (default: false)') do |verbose|
+          opts.on('-q', '--quiet', 'silence application log messages and script warnings (default: false)') do |verbose|
             self[:verbose] = 0
           end
-          opts.on('--trace', 'include backtrace information on errors (default: false)') do |trace|
+          opts.on('--trace', 'include backtrace information when reporting errors (default: false)') do |trace|
             self[:trace] = true
           end
           opts.on('-v', '--verbose', 'enable verbose mode (default: false)') do |verbose|
             self[:verbose] = 2
           end
-          opts.on('-t', '--timings', 'enable timings mode (default: false)') do |timing|
+          opts.on('-w', '--warnings', 'turn on script warnings (default: false)') do |warnings|
+            self[:warnings] = true
+          end
+          opts.on('-t', '--timings', 'print timings report (default: false)') do |timing|
             self[:timings] = true
           end
-
-          opts.on_tail('-h', '--help [TOPIC]', 'print the help message',
-              'show the command usage if TOPIC is not specified (or not recognized)',
+          opts.on_tail('-h', '--help [TOPIC]', 'print a help message',
+              'show this usage if TOPIC is not specified or recognized',
+              'show an overview of the AsciiDoc syntax if TOPIC is syntax',
               'dump the Asciidoctor man page (in troff/groff format) if TOPIC is manpage') do |topic|
-            if topic == 'manpage'
-              if (manpage_path = ENV['ASCIIDOCTOR_MANPAGE_PATH'])
+            case topic
+            # use `asciidoctor -h manpage | man -l -` to view with man pager
+            when 'manpage'
+              if (manpage_path = ::ENV['ASCIIDOCTOR_MANPAGE_PATH'])
                 if ::File.exist? manpage_path
                   if manpage_path.end_with? '.gz'
                     require 'zlib' unless defined? ::Zlib::GzipReader
                     $stdout.puts ::Zlib::GzipReader.open(manpage_path) {|gz| gz.read }
                   else
-                    $stdout.puts ::IO.read manpage_path
+                    $stdout.puts ::File.read manpage_path
                   end
                 else
                   $stderr.puts %(asciidoctor: FAILED: manual page not found: #{manpage_path})
                   return 1
                 end
-              elsif ::File.exist?(manpage_path = (::File.join ::Asciidoctor::ROOT_PATH, 'man', 'asciidoctor.1'))
-                $stdout.puts ::IO.read manpage_path
+              # Ruby 2.3 requires the extra brackets around the ::File.join method call
+              elsif ::File.exist? (manpage_path = (::File.join ROOT_DIR, 'man', 'asciidoctor.1'))
+                $stdout.puts ::File.read manpage_path
               else
-                require 'open3' unless defined? ::Open3.popen3
-                manpage_path = ::Open3.popen3('man -w asciidoctor') {|_, out| out.read }.chop rescue ''
+                manpage_path = `man -w asciidoctor`.chop rescue ''
                 if manpage_path.empty?
                   $stderr.puts 'asciidoctor: FAILED: manual page not found; try `man asciidoctor`'
                   return 1
@@ -161,26 +168,32 @@ Example: asciidoctor -b html5 source.asciidoc
                   require 'zlib' unless defined? ::Zlib::GzipReader
                   $stdout.puts ::Zlib::GzipReader.open(manpage_path) {|gz| gz.read }
                 else
-                  $stdout.puts ::IO.read manpage_path
+                  $stdout.puts ::File.read manpage_path
                 end
               end
+            when 'syntax'
+              # Ruby 2.3 requires the extra brackets around the ::File.join method call
+              if ::File.exist? (syntax_path = (::File.join ROOT_DIR, 'data', 'reference', 'syntax.adoc'))
+                $stdout.puts ::File.read syntax_path
+              else
+                $stderr.puts 'asciidoctor: FAILED: syntax page not found; visit https://asciidoctor.org/docs'
+                return 1
+              end
             else
               $stdout.puts opts
             end
             return 0
           end
-
           opts.on_tail('-V', '--version', 'display the version and runtime environment (or -v if no other flags or arguments)') do
             return print_version $stdout
           end
-
         end
 
-        infiles = []
+        old_verbose, $VERBOSE = $VERBOSE, (args.include? '-w')
         opts_parser.parse! args
 
         if args.empty?
-          if self[:verbose] == 2
+          if self[:verbose] == 2 # -v flag was specified
             return print_version $stdout
           else
             $stderr.puts opts_parser
@@ -188,29 +201,28 @@ Example: asciidoctor -b html5 source.asciidoc
           end
         end
 
+        infiles = []
         # shave off the file to process so that options errors appear correctly
         if args.size == 1 && args[0] == '-'
           infiles << args.pop
         elsif
           args.each do |file|
-            if file == '-' || (file.start_with? '-')
+            if file.start_with? '-'
               # warn, but don't panic; we may have enough to proceed, so we won't force a failure
               $stderr.puts %(asciidoctor: WARNING: extra arguments detected (unparsed arguments: '#{args.join "', '"}') or incorrect usage of stdin)
+            elsif ::File.file? file
+              infiles << file
+            # NOTE only attempt to glob if file is not found
             else
-              if ::File.file? file
+              # Tilt backslashes in Windows paths the Ruby-friendly way
+              if ::File::ALT_SEPARATOR == RS && (file.include? RS)
+                file = file.tr RS, FS
+              end
+              if (matches = ::Dir.glob file).empty?
+                # NOTE if no matches, assume it's just a missing file and proceed
                 infiles << file
-              # NOTE only attempt to glob if file is not found
               else
-                # Tilt backslashes in Windows paths the Ruby-friendly way
-                if ::File::ALT_SEPARATOR == RS && (file.include? RS)
-                  file = file.tr RS, FS
-                end
-                if (matches = ::Dir.glob file).empty?
-                  # NOTE if no matches, assume it's just a missing file and proceed
-                  infiles << file
-                else
-                  infiles.concat matches
-                end
+                infiles.concat matches
               end
             end
           end
@@ -236,11 +248,11 @@ Example: asciidoctor -b html5 source.asciidoc
 
         self[:input_files] = infiles
 
-        self.delete(:attributes) if self[:attributes].empty?
+        self.delete :attributes if self[:attributes].empty?
 
         if self[:template_dirs]
           begin
-            require 'tilt' unless defined? ::Tilt::VERSION
+            require 'tilt' unless defined? ::Tilt.new
           rescue ::LoadError
             raise $! if self[:trace]
             $stderr.puts 'asciidoctor: FAILED: \'tilt\' could not be loaded'
@@ -253,13 +265,13 @@ Example: asciidoctor -b html5 source.asciidoc
         end
 
         if (load_paths = self[:load_paths])
-          (self[:load_paths] = load_paths.uniq).reverse_each do |path|
-            $:.unshift ::File.expand_path(path)
-          end
+          load_paths.uniq!
+          load_paths.reverse_each {|path| $:.unshift ::File.expand_path path }
         end
 
         if (requires = self[:requires])
-          (self[:requires] = requires.uniq).each do |path|
+          requires.uniq!
+          requires.each do |path|
             begin
               require path
             rescue ::LoadError
@@ -282,18 +294,16 @@ Example: asciidoctor -b html5 source.asciidoc
         $stderr.puts %(asciidoctor: #{$!.message})
         $stdout.puts opts_parser
         return 1
+      ensure
+        $VERBOSE = old_verbose
       end
 
       def print_version os = $stdout
         os.puts %(Asciidoctor #{::Asciidoctor::VERSION} [https://asciidoctor.org])
-        if ::RUBY_MIN_VERSION_1_9
-          encoding_info = { 'lc' => 'locale', 'fs' => 'filesystem', 'in' => 'internal', 'ex' => 'external' }.map do |k, v|
-            %(#{k}:#{v == 'internal' ? (::File.open(__FILE__) {|f| f.getc }).encoding : (::Encoding.find v)})
-          end
-          os.puts %(Runtime Environment (#{::RUBY_DESCRIPTION}) (#{encoding_info.join ' '}))
-        else
-          os.puts %(Runtime Environment (#{::RUBY_DESCRIPTION}))
+        encoding_info = { 'lc' => 'locale', 'fs' => 'filesystem', 'in' => 'internal', 'ex' => 'external' }.map do |k, v|
+          %(#{k}:#{v == 'internal' ? (::File.open(__FILE__) {|f| f.getc.encoding }) : (::Encoding.find v)})
         end
+        os.puts %(Runtime Environment (#{::RUBY_DESCRIPTION}) (#{encoding_info.join ' '}))
         0
       end
     end