markdown_helper 0.2.4 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 128fe00dd89389615391ceb4cc69127317a7249b
-  data.tar.gz: bc50bd8214659764a83503c2a02f36a8c5795ec7
+  metadata.gz: 9350e847948120c0b6cd8da04deb1eb77a915631
+  data.tar.gz: f5eb9065d158d45ee87d0f4cb0e9e9e74529c48c
 SHA512:
-  metadata.gz: 6b11b8fc50ede26c160679b2fa750653e8f1b78e84b824052c233a53a35d2672812b322e76aab382e3476fa5c0ba1c21935fecc154cefd7bd22c54cc38cb11eb
-  data.tar.gz: efe58d2174a05141b743346b0a9fe043681fcd30f13111400d67c25b5015e5bbdfd771116d9cc64c4db3724061130af82ecaee2817f39a2de6c85e4ffd6ef203
+  metadata.gz: e98b19de2d10445af71e05e271f73c0de7ea563c7d009e9870ab7783b3a8a20a33fae2463fc6ffa1ba841deda72df0edd97f1880352cf5e7fb7fed5e90073602
+  data.tar.gz: c7f039f5e9ec548b713c23c759a6e34918eec4f25f20b900375d002c0f3caaa76124972bbd4a25310a4a84814061811436634a784b933c58773b5eb2f469a08b

data/Gemfile.lock

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

data/README.md

@@ -1,10 +1,14 @@
 <!-- >>>>>> BEGIN GENERATED FILE (include): SOURCE readme_files/temp_resolved.md -->
 <!-- >>>>>> BEGIN GENERATED FILE (resolve): SOURCE readme_files/README.template.md -->
-# MarkdownHelper
+# Markdown Helper
 
-## What's This?
+<!-- >>>>>> BEGIN RESOLVED IMAGES: INPUT-LINE '![Gem Version](https://badge.fury.io/rb/markdown_helper.svg)
+' -->
+<img src="https://badge.fury.io/rb/markdown_helper.svg" alt="Gem Version">
+<!-- <<<<<< END RESOLVED IMAGES: INPUT-LINE '![Gem Version](https://badge.fury.io/rb/markdown_helper.svg)
+' -->
 
-[![Gem Version](https://badge.fury.io/rb/markdown_helper.svg)](https://badge.fury.io/rb/markdown_helper)
+## What's This?
 
 Class <code>MarkdownHelper</code> supports:
 
@@ -30,10 +34,10 @@ You can suppress those comments using the <code>pristine</code> option.
 
 ## File Inclusion 
 
-<!-- >>>>>> BEGIN RESOLVED IMAGE: DESCRIPTION '![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/MarkdownHelper/master/images/include.png" alt="include_icon" width="50">
-<!-- <<<<<< END RESOLVED IMAGE: DESCRIPTION '![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)
 ' -->
 
 This markdown helper enables file inclusion in GitHub markdown.
@@ -152,10 +156,10 @@ where:
 
 ## Image Path Resolution 
 
-<!-- >>>>>> BEGIN RESOLVED IMAGE: DESCRIPTION '![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/MarkdownHelper/master/images/image.png" alt="image_icon" width="50">
-<!-- <<<<<< END RESOLVED IMAGE: DESCRIPTION '![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)
 ' -->
 
 This markdown helper enables image path resolution in GitHub markdown.
@@ -236,10 +240,10 @@ where:
 
 ## Image Attributes
 
-<!-- >>>>>> BEGIN RESOLVED IMAGE: DESCRIPTION '![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/MarkdownHelper/master/images/html.png" alt="html_icon" width="50">
-<!-- <<<<<< END RESOLVED IMAGE: DESCRIPTION '![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)
 ' -->
 
 This markdown helper enables HTML image attributes in GitHub markdown [image descriptions](https://github.github.com/gfm/#image-description).
@@ -318,13 +322,13 @@ where:
 
 ## What Should Be Next?
 
-I have opened some enhancement Issues in the GitHub [MarkdownHelper](https://github.com/BurdetteLamar/MarkdownHelper) project:
+I have opened some enhancement Issues in the GitHub [markdown_helper](https://github.com/BurdetteLamar/markdown_helper) project:
 
-* [Pagination](https://github.com/BurdetteLamar/MarkdownHelper/issues/40):  series of markdown pages connected by prev/next navigation links.
-* [Partial file inclusion](https://github.com/BurdetteLamar/MarkdownHelper/issues/38):  including only specified lines from a file (instead of the whole file).
-* [Ruby-entity inclusion](https://github.com/BurdetteLamar/MarkdownHelper/issues/39):  like file inclusion, but including a Ruby class, module, or method.
-* [File TOC](https://github.com/BurdetteLamar/MarkdownHelper/issues/36):  table of contents of all headers in a markdown page.
-* [Project TOC](https://github.com/BurdetteLamar/MarkdownHelper/issues/37):  table of contents of all markdown pages in project.
+* [File TOC](https://github.com/BurdetteLamar/markdown_helper/issues/36):  table of contents of all headers in a markdown page.
+* [Project TOC](https://github.com/BurdetteLamar/markdown_helper/issues/37):  table of contents of all markdown pages in project.
+* [Partial file inclusion](https://github.com/BurdetteLamar/markdown_helper/issues/38):  including only specified lines from a file (instead of the whole file).
+* [Ruby-entity inclusion](https://github.com/BurdetteLamar/markdown_helper/issues/39):  like file inclusion, but including a Ruby class, module, or method.
+* [Pagination](https://github.com/BurdetteLamar/markdown_helper/issues/40):  series of markdown pages connected by prev/next navigation links.
 
 Feel free to comment on any of these, or to add more Issues (enhancement or otherwise).
 <!-- <<<<<< END GENERATED FILE (resolve): SOURCE readme_files/README.template.md -->

data/_config.yml

@@ -0,0 +1 @@
+theme: jekyll-theme-cayman

data/lib/markdown_helper/version.rb

@@ -1,3 +1,3 @@
 class MarkdownHelper
-  VERSION = '0.2.4'
+  VERSION = '1.0.0'
 end

data/lib/markdown_helper.rb

@@ -6,8 +6,8 @@ require 'markdown_helper/version'
 # @author Burdette Lamar
 class MarkdownHelper
 
-  IMAGE_REGEXP = /^!\[([^\[]+)\]\(([^)]+)\)/
-  INCLUDE_REGEXP = /^@\[([^\[]+)\]\(([^)]+)\)/
+  IMAGE_REGEXP = /!\[([^\[]+)\]\(([^)]+)\)/
+  INCLUDE_REGEXP = /^@\[([^\[]+)\]\(([^)]+)\)$/
 
   attr_accessor :pristine
 
@@ -104,41 +104,12 @@ class MarkdownHelper
     # Method :generate_file does the first things, yields the block, does the last things.
     output = send(:generate_file, template_file_path, markdown_file_path, __method__) do |input_lines, output_lines|
       input_lines.each do |input_line|
-        match_data = input_line.match(IMAGE_REGEXP)
-        unless match_data
+        scan_data = input_line.scan(IMAGE_REGEXP)
+        if scan_data.empty?
           output_lines.push(input_line)
           next
         end
-        send(:comment_resolve, input_line, output_lines) do
-          alt_text = match_data[1]
-          relative_file_path, attributes_s = match_data[2].split(/\s?\|\s?/, 2)
-          attributes = attributes_s ? attributes_s.split(/\s+/) : []
-          formatted_attributes = ['']
-          attributes.each do |attribute|
-            name, value = attribute.split('=', 2)
-            formatted_attributes.push(format('%s="%s"', name, value))
-          end
-          formatted_attributes_s = formatted_attributes.join(' ')
-          repo_user, repo_name = repo_user_and_name
-          absolute_file_path = nil
-          if relative_file_path.start_with?('http')
-            absolute_file_path = relative_file_path
-          else
-            absolute_file_path = File.join(
-                "https://raw.githubusercontent.com/#{repo_user}/#{repo_name}/master",
-                relative_file_path,
-            )
-          end
-          following_text = input_line.sub(IMAGE_REGEXP, '').chomp
-          line = format(
-              '<img src="%s" alt="%s"%s>%s',
-              absolute_file_path,
-              alt_text,
-              formatted_attributes_s,
-              following_text
-          ) + "\n"
-          output_lines.push(line)
-        end
+        send(:resolve_images, scan_data, input_line, output_lines)
       end
     end
     output
@@ -193,10 +164,38 @@ class MarkdownHelper
     output_lines.push(comment(" <<<<<< END INCLUDED FILE (#{treatment}): SOURCE #{include_file.path} ")) unless pristine
   end
 
-  def comment_resolve(description, output_lines)
-    output_lines.push(comment(" >>>>>> BEGIN RESOLVED IMAGE: DESCRIPTION '#{description}' ")) unless pristine
-    yield
-    output_lines.push(comment(" <<<<<< END RESOLVED IMAGE: DESCRIPTION '#{description}' ")) unless pristine
+  def resolve_images(scan_data, input_line, output_lines)
+  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)
+    attributes = attributes_s ? attributes_s.split(/\s+/) : []
+    formatted_attributes = ['']
+    attributes.each do |attribute|
+      name, value = attribute.split('=', 2)
+      formatted_attributes.push(format('%s="%s"', name, value))
+    end
+    formatted_attributes_s = formatted_attributes.join(' ')
+    repo_user, repo_name = repo_user_and_name
+    absolute_file_path = nil
+    if relative_file_path.start_with?('http')
+      absolute_file_path = relative_file_path
+    else
+      absolute_file_path = File.join(
+          "https://raw.githubusercontent.com/#{repo_user}/#{repo_name}/master",
+          relative_file_path,
+      )
+    end
+    img_element = format(
+        '<img src="%s" alt="%s"%s>',
+        absolute_file_path,
+        alt_text,
+        formatted_attributes_s,
+    )
+    output_line = output_line.sub(IMAGE_REGEXP, img_element)
+  end
+  output_lines.push(output_line)
+  output_lines.push(comment(" <<<<<< END RESOLVED IMAGES: INPUT-LINE '#{input_line}' ")) unless pristine
   end
 
 end

data/markdown_helper.gemspec

@@ -17,7 +17,7 @@ Class to help with GitHub markdown:
 * Image path resolution
 * Image attributes
 EOT
-  spec.homepage      = 'https://github.com/BurdetteLamar/MarkdownHelper'
+  spec.homepage      = 'https://github.com/BurdetteLamar/markdown_helper'
   spec.license       = 'MIT'
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'

data/readme_files/README.template.md

@@ -1,8 +1,8 @@
-# MarkdownHelper
+# Markdown Helper
 
-## What's This?
+![Gem Version](https://badge.fury.io/rb/markdown_helper.svg)
 
-[![Gem Version](https://badge.fury.io/rb/markdown_helper.svg)](https://badge.fury.io/rb/markdown_helper)
+## What's This?
 
 Class <code>MarkdownHelper</code> supports:
 
@@ -160,12 +160,12 @@ where:
 
 ## What Should Be Next?
 
-I have opened some enhancement Issues in the GitHub [MarkdownHelper](https://github.com/BurdetteLamar/MarkdownHelper) project:
+I have opened some enhancement Issues in the GitHub [markdown_helper](https://github.com/BurdetteLamar/markdown_helper) project:
 
-* [Pagination](https://github.com/BurdetteLamar/MarkdownHelper/issues/40):  series of markdown pages connected by prev/next navigation links.
-* [Partial file inclusion](https://github.com/BurdetteLamar/MarkdownHelper/issues/38):  including only specified lines from a file (instead of the whole file).
-* [Ruby-entity inclusion](https://github.com/BurdetteLamar/MarkdownHelper/issues/39):  like file inclusion, but including a Ruby class, module, or method.
-* [File TOC](https://github.com/BurdetteLamar/MarkdownHelper/issues/36):  table of contents of all headers in a markdown page.
-* [Project TOC](https://github.com/BurdetteLamar/MarkdownHelper/issues/37):  table of contents of all markdown pages in project.
+* [File TOC](https://github.com/BurdetteLamar/markdown_helper/issues/36):  table of contents of all headers in a markdown page.
+* [Project TOC](https://github.com/BurdetteLamar/markdown_helper/issues/37):  table of contents of all markdown pages in project.
+* [Partial file inclusion](https://github.com/BurdetteLamar/markdown_helper/issues/38):  including only specified lines from a file (instead of the whole file).
+* [Ruby-entity inclusion](https://github.com/BurdetteLamar/markdown_helper/issues/39):  like file inclusion, but including a Ruby class, module, or method.
+* [Pagination](https://github.com/BurdetteLamar/markdown_helper/issues/40):  series of markdown pages connected by prev/next navigation links.
 
 Feel free to comment on any of these, or to add more Issues (enhancement or otherwise).

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: markdown_helper
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 1.0.0
 platform: ruby
 authors:
 - burdettelamar
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-18 00:00:00.000000000 Z
+date: 2018-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -87,6 +87,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- _config.yml
 - bin/console
 - bin/include
 - bin/resolve
@@ -96,7 +97,6 @@ files:
 - images/html.png
 - images/image.png
 - images/include.png
-- images_resolved.md
 - lib/markdown_helper.rb
 - lib/markdown_helper/version.rb
 - markdown_helper.gemspec
@@ -110,7 +110,7 @@ files:
 - readme_files/resolve.md
 - readme_files/resolve_usage.rb
 - readme_files/verbatim_ruby_template.md
-homepage: https://github.com/BurdetteLamar/MarkdownHelper
+homepage: https://github.com/BurdetteLamar/markdown_helper
 licenses:
 - MIT
 metadata: {}

data/images_resolved.md

@@ -1,96 +0,0 @@
-# MarkdownHelper
-
-[![Gem Version](https://badge.fury.io/rb/markdown_helper.svg)](https://badge.fury.io/rb/markdown_helper)
-
-## File Inclusion 
-
-<img src="https://raw.githubusercontent.com/BurdetteLamar/MarkdownHelper/master/images/include.png" alt="include_icon" width="50">
-
-This markdown helper enables file inclusion in GitHub markdown.
-
-(Actually, this README file itself is built using file inclusion.)
-
-Use the markdown helper to merge external files into a markdown (</code>.md</code>) file.
-
-### Merged Text Formats
-
-#### Highlighted Code Block
-
-@[ruby](include.rb)
-
-#### Plain Code Block
-
-@[:code_block](include.rb)
-
-[Note:  In the gem documentation, RubyDoc.info chooses to highlight this code block regardless.  Go figure.]
-
-#### Verbatim
-
-Verbatim text is included unadorned.  Most often, verbatim text is markdown to be rendered as part of the markdown page.
-
-### Usage
-
-#### CLI
-
-@[:code_block](../bin/usage/include.txt)
-
-#### API
-
-@[ruby](include_usage.rb)
-
-#### Include Pragmas
-
-Specify each file inclusion via an *include pragma*, which has the form:
-
-<code>@[</code>*format*<code>]\(</code>*relative_file_path*<code>)</code>
-
-where:
-
-* *format* (in square brackets) is one of the following:
-  * Highlighting mode such as <code>[ruby]</code>, to include a highlighted code block.  This can be any Ace mode mentioned in [GitHub Languages](https://github.com/github/linguist/blob/master/lib/linguist/languages.yml).
-  * <code>[:code_block]</code>, to include a plain code block.
-  * <code>[:verbatim]</code>, to include text verbatim (to be rendered as markdown).
-* *relative_file_path* points to the file to be included.
-
-##### Example Include Pragmas
-
-@[code_block](include.md)
-
-## Image Path Resolution 
-
-<img src="https://raw.githubusercontent.com/BurdetteLamar/MarkdownHelper/master/images/image.png" alt="image_icon" width="50">
-
-This markdown helper enables image path resolution in GitHub markdown.
-
-(Actually, this README file itself is built using image path resolution.)
-
-Use the markdown helper to resolve image relative paths in a markdown (</code>.md</code>) file.
-
-This matters because when markdown becomes part of a Ruby gem, its images will have been relocated in the documentation at RubyDoc.info, breaking the relative paths. The resolved (absolute) urls, however, will still be valid.
-
-### Usage
-
-#### CLI
-
-@[:code_block](../bin/usage/resolve.txt)
-
-#### API
-
-@[ruby](resolve_usage.rb)
-
-#### Image Pragmas
-
-Specify each image file via an *image pragma*, which has the form:
-
-<code>![*alt_text*]\(</code>*relative_file_path* <code>|</code> *attributes*<code>)</code>
-
-where:
-
-* *alt_text* is the usual alt text for an HTML image.
-* *relative_file_path* points to the file to be included.
-* *attributes* are whitespace-separated name-value pairs in the form *name*<code>=</code>*value*.  These are passed through to the generated <code>img</code> HTML element.
-
-##### Example Image Pragmas
-
-@[code_block](resolve.md)
-