middleman-asciidoc 1.0.0.rc.2 → 1.0.0.rc.3

data/lib/middleman-asciidoc/extension.rb

@@ -1,4 +1,5 @@
 require 'asciidoctor' unless defined? Asciidoctor
+require 'active_support/core_ext/time/zones' unless Time.respond_to? :zone
 
 module Middleman
   module AsciiDoc
@@ -16,10 +17,13 @@ module Middleman
         'middleman-version' => ::Middleman::VERSION
       }
 
-      option :attributes, [], 'Custom AsciiDoc attributes (Hash or Array)'
-      option :backend, :html5, 'Moniker used to select output format (Symbol)'
-      option :base_dir, nil, 'Base directory to use for the current AsciiDoc document; if nil, defaults to docdir (String)'
-      option :safe, :safe, 'Safe mode level (Symbol)'
+      AttributeReferenceRx = /\\?\{(\w+(?:[\-]\w+)*)\}/
+
+      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 :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
         super
@@ -30,100 +34,231 @@ module Middleman
 
       # NOTE options passed to activate take precedence (e.g., activate :asciidoc, attributes: ['foo=bar'])
       def after_configuration
-        if app.config.setting(:asciidoc).value_set?
+        # 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.'
         end
         app.config[:asciidoc].tap do |cfg|
