asciidoctor 0.0.9 → 0.1.0

data/lib/asciidoctor/cli/invoker.rb

@@ -0,0 +1,105 @@
+module Asciidoctor
+  module Cli
+    # Public Invocation class for starting Asciidoctor via CLI
+    class Invoker
+      attr_reader :options
+      attr_reader :document
+      attr_reader :code
+      attr_reader :timings
+
+      def initialize(*options)
+        @document = nil
+        @out = nil
+        @err = nil
+        @code = 0
+        @timings = {}
+        options = options.flatten
+        if !options.empty? && options.first.is_a?(Asciidoctor::Cli::Options)
+          @options = options.first
+        elsif options.first.is_a? Hash
+          @options = Asciidoctor::Cli::Options.new(options)
+        else
+          @options = Asciidoctor::Cli::Options.parse!(options)
+          # hmmm
+          if @options.is_a?(Integer)
+            @code = @options
+            @options = nil
+          end
+        end
+      end
+
+      def invoke!
+        return if @options.nil?
+
+        begin
+          @timings = {}
+          infile = @options[:input_file]
+          outfile = @options[:output_file]
+          if infile == '-'
+            # allow use of block to supply stdin, particularly useful for tests
+            input = block_given? ? yield : STDIN
+          else
+            input = File.new(infile)
+          end
+          start = Time.now
+          @document = Asciidoctor.load(input, @options)
+          timings[:parse] = Time.now - start
+          start = Time.now
+          output = @document.render
+          timings[:render] = Time.now - start
+          if @options[:verbose]
+            puts "Time to read and parse source: #{timings[:parse]}"
+            puts "Time to render document: #{timings[:render]}"
+            puts "Total time to read, parse and render: #{timings.reduce(0) {|sum, (_, v)| sum += v}}"
+          end
+          if outfile == '/dev/null'
+            # output nothing
+          elsif outfile == '-' || (infile == '-' && (outfile.nil? || outfile.empty?))
+            (@out || $stdout).puts output
+          else
+            if outfile.nil? || outfile.empty?
+              if @options[:destination_dir]
+                destination_dir = File.expand_path(@options[:destination_dir])
+              else
+                destination_dir = @document.base_dir
+              end
+              outfile = File.join(destination_dir, "#{@document.attributes['docname']}#{@document.attributes['outfilesuffix']}")
+            else
+              outfile = @document.normalize_asset_path outfile
+            end
+
+            # this assignment is primarily for testing or other post analysis
+            @document.attributes['outfile'] = outfile
+            @document.attributes['outdir'] = File.dirname(outfile)
+            File.open(outfile, 'w') {|file| file.write output }
+          end
+        rescue Exception => e
+          raise e if @options[:trace] || SystemExit === e
+          err = (@err || $stderr)
+          err.print "#{e.class}: " if e.class != RuntimeError
+          err.puts e.message
+          err.puts '  Use --trace for backtrace'
+          @code = 1
+        end
+      end
+
+      def redirect_streams(out, err = nil)
+        @out = out
+        @err = err
+      end
+
+      def read_output
+        !@out.nil? ? @out.string : ''
+      end
+
+      def read_error
+        !@err.nil? ? @err.string : ''
+      end
+
+      def reset_streams
+        @out = nil
+        @err = nil
+      end
+    end
+  end
+end

data/lib/asciidoctor/cli/options.rb

@@ -0,0 +1,146 @@
+require 'optparse'
+
+module Asciidoctor
+  module Cli
+
+    # Public: List of options that can be specified on the command line
+    class Options < Hash
+
+      def initialize(options = {})
+        self[:attributes] = options[:attributes] || {}
+        self[:input_file] = options[:input_file] || nil
+        self[:output_file] = options[:output_file] || nil
+        self[:safe] = options[:safe] || Asciidoctor::SafeMode::UNSAFE
+        self[:header_footer] = options[:header_footer] || true
+        self[:template_dir] = options[:template_dir] || nil
+        if options[:doctype]
+          self[:attributes]['doctype'] = options[:doctype]
+        end
+        if options[:backend]
+          self[:attributes]['backend'] = options[:backend]
+        end
+        self[:eruby] = options[:eruby] || nil
+        self[:compact] = options[:compact] || false
+        self[:verbose] = options[:verbose] || false
+        self[:base_dir] = options[:base_dir] || nil
+        self[:destination_dir] = options[:destination_dir] || nil
+        self[:trace] = false
+      end
+
+      def self.parse!(args)
+        Options.new.parse! args
+      end
+
+      def parse!(args)
+        opts_parser = OptionParser.new do |opts|
+          opts.banner = <<-EOS
+Usage: asciidoctor [OPTION]... [FILE]
+Translate the AsciiDoc source FILE 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
+
+          EOS
+
+          opts.on('-v', '--verbose', 'enable verbose mode (default: false)') do |verbose|
+            self[:verbose] = true
+          end
+          opts.on('-b', '--backend BACKEND', ['html5', 'docbook45'], 'set output format (i.e., backend): [html5, docbook45] (default: html5)') do |backend|
+            self[:attributes]['backend'] = backend
+          end
+          opts.on('-d', '--doctype DOCTYPE', ['article', 'book'],
+                  'document type to use when rendering output: [article, book] (default: article)') do |doc_type|
+            self[:attributes]['doctype'] = doc_type
+          end
+          opts.on('-o', '--out-file FILE', 'output file (default: based on input file path); use - to output to STDOUT') do |output_file|
+            self[:output_file] = output_file
+          end
+          opts.on('--safe',
+                  'set safe mode to safe (default: secure)',
+                  'enables include macros, but restricts access to ancestor paths of source file',
+                  'provided for compatibility with the asciidoc command') do
+            self[:safe] = Asciidoctor::SafeMode::SAFE
+          end
+          opts.on('-S', '--safe-mode SAFE_MODE', ['unsafe', 'safe', 'secure'],
+                  'set safe mode level explicitly: [unsafe, safe, secure] (default: secure)',
+                  'disables potentially dangerous macros in source files, such as include::[]') do |safe_mode|
+            self[:safe] = Asciidoctor::SafeMode.const_get(safe_mode.upcase)
+          end
+          opts.on('-s', '--no-header-footer', 'suppress output of header and footer (default: false)') do
+            self[:header_footer] = false
+          end
+          opts.on('-n', '--section-numbers', 'auto-number section titles in the HTML backend; disabled by default') do
+            self[:attributes]['numbered'] = ''
+          end
+          opts.on('-e', '--eruby ERUBY', ['erb', 'erubis'],
+                  'specify eRuby implementation to render built-in templates: [erb, erubis] (default: erb)') do |eruby|
+            self[:eruby] = eruby
+          end
+          opts.on('-C', '--compact', 'compact the output by removing blank lines (default: false)') do
+            self[:compact] = true
+          end
+          opts.on('-a', '--attribute key1=value,key2=value2,...', Array,
+                  'a list of attributes, in the form key or key=value pair, to set on the document',
+                  'these attributes take precedence over attributes defined in the source file') do |attribs|
+            attribs.each do |attrib|
+              tokens = attrib.split('=')
+              self[:attributes][tokens[0]] = tokens[1] || ''
+            end
+          end
+          opts.on('-T', '--template-dir DIR', 'directory containing custom render templates the override the built-in set') do |template_dir|
+            self[:template_dir] = template_dir
+          end
+          opts.on('-B', '--base-dir DIR', 'base directory containing the document and resources (default: directory of source file)') do |base_dir|
+            self[:base_dir] = base_dir
+          end
+          opts.on('-D', '--destination-dir DIR', 'destination output directory (default: directory of source file)') do |dest_dir|
+            self[:destination_dir] = dest_dir
+          end
+          opts.on('--trace', 'include backtrace information on errors (default: false)') do |trace|
+            self[:trace] = true
+          end
+
+          opts.on_tail('-h', '--help', 'show this message') do
+            $stdout.puts opts
+            return 0
+          end
+
+          opts.on_tail('-V', '--version', 'display the version') do
+            $stdout.puts "Asciidoctor #{Asciidoctor::VERSION} [http://asciidoctor.org]"
+            return 0
+          end
+          
+        end
+
+        begin
+          # shave off the file to process so that options errors appear correctly
+          if args.last && (args.last == '-' || !args.last.start_with?('-'))
+            self[:input_file] = args.pop
+          end
+          opts_parser.parse!(args)
+          if args.size > 0
+            # 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.map{|a| "'#{a}'"} * ', '})"
+          end
+
+          if self[:input_file].nil? || self[:input_file].empty?
+            $stderr.puts opts_parser
+            return 1
+          elsif self[:input_file] != '-' && !File.exist?(self[:input_file])
+            $stderr.puts "asciidoctor: FAILED: input file #{self[:input_file]} missing"
+            return 1
+          end
+        rescue OptionParser::MissingArgument
+          $stderr.puts "asciidoctor: option #{$!.message}"
+          $stdout.puts opts_parser
+          return 1
+        rescue OptionParser::InvalidOption, OptionParser::InvalidArgument
+          $stderr.puts "asciidoctor: #{$!.message}"
+          $stdout.puts opts_parser
+          return 1
+        end
+        self
+      end # parse()
+
+    end
+  end
+end

data/lib/asciidoctor/document.rb

@@ -19,6 +19,8 @@ class Asciidoctor::Document < Asciidoctor::AbstractBlock
 
   include Asciidoctor
 
+  Footnote = Struct.new(:index, :id, :text)
+
   # Public A read-only integer value indicating the level of security that
   # should be enforced while processing this document. The value must be
   # set in the Document constructor using the :safe option.
@@ -30,14 +32,23 @@ class Asciidoctor::Document < Asciidoctor::AbstractBlock
   # it prevents access to files which reside outside of the parent directory
   # of the source file and disables any macro other than the include macro.
   #
-  # A value of 10 (SECURE) disallows the document from attempting to read
-  # files from the file system and including the contents of them into the
-  # document. In particular, it disallows use of the include::[] macro and the
-  # embedding of binary content (data uri), stylesheets and JavaScripts
-  # referenced by the document. (Asciidoctor and trusted extensions may still
-  # be allowed to embed trusted content into the document). Since Asciidoctor
-  # is aiming for wide adoption, this value is the default and is recommended
-  # for server-side deployments.
+  # A value of 10 (SERVER) disallows the document from setting attributes that
+  # would affect the rendering of the document, in addition to all the security
+  # features of SafeMode::SAFE. For instance, this value disallows changing the
+  # backend or the source-highlighter using an attribute defined in the source
+  # document. This is the most fundamental level of security for server-side
+  # deployments (hence the name).
+  #
+  # A value of 20 (SECURE) disallows the document from attempting to read files
+  # from the file system and including the contents of them into the document,
+  # in addition to all the security features of SafeMode::SECURE. In
+  # particular, it disallows use of the include::[] macro and the embedding of
+  # binary content (data uri), stylesheets and JavaScripts referenced by the
+  # document. (Asciidoctor and trusted extensions may still be allowed to embed
+  # trusted content into the document).
+  #
+  # Since Asciidoctor is aiming for wide adoption, 20 (SECURE) is the default
+  # value and is recommended for server-side deployments.
   #
   # A value of 100 (PARANOID) is planned to disallow the use of passthrough
   # macros and prevents the document from setting any known attributes in
@@ -48,13 +59,17 @@ class Asciidoctor::Document < Asciidoctor::AbstractBlock
   # Public: Get the Hash of document references
   attr_reader :references
 
+  # Public: Get the Hash of document counters
+  attr_reader :counters
+
   # Public: Get the Hash of callouts
   attr_reader :callouts
 
   # Public: The section level 0 block
   attr_reader :header
 
-  # Public: Base directory for rendering this document
+  # Public: Base directory for rendering this document. Defaults to directory of the source file.
+  # If the source is a string, defaults to the current directory.
   attr_reader :base_dir
 
   # Public: A reference to the parent document of this nested document.
@@ -82,6 +97,8 @@ class Asciidoctor::Document < Asciidoctor::AbstractBlock
       @parent_document = options.delete(:parent)
       # should we dup here?
       options[:attributes] = @parent_document.attributes
+      options[:safe] ||= @parent_document.safe
+      options[:base_dir] ||= @parent_document.base_dir
       @renderer = @parent_document.renderer
     else
       @parent_document = nil
@@ -90,17 +107,20 @@ class Asciidoctor::Document < Asciidoctor::AbstractBlock
     @header = nil
     @references = {
       :ids => {},
+      :footnotes => [],
       :links => [],
-      :images => []
+      :images => [],
+      :indexterms => []
     }
