middleman-pagegroups 1.0.4 → 1.0.9

data/features/helpers_and_resources.feature

@@ -72,7 +72,7 @@ Feature: Provide helpers and resource items to make multiple targets easy to man
     And the file "index.html" should contain 'current_resource.brethren_next:nil'
     And the file "index.html" should contain 'current_resource.brethren_previous:nil'
     And the file "index.html" should contain 'current_resource.group_count:1'
-    And the file "index.html" should contain 'current_resource.legitimate_children:[#<Middleman::Sitemap::Resource path=sub_folder_01/index.html>, #<Middleman::Sitemap::Resource path=20_sub_folder_02/index.html>]'
+    And the file "index.html" should contain 'current_resource.legitimate_children:[#<Middleman::Sitemap::Resource path=sub_folder_01/index.html>, #<Middleman::Sitemap::Resource path=20_sub_folder_02/index.html>, #<Middleman::Sitemap::Resource path=30_nested_top/index.html>]'
     And the file "index.html" should contain 'current_resource.navigator_eligible:nil'
     And the file "index.html" should contain 'current_resource.page_group:source'
     And the file "index.html" should contain 'current_resource.page_name:index'

data/features/support/env.rb

@@ -4,17 +4,3 @@ ENV['TEST'] = 'true'
 require 'middleman'
 require 'middleman-core/step_definitions'
 require File.join(PROJECT_ROOT_PATH, 'lib', 'middleman-pagegroups')
-
-
-require 'cucumber/formatter/pretty'
-class QuietFormatter < Cucumber::Formatter::Pretty
-  def initialize(runtime, io, options)
-     $stderr = File.new( '/dev/null', 'w' )
-    super(runtime, io, options)
-  end
-  
-  def after_features(features)
-    $stderr = STDOUT
-    super(features)
-  end
-end

data/fixtures/middleman_pagegroups_app/source/30_nested_top/10_nested_sub_01/10_sibling_one.html.md.erb

@@ -0,0 +1,7 @@
+---
+title:    sibling_one
+blurb:    This is the sibling_one page.
+---
+
+#<%= current_page.data.title %>
+<%= current_page.data.blurb %>

data/fixtures/middleman_pagegroups_app/source/30_nested_top/10_nested_sub_01/20_sibling_two.html.md.erb

@@ -0,0 +1,7 @@
+---
+title:    sibling_two
+blurb:    This is the sibling_two page.
+---
+
+#<%= current_page.data.title %>
+<%= current_page.data.blurb %>

data/fixtures/middleman_pagegroups_app/source/30_nested_top/10_nested_sub_01/image.png

@@ -0,0 +1,7 @@
+---
+title:    nested_sub_02 index page
+blurb:    This is the index page for the group nested_sub_02.
+---
+
+#<%= current_page.data.title %>
+<%= current_page.data.blurb %>

data/fixtures/middleman_pagegroups_app/source/30_nested_top/10_nested_sub_01/index.html.md.erb

@@ -0,0 +1,7 @@
+---
+title:    nested_sub_01 index page
+blurb:    This is the index page for the group nested_sub_01.
+---
+
+#<%= current_page.data.title %>
+<%= current_page.data.blurb %>

data/fixtures/middleman_pagegroups_app/source/30_nested_top/20_nested_sub_02/index.html.md.erb

@@ -0,0 +1,7 @@
+---
+title:    nested_sub_02 index page
+blurb:    This is the index page for the group nested_sub_02.
+---
+
+#<%= current_page.data.title %>
+<%= current_page.data.blurb %>

data/fixtures/middleman_pagegroups_app/source/30_nested_top/20_nested_sub_02/sibling_one.html.md.erb

@@ -0,0 +1,8 @@
+---
+title:    sibling_one
+blurb:    This is the sibling_one page.
+order:    10
+---
+
+#<%= current_page.data.title %>
+<%= current_page.data.blurb %>

data/fixtures/middleman_pagegroups_app/source/30_nested_top/20_nested_sub_02/sibling_two.html.md.erb

@@ -0,0 +1,8 @@
+---
+title:    sibling_two
+blurb:    This is the sibling_two page.
+order:    20
+---
+
+#<%= current_page.data.title %>
+<%= current_page.data.blurb %>

data/fixtures/middleman_pagegroups_app/source/30_nested_top/index.html.md.erb

@@ -0,0 +1,7 @@
+---
+title:    nested_top index page
+blurb:    This is the index page for the group nested_top.
+---
+
+#<%= current_page.data.title %>
+<%= current_page.data.blurb %>

data/fixtures/middleman_pagegroups_app/source/30_nested_top/sibling_one.html.md.erb

@@ -0,0 +1,8 @@
+---
+title:    sibling_one
+blurb:    This is the sibling_one page.
+order:    30
+---
+
+#<%= current_page.data.title %>
+<%= current_page.data.blurb %>

data/fixtures/middleman_pagegroups_app/source/30_nested_top/sibling_two.html.md.erb

@@ -0,0 +1,8 @@
+---
+title:    sibling_two
+blurb:    This is the sibling_two page.
+order:    40
+---
+
+#<%= current_page.data.title %>
+<%= current_page.data.blurb %>

data/fixtures/middleman_pagegroups_app/source/image.png

@@ -0,0 +1,7 @@
+---
+title:    nested_sub_02 index page
+blurb:    This is the index page for the group nested_sub_02.
+---
+
+#<%= current_page.data.title %>
+<%= current_page.data.blurb %>

data/lib/middleman-pagegroups/extension.rb

@@ -29,7 +29,7 @@ class MiddlemanPageGroups < ::Middleman::Extension
   option :nav_toc_index_class,           nil,              'Default css class for the nav_toc_index helper/partial.'
 
   # @!group Extension Configuration
-
+  
   # @!attribute [rw] options[:strip_file_prefixes]=
   # If `true` leading numbers used for sorting files will be removed for
   # presentation purposes. This makes it possible to neatly organize your
@@ -113,19 +113,39 @@ class MiddlemanPageGroups < ::Middleman::Extension
   ############################################################
 
   #--------------------------------------------------------
-  # We must ensure that for any directory the index_file
-  # is first. This is so that we can check it for a page
-  # order and rename the containing directory in output.
+  # We want to handle shallower paths first, and ensure
+  # that for any directory the index_file is first. This
+  # gives us the ability to rename our directories if the
+  # parent directory is to be renamed.
   # @!visibility private
   #--------------------------------------------------------
   def resource_sort_comparator( x, y )
-    if File.basename(x.path) == app.config[:index_file]
-      -1
+    x_length = Pathname(x.path).each_filename.to_a.count
+    x_basename = File.basename(x.path)
+    x_dirname = File.dirname(x.path)
+    y_length = Pathname(y.path).each_filename.to_a.count
+    y_basename = File.basename(y.path)
+    y_dirname = File.dirname(y.path)
+
+    if x_length != y_length
+      return x_length <=> y_length
     else
-      if File.dirname(x.path) == File.dirname(y.path)
-        return File.basename(x.path) <=> File.basename(y.path)
+      if [x_basename, y_basename].include?(app.config[:index_file])
+        # If either is an index file, favor the index file.
+        # If both are index files, favor the path.
+        if x_basename == y_basename
+          return x_basename <=> y_basename
+        else
+          return x_basename == app.config[:index_file] ? -1 : 1
+        end
       else
-        return File.dirname(x.path) <=> File.dirname(y.path)
+        # If the dir names are the same, favor the basename,
+        # otherwise favor the entire path name.
+        if x_dirname == y_dirname
+          return x_basename <=> y_basename
+        else
+          return x_dirname <=> y_dirname
+        end
       end
     end
   end
@@ -241,7 +261,7 @@ class MiddlemanPageGroups < ::Middleman::Extension
           return nil
         else
           self.siblings
-            .find_all { |p| p.sort_order != 0 && !p.ignored }
+            .find_all { |p| p.legitimate? }
             .push(self)
             .sort_by { |p| p.sort_order }
             .find_index(self) + 1
@@ -264,7 +284,7 @@ class MiddlemanPageGroups < ::Middleman::Extension
       #--------------------------------------------------------
       def resource.brethren
         self.siblings
-          .find_all { |p| p.sort_order && p.sort_order != 0 && !p.ignored && p != self }
+          .find_all { |p| p.legitimate? && p != self }
           .sort_by { |p| p.sort_order }
       end
 
@@ -309,7 +329,7 @@ class MiddlemanPageGroups < ::Middleman::Extension
       #    use of `:navigator => false` in its front matter.
       #  * This page has a `sort_order`.
       #
-      # @return (Boolean) Returns `true` if this pages is
+      # @return (Boolean) Returns `true` if this page is
       #   eligible for a previous/next page control.
       #--------------------------------------------------------
       def resource.navigator_eligible?
@@ -320,6 +340,21 @@ class MiddlemanPageGroups < ::Middleman::Extension
       end
 
 
+      #--------------------------------------------------------
+      # Indicates whether or not a page is "legitimate" in
+      # terms of automatic navigation, based in:
+      #
+      #  * The resource has a sort order and isn't zero.
+      #  * The resource isn't ignored.
+      #
+      # @return (Boolean) Returns `true` if this pages 
+      #   participates in automatic navigation features.
+      #--------------------------------------------------------
+      def resource.legitimate?
+        self.sort_order && self.sort_order != 0 && !self.ignored
+      end
+  
+
       #--------------------------------------------------------
       # Returns an array of all of the children of this
       # resource, taking into account their eligibility for
@@ -336,7 +371,7 @@ class MiddlemanPageGroups < ::Middleman::Extension
       #--------------------------------------------------------
       def resource.legitimate_children
         self.children
-          .find_all { |p| p.sort_order && p.sort_order != 0 && !p.ignored }
+          .find_all { |p| p.legitimate? }
           .sort_by { |p| p.sort_order }
       end
 
@@ -369,10 +404,10 @@ class MiddlemanPageGroups < ::Middleman::Extension
       strip = @app.extensions[:MiddlemanPageGroups].options[:strip_file_prefixes]
       page_name = File.basename(resource.path, '.*')
       path_part = File.dirname(resource.destination_path)
+      file_renamed = false
 
       if resource.content_type && resource.content_type.start_with?('text/html', 'application/xhtml')
 
-        file_renamed = false
         # Set the resource's sort order if provided via various means.
         if resource.data.key?('order')
           # Priority for ordering goes to the :order front matter key.
@@ -391,11 +426,24 @@ class MiddlemanPageGroups < ::Middleman::Extension
 
         # Remove the sort order indicator from the file or directory name.
         # This will only change the output path for files that have a sort
-        # order. Other files in a renamed directory that needs to have their
+        # order. Other files in a renamed directory that need to have their
         # paths changed will be changed below.
         if strip && sort_order
+
           path_parts = path_part.split('/')
+
+          # Handle preceding path parts, first, if there's a grandparent (all
+          # top level items have a parent and aren't part of this case). These
+          # will have already been set because we've done shallower paths first.
+          if resource.parent && resource.parent.parent
+            parent_path_parts = File.dirname(resource.parent.destination_path).split('/')
+            path_parts = parent_path_parts + path_parts[parent_path_parts.count..-1]
+          end
+
+          # Handle our immediate directory.
           path_parts.last.sub!(/^(\d*?)_/, '')
+
+          # Join up everything and write the correct path.
           path_part = path_parts.join('/')
           name_part = page_name.sub( "#{sort_order}_", '') + File.extname( resource.path )
           if path_part == '.'

data/lib/middleman-pagegroups/version.rb

@@ -1,5 +1,5 @@
 module Middleman
     module MiddlemanPageGroups
-        VERSION = '1.0.4'
+        VERSION = '1.0.9'
     end
 end

data/middleman-pagegroups.gemspec

@@ -2,7 +2,22 @@
 $:.push File.expand_path('../lib', __FILE__)
 require 'middleman-pagegroups/version'
 
-mm_needed = ['~> 4.1', '>= 4.1.7']
+# We should work with any 4.3.x version of Middleman, but due to #2319,
+# automatic image alt attributes have been removed from Middleman, so
+# I'm adjusting the minimum requirement to the first release incorporating
+# that change.
+
+mm_needed = ['~> 4.3.0', '>= 4.3.7']
+
+# We should work with any 2.0 version of Ruby, but I'm no longer testing them
+# for regressions. Version 2.6.0 goes back to December 2018, and is a suitable
+# minimum version.
+#
+# Currently no released version of Middleman works with Ruby 3, so until that is
+# resolved, We will only support 2.6 up to and not including Ruby 3.0.
+
+rb_needed = ['~> 2.0', '>= 2.6']
+
 
 Gem::Specification.new do |s|
   s.name        = 'middleman-pagegroups'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: middleman-pagegroups
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.9
 platform: ruby
 authors:
 - Jim Derry
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-05-15 00:00:00.000000000 Z
+date: 2021-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: middleman-core
@@ -16,60 +16,60 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: 4.3.0
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.1.7
+        version: 4.3.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: 4.3.0
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.1.7
+        version: 4.3.7
 - !ruby/object:Gem::Dependency
   name: middleman-cli
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: 4.3.0
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.1.7
+        version: 4.3.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: 4.3.0
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.1.7
+        version: 4.3.7
 - !ruby/object:Gem::Dependency
   name: middleman
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: 4.3.0
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.1.7
+        version: 4.3.7
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: 4.3.0
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.1.7
+        version: 4.3.7
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -134,12 +134,14 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitattributes"
 - ".gitignore"
 - ".yardopts"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.md
 - README.md
+- README_doc.html
 - Rakefile
 - bin/middleman-pagegroups
 - documentation_project/.gitignore
@@ -201,7 +203,18 @@ files:
 - fixtures/middleman_pagegroups_app/source/20_sub_folder_02/not_legitimate.html.md.erb
 - fixtures/middleman_pagegroups_app/source/20_sub_folder_02/sibling_one.html.md.erb
 - fixtures/middleman_pagegroups_app/source/20_sub_folder_02/sibling_two.html.md.erb
+- fixtures/middleman_pagegroups_app/source/30_nested_top/10_nested_sub_01/10_sibling_one.html.md.erb
+- fixtures/middleman_pagegroups_app/source/30_nested_top/10_nested_sub_01/20_sibling_two.html.md.erb
+- fixtures/middleman_pagegroups_app/source/30_nested_top/10_nested_sub_01/image.png
+- fixtures/middleman_pagegroups_app/source/30_nested_top/10_nested_sub_01/index.html.md.erb
+- fixtures/middleman_pagegroups_app/source/30_nested_top/20_nested_sub_02/index.html.md.erb
+- fixtures/middleman_pagegroups_app/source/30_nested_top/20_nested_sub_02/sibling_one.html.md.erb
+- fixtures/middleman_pagegroups_app/source/30_nested_top/20_nested_sub_02/sibling_two.html.md.erb
+- fixtures/middleman_pagegroups_app/source/30_nested_top/index.html.md.erb
+- fixtures/middleman_pagegroups_app/source/30_nested_top/sibling_one.html.md.erb
+- fixtures/middleman_pagegroups_app/source/30_nested_top/sibling_two.html.md.erb
 - fixtures/middleman_pagegroups_app/source/_partial.md.erb
+- fixtures/middleman_pagegroups_app/source/image.png
 - fixtures/middleman_pagegroups_app/source/index.html.md.erb
 - fixtures/middleman_pagegroups_app/source/layout.erb
 - fixtures/middleman_pagegroups_app/source/sub_folder_01/10_sibling_one.html.md.erb
@@ -226,7 +239,7 @@ homepage: https://github.com/middlemac/middleman-pagegroups
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -241,12 +254,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Provides logical page groups and easy navigation for Middleman projects.
 test_files:
 - features/helpers_and_resources.feature
 - features/support/env.rb
-has_rdoc: