middleman-pagegroups 1.0.2 → 1.0.3

data/documentation_project/source/stylesheets/_middlemac_minimal.scss

@@ -666,3 +666,290 @@ div.image_article:after
 	display: table;
 	clear: both;
 }
+
+//*************************************
+//	For partials extracted from YARD
+//*************************************
+
+$yard_color_symbol: rgba(0,136,204,1);
+$yard_font_mono: Menlo, Consolas, Monaco, Courier, monospace;
+
+div.attr_details,
+div.method_details_list,
+dl.examples_list
+{
+	.inline
+	{
+		display: inline;
+
+		p:first-child
+		{
+			display: inline;
+		}
+	}
+
+	.method_details
+	{
+		border-top: 1px dotted #aaa;
+		margin-top: 15px;
+		padding-top: 0;
+
+		&.first
+		{
+			border: 0;
+		}
+	}
+
+	p.signature,
+	h3.signature,
+	dt
+	{
+		font-size: 0.9em;
+		font-weight: normal;
+		font-family: $yard_font_mono;
+		padding: 6px 10px;
+		margin-top: 18px;
+		background: #f2f3ff;
+		border: 1px solid #d8d8e5;
+		-moz-border-radius: 3px;
+		-webkit-border-radius: 3px;
+		color: $yard_color_symbol;
+
+		strong
+		{
+			color: inherit;;
+		}
+
+		tt
+		{
+			font-family: inherit;
+		}
+
+		.overload
+		{
+			display: block;
+		}
+
+		.extras
+		{
+			font-weight: normal;
+			font-family: sans-serif;
+			color: #444;
+			font-size: 1em;
+		}
+
+		.not_defined_here,
+		.aliases
+		{
+			display: block;
+			font-weight: normal;
+			font-size: 0.9em;
+			font-family: $yard_font_mono;
+			margin-top: 0px;
+			color: #555;
+
+			.names
+			{
+				font-family: $yard_font_mono;
+				font-weight: bold;
+				color: #000;
+				font-size: 1.2em;
+			}
+		}
+	}
+	
+	dt
+	{
+	    font-weight: bold;
+	}
+
+	div.docstring
+	{
+		div.discussion
+		{
+
+		}
+	}
+
+	div.tags
+	{
+		margin-bottom: 12px;
+
+		.tag_title
+		{
+			font-size: 1em;
+			margin-bottom: 0;
+			font-weight: bold; }
+
+		ul
+		{
+			margin-top: 5px;
+			padding-left: 30px;
+			list-style: square;
+
+			li {
+				margin-bottom: 3px;
+			}
+
+			.name
+			{
+				font-family: $yard_font_mono;
+				font-weight: bold;
+			}
+
+			.note
+			{
+				padding: 3px 6px;
+			}
+
+		}
+
+		.examples
+		{
+			.tag_title
+			{
+				margin-bottom: 10px;
+				font-weight: bold;
+			}
+
+			.inline p
+			{
+				padding: 0;
+				margin: 0;
+				margin-left: 15px;
+				font-weight: bold;
+				font-size: 0.9em;
+			}
+		}
+
+		.overload
+		{
+			.overload_item
+			{
+				list-style: none;
+				margin-bottom: 25px;
+
+				.signature
+				{
+					padding: 2px 8px;
+					background: #e5e8ff;
+					border: 1px solid #d8d8e5;
+					-moz-border-radius: 3px;
+					-webkit-border-radius: 3px;
+				}
+			}
+
+			.signature
+			{ margin-left: -15px;
+				font-family: monospace;
+				display: block;
+				font-size: 1.1em;
+			}
+
+			.docstring
+			{
+				margin-top: 15px;
+			}
+
+		}
+
+		/* syntax highlighting */
+		//.source_code { display: none; padding: 3px 8px; border-left: 8px solid #ddd; margin-top: 5px; }
+		//#filecontents pre.code, .docstring pre.code, .source_code pre { font-family: monospace; }
+		//#filecontents pre.code, .docstring pre.code { display: block; }
+		//.source_code .lines { padding-right: 12px; color: #555; text-align: right; }
+
+		#filecontents pre.code,
+		.docstring pre.code,
+		pre.example
+		{
+			padding: 5px 12px; margin-top: 4px; border: 1px solid #eef; background: #f5f5ff;
+		}
+
+		pre.code
+		{
+			color: #000;
+
+			info.file { color: #555; }
+
+			.val { color: #036A07; }
+
+			.tstring_content,
+			.heredoc_beg,
+			.heredoc_end,
+			.qwords_beg,
+			.qwords_end,
+			.tstring,
+			.dstring
+			{
+				color: #036A07;
+			}
+
+			.fid,
+			.rubyid_new,
+			.rubyid_to_s,
+			.rubyid_to_sym,
+			.rubyid_to_f,
+			.dot + pre.code .id,
+			.rubyid_to_i pre.code .rubyid_each
+			{
+				color: #0085FF;
+			}
+
+			.comment
+			{
+				color: #0066FF;
+			}
+
+			.const,
+			.constant
+			{
+				color: #585CF6;
+			}
+
+			.label,
+			.symbol
+			{
+				color: #C5060B;
+			}
+
+			.kw,
+			.rubyid_require,
+			.rubyid_extend,
+			.rubyid_include
+			{
+				color: #0000FF;
+			}
+
+			.ivar
+			{
+				color: #318495;
+			}
+
+			.gvar,
+			.rubyid_backref,
+			.rubyid_nth_ref
+			{
+				color: #6D79DE;
+			}
+
+			.regexp,
+			.dregexp
+			{
+				color: #036A07;
+			}
+
+			a
+			{
+				border-bottom: 1px dotted #bbf;
+			}
+
+		}
+	}
+
+	table.source_code
+	{
+		display: none;
+	}
+
+}

data/features/helpers_and_resources.feature

@@ -0,0 +1,120 @@
+Feature: Provide helpers and resource items to make multiple targets easy to manage.
+
+  As a software developer
+  I want to use helpers and resource items
+  In order to enable automatic navigation of items.
+  
+  Background:
+    Given a built app at "middleman_pagegroups_app"
+    
+  Scenario:
+    Source files and directories with prefixes must be built without 
+    prefixes, and all files must be present when built.
+    When I cd to "build"
+    Then the following directories should exist:
+      | sub_folder_01 |
+      | sub_folder_02 |
+    And the following files should exist:
+      | index.html                        |
+      | sub_folder_01/index.html          |
+      | sub_folder_01/sibling_one.html    |
+      | sub_folder_01/sibling_two.html    |
+      | sub_folder_01/sibling_three.html  |
+      | sub_folder_02/index.html          |
+      | sub_folder_02/sibling_one.html    |
+      | sub_folder_02/sibling_two.html    |
+      | sub_folder_02/not_legitimate.html |
+    And the following directories should not exist:
+      | 20_sub_folder_02 |
+    And the following files should not exist:
+      | index.html    |
+      | sub_folder_01/10_sibling_one.html    |
+      | sub_folder_01/20_sibling_two.html    |
+      | sub_folder_01/30_sibling_three.html  |
+
+  
+  Scenario: The CSS Class Helpers provide correct values when used.
+    When I cd to "build"
+    And the file "index.html" should contain 'nav_breadcrumbs_alt_class: breadcrumbs'
+    And the file "index.html" should contain 'nav_breadcrumbs_alt_label: Current page'
+    And the file "index.html" should contain 'nav_breadcrumbs_class: breadcrumbs'
+    And the file "index.html" should contain 'nav_brethren_class: table_contents'
+    And the file "index.html" should contain 'nav_brethren_index_class: related-topics'
+    And the file "index.html" should contain 'nav_legitimate_children_class: table_contents'
+    And the file "index.html" should contain 'nav_prev_next_class: navigate_prev_next'
+    And the file "index.html" should contain 'nav_prev_next_label_next: Next'
+    And the file "index.html" should contain 'nav_prev_next_label_prev: Previous'
+    And the file "index.html" should contain 'nav_toc_index_class: breadcrumbs'
+
+
+  Scenario: The extended page_classes helper provides correct values when used.
+    When I cd to "build"
+    And the file "index.html" should contain 'page_classes: index source'
+    When I cd to "sub_folder_01"
+    And the file "index.html" should contain 'page_classes: index sub_folder_01'
+    And the file "sibling_one.html" should contain 'page_classes: sibling_one sub_folder_01'
+    And the file "sibling_two.html" should contain 'page_classes: sibling_two sub_folder_01'
+    And the file "sibling_three.html" should contain 'page_classes: sibling_three sub_folder_01'
+    When I cd to "../sub_folder_02"
+    And the file "index.html" should contain 'page_classes: index sub_folder_02'
+    And the file "sibling_one.html" should contain 'page_classes: sibling_one sub_folder_02'
+    And the file "sibling_two.html" should contain 'page_classes: sibling_two sub_folder_02'
+    And the file "not_legitimate.html" should contain 'page_classes: not_legitimate sub_folder_02'
+
+
+  Scenario:
+    The resource extensions must deliver correct results when used, ensuring
+    that helpers and partials will have access to the correct data for
+    rendering. 
+    When I cd to "build"
+    And the file "index.html" should contain 'current_resource.breadcrumbs:[#<Middleman::Sitemap::Resource path=index.html>]'
+    And the file "index.html" should contain 'current_resource.brethren:[]'
+    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.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'
+    And the file "index.html" should contain 'current_resource.page_sequence:nil'
+    And the file "index.html" should contain 'current_resource.parent:nil'
+    And the file "index.html" should contain 'current_resource.sort_order:0'
+
+
+  Scenario:
+    The resource extensions must deliver correct results when used, ensuring
+    that helpers and partials will have access to the correct data for
+    rendering. 
+    When I cd to "build/sub_folder_01/"
+    And the file "sibling_two.html" should contain 'current_resource.breadcrumbs:[#<Middleman::Sitemap::Resource path=index.html>, #<Middleman::Sitemap::Resource path=sub_folder_01/index.html>, #<Middleman::Sitemap::Resource path=sub_folder_01/20_sibling_two.html>]'
+    And the file "sibling_two.html" should contain 'current_resource.brethren:[#<Middleman::Sitemap::Resource path=sub_folder_01/10_sibling_one.html>, #<Middleman::Sitemap::Resource path=sub_folder_01/30_sibling_three.html>]'
+    And the file "sibling_two.html" should contain 'current_resource.brethren_next:#<Middleman::Sitemap::Resource path=sub_folder_01/30_sibling_three.html>'
+    And the file "sibling_two.html" should contain 'current_resource.brethren_previous:#<Middleman::Sitemap::Resource path=sub_folder_01/10_sibling_one.html>'
+    And the file "sibling_two.html" should contain 'current_resource.group_count:3'
+    And the file "sibling_two.html" should contain 'current_resource.legitimate_children:[]'
+    And the file "sibling_two.html" should contain 'current_resource.navigator_eligible:true'
+    And the file "sibling_two.html" should contain 'current_resource.page_group:sub_folder_01'
+    And the file "sibling_two.html" should contain 'current_resource.page_name:sibling_two'
+    And the file "sibling_two.html" should contain 'current_resource.page_sequence:2'
+    And the file "sibling_two.html" should contain 'current_resource.parent:#<Middleman::Sitemap::Resource path=sub_folder_01/index.html>'
+    And the file "sibling_two.html" should contain 'current_resource.sort_order:20'
+
+
+  Scenario:
+    The resource extensions must deliver correct results when used, ensuring
+    that helpers and partials will have access to the correct data for
+    rendering. 
+    When I cd to "build/sub_folder_02/"
+    And the file "sibling_one.html" should contain 'current_resource.breadcrumbs:[#<Middleman::Sitemap::Resource path=index.html>, #<Middleman::Sitemap::Resource path=20_sub_folder_02/index.html>, #<Middleman::Sitemap::Resource path=20_sub_folder_02/sibling_one.html>]'
+    And the file "sibling_one.html" should contain 'current_resource.brethren:[#<Middleman::Sitemap::Resource path=20_sub_folder_02/sibling_two.html>]'
+    And the file "sibling_one.html" should contain 'current_resource.brethren_next:#<Middleman::Sitemap::Resource path=20_sub_folder_02/sibling_two.html>'
+    And the file "sibling_one.html" should contain 'current_resource.brethren_previous:nil'
+    And the file "sibling_one.html" should contain 'current_resource.group_count:2'
+    And the file "sibling_one.html" should contain 'current_resource.legitimate_children:[]'
+    And the file "sibling_one.html" should contain 'current_resource.navigator_eligible:nil'
+    And the file "sibling_one.html" should contain 'current_resource.page_group:sub_folder_02'
+    And the file "sibling_one.html" should contain 'current_resource.page_name:sibling_one'
+    And the file "sibling_one.html" should contain 'current_resource.page_sequence:1'
+    And the file "sibling_one.html" should contain 'current_resource.parent:#<Middleman::Sitemap::Resource path=20_sub_folder_02/index.html>'
+    And the file "sibling_one.html" should contain 'current_resource.sort_order:10'
+

data/features/support/env.rb

@@ -0,0 +1,20 @@
+PROJECT_ROOT_PATH = File.dirname(File.dirname(File.dirname(__FILE__)))
+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/config.rb

@@ -0,0 +1,17 @@
+activate :MiddlemanPageGroups do |options|
+
+  options[:strip_file_prefixes] = true
+  options[:extend_page_class] = true
+
+  options[:nav_breadcrumbs_class] = 'breadcrumbs'
+  options[:nav_breadcrumbs_alt_class] = 'breadcrumbs'
+  options[:nav_breadcrumbs_alt_label] = 'Current page'
+  options[:nav_brethren_class] = 'table_contents'
+  options[:nav_brethren_index_class] = 'related-topics'
+  options[:nav_legitimate_children_class] = 'table_contents'
+  options[:nav_prev_next_class] = 'navigate_prev_next'
+  options[:nav_prev_next_label_prev] = 'Previous'
+  options[:nav_prev_next_label_next] = 'Next'
+  options[:nav_toc_index_class] = 'help_map'
+
+end