asciidoctor 1.5.8 → 2.0.0.rc.1

data/test/paths_test.rb

@@ -1,395 +0,0 @@
-# encoding: UTF-8
-unless defined? ASCIIDOCTOR_PROJECT_DIR
-  $: << File.dirname(__FILE__); $:.uniq!
-  require 'test_helper'
-end
-
-context 'Path Resolver' do
-  context 'Web Paths' do
-    def setup
-      @resolver = Asciidoctor::PathResolver.new
-    end
-
-    test 'target with absolute path' do
-      assert_equal '/images', @resolver.web_path('/images')
-      assert_equal '/images', @resolver.web_path('/images', '')
-      assert_equal '/images', @resolver.web_path('/images', nil)
-    end
-
-    test 'target with relative path' do
-      assert_equal 'images', @resolver.web_path('images')
-      assert_equal 'images', @resolver.web_path('images', '')
-      assert_equal 'images', @resolver.web_path('images', nil)
-    end
-
-    test 'target with hidden relative path' do
-      assert_equal '.images', @resolver.web_path('.images')
-      assert_equal '.images', @resolver.web_path('.images', '')
-      assert_equal '.images', @resolver.web_path('.images', nil)
-    end
-
-    test 'target with path relative to current directory' do
-      assert_equal './images', @resolver.web_path('./images')
-      assert_equal './images', @resolver.web_path('./images', '')
-      assert_equal './images', @resolver.web_path('./images', nil)
-    end
-
-    test 'target with absolute path ignores start path' do
-      assert_equal '/images', @resolver.web_path('/images', 'foo')
-      assert_equal '/images', @resolver.web_path('/images', '/foo')
-      assert_equal '/images', @resolver.web_path('/images', './foo')
-    end
-
-    test 'target with relative path appended to start path' do
-      assert_equal 'assets/images', @resolver.web_path('images', 'assets')
-      assert_equal '/assets/images', @resolver.web_path('images', '/assets')
-      #assert_equal '/assets/images/tiger.png', @resolver.web_path('tiger.png', '/assets//images')
-      assert_equal './assets/images', @resolver.web_path('images', './assets')
-      assert_equal '/theme.css', @resolver.web_path('theme.css', '/')
-      assert_equal '/css/theme.css', @resolver.web_path('theme.css', '/css/')
-    end
-
-    test 'target with path relative to current directory appended to start path' do
-      assert_equal 'assets/images', @resolver.web_path('./images', 'assets')
-      assert_equal '/assets/images', @resolver.web_path('./images', '/assets')
-      assert_equal './assets/images', @resolver.web_path('./images', './assets')
-    end
-
-    test 'target with relative path appended to url start path' do
-      assert_equal 'http://www.example.com/assets/images', @resolver.web_path('images', 'http://www.example.com/assets')
-    end
-
-    # enable if we want to allow web_path to detect and preserve a target URI
-    #test 'target with file url appended to relative path' do
-    #  assert_equal 'file:///home/username/styles/asciidoctor.css', @resolver.web_path('file:///home/username/styles/asciidoctor.css', '.')
-    #end
-
-    # enable if we want to allow web_path to detect and preserve a target URI
-    #test 'target with http url appended to relative path' do
-    #  assert_equal 'http://example.com/asciidoctor.css', @resolver.web_path('http://example.com/asciidoctor.css', '.')
-    #end
-
-    test 'normalize target' do
-      assert_equal '../images', @resolver.web_path('../images/../images')
-    end
-
-    test 'append target to start path and normalize' do
-      assert_equal '../images', @resolver.web_path('../images/../images', '../images')
-      assert_equal '../../images', @resolver.web_path('../images', '..')
-    end
-
-    test 'normalize parent directory that follows root' do
-      assert_equal '/tiger.png', @resolver.web_path('/../tiger.png')
-      assert_equal '/tiger.png', @resolver.web_path('/../../tiger.png')
-    end
-
-    test 'uses start when target is empty' do
-      assert_equal 'assets/images', @resolver.web_path('', 'assets/images')
-      assert_equal 'assets/images', @resolver.web_path(nil, 'assets/images')
-    end
-
-    test 'posixifies windows paths' do
-      @resolver.file_separator = '\\'
-      assert_equal '/images', @resolver.web_path('\\images')
-      assert_equal '../images', @resolver.web_path('..\\images')
-      assert_equal '/images', @resolver.web_path('\\..\\images')
-      assert_equal 'assets/images', @resolver.web_path('assets\\images')
-      assert_equal '../assets/images', @resolver.web_path('assets\\images', '..\\images\\..')
-    end
-
-    test 'URL encode spaces in path' do
-      assert_equal 'assets%20and%20stuff/lots%20of%20images', @resolver.web_path('lots of images', 'assets and stuff')
-    end
-  end
-
-  context 'System Paths' do
-    JAIL = '/home/doctor/docs'
-    default_logger = Asciidoctor::LoggerManager.logger
-
-    def setup
-      @resolver = Asciidoctor::PathResolver.new
-      @logger = (Asciidoctor::LoggerManager.logger = Asciidoctor::MemoryLogger.new)
-    end
-
-    teardown do
-      Asciidoctor::LoggerManager.logger = default_logger
-    end
-
-    test 'raises security error if jail is not an absolute path' do
-      begin
-        @resolver.system_path('images/tiger.png', '/etc', 'foo')
-        flunk 'Expecting SecurityError to be raised'
-      rescue SecurityError
-      end
-    end
-
-    #test 'raises security error if jail is not a canoncial path' do
-    #  begin
-    #    @resolver.system_path('images/tiger.png', '/etc', %(#{JAIL}/../foo))
-    #    flunk 'Expecting SecurityError to be raised'
-    #  rescue SecurityError
-    #  end
-    #end
-
-    test 'prevents access to paths outside of jail' do
-      result = @resolver.system_path '../../../../../css', %(#{JAIL}/assets/stylesheets), JAIL
-      assert_equal %(#{JAIL}/css), result
-      assert_message @logger, :WARN, 'path has illegal reference to ancestor of jail; recovering automatically'
-
-      @logger.clear
-      result = @resolver.system_path '/../../../../../css', %(#{JAIL}/assets/stylesheets), JAIL
-      assert_equal %(#{JAIL}/css), result
-      assert_message @logger, :WARN, 'path is outside of jail; recovering automatically'
-
-      @logger.clear
-      result = @resolver.system_path '../../../css', '../../..', JAIL
-      assert_equal %(#{JAIL}/css), result
-      assert_message @logger, :WARN, 'path has illegal reference to ancestor of jail; recovering automatically'
-    end
-
-    test 'throws exception for illegal path access if recover is false' do
-      begin
-        @resolver.system_path('../../../../../css', "#{JAIL}/assets/stylesheets", JAIL, :recover => false)
-        flunk 'Expecting SecurityError to be raised'
-      rescue SecurityError
-      end
-    end
-
-    test 'resolves start path if target is empty' do
-      assert_equal "#{JAIL}/assets/stylesheets", @resolver.system_path('', "#{JAIL}/assets/stylesheets", JAIL)
-      assert_equal "#{JAIL}/assets/stylesheets", @resolver.system_path(nil, "#{JAIL}/assets/stylesheets", JAIL)
-    end
-
-    test 'expands parent references in start path if target is empty' do
-      assert_equal "#{JAIL}/stylesheets", @resolver.system_path('', "#{JAIL}/assets/../stylesheets", JAIL)
-    end
-
-    test 'expands parent references in start path if target is not empty' do
-      assert_equal "#{JAIL}/stylesheets/site.css", @resolver.system_path('site.css', "#{JAIL}/assets/../stylesheets", JAIL)
-    end
-
-    test 'resolves start path if target is dot' do
-      assert_equal "#{JAIL}/assets/stylesheets", @resolver.system_path('.', "#{JAIL}/assets/stylesheets", JAIL)
-      assert_equal "#{JAIL}/assets/stylesheets", @resolver.system_path('./', "#{JAIL}/assets/stylesheets", JAIL)
-    end
-
-    test 'treats absolute target outside of jail as relative when jail is specified' do
-      result = @resolver.system_path '/', "#{JAIL}/assets/stylesheets", JAIL
-      assert_equal JAIL, result
-      assert_message @logger, :WARN, 'path is outside of jail; recovering automatically'
-
-      @logger.clear
-      result = @resolver.system_path '/foo', "#{JAIL}/assets/stylesheets", JAIL
-      assert_equal "#{JAIL}/foo", result
-      assert_message @logger, :WARN, 'path is outside of jail; recovering automatically'
-
-      @logger.clear
-      result = @resolver.system_path '/../foo', "#{JAIL}/assets/stylesheets", JAIL
-      assert_equal "#{JAIL}/foo", result
-      assert_message @logger, :WARN, 'path is outside of jail; recovering automatically'
-
-      @logger.clear
-      @resolver.file_separator = '\\'
-      result = @resolver.system_path 'baz.adoc', 'C:/foo', 'C:/bar'
-      assert_equal 'C:/bar/baz.adoc', result
-      assert_message @logger, :WARN, 'path is outside of jail; recovering automatically'
-    end
-
-    test 'allows use of absolute target or start if resolved path is sub-path of jail' do
-      assert_equal "#{JAIL}/my/path", @resolver.system_path("#{JAIL}/my/path", '', JAIL)
-      assert_equal "#{JAIL}/my/path", @resolver.system_path("#{JAIL}/my/path", nil, JAIL)
-      assert_equal "#{JAIL}/my/path", @resolver.system_path('', "#{JAIL}/my/path", JAIL)
-      assert_equal "#{JAIL}/my/path", @resolver.system_path(nil, "#{JAIL}/my/path", JAIL)
-      assert_equal "#{JAIL}/my/path", @resolver.system_path('path', "#{JAIL}/my", JAIL)
-      assert_equal '/foo/bar/baz.adoc', @resolver.system_path('/foo/bar/baz.adoc', nil, '/')
-      assert_equal '/foo/bar/baz.adoc', @resolver.system_path('baz.adoc', '/foo/bar', '/')
-      assert_equal '/foo/bar/baz.adoc', @resolver.system_path('baz.adoc', 'foo/bar', '/')
-    end
-
-    test 'uses jail path if start path is empty' do
-      assert_equal "#{JAIL}/images/tiger.png", @resolver.system_path('images/tiger.png', '', JAIL)
-      assert_equal "#{JAIL}/images/tiger.png", @resolver.system_path('images/tiger.png', nil, JAIL)
-    end
-
-    test 'warns if start is not contained within jail' do
-      result = @resolver.system_path 'images/tiger.png', '/etc', JAIL
-      assert_equal %(#{JAIL}/images/tiger.png), result
-      assert_message @logger, :WARN, 'path is outside of jail; recovering automatically'
-
-      @logger.clear
-      result = @resolver.system_path '.', '/etc', JAIL
-      assert_equal JAIL, result
-      assert_message @logger, :WARN, 'path is outside of jail; recovering automatically'
-
-      @logger.clear
-      @resolver.file_separator = '\\'
-      result = @resolver.system_path '.', 'C:/foo', 'C:/bar'
-      assert_equal 'C:/bar', result
-      assert_message @logger, :WARN, 'path is outside of jail; recovering automatically'
-    end
-
-    test 'allows start path to be parent of jail if resolved target is inside jail' do
-      assert_equal "#{JAIL}/foo/path", @resolver.system_path('foo/path', JAIL, "#{JAIL}/foo")
-      @resolver.file_separator = '\\'
-      assert_equal "C:/dev/project/README.adoc", @resolver.system_path('project/README.adoc', 'C:/dev', 'C:/dev/project')
-    end
-
-    test 'relocates target to jail if resolved value fails outside of jail' do
-      result = @resolver.system_path 'bar/baz.adoc', JAIL, "#{JAIL}/foo"
-      assert_equal %(#{JAIL}/foo/bar/baz.adoc), result
-      assert_message @logger, :WARN, 'path is outside of jail; recovering automatically'
-
-      @logger.clear
-      @resolver.file_separator = '\\'
-      result = @resolver.system_path 'bar/baz.adoc', 'D:/', 'C:/foo'
-      assert_equal 'C:/foo/bar/baz.adoc', result
-      assert_message @logger, :WARN, '~outside of jail root'
-    end
-
-    test 'raises security error if start is not contained within jail and recover is disabled' do
-      begin
-        @resolver.system_path('images/tiger.png', '/etc', JAIL, :recover => false)
-        flunk 'Expecting SecurityError to be raised'
-      rescue SecurityError
-      end
-
-      begin
-        @resolver.system_path('.', '/etc', JAIL, :recover => false)
-        flunk 'Expecting SecurityError to be raised'
-      rescue SecurityError
-      end
-    end
-
-    test 'expands parent references in absolute path if jail is not specified' do
-      assert_equal '/etc/stylesheet.css', @resolver.system_path('/usr/share/../../etc/stylesheet.css')
-    end
-
-    test 'resolves absolute directory if jail is not specified' do
-      assert_equal '/usr/share/stylesheet.css', @resolver.system_path('/usr/share/stylesheet.css', '/home/dallen/docs/assets/stylesheets')
-    end
-
-    test 'resolves ancestor directory of start if jail is not specified' do
-      assert_equal '/usr/share/stylesheet.css', @resolver.system_path('../../../../../usr/share/stylesheet.css', '/home/dallen/docs/assets/stylesheets')
-    end
-
-    test 'resolves absolute path if start is absolute and target is relative' do
-      assert_equal '/usr/share/assets/stylesheet.css', @resolver.system_path('assets/stylesheet.css', '/usr/share')
-    end
-
-    test 'File.dirname preserves UNC path root on Windows' do
-      assert_equal File.dirname('\\\\server\\docs\\file.html'), '\\\\server\\docs'
-    end if windows?
-
-    test 'File.dirname preserves posix-style UNC path root on Windows' do
-      assert_equal File.dirname('//server/docs/file.html'), '//server/docs'
-    end if windows?
-
-    test 'resolves UNC path if start is absolute and target is relative' do
-      assert_equal '//QA/c$/users/asciidoctor/assets/stylesheet.css', @resolver.system_path('assets/stylesheet.css', '//QA/c$/users/asciidoctor')
-    end
-
-    test 'resolves UNC path if target is UNC path' do
-      @resolver.file_separator = '\\'
-      assert_equal '//server/docs/output.html', @resolver.system_path('\\\\server\\docs\\output.html')
-    end
-
-    test 'resolves UNC path if target is posix-style UNC path' do
-      assert_equal '//server/docs/output.html', @resolver.system_path('//server/docs/output.html')
-    end
-
-    test 'resolves relative target relative to current directory if start is empty' do
-      pwd = File.expand_path(Dir.pwd)
-      assert_equal "#{pwd}/images/tiger.png", @resolver.system_path('images/tiger.png', '')
-      assert_equal "#{pwd}/images/tiger.png", @resolver.system_path('images/tiger.png', nil)
-      assert_equal "#{pwd}/images/tiger.png", @resolver.system_path('images/tiger.png')
-    end
-
-    test 'resolves relative hidden target relative to current directory if start is empty' do
-      pwd = File.expand_path(Dir.pwd)
-      assert_equal "#{pwd}/.images/tiger.png", @resolver.system_path('.images/tiger.png', '')
-      assert_equal "#{pwd}/.images/tiger.png", @resolver.system_path('.images/tiger.png', nil)
-    end
-
-    test 'resolves and normalizes start when target is empty' do
-      pwd = File.expand_path Dir.pwd
-      assert_equal '/home/doctor/docs', (@resolver.system_path '', '/home/doctor/docs')
-      assert_equal '/home/doctor/docs', (@resolver.system_path '', '/home/doctor/./docs')
-      assert_equal '/home/doctor/docs', (@resolver.system_path nil, '/home/doctor/docs')
-      assert_equal '/home/doctor/docs', (@resolver.system_path nil, '/home/doctor/./docs')
-      assert_equal %(#{pwd}/assets/images), (@resolver.system_path nil, 'assets/images')
-      @resolver.system_path '', '../assets/images', JAIL
-      assert_message @logger, :WARN, 'path has illegal reference to ancestor of jail; recovering automatically'
-    end
-
-    test 'posixifies windows paths' do
-      @resolver.file_separator = '\\'
-      assert_equal "#{JAIL}/assets/css", @resolver.system_path('..\\css', 'assets\\stylesheets', JAIL)
-    end
-
-    test 'resolves windows paths when file separator is backlash' do
-      @resolver.file_separator = '\\'
-
-      assert_equal 'C:/data/docs', (@resolver.system_path '..', 'C:\\data\\docs\\assets', 'C:\\data\\docs')
-
-      result = @resolver.system_path '..\\..', 'C:\\data\\docs\\assets', 'C:\\data\\docs'
-      assert_equal 'C:/data/docs', result
-      assert_message @logger, :WARN, 'path has illegal reference to ancestor of jail; recovering automatically'
-
-      @logger.clear
-      result = @resolver.system_path '..\\..\\css', 'C:\\data\\docs\\assets', 'C:\\data\\docs'
-      assert_equal 'C:/data/docs/css', result
-      assert_message @logger, :WARN, 'path has illegal reference to ancestor of jail; recovering automatically'
-    end
-
-    test 'should calculate relative path' do
-      filename = @resolver.system_path('part1/chapter1/section1.adoc', nil, JAIL)
-      assert_equal "#{JAIL}/part1/chapter1/section1.adoc", filename
-      assert_equal 'part1/chapter1/section1.adoc', @resolver.relative_path(filename, JAIL)
-    end
-
-    test 'should resolve relative path to filename outside of base directory' do
-      filename = '/home/shared/partials'
-      base_dir = '/home/user/docs'
-      result = @resolver.relative_path filename, base_dir
-      assert_equal '../../shared/partials', result
-    end
-
-    test 'should resolve relative path relative to base dir in unsafe mode' do
-      base_dir = fixture_path 'base'
-      doc = empty_document :base_dir => base_dir, :safe => Asciidoctor::SafeMode::UNSAFE
-      expected = ::File.join base_dir, 'images', 'tiger.png'
-      actual = doc.normalize_system_path 'tiger.png', 'images'
-      assert_equal expected, actual
-    end
-
-    test 'should resolve absolute path as absolute in unsafe mode' do
-      base_dir = fixture_path 'base'
-      doc = empty_document :base_dir => base_dir, :safe => Asciidoctor::SafeMode::UNSAFE
-      actual = doc.normalize_system_path 'tiger.png', '/etc/images'
-      assert_equal '/etc/images/tiger.png', actual
-    end
-  end
-
-  context 'Helpers' do
-    test 'rootname should return file name without extension' do
-      assert_equal 'master', Asciidoctor::Helpers.rootname('master.adoc')
-      assert_equal 'docs/master', Asciidoctor::Helpers.rootname('docs/master.adoc')
-    end
-
-    test 'rootname should file name if it has no extension' do
-      assert_equal 'master', Asciidoctor::Helpers.rootname('master')
-      assert_equal 'docs/master', Asciidoctor::Helpers.rootname('docs/master')
-    end
-
-    test 'UriSniffRx should detect URIs' do
-      assert Asciidoctor::UriSniffRx =~ 'http://example.com'
-      assert Asciidoctor::UriSniffRx =~ 'https://example.com'
-      assert Asciidoctor::UriSniffRx =~ 'data:image/gif;base64,R0lGODlhAQABAIAAAAUEBAAAACwAAAAAAQABAAACAkQBADs='
-    end
-
-    test 'UriSniffRx should not detect an absolute Windows path as a URI' do
-      assert Asciidoctor::UriSniffRx !~ 'c:/sample.adoc'
-      assert Asciidoctor::UriSniffRx !~ 'c:\\sample.adoc'
-    end
-  end
-end

data/test/preamble_test.rb

@@ -1,173 +0,0 @@
-# encoding: UTF-8
-unless defined? ASCIIDOCTOR_PROJECT_DIR
-  $: << File.dirname(__FILE__); $:.uniq!
-  require 'test_helper'
-end
-
-context 'Preamble' do
-
-  test 'title and single paragraph preamble before section' do
-    input = <<-EOS
-= Title
-
-Preamble paragraph 1.
-
-== First Section
-
-Section paragraph 1.
-    EOS
-    result = convert_string(input)
-    assert_xpath '//p', result, 2
-    assert_xpath '//*[@id="preamble"]', result, 1
-    assert_xpath '//*[@id="preamble"]//p', result, 1
-    assert_xpath '//*[@id="preamble"]/following-sibling::*//h2[@id="_first_section"]', result, 1
-    assert_xpath '//*[@id="preamble"]/following-sibling::*//p', result, 1
-  end
-
-  test 'title of preface is blank by default in DocBook output' do
-    input = <<-EOS
-= Document Title
-:doctype: book
-
-Preface content.
-
-== First Section
-
-Section content.
-    EOS
-    result = convert_string input, :backend => :docbook
-    assert_xpath '//preface/title', result, 1
-    title_node = xmlnodes_at_xpath '//preface/title', result, 1
-    assert_equal '', title_node.text
-  end
-
-  test 'preface-title attribute is assigned as title of preface in DocBook output' do
-    input = <<-EOS
-= Document Title
-:doctype: book
-:preface-title: Preface
-
-Preface content.
-
-== First Section
-
-Section content.
-    EOS
-    result = convert_string input, :backend => :docbook
-    assert_xpath '//preface/title[text()="Preface"]', result, 1
-  end
-
-  test 'title and multi-paragraph preamble before section' do
-    input = <<-EOS
-= Title
-
-Preamble paragraph 1.
-
-Preamble paragraph 2.
-
-== First Section
-
-Section paragraph 1.
-    EOS
-    result = convert_string(input)
-    assert_xpath '//p', result, 3
-    assert_xpath '//*[@id="preamble"]', result, 1
-    assert_xpath '//*[@id="preamble"]//p', result, 2
-    assert_xpath '//*[@id="preamble"]/following-sibling::*//h2[@id="_first_section"]', result, 1
-    assert_xpath '//*[@id="preamble"]/following-sibling::*//p', result, 1
-  end
-
-  test 'should not wrap content in preamble if document has title but no sections' do
-    input = <<-EOS
-= Title
-
-paragraph
-    EOS
-    result = convert_string(input)
-    assert_xpath '//p', result, 1
-    assert_xpath '//*[@id="content"]/*[@class="paragraph"]/p', result, 1
-    assert_xpath '//*[@id="content"]/*[@class="paragraph"]/following-sibling::*', result, 0
-  end
-
-  test 'title and section without preamble' do
-    input = <<-EOS
-= Title
-
-== First Section
-
-Section paragraph 1.
-    EOS
-    result = convert_string(input)
-    assert_xpath '//p', result, 1
-    assert_xpath '//*[@id="preamble"]', result, 0
-    assert_xpath '//h2[@id="_first_section"]', result, 1
-  end
-
-  test 'no title with preamble and section' do
-    input = <<-EOS
-Preamble paragraph 1.
-
-== First Section
-
-Section paragraph 1.
-    EOS
-    result = convert_string(input)
-    assert_xpath '//p', result, 2
-    assert_xpath '//*[@id="preamble"]', result, 0
-    assert_xpath '//h2[@id="_first_section"]/preceding::p', result, 1
-  end
-
-  test 'preamble in book doctype' do
-      input = <<-EOS
-= Book
-:doctype: book
-
-Back then...
-
-= Chapter One
-
-[partintro]
-It was a dark and stormy night...
-
-== Scene One
-
-Someone's gonna get axed.
-
-= Chapter Two
-
-[partintro]
-They couldn't believe their eyes when...
-
-== Scene One
-
-The axe came swinging.
-      EOS
-
-      d = document_from_string(input)
-      assert_equal 'book', d.doctype
-      output = d.convert
-      assert_xpath '//h1', output, 3
-      assert_xpath %{//*[@id="preamble"]//p[text() = "Back then#{decode_char 8230}#{decode_char 8203}"]}, output, 1
-  end
-
-  test 'should output table of contents in preamble if toc-placement attribute value is preamble' do
-    input = <<-EOS
-= Article
-:toc:
-:toc-placement: preamble
-
-Once upon a time...
-
-== Section One
-
-It was a dark and stormy night...
-
-== Section Two
-
-They couldn't believe their eyes when...
-      EOS
-
-    output = convert_string input
-    assert_xpath '//*[@id="preamble"]/*[@id="toc"]', output, 1
-  end
-end