middlemac 2.0.0

data/features/main_features.feature

@@ -0,0 +1,44 @@
+Feature: Middlemac produces plist and strings files, uses correct HTML formats,
+  and provides useful helpers to generate content.
+
+  As a software developer
+  I want to build useable Mac OS X help books.
+  
+  Background:
+    Given a built app at "middlemac_app"
+    
+  Scenario:
+    The correct HTML version must be used on the top level index page versus
+    other pages in the project.
+    When I cd to "New Project (pro).help/Contents/Resources/Base.lproj/"
+    And the file "index.html" should contain "DTD XHTML 1.0 Strict"
+    And the file "testing_world_file.html" should contain "DTD HTML 4.01"
+
+  Scenario: The Info.plist file must be processed with relevant data.
+    When I cd to "New Project (pro).help/Contents/"
+    And the file "Info.plist" should contain "<string>com.sample.project.pro.help</string>"
+    And the file "Info.plist" should contain "<string>New Project</string>"
+    And the file "Info.plist" should contain "<string>New Project.helpindex</string>"
+    And the file "Info.plist" should contain "<string>New Project Help</string>"
+    And the file "Info.plist" should contain "<string>http://www.sample.com</string>"
+      
+  Scenario: The InfoPlist.strings file must be processed with relevant data.
+    When I cd to "New Project (pro).help/Contents/Resources/Base.lproj/"
+    And the file "InfoPlist.strings" should contain "<string>New Project</string>"
+    And the file "InfoPlist.strings" should contain "<string>New Project Help</string>"
+
+  Scenario: The help index file should have been produced.
+    When I cd to "New Project (pro).help/Contents/Resources/Base.lproj/"
+    And the file "New Project.helpindex" should exist
+
+  Scenario: The helpers will produce correct output.
+    When I cd to "New Project (pro).help/Contents/Resources/Base.lproj/"
+    And the file "testing_world_file.html" should contain "breadcrumbs:nav_breadcrumbs"
+    And the file "testing_world_file.html" should contain "partials_dir:Resources/Base.lproj/assets/partials"
+    And the file "testing_world_file.html" should contain "cfBundleIdentifier:com.sample.project.pro.help"
+    And the file "testing_world_file.html" should contain "cfBundleName:New Project"
+    And the file "testing_world_file.html" should contain "product_name:New Project Pro"
+    And the file "testing_world_file.html" should contain "product_version:2.0.0.wip"
+    And the file "testing_world_file.html" should contain "product_uri:http://www.sample.com"
+    And the file "testing_world_file.html" should contain "_new_style_partial"
+    And the file "testing_world_file.html" should contain "_partials_dir_partial"

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', 'middlemac')
+
+
+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/middlemac_app/.gitignore

@@ -0,0 +1,25 @@
+# Rubymine noise
+.idea/
+
+# BBedit noise
+*.bbprojectd
+
+# Mac OS X noise
+.DS_Store
+
+# Ignore bundler lock files
+Gemfile.lock
+
+# Ignore pkg folder
+/pkg
+
+# Ignore build folders
+.rbenv-*
+.ruby-gemset
+.ruby-version
+.sass-cache
+.sassc
+.tmp
+build*
+Makefile
+tmp

data/fixtures/middlemac_app/Contents/Info.plist.erb

@@ -0,0 +1,42 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>CFBundleIdentifier</key>
+	<string><%= cfBundleIdentifier %></string>
+	<key>CFBundleName</key>
+	<string><%= cfBundleName %></string>
+	<key>HPDBookAccessPath</key>
+	<string>index.html</string>
+	<key>HPDBookIndexPath</key>
+	<string><%= cfBundleName %>.helpindex</string>
+	<key>HPDBookTitle</key>
+	<string><%= cfBundleName %> Help</string>
+	<key>CFBundleDevelopmentRegion</key>
+	<string>en-us</string>
+	<key>CFBundleShortVersionString</key>
+	<string><%= config[:targets][config[:target]][:CFBundleShortVersionString] || product_version %></string>
+	<key>CFBundleVersion</key>
+	<string><%= config[:targets][config[:target]][:CFBundleVersion] || product_version %></string>
+	<key>HPDBookIconPath</key>
+	<string><%= config[:targets][config[:target]][:HPDBookIconPath] || 'shared/icon_32x32@2x.png' %></string>
+	<key>HPDBookKBProduct</key>
+	<string><%= config[:targets][config[:target]][:HPDBookKBProduct] %></string>
+	<key>HPDBookKBURL</key>
+	<string><%= config[:targets][config[:target]][:HPDBookKBURL] || product_uri %></string>
+	<key>HPDBookRemoteURL</key>
+	<string><%= config[:targets][config[:target]][:HPDBookRemoteURL] %></string>
+	<key>HPDBookTopicListCSSPath</key>
+	<string><%= config[:targets][config[:target]][:HPDBookTopicListCSSPath] %></string>
+	<key>HPDBookTopicListTemplatePath</key>
+	<string><%= config[:targets][config[:target]][:HPDBookTopicListTemplatePath] %></string>
+	<key>CFBundleInfoDictionaryVersion</key>
+	<string>6.0</string>
+	<key>CFBundlePackageType</key>
+	<string>BNDL</string>
+	<key>CFBundleSignature</key>
+	<string>hbwr</string>
+	<key>HPDBookType</key>
+	<string>3</string>
+</dict>
+</plist>

data/fixtures/middlemac_app/Contents/Resources/Base.lproj/10_hello_world_file.html.md.erb

@@ -0,0 +1,22 @@
+---
+title:  Hello World
+blurb:  Discover your project saying “Hello, world!” 
+layout: template-logo-small
+---
+<%= md_links %>
+<%= md_images %>
+
+
+<%= current_page.data.title %>
+==============================
+
+Hello World
+-----------
+
+Hello, World!
+
+
+Lorem
+-----
+
+<%= lorem.paragraphs 3 %>

data/fixtures/middlemac_app/Contents/Resources/Base.lproj/20_goodbye_world_file.html.md.erb

@@ -0,0 +1,22 @@
+---
+title:  Goodbye World
+blurb:  Discover your project saying “Goodbye, world!” 
+layout: template-logo-small
+---
+<%= md_links %>
+<%= md_images %>
+
+
+<%= current_page.data.title %>
+==============================
+
+Goodbye World
+-------------
+
+Goodbye, World!
+
+
+Lorem
+-----
+
+<%= lorem.paragraphs 3 %>

data/fixtures/middlemac_app/Contents/Resources/Base.lproj/30_sample_group_number_one/index.html.md.erb

@@ -0,0 +1,24 @@
+---
+title:  First Sample Group
+blurb:  A collection of pages in the first sample group.
+layout: template-logo-large
+navigate: true
+---
+<%= md_links %>
+<%= md_images %>
+
+<% content_for :seeAlso do %>
+Sidebar stuff can go here.
+<% end %>
+
+
+<%= current_page.data.title %>
+==============================
+
+<%= current_page.data.blurb %>
+
+* * *
+
+<%= nav_legitimate_children %>
+
+* * *

data/fixtures/middlemac_app/Contents/Resources/Base.lproj/30_sample_group_number_one/page_one.html.md.erb

@@ -0,0 +1,20 @@
+---
+title:  Page One
+blurb:  Check out Page One.
+layout: template-logo-medium
+order: 10
+---
+<%= md_links %>
+<%= md_images %>
+
+
+<%= current_page.data.title %>
+==============================
+
+<%= current_page.data.blurb %>
+
+
+Lorem
+-----
+
+<%= lorem.paragraphs 6 %>

data/fixtures/middlemac_app/Contents/Resources/Base.lproj/30_sample_group_number_one/page_two.html.md.erb

@@ -0,0 +1,19 @@
+---
+title:  Page 2
+blurb:  Have a look at page two, too.
+layout: template-logo-medium
+order: 20
+---
+<%= md_links %>
+<%= md_images %>
+
+<%= current_page.data.title %>
+==============================
+
+<%= current_page.data.blurb %>
+
+
+Lorem
+-----
+
+<%= lorem.paragraphs 6 %>

data/fixtures/middlemac_app/Contents/Resources/Base.lproj/40_sample_group_number_two/01_nested_group_example/01_page_one.html.md.erb

@@ -0,0 +1,18 @@
+---
+title:  Page 1
+blurb:  Think of something interesting for this blurb.
+layout: template-logo-medium
+---
+<%= md_links %>
+<%= md_images %>
+
+
+<%= current_page.data.title %>
+==============================
+
+<%= current_page.data.blurb %>
+
+Lorem
+-----
+
+<%= lorem.paragraphs 6 %>

data/fixtures/middlemac_app/Contents/Resources/Base.lproj/40_sample_group_number_two/01_nested_group_example/02_pagina_dos.html.md.erb