+    @counters = {}
     @callouts = Callouts.new
     @options = options
     @safe = @options.fetch(:safe, SafeMode::SECURE).to_i
-    @options[:header_footer] = @options.fetch(:header_footer, true)
+    @options[:header_footer] = @options.fetch(:header_footer, false)
 
-    @attributes['asciidoctor'] = true
+    @attributes['asciidoctor'] = ''
     @attributes['asciidoctor-version'] = VERSION
-    @attributes['sectids'] = true
+    @attributes['sectids'] = ''
     @attributes['encoding'] = 'UTF-8'
 
     attribute_overrides = options[:attributes] || {}
@@ -109,35 +129,58 @@ class Asciidoctor::Document < Asciidoctor::AbstractBlock
     # 10 is the AsciiDoc default, though currently Asciidoctor only supports 1 level
     attribute_overrides['include-depth'] ||= 10
 
-    # TODO we should go with one or the other, this is confusing
-    # for now, base_dir takes precedence if set
-    if options.has_key? :base_dir
-      @base_dir = attribute_overrides['docdir'] = options[:base_dir]
+    # if the base_dir option is specified, it overrides docdir as the root for relative paths
+    # otherwise, the base_dir is the directory of the source file (docdir) or the current
+    # directory of the input is a string
+    if options[:base_dir].nil?
+      if attribute_overrides['docdir']
+        @base_dir = attribute_overrides['docdir'] = File.expand_path(attribute_overrides['docdir'])
+      else
+        # perhaps issue a warning here?
+        @base_dir = attribute_overrides['docdir'] = Dir.pwd
+      end
     else
-      attribute_overrides['docdir'] ||= Dir.pwd
-      @base_dir = attribute_overrides['docdir']
+      @base_dir = attribute_overrides['docdir'] = File.expand_path(options[:base_dir])
     end
 
-    # restrict document from setting source-highlighter in SECURE safe mode
-    # it can only be set via the constructor
-    if @safe >= SafeMode::SECURE
+    if @safe >= SafeMode::SERVER
+      # restrict document from setting source-highlighter and backend
       attribute_overrides['source-highlighter'] ||= nil
+      attribute_overrides['backend'] ||= DEFAULT_BACKEND
+      # restrict document from seeing the docdir and trim docfile to relative path
+      if attribute_overrides.has_key?('docfile') && @parent_document.nil?
+        attribute_overrides['docfile'] = attribute_overrides['docfile'][(attribute_overrides['docdir'].length + 1)..-1]
+      end
+      attribute_overrides['docdir'] = ''
+      # restrict document from enabling icons
+      if @safe >= SafeMode::SECURE
+        attribute_overrides['icons'] ||= nil
+      end
     end
     
-    attribute_overrides.each {|key, val|
+    attribute_overrides.delete_if {|key, val|
+      verdict = false
       # a nil or negative key undefines the attribute 
-      if (val.nil? || key[-1..-1] == '!')
+      if val.nil? || key[-1..-1] == '!'
         @attributes.delete(key.chomp '!')
       # otherwise it's an attribute assignment
       else
+        # a value ending in @ indicates this attribute does not override
+        # an attribute with the same key in the document souce
+        if val.is_a?(String) && val.end_with?('@')
+          val.chop!
+          verdict = true
+        end
         @attributes[key] = val
       end
+      verdict
     }
 
     @attributes['backend'] ||= DEFAULT_BACKEND
+    @attributes['doctype'] ||= DEFAULT_DOCTYPE
     update_backend_attributes
 
-    if nested?
+    if !@parent_document.nil?
       # don't need to do the extra processing within our own document
       @reader = Reader.new(data)
     else
@@ -145,16 +188,16 @@ class Asciidoctor::Document < Asciidoctor::AbstractBlock
     end
 
     # dynamic intrinstic attribute values
-    @attributes['doctype'] ||= DEFAULT_DOCTYPE
-
     now = Time.new
     @attributes['localdate'] ||= now.strftime('%Y-%m-%d')
-    @attributes['localtime'] ||= now.strftime('%H:%m:%S %Z')
-    @attributes['localdatetime'] ||= [@attributes['localdate'], @attributes['localtime']].join(' ')
+    @attributes['localtime'] ||= now.strftime('%H:%M:%S %Z')
+    @attributes['localdatetime'] ||= [@attributes['localdate'], @attributes['localtime']] * ' '
     
-    # docdate and doctime should default to localdate and localtime if not otherwise set
+    # docdate, doctime and docdatetime should default to
+    # localdate, localtime and localdatetime if not otherwise set
     @attributes['docdate'] ||= @attributes['localdate']
     @attributes['doctime'] ||= @attributes['localtime']
+    @attributes['docdatetime'] ||= @attributes['localdatetime']
     
     @attributes['iconsdir'] ||= File.join(@attributes.fetch('imagesdir', 'images'), 'icons')
 
@@ -175,15 +218,61 @@ class Asciidoctor::Document < Asciidoctor::AbstractBlock
     }
   end
 
+  # Public: Get the named counter and take the next number in the sequence.
+  #
+  # name  - the String name of the counter
+  # seed  - the initial value as a String or Integer
+  #
+  # returns the next number in the sequence for the specified counter
+  def counter(name, seed = nil)
+    if !@counters.has_key? name
+      if seed.nil?
+        seed = nextval(@attributes.has_key?(name) ? @attributes[name] : 0)
+      elsif seed.to_i.to_s == seed
+        seed = seed.to_i
+      end
+      @counters[name] = seed
+    else
+      @counters[name] = nextval(@counters[name])
+    end
+
+    (@attributes[name] = @counters[name])
+  end
+
+  # Internal: Get the next value in the sequence.
+  #
+  # Handles both integer and character sequences.
+  #
+  # current - the value to increment as a String or Integer
+  #
+  # returns the next value in the sequence according to the current value's type
+  def nextval(current)
+    if current.is_a?(Integer)
+      current + 1
+    else
+      intval = current.to_i
+      if intval.to_s != current.to_s
+        (current[0].ord + 1).chr
+      else
+        intval + 1 
+      end
+    end
+  end
+
   def register(type, value)
-    if type == :ids
+    case type
+    when :ids
       if value.is_a?(Array)
         @references[:ids][value[0]] = (value[1] || '[' + value[0] + ']')
       else
         @references[:ids][value] = '[' + value + ']'
       end
-    elsif @options[:catalog_assets]
+    when :footnotes, :indexterms
       @references[type] << value
+    else
+      if @options[:catalog_assets]
+        @references[type] << value
+      end
     end
   end
 
@@ -242,6 +331,9 @@ class Asciidoctor::Document < Asciidoctor::AbstractBlock
   # Public: Update the backend attributes to reflect a change in the selected backend
   def update_backend_attributes()
     backend = @attributes['backend']
+    if BACKEND_ALIASES.has_key? backend
+      backend = @attributes['backend'] = BACKEND_ALIASES[backend]
+    end
     basebackend = backend.sub(/[[:digit:]]+$/, '')
     page_width = DEFAULT_PAGE_WIDTHS[basebackend]
     if page_width
@@ -249,9 +341,17 @@ class Asciidoctor::Document < Asciidoctor::AbstractBlock
     else
       @attributes.delete('pagewidth')
     end
-    @attributes['backend-' + backend] = 1
+    @attributes["backend-#{backend}"] = ''
     @attributes['basebackend'] = basebackend
-    @attributes['basebackend-' + basebackend] = 1
+    @attributes["basebackend-#{basebackend}"] = ''
+    # REVIEW cases for the next two assignments
+    @attributes["#{backend}-#{@attributes['doctype']}"] = ''
+    @attributes["#{basebackend}-#{@attributes['doctype']}"] = ''
+    ext = DEFAULT_EXTENSIONS[basebackend] || '.html'
+    @attributes['outfilesuffix'] = ext
+    file_type = ext[1..-1]
+    @attributes['filetype'] = file_type
+    @attributes["filetype-#{file_type}"] = ''
   end
 
   def splain
@@ -301,7 +401,7 @@ class Asciidoctor::Document < Asciidoctor::AbstractBlock
   # using the appropriate built-in template.
   def render(opts = {})
     r = renderer(opts)
-    @options.merge(opts)[:header_footer] ? r.render('document', self) : r.render('embedded', self)
+    @options.merge(opts)[:header_footer] ? r.render('document', self).strip : r.render('embedded', self)
   end
 
   def content