middleman-asciidoc 1.0.0.rc.7 → 1.0.0.rc.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7ae4f8ddef716de5e418a26661263c42e49aaf6904d8a8afc909ea0edf780242
-  data.tar.gz: e46fca12ff3c1406ef222daf7e0d0b62d99955d523b35a63bf855fb87eaf137d
+  metadata.gz: fa72cd0510e5297fab150560bad9f8442cc6d7c096b10251f660ab841d686107
+  data.tar.gz: 9fae6c014ec4b90ee98f8ec24f40eee7167f822d129001578f80cc138bc1d043
 SHA512:
-  metadata.gz: 0dce20bf3fda0ac2d72f39fccd325c948a2536bc80fe1d64dfc3412c82ffcb22b4ec31902c31a4629612081ba29804ed67ad343b0e2274e6a0ee83f9256283f6
-  data.tar.gz: e8cc0aa2f4345a7a025d20c6b36d08d9fdb4c5854733392ffb8371ad42e9e2e7f289ae8feb12a65449e33dcef3811c37f771096f40d8926e4212ca1ffdea0246
+  metadata.gz: 4726cd97933cce73a7dda15de14f1a22a42c2f822f91b8b2d337669e48610c8428cffd6531c1464ab172f29510eeb677734b7fa4bc64aa1c35743e8de1099cc3
+  data.tar.gz: 65e8dfa84591fac199e070ef733b34e4d1600c31b31801b6febcf95f21e0627883dbd5b62bdb9bb0fc7bc5c602574a82b075611fce9527873ce27b2064bba797

data/Gemfile

@@ -11,21 +11,27 @@ git 'https://github.com/mojavelinux/middleman.git', branch: 'jruby-compat-fix' d
 end if RUBY_ENGINE == 'jruby'
 
 # Build and doc tools
-gem 'rake', '~> 10.3', require: false
-gem 'yard', '~> 0.8', require: false
+gem 'rake', '~> 12.3.0', require: false
 
 # Test tools
-gem 'cucumber', '~> 2.0', require: false
-gem 'aruba', '~> 0.7.4', require: false
-gem 'capybara', '~> 2.5.0', require: false
+gem 'aruba', '~> 0.14.0', require: false
+gem 'capybara', '~> 2.16.0', require: false
+if (Gem::Version.new RUBY_VERSION) < (Gem::Version.new '2.2.0')
+  gem 'cucumber', '~> 2.99.0', require: false
+else
+  gem 'cucumber', '~> 3.1.0', require: false
+end
 
 # Code coverage tools
-gem 'simplecov', require: false
+gem 'simplecov', '~> 0.15.0', require: false
 
 # Additional libraries for testing
 # Middleman itself (use for testing against development version)
 #gem 'middleman-core', :github => 'middleman/middleman', :branch => 'master'
-gem 'middleman-blog', '~> 4.0', require: false
+gem 'middleman-blog', '~> 4.0.2', require: false
 # NOTE middleman-cli required by middleman-blog
-gem 'middleman-cli', '~> 4.0', require: false
-gem 'listen', '~> 3.0.0', require: false # see https://github.com/middleman/middleman/pull/1891
+if (Gem::Version.new RUBY_VERSION) < (Gem::Version.new '2.2.0')
+  gem 'middleman-cli', '~> 4.0.0', require: false
+else
+  gem 'middleman-cli', '~> 4.2.0', require: false
+end

data/README.adoc

@@ -1,6 +1,6 @@
 = AsciiDoc Extension for Middleman (powered by Asciidoctor)
 Dan Allen <https://github.com/mojavelinux[@mojavelinux]>
-v1.0.0.rc.7, 2017-12-20
+v1.0.0.rc.8, 2017-12-28
 // Settings:
 :idprefix:
 :idseparator: -
@@ -34,15 +34,12 @@ endif::[]
 :badge-gem: https://img.shields.io/gem/v/middleman-asciidoc.svg?label=gem
 :uri-build: https://travis-ci.org/middleman/middleman-asciidoc
 :badge-build: https://img.shields.io/travis/middleman/middleman-asciidoc/master.svg
-:uri-deps: https://gemnasium.com/middleman/middleman-asciidoc
-:badge-deps: https://img.shields.io/gemnasium/middleman/middleman-asciidoc.svg
 //:uri-codequality: https://codeclimate.com/github/middleman/middleman-asciidoc
 //:badge-codequality: https://codeclimate.com/github/middleman/middleman-asciidoc.png
 
 ifdef::status[]
 image:{badge-gem}[Gem Version Badge,link={uri-gem}]
 image:{badge-build}[Build Status Badge,link={uri-build}]
