middlemac-extras 1.0.6 → 1.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 31a65dd425ee55202ee06644b77dc24aa1a902eb
-  data.tar.gz: e3f7ac7e9f4d119285a0574bfcf698b154f8756f
+  metadata.gz: c85e311f64a6b602ca9b5c9f9c04aefd33dbd19f
+  data.tar.gz: c9fa9f990646fb0cd4556d0b00853581f56e8ccc
 SHA512:
-  metadata.gz: 683a523261e3c37fc8bedcb054e77037b5e2ac69d372b73e3261acea6c4b7f1bfcc935aeb064962a99f34293ae639518567fa8bfbe21922f3b0617b521ecc41e
-  data.tar.gz: 0c67ae4502826c5bfdc4288954cc976a9ed708f2a0bbeb6bb0b3103e9a5e9520d8e12ad63bb127f7246d9f209dbc56080a40c1c157faf1babfe455f4ccfd567b
+  metadata.gz: 5499e4cc80d1d6e9f7d52535d42910a3de2ea2c98321e9568cdb097f6610ffa673328146e9d141755cae62e1e765d9684261e8fab22f6c7ee3d4f9285514585e
+  data.tar.gz: 4febfd9e6312beb93cfe60118b03bd9995fab19266e0bed3cd05fc96a7e4dea28b0b0c43b83ffbc984a0a1b64f34118728cc2e542838b8005cd847533e70d8d6

data/.gitignore

@@ -14,4 +14,11 @@ Gemfile.lock
 /pkg
 
 # Ignore build folders
-build*
+build/*
+
+# Yard cruft
+/doc/
+/.yardoc
+
+# Aruba
+/tmp/

data/.yardopts

@@ -0,0 +1,7 @@
+--no-private
+--markup=markdown
+--load yard/yard_extensions.rb
+--exclude middlemac-extras/version.rb
+--one-file
+--readme yard/readme.md
+--title middlemac-extras

data/CHANGELOG.md

@@ -1,19 +1,36 @@
 middlemac-extras change log
 ===========================
 
-- Version 1.0.6 / 2016-April-08
+- Version 1.0.7 / 2016-May-11
 
-  - 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.7 supports RAKE, Yard, etc.
+      - YARD support added.
+      - Cucumber tests added.
+      - Documentation project updates.
+      - Source code commented extensively for YARD.
+  - Works cooperative if middleman-targets is installed to support images without extensions for target-specific images, too. Added CLI help section.
 
 - Version 1.0.5 / 2016-April-08
 
-  - Fixed the implementation of css_image_sizes so that full path is not
-    always used, as Middleman using `:relative_assets` doesn't use the full
-    path.
+  - 1.0.5 Fixes id-ten-t issue.
+
+- Version 1.0.4 / 2016-April-08
+
+  - Final gem fix.
+
+- Version 1.0.3 / 2016-April-08
+
+  - Gem fixes.
+
+- Version 1.0.2 / 2016-April-08
+
+  - Fix bad gem push.
+
+- Version 1.0.1 / 2016-April-08
+
+  - css_images_sizes fixed for relative_assets
 
 - Version 1.0.0 / 2016-April-05
 
-  - Initial Release
+  - middlemac-extras
+    Initial release.

data/Rakefile

@@ -1,10 +1,212 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
+require 'bundler/gem_tasks'
+require 'cucumber/rake/task'
+require 'yard'
+require 'git'
+require File.expand_path('../lib/middlemac-extras/version.rb', __FILE__)
 
-Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList['test/**/*_test.rb']
+
+###############################################################################
+# :default
+#   Define the default task.
+###############################################################################
+task :default => :test
+
+
+###############################################################################
+# :test
+#   Perform Cucumber testing.
+###############################################################################
+Cucumber::Rake::Task.new(:test, 'Features that must pass') do |task|
+  task.cucumber_opts = '--require features --color --tags ~@wip --strict --format QuietFormatter'
+end
+
+
+###############################################################################
+# :yard
+#   Generate documentation using YARD. Note that there is a `.yardopts` file
+#   present that will load the `yard/yard_extensions.rb` file in order to
+#   control how output is generated. Output will be to the default `doc`
+#   directory using the template-grouped template, as a single page.
+###############################################################################
+YARD::Rake::YardocTask.new(:yard) do |task|
+  task.stats_options = ['--list-undoc']
+end
+
+
+###############################################################################
+# :partials
+#   Generate documentation partials using YARD. These are used by the
+#   documentation project in order to include the API documentation.
+###############################################################################
+desc 'Make separate documents for documentation_project'
+task :partials do
+
+  # Define the @!group to output file relationships.
+  sections = [
+      { :file => '_yard_helpers.erb',          :group => 'Helpers',  },
+      { :file => '_yard_helpers_extended.erb', :group => 'Extended Helpers' },
+      { :file => '_yard_config.erb',           :group => 'Extension Configuration' },
+  ]
+  
+  # Define the output directory.
+  dest = File.join('documentation_project', 'source', 'partials')
+
+  # Run YARD multiple times, filtering the group that interests us.
+  sections.each do |s|
+    params = [
+      "--query 'o.group == \"#{s[:group]}\" || has_tag?(:author)'",
+      "-o #{dest}",
+      "-t default",
+      "-p #{File.join(File.dirname(__FILE__), 'yard', 'template-partials')}"     
+     ]
+    command = "yardoc #{params.join(' ')}"
+    puts command
+    system(command)
+    File.rename( File.join(dest, 'index.html'), File.join(dest, s[:file]) )
+  end
+
+end
+
+
+###############################################################################
+# :version
+#   Displays the current version.
+###############################################################################
+desc 'Displays the current version'
+task :version do
+  puts "Current version: #{Middleman::MiddlemacExtras::VERSION}"
 end
 
-task :default => :spec
+
+###############################################################################
+# :version_finalize
+#   Remove any wip suffix from the version, as we are ready to release.
+###############################################################################
+desc 'Remove any wip suffix from the version'
+task :version_finalize do
+  version_old = Middleman::MiddlemacExtras::VERSION
+  version_new = version_old.sub('.wip', '')
+  update_version_file( version_new )
+  update_doc_file( version_new )
+  update_doc_gemfile( version_new )
+  Middleman::MiddlemacExtras.send(:remove_const, 'VERSION')
+  Middleman::MiddlemacExtras::VERSION = version_new
+end
+
+
+###############################################################################
+# :version_next_wip
+#   Increment the patch level and add a wip suffix. We are ready for work.
+###############################################################################
+desc 'Increment the patch level and add a wip suffix'
+task :version_next_wip do
+  version_old = Middleman::MiddlemacExtras::VERSION
+  version_new = version_old.sub('.wip', '').split('.')
+  version_new.last.succ!
+  version_new = version_new.join('.') + '.wip'
+  update_version_file( version_new )
+  update_doc_file( version_new )
+  update_doc_gemfile( version_new )
+  Middleman::MiddlemacExtras.send(:remove_const, 'VERSION')
+  Middleman::MiddlemacExtras::VERSION = version_new
+end
+
+
+###############################################################################
+# :log
+#   Generate the CHANGELOG.md file.
+###############################################################################
+desc 'Generate the CHANGELOG.md file'
+task :log do
+  report = ''
+  report << "middlemac-extras change log\n"
+  report << "===========================\n"
+
+  Git.open( File.expand_path('..', __FILE__) ).log.each_with_index do |l, i|
+
+    version = nil
+    if i == 0 && !l.name.start_with?('tags/')
+      version = "Version #{Middleman::MiddlemacExtras::VERSION}"
+    elsif l.name.end_with?('^0')
+      version = "Version #{l.name.match(/tags\/v(.*)\^0/)[1]}"
+    end
+    
+    if version
+      report << "\n- #{version} / #{l.date.strftime('%Y-%B-%d')}\n"
+      report << "\n"
+    end
+    
+    l.message.each_line.with_index do |line, lineno| 
+      if lineno == 0
+        report << "  - #{line}"
+      else
+        report << "    #{line}" unless line.strip == ''
+      end
+    end
+    report << "\n"
+  end # Git.open
+
+  file = File.expand_path('../CHANGELOG.md', __FILE__)
+  File.write(file, report)
+  puts "The changelog has been written."
+end
+
+
+###############################################################################
+# :pre_release
+#   Prepares the project for release.
+###############################################################################
+desc "Prepares the project for release"
+task :pre_release do
+
+  if `git status -s`.length > 0
+    puts "Cannot continue because you have uncommitted changes."
+    exit 1
+  end
+
+  Rake::Task[:version_finalize].execute
+  Rake::Task[:partials].execute
+  Rake::Task[:log].execute
+  sh "git add -A"
+  sh "git commit --amend --no-edit"
+end
+
+private
+
+
+###############################################################################
+# update_version_file
+#   Replace the version in the `version.rb` file.
+###############################################################################
+def update_version_file( version_new )
+  file = File.expand_path('../lib/middlemac-extras/version.rb', __FILE__)
+  content = File.read(file)
+  content.sub!(/(?<=VERSION = ')(.*)(?=')/, version_new)
+  File.write(file, content)
+  puts "version.rb changed to #{version_new}."
+end
+
+###############################################################################
+# update_doc_file
+#   Replace the version in the `documentation_project/config.rb` file.
+###############################################################################
+def update_doc_file( version_new )
+  file = File.expand_path('../documentation_project/config.rb', __FILE__)
+  content = File.read(file)
+  content.sub!(/(?<=def product_version).*?(?=end)/m, "\n    '#{version_new}'\n")
+  File.write(file, content)
+  puts "config.rb changed to #{version_new}."
+end
+
+###############################################################################
+# update_doc_gemfile
+#   Replace the version in the `documentation_project/Gemfile` file.
+###############################################################################
+def update_doc_gemfile( version_new )
+  file = File.expand_path('../documentation_project/Gemfile', __FILE__)
+  content = File.read(file)
+  # gem 'middlemac-extras', '~> 1.0.7.wip'
+  content.sub!(/(?<=gem 'middlemac-extras', '~> ).*(?=')/, version_new)
+  File.write(file, content)
+  puts "Gemfile changed to #{version_new}."
+end

data/documentation_project/Gemfile

@@ -9,9 +9,9 @@ gem 'wdm', '~> 0.1.0', platforms: [:mswin, :mingw]
 gem 'tzinfo-data', platforms: [:mswin, :mingw, :jruby]
 
 # Middleman Gems
-gem 'middlemac-extras', '~> 1.0.6'
-gem 'middleman', '~> 4.1.6'
+gem 'middlemac-extras', '~> 1.0.7'
+gem 'middleman', '~> 4.1.7'
 gem 'middleman-syntax'
 
 # Other required gems
-gem 'fastimage', '~> 1.9'
+gem 'fastimage', '~> 2.0'

data/documentation_project/config.rb

@@ -58,8 +58,8 @@ helpers do
   end
 
   def product_version
-    '1.0.6'
-  end
+    '1.0.7'
+end
 
   def product_uri
     'https://github.com/middlemac'

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

@@ -0,0 +1,38 @@
+---
+title:    API Reference
+blurb:    Look at the API documentation for the helpers and configuration
+          settings directly.
+layout:   template-logo-medium
+---
+
+<%= md_links %>
+<% 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="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 %>
+
+# <%= current_page.data.title %>
+<%= current_page.data.blurb %>
+
+## Configuration settings
+
+<%= partial 'partials/yard_config' %>
+
+* * *
+
+## Extended Helpers
+
+<%= partial 'partials/yard_helpers_extended' %>
+
+* * *
+
+## Helpers
+
+<%= partial 'partials/yard_helpers' %>

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

@@ -1,12 +1,12 @@
 ---
 title:     Command Line Interface
+blurb:     This gem offers a simple command line interface for building its own
+           documentation.
 layout:    template-logo-medium
 ---
 
 # <%= current_page.data.title %>
-
-`middlemac-extras` has a small command line interface that might be useful
-for generating sample documentation.
+<%= current_page.data.blurb %>
 
 The CLI takes the format:
 
@@ -44,6 +44,7 @@ bundle exec middleman server
   <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="api_reference.html">API Reference</a></li>
   <li><a href="license.html">The MIT License</a></li>
 </ul>
 <% end %>

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

@@ -2,8 +2,6 @@
 title:    Setting up config.rb
 blurb:    Review the key configuration values for making this extension work.
 layout:   template-logo-medium
-order:    40
-navigate: false
 ---
 
 <%= md_links %>
@@ -14,6 +12,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="api_reference.html">API Reference</a></li>
   <li><a href="cli.html">Command line interface</a></li>
   <li><a href="license.html">The MIT License</a></li>
 </ul>

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

@@ -4,8 +4,6 @@ blurb:    Use the <code>css_image_sizes</code> helper to specify maximum sizes
           for all of your project’s images without using unsemantic width and 
           height attributes in your HTML code.
 layout:   template-logo-medium
-order:    40
-navigate: false
 ---
 
 <%= md_links %>
@@ -16,6 +14,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="api_reference.html">API Reference</a></li>
   <li><a href="cli.html">Command line interface</a></li>
   <li><a href="license.html">The MIT License</a></li>
 </ul>
@@ -45,7 +44,7 @@ When called like this:
 
 You could use this in an HTML `<style>` element on each of your pages, or better
 yet in your layouts. This has the unfortunate effect of including it in every
-one of your pages, however, and so this sample project uses like this:
+one of your pages, however, and so this sample project uses it like this:
 
 Contents of `stylesheets/css_image_sizes.css.erb`:
 

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

@@ -3,8 +3,6 @@ title:    The <code>image_tag</code> helper
 blurb:    Find out how to use the enhanced <code>image_tag</code> helper so that
           it can be even more helpful.
 layout:   template-logo-medium
-order:    40
-navigate: false
 ---
 
 <%= md_links %>
@@ -15,6 +13,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="api_reference.html">API Reference</a></li>
   <li><a href="cli.html">Command line interface</a></li>
   <li><a href="license.html">The MIT License</a></li>
 </ul>

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

@@ -2,7 +2,6 @@
 title:    Welcome to <code>middlemac-extras</code>
 blurb:    <em>middlemac-extras</em> adds several developer conveniences.
 layout:   template-logo-large
-navigate: false
 ---
 
 <%= md_links %>
@@ -10,12 +9,10 @@ navigate: false
 # <%= current_page.data.title %>
 
 Although developed for **Middlemac**, the `middlemac-extras` extension for
-Middleman is a great way to add handy developer conveniences to your Middleman
-project.
-
-It serves as a truly “extra” extension that gathers utilities intended for
-**MiddleMac** but are generic enough that they can be used with any Middleman
-project.
+**Middleman** is a great way to add handy developer conveniences to your
+**Middleman** project. It serves as a truly “extra” extension that gathers
+utilities intended for **MiddleMac** but are generic enough that they can be
+used with any **Middleman** project.
 
 This extension currently offers features such as these:
 
@@ -48,6 +45,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.
+
+[API Reference][api_reference]
+ : Look at the API documentation for the helpers and configuration settings
+   directly.
  
 [Command Line Interface][cli]
  : This gem offers a simple command line interface for building its own

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

@@ -2,8 +2,6 @@
 title:    The MIT License
 blurb:    Describes your legal rights and obligations for using these materials.
 layout:   template-logo-medium
-order:    40
-navigate: false
 ---
 
 <%= md_links %>
@@ -15,6 +13,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="api_reference.html">API Reference</a></li>
   <li><a href="cli.html">Command line interface</a></li>
 </ul>
 <% end %>

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

@@ -3,8 +3,6 @@ title:    The <code>md_images</code> helper
 blurb:    Automatic Markdown reference style links for every image in your site
           are available by using this helper.
 layout:   template-logo-medium
-order:    40
-navigate: false
 ---
 
 <%= md_links %>
@@ -16,6 +14,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="api_reference.html">API Reference</a></li>
   <li><a href="cli.html">Command line interface</a></li>
   <li><a href="license.html">The MIT License</a></li>
 </ul>

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

@@ -4,8 +4,6 @@ blurb:    The <code>md_links</code> helper can help you by providing Markdown
           reference-style links (including title attributes) to every page in
           your site.
 layout:   template-logo-medium
-order:    40
-navigate: false
 ---
 
 <%= md_links %>
@@ -16,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="config_rb.html">Setting up <code>config.rb</code></a></li>
+  <li><a href="api_reference.html">API Reference</a></li>
   <li><a href="cli.html">Command line interface</a></li>
   <li><a href="license.html">The MIT License</a></li>
 </ul>