bookbindery 9.6.1 → 9.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e302ff6d4ab515306e9318852b35f5a76cbf31e9
-  data.tar.gz: e674caa968578818d6b1fc8c8caf3f17a5b4c1de
+  metadata.gz: fd201eb536834687e2551bb108e397c4ecc8e80f
+  data.tar.gz: 82aab6304ea515c297f37d94978041612f554870
 SHA512:
-  metadata.gz: 682616ee0377b5de0985029f3eef5bb9d78fb09826e0a4ef5c3464e0321c9457c13f332f30903775684a61105e3a4420e5c20793eaf283c7ad8e1242b2c7a82c
-  data.tar.gz: dd1ea778df634876b0464897b798f2913b3d062ba1647aaf22ba1c30481db5d202c5d5b2417e4730fa18b0ed485467a1734cc5ff161ecc8c39bcd5bba932e806
+  metadata.gz: e673fa3032769f9e17ba2dc50d54a757b447463fa827b5a67611e90010f55b4f3d6030fc41acc88dcadbfe9c09bc1dab1836b82fd7b3edf2979bca1b2dcfa202
+  data.tar.gz: e06cfc24fabe98f4db0e8720841db9d64b326be8b58194040a93d43b7c75669ce61a2349358eb35899351680067a46fffdecc129fc896301fceb055b3c5bcf13

data/bookbinder.gemspec

@@ -2,7 +2,7 @@ require 'base64'
 
 Gem::Specification.new do |s|
   s.name        = 'bookbindery'
-  s.version     = '9.6.1'
+  s.version     = '9.7.0'
   s.summary     = 'Markdown to Rackup application documentation generator'
   s.description = 'A command line utility to be run in Book repositories to stitch together their constituent Markdown repos into a static-HTML-serving application'
   s.authors     = ['Mike Grafton', 'Lucas Marks', 'Gavin Morgan', 'Nikhil Gajwani', 'Dan Wendorf', 'Brenda Chan', 'Matthew Boedicker', 'Andrew Bruce', 'Frank Kotsianas', 'Elena Sharma', 'Christa Hartsock', 'Michael Trestman', 'Alpha Chen', 'Sarah McAlear', 'Gregg Van Hove']

data/lib/bookbinder/subnav/navigation_entries_from_html_toc.rb

@@ -6,6 +6,7 @@ module Bookbinder
     class NavigationEntriesFromHtmlToc
       def initialize(fs)
         @fs = fs