-image:{badge-deps}[Dependency Status Badge,link={uri-deps}]
 //image:{badge-codequality}[Code Quality Badge,link={uri-codequality}]
 endif::[]
 
@@ -115,7 +112,7 @@ end
 The following option keys can be used to configure this extension.
 With the exception of `layout`, these option keys map directly to options in the Asciidoctor API.
 
-attributes (type: Hash or Array, default: [])::
+attributes (type: Hash or String Array, default: [])::
 Custom AsciiDoc attributes to pass to the processor.
 The following built-in attributes are automatically appended to this collection.
 (You can remove a built-in attribute by passing a custom attribute with the corresponding name prefixed with `-`).
@@ -147,14 +144,52 @@ If not specified, defaults to the document directory (i.e., `:docdir`).
 To set the base directory to the source directory, use the keyword `:source` or the expression `app.source_dir`.
 To leave the base directory undefined, use the value `nil`.
 
+layout (type: String or Symbol, default: nil)::
+The name of the default layout for AsciiDoc-based pages (pages processed by this extension, not including blog articles if a blog layout is specified).
+
 safe (type: Symbol, default: :safe)::
 The safe mode level under which to run the AsciiDoc processor.
 
-layout (type: String or Symbol, default: nil)::
-The name of the default layout for AsciiDoc-based pages (pages processed by this extension, not including blog articles if a blog layout is specified).
+template_dirs (type: String or String Array, default: nil)::
+One or more directory paths (relative to the site root) where Asciidoctor converter templates should be discovered.
+Asciidoctor templates can be used to customize the HTML generated for each node in the Asciidoctor document tree.
+
+template_engine (type: String or Symbol, default: nil)::
+The template engine filter to apply when scanning for Asciidoctor converter templates.
+For example, to only discover Slim templates, set this to `:slim`.
+
+template_engine_options (type: Hash, default: nil)::
+Additional options to pass to the template engine when invoking the Asciidoctor converter templates.
+Options must be indexed by the template engine name (e.g., `:slim`).
 
 TIP: The full set of options can be seen on your preview server's config page at the path [.path]_/__middleman/config/_.
 
+=== Configuring Specific Pages
+
+You can pass extra attributes and other options to the AsciiDoc processor for a given page (or set of pages) using the `:renderer_options` option of the `page` directive (where the "`renderer`" is the AsciiDoc processor):
+
+[source,ruby]
+----
+page 'manual', renderer_options: {
+  attributes: { 'sectanchors' => '' }
+}
+----
+
+NOTE: The first argument to the `page` directive is the page ID.
+The page ID is computed by starting with the path of the source file relative to the source directory, then removing the template extension (i.e., the AsciiDoc extension), then removing the `.html` extension, if present.
+For example, the page ID for both [.path]_home.adoc_ and [.path]_home.html.adoc_ is `home`.
+
+WARNING: Attributes passed to the page directive must be specified as a Hash and receive no additional processing.
+
+You can add extra attributes to a page more concisely using the `:attributes` option on the page directive:
+
+[source,ruby]
+----
+page 'manual', attributes: { 'sectanchors' => '' }
+----
+
+The `:attributes` option on the page directive takes precedence over the `:attributes` option in `:renderer_options`.
+
 == Creating Pages
 
 Each AsciiDoc file in the source directory (except for files that begin with `+_+` or which are located in a directory that begins with `+_+`) becomes a page in the site.
@@ -229,7 +264,7 @@ Alternately, you can set a default layout just for AsciiDoc-based pages (pages p
 activate :asciidoc, layout: :name_of_layout
 ----
 
-Finally, you can set the layout for a specific page or group of pages using the page directive.
+Finally, you can set the layout for a specific page or group of pages using the `page` directive.
 This is an alternate way to define front matter for a page.
 
 [source,ruby]
@@ -237,10 +272,6 @@ This is an alternate way to define front matter for a page.
 page 'home', layout: :name_of_layout
 ----
 
-NOTE: The first argument to the `page` function is the page ID.
-The page ID is computed starting from the path of the source file relative to the source directory, then removing the template extension (i.e., the AsciiDoc extension), then removing the `.html` extension, if present.
-For example, the page ID for both [.path]_home.adoc_ and [.path]_home.html.adoc_ is `home`.
-
 TIP: When you define the layout in [.path]_config.rb_, you can specify the value either as a String or a Symbol.
 
 If you don't set the layout in [.path]_config.rb_, the default layout is considered unset.
@@ -284,6 +315,25 @@ You can do so in an ERB template using:
 
 Other processor options, such as `:attributes`, are available from the `current_page.options[:renderer_options]` variable path.
 
+==== Accessing the AsciiDoc Document From a Layout
+
+You can access the document model for the current AsciiDoc-based page from the page layout as follows:
+
+----
+<%= current_page.data.document %>
+----
+
+This object is an instance of `Asciidoctor::Document`.
+It can be used, for instance, to output a table of contents for the current page:
+
+----
+<% if (doc = current_page.data.document) %>
+<%= doc.converter.convert doc, 'outline', toclevels: 3 %>
+<% end %>
+----
+
+For more information about this API, refer to the http://www.rubydoc.info/gems/asciidoctor/Asciidoctor/Document[API documentation].
+
 === Ignoring a Page
 
 In addition to the normal ignore filter in Middleman, you can also control whether a page is ignored from AsciiDoc.
@@ -490,7 +540,7 @@ In your site's [.path]_config.rb_ file, configure Asciidoctor to load the templa
 
 [source,ruby]
 ----
-activate :asciidoc, template_dirs: source/_asciidoc_templates
+activate :asciidoc, template_dirs: 'source/_asciidoc_templates'
 ----
 
 === Step {counter:step}: Compose a Template

data/features/asciidoc-pages.feature

@@ -423,7 +423,7 @@ Feature: AsciiDoc Support
     When I go to "/page-data.html"
     Then I should see:
       """
-      <pre>{"id"=>"page-data", "title"=>"Page Data", "v-chrarray"=>["a", "b", "c"], "v-dblquote"=>"\"", "v-empty"=>"", "v-false"=>false, "v-hash"=>{"a"=>"a", "b"=>"b", "c"=>"c"}, "v-null"=>nil, "v-num"=>1, "v-numarray"=>[1, 2, 3], "v-quote"=>"'", "v-true"=>true}</pre>
+      <pre>{"document"=>"Page Data", "id"=>"page-data", "title"=>"Page Data", "v-chrarray"=>["a", "b", "c"], "v-dblquote"=>"\"", "v-empty"=>"", "v-false"=>false, "v-hash"=>{"a"=>"a", "b"=>"b", "c"=>"c"}, "v-null"=>nil, "v-num"=>1, "v-numarray"=>[1, 2, 3], "v-quote"=>"'", "v-true"=>true}</pre>
       """
 
   Scenario: Promoting standard AsciiDoc attributes to page data
@@ -740,6 +740,16 @@ Feature: AsciiDoc Support
       <h2 id="_section_a"><a class="anchor" href="#_section_a"></a>Section A</h2>
       """
 
+  Scenario: Setting custom attributes for a specific page abbrev
+    Given a fixture app "asciidoc-pages-app"
+    And app "asciidoc-pages-app" is using config "page-attributes-abbrev"
+    And the Server is running
+    When I go to "/with-sections.html"
+    Then I should see:
+      """
+      <h2 id="_section_a"><a class="anchor" href="#_section_a"></a>Section A</h2>
+      """
+
   Scenario: Using custom templates to convert AsciiDoc document nodes to HTML
     Given a fixture app "asciidoc-pages-app"
     And a file named "config.rb" with:

data/features/support/env.rb

@@ -4,4 +4,8 @@ require 'simplecov' if ENV['COVERAGE'] == 'true'
 ENV['TEST'] = 'true'
 require 'middleman-core'
 require 'middleman-core/step_definitions'
+module SilenceArubaDeprecations
+  def deprecated msg; end
+end
+Aruba::Platforms::UnixPlatform.prepend SilenceArubaDeprecations
 require File.join PROJECT_ROOT_PATH, 'lib', 'middleman-asciidoc'

data/fixtures/asciidoc-pages-app/config-page-attributes-abbrev.rb

@@ -0,0 +1,2 @@
+activate :asciidoc
+page 'with-sections', attributes: { 'sectanchors' => '' }

data/fixtures/asciidoc-pages-app/source/layouts/inspect-page-data.erb

@@ -4,6 +4,8 @@
 <title><%= current_resource.data.title %></title>
 </head>
 <body>
-<pre><%= (JSON.load current_resource.data.to_json).sort.to_h.inspect %></pre>
+<pre>{<%= current_resource.data.keys.sort.map {|k|
+  %("#{k}"=>#{(k == 'document' ? current_resource.data[k].doctitle : (JSON.load current_resource.data[k].to_json)).inspect })
+} * ', ' %>}</pre>
 </body>
 </html>

data/lib/middleman-asciidoc/extension.rb

@@ -1,4 +1,5 @@
 require 'asciidoctor' unless defined? Asciidoctor
+require 'middleman-asciidoc/template'
 
 module Middleman
   module AsciiDoc
@@ -97,9 +98,17 @@ module Middleman
             page_attrs['docdir'] = (dir = ::File.dirname path)
             page_attrs['docname'] = ::File.basename path, (page_attrs['docfilesuffix'] = ::File.extname path)
           end
-          if (page_asciidoc_opts = resource.options.delete :renderer_options)
-            (page_asciidoc_opts[:attributes] ||= {}).update page_attrs
+          # handle options set using the page directive
+          # :attributes key on page directive takes precedence over :attributes key in :asciidoc option
+          initial_page_attrs = resource.options.delete :attributes
+          if ::Hash === (page_asciidoc_opts = resource.options.delete :asciidoc)
+            if ::Hash === initial_page_attrs ||
+                ::Hash === (initial_page_attrs = page_asciidoc_opts.delete :attributes)
+              page_attrs = initial_page_attrs.merge page_attrs
+            end
+            page_asciidoc_opts[:attributes] = page_attrs
           else
+            page_attrs = initial_page_attrs.merge page_attrs if ::Hash === initial_page_attrs
             page_asciidoc_opts = { attributes: page_attrs }
           end
           opts, page = { renderer_options: page_asciidoc_opts }, {}

data/lib/middleman-asciidoc/template.rb

@@ -0,0 +1,24 @@
+# Enhance the default template for AsciiDoc to make the Asciidoctor::Document
+# instance accessible to the current page via the variable path
+# `current_page.data.document`.
+module Middleman; module AsciiDoc
+  module Template
+    DEFAULT_OPTIONS = { header_footer: false }
+
+    def prepare
+      @document = ::Asciidoctor.load data, (DEFAULT_OPTIONS.merge options)
+      if ::Middleman::TemplateContext === (ctx = options[:context])
+        ctx.current_page.data.document = @document
+      end
+      @output = nil
+    end
+
+    def evaluate scope, locals
+      @output ||= @document.convert
+    end
+  end
+
+  if (template_class = ::Tilt[:adoc])
+    template_class.send :prepend, Template
+  end
+end; end

data/lib/middleman-asciidoc/version.rb

@@ -1,5 +1,5 @@
 module Middleman
   module AsciiDoc
-    VERSION = '1.0.0.rc.7'
+    VERSION = '1.0.0.rc.8'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: middleman-asciidoc
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc.7
+  version: 1.0.0.rc.8
 platform: ruby
 authors:
 - Dan Allen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-20 00:00:00.000000000 Z
+date: 2017-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: middleman-core
@@ -75,6 +75,7 @@ files:
 - fixtures/asciidoc-blog-app/source/layouts/article.erb
 - fixtures/asciidoc-blog-app/source/layouts/asciidoc_page.erb
 - fixtures/asciidoc-pages-app/config-global-layout.rb
+- fixtures/asciidoc-pages-app/config-page-attributes-abbrev.rb
 - fixtures/asciidoc-pages-app/config-page-attributes.rb
 - fixtures/asciidoc-pages-app/config-page-layout.rb
 - fixtures/asciidoc-pages-app/config-set-asciidoc.rb
@@ -117,6 +118,7 @@ files:
 - lib/middleman-asciidoc.rb
 - lib/middleman-asciidoc/extension.rb
 - lib/middleman-asciidoc/middleman_extension.rb
+- lib/middleman-asciidoc/template.rb
 - lib/middleman-asciidoc/version.rb
 - middleman-asciidoc.gemspec
 homepage: https://github.com/middleman/middleman-asciidoc
@@ -139,7 +141,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.7.4
 signing_key: 
 specification_version: 4
 summary: AsciiDoc support for Middleman
@@ -166,6 +168,7 @@ test_files:
 - fixtures/asciidoc-blog-app/source/layouts/article.erb
 - fixtures/asciidoc-blog-app/source/layouts/asciidoc_page.erb
 - fixtures/asciidoc-pages-app/config-global-layout.rb
+- fixtures/asciidoc-pages-app/config-page-attributes-abbrev.rb
 - fixtures/asciidoc-pages-app/config-page-attributes.rb
 - fixtures/asciidoc-pages-app/config-page-layout.rb
 - fixtures/asciidoc-pages-app/config-set-asciidoc.rb