class Middleman::AsciiDoc::AsciiDocExtension
Constants
- AttributeReferenceRx
- IMPLICIT_ATTRIBUTES
Public Class Methods
# File lib/middleman-asciidoc/extension.rb, line 31 def initialize app, options_hash = {}, &block super unless app.mode? :config end
Public Instance Methods
# File lib/middleman-asciidoc/extension.rb, line 35 def after_configuration app.config[:asciidoc_extensions] = prune_tilt_mapping! set_time_zone app.config[:time_zone] if (app.config.defines_setting? :asciidoc) # :nocov: warn 'Using `set :asciidoc` to set options for AsciiDoc is no longer supported. Please use `activate :asciidoc`.' # :nocov: end (app.config[:asciidoc] = {}).tap do |cfg| 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] attributes['relfilesuffix'] = app.config[:strip_index_file] ? (app.config[:trailing_slash] ? '/' : '') : %(/#{app.config[:index_file]}) attributes['relfileprefix'] = '../' end attributes['imagesdir'] = %(#{[((app.config[:http_prefix] || '').chomp '/'), app.config[:images_dir]] * '/'}@) unless (user_attributes = options[:attributes] || {}).empty? attributes = merge_attributes user_attributes, attributes end require 'middleman-asciidoc/diagram_ext' if defined? ::Asciidoctor::Diagram::VERSION if !(attributes.key? 'imagesoutdir') && (imagesdir = attributes['imagesdir']) && (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[: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] = (cfg[:safe] || :safe).to_sym if (template_dirs_opt = options.setting :template_dirs).value_set? cfg[:template_dirs] = (Array template_dirs_opt.value).map {|dir| (app.root_path.join dir).to_s } cfg[:template_engine] = options[:template_engine].to_s if (options.setting :template_engine).value_set? cfg[:template_engine_options] = options[:template_engine_options] if (options.setting :template_engine_options).value_set? end 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 app, default_layout.to_sym), 60 end end end
# File lib/middleman-asciidoc/extension.rb, line 195 def asciidoc_file? resource (path = resource.source_file) && (path.end_with? *app.config[:asciidoc_extensions]) 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.
# File lib/middleman-asciidoc/extension.rb, line 246 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).to_sym end end
# File lib/middleman-asciidoc/extension.rb, line 87 def manipulate_resource_list resources if (app_time = app.config[:time]) app_date_time_strs = (app_time.in_time_zone.strftime '%F %T %Z').split ' ', 2 end header_asciidoc_opts = app.config[:asciidoc].merge parse_header_only: true 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| page_attrs = { 'page-id' => %(#{resource.page_id}@) } page_attrs['localdate'], page_attrs['localtime'] = app_date_time_strs if app_date_time_strs 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 # 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 }, {} 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.merge attributes: (header_attrs.merge page_header_attrs)) if (doc.attr? 'page-ignored') && !(doc.attr? 'page-ignored', 'false') resource.ignore! next end # 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').to_sym if doc.attr? 'page-layout-engine' else case (layout = layout.to_sym) when :~, :null opts[:layout] = false when :false opts[:layout] = false page_asciidoc_opts[:header_footer] = true else opts[:layout] = layout opts[:layout_engine] = (doc.attr 'page-layout-engine').to_sym if doc.attr? 'page-layout-engine' end end else opts[:layout] = false page_asciidoc_opts[:header_footer] = true end page[:title] = doc.doctitle if doc.header? if 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 {|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 ['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] = ::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.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 unless resource.ext == doc.outfilesuffix # NOTE we must use << or else the layout gets disabled resource.destination_path << doc.outfilesuffix end # NOTE only options[:renderer_options] overrides keys defined in global options resource.add_metadata options: opts, page: page end resources end
# File lib/middleman-asciidoc/extension.rb, line 199 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) + ['', '']).slice 0, 2) : entry if key.start_with? '!' new_attrs[key.slice 1, key.length] = nil elsif key.end_with? '!' new_attrs[key.chop] = nil # "-" prefix means to remove key from accumulator elsif key.start_with? '-' new_attrs.delete (key.slice 1, key.length) elsif is_array new_attrs[key] = resolve_attribute_refs val, new_attrs else new_attrs[key] = case val when ::String resolve_attribute_refs val, new_attrs when ::Numeric val.to_s when true '' when nil, false nil else val end end } else raise 'Value of attributes setting on AsciiDoc extension must be a Hash or an Array.' 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.
# File lib/middleman-asciidoc/extension.rb, line 262 def parse_yaml_value val if val.empty? val else begin ::YAML.load %(--- #{val}) rescue ::StandardError, ::SyntaxError val = val.gsub '\'', '\'\'' if val.include? '\'' ::YAML.load %(--- \'#{val}\') 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.
# File lib/middleman-asciidoc/extension.rb, line 281 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 # :nocov: ::Tilt.mappings.select {|_, classes| classes.include? ::Tilt::AsciidoctorTemplate }.keys.map {|ext| %(.#{ext}) } # :nocov: end end
# File lib/middleman-asciidoc/extension.rb, line 232 def resolve_attribute_refs text, attrs if text.empty? text elsif text.include? '{' text.gsub(AttributeReferenceRx) { ($&.start_with? '\\') ? ($&.slice 1, $&.length) : ((attrs.fetch $1, $&).to_s.chomp '@') } else text 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`
# File lib/middleman-asciidoc/extension.rb, line 302 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