middlemac 2.0.0 → 3.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d2b3410abbcf1647fe5bb583455675fc72a44c94
-  data.tar.gz: 92adcc43e61ddf09e65e84c99eb031fb183b3cb1
+SHA256:
+  metadata.gz: d36a639d23b4ec321d7047879332e744986115c5d2eb0addf9959357d915ff2b
+  data.tar.gz: bbc5aa12ebf741fc881922d884850a1b31524ecbd9c0c3df1ce32afd1ff2a3cd
 SHA512:
-  metadata.gz: b8ec6cd32d7a0f7c23fff233455cb8b9d52ab4031db52c3561516f06879ba07f915142f70c208f0da68c23d88ac696ecd1eb889c6a52a8dbbed059d30624fb0e
-  data.tar.gz: e523e9deb1141f927269495e61aa0fa8afdde9105f8e9fef6545e6cb88c12f156d599e708713b0e94a69968d7060a73cd8964606fbfe2d94c1ff69d3723019d4
+  metadata.gz: 201dc66cda139522d89824b801493388c310f80e9dbd7703b58f2af4dab92f1c02ea3eadba0d211b6c863865bf6717f20a1b6fbdddee402bc54777a135e5fd7a
+  data.tar.gz: 47425d49c57f6c7d975228542b126d338f579107d53737876ebdfababfcb1ff0961162d6299cf8b10580461b4781ab089eedef49bc6da97b20d6416a7c208a0e

data/.gitattributes

@@ -0,0 +1,5 @@
+*.html linguist-documentation
+*.css linguist-documentation
+*.erb linguist-documentation
+*.js linguist-documentation
+documentation_project/ linguist-documentation

data/.gitignore

@@ -22,3 +22,9 @@ build/*
 
 # Aruba
 /tmp/
+
+# Native Extension Build
+/lib/trie
+
+# Fixture build folder when testing.
+/fixtures/middlemac_app/New_Project_(pro).help

data/CHANGELOG.md

@@ -1,17 +1,58 @@
 middlemac change log
 ====================
 
+- Version 3.1.1 / 2021-April-12
+
+  - Compatibility Updates
+      - Version bump.
+      - Vendor the source of the fast_trie gem, because it's no longer maintained, and I
+        don't want to create another unmaintained Ruby gem. Updates to fast_trie are needed
+        because Clang now has added diagnostics including default C99 which causes the
+        original fast_trie to no longer build. I've also silenced warnings.
+      - Make the landing page use target magic images instead of the static image it uses.
+        This means you should have `target1-icon_256x256` and `target2-icon_256x256` in
+        your images, or to use the same icon for all targets, `all-icon_256x256`.
+      - Enforce a newer minimum Middleman version, because it has removed support for
+        automatic alt attributes, and we've done the same. This keeps us in sync.
+      - Enforce Ruby versions. Right now Ruby 2.6.0 approaching 3.0 is supported. Once
+        Middleman has a numbered release supporting Ruby 3.0, I'll take a look at supporting
+        it.
+
+- Version 3.1.0 / 2019-October-11
+
+  - Version 3.1.0
+    - Introduce a couple of new options in order to influence the file name of the
+      help book.
+  - Added .gitattributes for proper language reporting in GitHub.
+    No version bump.
+    No new gem.
+
+- Version 3.0.1 / 2019-September-08
+
+  - Bump to 3.0.1:
+    - Fix YAML parsing issue for picky parsers.
+    - Added redirect files, to avoid recent macOS issue where /Resources/index.html
+      and the language.lproj/index.html files would confuse help viewer.
+    - Updated tests
+    - Updated documentation in the documentation project.
+
+- Version 3.0.0 / 2018-June-18
+
+  - All new Middlemac 3.0.
+  - Git Commit Issues Fix
+      - Ensure that build.sh is captured in version control.
+      - Added blank build.sh. Todo is recreate this. Sorry.
+
 - Version 2.0.0 / 2016-May-15
 
+  - Touchup changelog, and release gem.
   - All new Middlemac version 2.0.0!
       - _Significant_, major upgrade to _Middlemac_.
       - Now packaged as a real Ruby gem.
       - Uses the latest Middleman 4.1 series (4.1.7 or newer required).
       - This version _will_ break old projects.
       - Read the full documentation to understand the full scope of changes.
-
-- Previous
-  - Updated to newer middleman.
+  - - Updated to newer middleman.
     - Use font-awesome-sass gem instead of keeping it in the file system.
   - Fixed 256x256 image file.
   - Added built output. RC1
@@ -34,10 +75,3 @@ middlemac change log
   - README, getting started.
   - Overhaul of helpers and sitemap manipulators complete.
   - BRETHREN checkpoint
-  - Continued refactoring resources.
-  - Begin refactor helpers to methods.
-  - Topical content.
-  - Bug-proofing.
-  - Added topical content.
-  - Removed conflicting LESS stuff.
-  - More content.

data/Gemfile

@@ -2,7 +2,7 @@
 # the following line to use "http://" instead
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in middleman-pagegroups.gemspec
+# Specify your gem's dependencies in middlemac.gemspec
 gemspec
 
 group :development do
@@ -16,3 +16,13 @@ group :test do
   gem 'aruba'
   gem 'rspec'
 end
+
+
+# These are needed so that Cucumber will work with our fixture. As this
+# is not part of the gem, it's probably okay, but seems rather stupid.
+# It used to work without this, and Middleman would load its *own* gemfile
+# from the fixture. Not sure why that's not happening.
+gem 'middleman-targets'
+gem 'middleman-syntax'
+gem 'middleman-compass'
+

data/README.md

@@ -1,23 +1,55 @@
-Middlemac, the Middleman Build System for Mac OS X Help Projects
-================================================================
+Middlemac, the Middleman Build System for macOS Help Projects
+=============================================================
 [![Gem Version](https://badge.fury.io/rb/middlemac.svg)](https://badge.fury.io/rb/middlemac)
 
 
 _Middlemac_
 
 This gem provides a complete solution to generating help documentation for
-Mac OS X applications in the form of Help Books, using Middleman and a
+macOS applications in the form of modern Help Books, using Middleman and a
 selection of custom extensions to provide everything a developer needs.
 
+The Help Books you make will be modern Apple Help Books, complete with Apple’s
+native look and feel, and having the same features as Apple’s own Help Books.
+These features aren’t a simulation by _Middlemac_, but are truly Apple native
+Help Book features.
+
 Using this Apple Help Book building system leverages the tools of _Middleman_ to
-make building end-user documentation for your Mac OS X applications a snap.
+make building end-user documentation for your macOS applications a snap.
 Whether you are targeting multiple versions of your application or a single
 version, once properly configured, _Middlemac_ will take all of the pain out of
 building help files.
 
+_Middlemac_ isn’t merely a text-to-HTML tool. It manages multiple languages,
+provides helpers to assist with asset management, supports multiple versions of
+your help (for multiple versions of your application), and more.
+
+
+Alternatives to _Middlemac_
+---------------------------
+
+If your needs are very little and you simply want something that resembles
+Apple’s Help Books without all of the extra features, then you cannot go wrong
+with [jekyll-apple-help](https://github.com/chuckhoupt/jekyll-apple-help). 
+
+
+Middlemac’s Manual
+------------------
+
+The steps below lead you through installing _Middlemac_ and building its manual
+using _Middlemac_. That’s asking an awful lot if you just want to take a look at
+what it does, so feel free to visit the manual on its website:
+
+- The manual built using the “free” target is [right here][1].
+- The manual built using the “pro” target can be looked at [here][2].
+
+ [1]: https://www.balthisar.com/manuals/Middlemac3_(free)/Contents/Resources/index.html
+ [2]: https://www.balthisar.com/manuals/Middlemac3_(pro)/Contents/Resources/index.html
+
 
 Simple README
 -------------
+
 Jump to the [verbose README](#verbose-readme) and instructions below, otherwise…
 
 
@@ -112,7 +144,7 @@ There are multiple ways you could be reading this content now, but for now we
 will assume that you have not yet installed _Middlemac_ and its dependencies.
 
 To get started and read the full documentation, make sure that your system has
-[Ruby](https://www.ruby-lang.org/) installed (it comes pre-installed on Mac OS X
+[Ruby](https://www.ruby-lang.org/) installed (it comes pre-installed on macOS
 and some Linuxes), and follow these steps below. 
 
 We now recommend the use of the Ruby Version Manager [(RVM)](https://rvm.io/).
@@ -143,7 +175,7 @@ xcode-select --install
 
 If that fails or the rest of the installation fails, then install all of XCode.
 It’s available in the App Store. It’s free of charge. And you’re using this
-project to develop help for Mac OS X applications that you’re developing using
+project to develop help for macOS applications that you’re developing using
 XCode anyway. Install it, already!
 
 Dependencies on Linux are left up to you. Most modern Linuxes will prompt you to

data/Rakefile

@@ -1,3 +1,4 @@
+require "rake/extensiontask"
 require 'bundler/gem_tasks'
 require 'cucumber/rake/task'
 require 'yard'
@@ -5,19 +6,33 @@ require 'git'
 require File.expand_path('../lib/middlemac/version.rb', __FILE__)
 
 
+###############################################################################
+# ExtensionTask.new
+#   Compile the native extensions.
+###############################################################################
+Rake::ExtensionTask.new("trie") do |ext|
+  ext.ext_dir = 'ext/trie'
+  ext.lib_dir = 'lib/trie'
+end
+
+
 ###############################################################################
 # :default
 #   Define the default task.
 ###############################################################################
-task :default => :test
+task :default => [:compile, :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'
+Cucumber::Rake::Task.new(:test, 'Features that must pass; do "rake compile" first!') do |task|
+  task.cucumber_opts = '--publish-quiet --require features --color --tags "not @wip" --strict --format pretty 2>/dev/null'
+end
+
+Cucumber::Rake::Task.new(:testnoisy, 'Features that must pass; do "rake compile" first!') do |task|
+  task.cucumber_opts = '--publish-quiet --require features --color --tags "not @wip" --strict --format pretty'
 end
 
 
@@ -46,10 +61,11 @@ task :partials do
       { :file => '_yard_middlemac_helpers.erb',          :group => 'Helpers',  },
       { :file => '_yard_middlemac_helpers_extended.erb', :group => 'Extended Helpers' },
       { :file => '_yard_middlemac_config.erb',           :group => 'Extension Configuration' },
+      { :file => '_yard_middlemac_resources.erb',        :group => 'Resource Extensions',  },
   ]
   
   # Define the output directory.
-  dest = File.join('documentation_project', 'Contents', 'Resources', 'Base.lproj', 'assets', 'partials')
+  dest = File.join('documentation_project', 'Contents', 'Resources', 'SharedGlobalAssets', '_partials')
 
   # Run YARD multiple times, filtering the group that interests us.
   sections.each do |s|

data/documentation_project/.gitignore

@@ -21,7 +21,7 @@ Gemfile.lock
 .sassc
 .tmp
 build*
-Makefile
+!build.sh
 tmp
 
 # XCode user-specific files

data/documentation_project/Contents/Info.plist.erb

@@ -7,9 +7,11 @@
 	<key>CFBundleName</key>
 	<string><%= cfBundleName %></string>
 	<key>HPDBookAccessPath</key>
-	<string>index.html</string>
+	<string>index_hpd.html</string>
 	<key>HPDBookIndexPath</key>
 	<string><%= cfBundleName %>.helpindex</string>
+	<key>HPDBookCSIndexPath</key>
+	<string><%= cfBundleName %>.cshelpindex</string>
 	<key>HPDBookTitle</key>
 	<string><%= cfBundleName %> Help</string>
 	<key>CFBundleDevelopmentRegion</key>
@@ -19,13 +21,13 @@
 	<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>
+	<string><%= config[:targets][config[:target]][:HPDBookIconPath] || 'SharedGlobalAssets/convention/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>
+	<string><%= config[:targets][config[:target]][:HPDBookRemoteURL] || 'dummy_enables_share' %></string>
 	<key>HPDBookTopicListCSSPath</key>
 	<string><%= config[:targets][config[:target]][:HPDBookTopicListCSSPath] %></string>
 	<key>HPDBookTopicListTemplatePath</key>

data/documentation_project/Contents/Resources/SharedGlobalAssets/_data/locale-list.json

@@ -0,0 +1,318 @@
+[
+  {
+    "text-direction": "ltr",
+    "name": "English (U.S.)\u200e",
+    "isoName": "English (U.S.)\u200e",
+    "isoCodes": [
+      "en",
+      "en-us"
+    ],
+    "folder": "en.lproj"
+  },
+  {
+    "text-direction": "rtl",
+    "name": "\u0627\u0644\u0639\u0631\u0628\u064a\u0629",
+    "isoName": "Arabic",
+    "isoCodes": [
+      "ar"
+    ],
+    "folder": "ar.lproj"
+  },
+  {
+    "text-direction": "ltr",
+    "name": "Catal\u00e0",
+    "isoName": "Catalan",
+    "isoCodes": [
+      "ca"
+    ],
+    "folder": "ca.lproj"
+  },
+  {
+    "text-direction": "ltr",
+    "name": "\u010ce\u0161tina",
+    "isoName": "Czech",
+    "isoCodes": [
+      "cs"
+    ],
+    "folder": "cs.lproj"
+  },
+  {
+    "text-direction": "ltr",
+    "name": "Dansk",
+    "isoName": "Danish",
+    "isoCodes": [
+      "da"
+    ],
+    "folder": "da.lproj"
+  },
+  {
+    "text-direction": "ltr",
+    "name": "Deutsch",
+    "isoName": "German",
+    "isoCodes": [
+      "de"
+    ],
+    "folder": "de.lproj"
+  },
+  {
+    "text-direction": "ltr",
+    "name": "\u0395\u03bb\u03bb\u03b7\u03bd\u03b9\u03ba\u03ac",
+    "isoName": "Greek",
+    "isoCodes": [
+      "el"
+    ],
+    "folder": "el.lproj"
+  },
+  {
+    "text-direction": "ltr",
+    "name": "Espa\u00f1ol",
+    "isoName": "Spanish",
+    "isoCodes": [
+      "es"
+    ],
+    "folder": "es.lproj"
+  },
+  {
+    "text-direction": "ltr",
+    "name": "Espa\u00f1ol (Latinoam\u00e9rica)\u200e",
+    "isoName": "Latin American Spanish",
+    "isoCodes": [
+      "es-419",
+      "es-xl"
+    ],
+    "folder": "es_419.lproj"
+  },
+  {
+    "text-direction": "ltr",
+    "name": "Suomi",
+    "isoName": "Finnish",
+    "isoCodes": [
+      "fi"
+    ],
+    "folder": "fi.lproj"
+  },
+  {
+    "text-direction": "ltr",
+    "name": "Fran\u00e7ais",
+    "isoName": "French",
+    "isoCodes": [
+      "fr"
+    ],
+    "folder": "fr.lproj"
+  },
+  {
+    "text-direction": "rtl",
+    "name": "\u05e2\u05d1\u05e8\u05d9\u05ea",
+    "isoName": "Hebrew",
+    "isoCodes": [
+      "he"
+    ],
+    "folder": "he.lproj"
+  },
+  {
+    "text-direction": "ltr",
+    "name": "Hrvatski",
+    "isoName": "Croatian",
+    "isoCodes": [
+      "hr"
+    ],
+    "folder": "hr.lproj"
+  },
+  {
+    "text-direction": "ltr",
+    "name": "Magyar",
+    "isoName": "Hungarian",
+    "isoCodes": [
+      "hu"
+    ],
+    "folder": "hu.lproj"
+  },
+  {
+    "text-direction": "ltr",
+    "name": "Bahasa Indonesia",
+    "isoName": "Indonesian",
+    "isoCodes": [
+      "id"
+    ],
+    "folder": "id.lproj"
+  },
+  {
+    "text-direction": "ltr",
+    "name": "Italiano",
+    "isoName": "Italian",
+    "isoCodes": [
+      "it"
+    ],
+    "folder": "it.lproj"
+  },
+  {
+    "text-direction": "ltr",
+    "name": "\u65e5\u672c\u8a9e",
+    "isoName": "Japanese",
+    "isoCodes": [
+      "ja"
+    ],
+    "folder": "ja.lproj"
+  },
+  {
+    "text-direction": "ltr",
+    "name": "\ud55c\uad6d\uc5b4",
+    "isoName": "Korean",
+    "isoCodes": [
+      "ko"
+    ],
+    "folder": "ko.lproj"
+  },
+  {
+    "text-direction": "ltr",
+    "name": "Bahasa Melayu",
+    "isoName": "Malaysian",
+    "isoCodes": [
+      "ms"
+    ],
+    "folder": "ms.lproj"
+  },
+  {
+    "text-direction": "ltr",
+    "name": "Nederlands",
+    "isoName": "Dutch",
+    "isoCodes": [
+      "nl"
+    ],
+    "folder": "nl.lproj"
+  },
+  {
+    "text-direction": "ltr",
+    "name": "Norsk (bokm\u00e5l)\u200e",
+    "isoName": "Norwegian",
+    "isoCodes": [
+      "nb",
+      "nn",
+      "no"
+    ],
+    "folder": "no.lproj"
+  },
+  {
+    "text-direction": "ltr",
+    "name": "Polski",
+    "isoName": "Polish",
+    "isoCodes": [
+      "pl"
+    ],
+    "folder": "pl.lproj"
+  },
+  {
+    "text-direction": "ltr",
+    "name": "Portugu\u00eas (Brasil)\u200e",
+    "isoName": "Brazilian Portuguese",
+    "isoCodes": [
+      "pt-br",
+      "pt"
+    ],
+    "folder": "pt.lproj"
+  },
+  {
+    "text-direction": "ltr",
+    "name": "Portugu\u00eas (Portugal)\u200e",
+    "isoName": "Portuguese",
+    "isoCodes": [
+      "pt-pt"
+    ],
+    "folder": "pt_PT.lproj"
+  },
+  {
+    "text-direction": "ltr",
+    "name": "Rom\u00e2n\u0103",
+    "isoName": "Romanian",
+    "isoCodes": [
+      "ro"
+    ],
+    "folder": "ro.lproj"
+  },
+  {
+    "text-direction": "ltr",
+    "name": "\u0420\u0443\u0441\u0441\u043a\u0438\u0439",
+    "isoName": "Russian",
+    "isoCodes": [
+      "ru"
+    ],
+    "folder": "ru.lproj"
+  },
+  {
+    "text-direction": "ltr",
+    "name": "Sloven\u010dina",
+    "isoName": "Slovak",
+    "isoCodes": [
+      "sk"
+    ],
+    "folder": "sk.lproj"
+  },
+  {
+    "text-direction": "ltr",
+    "name": "Svenska",
+    "isoName": "Swedish",
+    "isoCodes": [
+      "sv"
+    ],
+    "folder": "sv.lproj"
+  },
+  {
+    "text-direction": "ltr",
+    "name": "\u0e20\u0e32\u0e29\u0e32\u0e44\u0e17\u0e22",
+    "isoName": "Thai",
+    "isoCodes": [
+      "th"
+    ],
+    "folder": "th.lproj"
+  },
+  {
+    "text-direction": "ltr",
+    "name": "T\u00fcrk\u00e7e",
+    "isoName": "Turkish",
+    "isoCodes": [
+      "tr"
+    ],
+    "folder": "tr.lproj"
+  },
+  {
+    "text-direction": "ltr",
+    "name": "\u0423\u043a\u0440\u0430\u0457\u043d\u0441\u044c\u043a\u0430",
+    "isoName": "Ukrainian",
+    "isoCodes": [
+      "uk"
+    ],
+    "folder": "uk.lproj"
+  },
+  {
+    "text-direction": "ltr",
+    "name": "Ti\u1ebfng Vi\u1ec7t",
+    "isoName": "Vietnamese",
+    "isoCodes": [
+      "vi"
+    ],
+    "folder": "vi.lproj"
+  },
+  {
+    "text-direction": "ltr",
+    "name": "\u7b80\u4f53\u4e2d\u6587",
+    "isoName": "Simplified Chinese",
+    "isoCodes": [
+      "zh-cn",
+      "zh-hans",
+      "zh"
+    ],
+    "folder": "zh_CN.lproj"
+  },
+  {
+    "text-direction": "ltr",
+    "name": "\u7e41\u9ad4\u4e2d\u6587",
+    "isoName": "Traditional Chinese",
+    "isoCodes": [
+      "zh-tw",
+      "zh-hk",
+      "zh-mo",
+      "zh-hant"
+    ],
+    "folder": "zh_TW.lproj"
+  }
+]