markdown_helper 1.6.1 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 40f6b9b405ab0a09530dc86a3397cd1aeaf05b14
-  data.tar.gz: 3f6d57289baabeb3528f56550cde10208d2be42c
+  metadata.gz: 271b429b2a0016330e36fb2afd2c59c141ffb875
+  data.tar.gz: cc509ab4b86e4eeb18a60b5ec435bdf6f840fad1
 SHA512:
-  metadata.gz: 39fd4211aa2e807938ecd1e9e7e5c64e309162ddcad2eef087d4762576ac2a344ba6b3f0a85b2ef38ac5d102fc15dd17a2e941400035b444096f0718cfac2cd4
-  data.tar.gz: ad48c542562adb40e3d7371efbad4c68848777cf1473c62041ee92624cb71ec20ea954f6da462debd5c7a7a3b1230a99d22d3503ec08d01e727b897bee5503e1
+  metadata.gz: bdfda83d3fecc8f4f80b0762b28878fa0ef3d4374df8bb10abeb1c7df638b42a97d180bda2388517091220a09bd55c5cd3c2a39da3f73e3d98ced011d4a9ca29
+  data.tar.gz: c9acebb1a64ca5f539da782cc451f70e96ef908567770a660e3e60c940714608fa5ae9723861f0fd16b327f444388602ec6f92c8e6ae35304e0042325c2b82d0

data/.gitignore

@@ -7,5 +7,5 @@
 /pkg/
 /spec/reports/
 /tmp/
-/test/tmp/
+/test/resolve/tmp/
 

data/Gemfile.lock

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

data/README.md

@@ -41,10 +41,10 @@ You can suppress those comments using the <code>pristine</code> option.
 
 ## File Inclusion 
 
-<!-- >>>>>> BEGIN RESOLVED IMAGES: INPUT-LINE '![include_icon](images/include.png | width=50)
+<!-- >>>>>> BEGIN RESOLVED IMAGES: INPUT-LINE '![include_icon](../images/include.png | width=50)
 ' -->
 <img src="https://raw.githubusercontent.com/BurdetteLamar/markdown_helper/master/images/include.png" alt="include_icon" width="50">
-<!-- <<<<<< END RESOLVED IMAGES: INPUT-LINE '![include_icon](images/include.png | width=50)
+<!-- <<<<<< END RESOLVED IMAGES: INPUT-LINE '![include_icon](../images/include.png | width=50)
 ' -->
 
 This markdown helper enables file inclusion in GitHub markdown.
@@ -166,10 +166,10 @@ where:
 
 ## Image Path Resolution 
 
-<!-- >>>>>> BEGIN RESOLVED IMAGES: INPUT-LINE '![image_icon](images/image.png | width=50)
+<!-- >>>>>> BEGIN RESOLVED IMAGES: INPUT-LINE '![image_icon](../images/image.png | width=50)
 ' -->
 <img src="https://raw.githubusercontent.com/BurdetteLamar/markdown_helper/master/images/image.png" alt="image_icon" width="50">
-<!-- <<<<<< END RESOLVED IMAGES: INPUT-LINE '![image_icon](images/image.png | width=50)
+<!-- <<<<<< END RESOLVED IMAGES: INPUT-LINE '![image_icon](../images/image.png | width=50)
 ' -->
 
 This markdown helper enables image path resolution in GitHub markdown.
@@ -251,10 +251,10 @@ where:
 
 ## Image Attributes
 
-<!-- >>>>>> BEGIN RESOLVED IMAGES: INPUT-LINE '![html_icon](images/html.png | width=50)
+<!-- >>>>>> BEGIN RESOLVED IMAGES: INPUT-LINE '![html_icon](../images/html.png | width=50)
 ' -->
 <img src="https://raw.githubusercontent.com/BurdetteLamar/markdown_helper/master/images/html.png" alt="html_icon" width="50">
