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

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c36ec3831f7e530ddd384d86818651332d51691441da4657581dcc1b0ffa32a7
-  data.tar.gz: 0cb91df8ade3ee3a0d9720397b79612c3d48c1a62d3b3cf057b015e19b6b50e1
+  metadata.gz: 3fbada42f7900398ed4146ab4c34415730ff11250e7fe0aeac5fb0a9ab79052f
+  data.tar.gz: 8f8d642ddad76e9543043b12537b8d993e187a488b8441345e6251d868d95b65
 SHA512:
-  metadata.gz: fa80fa61d1665135bcf04676f45b7dcee6638cce2cdc3b4b133cdaa69d70db0f671201e9e3ea52740257494e4b1fb8d01e9eb48d9fea269bc4ca4228e320ce30
-  data.tar.gz: 8c984dbfaf206fa58cb89a317320cd5e9d28b60183dbe61621f450dcebc50f319af9e9ad5e15351c9ce9ae19536b7114bf17ef2524c00ef0bbfa70d70b3390ed
+  metadata.gz: 08bef99c6140b5dfbfe52cdf0ea75a4fb493cc086b5cd56ba31cd3bf0cdc6bf0b673ad160adf36cb2105e023e6b8363089dab51c895603bf77bfd62aac2a191d
+  data.tar.gz: e205ad469ba66138631ea7cf0040a64df009c7f78129ec658c125e73dcfbd2f49f23edd9a12d73d988463da26c9837a3479395ef123b3f27d727139abb79bb68

data/Gemfile

@@ -4,7 +4,9 @@ source 'https://rubygems.org'
 gemspec
 
 # NOTE when running tests on JRuby, use version of middleman-core that does not depend on fast_blank
-git 'https://github.com/middleman/middleman.git', ref: '1d13e415e27aa1b30d85fecebf8cc0f91d4023c6' do
+#git 'https://github.com/middleman/middleman.git', ref: '1d13e415e27aa1b30d85fecebf8cc0f91d4023c6' do
+# ...and which fixes the misplaced chmod command
+git 'https://github.com/mojavelinux/middleman.git', branch: 'jruby-compat-fix' do
   gem 'middleman-core'
 end if RUBY_ENGINE == 'jruby'
 

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.5, 2017-12-03
+v1.0.0.rc.6, 2017-12-07
 // Settings:
 :idprefix:
 :idseparator: -
@@ -44,7 +44,7 @@ Specifically, this extension converts AsciiDoc files in your site source to HTML
 This conversion is performed using {uri-asciidoctor}[Asciidoctor] by default.
 
 IMPORTANT: This extension is designed for Middleman >= 4.0.0.
-Prior to Middleman 4, AsciiDoc support was part of Middleman core.
+Prior to Middleman 4, AsciiDoc support was bundled with Middleman.
 
 == Installation
 
@@ -175,11 +175,12 @@ The value is parsed as https://en.wikipedia.org/wiki/YAML[YAML] data (that which
 In addition to these explicit page attributes, the following AsciiDoc attributes are also promoted to page data:
 
 * doctitle (i.e., the document title) (becomes title)
-* author
-* authors (converted to an Array of String values)
-* email
+* author (becomes author.name)
+* email (becomes author.email or author.url)
+ ** if value matches the pattern `url[@username]`, author.username is also set
+* authors (converted to an Array of Author objects)
 * revdate (becomes date; value is converted to a Time object)
-* keywords (left as a String value)
+* keywords (value is kept as a String)
 * description
 
 TIP: You can continue to specify page data using the front matter header.

data/features/asciidoc-blog.feature

@@ -46,7 +46,6 @@ Feature: Blog Integration
     When I go to "/index.html"
     Then I should not see "/blog/not-published.html"
 
-  @nojava
   Scenario: A blog article marked as not published should not be published when generating the site
     Given a fixture app "asciidoc-blog-app"
     And I run `middleman build`

data/features/asciidoc-pages.feature

@@ -396,7 +396,7 @@ Feature: AsciiDoc Support
     When I go to "/page-data.html"
     Then I should see:
       """
-      <pre>{"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>{"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
@@ -406,8 +406,10 @@ Feature: AsciiDoc Support
       """
       <p>Page Title</p>
       <p>Doc Writer</p>
-      <p>Doc Writer | Junior Writer</p>
       <p>doc.writer@example.com</p>
+      <p>Doc Writer | Junior Writer</p>
+      <p>https://social.example.com/jrw</p>
+      <p>jrw</p>
       <p>This is a sample page.</p>
       <p>meta, AsciiDoc, Middleman</p>
       """
@@ -471,7 +473,7 @@ Feature: AsciiDoc Support
     When I go to "/manual/index.html"
     Then I should see:
       """
-      <p>Unresolved directive in &lt;stdin&gt; - include::_chapters/ch01.adoc[]</p>
+      <p>Unresolved directive in index.adoc - include::_chapters/ch01.adoc[]</p>
       """
 
   Scenario: Including a file relative to document in subdirectory when base_dir is set to app.source_dir
@@ -484,7 +486,7 @@ Feature: AsciiDoc Support
     When I go to "/manual/index.html"
     Then I should see:
       """
-      <p>Unresolved directive in &lt;stdin&gt; - include::_chapters/ch01.adoc[]</p>
+      <p>Unresolved directive in index.adoc - include::_chapters/ch01.adoc[]</p>
       """
 
   Scenario: Linking to a sibling page with directory indexes activated
@@ -621,6 +623,13 @@ Feature: AsciiDoc Support
     When I go to "/custom-attribute.html"
     Then I should see "bar{baz}"
 
+  Scenario: Warn when options are set using `set :asciidoc`
+    Given a fixture app "asciidoc-pages-app"
+    And app "asciidoc-pages-app" is using config "set-asciidoc"
+    And I run `middleman build`
+    And was successfully built
+    Then the output should contain "Using `set :asciidoc` to set options for AsciiDoc is no longer supported."
+
   Scenario: Highlighting source code
     Given a fixture app "asciidoc-pages-app"
     And a file named "config.rb" with:

data/fixtures/asciidoc-pages-app/config-set-asciidoc.rb

@@ -0,0 +1,2 @@
+set :asciidoc, attributes: %w(sectanchors)
+activate :asciidoc

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

@@ -1,10 +1,12 @@
 ---
 layout: false
 ---
-<% page_data = ((sitemap.find_resource_by_page_id 'standard-page-data') || (sitemap.find_resource_by_page_id 'standard-page-data.html')).data %>
+<% page_data = (sitemap.find_resource_by_page_id 'std-page-data').data %>
 <p><%= page_data.title %></p>
-<p><%= page_data.author %></p>
+<p><%= page_data.author.name %></p>
+<p><%= page_data.author.email %></p>
 <p><%= (page_data.authors || []) * ' | ' %></p>
-<p><%= page_data.email %></p>
+<p><%= page_data.authors[1].url %></p>
+<p><%= page_data.authors[1].username %></p>
 <p><%= page_data.description %></p>
 <p><%= page_data.keywords %></p>

data/fixtures/asciidoc-pages-app/source/standard-page-data.adoc

@@ -1,5 +1,6 @@
 = Page Title
-Doc Writer <doc.writer@example.com>; Junior Writer
+Doc Writer <doc.writer@example.com>; Junior Writer <https://social.example.com/jrw[@jrw]>
+:page-id: std-page-data
 :showtitle:
 :description: This is a sample page.
 :keywords: meta, AsciiDoc, Middleman

data/lib/middleman-asciidoc/extension.rb

@@ -1,5 +1,4 @@
 require 'asciidoctor' unless defined? Asciidoctor
-require 'active_support/core_ext/time/zones' unless Time.respond_to? :zone
 
 module Middleman
   module AsciiDoc
@@ -19,40 +18,24 @@ module Middleman
 
       AttributeReferenceRx = /\\?\{(\w+(?:[\-]\w+)*)\}/
 
-      option :attributes, [], 'Custom AsciiDoc attributes passed to all AsciiDoc-based pages. Defaults to empty Array. (Hash or Array)'
+      option :attributes, [], '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, which is replaced with the document directory. (String)'
+      option :base_dir, :docdir, 'Base directory to use for the current AsciiDoc document. Defaults to :docdir, which resolves to 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
-        app.config.define_setting :asciidoc_attributes, [], 'Custom AsciiDoc attributes (Hash or Array)'
+        super unless app.mode? :config
       end
 
       # 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
-        # set :time_zone
-        if app.config[:time_zone]
-          ::Time.zone = app.config[:time_zone]
-        else
-          ::Time.zone ||= 'UTC'
-        end
-        zone_default = ::Time.find_zone! ::Time.zone
-        raise 'Value assigned to time_zone not recognized.' unless zone_default
-        ::Time.zone_default = zone_default
-
-        if (app.config.setting :asciidoc).value_set?
-          warn 'Using `set :asciidoc` to define options is deprecated. Please define options on `activate :asciidoc` instead.'
+        set_time_zone app.config[:time_zone]
+        if (app.config.defines_setting? :asciidoc)
+          warn 'Using `set :asciidoc` to set options for AsciiDoc is no longer supported. Please use `activate :asciidoc`.'
         end
-        app.config[:asciidoc].tap do |cfg|
+        (app.config[:asciidoc] = {}).tap do |cfg|
           attributes = {
             'site-root' => app.root.to_s,
             'site-source' => app.source_dir.to_s,
@@ -67,19 +50,11 @@ module Middleman
             end
             attributes['relfileprefix'] = '../'
           end
-          # NOTE handles deprecated `set :asciidoc, attributes: ...`
-          attributes = merge_attributes cfg[:attributes], attributes if cfg.key? :attributes
-          # NOTE handles `activate :asciidoc, attributes: ...`
-          if (options.setting :attributes).value_set?
-            attributes = merge_attributes options[:attributes], attributes
-          # NOTE handles `set :asciidoc_attributes ...`
-          elsif (app.config.setting :asciidoc_attributes).value_set?
-            attributes = merge_attributes options[:asciidoc_attributes], attributes
-          end
-          imagesdir = if attributes.key? 'imagesdir'
-            attributes['imagesdir']
+          attributes = merge_attributes options[:attributes], attributes if (options.setting :attributes).value_set?
+          if attributes.key? 'imagesdir'
+            imagesdir = attributes['imagesdir']
           else
-            attributes['imagesdir'] = %(#{::File.join ((app.config[:http_prefix] || '').chomp '/'), app.config[:images_dir]}@)
+            imagesdir = attributes['imagesdir'] = %(#{[((app.config[:http_prefix] || '').chomp '/'), app.config[:images_dir]] * '/'}@)
           end
           if imagesdir && !(attributes.key? 'imagesoutdir') && (imagesdir.start_with? '/')
             attributes['imagesoutdir'] = ::File.join dest, (imagesdir.chomp '@')
@@ -106,23 +81,28 @@ module Middleman
 
       def manipulate_resource_list resources
         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' => '')
+        header_attrs = header_asciidoc_opts[:attributes].merge 'skip-front-matter' => ''
         use_docdir_as_base_dir = header_asciidoc_opts[:base_dir] == :docdir
 
         resources.select {|res| !res.ignored? && (asciidoc_file? res) }.each do |resource|
-          path = resource.source_file
+          page_attrs = { 'page-id' => %(#{resource.page_id}@) }
+          if (path = resource.source_file)
+            page_attrs['docfile'] = path
+            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] ||= {})['page-id'] = resource.page_id
+            (page_asciidoc_opts[:attributes] ||= {}).update page_attrs
           else
-            page_asciidoc_opts = { attributes: { 'page-id' => resource.page_id } }
+            page_asciidoc_opts = { attributes: page_attrs }
           end
           opts, page = { renderer_options: page_asciidoc_opts }, {}
 
-          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]}@)
+          page_header_attrs = { 'page-layout' => %(#{resource.options[:layout]}@) }.merge page_attrs
+          header_asciidoc_opts[:base_dir] = page_asciidoc_opts[:base_dir] = dir if use_docdir_as_base_dir && dir
           # 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, header_asciidoc_opts
+          doc = ::Asciidoctor.load_file path, (header_asciidoc_opts.merge attributes: (header_attrs.merge page_header_attrs))
 
           if (doc.attr? 'page-ignored') && !(doc.attr? 'page-ignored', 'false')
             resource.ignore!
@@ -153,14 +133,18 @@ module Middleman
 
           page[:title] = doc.doctitle if doc.header?
           if doc.attr? 'author'
-            page[:author] = (author = doc.attr 'author')
+            page[:author] = (author = AuthorData.new (doc.attr 'author'), (doc.attr 'email'))
             if (num_authors = (doc.attr 'authorcount').to_i) > 1
-              page[:authors] = num_authors.times.map {|idx| doc.attr %(author_#{idx + 1}) }.compact
+              page[:authors] = num_authors.times.map {|i|
+                if doc.attr? %(author_#{idx = i + 1})
+                  AuthorData.new (doc.attr %(author_#{idx})), (doc.attr %(email_#{idx}))
+                end
+              }.compact
             else
               page[:authors] = [author]
             end
           end
-          ['email', 'keywords', 'description'].each do |key|
+          ['keywords', 'description'].each do |key|
             page[key.to_sym] = doc.attr key if doc.attr? key
           end
           if !(page.key? :date) && (doc.attr? 'revdate')
@@ -274,6 +258,23 @@ module Middleman
           ::Tilt.mappings.select {|_, classes| classes.include? ::Tilt::AsciidoctorTemplate }.keys.map {|ext| %(.#{ext}) }
         end
       end
+
+      # Set Time.zone and Time.zone_default to match behavior of blog extension.
+      #
+      # Make sure ActiveSupport's TimeZone stuff has something to work with,
+      # allowing site owners to set their desired time zone via Time.zone or
+      # `set :time_zone`
+      def set_time_zone tz
+        require 'active_support/core_ext/time/zones' unless ::Time.respond_to? :zone
+        if tz
+          ::Time.zone = tz
+        else
+          ::Time.zone ||= 'UTC'
+        end
+        zone_default = ::Time.find_zone! ::Time.zone
+        raise 'Value assigned to time_zone not recognized.' unless zone_default
+        ::Time.zone_default = zone_default
+      end
     end
 
     # Resolves the automatic layout if no layout has been specified and this resource is not a blog article
@@ -308,5 +309,27 @@ module Middleman
         resource.respond_to? :blog_data
       end
     end
+
+    class AuthorData
+      UrlWithUsernameRx = /^(.+?)\[@([^\]]+)\]$/
+      attr :name, :email, :url, :username
+
+      def initialize name, email_or_url = nil
+        @name = name
+        if email_or_url
+          if email_or_url.start_with? 'https://', 'http://'
+            if (email_or_url.include? '[') && UrlWithUsernameRx =~ email_or_url
+              @url, @username = $1, $2
+            else
+              @url = email_or_url
+            end
+          else
+            @email = email_or_url
+          end
+        end
+      end
+
+      alias to_s name
+    end
   end
 end

data/lib/middleman-asciidoc/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: middleman-asciidoc
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc.5
+  version: 1.0.0.rc.6
 platform: ruby
 authors:
 - Dan Allen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-04 00:00:00.000000000 Z
+date: 2017-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: middleman-core
@@ -75,6 +75,7 @@ files:
 - fixtures/asciidoc-blog-app/source/layouts/asciidoc_page.erb
 - fixtures/asciidoc-pages-app/config-global-layout.rb
 - fixtures/asciidoc-pages-app/config-page-layout.rb
+- fixtures/asciidoc-pages-app/config-set-asciidoc.rb
 - fixtures/asciidoc-pages-app/config.rb
 - fixtures/asciidoc-pages-app/source/_include.adoc
 - fixtures/asciidoc-pages-app/source/backend.adoc
@@ -157,6 +158,7 @@ test_files:
 - fixtures/asciidoc-blog-app/source/layouts/asciidoc_page.erb
 - fixtures/asciidoc-pages-app/config-global-layout.rb
 - fixtures/asciidoc-pages-app/config-page-layout.rb
+- fixtures/asciidoc-pages-app/config-set-asciidoc.rb
 - fixtures/asciidoc-pages-app/config.rb
 - fixtures/asciidoc-pages-app/source/_include.adoc
 - fixtures/asciidoc-pages-app/source/backend.adoc