asciidoctor-github-include 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4eef1cd3edd907cc787076ac217d434f4be7726c
-  data.tar.gz: 960c70636ad1932d5c5bdde93f523a623023233d
+  metadata.gz: a4d2ffec52b3127a3d790aa4d774b63c52da5a0e
+  data.tar.gz: 7014707480dd04c00ee818bee2811eb11ba6c0aa
 SHA512:
-  metadata.gz: 541f4e9e7d342918413dc96f6b856b1c41414b22055a9d69618460c1ca283b93b2a62f8d073aefa427e8f14d5784d2763defdb078e552fed2c760391f5dd2879
-  data.tar.gz: a99513b1be53ed0a7462e24ed0da1cc152141087e73a50b55b99b59bc53647b0331e97072fd543fdf390b9161785f83f0291ed428f3cfe6ef4786b973b72b7f7
+  metadata.gz: 1812c41bea943e09d963de7f4e6d802d1edc9845b4d6e2167e939db31fa443c27f23a17afae5cef7feaa6af15bc929548d3e301c68a2f59e3f1cabbe496be0ce
+  data.tar.gz: '0964b2877ce6fc1f5505846dfb4edc6440dcbdbb6fffb36afe9d4a0e12ce1cba7b37ded7313c33d3e586807c4e64d4b16767c0df0b921137737f991ae6f10cf2'

data/lib/asciidoctor-github-include.rb

@@ -9,6 +9,15 @@ class GithubPrivateUriIncludeProcessor < Extensions::IncludeProcessor
   end
 
   def process doc, reader, target, attributes
+
+    tags  = [attributes["tag"]] if attributes.key? "tag" unless attributes["tag"] == ""
+    tags  = attributes["tags"].split(DataDelimiterRx) if attributes.key? "tags" unless attributes["tags"] == ""
+    lines = attributes["lines"] unless attributes["lines"] == ""
+    if lines && tags
+      warn %(asciidoctor: WARNING: Tag selection #{tags} in #{target} was ignored because line selection was specified.)
+    end
+
+    # Fetch the file to be included
     begin
       doc.attr('github-access-token').nil? ? 
         content = (open target).readlines :
@@ -16,13 +25,78 @@ class GithubPrivateUriIncludeProcessor < Extensions::IncludeProcessor
     rescue
       warn %(asciidoctor: WARNING: Failed to retrieve GitHub URI #{target}. Did you set :github-access-token:?)
       content = "WARNING: Failed to retrieve GitHub URI link:#{target}[]"
+      return reader.push_include content, target, target, 1, attributes
     end
+
+    # process the lines and tags attributes
+    content = process_line_selection(content, lines, target) if lines
+    content = process_tags(content, tags, target) if tags unless lines
+
+    # push the lines onto the reader and return it
     reader.push_include content, target, target, 1, attributes
     reader
   end
+
+  # We need to process tags. This is a very naïve implementation to start with, and
+  # only supports the case where there is exactly one opening and closing instance
+  # of the tag in the file.
+  #
+  # text - the text to be processed, as an array of lines
+  # tags - an array of tags to get
+  # target - the URI of the object being fetched (only used to check the extension)
+  def process_tags text, tags, target
+    snipped_content = []
+
+    # Asciidoctor provides a map of (file extension) => (opening and closing tags for
+    # the file's circumfix comments). Use it to check for this case and get the right
+    # suffix if needed.
+    target_extension = target.slice (target.rindex '.'), target.length
+    if (circ_cmt = CIRCUMFIX_COMMENTS[target_extension])
+      circumfix_suffix = circ_cmt[:suffix]
+    end
+
+    tags.each do |tag|
+      if circumfix_suffix
+        tag_open = text.index{|line| line.chomp.end_with? %(tag::#{tag}[] #{circumfix_suffix})}
+        tag_close = text.index{|line| line.chomp.end_with? %(end::#{tag}[] #{circumfix_suffix})}
+      else
+        tag_open = text.index{|line| line.chomp.end_with? %(tag::#{tag}[])}
+        tag_close = text.index{|line| line.chomp.end_with? %(end::#{tag}[])}
+      end
+      if (!tag_open && !tag_close)
+        warn %(asciidoctor: WARNING: Tag #{tag} not found in included GitHub URI #{target}.)
+      elsif (!tag_open && tag_close)
+        warn %(asciidoctor: WARNING: Tag #{tag} not found in included GitHub URI #{target}, but end::[] tag was found.)
+      elsif (tag_open && !tag_close)
+        warn %(asciidoctor: WARNING: Closing tag for tag #{tag} not found in included GitHub URI #{target}.)
+      end
+
+      snipped_content += text[tag_open+1..tag_close-1] unless (!tag_open || !tag_close)
+    end
+    snipped_content
+  end
+
+  def process_line_selection text, lines, target
+    snipped_content = []
+    selected_lines = []
+
+    lines.split(DataDelimiterRx).each do |linedef|
+      if linedef.include?('..')
+        from, to = linedef.split('..', 2).map {|it| it.to_i }
+        to = text.length if to == -1 # -1 as a closing length means end of file
+        selected_lines.concat ::Range.new(from, to).to_a
+      else
+        selected_lines << linedef.to_i
+      end
+    end
+    selected_lines.sort.uniq.each do |i|
+      snipped_content << text[i-1]
+    end
+    snipped_content
+  end
+
 end
 
 Extensions.register do
   include_processor GithubPrivateUriIncludeProcessor 
 end
-

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-github-include
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Jon Oster
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-23 00:00:00.000000000 Z
+date: 2017-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor