markdown_helper 2.5.0 → 2.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 124d093de5339a00fe47c99c1f90136659cf21d3922baedc61e5a9aea7fe15ec
-  data.tar.gz: 077e4d99acaff53d4bf5f8ec1886c8b396c375dcb2ae6229fd04ca7941b2c19f
+  metadata.gz: 3a03aca6d8626d52b3ac599739a247fbb454b298ee0fb02187a451982526c8f6
+  data.tar.gz: 4ba9dcaf4796e01953debbb350f308484912b6dd850a50727fba32cd15b13bd4
 SHA512:
-  metadata.gz: 1b8ef5e11f12671e0a11faf819c3ae51a29ee3956d66c1e66405913a834b6b7ad95dfb5a581d41c02bcfa12e694d00b18237b19be0ca4929d606dca14484cb52
-  data.tar.gz: '0981351b0c5458fedc5ce0803ed999519e55c289fb0534d3b679356f3b4e68a4266c2038aa6462d03a30654cf1d1bb2f9952ccc542c64e71f86e0f5bba6b9da9'
+  metadata.gz: 6e569e86f5512efeb7cc345388bebcfc0524b08d304b0be154095c9728315fec6b804b58685707b87a6dfd7e6974a5bcc63b6162a31f18be25c288beb86a6bc7
+  data.tar.gz: 130a4b48f210cc5622ccd327273aa1f868ac567f5562662363b0c30cd582a16fbdc3c633a3283f4a03e7a9ecd8350a9f904a848f4dca34ce66e4c203a8d78b7f

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    markdown_helper (2.5.0)
+    markdown_helper (2.5.1)
 
 GEM
   remote: https://rubygems.org/

data/lib/markdown_helper/markdown_helper.rb

@@ -48,6 +48,7 @@ EOT
     template_path_in_project = MarkdownHelper.path_in_project(template_file_path)
     output_lines = []
     yield output_lines
+    output_lines = output_lines.collect { |line| line.chomp }
     unless pristine
       output_lines.unshift(MarkdownHelper.comment(" >>>>>> BEGIN GENERATED FILE (#{method}): SOURCE #{template_path_in_project} "))
       output_lines.push(MarkdownHelper.comment(" <<<<<< END GENERATED FILE (#{method}): SOURCE #{template_path_in_project} "))

data/lib/markdown_helper/markdown_includer.rb

@@ -9,9 +9,8 @@ class MarkdownIncluder < MarkdownHelper
     @inclusions = []
     generate_file(:include, template_file_path, markdown_file_path) do |output_lines|
       Dir.chdir(File.dirname(template_file_path)) do
-        markdown_lines = include_markdown(template_file_path)
-        markdown_lines = include_page_toc(markdown_lines)
-        include_all(template_file_path, markdown_lines, output_lines)
+        page_toc_lines = get_page_toc_lines(template_file_path)
+        include_all(template_file_path, page_toc_lines, is_nested = false, output_lines)
       end
     end
 
@@ -25,76 +24,45 @@ class MarkdownIncluder < MarkdownHelper
     "<details>\n#{text}</details>"
   end
 
-  def include_markdown(template_file_path)
+  def gather_markdown(template_file_path)
+    check_template(template_file_path)
     Dir.chdir(File.dirname(template_file_path)) do
       markdown_lines = []
-      unless File.readable?(template_file_path)
-        path_in_project = MarkdownHelper.path_in_project(template_file_path )
-        message = [
-            "Could not read template file: #{path_in_project}",
-            MarkdownIncluder.backtrace_inclusions(@inclusions),
-        ].join("\n")
-        e = UnreadableTemplateError.new(message)
-        e.set_backtrace([])
-        raise e
-      end
       template_lines = File.readlines(template_file_path)
       template_lines.each_with_index do |template_line, i|
         template_line.chomp!
         treatment, includee_file_path = *parse_include(template_line)
-        if treatment.nil?
-          markdown_lines.push(template_line)
-          next
-        end
-        if treatment == ':page_toc'
+        unless treatment == ':markdown'
           markdown_lines.push(template_line)
           next
         end
         inclusion = Inclusion.new(
-            template_file_path,
-            template_line,
-            i,
-            treatment,
-            includee_file_path,
-            @inclusions
+            includer_file_path: template_file_path,
+            include_pragma: template_line,
+            includer_line_number: i,
+            treatment: treatment,
+            cited_includee_file_path: includee_file_path,
+            inclusions: @inclusions
         )
-        case treatment
-        when ':markdown'
-          check_includee(inclusion)
-          check_circularity(inclusion)
-          @inclusions.push(inclusion)
-          includee_lines = include_markdown(File.absolute_path(includee_file_path))
-          markdown_lines.concat(includee_lines)
-        when ':comment'
-          text = File.read(includee_file_path)
-          markdown_lines.push(MarkdownHelper.comment(text))
-          @inclusions.push(inclusion)
-        when ':pre'
-          text = File.read(includee_file_path)
-          markdown_lines.push(MarkdownIncluder.pre(text))
-          @inclusions.push(inclusion)
-        when ':details'
-          text = File.read(includee_file_path)
-          markdown_lines.push(MarkdownIncluder.details(text))
-          @inclusions.push(inclusion)
-        else
-          markdown_lines.push(template_line)
-          next
-        end
+        check_includee(inclusion)
+        check_circularity(inclusion)
+        @inclusions.push(inclusion)
+        includee_lines = gather_markdown(File.absolute_path(includee_file_path))
+        markdown_lines.concat(includee_lines)
         @inclusions.pop
-        treatment.sub!(/^:/, '')
         add_inclusion_comments(treatment, includee_file_path, markdown_lines)
       end
       markdown_lines
     end
   end
 
-  def include_page_toc(template_lines)
+  def get_page_toc_lines(template_file_path)
+    markdown_lines = gather_markdown(template_file_path)
     toc_line_index = nil
     toc_title = nil
     anchor_counts = Hash.new(0)
-    template_lines.each_with_index do |template_line, i|
-      match_data = template_line.match(INCLUDE_REGEXP)
+    markdown_lines.each_with_index do |markdown_line, i|
+      match_data = markdown_line.match(INCLUDE_REGEXP)
       next unless match_data
       treatment = match_data[1]
       next unless treatment == ':page_toc'
@@ -110,10 +78,10 @@ class MarkdownIncluder < MarkdownHelper
         raise InvalidTocTitleError.new(message)
       end
     end
-    return template_lines unless toc_line_index
+    return markdown_lines unless toc_line_index
     toc_lines = [toc_title]
     first_heading_level = nil
-    template_lines.each_with_index do |input_line, i|
+    markdown_lines.each_with_index do |input_line, i|
       line = input_line.chomp
       heading = Heading.parse(line)
       next unless heading
@@ -126,44 +94,103 @@ class MarkdownIncluder < MarkdownHelper
       toc_line = "#{indentation}- #{heading.link(anchor_counts)}"
       toc_lines.push(toc_line)
     end
-    template_lines.delete_at(toc_line_index)
-    template_lines.insert(toc_line_index, *toc_lines)
-    template_lines
+    toc_lines
   end
 
-  def include_all(template_file_path, template_lines, output_lines)
-    template_lines.each_with_index do |template_line, i|
-      treatment, includee_file_path = *parse_include(template_line)
-      if treatment.nil?
-        output_lines.push(template_line)
-        next
+  def include_all(includer_file_path, page_toc_lines, is_nested, output_lines)
+    includer_dir_path = File.dirname(includer_file_path)
+    includer_file_name = File.basename(includer_file_path)
+    Dir.chdir(includer_dir_path) do
+      check_template(includer_file_path)
+      template_lines = File.readlines(includer_file_name)
+      if is_nested
+        add_inclusion_comments(':markdown', includer_file_path, template_lines)
       end
