markdown_helper 1.5.0 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d1147c20c56afc8ddb67b90b57845d59d08488c7
-  data.tar.gz: 0d4e6f2363d0921cdc206adc4c7c8d30a654ac1a
+  metadata.gz: 38e7b32f5f6e0b8b46878e5ef5586d2f94852c60
+  data.tar.gz: efefe056e97327bc5dafd225774e52ce81955a03
 SHA512:
-  metadata.gz: ec0b3a986477b6c9780a31073855358880375d6ccef61d669fb5b55ed121d9327c536e46f6d7cdf075dec5129c7b4c3c4be200fd7d8afbed9c128f4a11f5f518
-  data.tar.gz: a172ff12521ec4e2363d17d89b3149f303242fe7c506e17b376ab9499e7912a980905fc0463bb1bc84262165a3bfcc7b6e1d008ccd8e53f35c63f9414b488c8f
+  metadata.gz: 62891f62df9f8a0a68f1cd865335057285e9a9b1cd28d7ff0d153fdb05e679bb61accec96ec626f6dfc450843e8bc3f6f0fbc7b3b38d09d3de9e7488a2c88e9c
+  data.tar.gz: 588635b8668e9757edcb0d1eaa11364c640763471b3d943410a2a650344f7168d152fd2f9cd6752c494ee57c57405702153f7b57f4da1e1fcec28781144f20ee

data/Gemfile.lock

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

data/Rakefile

@@ -14,13 +14,16 @@ namespace :build do
     Rake::Task['build:usages'].invoke
     require_relative 'lib/markdown_helper'
     markdown_helper = MarkdownHelper.new
-    markdown_helper.include('readme_files/highlight_ruby_template.md', 'readme_files/highlighted_ruby.md')
+    template_file_path = 'readme_files/highlight_ruby_template.md'
+    markdown_file_path = 'readme_files/highlighted_ruby.md'
+    markdown_helper.include(template_file_path, markdown_file_path)
     # Do the resolve before the include, so that the included text is not also resolved.
-    # Thie protects example code from being also resolved, thus damaging the example code.
+    # This protects example code from being also resolved, thus damaging the example code.
     # Temp file must be in the same directory as its source (it becomes the source).
     temp_file_path = 'readme_files/temp_resolved.md'
     markdown_helper.resolve('readme_files/README.template.md', temp_file_path)
-    markdown_helper.include(temp_file_path, 'README.md')
+    readme_file_path = 'README.md'
+    markdown_helper.include(temp_file_path, readme_file_path)
     File.delete(temp_file_path)
   end
 

data/lib/markdown_helper.rb

@@ -41,10 +41,9 @@ class MarkdownHelper
   # @example pragma to include text verbatim, to be rendered as markdown.
   #   @[:verbatim](foo.md)
   def include(template_file_path, markdown_file_path)
-    output = send(:generate_file, template_file_path, markdown_file_path, __method__) do |input_lines, output_lines|
+    send(:generate_file, template_file_path, markdown_file_path, __method__) do |input_lines, output_lines|
       send(:include_files, template_file_path, input_lines, output_lines, paths = [], realpaths = [])
     end
-    output
   end
 
   # Resolves relative image paths to absolute urls in markdown text.
@@ -70,10 +69,9 @@ class MarkdownHelper
   #   )
   def resolve(template_file_path, markdown_file_path)
     # 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|
+    send(:generate_file, template_file_path, markdown_file_path, __method__) do |input_lines, output_lines|
       send(:resolve_images, input_lines, output_lines)
     end
-    output
   end
   alias resolve_image_urls resolve
 
@@ -192,7 +190,6 @@ EOT
       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

data/lib/markdown_helper/version.rb

@@ -1,3 +1,3 @@
 class MarkdownHelper
-  VERSION = '1.5.0'
+  VERSION = '1.5.1'
 end

data/readme_files/use_cases/evergreen_examples.md

@@ -2,12 +2,12 @@
 
 Example code and output that's embedded in a markdown file is dead text that may no longer be correct.
 
-Use the markdown helper to include example code and output -- but only after the project "build" has re-run the code and refreahed the output!
+Use the markdown helper to include example code and output -- but only after the project "build" has re-run the code and refreshed the output!
 
 Here's how:
 
 1.  Maintain each code example in a separate executable file.
-1.  Maintain markdown files that have include desctiptions, rather than embedded code and output.
+1.  Maintain markdown files that have include descriptions, rather than embedded code and output.
 1.  At project "build time" (controlled by a suitable build tool):
     1.  Execute each code example, capturing its output to one or more files.
     1.  Check output for errors and validity.

data/readme_files/use_cases/generated_text.md

@@ -1,5 +1,5 @@
 ### Include Generated Text
 
-Use the markdown helper to include text that is genrated at project "build time."
+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.
+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.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: markdown_helper
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.5.1
 platform: ruby
 authors:
 - burdettelamar
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-07 00:00:00.000000000 Z
+date: 2018-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler