middleman-pagegroups 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 36b39432e2959430ad92e7a0fbc590a2b07829e3
-  data.tar.gz: f398d30caa4c9b340a8a99ee93d8590644ff9841
+  metadata.gz: 12b13f9772555307c96788be1a321eea187d4a84
+  data.tar.gz: 5b18ef759e3f15784c27a4d294f42bb56c85240a
 SHA512:
-  metadata.gz: a98612cb826a331b8ab73a1fccb06a2983e4c330d6ffae0182db84a48a7402f205bda870aefd24628d094f1bdc540b36c90c532a1ef72d7273c32c62bf3fe1ad
-  data.tar.gz: cd322348875e2fcf88235784174916f66fff02cca8ab2f346c53c5f775e97bcbce814dcce244ac05833f5d0d1045faf9cd970796de2a0e4801636a27c2728018
+  metadata.gz: bc06ed4016a0fa77187137954165d95d9e32f78b9fd2b9320ff68cbc16b8f78ffda8704072417209bc01fce257758acd4b532b85ed1b9c82c5f9bbd011c56a17
+  data.tar.gz: f0b2228d1ed3bd97b156a77b8f1d66f5be6d544c88208d03d569aa41a878f773e55150afa14530e93805b2ff54e2fd6c7dcfd3e104f17c5758a2b5b855a9182e

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,8 @@
+--no-private
+--markup=markdown
+--load yard/yard_extensions.rb
+--exclude middleman-pagegroups/version.rb
+--exclude middleman-pagegroups/partials.rb
+--one-file
+--readme yard/readme.md
+--title middleman-pagegroups

data/CHANGELOG.md

@@ -1,10 +1,30 @@
 middleman-pagegroups change log
 ===============================
 
-- Version 1.0.1 / 2016-April-03
+- Version 1.0.3 / 2016-May-11
 
-  - Fixed the bad reference to the local gem in the sample project.
+  - Support ordering on directories; documentation
+    - Replaced Middleman's `resource.parent` with fixed version that respects
+      changes to output directory names.
+    - Fixed an issue wherein HTML files in renamed directories weren't having
+      their paths corrected.
+    - Added YARDOC comments and features.
+    - Added initial Cucumber testing support.
+    - Added significant release-related functionality to the Rakefile.
+    Rakefile now generates the change log.
 
-- Version 1.0.1 / 2016-March
+- Version 1.0.2 / 2016-May-10
 
-  - Initial Release
+  - Bump to v1.0.2 to fix files that don't have a page order associated with them
+  - Cleanup
+    - Cleanup README.
+    - Remove .gem that should not have been committed.
+
+- Version 1.0.1 / 2016-May-10
+
+  - Bump to v1.0.1 to repair bad sample project
+  - Added RubyGems badge to README
+
+- Version 1.0.0 / 2016-April-03
+
+  - Version 1.0.0

data/README.md

@@ -9,7 +9,7 @@ middleman-pagegroups readme
    by topic and navigating between them. It includes support for tables of
    content, related pages, breadcrumbs, and more.
 
-   It is standalone and can be used in any Middleman project.
+   It is standalone and can be used in any **Middleman** project.
 
 
 Install the Gem
@@ -50,7 +50,7 @@ Middlemac
 ---------
 
 This Middleman extension is a critical part of
-[Middlemac](https://github.com/middlemac), the Mac OS X help building system
+[**Middlemac**](https://github.com/middlemac), the Mac OS X help building system
 for Mac OS X applications. However this gem is not Mac OS X specific and can be
 useful in any application for which you want to provide structure and
 navigation.
@@ -59,11 +59,11 @@ navigation.
 License
 -------
 
-MIT. See `LICENSE.md`.
+MIT. See [`LICENSE.md`](LICENSE.md).
 
 
 Changelog
 ---------
 
-See `CHANGELOG.md` for point changes, or simply have a look at the commit
-history for non-version changes (such as readme updates).
+See [`CHANGELOG.md`](CHANGELOG.md) for point changes, or simply have a look at
+the commit history for non-version changes (such as readme updates).

data/Rakefile

@@ -1,10 +1,204 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
+require 'bundler/gem_tasks'
+require 'cucumber/rake/task'
+require 'yard'
+require 'git'
+require File.expand_path('../lib/middleman-pagegroups/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_css.erb',      :group => 'CSS Class Helpers',  },
+      { :file => '_yard_helpers_extended.erb', :group => 'Extended Helpers' },
+      { :file => '_yard_config.erb',           :group => 'Extension Configuration' },
+      { :file => '_yard_resources.erb',        :group => 'Resource Extensions',  },
+  ]
+  
+  # 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::MiddlemanPageGroups::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::MiddlemanPageGroups::VERSION
+  version_new = version_old.sub('.wip', '')
+  update_version_file( version_new )
+  update_doc_file( version_new )
+  Middleman::MiddlemanPageGroups.send(:remove_const, 'VERSION')
+  Middleman::MiddlemanPageGroups::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::MiddlemanPageGroups::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 )
+  Middleman::MiddlemanPageGroups.send(:remove_const, 'VERSION')
+  Middleman::MiddlemanPageGroups::VERSION = version_new
+end
+
+
+###############################################################################
+# :log
+#   Generate the CHANGELOG.md file.
+###############################################################################
+desc 'Generate the CHANGELOG.md file'
+task :log do
+  report = ''
+  report << "middleman-pagegroups 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::MiddlemanPageGroups::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/middleman-pagegroups/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
 
-task :default => :spec
+
+def const_undef(const)
+  self.instance_eval { remove_const(const) }
+end

data/documentation_project/Gemfile

@@ -9,8 +9,8 @@ gem 'wdm', '~> 0.1.0', platforms: [:mswin, :mingw]
 gem 'tzinfo-data', platforms: [:mswin, :mingw, :jruby]
 
 # Middleman Gems
-gem 'middleman-pagegroups'
-gem 'middleman', '~> 4.1.6'
+gem 'middleman-pagegroups', :path => '../'
+gem 'middleman', '~> 4.1.7'
 gem 'middleman-syntax'
 
 

data/documentation_project/config.rb

@@ -14,56 +14,52 @@
 
 #==========================================================================
 # Extension Setup
-#  Note that middleman-targets adds configuration parameters to the base
-#  Middleman application (supported feature in 4.0+); there are *not*
-#  extension options. Additionally if middleman-targets is in your Gemfile
-#  then it is also activated automatically.
 #==========================================================================
-activate :MiddlemanPageGroups do |config|
+activate :MiddlemanPageGroups do |options|
 
   # Indicate whether or not numeric file name prefixes used for sorting
   # pages should be eliminated during output. This results in cleaner
   # URI's. Helpers such as `page_name` and Middleman helpers such as
   # `page_class` will reflect the pretty name.
-  config.strip_file_prefixes = true
+  options[:strip_file_prefixes] = true
 
   # Indicates whether or not Middleman's built-in `page_class` helper is
   # extended to include the page_group and page_name.
-  config.extend_page_class = true
+  options[:extend_page_class] = true
 
   # the following options provide defaults for the built-in helpers, and
   # also work with the sample partials if you choose to install them.
   # They'll also work in your own partials and helpers, of course.
 
   # Default css class for the nav_breadcrumbs helper/partial.
-  config.nav_breadcrumbs_class = 'breadcrumbs'
+  options[:nav_breadcrumbs_class] = 'breadcrumbs'
 
   # Default css class for the nav_breadcrumbs_alt helper/partial.
-  config.nav_breadcrumbs_alt_class = 'breadcrumbs'
+  options[:nav_breadcrumbs_alt_class] = 'breadcrumbs'
 
   # Default "current page" label for the nav_breadcrumbs_alt helper/partial.
-  config.nav_breadcrumbs_alt_label = 'Current page'
+  options[:nav_breadcrumbs_alt_label] = 'Current page'
 
   # Default css class for the nav_brethren helper/partial.
-  config.nav_brethren_class = 'table_contents'
+  options[:nav_brethren_class] = 'table_contents'
 
   # Default css class for the nav_brethren_index helper/partial.
-  config.nav_brethren_index_class = 'related-topics'
+  options[:nav_brethren_index_class] = 'related-topics'
 
   # Default css class for the nav_legitimate_children helper/partial.
-  config.nav_legitimate_children_class = 'table_contents'
+  options[:nav_legitimate_children_class] = 'table_contents'
 
   # Default css class for the nav_prev_next helper/partial.
-  config.nav_prev_next_class = 'navigate_prev_next'
+  options[:nav_prev_next_class] = 'navigate_prev_next'
 
   # Default "previous" label text for the nav_prev_next helper/partial.
-  config.nav_prev_next_label_prev = 'Previous'
+  options[:nav_prev_next_label_prev] = 'Previous'
 
   # Default "next" label text for the nav_prev_next helper/partial.
-  config.nav_prev_next_label_next = 'Next'
+  options[:nav_prev_next_label_next] = 'Next'
 
   # Default css class for the nav_toc_index helper/partial.
-  config.nav_toc_index_class = 'help_map'
+  options[:nav_toc_index_class] = 'help_map'
 
 end
 
@@ -90,8 +86,8 @@ helpers do
   end
 
   def product_version
-    '1.0.2'
-  end
+    '1.0.3'
+end
 
   def product_uri
     'https://github.com/middlemac'

data/documentation_project/source/documentation/100_nested_folder/another_file.html.md.erb

@@ -0,0 +1,19 @@
+---
+title:    Another File
+blurb:    This is just a file with a sort order of 10 specified in its front
+          matter.
+layout:   template-logo-medium
+order:    10
+---
+
+# <%= current_page.data.title %>
+
+<%= current_page.data.blurb %>
+
+Current Page: <%= current_page.url %>
+
+Parent: <%= current_page.parent.url %>
+
+<% siblings = current_page.siblings.collect { |p| p.url } %>
+Siblings: <%= siblings %>
+

data/documentation_project/source/documentation/100_nested_folder/index.html.md.erb

@@ -0,0 +1,25 @@
+---
+title:     Nested Group Example
+blurb:     See an example of a nested group, where sort order is specified only
+           by the front matter.
+layout:    template-logo-large
+navigator: false
+---
+
+# <%= current_page.data.title %>
+
+- All of these documents are part of the `nested_folder` group. This is because
+  the source directory they reside in is named `nested_folder/`.
+
+- This particular page is the index page of the group, and is considered the
+  parent of all of the other files.
+  
+  - This page does not have an `:order` key set; its order is based on its
+    original containing directory name.  
+
+  - The other pages are set via their `:order` keys instead of a via a naming
+    prefix.
+
+* * *
+
+<%= nav_legitimate_children :class => 'table_contents' %>