-      inclusion = Inclusion.new(
-          template_file_path,
-          template_line,
-          i,
-          treatment,
-          includee_file_path,
-          @inclusions
-      )
-      check_includee(inclusion)
-      @inclusions.push(inclusion)
-      file_marker = format('```%s```:', File.basename(includee_file_path))
-      begin_backticks = '```'
-      end_backticks = '```'
-      begin_backticks += treatment unless treatment.start_with?(':')
-      includee_lines = File.read(includee_file_path).split("\n")
-      includee_lines.unshift(begin_backticks)
-      includee_lines.unshift(file_marker)
-      includee_lines.push(end_backticks)
-      add_inclusion_comments(treatment.sub(':', ''), includee_file_path, includee_lines)
-      output_lines.concat(includee_lines)
+      template_lines.each_with_index do |template_line, i|
+        treatment, includee_file_path = *parse_include(template_line)
+        if treatment.nil?
+          output_lines.push(template_line)
+          next
+        end
+        if treatment == ':page_toc'
+          output_lines.concat(page_toc_lines)
+          next
+        end
+        inclusion = Inclusion.new(
+            includer_file_path: includer_file_path,
+            include_pragma: template_line,
+            includer_line_number: i,
+            treatment: treatment,
+            cited_includee_file_path: includee_file_path,
+            inclusions: @inclusions
+        )
+        @inclusions.push(inclusion)
+        check_includee(inclusion)
+        case treatment
+        when ':comment'
+          include_comment(includee_file_path, treatment, inclusion, output_lines)
+        when ':pre'
+          include_pre(includee_file_path, treatment, inclusion, output_lines)
+        when ':details'
+          include_details(includee_file_path, treatment, inclusion, output_lines)
+        when ':markdown'
+          include_all(includee_file_path, page_toc_lines, is_nested = true, output_lines)
+        else
+          include_file(includee_file_path, treatment, inclusion, output_lines)
+        end
+        @inclusions.pop
+      end
+    end
+  end
+
+  def include_comment(includee_file_path, treatment, inclusion, output_lines)
+    text = File.read(includee_file_path)
+    output_lines.push(MarkdownHelper.comment(text))
+    add_inclusion_comments(treatment, includee_file_path, output_lines)
+  end
+
+  def include_pre(includee_file_path, treatment, inclusion, output_lines)
+    text = File.read(includee_file_path)
+    output_lines.push(MarkdownIncluder.pre(text))
+    add_inclusion_comments(treatment, includee_file_path, output_lines)
+  end
+
+  def include_details(includee_file_path, treatment, inclusion, output_lines)
+    text = File.read(includee_file_path)
+    output_lines.push(MarkdownIncluder.details(text))
+    add_inclusion_comments(treatment, includee_file_path, output_lines)
+  end
+
+  def include_file(includee_file_path, treatment, inclusion, output_lines)
+    file_marker = format('```%s```:', File.basename(includee_file_path))
+    begin_backticks = '```'
+    end_backticks = '```'
+    begin_backticks += treatment unless treatment.start_with?(':')
+    includee_lines = File.read(includee_file_path).split("\n")
+    includee_lines.unshift(begin_backticks)
+    includee_lines.unshift(file_marker)
+    includee_lines.push(end_backticks)
+    add_inclusion_comments(treatment, includee_file_path, includee_lines)
+    output_lines.concat(includee_lines)
+  end
+
+  def check_template(template_file_path)
+    unless File.readable?(template_file_path)
+      path_in_project = MarkdownHelper.path_in_project(template_file_path )
+      message = [
+        "Could not read template file: #{path_in_project}",
+        MarkdownIncluder.backtrace_inclusions(@inclusions),
+      ].join("\n")
+      e = UnreadableTemplateError.new(message)
+      e.set_backtrace([])
+      raise e
     end
   end
 
   def add_inclusion_comments(treatment, includee_file_path, lines)
-    path_in_project = MarkdownHelper.path_in_project(includee_file_path)
     unless pristine
+      path_in_project = MarkdownHelper.path_in_project(includee_file_path)
+      treatment = treatment.sub(/^:/, '')
       comment = format(' >>>>>> BEGIN INCLUDED FILE (%s): SOURCE %s ', treatment, path_in_project)
       lines.unshift(MarkdownHelper.comment(comment))
       comment = format(' <<<<<< END INCLUDED FILE (%s): SOURCE %s ', treatment, path_in_project)
@@ -267,12 +294,12 @@ class MarkdownIncluder < MarkdownHelper
       :includee_absolute_file_path
 
     def initialize(
-        includer_file_path,
-        include_pragma,
-        includer_line_number,
-        treatment,
-        cited_includee_file_path,
-        inclusions
+        includer_file_path:,
+        include_pragma:,
+        includer_line_number:,
+        treatment:,
+        cited_includee_file_path:,
+        inclusions:
     )
       self.includer_file_path = includer_file_path
       self.include_pragma = include_pragma

data/lib/markdown_helper/version.rb

@@ -1,3 +1,3 @@
 class MarkdownHelper
-  VERSION = '2.5.0'
+  VERSION = '2.5.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: markdown_helper
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 2.5.1
 platform: ruby
 authors:
 - burdettelamar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-29 00:00:00.000000000 Z
+date: 2019-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler