middleman-pagegroups 1.0.2 → 1.0.3

data/lib/middleman-pagegroups/partials.rb

@@ -1,14 +1,12 @@
 ################################################################################
-# partials
-#  Here's the deal: this is an extension and not an extension+template, so in
-#  order to provide some modicum of usefulness to users, we're providing some
-#  template-like helpers in the extension. This file constitutes the source
-#  for them, with the added benefit that we can recycle the values in the
-#  console application and generate real partial templates for users that
-#  prefer pure MVC.
+# Given that `middleman-pagegroups` is an extension and not a template, we
+# don’t have partials. However we are capable of building the partials using
+# the CLI, and using this same code base provide helpers.
+#
+# Because of recursion, `MM_TOC_INDEX` will only be used to build a partial;
+# the helper internally generates identical output but is constructed just a
+# bit differently.
 ################################################################################
-
-
 module MMPartials
 
   MM_BREADCRUMBS = <<HEREDOC
@@ -156,8 +154,8 @@ HEREDOC
 
 
   #########################################################
-  # MM_PARTIALS
-  #  Used by the CLI application to build partial files.
+  # The CLI application will use this array to generate
+  # partials using the given :filename with the :content.
   #########################################################
   MM_PARTIALS = [
       { :filename => '_nav_breadcrumbs.haml',         :content => MM_BREADCRUMBS         },
@@ -169,5 +167,4 @@ HEREDOC
       { :filename => '_nav_toc_index.haml',           :content => MM_TOC_INDEX           },
   ]
 
-
 end # module

data/lib/middleman-pagegroups/version.rb

@@ -1,5 +1,5 @@
 module Middleman
     module MiddlemanPageGroups
-        VERSION = '1.0.2'
+        VERSION = '1.0.3'
     end
 end

data/middleman-pagegroups.gemspec

@@ -2,6 +2,8 @@
 $:.push File.expand_path('../lib', __FILE__)
 require 'middleman-pagegroups/version'
 
+mm_needed = ['~> 4.1', '>= 4.1.7']
+
 Gem::Specification.new do |s|
   s.name        = 'middleman-pagegroups'
   s.version     = Middleman::MiddlemanPageGroups::VERSION
@@ -19,8 +21,14 @@ Gem::Specification.new do |s|
   s.require_paths = ['lib']
   
   # The version of middleman-core your extension depends on
-  s.add_runtime_dependency('middleman-core', ['~> 4.1', '>= 4.1.6'])
+  s.add_runtime_dependency('middleman-core', mm_needed)
 
   # Additional dependencies
-  s.add_runtime_dependency('middleman-cli', ['~> 4.1', '>= 4.1.6'])
+  s.add_runtime_dependency('middleman-cli', mm_needed)
+
+  # Development dependencies
+  s.add_development_dependency 'middleman', mm_needed
+  s.add_development_dependency 'bundler',   '>= 1.6'
+  s.add_development_dependency 'rake',      '>= 10.3'
+  s.add_development_dependency 'git'
 end

data/yard/readme.md

@@ -0,0 +1,5 @@
+This gem provides advanced navigation tools and helpers for grouping pages
+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.

data/yard/template-grouped/default/module/html/method_details_list.erb

@@ -0,0 +1,11 @@
+<% scopes(method_listing(false)) do |list, scope| %>
+  <div id="<%= scope %>_method_details" class="method_details_list">
+    <% groups = list.group_by { |g| g.group.nil? ? 'ZZZ' : g.group }.sort.to_h %>
+    <% groups.each_value do |group| %>
+      <h2><%= group[0].group || "#{scope.to_s.capitalize} Method Details" %></h2>
+      <% group.each_with_index do |meth, i| %>
+        <%= yieldall :object => meth, :owner => object, :index => i %>
+      <% end %>
+    <% end %>
+  </div>
+<% end %>

data/yard/template-partials/default/method_details/setup.rb

@@ -0,0 +1,4 @@
+def init
+  super
+  sections :header, [:method_signature, T('docstring')]
+end

data/yard/template-partials/default/module/html/attribute_details.erb

@@ -0,0 +1,9 @@
+<% scopes(attr_listing) do |list, scope| %>
+  <div id="<%= scope %>_attr_details" class="attr_details">
+    <% list.each_with_index do |meth, i| %>
+      <% rw = meth.attr_info %>
+      <span id="<%= anchor_for(rw[meth.reader? ? :write : :read]) %>"></span>
+      <%= yieldall :object => meth, :owner => object, :index => i %>
+    <% end %>
+  </div>
+<% end %>

data/yard/template-partials/default/module/html/method_details_list.erb

@@ -0,0 +1,10 @@
+<% scopes(method_listing(false)) do |list, scope| %>
+  <div class="method_details_list">
+    <% groups = list.group_by { |g| g.group.nil? ? 'ZZZ' : g.group }.sort.to_h %>
+    <% groups.each_value do |group| %>
+      <% group.each_with_index do |meth, i| %>
+        <%= yieldall :object => meth, :owner => object, :index => i %>
+      <% end %>
+    <% end %>
+  </div>
+<% end %>

data/yard/template-partials/default/module/setup.rb

@@ -0,0 +1,6 @@
+include Helpers::ModuleHelper
+
+def init
+  sections :attribute_details, [T('method_details')],
+           :method_details_list, [T('method_details')]
+end

data/yard/template-partials/default/onefile/html/layout.erb

@@ -0,0 +1 @@
+<%= yieldall %>

data/yard/template-partials/default/onefile/html/setup.rb

@@ -0,0 +1,4 @@
+def init
+  super
+  sections :layout, [:all_objects]
+end

data/yard/yard_extensions.rb

@@ -0,0 +1,109 @@
+##########################################################################
+# Our template groups the methods by @group instead of lumping all of 
+# them together as instance methods. This is because most of them simply
+# *aren't* instance methods but rather helpers or resource methods.
+# This template will be used by default because .yardopts loads this
+# file; however `rake partials` will override this template via the
+# command line in order to use the `template-partials` instead.
+##########################################################################
+YARD::Templates::Engine.register_template_path File.join(File.dirname(__FILE__), 'template-grouped')
+
+##########################################################################
+# Force Yard to parse the helpers block in a Middleman extension.
+#
+#  * Assign a generic "Helpers" group to each item if they don't have
+#    their own @group assignment. Note that @!group doesn't work in this
+#    section.
+#  * Add a @note to each item to distinguish them in a mixed up instance
+#    method detail section.
+##########################################################################
+class HelpersHandler < YARD::Handlers::Ruby::Base
+  handles method_call(:helpers)
+  namespace_only
+
+  def process
+
+    statement.last.last.each do |node|
+
+      extra = ''
+
+      # Find out if there's a @group assigned.
+      extra << '@group Helpers' unless node.docstring.match(/^@group (.*?)$/i)
+
+      # Clean up the doc string because we like - and = borders.
+      # Force the note and group on each of these "fake" methods.
+      if node.docstring
+        docstring = node.docstring
+        docstring = docstring.gsub(/^[\-=]+\n/, '')
+        docstring = docstring.gsub(/[\-=]+$/, '')
+        docstring << extra
+        node.docstring = docstring
+      else
+        node.docstring = extra
+      end
+
+      parse_block(node, :owner => self.owner)
+    end # do
+
+  end # def
+
+end # class
+
+
+##########################################################################
+# Force Yard to parse the resources.each block in a Middleman extension.
+#
+#  * Assign a generic "Resource Extensions" group to each item if they
+#    don't have their own @group assignment. Note that @!group
+#    doesn't work in this section.
+#  * Force each item to have a `@visibility public` because we will
+#    probably have `@visibility private` in the wrapping method.
+#  * Add a @note to each item to distinguish them in a mixed up instance
+#    method detail section.
+##########################################################################
+class ResourcesHandler < YARD::Handlers::Ruby::Base
+  handles :def
+  namespace_only
+
+  def process
+    extra = <<HEREDOC
+@visibility public
+HEREDOC
+
+    return unless statement.method_name(true).to_sym == :manipulate_resource_list
+
+    # Block consists of everything in the actual `do` block
+    block = statement.last.first.last.last
+    block.each do | node |
+      if node.type == :defs
+        # Clean up the doc string because we like - and = borders.
+        # Force the note and public on each of these "fake" methods.
+        if node.docstring
+          docstring = node.docstring
+          docstring = docstring.gsub(/^[\-=]+\n/, '')
+          docstring = docstring.gsub(/[\-=]+$/, '')
+          docstring << extra
+        else
+          docstring = extra
+        end
+
+        # Find out if there's a @group assigned.
+        if ( group = docstring.match(/^@group (.*?)$/i) )
+          group = group[1]
+        else
+          group = 'Resource Extensions'
+        end
+
+        def_name = node[2][0]
+        object = YARD::CodeObjects::MethodObject.new(namespace, "resource.#{def_name}")
+        register(object)
+        object.dynamic = true
+        object.source = node.source.clone
+        object[:docstring] = docstring
+        object[:group] = group
+      end
+    end # do
+
+  end # def
+
+end # class

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: middleman-pagegroups
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Jim Derry
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-05 00:00:00.000000000 Z
+date: 2016-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: middleman-core
@@ -19,7 +19,7 @@ dependencies:
         version: '4.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.1.6
+        version: 4.1.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '4.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.1.6
+        version: 4.1.7
 - !ruby/object:Gem::Dependency
   name: middleman-cli
   requirement: !ruby/object:Gem::Requirement
@@ -39,7 +39,7 @@ dependencies:
         version: '4.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.1.6
+        version: 4.1.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -49,7 +49,69 @@ dependencies:
         version: '4.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.1.6
+        version: 4.1.7
+- !ruby/object:Gem::Dependency
+  name: middleman
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.7
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.3'
+- !ruby/object:Gem::Dependency
+  name: git
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Provides logical page groups and easy navigation for Middleman projects.
 email:
 - balthisar@gmail.com
@@ -59,6 +121,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".yardopts"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.md
@@ -69,6 +132,10 @@ files:
 - documentation_project/Gemfile
 - documentation_project/README.md
 - documentation_project/config.rb
+- documentation_project/source/documentation/100_nested_folder/another_file.html.md.erb
+- documentation_project/source/documentation/100_nested_folder/index.html.md.erb
+- documentation_project/source/documentation/100_nested_folder/one_file.html.md.erb
+- documentation_project/source/documentation/100_nested_folder/stray.txt
 - documentation_project/source/documentation/10_concepts.html.md.erb
 - documentation_project/source/documentation/20_directory_organization.html.md.erb
 - documentation_project/source/documentation/30_frontmatter.html.md.erb
@@ -77,6 +144,7 @@ files:
 - documentation_project/source/documentation/60_sample_partials.html.md.erb
 - documentation_project/source/documentation/70_sample_layouts.html.md.erb
 - documentation_project/source/documentation/80_config.html.md.erb
+- documentation_project/source/documentation/90_cli.html.md.erb
 - documentation_project/source/documentation/index.html.md.erb
 - documentation_project/source/documentation/ovum.html.md.erb
 - documentation_project/source/fonts/font-awesome/FontAwesome.otf
@@ -101,17 +169,45 @@ files:
 - documentation_project/source/partials/_nav_legitimate_children.haml
 - documentation_project/source/partials/_nav_prev_next.haml
 - documentation_project/source/partials/_nav_toc_index.haml
+- documentation_project/source/partials/_yard_config.erb
+- documentation_project/source/partials/_yard_helpers.erb
+- documentation_project/source/partials/_yard_helpers_css.erb
+- documentation_project/source/partials/_yard_helpers_extended.erb
+- documentation_project/source/partials/_yard_resources.erb
 - documentation_project/source/stylesheets/_github.scss
 - documentation_project/source/stylesheets/_middlemac_minimal.scss
 - documentation_project/source/stylesheets/_normalize.scss
 - documentation_project/source/stylesheets/breadcrumb-separator-light.png
 - documentation_project/source/stylesheets/style.css.scss
 - documentation_project/source/toc.html.md.erb
+- features/helpers_and_resources.feature
+- features/support/env.rb
+- fixtures/middleman_pagegroups_app/config.rb
+- fixtures/middleman_pagegroups_app/source/20_sub_folder_02/index.html.md.erb
+- 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/_partial.md.erb
+- 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
+- fixtures/middleman_pagegroups_app/source/sub_folder_01/20_sibling_two.html.md.erb
+- fixtures/middleman_pagegroups_app/source/sub_folder_01/30_sibling_three.html.md.erb
+- fixtures/middleman_pagegroups_app/source/sub_folder_01/index.html.md.erb
 - lib/middleman-pagegroups.rb
 - lib/middleman-pagegroups/extension.rb
 - lib/middleman-pagegroups/partials.rb
 - lib/middleman-pagegroups/version.rb
 - middleman-pagegroups.gemspec
+- yard/readme.md
+- yard/template-grouped/default/module/html/method_details_list.erb
+- yard/template-partials/default/method_details/setup.rb
+- yard/template-partials/default/module/html/attribute_details.erb
+- yard/template-partials/default/module/html/method_details_list.erb
+- yard/template-partials/default/module/setup.rb
+- yard/template-partials/default/onefile/html/layout.erb
+- yard/template-partials/default/onefile/html/setup.rb
+- yard/yard_extensions.rb
 homepage: https://github.com/middlemac/middleman-pagegroups
 licenses:
 - MIT
@@ -136,5 +232,7 @@ rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Provides logical page groups and easy navigation for Middleman projects.
-test_files: []
+test_files:
+- features/helpers_and_resources.feature
+- features/support/env.rb
 has_rdoc: