middlemac 3.0.1 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 7317b985a597b76832c31022f3b9fe89ed88e59b
-  data.tar.gz: 20edec01a9b12076dcef9149994305a015c835b4
+SHA256:
+  metadata.gz: 577f3591f5f815b959d9a272ea275cbaa18b19996c4234312fcb177aa3b56df0
+  data.tar.gz: 4c6765e7f1d9a70043301616d7245deb167c1e87de787b8cd3e830298a112efe
 SHA512:
-  metadata.gz: 139c7f24a3c4da6f58a8dc8ea5bd5ab726ea94dd646b868e690d098b11cf9af35957bccfccae6acf753bee26db227751439b5d8c2d42c06956589a3cb42f0af5
-  data.tar.gz: cffd0b71199a96fa1df3d329c2f05f0eb841d2bfa7adf4d4aceec587784e5a1de5b3e6e6656509d5068a32bb3cb5ad57c1f497488637c443444b6b67d9eaddad
+  metadata.gz: 780edeb0005d4a5ce14210306b63b297518ba471c0904510260722de7155f1e0ec54141ab3cc310c1592b3da217377efec6bd71f5e9aa2610bf115769d7e2076
+  data.tar.gz: 8d1856e6b75850ca86e7bab12cb702e93f5af2536384798e1a5d656800c46813b5efee6c1d53f2506ba9c93da380ec6a36870eae389b64fd9c5975f9cbc8a741

data/.gitattributes

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

data/CHANGELOG.md

@@ -1,12 +1,26 @@
 middlemac change log
 ====================
 
+- 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
 
-  - Updated documentation.
-  - Added redirect files, and updated tests.
-  - Fix YAML parsing issue for picky parsers.
-  - Version bump.
+  - 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.
@@ -44,3 +58,4 @@ middlemac change log
   - README, getting started.
   - Overhaul of helpers and sitemap manipulators complete.
   - BRETHREN checkpoint
+  - Continued refactoring resources.

data/documentation_project/Contents/Resources/SharedGlobalAssets/_partials/_yard_middlemac_config.erb

@@ -5,9 +5,53 @@
   <div id="instance_attr_details" class="attr_details">
     
       
-      <span id="options[:help_output_location]=-instance_method"></span>
+      <span id="options[:help_output_avoid_spaces]=-instance_method"></span>
       <div class="method_details first">
-  <h3 class="signature first" id="options[:help_output_location]=-instance_method">
+  <h3 class="signature first" id="options[:help_output_avoid_spaces]=-instance_method">
+  
+    #<strong>options[:help_output_avoid_spaces]=</strong>(value)  &#x21d2; <tt>Boolean</tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Indicates whethr or not the <code>help_output_location</code> includes spaces in its
+filename or not. Some GNU tools, such as make, choke on spaces. The default
+setting for this option is <em>yes</em> in order to maintain backward
+compatibility.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>Boolean</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'><p><code>true</code> or <code>false</code> to enable or disable this behavior.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div>
+</div>
+    
+      
+      <span id="options[:help_output_location]=-instance_method"></span>
+      <div class="method_details ">
+  <h3 class="signature " id="options[:help_output_location]=-instance_method">
   
     #<strong>options[:help_output_location]=</strong>(value)  &#x21d2; <tt>String</tt> 
   
@@ -49,6 +93,52 @@ built.</p>
   
 </ul>
 
+</div>
+</div>
+    
+      
+      <span id="options[:help_output_use_target]=-instance_method"></span>
+      <div class="method_details ">
+  <h3 class="signature " id="options[:help_output_use_target]=-instance_method">
+  
+    #<strong>options[:help_output_use_target]=</strong>(value)  &#x21d2; <tt>Boolean</tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Indicates whether or not the <code>help_output_location</code> includes the <code>(target)</code>
+prefix in the help book bundle name. The default, <code>true</code>, will result in
+<code>#{CFBundleName} (target).help</code>, which is the historical behavior. Setting
+this to <code>false</code> will result in a help book named <code>#{CFBundleName}.help</code>,
+instead. This can be useful if you are building help books from scripts via
+XCode, and you set <code>help_output_location</code> to <code>ENV['BUILT_PRODUCTS_DIR']</code>.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>Boolean</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'><p><code>true</code> or <code>false</code> to enable or disable this behavior.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
 </div>
 </div>
     

data/documentation_project/Contents/Resources/en.lproj/030_get_started/020_your_first_help_book.html.md.erb

@@ -143,7 +143,7 @@ config[:targets] = {
                 :HPDBookIconPath  => 'SharedGlobalArt/free-icon_32x32@2x.png',
                 :CFBundleName     => 'Middlemac',
                 :ProductName      => 'Middlemac',
-                :ProductVersion   => '3.0.0.wip',
+                :ProductVersion   => '3.1.0',
                 :ProductURI       => 'http://www.balthisar.com/developer',
                 :ProductCopyright => '© 2018 Jim Derry. All rights reserved.',
                 :features =>
@@ -161,7 +161,7 @@ config[:targets] = {
                 :HPDBookIconPath  => 'SharedGlobalArt/pro-icon_32x32@2x.png',
                 :CFBundleName     => 'Middlemac',
                 :ProductName      => 'Middlemac Pro',
-                :ProductVersion   => '3.0.0.wip',
+                :ProductVersion   => '3.1.0',
                 :ProductURI       => 'http://www.balthisar.com/developer',
                 :ProductCopyright => '© 2018 Jim Derry. All rights reserved.',
                 :features =>

data/documentation_project/Contents/Resources/en.lproj/110_acknowledgements/index.html.md.erb

@@ -39,7 +39,7 @@ of _Middlemac_ do not pretend to override.
 
 ### The MIT License (MIT)
 
-Copyright (c) 2014-2018 Jim Derry and balthisar.com
+Copyright (c) 2014-2019 Jim Derry and balthisar.com
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in

data/documentation_project/Gemfile

@@ -17,7 +17,7 @@ source 'https://rubygems.org'
 #######################################
 # Middlemac, natch.
 #######################################
-gem 'middlemac', '~> 3.0.1'
+gem 'middlemac', '~> 3.1.0'
 gem 'middleman-targets', '~> 1.0.12'
 
 

data/documentation_project/config.rb

@@ -94,9 +94,9 @@ config[:targets] = {
                 :HPDBookIconPath  => 'SharedGlobalArt/free-icon_32x32@2x.png',
                 :CFBundleName     => 'Middlemac',
                 :ProductName      => 'Middlemac',
-                :ProductVersion   => version_app || '3.0.0',
+                :ProductVersion   => version_app || '3.1.0',
                 :ProductURI       => 'http://www.balthisar.com/developer',
-                :ProductCopyright => '© 2018 Jim Derry. All rights reserved.',
+                :ProductCopyright => '© 2019 Jim Derry. All rights reserved.',
                 :features =>
                     {
                         :feature_advertise_pro        => true,
@@ -112,9 +112,9 @@ config[:targets] = {
                 :HPDBookIconPath  => 'SharedGlobalArt/pro-icon_32x32@2x.png',
                 :CFBundleName     => 'Middlemac',
                 :ProductName      => 'Middlemac Pro',
-                :ProductVersion   => version_app || '3.0.0',
+                :ProductVersion   => version_app || '3.1.0',
                 :ProductURI       => 'http://www.balthisar.com/developer',
-                :ProductCopyright => '© 2018 Jim Derry. All rights reserved.',
+                :ProductCopyright => '© 2019 Jim Derry. All rights reserved.',
                 :features =>
                     {
                         :feature_advertise_pro        => false,
@@ -152,6 +152,20 @@ activate :Middlemac do |options|
   # is always up to date.
   options.help_output_location = nil
 
+  # Indicates whether or not spaces should be avoided in the name of the help
+  # bundle. The default value for backwards compatibility is `true` because
+  # some tools, such a make, don't like spaces.
+  options.help_output_avoid_spaces = true
+
+  # Indicates whether or not the `help_output_location` includes the `(target)`
+  # prefix in the help book bundle name. The default, `true`, will result in
+  # `#{CFBundleName} (target).help`, which is the historical behavior. Setting
+  # this to `false` will result in a help book named `#{CFBundleName}.help`,
+  # instead. This can be useful if you are building help books from scripts via
+  # XCode, and you set `help_output_location` to `ENV['BUILT_PRODUCTS_DIR']`.
+  # @return [Boolean] `true` or `false` to enable or disable this behavior.
+  options.help_output_use_target = true
+
   # If set to true, then the enhanced image_tag helper will be used
   # to include @2x, @3x, and @4x srcset automatically, if the image assets
   # exist.

data/features/main_features.feature

@@ -42,7 +42,7 @@ Feature: Middlemac produces plist and strings files, uses correct HTML formats,
     And the file "testing_world_file.html" should contain "com.sample.project.pro.help"
     And the file "testing_world_file.html" should contain "New Project"
     And the file "testing_world_file.html" should contain "New Project Pro"
-    And the file "testing_world_file.html" should contain "3.0.1"
+    And the file "testing_world_file.html" should contain "3.1.0"
     And the file "testing_world_file.html" should contain "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/fixtures/middlemac_app/Gemfile

@@ -17,7 +17,7 @@ source 'https://rubygems.org'
 #######################################
 # Middlemac, natch.
 #######################################
-gem 'middlemac', '~> 3.0.1'
+gem 'middlemac', '~> 3.1.0'
 gem 'middleman-targets', '~> 1.0.12'
 
 

data/fixtures/middlemac_app/config.rb

@@ -94,7 +94,7 @@ config[:targets] = {
                 :HPDBookIconPath  => nil,
                 :CFBundleName     => 'New Project',
                 :ProductName      => 'New Project',
-                :ProductVersion   => version_app || '3.0.1',
+                :ProductVersion   => version_app || '3.1.0',
                 :ProductURI       => 'http://www.sample.com',
                 :ProductCopyright => '© 2018 Jim Derry. All rights reserved.',
                 :features =>
@@ -112,7 +112,7 @@ config[:targets] = {
                 :HPDBookIconPath  => nil,
                 :CFBundleName     => 'New Project',
                 :ProductName      => 'New Project Pro',
-                :ProductVersion   => version_app || '3.0.1',
+                :ProductVersion   => version_app || '3.1.0',
                 :ProductURI       => 'http://www.sample.com',
                 :ProductCopyright => '© 2018 Jim Derry. All rights reserved.',
                 :features =>
@@ -152,6 +152,20 @@ activate :Middlemac do |options|
   # is always up to date.
   options.help_output_location = nil
 
+  # Indicates whether or not spaces should be avoided in the name of the help
+  # bundle. The default value for backwards compatibility is `true` because
+  # some tools, such a make, don't like spaces.
+  options.help_output_avoid_spaces = true
+
+  # Indicates whether or not the `help_output_location` includes the `(target)`
+  # prefix in the help book bundle name. The default, `true`, will result in
+  # `#{CFBundleName} (target).help`, which is the historical behavior. Setting
+  # this to `false` will result in a help book named `#{CFBundleName}.help`,
+  # instead. This can be useful if you are building help books from scripts via
+  # XCode, and you set `help_output_location` to `ENV['BUILT_PRODUCTS_DIR']`.
+  # @return [Boolean] `true` or `false` to enable or disable this behavior.
+  options.help_output_use_target = true
+
   # If set to true, then the enhanced image_tag helper will be used
   # to include @2x, @3x, and @4x srcset automatically, if the image assets
   # exist.

data/lib/middlemac/extension.rb

@@ -53,6 +53,8 @@ class Middlemac < ::Middleman::Extension
   # as extension options.
   ############################################################
   option :help_output_location, nil, 'Directory to place the built helpbook.'
+  option :help_output_avoid_spaces, true, 'If true, spaces in the help book file name bundle will be replaced with underscores.'
+  option :help_output_use_target, true, 'If false, the help book will not include (target) in its bundle name.'
   option :img_auto_extensions, %w(.svg .png .jpg .jpeg .gif .tiff .tif), 'If not empty, then `image_tag` will work without filename extensions.'
   option :retina_srcset, true, 'If true then the image_tag helper will be extended to include automatic @2x images.'
   option :show_debug, false, 'If true, the main layout will show some debug information and site contents.'
@@ -72,6 +74,22 @@ class Middlemac < ::Middleman::Extension
   # Xcode project is automatically up to date every time a help project is
   # built.
   # @return [String] The directory where the final help bundle will be built.
+  
+  # @!attribute [rw] options[:help_output_avoid_spaces]=
+  # Indicates whethr or not the `help_output_location` includes spaces in its
+  # filename or not. Some GNU tools, such as make, choke on spaces. The default
+  # setting for this option is *yes* in order to maintain backward
+  # compatibility.
+  # @return [Boolean] `true` or `false` to enable or disable this behavior.
+  
+  # @!attribute [rw] options[:help_output_use_target]=
+  # Indicates whether or not the `help_output_location` includes the `(target)`
+  # prefix in the help book bundle name. The default, `true`, will result in
+  # `#{CFBundleName} (target).help`, which is the historical behavior. Setting
+  # this to `false` will result in a help book named `#{CFBundleName}.help`,
+  # instead. This can be useful if you are building help books from scripts via
+  # XCode, and you set `help_output_location` to `ENV['BUILT_PRODUCTS_DIR']`.
+  # @return [Boolean] `true` or `false` to enable or disable this behavior.
 
   # @!attribute [rw] options[:img_auto_extensions]=
   # This option determines whether or not to support specifying images without
@@ -136,14 +154,21 @@ class Middlemac < ::Middleman::Extension
     dir = options[:help_output_location] || File.expand_path('./')
     cf_bundle_name = app.config[:targets][app.config[:target]][:CFBundleName]
     target = app.config[:target]
-    output_name = "#{cf_bundle_name} (#{target}).help".gsub(' ', '_')
+    
+    if options[:help_output_use_target]
+      output_name = "#{cf_bundle_name} (#{target}).help"
+    else
+      output_name = "#{cf_bundle_name}.help"
+    end
+    output_name.gsub!(' ', '_') if options[:help_output_avoid_spaces]
+    
     app.config[:build_dir] = File.join(dir, output_name, 'Contents')
 
     return if app.config[:exit_before_ready]
 
     # Set the other directories accordingly.
     app.config[:layouts_dir]    = File.join(app.config[:assets_dir], app.config[:layouts_dir])
-    app.config[:partials_dir]  = File.join(app.config[:assets_dir], app.config[:partials_dir])
+    app.config[:partials_dir]   = File.join(app.config[:assets_dir], app.config[:partials_dir])
     app.config[:convention_dir] = File.join(app.config[:assets_dir], app.config[:convention_dir])
     app.config[:css_dir]        = File.join(app.config[:assets_dir], app.config[:css_dir])
     app.config[:fonts_dir]      = File.join(app.config[:assets_dir], app.config[:fonts_dir])

data/lib/middlemac/version.rb

@@ -1,5 +1,5 @@
 module Middleman
     module Middlemac
-        VERSION = '3.0.1'
+        VERSION = '3.1.0'
     end
 end

metadata

@@ -1,53 +1,53 @@
 --- !ruby/object:Gem::Specification
 name: middlemac
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.1.0
 platform: ruby
 authors:
 - Jim Derry
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-08 00:00:00.000000000 Z
+date: 2019-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: middleman-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 4.2.0
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 4.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 4.2.0
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 4.2.0
 - !ruby/object:Gem::Dependency
   name: middleman-cli
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 4.2.0
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 4.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 4.2.0
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 4.2.0
 - !ruby/object:Gem::Dependency
@@ -116,20 +116,20 @@ dependencies:
   name: middleman
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 4.2.0
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 4.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 4.2.0
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 4.2.0
 - !ruby/object:Gem::Dependency
@@ -196,6 +196,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitattributes"
 - ".gitignore"
 - ".yardopts"
 - CHANGELOG.md
@@ -624,8 +625,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Build complete macOS application help books using Middleman.