@@ -0,0 +1,19 @@
+---
+title:  Page 2
+blurb:  Think of something else interesting for this blurb.
+layout: template-logo-medium
+---
+<%= md_links %>
+<%= md_images %>
+
+
+<%= current_page.data.title %>
+==============================
+
+<%= current_page.data.blurb %>
+
+
+Lorem
+-----
+
+<%= lorem.paragraphs 6 %>

data/fixtures/middlemac_app/Contents/Resources/Base.lproj/40_sample_group_number_two/01_nested_group_example/03_page_san.html.md.erb

@@ -0,0 +1,18 @@
+---
+title:  Page 3
+blurb:  Think of something interesting for this blurb, as well.
+layout: template-logo-medium
+---
+<%= md_links %>
+<%= md_images %>
+
+
+<%= current_page.data.title %>
+==============================
+
+<%= current_page.data.blurb %>
+
+Lorem
+-----
+
+<%= lorem.paragraphs 6 %>

data/fixtures/middlemac_app/Contents/Resources/Base.lproj/40_sample_group_number_two/01_nested_group_example/index.html.md.erb

@@ -0,0 +1,18 @@
+---
+title:     A nested group example
+blurb:     See how nested groups work.
+layout:    template-logo-large
+navigate:  true
+---
+<%= md_links %>
+<%= md_images %>
+
+
+<%= current_page.data.title %>
+==============================
+
+<%= current_page.data.blurb %>
+
+* * *
+
+<%= nav_legitimate_children %>

data/fixtures/middlemac_app/Contents/Resources/Base.lproj/40_sample_group_number_two/02_page_two.html.md.erb

@@ -0,0 +1,19 @@
+---
+title:  Page two
+blurb:  Page two sort order is by filename, not by frontmatter.
+layout: template-logo-medium
+---
+<%= md_links %>
+<%= md_images %>
+
+
+<%= current_page.data.title %>
+==============================
+
+<%= current_page.data.blurb %>
+
+
+Lorem
+-----
+
+<%= lorem.paragraphs 6 %>

data/fixtures/middlemac_app/Contents/Resources/Base.lproj/40_sample_group_number_two/03_page_three.html.md.erb

@@ -0,0 +1,19 @@
+---
+title:  The third page
+blurb:  Page three sort order is by filename, not by frontmatter, also.
+layout: template-logo-medium
+---
+<%= md_links %>
+<%= md_images %>
+
+
+<%= current_page.data.title %>
+==============================
+
+<%= current_page.data.blurb %>
+
+
+Lorem
+-----
+
+<%= lorem.paragraphs 6 %>

data/fixtures/middlemac_app/Contents/Resources/Base.lproj/40_sample_group_number_two/index.html.md.erb

@@ -0,0 +1,24 @@
+---
+title:    Sample Group Number 2
+blurb:    Some more pages are grouped <strong>right here</strong>.
+layout:   template-logo-large
+navigate: true
+---
+<%= md_links %>
+<%= md_images %>
+
+<% content_for :seeAlso do %>
+Sidebar stuff can go here.
+<% end %>
+
+
+<%= current_page.data.title %>
+==============================
+
+<%= current_page.data.blurb %>
+
+* * *
+
+<%= nav_legitimate_children %>
+
+* * *

data/fixtures/middlemac_app/Contents/Resources/Base.lproj/45_testing_world_file.html.md.erb

@@ -0,0 +1,55 @@
+---
+title:  Testing World
+blurb:  A page that uses <strong>Middlemac</strong>’s helpers so that Cucumber
+        has something predictable to examine.
+layout: template-logo-medium
+---
+<%= md_links %>
+<%= md_images %>
+
+<%= current_page.data.title %>
+==============================
+
+This page simply uses all of **Middlemac**’s helpers so that Cucumber testing
+can be performed. This sample project is also the fixture for testing; if you
+have this Gem’s source, you can
+
+~~~ bash
+rake test
+~~~
+
+…from the Gem’s directory to run the tests yourself.
+
+Note that this isn’t the only file tested, but it’s a nice place to capture
+some of the test output.
+{:.note}
+
+* * *
+
+breadcrumbs:<%= breadcrumbs %>
+
+partials_dir:<%= partials_dir %>
+
+cfBundleIdentifier:<%= cfBundleIdentifier %>
+
+cfBundleName:<%= cfBundleName %>
+
+product_name:<%= product_name %>
+
+product_version:<%= product_version %>
+
+product_uri:<%= product_uri %>
+
+* * *
+
+## New Style Middleman Partial
+
+~~~ html
+<%= partial 'new_style_partial' %>
+~~~
+
+## Partial from `partials_dir`
+
+~~~ html
+<%= partial 'partials_dir_partial' %>
+~~~