middlemac-extras 1.0.9 → 1.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1f1bf37078cfe11386a8818f85d6590977f7bce8
-  data.tar.gz: 6f7f71d6d9659d01893fe251f1050a5cd7df7ea8
+  metadata.gz: 388a2f2b206613513f0144bbb7b678666ca7bc8e
+  data.tar.gz: ea309459983cd5d51d932615a0b384476c03742f
 SHA512:
-  metadata.gz: 5451db71c800300cb9ef009e464a1d48b46a2920ad42a8a8d8455bb47432d4bd07dd958f0ea47b94919fb2a0cba15ef1556ff93840a8c9e04c42a839a12dfa1d
-  data.tar.gz: 55d393044768891b9a77faa61a445d29c24f9b4fb5ea8f8924ada2db39debb6ebdda0ff38ee579202d8d82f043186b390fa3059217e390e81323788dc14ee7e3
+  metadata.gz: 9d31050d09b88de67c8efcaaff385ce392502b9c48ca481c7a1705ac203db465117d6b2ff5faafa15aa1617753be6a6cd7f61c69b79629700fbc3ceba346fea0
+  data.tar.gz: 7c2d1d41e699882c10e3e105a6513273549dff8e97e667485c72c356bc95597975765dc7a3645cf1ececff8a1e42865849e989caf42d72b1cfdc8c0e4b50a201

data/CHANGELOG.md

@@ -1,9 +1,13 @@
 middlemac-extras change log
 ===========================
 
-- Version 1.0.9 / 2018-April-28
+- Version 1.0.10 / 2018-April-28
 
+  - Update to 1.0.10 for use with newer middlemac.
   - Updated to 1.0.9. md_links no longer outputs empty quotes if no description.
+
+- Version 1.0.8 / 2016-May-15
+
   - Bump to 1.0.8 improvements:
       - Better version management in Rakefile.
       - Fixes failing Cucumber testing by forcing capybara development dependency.

data/documentation_project/Gemfile

@@ -9,7 +9,7 @@ gem 'wdm', '~> 0.1.0', platforms: [:mswin, :mingw]
 gem 'tzinfo-data', platforms: [:mswin, :mingw, :jruby]
 
 # Middleman Gems
-gem 'middlemac-extras', '~> 1.0.9'
+gem 'middlemac-extras', '~> 1.0.10'
 gem 'middleman', '~> 4.1.7'
 gem 'middleman-syntax'
 

data/documentation_project/config.rb

@@ -58,7 +58,7 @@ helpers do
   end
 
   def product_version
-    '1.0.9'
+    '1.0.10'
   end
 
 end

data/documentation_project/source/partials/_yard_helpers.erb

@@ -49,6 +49,52 @@ for every image found in your project.</p>
   
 </ul>
 
+</div>
+</div>
+      
+        <div class="method_details ">
+  <h3 class="signature " id="md_hblinks-instance_method">
+  
+    #<strong>md_hblinks</strong>  &#x21d2; <tt>String</tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>This helper provides access to <code>middlemac-extras</code>’ 
+index of links in Markdown reference format, enabling
+you to use reference-style links in documents. Because
+this helper includes literal Markdown, it’s only useful
+in Markdown documents. This is only useful when using
+Middlemac 3.0.0 or newer, which includes support for
+helpbook style links.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'><p>Returns a string with the Markdown
+index of every page in your project.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
 </div>
 </div>
       

data/lib/middlemac-extras/extension.rb

@@ -57,6 +57,7 @@ class MiddlemacExtras < ::Middleman::Extension
     super
 
     @md_links_b = nil
+    @md_links_modern_b = nil
     @md_images_b = nil
     @md_sizes_b = nil
 
@@ -74,6 +75,7 @@ class MiddlemacExtras < ::Middleman::Extension
     # changes. For speed we don't want to recalculate everything
     # every time a helper is used, but only the first time.
     @md_links_b = nil
+    @md_links_modern_b = nil
     @md_images_b = nil
     @md_sizes_b = nil
 
@@ -102,6 +104,22 @@ class MiddlemacExtras < ::Middleman::Extension
     end
 
 
+    #--------------------------------------------------------
+    # This helper provides access to `middlemac-extras`’ 
+    # index of links in Markdown reference format, enabling
+    # you to use reference-style links in documents. Because
+    # this helper includes literal Markdown, it’s only useful
+    # in Markdown documents. This is only useful when using
+    # Middlemac 3.0.0 or newer, which includes support for
+    # helpbook style links.
+    # @return [String] Returns a string with the Markdown
+    #   index of every page in your project.
+    #--------------------------------------------------------
+    def md_hblinks
+      extensions[:MiddlemacExtras].md_links_modern_b
+    end
+
+
     #--------------------------------------------------------
     # This helper provides access to `middlemac-extras`’ 
     # index of images in Markdown reference format, enabling
@@ -269,6 +287,31 @@ class MiddlemacExtras < ::Middleman::Extension
   end
 
 
+  #########################################################
+  # This accessor for @md_links_modern_b lazily populates
+  # the backing variable and buffers it for repeated use.
+  # In the event of file changes, a server restart is 
+  # needed.
+  # @returns [String] Returns the Markdown reference list.
+  # @!visibility private
+  #########################################################
+  def md_links_modern_b
+    unless @md_links_modern_b
+      @md_links_modern_b = get_link_data('text/html', 'application/xhtml')
+                          .collect { |l| 
+                            if l[:title]
+                              "[#{l[:reference]}]: #{l[:hb_link]} \"#{l[:title]}\"" 
+                            else
+                              "[#{l[:reference]}]: #{l[:hb_link]}" 
+                            end
+                            }
+                          .join("\n")
+    end
+
+    @md_links_modern_b
+  end
+
+
   #########################################################
   # This accessor for @md_images_b lazily populates the
   # backing variable and buffers it for repeated use. In
@@ -309,6 +352,7 @@ class MiddlemacExtras < ::Middleman::Extension
       reference_path.shift
       reference = File.basename(r.destination_path, '.*').gsub(%r{ }, '_')
       link = r.url
+      hb_link = defined?(r.hb_NavId) ? "#/#{r.hb_NavId}" : nil
       title = r.data.title ? r.data.title.gsub(%r{</?[^>]+?>}, '') : nil
 
       i = 0
@@ -318,7 +362,7 @@ class MiddlemacExtras < ::Middleman::Extension
         i += 1
       end
 
-      all_links << {:reference => reference, :link => link, :title => title}
+      all_links << {:reference => reference, :link => link, :title => title, :hb_link => hb_link}
     end # .each
 
     all_links

data/lib/middlemac-extras/version.rb

@@ -1,5 +1,5 @@
 module Middleman
     module MiddlemacExtras
-        VERSION = '1.0.9'
+        VERSION = '1.0.10'
     end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: middlemac-extras
 version: !ruby/object:Gem::Version
-  version: 1.0.9
+  version: 1.0.10
 platform: ruby
 authors:
 - Jim Derry