-          attributes = {}
-          if cfg.key? :attributes
-            attributes.update(attrs_as_hash cfg[:attributes])
-            attributes['!imagesdir'] = attributes.delete 'imagesdir!' if attributes.key? 'imagesdir!'
+          attributes = {
+            'site-root' => app.root.to_s,
+            'site-source' => app.source_dir.to_s,
+            'site-destination' => (dest = (app.root_path.join app.config[:build_dir]).to_s),
+            'site-environment' => app.environment.to_s
+          }.merge IMPLICIT_ATTRIBUTES
+          if !!app.extensions[:directory_indexes]
+            if app.config[:strip_index_file]
+              attributes['relfilesuffix'] = app.config[:trailing_slash] ? '/' : ''
+            else
+              attributes['relfilesuffix'] = %(/#{app.config[:index_file]})
+            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
-          if options.setting(:attributes).value_set?
-            attributes.update(attrs_as_hash options[:attributes])
-          elsif app.config.setting(:asciidoc_attributes).value_set?
-            attributes.update(attrs_as_hash app.config[:asciidoc_attributes])
+          imagesdir = if attributes.key? 'imagesdir'
+            attributes['imagesdir']
+          else
+            attributes['imagesdir'] = %(#{::File.join ((app.config[:http_prefix] || '').chomp '/'), app.config[:images_dir]}@)
           end
-          unless (attributes.key? 'imagesdir') || (attributes.key? '!imagesdir')
-            attributes['imagesdir'] = %(#{File.join((app.config[:http_prefix] || '/').chomp('/'), app.config[:images_dir])}@)
+          if imagesdir && !(attributes.key? 'imagesoutdir') && (imagesdir.start_with? '/')
+            attributes['imagesoutdir'] = ::File.join dest, (imagesdir.chomp '@')
+          end
+          cfg[:attributes] = attributes
+          case (base_dir = options[:base_dir])
+          when :source
+            cfg[:base_dir] = ::File.expand_path app.source_dir
+          when :docdir
+            cfg[:base_dir] = :docdir
+          else
+            cfg[:base_dir] = ::File.expand_path base_dir if base_dir
           end
-          cfg[:attributes] = attributes.update IMPLICIT_ATTRIBUTES
-          cfg[:base_dir] = (dir = options[:base_dir]) ? dir.to_s : dir if options.setting(:base_dir).value_set?
-          # QUESTION ^ should we call expand_path on :base_dir if non-nil?
-          cfg[:backend] = options[:backend] if options.setting(:backend).value_set?
+          cfg[:backend] = options[:backend] if (options.setting :backend).value_set?
           cfg[:backend] = (cfg[:backend] || :html5).to_sym
-          cfg[:safe] = options[:safe] if options.setting(:safe).value_set?
+          cfg[:safe] = options[:safe] if (options.setting :safe).value_set?
           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
+          end
         end
       end
 
       def manipulate_resource_list resources
-        default_page_layout = app.config[:layout] == :_auto_layout ? '' : app.config[:layout]
         asciidoc_opts = app.config[:asciidoc].merge parse_header_only: true
         asciidoc_opts[:attributes] = (asciidoc_attrs = asciidoc_opts[:attributes].merge 'skip-front-matter' => '')
-        use_docdir_as_base_dir = asciidoc_opts[:base_dir].nil?
+        app.config[:asciidoc].delete :base_dir if (use_docdir_as_base_dir = asciidoc_opts[:base_dir] == :docdir)
         resources.each do |resource|
-          next unless (path = resource.source_file).present? && (path.end_with? '.adoc')
+          next if resource.ignored? || (path = resource.source_file).blank? || !(path.end_with? '.adoc')
+
+          opts, page = {}, {}
 
+          asciidoc_attrs['page-layout'] = %(#{resource.options[:layout]}@)
+          opts[:base_dir] = asciidoc_opts[:base_dir] = ::File.dirname path if use_docdir_as_base_dir
           # read AsciiDoc header only to set page options and data
           # header values can be accessed via app.data.page.<name> in the layout
-          asciidoc_attrs['page-layout'] = %(#{resource.options[:layout] || default_page_layout}@)
-          asciidoc_opts[:base_dir] = ::File.dirname path if use_docdir_as_base_dir
-          doc = Asciidoctor.load_file path, asciidoc_opts
-          opts = {}
-          page = {}
+          doc = ::Asciidoctor.load_file path, asciidoc_opts
 
-          opts[:base_dir] = asciidoc_opts[:base_dir] if use_docdir_as_base_dir
+          if (doc.attr? 'page-ignored') && !(doc.attr? 'page-ignored', 'false')
+            resource.ignore!
+            next
+          end
 
-          # NOTE page layout value cascades from site config -> front matter -> page-layout header attribute
+          # NOTE page layout value cascades from site config -> extension config -> front matter -> page-layout attribute
           if doc.attr? 'page-layout'
             if (layout = doc.attr 'page-layout').empty?
               opts[:layout] = :_auto_layout
+              opts[:layout_engine] = doc.attr 'page-layout-engine' if doc.attr? 'page-layout-engine'
             else
-              opts[:layout] = layout
+              case (layout = layout.to_sym)
+              when :-
+                opts[:layout] = false
+              when :false
+                opts[:layout] = false
+                opts[:header_footer] = true
+              else
+                opts[:layout] = layout
+                opts[:layout_engine] = doc.attr 'page-layout-engine' if doc.attr? 'page-layout-engine'
+              end
             end
-            opts[:layout_engine] = doc.attr 'page-layout-engine' if doc.attr? 'page-layout-engine'
           else
             opts[:layout] = false
             opts[:header_footer] = true
           end
 
           page[:title] = doc.doctitle if doc.header?
-          ['author', 'email'].each do |key|
+          if doc.attr? 'author'
+            page[:author] = (author = doc.attr 'author')
+            if (num_authors = (doc.attr 'authorcount').to_i) > 1
+              page[:authors] = num_authors.times.map {|idx| doc.attr %(author_#{idx + 1}) }.compact
+            else
+              page[:authors] = [author]
+            end
+          end
+          ['email', 'keywords', 'description'].each do |key|
             page[key.to_sym] = doc.attr key if doc.attr? key
           end
           if !(page.key? :date) && (doc.attr? 'revdate')
             begin
-              page[:date] = ::DateTime.parse(doc.attr 'revdate').to_time
+              page[:date] = ::Time.zone.parse (doc.attr 'revdate')
+              # ...or hack to use app time zone, but only if time zone is not specified
+              #page[:date] = ::DateTime.parse(%(#{doc.attr 'revdate'} #{::Time.zone.formatted_offset})).to_time
             rescue
             end
           end
 
-          unless (adoc_front_matter = doc.attributes
-              .select {|name| name != 'page-layout' && name != 'page-layout-engine' && name.start_with?('page-') }
-              .map {|name, val| %(:#{name[5..-1]}: #{val}) }).empty?
-            page.update(::YAML.load(adoc_front_matter * "\n"))
+          unless (adoc_front_matter = doc.attributes.each_with_object({}) {|(key, val), accum|
+                if (page_variable_name = derive_page_variable_name key)
+                  accum[page_variable_name] = ::String === val ? (parse_yaml_value val) : val
+                end
+              }).empty?
+            page.update adoc_front_matter
           end
 
-          # QUESTION should we use resource.ext == doc.outfilesuffix instead?
-          unless resource.destination_path.end_with? doc.outfilesuffix
+          unless resource.ext == doc.outfilesuffix
             # NOTE we must use << or else the layout gets disabled
             resource.destination_path << doc.outfilesuffix
           end
 
+          # NOTE opts won't override any keys defined in global options
           resource.add_metadata options: opts, page: page
         end
       end
 
-      def attrs_as_hash attrs
-        if Hash === attrs
-          attrs
+      def merge_attributes attrs, initial = {}
+        if (is_array = ::Array === attrs) || ::Hash === attrs
+          attrs.each_with_object(initial) {|entry, new_attrs|
+            key, val = is_array ? ((entry.split '=', 2) + ['', ''])[0..1] : entry
+            if key.start_with? '!'
+              new_attrs[key[1..-1]] = nil
+            elsif key.end_with? '!'
+              new_attrs[key.chop] = nil
+            else
+              new_attrs[key] = val ? (resolve_attribute_refs val, new_attrs) : nil
+            end
+          }
         else
-          Array(attrs).inject({}) do |accum, entry|
-            k, v = entry.split '=', 2
-            k = %(!#{k.chop}) if k.end_with? '!'
-            accum[k] = v || ''
-            accum
+          initial
+        end
+      end
+
+      def resolve_attribute_refs text, attrs
+        if text.empty?
+          text
+        elsif text.include? '{'
+          text.gsub(AttributeReferenceRx) { ($&.start_with? '\\') ? $&[1..-1] : ((attrs.fetch $1, $&).to_s.chomp '@') }
+        else
+          text
+        end
+      end
+
+      # Derive the page variable name from the specified attribute name.
+      #
+      # Returns the page variable name as a [String] or nothing if the attribute name is not the name of a page
+      # attribute.
+      def derive_page_variable_name attribute_name
+        if attribute_name != 'page-layout' && attribute_name != 'page-layout-engine' && attribute_name != 'page-ignored' &&
+            (attribute_name.start_with? 'page-')
+          attribute_name.slice 5, attribute_name.length
+        end
+      end
+
+      # Parse the specified value as a single-line YAML value.
+      #
+      # Attempt to parse the specified String value as though it's a single-line YAML value (i.e., the value part of a
+      # YAML key/value pair). If the value fails to parse, wrap the value in single quotes (after escaping any single
+      # quotes in the value) and parse it as a character sequence. If the value is empty, return an empty String.
+      #
+      # val - The String value to parse.
+      #
+      # 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?
+          ''
+        else
+          begin
+            ::YAML.load %(--- #{val})
+          rescue ::StandardError, ::SyntaxError
+            val = val.gsub '\'', '\'\'' if val.include? '\''
+            ::YAML.load %(--- \'#{val}\')
+          end
+        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
+        @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]) &&
+              (blog_layout = blog_layout.to_sym) != :_auto_layout
+            resource.options[:layout] = blog_layout
+          else
+            resource.options[:layout] = @layout
           end
         end
       end

data/lib/middleman-asciidoc/version.rb

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

data/middleman-asciidoc.gemspec

@@ -6,15 +6,23 @@ Gem::Specification.new do |s|
   s.name = 'middleman-asciidoc'
   s.version = Middleman::AsciiDoc::VERSION
   s.summary = 'AsciiDoc support for Middleman'
-  s.description = 'AsciiDoc conversion and metadata support for Middleman'
+  s.description = 'Converts AsciiDoc files in the source directory to HTML pages. Allows page data to be specified using AsciiDoc attributes defined in the document header (as an alternative to YAML front matter).'
 
   s.authors = ['Dan Allen']
   s.email = ['dan.j.allen@gmail.com']
   s.homepage = 'https://github.com/middleman/middleman-asciidoc'
   s.license = 'MIT'
+  s.required_ruby_version = '>= 2.0.0'
+
+  files = begin
+    output = IO.popen('git ls-files -z', err: File::NULL) {|io| io.read }.split %(\0)
+    $?.success? ? output : Dir['**/*']
+  rescue
+    Dir['**/*']
+  end
+  s.files = files.grep %r/^(?:lib\/.+|Gemfile|Rakefile|(?:CHANGELOG|CONTRIBUTING|LICENSE|README)\.adoc|#{s.name}\.gemspec)$/
+  s.test_files = files.grep %r/^(?:features|fixtures)\/.+/
 
-  s.files = `git ls-files -z`.split "\0"
-  s.test_files = `git ls-files -z -- {fixtures,features}/*`.split "\0"
   s.require_paths = ['lib']
 
   s.add_runtime_dependency 'middleman-core', '~> 4.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: middleman-asciidoc
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc.2
+  version: 1.0.0.rc.3
 platform: ruby
 authors:
 - Dan Allen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-23 00:00:00.000000000 Z
+date: 2017-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: middleman-core
@@ -38,17 +38,15 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.5.0
-description: AsciiDoc conversion and metadata support for Middleman
+description: Converts AsciiDoc files in the source directory to HTML pages. Allows
+  page data to be specified using AsciiDoc attributes defined in the document header
+  (as an alternative to YAML front matter).
 email:
 - dan.j.allen@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".bundle/config"
-- ".gitignore"
-- ".ruby-version"
-- ".travis.yml"
 - CHANGELOG.adoc
 - CONTRIBUTING.adoc
 - Gemfile
@@ -63,18 +61,25 @@ files:
 - fixtures/asciidoc-app/source/custom-attribute.adoc
 - fixtures/asciidoc-app/source/custom-imagesdir.adoc
 - fixtures/asciidoc-app/source/gallery.adoc
-- fixtures/asciidoc-app/source/hello-no-layout.adoc
 - fixtures/asciidoc-app/source/hello-with-extension.html.adoc
 - fixtures/asciidoc-app/source/hello-with-front-matter.adoc
-- fixtures/asciidoc-app/source/hello-with-layout.adoc
 - fixtures/asciidoc-app/source/hello-with-mixed-page-data.adoc
 - fixtures/asciidoc-app/source/hello-with-title.adoc
 - fixtures/asciidoc-app/source/hello.adoc
+- fixtures/asciidoc-app/source/ignored.adoc
 - fixtures/asciidoc-app/source/images/tiger.gif
+- fixtures/asciidoc-app/source/inspect-standard-page-data.html.erb
 - fixtures/asciidoc-app/source/layouts/default.erb
+- fixtures/asciidoc-app/source/layouts/showdate.erb
+- fixtures/asciidoc-app/source/link-to-page.adoc
 - fixtures/asciidoc-app/source/manual/_chapters/ch01.adoc
 - fixtures/asciidoc-app/source/manual/index.adoc
 - fixtures/asciidoc-app/source/master.adoc
+- fixtures/asciidoc-app/source/page-with-date-at-zone.adoc
+- fixtures/asciidoc-app/source/page-with-date.adoc
+- fixtures/asciidoc-app/source/safe-mode.adoc
+- fixtures/asciidoc-app/source/site-information.adoc
+- fixtures/asciidoc-app/source/standard-page-data.adoc
 - lib/middleman-asciidoc.rb
 - lib/middleman-asciidoc/extension.rb
 - lib/middleman-asciidoc/middleman_extension.rb
@@ -92,7 +97,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">"
@@ -100,7 +105,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.7.2
 signing_key: 
 specification_version: 4
 summary: AsciiDoc support for Middleman
@@ -113,16 +118,22 @@ test_files:
 - fixtures/asciidoc-app/source/custom-attribute.adoc
 - fixtures/asciidoc-app/source/custom-imagesdir.adoc
 - fixtures/asciidoc-app/source/gallery.adoc
-- fixtures/asciidoc-app/source/hello-no-layout.adoc
 - fixtures/asciidoc-app/source/hello-with-extension.html.adoc
 - fixtures/asciidoc-app/source/hello-with-front-matter.adoc
-- fixtures/asciidoc-app/source/hello-with-layout.adoc
 - fixtures/asciidoc-app/source/hello-with-mixed-page-data.adoc
 - fixtures/asciidoc-app/source/hello-with-title.adoc
 - fixtures/asciidoc-app/source/hello.adoc
+- fixtures/asciidoc-app/source/ignored.adoc
 - fixtures/asciidoc-app/source/images/tiger.gif
+- fixtures/asciidoc-app/source/inspect-standard-page-data.html.erb
 - fixtures/asciidoc-app/source/layouts/default.erb
+- fixtures/asciidoc-app/source/layouts/showdate.erb
+- fixtures/asciidoc-app/source/link-to-page.adoc
 - fixtures/asciidoc-app/source/manual/_chapters/ch01.adoc
 - fixtures/asciidoc-app/source/manual/index.adoc
 - fixtures/asciidoc-app/source/master.adoc
-has_rdoc: 
+- fixtures/asciidoc-app/source/page-with-date-at-zone.adoc
+- fixtures/asciidoc-app/source/page-with-date.adoc
+- fixtures/asciidoc-app/source/safe-mode.adoc
+- fixtures/asciidoc-app/source/site-information.adoc
+- fixtures/asciidoc-app/source/standard-page-data.adoc

data/.bundle/config

@@ -1,4 +0,0 @@
----
-BUNDLE_PATH: rubygems
-BUNDLE_DISABLE_SHARED_GEMS: '1'
-BUNDLE_BUILD__NOKOGIRI: '--use-system-libraries'

data/.gitignore

@@ -1,5 +0,0 @@
-/.ruby-gemset
-/Gemfile.lock
-/pkg/
-/rubygems/
-/tmp/

data/.ruby-version

@@ -1 +0,0 @@
-2.3.0

data/.travis.yml

@@ -1,13 +0,0 @@
-sudo: false
-git:
-  depth: 1
-language: ruby
-rvm:
-  - 2.3.0
-  - 2.2.4
-  - 2.1.8
-  - 2.0.0
-  #- jruby-9.0.4.0
-script: bundle exec rake cucumber
-env:
-  - NOKOGIRI_USE_SYSTEM_LIBRARIES=1 TEST=true

data/fixtures/asciidoc-app/source/hello-no-layout.adoc

@@ -1,2 +0,0 @@
-:page-layout!:
-Hello, AsciiDoc!

data/fixtures/asciidoc-app/source/hello-with-layout.adoc

@@ -1,2 +0,0 @@
-:page-layout: default
-Hello, AsciiDoc!