+        @external_link_check = %r{\Ahttps?://}
       end
 
       def get_links(section, output_locations)
@@ -33,7 +34,9 @@ module Bookbinder
 
       def set_anchor_values(anchors)
         anchors.each do |anchor|
-          anchor['href'] = "/#{section.destination_directory}/#{anchor['href']}"
+          unless @external_link_check.match(anchor['href'])
+            anchor['href'] = "/#{section.destination_directory}/#{anchor['href']}"
+          end
         end
       end
 

data/master_middleman/bookbinder_helpers.rb

@@ -70,14 +70,9 @@ module Bookbinder
         current_page.add_metadata({page: {repo_link_disabled: true}})
       end
 
-      def render_repo_link(include_environments: [])
+      def render_repo_link
         if config[:repo_link_enabled] && repo_url && !current_page.metadata[:page][:repo_link_disabled]
-          id = 'repo-link'
-          whitelisted_envs = include_environments.join(" ")
-          default_display = 'display: none;'
-          display_text = 'View the source for this page in GitHub'
-
-          "<a id='#{id}' data-whitelist='#{whitelisted_envs}' style='#{default_display}' href='#{repo_url}'>#{display_text}</a>"
+          "<a id='repo-link' href='#{repo_url}'>View the source for this page in GitHub</a>"
         end
       end
 
@@ -92,7 +87,7 @@ module Bookbinder
 
         date = page_last_modified_date || parsed_default_date
 
-        "Page last updated: <span data-behavior=\"DisplayModifiedDate\" data-modified-date=\"#{date}\"></span>" if date
+        "Page last updated: <span data-behavior=\"DisplayModifiedDate\" data-modified-date=\"#{date.to_i}000\"></span>" if date
       end
 
       def breadcrumbs

data/master_middleman/source/javascripts/all.js

@@ -0,0 +1,2 @@
+//= require bookbinder
+//= require book

data/master_middleman/source/javascripts/book.js

@@ -0,0 +1 @@
+// Declare your book-specific javascript overrides in this file.

data/master_middleman/source/javascripts/bookbinder.js

@@ -0,0 +1,99 @@
+(function() {
+  var MONTHS = ['January', 'February', 'March', 'April', 'May', 'June', 'July', 'August', 'September', 'October', 'November', 'December'];
+
+  function toggleClass(el, className) {
+    var check = new RegExp("\\b" + className + "\\b");
+    if (check.test(el.className)) {
+      el.className = el.className.replace(check, '');
+    } else {
+      el.className += ' ' + className;
+    }
+  }
+
+  function openSubmenu(e) {
+    var el = e.currentTarget;
+    toggleClass(el, 'expanded');
+    e.stopPropagation();
+  }
+
+  function registerOnClick(el, handler) {
+    if (el.addEventListener) {
+      el.addEventListener('click', handler);
+    } else {
+      el.onclick = handler;
+    }
+  }
+
+  function toggleMainMenu(e) {
+    var el = e.currentTarget;
+    toggleClass(el.parentNode, 'menu-active');
+  }
+
+  function toggleSubMenu(e) {
+    var el = e.currentTarget;
+    toggleClass(el.parentNode, 'active');
+  }
+
+  function displayDate(millis) {
+    millis = parseInt(millis, 10);
+    var date = new Date(millis);
+
+    return [MONTHS[date.getMonth()], ' ', date.getDate(), ', ', date.getFullYear()].join('');
+  }
+
+  window.Bookbinder = {
+    startSidenav: function(rootEl, currentPath) {
+      var submenus = rootEl.querySelectorAll('.has_submenu');
+
+      for (var i = 0; i < submenus.length; i++) {
+        registerOnClick(submenus[i], openSubmenu);
+      }
+
+      if (currentPath) {
+        var currentLink = rootEl.querySelector('a[href="' + currentPath + '"]');
+        if (currentLink) {
+          currentLink.className += ' active';
+
+          var hasSubmenu = /\bhas_submenu\b/;
+          var subnavLocation = currentLink.parentNode;
+
+          while(subnavLocation.parentNode !== rootEl) {
+            subnavLocation = subnavLocation.parentNode;
+            if (hasSubmenu.test(subnavLocation.className)) {
+              subnavLocation.className += ' expanded';
+            }
+          }
+
+          rootEl.scrollTop = currentLink.offsetTop - rootEl.offsetTop;
+        }
+      }
+    },
+    mobileMainMenu: function(root) {
+      var mainMenus = root.querySelectorAll('[data-behavior=MenuMobile]');
+
+      for (var i = 0; i < mainMenus.length; i++) {
+        registerOnClick(mainMenus[i], toggleMainMenu);
+      }
+    },
+    mobileSubMenu: function(root) {
+      var subMenus = root.querySelectorAll('[data-behavior=SubMenuMobile]');
+
+      for (var i = 0; i < subMenus.length; i++) {
+        registerOnClick(subMenus[i], toggleSubMenu);
+      }
+    },
+    modifiedDates: function(root) {
+      var datesElements = root.querySelectorAll('[data-behavior=DisplayModifiedDate]');
+
+      for (var i = 0; i < datesElements.length; i++) {
+        datesElements[i].innerText = displayDate(datesElements[i].getAttribute('data-modified-date'));
+      }
+    },
+    boot: function() {
+      Bookbinder.startSidenav(document.querySelector('#sub-nav'), document.location.pathname);
+      Bookbinder.mobileMainMenu(document);
+      Bookbinder.mobileSubMenu(document);
+      Bookbinder.modifiedDates(document);
+    }
+  };
+})();

data/master_middleman/source/layouts/_page-footer.erb

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

data/master_middleman/source/layouts/layout.erb

@@ -18,7 +18,7 @@
   <%= stylesheet_link_tag 'book-styles', :media => 'screen, print' %>
   <link href='/images/favicon.ico' rel='shortcut icon'>
 
-  <script src="/javascripts/sidenav.js"></script>
+  <%= javascript_include_tag "all" %>
   <%= partial 'layouts/additional-scripts' %>
 </head>
 
@@ -56,6 +56,7 @@
           <a href="#top" title="back to top"></a>
         </div>
         <%= yield %>
+        <%= partial 'layouts/page-footer' %>
       </main>
     </div>
   </div>

data/master_middleman/source/stylesheets/base.scss

@@ -12,6 +12,7 @@
 @import "partials/header";
 @import "partials/footer";
 @import "partials/search";
+@import "partials/sidenav";
 
 
 // ~LAYOUT

data/master_middleman/source/stylesheets/partials/_footer.scss

@@ -55,6 +55,7 @@
 }
 
 #repo-link {
+  display: block;
   border-bottom: solid 1px #eceae9;
   border-top: solid 1px #eceae9;
   text-align: center;

data/master_middleman/source/stylesheets/partials/_mixins.scss

@@ -41,3 +41,13 @@
   }
   @return ($pxval / $base) * 1em;
 }
+
+@function rem($pxval, $base: $em-base) {
+  @if not unitless($pxval) {
+    $pxval: strip-units($pxval);
+  }
+  @if not unitless($base) {
+    $base: strip-units($base);
+  }
+  @return ($pxval / $base) * 1rem;
+}

data/master_middleman/source/stylesheets/partials/_sidenav.scss

@@ -1,3 +1,4 @@
+@import "compass/utilities/color/contrast";
 /*
  * FILE: _sidenav.scss
 ======================================================================== */
@@ -13,86 +14,28 @@ category: basics
   Doc Index
 </a>
 <div class="nav-content">
-  <ul class="menu">
-    <li class="menu-item js-menu-item">
-      <div class="menu-title js-menu-title">
+  <ul>
+    <li class="has_submenu">
+      <span>
         Side Nav Title 1
-      </div>
-      <div class="menu-content js-menu-content" aria-hidden="true">
-        <ul>
-          <li class="menu-link">
-            <a href="#">
-              Item
-            </a>
-          </li>
-          <li class="menu-link">
-            <a href="#">
-              Item
-            </a>
-          </li>
-        </ul>
-      </div>
+      </span>
+      <ul>
+        <li>
+          <a href="#">
+            Item
+          </a>
+        </li>
+        <li>
+          <a href="#">
+            Item
+          </a>
+        </li>
+      </ul>
     </li>
-    <li class="menu-item js-menu-item">
-      <div class="menu-title js-menu-title">
-        Side Nav Title 2
-      </div>
-      <div class="menu-content js-menu-content" aria-hidden="true">
-        <ul>
-          <li class="menu-link">
-            <a href="#">
-              Item
-            </a>
-          </li>
-          <li class="menu-link">
-            <a href="#">
-              Item
-            </a>
-          </li>
-        </ul>
-      </div>
-    </li>
-    <li class="menu-item js-menu-item">
-      <div class="menu-title js-menu-title">
-        Side Nav Item 3
-      </div>
-      <div class="menu-content js-menu-content" aria-hidden="true">
-        <div class="menu-subtitle">
-          Side Nav Subtitle
-        </div>
-        <ul>
-          <li class="menu-link">
-            <a href="#">
-              Item
-            </a>
-          </li>
-          <li class="menu-link">
-            <a href="#">
-              Item
-            </a>
-          </li>
-        </ul>
-        <div class="menu-subtitle">
-          Side Nav Subtitle
-        </div>
-        <ul>
-          <li class="menu-link">
-            <a href="#">
-              Item
-            </a>
-          </li>
-          <li class="menu-link">
-            <a href="#">
-              Item
-            </a>
-          </li>
-          <li class="menu-link">
-            <a href="#">
-              Item
-            </a>
-          </li>
-        </ul>
-      </div>
+    <li>
+      <a href="#">
+        Item
+      </a>
     </li>
   </ul>
 </div>
@@ -106,14 +49,16 @@ category: basics
   padding: 1em;
   text-align: center;
   text-transform: uppercase;
+
   @media (min-width: $bp-wide) {
     display: none;
   }
-}
-.sidenav-title:after {
-  @extend .fa;
-  content: $fa-var-angle-down;
-  padding-left: 1.5em;
+
+  &:after {
+    @extend .fa;
+    content: $fa-var-angle-down;
+    padding-left: 1.5em;
+  }
 }
 .sidenav-title:hover,
 .active .sidenav-title {
@@ -123,6 +68,7 @@ category: basics
 .active .sidenav-title:after {
   content: $fa-var-angle-up;
 }
+
 // ~SIDE NAVIGATION
 .nav-container {
   background: $gray5;
@@ -136,12 +82,14 @@ category: basics
   @include transition(all 0.2s linear);
   overflow: hidden;
   padding-left: 1em;
+
   @media (min-width: $bp-wide) {
     height: auto;
     display: block;
     opacity: 1;
     padding-left: 0;
   }
+
   @media (min-width: $bp-widest) {
     padding-left: 0.875em;
   }
@@ -193,7 +141,7 @@ category: basics
   background-color: transparentize($color-accent-bright, 0.8);
   border-style: solid;
   color: $gray1;
-  @extend %h-bold;
+  font-weight: 600;
 }
 
 

data/master_middleman/source/stylesheets/partials/_vars.scss

@@ -22,6 +22,7 @@ $gray6: #fdfdfd;
 
 $color-accent: $gray6;
 $color-accent-bright: $gray6;
+$color-access-bright-contrast: #000000;
 
 // text colors
 $color-header: $gray2;

data/template_app/rack_app.rb

@@ -18,6 +18,7 @@ module Bookbinder
       Rack::Builder.new do
         use ResolveRedirects, path
         use AuthorizeUser, auth
+        use Rack::Deflater
         map '/api/feedback' do
           use MailFeedback, client
           run Bookbinder::NotFound.new('public/404.html')
@@ -25,14 +26,7 @@ module Bookbinder
         map '/search' do
           run Bookbinder::Search::Handler.new
         end
-        if ENV['CUSTOM_ROOT']
-          map ENV['CUSTOM_ROOT'] do
-            run Bookbinder::Server
-          end
-          run Bookbinder::NotFound.new('public/404.html')
-        else
-          run Bookbinder::Server
-        end
+        run Bookbinder::Server
       end
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bookbindery
 version: !ruby/object:Gem::Version
-  version: 9.6.1
+  version: 9.7.0
 platform: ruby
 authors:
 - Mike Grafton
@@ -22,7 +22,7 @@ authors:
 autorequire: 
 bindir: install_bin
 cert_chain: []
-date: 2016-06-01 00:00:00.000000000 Z
+date: 2016-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fog-aws
@@ -434,13 +434,16 @@ files:
 - master_middleman/compass_runner.rb
 - master_middleman/config.rb
 - master_middleman/quicklinks_renderer.rb
-- master_middleman/source/javascripts/sidenav.js
+- master_middleman/source/javascripts/all.js
+- master_middleman/source/javascripts/book.js
+- master_middleman/source/javascripts/bookbinder.js
 - master_middleman/source/layouts/_additional-scripts.erb
 - master_middleman/source/layouts/_book-footer.erb
 - master_middleman/source/layouts/_book-search.erb
 - master_middleman/source/layouts/_book-title.erb
 - master_middleman/source/layouts/_header.erb
 - master_middleman/source/layouts/_local-header.erb
+- master_middleman/source/layouts/_page-footer.erb
 - master_middleman/source/layouts/layout.erb
 - master_middleman/source/stylesheets/base.scss
 - master_middleman/source/stylesheets/partials/_book-base-values.scss

data/master_middleman/source/javascripts/sidenav.js

@@ -1,53 +0,0 @@
-(function() {
-  var isExpanded = /\bexpanded\b/;
-
-  function openSubmenu(e) {
-    var el = e.currentTarget;
-    if (isExpanded.test(el.className)) {
-      el.className = el.className.replace(isExpanded, '');
-    } else {
-      el.className += ' expanded';
-    }
-    e.stopPropagation();
-  }
-
-  function registerOnClick(el) {
-    if (el.addEventListener) {
-      el.addEventListener('click', openSubmenu);
-    } else {
-      el.onclick = openSubmenu;
-    }
-  }
-
-  window.Bookbinder = {
-    startSidenav: function(rootEl, currentPath) {
-      var submenus = rootEl.querySelectorAll('.has_submenu');
-
-      for (var i = 0; i < submenus.length; i++) {
-        registerOnClick(submenus[i]);
-      }
-
-      if (currentPath) {
-        var currentLink = rootEl.querySelector('a[href="' + currentPath + '"]');
-        if (currentLink) {
-          currentLink.className += ' active';
-
-          var hasSubmenu = /\bhas_submenu\b/;
-          var subnavLocation = currentLink.parentNode;
-
-          while(subnavLocation.parentNode !== rootEl) {
-            subnavLocation = subnavLocation.parentNode;
-            if (hasSubmenu.test(subnavLocation.className)) {
-              subnavLocation.className += ' expanded';
-            }
-          }
-
-          rootEl.scrollTop = currentLink.offsetTop - rootEl.offsetTop;
-        }
-      }
-    },
-    boot: function() {
-      Bookbinder.startSidenav(document.querySelector('#sub-nav'), document.location.pathname);
-    }
-  };
-})();