middlemac-extras 1.0.5 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 47aad4c22b21d4814184a9f3d0bfbbaa7a3c1d49
-  data.tar.gz: ed424b5d4b2ac535f57580cc31b9b7413b4b5b61
+  metadata.gz: 31a65dd425ee55202ee06644b77dc24aa1a902eb
+  data.tar.gz: e3f7ac7e9f4d119285a0574bfcf698b154f8756f
 SHA512:
-  metadata.gz: d78a4a8951950f779079bacc9c9d78bc6335bd6d24777864a02dd68f21ea3d0619bcddc951f090d0aa0d0a73852067ecee71ba86d9d9cdabc46ad9ff2b38855e
-  data.tar.gz: 5edc65933dec1909430c1b3b089a32725fbd6282d2d08448e4a8fb662c5b1e8ff71f8bf0b0cd502fc22670718a081b78f3c7c3230fe6dfcd1074a6c50fc66473
+  metadata.gz: 683a523261e3c37fc8bedcb054e77037b5e2ac69d372b73e3261acea6c4b7f1bfcc935aeb064962a99f34293ae639518567fa8bfbe21922f3b0617b521ecc41e
+  data.tar.gz: 0c67ae4502826c5bfdc4288954cc976a9ed708f2a0bbeb6bb0b3103e9a5e9520d8e12ad63bb127f7246d9f209dbc56080a40c1c157faf1babfe455f4ccfd567b

data/CHANGELOG.md

@@ -1,6 +1,13 @@
 middlemac-extras change log
 ===========================
 
+- Version 1.0.6 / 2016-April-08
+
+  - If `middleman-targets` is also installed, support images without extensions
+    for it, too. Make sure to active it first, though.
+    
+  - Added CLI topic to help file.
+
 - Version 1.0.5 / 2016-April-08
 
   - Fixed the implementation of css_image_sizes so that full path is not

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.5'
+gem 'middlemac-extras', '~> 1.0.6'
 gem 'middleman', '~> 4.1.6'
 gem 'middleman-syntax'
 

data/documentation_project/config.rb

@@ -32,7 +32,7 @@ activate :MiddlemacExtras do |config|
   # Set this to an array of extensions in the order of precedence for
   # using `image_tag` without file extensions.
   config.img_auto_extensions_order = %w(.svg .png .jpg .jpeg .gif .tiff .tif)
-
+  
 end
 
 
@@ -58,7 +58,7 @@ helpers do
   end
 
   def product_version
-    '1.0.5'
+    '1.0.6'
   end
 
   def product_uri

data/documentation_project/source/cli.html.md.erb

@@ -0,0 +1,49 @@
+---
+title:     Command Line Interface
+layout:    template-logo-medium
+---
+
+# <%= current_page.data.title %>
+
+`middlemac-extras` has a small command line interface that might be useful
+for generating sample documentation.
+
+The CLI takes the format:
+
+~~~ bash
+middlemac-extras command
+~~~
+
+…where the following commands are available.
+
+`documentation`
+
+ : Produces a sample project named `middlemac-extras-docs/` in your current
+   working directory. This sample uses the features of this gem. You can then
+   serve this new project to read the documentation by:
+
+~~~ bash
+cd middlemac-extras-docs
+bundle install
+bundle exec middleman server
+~~~
+
+
+`help`
+
+ : Displays CLI usage help.
+ 
+`--version` or `-v`
+
+ : Displays the version of `middlemac-extras`.
+
+<% content_for :seeAlso do %>
+<ul>
+  <li><a href="/">Welcome to <code>middlemac-extras</code></a></li>
+  <li><a href="css_image_sizes.html">The <code>css_image_sizes</code> helper</a></li>
+  <li><a href="image_tag.html">The <code>image_tag</code> helper</a></li>
+  <li><a href="md_images.html">The <code>md_images</code> helper</a></li>
+  <li><a href="md_links.html">The <code>md_links</code> helper</a></li>
+  <li><a href="license.html">The MIT License</a></li>
+</ul>
+<% end %>

data/documentation_project/source/config_rb.html.md.erb

@@ -14,6 +14,7 @@ navigate: false
   <li><a href="image_tag.html">The <code>image_tag</code> helper</a></li>
   <li><a href="md_images.html">The <code>md_images</code> helper</a></li>
   <li><a href="md_links.html">The <code>md_links</code> helper</a></li>
+  <li><a href="cli.html">Command line interface</a></li>
   <li><a href="license.html">The MIT License</a></li>
 </ul>
 <% end %>

data/documentation_project/source/css_image_sizes.html.md.erb

@@ -16,6 +16,7 @@ navigate: false
   <li><a href="md_images.html">The <code>md_images</code> helper</a></li>
   <li><a href="md_links.html">The <code>md_links</code> helper</a></li>
   <li><a href="config_rb.html">Setting up <code>config.rb</code></a></li>
+  <li><a href="cli.html">Command line interface</a></li>
   <li><a href="license.html">The MIT License</a></li>
 </ul>
 <% end %>

data/documentation_project/source/image_tag.html.md.erb

@@ -15,6 +15,7 @@ navigate: false
   <li><a href="md_images.html">The <code>md_images</code> helper</a></li>
   <li><a href="md_links.html">The <code>md_links</code> helper</a></li>
   <li><a href="config_rb.html">Setting up <code>config.rb</code></a></li>
+  <li><a href="cli.html">Command line interface</a></li>
   <li><a href="license.html">The MIT License</a></li>
 </ul>
 <% end %>
@@ -31,13 +32,16 @@ When enabled this new feature allows you to omit the image extension when
 specifying an image.
 
 ~~~ erb
-<%= image_tag 'image' %>
+<%%= image_tag 'middlemac-extras-small' %>
 ~~~
 
 ~~~ markdown
-![MyImage](image)
+![MyImage](middlemac-extras-small)
 ~~~
 
+<%= image_tag 'middlemac-extras-small' %>
+
+
 When enabled, the helper will look for images in your project that have an 
 extension specified by `img_auto_extensions_order` in your
 [`config.rb`][config_rb] file.

data/documentation_project/source/index.html.md.erb

@@ -48,6 +48,10 @@ This extension currently offers features such as these:
 
 [Setting up `config.rb`][config_rb]
  : Review the key configuration values for making this extension work.
+ 
+[Command Line Interface][cli]
+ : This gem offers a simple command line interface for building its own
+   documentation.
 
 [The MIT License][license]
  : Describes your legal rights and obligations for using these materials.

data/documentation_project/source/license.html.md.erb

@@ -15,6 +15,7 @@ navigate: false
   <li><a href="md_images.html">The <code>md_images</code> helper</a></li>
   <li><a href="md_links.html">The <code>md_links</code> helper</a></li>
   <li><a href="config_rb.html">Setting up <code>config.rb</code></a></li>
+  <li><a href="cli.html">Command line interface</a></li>
 </ul>
 <% end %>
 

data/documentation_project/source/md_images.html.md.erb

@@ -16,6 +16,7 @@ navigate: false
   <li><a href="image_tag.html">The <code>image_tag</code> helper</a></li>
   <li><a href="md_links.html">The <code>md_links</code> helper</a></li>
   <li><a href="config_rb.html">Setting up <code>config.rb</code></a></li>
+  <li><a href="cli.html">Command line interface</a></li>
   <li><a href="license.html">The MIT License</a></li>
 </ul>
 <% end %>

data/documentation_project/source/md_links.html.md.erb

@@ -16,6 +16,7 @@ navigate: false
   <li><a href="image_tag.html">The <code>image_tag</code> helper</a></li>
   <li><a href="md_images.html">The <code>md_images</code> helper</a></li>
   <li><a href="config_rb.html">Setting up <code>config.rb</code></a></li>
+  <li><a href="cli.html">Command line interface</a></li>
   <li><a href="license.html">The MIT License</a></li>
 </ul>
 <% end %>

data/lib/middlemac-extras/extension.rb

@@ -94,6 +94,8 @@ class MiddlemacExtras < ::Middleman::Extension
 
       img_auto_extensions = ext_options[:img_auto_extensions]
       img_auto_extensions = params.delete(:img_auto_extensions) if params[:img_auto_extensions]