-<!-- <<<<<< END RESOLVED IMAGES: INPUT-LINE '![html_icon](images/html.png | width=50)
+<!-- <<<<<< END RESOLVED IMAGES: INPUT-LINE '![html_icon](../images/html.png | width=50)
 ' -->
 
 This markdown helper enables HTML image attributes in GitHub markdown [image descriptions](https://github.github.com/gfm/#image-description).

data/lib/markdown_helper.rb

@@ -63,14 +63,14 @@ class MarkdownHelper
   #
   # The path resolves to:
   #
-  #   absolute_file_path = File.join(
+  #   image_path = File.join(
   #       "https://raw.githubusercontent.com/#{repo_user}/#{repo_name}/master",
   #       relative_file_path,
   #   )
   def resolve(template_file_path, markdown_file_path)
     # Method :generate_file does the first things, yields the block, does the last things.
     send(:generate_file, template_file_path, markdown_file_path, __method__) do |input_lines, output_lines|
-      send(:resolve_images, input_lines, output_lines)
+      send(:resolve_images, template_file_path, input_lines, output_lines)
     end
   end
   alias resolve_image_urls resolve
@@ -175,7 +175,7 @@ class MarkdownHelper
     end
   end
 
-  def resolve_images(input_lines, output_lines)
+  def resolve_images(template_file_path, input_lines, output_lines)
     input_lines.each do |input_line|
       scan_data = input_line.scan(IMAGE_REGEXP)
       if scan_data.empty?
@@ -185,7 +185,9 @@ class MarkdownHelper
       output_lines.push(comment(" >>>>>> BEGIN RESOLVED IMAGES: INPUT-LINE '#{input_line}' ")) unless pristine
       output_line = input_line
       scan_data.each do |alt_text, path_and_attributes|
-        relative_file_path, attributes_s =path_and_attributes.split(/\s?\|\s?/, 2)
+        original_image_file_path, attributes_s = path_and_attributes.split(/\s?\|\s?/, 2)
+
+        # Attributes.
         attributes = attributes_s ? attributes_s.split(/\s+/) : []
         formatted_attributes = ['']
         attributes.each do |attribute|
@@ -193,18 +195,35 @@ class MarkdownHelper
           formatted_attributes.push(format('%s="%s"', name, value))
         end
         formatted_attributes_s = formatted_attributes.join(' ')
-        repo_user, repo_name = repo_user_and_name
-        if relative_file_path.start_with?('http')
-          absolute_file_path = relative_file_path
+
+        if original_image_file_path.start_with?('http')
+          image_path = original_image_file_path
         else
+          git_dir = `git rev-parse --git-dir`.chomp
+          if git_dir == '.git'
+            git_clone_dir_path = `pwd`.chomp
+          else
+            git_clone_dir_path = git_dir.chomp
+          end
+          git_clone_dir_pathname = Pathname.new(git_clone_dir_path.sub(%r|/c/|, 'C:/')).realpath
+          git_clone_dir_path = git_clone_dir_pathname.to_s
+          absolute_template_file_path = File.absolute_path(template_file_path)
+          template_dir_path = File.dirname(absolute_template_file_path)
           absolute_file_path = File.join(
+              template_dir_path,
+              original_image_file_path,
+          )
+          absolute_file_path = Pathname.new(absolute_file_path).cleanpath.to_s
+          relative_image_file_path = absolute_file_path.sub(git_clone_dir_path + '/', '')
+          repo_user, repo_name = repo_user_and_name
+          image_path = File.join(
               "https://raw.githubusercontent.com/#{repo_user}/#{repo_name}/master",
-              relative_file_path,
+              relative_image_file_path,
           )
         end
         img_element = format(
             '<img src="%s" alt="%s"%s>',
-            absolute_file_path,
+            image_path,
             alt_text,
             formatted_attributes_s,
         )

data/lib/markdown_helper/version.rb

@@ -1,3 +1,3 @@
 class MarkdownHelper
-  VERSION = '1.6.1'
+  VERSION = '1.7.0'
 end

data/markdown/README.template.md

@@ -35,7 +35,7 @@ You can suppress those comments using the <code>pristine</code> option.
 
 ## File Inclusion 
 
-![include_icon](images/include.png | width=50)
+![include_icon](../images/include.png | width=50)
 
 This markdown helper enables file inclusion in GitHub markdown.
 
@@ -95,7 +95,7 @@ where:
 
 ## Image Path Resolution 
 
-![image_icon](images/image.png | width=50)
+![image_icon](../images/image.png | width=50)
 
 This markdown helper enables image path resolution in GitHub markdown.
 
@@ -133,7 +133,7 @@ where:
 
 ## Image Attributes
 
-![html_icon](images/html.png | width=50)
+![html_icon](../images/html.png | width=50)
 
 This markdown helper enables HTML image attributes in GitHub markdown [image descriptions](https://github.github.com/gfm/#image-description).
 

data/markdown/use_cases/reuse_text/included.md

@@ -0,0 +1,7 @@
+<!-- >>>>>> BEGIN GENERATED FILE (include): SOURCE includer.md -->
+This file includes the useful text.
+
+<!-- >>>>>> BEGIN INCLUDED FILE (verbatim): SOURCE ./reusable_text.md -->
+This is some useful text that can be included in more than one place (actually, in more than one file).
+<!-- <<<<<< END INCLUDED FILE (verbatim): SOURCE ./reusable_text.md -->
+<!-- <<<<<< END GENERATED FILE (include): SOURCE includer.md -->

data/markdown/use_cases/{reusable_text/use_case.md → reuse_text/reuse_text.md}

@@ -1,19 +1,19 @@
-### Reusable Text
+### Use Case: Reuse Text
 
 Use file inclusion to stay DRY (Don't Repeat Yourself).
 
 Maintain reusable text in a separate file, then include it wherever it's needed.
 
-#### Separate File
+#### File to Be Included
 
-Here's a file containing some text that can be included in more than one place:
+Here's a file containing some text that can be included:
 
 <code>reusable_text.md</code>
 ```
 This is some useful text that can be included in more than one place (actually, in more than one file).
 ```
 
-#### Template File
+#### Includer File
 
 Here's a template file that includes it:
 
@@ -29,16 +29,20 @@ This file includes the useful text.
 Here's the command to perform the inclusion (```--pristine``` suppresses inclusion comments):
 
 ```sh
-ruby ../../../bin/include --pristine includer.md included.md
+markdown_helper include includer.md included.md
 ```
 
-#### Included File
+#### File with Inclusion
 
 Here's the finished file with the inclusion:
 
 <code>included.md</code>
 ```
+<!-- >>>>>> BEGIN GENERATED FILE (include): SOURCE includer.md -->
 This file includes the useful text.
 
+<!-- >>>>>> BEGIN INCLUDED FILE (verbatim): SOURCE ./reusable_text.md -->
 This is some useful text that can be included in more than one place (actually, in more than one file).
+<!-- <<<<<< END INCLUDED FILE (verbatim): SOURCE ./reusable_text.md -->
+<!-- <<<<<< END GENERATED FILE (include): SOURCE includer.md -->
 ```

data/markdown/use_cases/{reusable_text/build.rb → reuse_text/reuse_text.rb}

@@ -1,26 +1,48 @@
+#!/usr/bin/env ruby
+
 reusable_text_file_name = 'reusable_text.md'
 includer_file_name = 'includer.md'
 included_file_name = 'included.md'
+use_case_file_name = 'reuse_text.md'
 template_file_name = 'template.md'
-use_case_file_name = 'use_case.md'
 
-include_command = "ruby ../../../bin/include --pristine #{includer_file_name} #{included_file_name}"
-build_command = "ruby ../../../bin/include --pristine #{template_file_name} #{use_case_file_name}"
+include_command = "markdown_helper include #{includer_file_name} #{included_file_name}"
+
+File.write(
+    reusable_text_file_name,
+    <<EOT
+This is some useful text that can be included in more than one place (actually, in more than one file).
+EOT
+)
+
+File.write(
+    includer_file_name,
+    <<EOT
+This file includes the useful text.
+
+@[:verbatim](#{reusable_text_file_name})
+EOT
+)
+
+# Example inclusion.
+system(include_command)
 
-template = <<EOT
-### Reusable Text
+File.write(
+    template_file_name,
+    <<EOT
+### Use Case: Reuse Text
 
 Use file inclusion to stay DRY (Don't Repeat Yourself).
 
 Maintain reusable text in a separate file, then include it wherever it's needed.
 
-#### Separate File
+#### File to Be Included
 
-Here's a file containing some text that can be included in more than one place:
+Here's a file containing some text that can be included:
 
 @[:code_block](#{reusable_text_file_name})
 
-#### Template File
+#### Includer File
 
 Here's a template file that includes it:
 
@@ -34,34 +56,14 @@ Here's the command to perform the inclusion (```--pristine``` suppresses inclusi
 #{include_command}
 ```
 
-#### Included File
+#### File with Inclusion
 
 Here's the finished file with the inclusion:
 
 @[:code_block](#{included_file_name})
 EOT
+)
 
-reusable_text = <<EOT
-This is some useful text that can be included in more than one place (actually, in more than one file).
-EOT
-
-includer = <<EOT
-This file includes the useful text.
-
-@[:verbatim](#{reusable_text_file_name})
-EOT
-
-# Write markdown files.
-{
-  template_file_name => template,
-  reusable_text_file_name => reusable_text,
-  includer_file_name => includer,
-}.each_pair do |file_name, text|
-  File.write(file_name, text)
-end
-
-# Perform the inclusion.
-system(include_command)
-
-# Build the use case.
+# Build use case.
+build_command = "markdown_helper include --pristine #{template_file_name} #{use_case_file_name}"
 system(build_command)

data/markdown/use_cases/{reusable_text → reuse_text}/template.md

@@ -1,16 +1,16 @@
-### Reusable Text
+### Use Case: Reuse Text
 
 Use file inclusion to stay DRY (Don't Repeat Yourself).
 
 Maintain reusable text in a separate file, then include it wherever it's needed.
 
-#### Separate File
+#### File to Be Included
 
-Here's a file containing some text that can be included in more than one place:
+Here's a file containing some text that can be included:
 
 @[:code_block](reusable_text.md)
 
-#### Template File
+#### Includer File
 
 Here's a template file that includes it:
 
@@ -21,10 +21,10 @@ Here's a template file that includes it:
 Here's the command to perform the inclusion (```--pristine``` suppresses inclusion comments):
 
 ```sh
-ruby ../../../bin/include --pristine includer.md included.md
+markdown_helper include includer.md included.md
 ```
 
-#### Included File
+#### File with Inclusion
 
 Here's the finished file with the inclusion:
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: markdown_helper
 version: !ruby/object:Gem::Version
-  version: 1.6.1
+  version: 1.7.0
 platform: ruby
 authors:
 - burdettelamar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-19 00:00:00.000000000 Z
+date: 2018-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -112,16 +112,15 @@ files:
 - markdown/include_usage.rb
 - markdown/resolve.md
 - markdown/resolve_usage.rb
-- markdown/use_cases/evergreen_examples.md
-- markdown/use_cases/generated_text.md
-- markdown/use_cases/image_attributes.md
-- markdown/use_cases/reusable_text/build.rb
-- markdown/use_cases/reusable_text/included.md
-- markdown/use_cases/reusable_text/includer.md
-- markdown/use_cases/reusable_text/reusable_text.md
-- markdown/use_cases/reusable_text/template.md
-- markdown/use_cases/reusable_text/use_case.md
-- markdown/use_cases/rubygem_images.md
+- markdown/use_cases/gemify_images/template.md
+- markdown/use_cases/resize_images/template.md
+- markdown/use_cases/reuse_text/included.md
+- markdown/use_cases/reuse_text/includer.md
+- markdown/use_cases/reuse_text/reusable_text.md
+- markdown/use_cases/reuse_text/reuse_text.md
+- markdown/use_cases/reuse_text/reuse_text.rb
+- markdown/use_cases/reuse_text/template.md
+- markdown/use_cases/verify_examples/template.md
 - markdown/verbatim_ruby_template.md
 - markdown_helper.gemspec
 homepage: https://github.com/BurdetteLamar/markdown_helper

data/markdown/use_cases/generated_text.md

@@ -1,5 +0,0 @@
-### Include Generated Text
-
-Use the markdown helper to include text that is generated at project "build time."
-
-Example:  Project build runs each executable with option <code>--help</code>, capturing the output into a file.  That file can then be included into the markdown pages for the project.

data/markdown/use_cases/reusable_text/included.md

@@ -1,3 +0,0 @@
-This file includes the useful text.
-
-This is some useful text that can be included in more than one place (actually, in more than one file).