middleman-asciidoc 1.0.0.rc.4 → 1.0.0.rc.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 09404febee1aa7a38d25fbeb16e29c21e1790e3a3eb5f4033d2c19aa1c016467
-  data.tar.gz: cf334b89c66b3415fab2af159461c32f4c292d5907f0dfd1d0f8e92932612387
+  metadata.gz: c36ec3831f7e530ddd384d86818651332d51691441da4657581dcc1b0ffa32a7
+  data.tar.gz: 0cb91df8ade3ee3a0d9720397b79612c3d48c1a62d3b3cf057b015e19b6b50e1
 SHA512:
-  metadata.gz: c97fc8f19a5531aac959f91332e442b15de33b8834475f2b5f075f6cd2005a3190f9343b10264b43347941f9954e6e8562fee07737901a9f1f2c97ad0d4ea4d6
-  data.tar.gz: 88802a4fe982d3fd841426c56f9ef9738d7a117203b7d80c6af1f02adff690f70efb3359188f6d695e4274d8b4b1d74af60e5455a53d269a8005fd186dfbfbd0
+  metadata.gz: fa80fa61d1665135bcf04676f45b7dcee6638cce2cdc3b4b133cdaa69d70db0f671201e9e3ea52740257494e4b1fb8d01e9eb48d9fea269bc4ca4228e320ce30
+  data.tar.gz: 8c984dbfaf206fa58cb89a317320cd5e9d28b60183dbe61621f450dcebc50f319af9e9ad5e15351c9ce9ae19536b7114bf17ef2524c00ef0bbfa70d70b3390ed

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.4, 2017-11-29
+v1.0.0.rc.5, 2017-12-03
 // Settings:
 :idprefix:
 :idseparator: -
@@ -75,22 +75,38 @@ You're now ready to activate this extension and begin putting it to work.
 
 == Activation and Configuration
 
-To activate this extension, add the following line to the [.path]_config.rb_ file for your site:
+To activate the AsciiDoc extension, add the following line to the [.path]_config.rb_ file for your site:
 
 [source,ruby]
 ----
 activate :asciidoc
 ----
 
-You can also pass AsciiDoc configuration options to the underlying Asciidoctor processor as a Hash or Array.
-Here's an example of passing the attribute as an Array:
+You can also pass options to the extension.
+One way is to pass a Hash of options as the second argument of `activate`.
+In this case, the option keys must be expressed as symbols.
+
+Here's an example of how to set the `attributes` option for this extension, which assigns attributes to the underlying Asciidoctor processor:
 
 [source,ruby]
 ----
 activate :asciidoc, attributes: ['source-highlighter=coderay']
 ----
 
-The following option keys from the Asciidoctor API can be added to the Hash of the second argument to `activate`:
+Alternately, you can assign options directly to the extension object when using the block form of `activate`.
+In this case, the options are properties of the extension object.
+
+Here's how to assign the `attributes` option for this extension using the block form of `activate`:
+
+[source,ruby]
+----
+activate :asciidoc do |asciidoc|
+  asciidoc.attributes = ['source-highlighter=coderay']
+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: [])::
 Custom AsciiDoc attributes to pass to the processor.
@@ -197,6 +213,18 @@ 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.
+This is an alternate way to define front matter for a page.
+
+[source,ruby]
+----
+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.

data/features/asciidoc-blog.feature

@@ -60,6 +60,16 @@ Feature: Blog Integration
     When I go to "/blog/ignored.html"
     Then I should see "Not Found"
 
+  Scenario: Specifying _auto_layout in blog configuration falls back to layout defined in AsciiDoc configuration
+    Given a fixture app "asciidoc-blog-app"
+    And app "asciidoc-blog-app" is using config "auto-layout"
+    And the Server is running
+    When I go to "/blog/welcome.html"
+    Then I should see:
+      """
+      <title>AsciiDoc Page: Welcome</title>
+      """
+
   Scenario: The layout defined in blog configuration takes precedence over the layout defined in AsciiDoc configuration
     Given a fixture app "asciidoc-blog-app"
     And app "asciidoc-blog-app" is using config "asciidoc-layout"

data/features/asciidoc-pages.feature

@@ -1,7 +1,7 @@
 Feature: AsciiDoc Support
   In order to test AsciiDoc support
 
-  Scenario: Rendering html
+  Scenario: Rendering HTML page from AsciiDoc document
     Given the Server is running at "asciidoc-pages-app"
     When I go to "/hello.html"
     Then I should see:
@@ -12,6 +12,16 @@ Feature: AsciiDoc Support
       </div>
       """
 
+  Scenario: Rendering HTML page from AsciiDoc document with alternate extension
+    Given the Server is running at "asciidoc-pages-app"
+    When I go to "/goodbye.html"
+    Then I should see:
+      """
+      <div class="paragraph">
+      <p>So long!</p>
+      </div>
+      """
+
   Scenario: Rendering html with double file extension
     Given the Server is running at "asciidoc-pages-app"
     When I go to "/hello-with-extension.html"
@@ -50,7 +60,7 @@ Feature: AsciiDoc Support
 
   Scenario: Rendering html with no layout specified
     Given a fixture app "asciidoc-pages-app"
-    And app "asciidoc-pages-app" is using config "default-layout"
+    And app "asciidoc-pages-app" is using config "global-layout"
     And a file named "source/no-layout.adoc" with:
       """
       Hello, AsciiDoc!
@@ -74,7 +84,7 @@ Feature: AsciiDoc Support
 
   Scenario: Rendering html with auto layout specified
     Given a fixture app "asciidoc-pages-app"
-    And app "asciidoc-pages-app" is using config "default-layout"
+    And app "asciidoc-pages-app" is using config "global-layout"
     And a file named "source/auto-layout.adoc" with:
       """
       :page-layout: _auto_layout
@@ -100,7 +110,7 @@ Feature: AsciiDoc Support
 
   Scenario: Rendering html with blank layout specified
     Given a fixture app "asciidoc-pages-app"
-    And app "asciidoc-pages-app" is using config "default-layout"
+    And app "asciidoc-pages-app" is using config "global-layout"
     And a file named "source/blank-layout.adoc" with:
       """
       :page-layout:
@@ -238,7 +248,7 @@ Feature: AsciiDoc Support
 
   Scenario: Default safe mode for AsciiDoc processor
     Given a fixture app "asciidoc-pages-app"
-    And app "asciidoc-pages-app" is using config "default-layout"
+    And app "asciidoc-pages-app" is using config "global-layout"
     And the Server is running
     When I go to "/safe-mode.html"
     Then I should see:
@@ -320,6 +330,27 @@ Feature: AsciiDoc Support
       </html>
       """
 
+  Scenario: Rendering html with layout from page directive
+    Given a fixture app "asciidoc-pages-app"
+    And app "asciidoc-pages-app" is using config "page-layout"
+    And the Server is running
+    When I go to "/hello.html"
+    Then I should see:
+      """
+      <!DOCTYPE html>
+      <html>
+      <head>
+      <title>Fallback</title>
+      </head>
+      <body>
+      <div class="paragraph">
+      <p>Hello, AsciiDoc!
+      Middleman, I am in you.</p>
+      </div>
+      </body>
+      </html>
+      """
+
   Scenario: Ignoring files marked as ignored
     Given the Server is running at "asciidoc-pages-app"
     When I go to "/ignored.html"
@@ -336,6 +367,11 @@ Feature: AsciiDoc Support
     And I should see content matching %r{<p>site-destination=.+/tmp/aruba/asciidoc-pages-app/build</p>}
     And I should see content matching %r{<p>site-environment=development</p>}
 
+  Scenario: Assigning page ID to page-id attribute
+    Given the Server is running at "asciidoc-pages-app"
+    When I go to "/topic/echo-page-id.html"
+    Then I should see "topic/echo-page-id"
+
   Scenario: Merging page data in front matter and AsciiDoc header
     Given the Server is running at "asciidoc-pages-app"
     When I go to "/hello-with-mixed-page-data.html"

data/fixtures/asciidoc-blog-app/config-auto-layout.rb

@@ -0,0 +1,9 @@
+activate :asciidoc, layout: :asciidoc_page
+
+require 'middleman-blog'
+
+activate :blog do |blog|
+  blog.layout = '_auto_layout'
+  blog.sources = 'blog/{title}.html'
+  blog.permalink = 'blog/{title}.html'
+end

data/fixtures/asciidoc-pages-app/config-page-layout.rb

@@ -0,0 +1,2 @@
+activate :asciidoc
+page 'hello', layout: :default

data/fixtures/asciidoc-pages-app/source/goodbye.asciidoc

@@ -0,0 +1,3 @@
+= Goodbye
+
+So long!

data/fixtures/asciidoc-pages-app/source/topic/echo-page-id.adoc

@@ -0,0 +1,3 @@
+= Echo Page ID
+
+{page-id}

data/lib/middleman-asciidoc/extension.rb

@@ -21,11 +21,12 @@ module Middleman
 
       option :attributes, [], 'Custom AsciiDoc attributes passed to all AsciiDoc-based pages. Defaults to empty Array. (Hash or Array)'
       option :backend, :html5, 'Moniker used to select output format for AsciiDoc-based pages. Defaults to :html5. (Symbol)'
-      option :base_dir, :docdir, 'Base directory to use for the current AsciiDoc document. Defaults to :docdir (tracks directory of document). (String)'
+      option :base_dir, :docdir, 'Base directory to use for the current AsciiDoc document. Defaults to :docdir, which is replaced with the document directory. (String)'
       option :safe, :safe, 'Safe mode level for AsciiDoc processor. Defaults to :safe. (Symbol)'
       option :layout, nil, 'Name of layout to use for AsciiDoc-based pages (not blog articles) (String or Symbol)'
 
       def initialize app, options_hash = {}, &block
+        return if app.mode? :config
         super
         app.config.define_setting :asciidoc, {}, 'AsciiDoc processor options (Hash)'
         # NOTE support global :asciidoc_attributes setting for backwards compatibility
@@ -34,6 +35,7 @@ module Middleman
 
       # NOTE options passed to activate take precedence (e.g., activate :asciidoc, attributes: ['foo=bar'])
       def after_configuration
+        app.config[:asciidoc_extensions] = prune_tilt_mapping!
         # Match behavior of middleman blog extension
         # Make sure ActiveSupport's TimeZone stuff has something to work with,
         # allowing people to set their desired time zone via Time.zone or
@@ -97,25 +99,30 @@ module Middleman
           cfg[:safe] = (cfg[:safe] || :safe).to_sym
           if (default_layout = options[:layout] || app.config[:layout])
             # set priority to run after blog extension, which also sets a layout
-            app.sitemap.register_resource_list_manipulator :asciidoc_default_layout, (DefaultLayoutConfigurator.new default_layout.to_sym), 60
+            app.sitemap.register_resource_list_manipulator :asciidoc_default_layout, (DefaultLayoutConfigurator.new app, default_layout.to_sym), 60
           end
         end
       end
 
       def manipulate_resource_list resources
-        asciidoc_opts = app.config[:asciidoc].merge parse_header_only: true
-        asciidoc_opts[:attributes] = (asciidoc_attrs = asciidoc_opts[:attributes].merge 'skip-front-matter' => '')
-        app.config[:asciidoc].delete :base_dir if (use_docdir_as_base_dir = asciidoc_opts[:base_dir] == :docdir)
-        resources.each do |resource|
-          next if resource.ignored? || (path = resource.source_file).blank? || !(path.end_with? '.adoc')
+        header_asciidoc_opts = app.config[:asciidoc].merge parse_header_only: true
+        header_asciidoc_attrs = (header_asciidoc_opts[:attributes] = header_asciidoc_opts[:attributes].merge 'skip-front-matter' => '')
+        use_docdir_as_base_dir = header_asciidoc_opts[:base_dir] == :docdir
 
-          opts, page = {}, {}
+        resources.select {|res| !res.ignored? && (asciidoc_file? res) }.each do |resource|
+          path = resource.source_file
+          if (page_asciidoc_opts = resource.options.delete :renderer_options)
+            (page_asciidoc_opts[:attributes] ||= {})['page-id'] = resource.page_id
+          else
+            page_asciidoc_opts = { attributes: { 'page-id' => resource.page_id } }
+          end
+          opts, page = { renderer_options: page_asciidoc_opts }, {}
 
-          asciidoc_attrs['page-layout'] = %(#{resource.options[:layout]}@)
-          opts[:base_dir] = asciidoc_opts[:base_dir] = ::File.dirname path if use_docdir_as_base_dir
+          header_asciidoc_opts[:base_dir] = page_asciidoc_opts[:base_dir] = ::File.dirname path if use_docdir_as_base_dir
+          header_asciidoc_attrs['page-layout'] = %(#{resource.options[:layout]}@)
           # read AsciiDoc header only to set page options and data
           # header values can be accessed via app.data.page.<name> in the layout
-          doc = ::Asciidoctor.load_file path, asciidoc_opts
+          doc = ::Asciidoctor.load_file path, header_asciidoc_opts
 
           if (doc.attr? 'page-ignored') && !(doc.attr? 'page-ignored', 'false')
             resource.ignore!
@@ -133,7 +140,7 @@ module Middleman
                 opts[:layout] = false
               when :false
                 opts[:layout] = false
-                opts[:header_footer] = true
+                page_asciidoc_opts[:header_footer] = true
               else
                 opts[:layout] = layout
                 opts[:layout_engine] = doc.attr 'page-layout-engine' if doc.attr? 'page-layout-engine'
@@ -141,7 +148,7 @@ module Middleman
             end
           else
             opts[:layout] = false
-            opts[:header_footer] = true
+            page_asciidoc_opts[:header_footer] = true
           end
 
           page[:title] = doc.doctitle if doc.header?
@@ -178,9 +185,14 @@ module Middleman
             resource.destination_path << doc.outfilesuffix
           end
 
-          # NOTE opts won't override any keys defined in global options
+          # NOTE only options[:renderer_options] overrides keys defined in global options
           resource.add_metadata options: opts, page: page
         end
+        resources
+      end
+
+      def asciidoc_file? resource
+        (path = resource.source_file) && (path.end_with? *app.config[:asciidoc_extensions])
       end
 
       def merge_attributes attrs, initial = {}
@@ -232,7 +244,7 @@ module Middleman
       # Returns an [Object] parsed from the string-based YAML value or empty [String] if the specified value is empty.
       def parse_yaml_value val
         if val.empty?
-          ''
+          val
         else
           begin
             ::YAML.load %(--- #{val})
@@ -242,25 +254,58 @@ module Middleman
           end
         end
       end
+
+      # Resolves lazy AsciidoctorTemplate entries in the Tilt mapping, prunes those entries, and returns the
+      # extensions (with the leading dot) for which the AsciidoctorTemplate is registered.
+      #
+      # Pruning prevents Tilt::Mapping.default_mapping#extensions_for from returning duplicate extensions.
+      #
+      # Returns a String Array of extensions for which the AsciidoctorTemplate is registered.
+      def prune_tilt_mapping!
+        if ::Tilt.respond_to? :default_mapping
+          (mapping = ::Tilt.default_mapping).extensions_for(::Tilt::AsciidoctorTemplate).uniq.map do |ext|
+            if mapping.lazy_map.key? ext
+              mapping[ext]
+              mapping.lazy_map.delete ext
+            end
+            %(.#{ext})
+          end
+        else
+          ::Tilt.mappings.select {|_, classes| classes.include? ::Tilt::AsciidoctorTemplate }.keys.map {|ext| %(.#{ext}) }
+        end
+      end
     end
 
     # Resolves the automatic layout if no layout has been specified and this resource is not a blog article
     class DefaultLayoutConfigurator
-      def initialize layout
+      def initialize app, layout
+        @app = app
         @layout = layout
       end
 
       def manipulate_resource_list resources
-        resources.each do |resource|
-          next if resource.ignored? || (path = resource.source_file).blank? || !(path.end_with? '.adoc') ||
-              resource.options[:layout] != :_auto_layout
-          if (resource.respond_to? :blog_data) && (blog_layout = resource.blog_data.options[:layout]) &&
+        resources.select {|res| !res.ignored? && (has_auto_layout? res) && (asciidoc_file? res) }.each do |resource|
+          if (blog_article? resource) &&
+              (blog_layout = resource.blog_data.options[:layout]) &&
               (blog_layout = blog_layout.to_sym) != :_auto_layout
             resource.options[:layout] = blog_layout
           else
             resource.options[:layout] = @layout
           end
         end
+        resources
+      end
+
+      def has_auto_layout? resource
+        resource.options[:layout] == :_auto_layout
+      end
+
+      def asciidoc_file? resource
+        (path = resource.source_file) && (path.end_with? *@app.config[:asciidoc_extensions])
+      end
+
+      def blog_article? resource
+        resource.respond_to? :blog_data
       end
     end
   end

data/lib/middleman-asciidoc/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: middleman-asciidoc
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc.4
+  version: 1.0.0.rc.5
 platform: ruby
 authors:
 - Dan Allen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-30 00:00:00.000000000 Z
+date: 2017-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: middleman-core
@@ -57,6 +57,7 @@ files:
 - features/asciidoc-pages.feature
 - features/support/env.rb
 - fixtures/asciidoc-blog-app/config-asciidoc-layout.rb
+- fixtures/asciidoc-blog-app/config-auto-layout.rb
 - fixtures/asciidoc-blog-app/config-date-in-filename.rb
 - fixtures/asciidoc-blog-app/config-published-only.rb
 - fixtures/asciidoc-blog-app/config.rb
@@ -72,7 +73,8 @@ files:
 - fixtures/asciidoc-blog-app/source/index.html.erb
 - fixtures/asciidoc-blog-app/source/layouts/article.erb
 - fixtures/asciidoc-blog-app/source/layouts/asciidoc_page.erb
-- fixtures/asciidoc-pages-app/config-default-layout.rb
+- fixtures/asciidoc-pages-app/config-global-layout.rb
+- fixtures/asciidoc-pages-app/config-page-layout.rb
 - fixtures/asciidoc-pages-app/config.rb
 - fixtures/asciidoc-pages-app/source/_include.adoc
 - fixtures/asciidoc-pages-app/source/backend.adoc
@@ -80,6 +82,7 @@ files:
 - fixtures/asciidoc-pages-app/source/custom-attribute.adoc
 - fixtures/asciidoc-pages-app/source/custom-imagesdir.adoc
 - fixtures/asciidoc-pages-app/source/gallery.adoc
+- fixtures/asciidoc-pages-app/source/goodbye.asciidoc
 - fixtures/asciidoc-pages-app/source/hello-with-extension.html.adoc
 - fixtures/asciidoc-pages-app/source/hello-with-front-matter.adoc
 - fixtures/asciidoc-pages-app/source/hello-with-mixed-page-data.adoc
@@ -101,6 +104,7 @@ files:
 - fixtures/asciidoc-pages-app/source/safe-mode.adoc
 - fixtures/asciidoc-pages-app/source/site-information.adoc
 - fixtures/asciidoc-pages-app/source/standard-page-data.adoc
+- fixtures/asciidoc-pages-app/source/topic/echo-page-id.adoc
 - lib/middleman-asciidoc.rb
 - lib/middleman-asciidoc/extension.rb
 - lib/middleman-asciidoc/middleman_extension.rb
@@ -135,6 +139,7 @@ test_files:
 - features/asciidoc-pages.feature
 - features/support/env.rb
 - fixtures/asciidoc-blog-app/config-asciidoc-layout.rb
+- fixtures/asciidoc-blog-app/config-auto-layout.rb
 - fixtures/asciidoc-blog-app/config-date-in-filename.rb
 - fixtures/asciidoc-blog-app/config-published-only.rb
 - fixtures/asciidoc-blog-app/config.rb
@@ -150,7 +155,8 @@ test_files:
 - fixtures/asciidoc-blog-app/source/index.html.erb
 - fixtures/asciidoc-blog-app/source/layouts/article.erb
 - fixtures/asciidoc-blog-app/source/layouts/asciidoc_page.erb
-- fixtures/asciidoc-pages-app/config-default-layout.rb
+- fixtures/asciidoc-pages-app/config-global-layout.rb
+- fixtures/asciidoc-pages-app/config-page-layout.rb
 - fixtures/asciidoc-pages-app/config.rb
 - fixtures/asciidoc-pages-app/source/_include.adoc
 - fixtures/asciidoc-pages-app/source/backend.adoc
@@ -158,6 +164,7 @@ test_files:
 - fixtures/asciidoc-pages-app/source/custom-attribute.adoc
 - fixtures/asciidoc-pages-app/source/custom-imagesdir.adoc
 - fixtures/asciidoc-pages-app/source/gallery.adoc
+- fixtures/asciidoc-pages-app/source/goodbye.asciidoc
 - fixtures/asciidoc-pages-app/source/hello-with-extension.html.adoc
 - fixtures/asciidoc-pages-app/source/hello-with-front-matter.adoc
 - fixtures/asciidoc-pages-app/source/hello-with-mixed-page-data.adoc
@@ -179,3 +186,4 @@ test_files:
 - fixtures/asciidoc-pages-app/source/safe-mode.adoc
 - fixtures/asciidoc-pages-app/source/site-information.adoc
 - fixtures/asciidoc-pages-app/source/standard-page-data.adoc
+- fixtures/asciidoc-pages-app/source/topic/echo-page-id.adoc