+      
+      middleman_targets = app.extensions[:MiddlemanTargets]
 
       retina_srcset = ext_options[:retina_srcset]
       retina_srcset = params.delete(:retina_srcset) if params[:retina_srcset]
@@ -109,18 +111,29 @@ class MiddlemacExtras < ::Middleman::Extension
       #- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
       if File.extname(path) == '' && img_auto_extensions
         ext_options[:img_auto_extensions_order].reverse.each do |ext|
-          real_path = "#{path.dup}#{ext}"
-          real_path = if path.start_with?('/')
-                        File.expand_path(File.join(@app.config[:source], real_path))
-                      else
-                        File.expand_path(File.join(@app.config[:source], @app.config[:images_dir], real_path))
-                      end
-
-          file = app.files.find(:source, real_path)
-          if file && file[:full_path].exist?
-            path = "#{path.dup}#{ext}"
-          end
+        
+          original_path = path.dup
+          proposed_path = app.extensions[:MiddlemacExtras].with_extension_proposal( original_path, ext )
+
+          path = proposed_path if proposed_path != original_path
+
         end # each
+        
+        # If we're still empty and we're using `middleman-targets` let's try
+        # to find a match using the `middleman-targets` gem, because there
+        # may be a target-specific image but not the magic_word image that
+        # was asked for.
+        if File.extname(path) == '' && middleman_targets
+          ext_options[:img_auto_extensions_order].reverse.each do |ext|
+        
+            test_path = "#{path}#{ext}"
+            proposed_path = middleman_targets.target_specific_proposal(test_path)
+
+            path = proposed_path if proposed_path != test_path
+
+          end # each
+          
+        end # if
       end
 
 
@@ -267,5 +280,56 @@ class MiddlemacExtras < ::Middleman::Extension
     end
     @md_sizes_b.join("\n")
   end
+  
+  
+  #--------------------------------------------------------
+  # with_extension_proposal( path, ext )
+  #  Returns a file with an extension if found; otherwise
+  #  it returns the original file.
+  #--------------------------------------------------------
+  def with_extension_proposal( path, ext )
+    return path unless File.extname(path) == '' && app.extensions[:MiddlemacExtras].options[:img_auto_extensions]
+  
+    real_path = path.dup
+
+    # Enable absolute paths, too.
+    real_path = if path.start_with?('/')
+                  File.expand_path(File.join(app.config[:source], real_path))
+                else
+                  File.expand_path(File.join(app.config[:source], app.config[:images_dir], real_path))
+                end
+
+    proposed_path = "#{real_path}#{ext}"
+    file = app.files.find(:source, proposed_path)
+    
+    if file && file[:full_path].exist?
+      "#{path}#{ext}"
+    else
+      path
+    end
+
+  end
+
+
+  #--------------------------------------------------------
+  # say
+  #  Output colored messages using ANSI codes.
+  #--------------------------------------------------------
+  def say(message = '', color = :reset)
+    colors = { :blue   => "\033[34m",
+               :cyan   => "\033[36m",
+               :green  => "\033[32m",
+               :red    => "\033[31m",
+               :yellow => "\033[33m",
+               :reset  => "\033[0m",
+    }
+
+    if RbConfig::CONFIG['host_os'] =~ /mswin|mingw|cygwin/
+      puts message
+    else
+      puts colors[color] + message + colors[:reset]
+    end
+  end # say
+
 
 end # class MiddlemacExtras

data/lib/middlemac-extras/version.rb

@@ -1,5 +1,5 @@
 module Middleman
     module MiddlemacExtras
-        VERSION = '1.0.5'
+        VERSION = '1.0.6'
     end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: middlemac-extras
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.0.6
 platform: ruby
 authors:
 - Jim Derry
@@ -105,6 +105,7 @@ files:
 - documentation_project/source/books/science fiction/past_science_fiction/past_far/index.html.md.erb
 - documentation_project/source/books/science fiction/past_science_fiction/past_near/about.html.md.erb
 - documentation_project/source/books/science fiction/past_science_fiction/past_near/index.html.md.erb
+- documentation_project/source/cli.html.md.erb
 - documentation_project/source/config_rb.html.md.erb
 - documentation_project/source/css_image_sizes.html.md.erb
 - documentation_project/source/image_tag.html.md.erb