middlemac-extras 1.0.6 → 1.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 31a65dd425ee55202ee06644b77dc24aa1a902eb
-  data.tar.gz: e3f7ac7e9f4d119285a0574bfcf698b154f8756f
+SHA256:
+  metadata.gz: 62c558839c6210edb90fc9af6769a000b2a5192de0a047e796ee67796d759ae1
+  data.tar.gz: 862e1a8f7d748db8d981d55c492a1ffb309f4b4944047d88e5a55e3706cc1811
 SHA512:
-  metadata.gz: 683a523261e3c37fc8bedcb054e77037b5e2ac69d372b73e3261acea6c4b7f1bfcc935aeb064962a99f34293ae639518567fa8bfbe21922f3b0617b521ecc41e
-  data.tar.gz: 0c67ae4502826c5bfdc4288954cc976a9ed708f2a0bbeb6bb0b3103e9a5e9520d8e12ad63bb127f7246d9f209dbc56080a40c1c157faf1babfe455f4ccfd567b
+  metadata.gz: b3333535b3f47c533f8faac58372a6a142d0d1a0dfc3c6a7fa81cc85be1702bf224628283966b02ea7eca25c04b1fc7f81d89ad6fe2619d0df718a1f6e69719c
+  data.tar.gz: c0132e7a7791a8010673d0f28211d9f41dfa951d3f5db6127ede91792ae27b0381d18a31cf650d5a12b0ada230f03e73db17002e5cbe21857e70edc8a28f50b2

data/.gitattributes

@@ -0,0 +1,4 @@
+*.html linguist-documentation
+*.css linguist-documentation
+*.erb linguist-documentation
+*.js linguist-documentation

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,65 @@
 middlemac-extras change log
 ===========================
 
+- Version 1.0.11 / 2021-April-12
+
+  - Updated Ruby version requirements to make it clear that Ruby 3.0+ is not yet
+    supported.
+    Updated test task so that default task doesn't use the noisy version with deprecation
+    warnings, and to remove the advertisement at the end of output.
+    Removed support for automatic_image_tags, which was removed due to middleman
+    issue #2319.
+  - Added .gitattributes for proper language reporting in GitHub.
+    No version bump.
+    No new gem.
+
+- Version 1.0.10 / 2018-April-28
+
+  - Update to 1.0.10 for use with newer middlemac.
+
+- Version 1.0.9 / 2018-April-28
+
+  - 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.
+
+- Version 1.0.7 / 2016-May-11
+
+  - Version 1.0.7 supports RAKE, Yard, etc.
+      - YARD support added.
+      - Cucumber tests added.
+      - Documentation project updates.
+      - Source code commented extensively for YARD.
+
 - 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.
+  - 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-07
+
+  - 1.0.5 Fixes id-ten-t issue.
+
+- Version 1.0.4 / 2016-April-07
+
+  - Final gem fix.
+
+- Version 1.0.3 / 2016-April-07
+
+  - Gem fixes.
+
+- Version 1.0.2 / 2016-April-07
+
+  - Fix bad gem push.
 
-- Version 1.0.5 / 2016-April-08
+- Version 1.0.1 / 2016-April-07
 
-  - 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.
+  - 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,209 @@
-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 = '--publish-quiet --require features --color --tags "not @wip" --strict --format pretty 2>/dev/null'
 end
 
-task :default => :spec
+Cucumber::Rake::Task.new(:testnoisy, 'Features that must pass') do |task|
+  task.cucumber_opts = '--publish-quiet --require features --color --tags "not @wip" --strict --format pretty'
+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
+
+
+###############################################################################
+# :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_versions( 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_versions( version_new )
+end
+
+
+###############################################################################
+# :version_set
+#   Sets an arbitrary version.
+###############################################################################
+desc 'Sets all of the files to the version specified. Use rake version_set[value].'
+task :version_set, :new_version do |t, args|
+  update_versions( args[:new_version] )
+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_versions
+#   Update the version in various files that depend on the correct version.
+###############################################################################
+def update_versions( version_new )
+  [ {
+      :file  => File.expand_path('../lib/middlemac-extras/version.rb', __FILE__),
+      :regex => /(?<=VERSION = ')(.*)(?=')/
+    },
+    {
+      :file  => File.expand_path('../documentation_project/Gemfile', __FILE__),
+      :regex => /(?<=gem 'middlemac-extras', '~> ).*(?=')/
+    },
+    {
+      :file  => File.expand_path('../documentation_project/config.rb', __FILE__),
+      :regex => /(?<=def product_version\n    ').*?(?='\n  end)/m
+    },
+  ].each do | item |
+    
+    content = File.read( item[:file] )
+    content.gsub!( item[:regex], version_new )
+    File.write( item[:file], content )
+    puts "#{File.basename( item[:file] )} changed to '#{version_new}'."
+  end
+
+  Middleman::MiddlemacExtras::VERSION.replace 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.11'
+gem 'middleman', '~> 4.3.7'
 gem 'middleman-syntax'
 
 # Other required gems
-gem 'fastimage', '~> 1.9'
+gem 'fastimage', '~> 2.0'

data/documentation_project/config.rb

@@ -13,7 +13,7 @@
 #  so it's best to make sure they're activated first.
 #==========================================================================
 # activate :MiddlemanPageGroups
-activate :automatic_alt_tags
+
 
 #==========================================================================
 # Extension Setup
@@ -58,11 +58,7 @@ helpers do
   end
 
   def product_version
-    '1.0.6'
-  end
-
-  def product_uri
-    'https://github.com/middlemac'
+    '1.0.11'
   end
 
 end

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>