asciidoctor-interdoc-reftext 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c198842d29c3f2d5ec0a2e10465885cd5172d698224f2cc05c2e0d72beda2d73
-  data.tar.gz: 2241e3587eaf4097ccc9d3a8305f8ce957d88d0d052cc7522401795b1d8d933c
+  metadata.gz: cd232240b5668fc37f4552d6ee419f46028815c0aec5015fd7f70dd4a110c3cc
+  data.tar.gz: f68b54e05dd2cd7d32fc3f3f0c48b852ab50e3d4ec7cda4bcf54c1891ef0d8f1
 SHA512:
-  metadata.gz: 662b5938301f727bba05fd130ad25cd5c101b3cfe43fbc75299f7f5f6fc9e0a5400f9d28997e005885ed04883ab0f68abe522623469c6d102f252998a186a614
-  data.tar.gz: 1cd4739d61b4d8279b4e24775b702f34425c4f09be3610f3f81885dc7415b3017c105c10be1bea99e1fd0d38ebafb2b28fec2c6d8de78ffca065f1279a94dff4
+  metadata.gz: a7ddcf13d9d125c3071507ebaca379af4bfc41933df4f4920c6be70f8e12053e804cd586146da565389d9f29cc8fb7e6f174db2d4db129105a66cbc02447e1d2
+  data.tar.gz: 19432fd2fac94e39a36d4c20ac45870d45733b904f3485f4dc37413b8fa47664e6b92bae2603a6a583867ff0fa9385871e289ef139c804b679585445477e51e1

data/README.adoc

@@ -11,6 +11,7 @@ image:https://travis-ci.org/{gh-name}.svg?branch={gh-branch}[Build Status, link=
 image:https://api.codacy.com/project/badge/Coverage/{codacy-id}["Test Coverage", link="https://www.codacy.com/app/{gh-name}"]
 image:https://api.codacy.com/project/badge/Grade/{codacy-id}["Codacy Code quality", link="https://www.codacy.com/app/{gh-name}"]
 image:https://img.shields.io/gem/v/{gem-name}.svg?style=flat[Gem Version, link="https://rubygems.org/gems/{gem-name}"]
+image:https://img.shields.io/npm/v/{gem-name}.svg?style=flat[npm Version, link="https://www.npmjs.org/package/{gem-name}"]
 image:https://img.shields.io/badge/yard-docs-blue.svg[Yard Docs, link="http://www.rubydoc.info/github/{gh-name}/{gh-branch}"]
 endif::env-github[]
 
@@ -61,7 +62,9 @@ where “The First Section” is *title* of the section with id _sec1_ in _other
 
 == Installation
 
-To install (or update to the latest version):
+=== Ruby
+
+Install {gem-name} from Rubygems:
 
 [source, subs="+attributes"]
 gem install {gem-name}
@@ -72,21 +75,47 @@ or to install the latest development version:
 gem install {gem-name} --pre
 
 
+=== Node.js
+
+Install {gem-name} from npmjs.com:
+
+[source, sh, subs="+attributes"]
+npm install --save {gem-name}
+
+
 == Usage
 
-Just `require '{gem-name}'`.
+=== CLI
+
 If you invoke Asciidoctor from command-line, use option `-r` to load the extension:
 
 [source, subs="+attributes"]
 asciidoctor -r {gem-name} README.adoc
 
-If you don’t want the extension to be automatically registered in Asciidoctor, don’t _require_ `{gem-name}`, but `asciidoctor/interdoc_reftext/processor`.
+
+=== Ruby
+
+Just `require '{gem-name}'`.
+However, if you don’t want the extension to be automatically registered in Asciidoctor, `require 'asciidoctor/interdoc_reftext/processor'` instead.
 
 IMPORTANT: Bundler automatically _requires_ all the specified gems.
            To prevent it, use +
            `gem '{gem-name}', require: false`.
 
 
+=== Node.js
+
+[source, js, subs="+attributes"]
+----
+// Load asciidoctor.js and {gem-name}.
+const asciidoctor = require('asciidoctor.js')()
+require('{gem-name}')
+
+// Convert the file to HTML.
+asciidoctor.convertFile("./README.adoc")
+----
+
+
 == License
 
 This project is licensed under http://opensource.org/licenses/MIT/[MIT License].

data/lib/asciidoctor/interdoc_reftext/inline_node_mixin.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
+require 'asciidoctor' unless RUBY_PLATFORM == 'opal'
 require 'asciidoctor/interdoc_reftext/version'
-require 'asciidoctor'
 
 module Asciidoctor::InterdocReftext
   # Mixin intended to be prepended into `Asciidoctor::Inline`.
@@ -10,29 +10,39 @@ module Asciidoctor::InterdocReftext
   # represents an inter-document cross reference).
   module InlineNodeMixin
 
-    # Returns text of this inline element.
-    #
-    # @note This method will override the same name attribute reader in
-    #   class `Asciidoctor::Inline`.
-    #
-    # @return [String, nil]
-    def text
-      if (value = super)
-        value
-      # If this node is an inter-document cross reference...
-      elsif @node_name == 'inline_anchor' && @attributes['path']
-        resolver = interdoc_reftext_resolver
-        @text = resolver.call(@attributes['refid']) if resolver
+    if RUBY_PLATFORM == 'opal'
+      # Opal does not support `Module#prepend`, so we have to fallback to
+      # `include` with poor alias method chain approach.
+      def self.included(base_klass)
+        base_klass.send(:alias_method, :text_without_reftext, :text)
+        base_klass.send(:define_method, :text) do
+          text_without_reftext || interdoc_reftext
+        end
+      end
+    else
+      # Returns text of this inline element.
+      #
+      # @note This method will override the same name attribute reader in
+      #   class `Asciidoctor::Inline`.
+      def text
+        super || interdoc_reftext
       end
     end
 
     private
 
-    # @return [#call, nil] an inter-document reftext resolver, or nil if not
-    #   set for the document.
-    def interdoc_reftext_resolver
+    # Returns resolved reftext of this inline node if it is a valid
+    # inter-document cross-reference, otherwise returns nil.
+    #
+    # @return [String, nil]
+    def interdoc_reftext
+      # If this node is not an inter-document cross reference...
+      return if @node_name != 'inline_anchor' || @attributes['path'].nil?
+
       # This variable is injected into the document by {Processor}.
-      @document.instance_variable_get(Processor::RESOLVER_VAR_NAME)
+      if (resolver = @document.instance_variable_get(Processor::RESOLVER_VAR_NAME))
+        @text = resolver.call(@attributes['refid'])
+      end
     end
   end
 end

data/lib/asciidoctor/interdoc_reftext/processor.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
-require 'asciidoctor'
-require 'asciidoctor/extensions'
+require 'asciidoctor' unless RUBY_PLATFORM == 'opal'
+require 'asciidoctor/extensions' unless RUBY_PLATFORM == 'opal'
 require 'asciidoctor/interdoc_reftext/inline_node_mixin'
 require 'asciidoctor/interdoc_reftext/resolver'
 require 'asciidoctor/interdoc_reftext/version'
@@ -34,7 +34,7 @@ module Asciidoctor::InterdocReftext
   #
   # Eh, this is really nasty... The least evil way how to achieve the goal
   # seems to be monkey-patching of the `Asciidoctor::Inline` class. This is
-  # done via {InlineNodeMixin} which is prepended into the `Inline` class on
+  # done via {InlineNodeMixin} which is prepended* into the `Inline` class on
   # initialization of this processor.
   #
   # The actual logic that resolves reflabel for the given *refid* is
@@ -43,11 +43,16 @@ module Asciidoctor::InterdocReftext
   # it into instance variable {RESOLVER_VAR_NAME} in the document, so
   # {InlineNodeMixin} can access it.
   #
-  # Prepending {InlineNodeMixin} into the `Asciidoctor::Inline` class has
+  # Prepending* {InlineNodeMixin} into the `Asciidoctor::Inline` class has
   # (obviously) a global effect. However, if {RESOLVER_VAR_NAME} is not
   # injected in the document object (e.g. extension is not active), `Inline`
   # behaves the same as without {InlineNodeMixin}.
   #
+  # _\* If running under Opal (JavaScript), {InlineNodeMixin} is not prepended
+  # into the `Asciidoctor::Inline`, because Opal does not support that. Thus
+  # it's included and the `#text` method is overriden using poor alias method
+  # chain approach.
+  #
   # NOTE: We use _reftext_ and _reflabel_ as interchangeable terms in this gem.
   class Processor < ::Asciidoctor::Extensions::TreeProcessor
 
@@ -65,7 +70,13 @@ module Asciidoctor::InterdocReftext
 
       # Monkey-patch Asciidoctor::Inline unless already patched.
       unless ::Asciidoctor::Inline.include? InlineNodeMixin
-        ::Asciidoctor::Inline.send(:prepend, InlineNodeMixin)
+        if RUBY_PLATFORM == 'opal'
+          # Opal does not support `Module#prepend`, so we have to fallback to
+          # `include` with poor alias method chain approach.
+          ::Asciidoctor::Inline.send(:include, InlineNodeMixin)
+        else
+          ::Asciidoctor::Inline.send(:prepend, InlineNodeMixin)
+        end
       end
     end
 

data/lib/asciidoctor/interdoc_reftext/resolver.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
+require 'asciidoctor' unless RUBY_PLATFORM == 'opal'
+require 'logger' unless RUBY_PLATFORM == 'opal'
 require 'asciidoctor/interdoc_reftext/version'
-require 'asciidoctor'
-require 'logger'
 
 module Asciidoctor::InterdocReftext
   # Resolver of inter-document cross reference texts.
@@ -20,8 +20,17 @@ module Asciidoctor::InterdocReftext
 
       logger ||= if defined? ::Asciidoctor::LoggerManager
         ::Asciidoctor::LoggerManager.logger
-      else
+      elsif defined? ::Logger
         ::Logger.new(STDERR)
+      else
+        # Fake logger for Opal.
+        # TODO: Remove after update to Asciidoctor 1.5.7 or Opal with Logger.
+        Object.new.tap do |o|
+          # rubocop: disable MethodMissing
+          def o.method_missing(_, *args)
+            STDERR.puts(*args)
+          end
+        end
       end
 
       @document = document
@@ -48,8 +57,9 @@ module Asciidoctor::InterdocReftext
       path = resolve_target_path(path) or return nil
 
       @cache["#{path}##{fragment}".freeze] ||= begin
-        lines = read_file(path) or return nil
-        parse_reftext(lines, fragment)
+        read_file(path) do |lines|
+          parse_reftext(lines, fragment)
+        end
       rescue => e  # rubocop: disable RescueWithoutErrorClass
         raise if @raise_exceptions
         @logger.error "interdoc-reftext: #{e}"
@@ -93,9 +103,11 @@ module Asciidoctor::InterdocReftext
     end
 
     # @param path [String] path of the file to read.
-    # @return [Enumerable<String>] lines of the file.
+    # @yield [Enumerable<String>] gives lines of the file.
     def read_file(path)
-      ::IO.foreach(path)
+      ::File.open(path) do |f|
+        yield f.each_line
+      end
     end
 
     # @param input [Enumerable<String>] lines of the AsciiDoc document.

data/lib/asciidoctor/interdoc_reftext/version.rb

@@ -3,6 +3,6 @@
 module Asciidoctor
   module InterdocReftext
     # Version of the asciidoctor-interdoc-reftext gem.
-    VERSION = '0.2.0'.freeze
+    VERSION = '0.3.0'.freeze
   end
 end

data/lib/asciidoctor/interdoc_reftext.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
-require 'asciidoctor'
-require 'asciidoctor/extensions'
+require 'asciidoctor' unless RUBY_PLATFORM == 'opal'
+require 'asciidoctor/extensions' unless RUBY_PLATFORM == 'opal'
 require 'asciidoctor/interdoc_reftext/version'
 require 'asciidoctor/interdoc_reftext/processor'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-interdoc-reftext
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Jakub Jirutka
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-09 00:00:00.000000000 Z
+date: 2018-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -171,7 +171,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Asciidoctor extension providing implicit (automatic) reference text (label)