ex-doc-include 0.2 → 0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 82735343deff232e1a0c4eeebb632ac7a0d66545cd2f5be0825e1e41f2a5e253
-  data.tar.gz: ec97ab375ae697d6920f1f766f344d65cb3c5d1d572981c1745d9ae5750e6a61
+  metadata.gz: 31caa3b93cfb0b3764c773b1fb9fce47ee370171f919a8e104275b5eb9d7fec0
+  data.tar.gz: 3a16089963e1fbc6e6d142a180c5a5206329e9f8701673073e63401b43a54c71
 SHA512:
-  metadata.gz: 37348ca9e62132d709a573b3388114a521553f7937e71dc668c13a072ac2d99046e22a0811a507d17f0adb21afb5e958fba7cf7f2cae5c4262f2b703bd2410bf
-  data.tar.gz: 1ee732f617a0d25750c11069e45fe26d770f5690065f0d82ce2edc8824e8c13ba7c0326bdaab01d0fefa0f6b6f35369b5148f13b40a11ed6cf6d2c2419a3dbc4
+  metadata.gz: b06dc8f66955087d82e76cf0c65a4bee8a0ae415fc192d5cbe56035e3a9eb4c565904ff9cc06c812d1190421c96d56e7ed5f38604def5a78bba48480ca39e951
+  data.tar.gz: f29b34fa361ded28f2ec20b9c2ff5021d9b1a700bdfba0f0886409a669e82c374b88a00f41b58d55b98936ba8211471f6ebc3138ad96476ad30e35245e776718

data/lib/articles-addresser.rb

@@ -0,0 +1,91 @@
+# Provides facilities to identify key traits of the included articles.
+# Relative references found at inclusion location, are supposed to be
+# relative to the location of:
+#  - the master (including) document, when referencing a source 
+#  - the master's destination folder, when referencing an output document 
+#    (e.g. a rendered linked article)
+
+class ArticleReference
+
+  # The initialization requires the master document as received by the 
+  # process function from the parser to let the constructed object be 
+  # informed of:
+  #   - the value of document option `:to_dir`
+  #   - the value of the document attribute `docdir`
+  #
+  # In case the document option `:to_dir` is not defined (happen when 
+  # not converting to file), the destination directory is assumed to be
+  # the same as the one of the master document; that is `docdir`
+
+  def initialize (doc)
+    @to_dir = doc.options[:to_dir] 
+    @root = if doc.attributes.key? 'docdir' then doc.attributes['docdir'] else '' end
+    if @to_dir == nil then 
+      @to_dir = @root 
+    end
+  end
+
+  # The method process_article collect additional information of an article
+  # linked in the document. It fixed article informations that are used to 
+  # feed the other methods, therefore `process_article` must be called prior
+  # the read of any other property.
+  # While not optimal, this is necessary because the information provided 
+  # actually refer to an included article, and multiple included
+  # articles might happen to be in the same document - then their references
+  # resolved by the same `ArticleReference` object.
+  #
+  # The last call to `process_article` fixes the *processing article*.
+
+  def process_article target, attributes 
+    @target = target
+    @base_target = File.basename(target, '.*')
+
+    @articles_folder = if attributes.key?  'articles-dir' then
+      attributes['articles-dir'] 
+    else
+      ''
+    end
+
+    @link = if attributes.key? 'link' then
+      attributes['link'] 
+    else 
+      @base_target
+    end
+  end
+
+  # Provides the relative path of the processing article in the output space.
+  # The path is relative to the output folder of the master document. 
+  #
+  # i.e. <articles-dir>/<target>.html
+  def article
+    if @articles_folder.empty? then 
+      "#{@base_target}.html" 
+    else 
+      File.join( @articles_folder, @base_target) + ".html"
+    end
+  end
+
+  # Rebases the article path to the destination folder.
+  def abs_article
+    File.join(@to_dir, article)
+  end
+
+  # Makes the target path relative to the master document folder.
+  # If available, the master document folder is an absolute path, then the 
+  # result is also an absolute path.
+  # When the master document folder is not known, the result is 
+  # the target itself, whenever it is absolute or relative.
+  def abs_target
+    if @root == nil then
+      return @target 
+    end
+    
+    return File.absolute_path(@target, @root)
+  end
+
+  # Provides the alias to be used at link location in the master document.
+  def link
+    return @link
+  end
+  
+end

data/lib/ex-doc-include.rb

@@ -1,4 +1,6 @@
 require 'asciidoctor'
+require_relative 'articles-addresser'
+
 
 class DocBlocksExtractor
   
@@ -64,32 +66,56 @@ class DocBlocksExtractor
 end
 
 
+
 class ExDocIncludeProcessor < Asciidoctor::Extensions::IncludeProcessor
+
   def handles? target
     target.end_with? '.h', '.hpp', '.cpp'
   end
 
+  def expand? attributes
+    return attributes.key? 'expand'
+  end
+
+  def link? attributes
+    return not expand? attributes
+  end
+
   def process doc, reader, target, attributes
-    if not attributes.key? 'expand'
-      target_name = File.basename(target,'.*')
-      expanded_target =  "#{target_name}.html"
-      if attributes.key? 'out-dir'
-        expanded_target = attributes["out-dir"] + "/" + expanded_target
-      end
-      
-      Asciidoctor.convert("include::#{target}[expand=true]", to_file: expanded_target, attributes: doc.attributes)
-
-      text =  if attributes.key? 'link' then attributes["link"] else target_name end
-      content = ["link:#{expanded_target}[#{text}]"]
-    else
+    log = doc.logger 
+
+    article_refs = ArticleReference.new( doc)
+    article_refs.process_article(target, attributes)
+
+    if link? attributes
+      log.info "Linking ex-doc from #{target}"
+      log.info "  Creating the linked article in #{ article_refs.abs_article}"
+      log.info "  Link alias:  #{article_refs.link}"
+      log.info "  Link target: #{article_refs.article}"
+
+      Asciidoctor.convert(
+        "include::#{article_refs.abs_target}[expand=true]", 
+        to_file: article_refs.abs_article, 
+        to_dir: doc.options[:to_dir],
+        standalone: doc.options[:standalone],
+        attributes: doc.options[:attributes],
+        safe: :unsafe,
+        mkdirs: true)
+
+      content = ["link:#{article_refs.article}[#{ article_refs.link}]"]
+    end
+
+    if expand? attributes
+      log.info "Expanding ex-doc from #{article_refs.abs_target}"
+
       content = 
-        IO.readlines(target)
+        IO.readlines( article_refs.abs_target )
         .map( &DocBlocksExtractor.new() )
         .compact
-      #content = ["linked"]
     end
-      reader.push_include content, target, target, 1, attributes
-      return reader
+    
+    reader.push_include content, nil, nil, 1, attributes
+    
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ex-doc-include
 version: !ruby/object:Gem::Version
-  version: '0.2'
+  version: '0.4'
 platform: ruby
 authors:
 - Giuseppe Puoti
@@ -14,6 +14,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - assets/style.css
+- lib/articles-addresser.rb
 - lib/ex-doc-include.rb
 homepage: https://github.com/gpuoti/ex-doc-include
 licenses: