asciidoctor 0.0.9 → 0.1.0

data/lib/asciidoctor/table.rb

@@ -19,6 +19,7 @@ module Asciidoctor
     # Public: A Hash mapping styles abbreviations to styles that can be applied
     # to a table column or cell
     TEXT_STYLES = {
+      'd' => :none,
       's' => :strong,
       'e' => :emphasis,
       'm' => :monospaced,
@@ -407,8 +408,14 @@ module Asciidoctor
       @buffer = ''
       if format == 'psv'
         cell_spec = take_cell_spec
-        repeat = cell_spec.fetch('repeatcol', 1)
-        cell_spec.delete('repeatcol')
+        if cell_spec.nil?
+          puts 'asciidoctor: ERROR: table missing leading separator, recovering automatically'
+          cell_spec = {}
+          repeat = 1
+        else
+          repeat = cell_spec.fetch('repeatcol', 1)
+          cell_spec.delete('repeatcol')
+        end
       else
         cell_spec = nil
         repeat = 1

data/lib/asciidoctor/version.rb

@@ -1,3 +1,3 @@
 module Asciidoctor
-  VERSION = "0.0.9"
+  VERSION = "0.1.0"
 end

data/man/asciidoctor.1

@@ -0,0 +1,212 @@
+'\" t
+.\"     Title: asciidoctor
+.\"    Author: [see the "AUTHORS" section]
+.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
+.\"      Date: 01/30/2013
+.\"    Manual: \ \&
+.\"    Source: \ \&
+.\"  Language: English
+.\"
+.TH "ASCIIDOCTOR" "1" "01/30/2013" "\ \&" "\ \&"
+.\" -----------------------------------------------------------------
+.\" * Define some portability stuff
+.\" -----------------------------------------------------------------
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" http://bugs.debian.org/507673
+.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.ie \n(.g .ds Aq \(aq
+.el       .ds Aq '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "NAME"
+asciidoctor \- converts an AsciiDoc source file to HTML, DocBook and other formats
+.SH "SYNOPSIS"
+.sp
+\fBasciidoctor\fR [\fIOPTION\fR]\&... \fIFILE\fR
+.SH "DESCRIPTION"
+.sp
+The asciidoctor(1) command converts the AsciiDoc source file \fIFILE\fR to HTML 5, DocBook 4\&.5 and other output formats\&.
+.sp
+If \fIFILE\fR is \fI\-\fR then the AsciiDoc source is read from standard input\&.
+.SH "OPTIONS"
+.SS "Security Settings"
+.PP
+\fB\-B, \-\-base\-dir\fR=\fIDIR\fR
+.RS 4
+Base directory containing the document and resources\&. Defaults to the directory containing the source file, or the working directory if the source is read from a stream\&. Can be used as a way to chroot the execution of the program\&.
+.RE
+.PP
+\fB\-S, \-\-safe\-mode\fR=\fISAFE_MODE\fR
+.RS 4
+Set safe mode level explicity:
+\fIunsafe\fR,
+\fIsafe\fR,
+\fIsecure\fR\&. Defaults to
+\fIsecure\fR\&. Disables potentially dangerous macros in source files, such as include::[]\&.
+.RE
+.PP
+\fB\-\-safe\fR
+.RS 4
+Set safe mode to
+\fIsafe\fR
+from the default safe mode of
+\fIsecure\fR\&. Enables include macros, but restricts access to ancestor paths of source file\&. Provided for compatibility with the asciidoc command\&.
+.RE
+.SS "Document Settings"
+.PP
+\fB\-a, \-\-attribute\fR=\fIATTRIBUTE\fR
+.RS 4
+Define, override or delete a document attribute\&. Command\-line attributes take precedence over attributes defined in the source file\&.
+.sp
+\fIATTRIBUTE\fR
+is formatted as a key\-value pair, in the form
+\fINAME=VALUE\fR\&. Values containing spaces should be enclosed in double\-quote characters\&. Alternate acceptable forms are
+\fINAME\fR
+(the
+\fIVALUE\fR
+defaults to an empty string),
+\fINAME!\fR
+(deletes the
+\fINAME\fR
+attribute) and
+\fINAME=VALUE@\fR
+(does not override
+\fINAME\fR
+attribute if already defined in the source file)\&.
+.sp
+This option may be specified more than once\&.
+.RE
+.PP
+\fB\-b, \-\-backend\fR=\fIBACKEND\fR
+.RS 4
+Backend output file format:
+\fIdocbook45\fR
+or
+\fIhtml5\fR\&. You can also use the backend alias names
+\fIhtml\fR
+(aliased to
+\fIhtml5\fR) or
+\fIdocbook\fR
+(aliased to
+\fIdocbook45\fR)\&. Defaults to
+\fIhtml5\fR\&.
+.RE
+.PP
+\fB\-d, \-\-doctype\fR=\fIDOCTYPE\fR
+.RS 4
+Document type:
+\fIarticle\fR
+or
+\fIbook\fR\&. Sets the root element when using the
+\fIdocbook\fR
+backend and the style class on the HTML body element when using the
+\fIhtml\fR
+backend\&. The
+\fIbook\fR
+document type allows multiple level\-0 section titles in a single document\&. Defaults to
+\fIarticle\fR\&.
+.RE
+.SS "Rendering Control"
+.PP
+\fB\-C, \-\-compact\fR
+.RS 4
+Compact the output by removing blank lines\&. Not enabled by default\&.
+.RE
+.PP
+\fB\-D, \-\-destination\-dir\fR=\fIDIR\fR
+.RS 4
+Destination output directory\&. Defaults to the directory containing the source file, or the working directory if the source is read from a stream\&.
+.RE
+.PP
+\fB\-e, \-\-eruby\fR
+.RS 4
+Specifies the eRuby implementation to use for rendering the built\-in templates\&. Supported values are
+\fIerb\fR
+and
+\fIerubis\fR\&. Defaults to
+\fIerb\fR\&.
+.RE
+.PP
+\fB\-n, \-\-section\-numbers\fR
+.RS 4
+Auto\-number section titles\&. Synonym for
+\fB\-\-attribute numbered\fR\&.
+.RE
+.PP
+\fB\-o, \-\-out\-file\fR=\fIOUT_FILE\fR
+.RS 4
+Write output to file
+\fIOUT_FILE\fR\&. Defaults to the base name of the input file suffixed with
+\fIbackend\fR
+extension\&. If the input is read from standard input, then the output file defaults to stdout\&. If
+\fIOUT_FILE\fR
+is
+\fI\-\fR
+then the standard output is also used\&.
+.RE
+.PP
+\fB\-s, \-\-no\-header\-footer\fR
+.RS 4
+Suppress the document header and footer in the output\&.
+.RE
+.PP
+\fB\-T, \-\-template\-dir\fR=\fIDIR\fR
+.RS 4
+Directory containing custom render templates that override one or more templates from the the built\-in set\&.
+.RE
+.SS "Processing Information"
+.PP
+\fB\-\-trace\fR
+.RS 4
+Include backtrace information on errors\&. Not enabled by default\&.
+.RE
+.PP
+\fB\-v, \-\-verbose\fR
+.RS 4
+Verbosely print processing information and configuration file checks to stderr\&.
+.RE
+.SS "Program Information"
+.PP
+\fB\-h, \-\-help\fR
+.RS 4
+Show the help message\&.
+.RE
+.PP
+\fB\-V, \-\-version\fR
+.RS 4
+Print program version number\&.
+.RE
+.SH "EXIT STATUS"
+.PP
+\fB0\fR
+.RS 4
+Success
+.RE
+.PP
+\fB1\fR
+.RS 4
+Failure (syntax or usage error; configuration error; document processing failure; unexpected error)\&.
+.RE
+.SH "BUGS"
+.sp
+See the \fBAsciidoctor\fR issue tracker: <\fBhttps://github\&.com/erebor/asciidoctor/issues?state=open\fR>
+.SH "AUTHORS"
+.sp
+\fBAsciidoctor\fR was written by Ryan Waldron, Dan Allen and other contributors\&. \fBAsciiDoc\fR was written by Stuart Rackham and has received contributions from many other individuals\&.
+.SH "RESOURCES"
+.sp
+Git source repository on GitHub: <\fBhttps://github\&.com/erebor/asciidoctor\fR>
+.sp
+Main web site: <\fBhttp://asciidoctor\&.org\fR>
+.SH "COPYING"
+.sp
+Copyright (C) Ryan Waldron\&. Free use of this software is granted under the terms of the MIT License\&.

data/man/asciidoctor.ad

@@ -0,0 +1,156 @@
+asciidoctor(1)
+==============
+:doctype: manpage
+
+
+NAME
+----
+asciidoctor - converts an AsciiDoc source file to HTML, DocBook and other formats
+
+
+SYNOPSIS
+--------
+*asciidoctor* ['OPTION']... 'FILE'
+
+
+DESCRIPTION
+-----------
+The asciidoctor(1) command converts the AsciiDoc source file 'FILE' to HTML 5,
+DocBook 4.5 and other output formats.
+
+If 'FILE' is '-' then the AsciiDoc source is read from standard input.
+
+
+OPTIONS
+-------
+
+Security Settings
+~~~~~~~~~~~~~~~~~
+
+*-B, --base-dir*='DIR'::
+    Base directory containing the document and resources. Defaults to the
+    directory containing the source file, or the working directory if the
+    source is read from a stream. Can be used as a way to chroot the execution
+    of the program.
+
+*-S, --safe-mode*='SAFE_MODE'::
+    Set safe mode level explicity: 'unsafe', 'safe', 'secure'. Defaults to
+    'secure'. Disables potentially dangerous macros in source files, such as
+    include::[].
+
+*--safe*::
+    Set safe mode to 'safe' from the default safe mode of 'secure'. Enables
+    include macros, but restricts access to ancestor paths of source file.
+    Provided for compatibility with the asciidoc command.
+
+Document Settings
+~~~~~~~~~~~~~~~~~
+
+*-a, --attribute*='ATTRIBUTE'::
+    Define, override or delete a document attribute. Command-line attributes
+    take precedence over attributes defined in the source file.
++
+'ATTRIBUTE' is formatted as a key-value pair, in the form 'NAME=VALUE'. Values
+containing spaces should be enclosed in double-quote characters.  Alternate
+acceptable forms are 'NAME' (the 'VALUE' defaults to an empty string), 'NAME!'
+(deletes the 'NAME' attribute) and 'NAME=VALUE@' (does not override 'NAME'
+attribute if already defined in the source file).
++
+This option may be specified more than once. 
+
+*-b, --backend*='BACKEND'::
+    Backend output file format: 'docbook45' or 'html5'.  You can also use the
+    backend alias names 'html' (aliased to 'html5') or 'docbook' (aliased to
+    'docbook45'). Defaults to 'html5'.
+
+*-d, --doctype*='DOCTYPE'::
+    Document type: 'article' or 'book'. Sets the root element when using the
+    'docbook' backend and the style class on the HTML body element when using
+    the 'html' backend. The 'book' document type allows multiple level-0
+    section titles in a single document. Defaults to 'article'.
+
+Rendering Control
+~~~~~~~~~~~~~~~~~
+
+*-C, --compact*::
+    Compact the output by removing blank lines. Not enabled by default.
+
+*-D, --destination-dir*='DIR'::
+    Destination output directory. Defaults to the directory containing the
+    source file, or the working directory if the source is read from a stream.
+
+*-e, --eruby*::
+    Specifies the eRuby implementation to use for rendering the built-in
+    templates. Supported values are 'erb' and 'erubis'. Defaults to 'erb'.
+
+*-n, --section-numbers*::
+    Auto-number section titles. Synonym for *--attribute numbered*.
+
+*-o, --out-file*='OUT_FILE'::
+    Write output to file 'OUT_FILE'. Defaults to the base name of the input
+    file suffixed with 'backend' extension. If the input is read from standard
+    input, then the output file defaults to stdout. If 'OUT_FILE' is '-' then
+    the standard output is also used.
+
+*-s, --no-header-footer*::
+    Suppress the document header and footer in the output.
+
+*-T, --template-dir*='DIR'::
+    Directory containing custom render templates that override one or more
+    templates from the the built-in set.
+
+Processing Information
+~~~~~~~~~~~~~~~~~~~~~~
+
+*--trace*::
+    Include backtrace information on errors. Not enabled by default.
+
+*-v, --verbose*::
+    Verbosely print processing information and configuration file checks to
+    stderr.
+
+Program Information
+~~~~~~~~~~~~~~~~~~~
+
+*-h, --help*::
+    Show the help message.
+
+*-V, --version*::
+    Print program version number.
+
+
+EXIT STATUS
+-----------
+*0*::
+    Success
+
+*1*::
+    Failure (syntax or usage error; configuration error; document processing
+    failure; unexpected error).
+
+
+BUGS
+----
+See the *Asciidoctor* issue tracker: <**https://github.com/asciidoctor/asciidoctor/issues?state=open**>
+
+
+AUTHORS
+-------
+*Asciidoctor* was written by Ryan Waldron, Dan Allen and other contributors.
+*AsciiDoc* was written by Stuart Rackham and has received contributions from
+many other individuals.
+
+
+RESOURCES
+---------
+Git source repository on GitHub: <**https://github.com/asciidoctor/asciidoctor**>
+
+Project web site: <**http://asciidoctor.org**>
+
+GitHub organization: <**http://github.com/asciidoctor**>
+
+
+COPYING
+-------
+Copyright \(C) Ryan Waldron. Free use of this software is granted under the
+terms of the MIT License.

data/test/attributes_test.rb

@@ -9,7 +9,7 @@ context 'Attributes' do
 
     test 'creates an attribute by fusing a multi-line value' do
       str = <<-EOS
-:description: This is the first +
+:description: This is the first      +
               Ruby implementation of +
               AsciiDoc.
       EOS
@@ -86,14 +86,14 @@ endif::holygrail[]
     end
 
     test 'attribute undefined in document options cannot be assigned in document' do
-      doc = document_from_string(':cash: money', :attributes => {'cash!' => 1 })
+      doc = document_from_string(':cash: money', :attributes => {'cash!' => '' })
       assert_equal nil, doc.attributes['cash']
       doc = document_from_string(':cash: money', :attributes => {'cash' => nil })
       assert_equal nil, doc.attributes['cash']
     end
 
-    test 'backend attributes are updated if backend attribute is defined in document' do
-      doc = document_from_string(':backend: docbook45')
+    test 'backend attributes are updated if backend attribute is defined in document and safe mode is less than SERVER' do
+      doc = document_from_string(':backend: docbook45', :safe => Asciidoctor::SafeMode::SAFE)
       assert_equal 'docbook45', doc.attributes['backend']
       assert doc.attributes.has_key? 'backend-docbook45'
       assert_equal 'docbook', doc.attributes['basebackend']
@@ -101,7 +101,7 @@ endif::holygrail[]
     end
 
     test 'backend attributes defined in document options overrides backend attribute in document' do
-      doc = document_from_string(':backend: docbook45', :attributes => {'backend' => 'html5'})
+      doc = document_from_string(':backend: docbook45', :safe => Asciidoctor::SafeMode::SAFE, :attributes => {'backend' => 'html5'})
       assert_equal 'html5', doc.attributes['backend']
       assert doc.attributes.has_key? 'backend-html5'
       assert_equal 'html', doc.attributes['basebackend']
@@ -118,6 +118,11 @@ endif::holygrail[]
       assert_equal "Yo, Tanglefoot!\nBeat Spiderman!", result.css("p").first.content.strip
     end
 
+    test 'attribute lookup is not case sensitive' do
+      result = render_embedded_string(":He-Man: The most powerful man in the universe\n\n{He-Man}")
+      assert_xpath '//p[text()="The most powerful man in the universe"]', result, 1
+    end
+
     test "render properly with single character name" do
       html = render_string(":r: Ruby\n\nR is for {r}!")
       result = Nokogiri::HTML(html)
@@ -220,6 +225,32 @@ of the attribute named foo in your document.
       output = render_string(input)
       assert_match(/\{foo\}/, output)
     end
+
+    test 'does not show docdir and shows relative docfile if safe mode is SERVER or greater' do
+      input = <<-EOS
+* docdir: {docdir}
+* docfile: {docfile}
+      EOS
+
+      docdir = Dir.pwd
+      docfile = File.join(docdir, 'sample.asciidoc')
+      output = render_embedded_string input, :safe => Asciidoctor::SafeMode::SERVER, :attributes => {'docdir' => docdir, 'docfile' => docfile}
+      assert_xpath '//li[1]/p[text()="docdir: "]', output, 1
+      assert_xpath '//li[2]/p[text()="docfile: sample.asciidoc"]', output, 1
+    end
+
+    test 'shows absolute docdir and docfile paths if safe mode is less than SERVER' do
+      input = <<-EOS
+* docdir: {docdir}
+* docfile: {docfile}
+      EOS
+
+      docdir = Dir.pwd
+      docfile = File.join(docdir, 'sample.asciidoc')
+      output = render_embedded_string input, :safe => Asciidoctor::SafeMode::SAFE, :attributes => {'docdir' => docdir, 'docfile' => docfile}
+      assert_xpath %(//li[1]/p[text()="docdir: #{docdir}"]), output, 1
+      assert_xpath %(//li[2]/p[text()="docfile: #{docfile}"]), output, 1
+    end
   end
 
   context "Intrinsic attributes" do
@@ -241,6 +272,78 @@ of the attribute named foo in your document.
       html = render_string('<node>&</node>')
       assert_match(/&lt;node&gt;&amp;&lt;\/node&gt;/, html)
     end
+
+    test 'creates counter' do
+      input = <<-EOS
+{counter:mycounter}
+      EOS
+
+      doc = document_from_string input
+      output = doc.render
+      assert_equal 1, doc.attributes['mycounter']
+      assert_xpath '//p[text()="1"]', output, 1
+    end
+
+    test 'creates counter silently' do
+      input = <<-EOS
+{counter2:mycounter}
+      EOS
+
+      doc = document_from_string input
+      output = doc.render
+      assert_equal 1, doc.attributes['mycounter']
+      assert_xpath '//p[text()="1"]', output, 0
+    end
+
+    test 'creates counter with numeric seed value' do
+      input = <<-EOS
+{counter2:mycounter:10}
+      EOS
+
+      doc = document_from_string input
+      doc.render
+      assert_equal 10, doc.attributes['mycounter']
+    end
+
+    test 'creates counter with character seed value' do
+      input = <<-EOS
+{counter2:mycounter:A}
+      EOS
+
+      doc = document_from_string input
+      doc.render
+      assert_equal 'A', doc.attributes['mycounter']
+    end
+
+    test 'increments counter with numeric value' do
+      input = <<-EOS
+:mycounter: 1
+
+{counter:mycounter}
+
+{mycounter}
+      EOS
+
+      doc = document_from_string input
+      output = doc.render
+      assert_equal 2, doc.attributes['mycounter']
+      assert_xpath '//p[text()="2"]', output, 2
+    end
+
+    test 'increments counter with character value' do
+      input = <<-EOS
+:mycounter: @
+
+{counter:mycounter}
+
+{mycounter}
+      EOS
+
+      doc = document_from_string input
+      output = doc.render
+      assert_equal 'A', doc.attributes['mycounter']
+      assert_xpath '//p[text()="A"]', output, 2
+    end
     
   end