bookbindery 9.5.0 → 9.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a7fb273894d32de11b696ffd383b8d55ded9b612
-  data.tar.gz: 916e689fdca4e2386643bfe17b85fce557fb46df
+  metadata.gz: 6fce8a509ec467f42d265301238c63732c561114
+  data.tar.gz: 102ee2ea961254302f89115dd2c48e1e1a5fdb2b
 SHA512:
-  metadata.gz: 4b2e0f90300f0ac55df5d5c48945a03b7249a07fdc4f4723d5e005ef1af611814490b64117a95aea9d5fdab925bced0f9c94d338ec841d6658dbbd88e6e67b5d
-  data.tar.gz: 534dbb03ae216b40205e25e9fc4495f23dda3ab6d90fb3e36201ac25b9c9e57a20d976741e5dd226ff9061bc483426050bfe05bd6148350520a31d09913ce59a
+  metadata.gz: e7f58749e6e832db572c4c65a2fe92decf59de7272c5c1d9c33904ce36ae3d248936a6b7c17796f1f9eef83141b84b1a356ec8c1f925653c00e579320e79cfe7
+  data.tar.gz: 100960ac745d0eb90ef8f7cb0cad49df23492a62fd9278aeb12773bb377cc7e3687bf89be10ba0f53a500ce3082599797a16ea9c08285d054a99e70f5d02c2d3

data/bookbinder.gemspec

@@ -2,7 +2,7 @@ require 'base64'
 
 Gem::Specification.new do |s|
   s.name        = 'bookbindery'
-  s.version     = '9.5.0'
+  s.version     = '9.6.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']
@@ -31,10 +31,12 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'nokogiri', ['1.6.7.2']
   s.add_runtime_dependency 'thor'
   s.add_runtime_dependency 'elasticsearch'
+  s.add_runtime_dependency 'font-awesome-sass'
 
   s.add_development_dependency 'license_finder'
   s.add_development_dependency 'pry-byebug'
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec'
   s.add_development_dependency 'sendgrid-ruby'
+  s.add_development_dependency 'jasmine'
 end

data/lib/bookbinder/commands/collection.rb

@@ -1,5 +1,5 @@
 Dir.glob(File.expand_path('../../commands/*.rb', __FILE__)).each do |command_file|
-  require command_file
+  require command_file unless command_file =~ /collection\.rb\z/
 end
 
 require_relative '../commands/components/bind/directory_preparer'

data/lib/bookbinder/commands/generate.rb

@@ -12,7 +12,7 @@ module Bookbinder
 
       def run(name, special_bookbinder_gem_args={})
         path = context_dir.join(name)
-        streams[:out].puts "Generating book at #{path}…"
+        streams[:out].puts "Generating book at #{path}..."
         if fs.file_exist?(path)
           streams[:err].puts "Cannot generate book: directory already exists"
           1

data/lib/bookbinder/css_link_checker.rb

@@ -42,14 +42,18 @@ module Bookbinder
       case link
         when data_uri then true
         when remote_uri then http_reachable?(link)
-        when absolute_uri then File.exists?(File.join('.', 'public', link))
+        when absolute_uri then File.exists?(File.join('.', 'public', path_info(link)))
         when relative_uri then
           dirs = dirs.split('/')[0...-1]
-          computed_uri = File.expand_path(File.join dirs, link)
+          computed_uri = File.expand_path(File.join dirs, path_info(link))
           File.exists?(computed_uri)
       end
     end
 
+    def path_info(link)
+      link.sub(/[?#].+\z/, '')
+    end
+
     def strip_location(id)
       dirs, filepath = id.split('=> ')
       [dirs, filepath]

data/lib/bookbinder/preprocessing/dita_html_preprocessor.rb

@@ -1,5 +1,5 @@
 require_relative '../values/subnav_template'
-require_relative '../../../lib/bookbinder/subnav/json_from_html_toc'
+require_relative '../../../lib/bookbinder/subnav/navigation_entries_from_html_toc'
 
 module Bookbinder
   module Preprocessing
@@ -43,7 +43,7 @@ module Bookbinder
 
       private
 
-      attr_reader :fs, :subnav_gen_factory, :dita_formatter, :command_creator, :sheller, :subnav_generator, :output_locations
+      attr_reader :fs, :subnav_gen_factory, :dita_formatter, :command_creator, :sheller, :output_locations
 
       def section_html_dir(section)
         output_locations.html_from_preprocessing_dir.join(section.destination_directory)
@@ -84,7 +84,7 @@ module Bookbinder
 
 
       def subnav_generator
-        @subnav_generator ||= subnav_gen_factory.produce(Subnav::JsonFromHtmlToc.new(fs))
+        @subnav_generator ||= subnav_gen_factory.produce(Subnav::NavigationEntriesFromHtmlToc.new(fs))
       end
     end
   end

data/lib/bookbinder/preprocessing/link_to_site_gen_dir.rb

@@ -1,5 +1,5 @@
 require_relative '../subnav/subnav_generator'
-require_relative '../subnav/json_from_markdown_toc'
+require_relative '../subnav/navigation_entries_from_markdown_root'
 
 module Bookbinder
   module Preprocessing
@@ -30,7 +30,7 @@ module Bookbinder
       private
 
       def subnav_generator(require_valid_subnav_links)
-        @subnav_generator ||= subnav_generator_factory.produce(Subnav::JsonFromMarkdownToc.new(filesystem, require_valid_subnav_links))
+        @subnav_generator ||= subnav_generator_factory.produce(Subnav::NavigationEntriesFromMarkdownRoot.new(filesystem, require_valid_subnav_links))
       end
 
       attr_reader :filesystem, :subnav_generator_factory

data/lib/bookbinder/subnav/{json_from_html_toc.rb → navigation_entries_from_html_toc.rb}

@@ -3,7 +3,7 @@ require 'active_support/all'
 
 module Bookbinder
   module Subnav
-    class JsonFromHtmlToc
+    class NavigationEntriesFromHtmlToc
       def initialize(fs)
         @fs = fs
       end
@@ -14,9 +14,7 @@ module Bookbinder
         doc = parse_toc_file
         set_anchor_values(doc.css('a'))
 
-        {
-          links: gather_urls_and_texts(doc.css('body > ul'))
-        }.to_json
+        gather_urls_and_texts(doc.css('body > ul'))
       end
 
       private
@@ -47,7 +45,7 @@ module Bookbinder
           text = anchor.inner_text
           ul = li.css('> ul')
           if ul.size > 0
-            {url: href, text: text, nestedLinks: gather_urls_and_texts(ul)}
+            {url: href, text: text, nested_links: gather_urls_and_texts(ul)}
           else
             {url: href, text: text}
           end

data/lib/bookbinder/subnav/{json_from_markdown_toc.rb → navigation_entries_from_markdown_root.rb}

@@ -4,7 +4,7 @@ require 'redcarpet'
 
 module Bookbinder
   module Subnav
-    class JsonFromMarkdownToc
+    class NavigationEntriesFromMarkdownRoot
       SubnavDuplicateLinkError = Class.new(RuntimeError)
       SubnavBrokenLinkError = Class.new(RuntimeError)
       SubnavRootMissingError = Class.new(RuntimeError)
@@ -25,13 +25,13 @@ module Bookbinder
           if @require_valid_subnav_links
             raise SubnavRootMissingError.new('Subnav root not found at: ' + config.subnav_root)
           else
-            return {links: []}.to_json
+            return []
           end
         end
 
         @parsed_files = {Pathname(root) => '(root)'}
 
-        {links: gather_urls_and_texts(root)}.to_json
+        gather_urls_and_texts(root)
       end
 
       attr_reader :fs, :source_for_site_gen, :renderer, :config
@@ -67,7 +67,7 @@ module Bookbinder
           unless no_children
             @parsed_files[next_source] = source
             nested_urls_and_texts = gather_urls_and_texts(next_source)
-            nested_links.merge!(nestedLinks: nested_urls_and_texts) unless nested_urls_and_texts.empty?
+            nested_links.merge!(nested_links: nested_urls_and_texts) unless nested_urls_and_texts.empty?
           end
 
           {url: '/' + expanded_href.to_s, text: element.inner_text}.merge(nested_links)

data/lib/bookbinder/subnav/pdf_config_creator.rb

@@ -1,5 +1,4 @@
 require 'yaml'
-require "json"
 
 module Bookbinder
   module Subnav
@@ -9,9 +8,8 @@ module Bookbinder
         @output_locations = output_locations
       end
 
-      def create(props_filename, subnav_config)
-        json = JSON.parse(fs.read(props_location(props_filename)))
-        @links = format_links(json['links'])
+      def create(navigation_entries, subnav_config)
+        @links = format_links(navigation_entries)
 
         fs.overwrite(to: output_locations.pdf_config_dir.join(subnav_config.pdf_config),
                      text: config_content)
@@ -26,7 +24,7 @@ module Bookbinder
       end
 
       def format_links(links)
-        links.map{|item| item['url'] }.compact.map{|link| link.sub(/^\//, '')}
+        links.map{|item| item[:url] }.compact.map{|link| link.sub(/^\//, '')}
       end
 
       def config_content

data/lib/bookbinder/subnav/subnav_generator.rb

@@ -1,22 +1,25 @@
 module Bookbinder
   module Subnav
     class SubnavGenerator
-      def initialize(json_props_creator, template_creator, pdf_config_creator)
-        @json_props_creator = json_props_creator
+      def initialize(navigation_entries_parser, template_creator, pdf_config_creator, output_locations)
+        @navigation_entries_parser = navigation_entries_parser
         @template_creator = template_creator
         @pdf_config_creator = pdf_config_creator
+        @output_locations = output_locations
       end
 
       def generate(subnav_spec)
-        filename = json_props_creator.create(subnav_spec)
-        template_creator.create(filename, subnav_spec)
-        pdf_config_creator.create(filename, subnav_spec) if pdf?(subnav_spec)
+        navigation_entries = navigation_entries_parser.get_links(subnav_spec, output_locations)
+        template_creator.create(navigation_entries, subnav_spec)
+        pdf_config_creator.create(navigation_entries, subnav_spec) if pdf?(subnav_spec)
       end
 
-      attr_reader :json_props_creator, :template_creator, :pdf_config_creator
+      attr_reader :navigation_entries_parser, :template_creator, :pdf_config_creator
 
       private
 
+      attr_reader :output_locations
+
       def pdf?(subnav_spec)
         subnav_spec.respond_to?(:pdf_config) && subnav_spec.pdf_config
       end

data/lib/bookbinder/subnav/subnav_generator_factory.rb

@@ -1,7 +1,5 @@
-require_relative 'json_props_creator'
 require_relative 'template_creator'
 require_relative 'pdf_config_creator'
-require_relative '../html_document_manipulator'
 
 module Bookbinder
   module Subnav
@@ -12,19 +10,15 @@ module Bookbinder
       end
 
       def produce(json_generator)
-        SubnavGenerator.new(json_props_creator(json_generator), template_creator, pdf_config_creator)
+        SubnavGenerator.new(json_generator, template_creator, pdf_config_creator, output_locations)
       end
 
       attr_reader :fs, :output_locations
 
       private
 
-      def json_props_creator(json_generator)
-        @json_props_creator ||= JsonPropsCreator.new(fs, output_locations, json_generator)
-      end
-
       def template_creator
-        @template_creator ||= TemplateCreator.new(fs, output_locations, HtmlDocumentManipulator.new)
+        @template_creator ||= TemplateCreator.new(fs, output_locations)
       end
 
       def pdf_config_creator

data/lib/bookbinder/subnav/template_creator.rb

@@ -1,24 +1,20 @@
-require_relative '../../../lib/bookbinder/values/user_message'
-require_relative '../../../lib/bookbinder/colorizer'
-require_relative '../../../lib/bookbinder/terminal'
+require 'erb'
 
 module Bookbinder
   module Subnav
     class TemplateCreator
-      def initialize(fs, output_locations, html_doc_manipulator)
+      def initialize(fs, output_locations)
         @fs = fs
         @output_locations = output_locations
-        @html_doc_manipulator = html_doc_manipulator
       end
 
-      def create(props_filename, subnav_spec)
+      def create(navigation_entries, subnav_spec)
         template_content = fs.read(template_path)
-        nav_with_props = html_doc_manipulator.set_attribute(document: template_content,
-                                                            selector: 'div.nav-content',
-                                                            attribute: 'data-props-location',
-                                                            value: props_filename)
+        links_template = ERB.new(fs.read(subnavs_path.join('_nav-links.erb')))
 
-        fs.write(text: nav_with_props, to: subnav_destination(subnav_spec.subnav_name))
+        populated_nav = ERB.new(template_content).result(LinkHolder.new(navigation_entries, links_template).get_binding)
+
+        fs.write(text: populated_nav, to: subnav_destination(subnav_spec.subnav_name))
       end
 
       attr_reader :fs, :output_locations, :html_doc_manipulator
@@ -34,21 +30,37 @@ module Bookbinder
       end
 
       def template_path
-        deprecated_prefix = '_dita_' unless fs.file_exist?(subnavs_path.join('subnav_template.erb'))
-
-        if deprecated_prefix
-          Terminal.new(Colorizer.new).update(UserMessage.new(
-            "Use of '_dita_subnav_template.erb' is deprecated. " +
-              "The preferred template is 'subnav_template.erb'. Please rename your file.",
-            EscalationType.warn
-          ))
-        end
-        subnavs_path.join("#{deprecated_prefix}subnav_template.erb")
+        subnavs_path.join('_subnav_template.erb')
       end
 
       def subnav_destination(name)
         subnavs_path.join(filename(name))
       end
+
+      class LinkHolder
+        def initialize(links, template)
+          @links = links
+          @template = template
+        end
+
+        attr_reader :links
+
+        def get_binding
+          binding
+        end
+
+        def render_links(some_links)
+          @template.result(LinkHolder.new(some_links, @template).get_binding)
+        end
+
+        def submenu_class(link)
+          'has_submenu' unless links?(link[:nested_links])
+        end
+
+        def links?(links)
+          (links || []).empty?
+        end
+      end
     end
   end
 end

data/master_middleman/archive_drop_down_menu.rb

@@ -1,7 +1,7 @@
 module Bookbinder
   class ArchiveDropDownMenu
     def initialize(config, current_path: nil)
-      @config = config || default_config
+      @config = config_with_default(config)
       @current_path = current_path
     end
 
@@ -35,8 +35,8 @@ module Bookbinder
       File.dirname(current_path)
     end
 
-    def default_config
-      { root_menu_reference => empty_menu }
+    def config_with_default(config)
+      { root_menu_reference => empty_menu }.merge(config || {})
     end
 
     def empty_menu

data/master_middleman/bookbinder_helpers.rb

@@ -144,7 +144,7 @@ module Bookbinder
           path = current_path.dup
         end
         basename = File.basename(path)
-        dirname = File.dirname(path).gsub(/\./, '_')
+        dirname = File.dirname(path).gsub('.', '_')
         page_classes(File.join(dirname, basename), options)
       end
 

data/master_middleman/source/javascripts/sidenav.js

@@ -0,0 +1,45 @@
+(function() {
+  var isExpanded = /\bexpanded\b/;
+
+  function openSubmenu(e) {
+    var el = e.srcElement;
+    if (isExpanded.test(el.className)) {
+      el.className = el.className.replace(isExpanded, '');
+    } else {
+      el.className += ' expanded';
+    }
+    e.stopPropagation();
+  }
+
+  window.Bookbinder = {
+    startSidenav: function(rootEl, currentPath) {
+      var submenus = rootEl.querySelectorAll('.has_submenu');
+
+      for (var i = 0; i < submenus.length; i++) {
+        submenus[i].onclick = 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;
+        }
+      }
+    },
+    boot: function() {
+      Bookbinder.startSidenav(document.querySelector('#sub-nav'), document.location.pathname);
+    }
+  };
+})();

data/master_middleman/source/layouts/_book-title.erb

@@ -0,0 +1,3 @@
+<!--Default title-->
+<!--If book needs something different, add a book-title partial to the book's layouts folder-->
+<%= vars.title %>

data/master_middleman/source/layouts/_header.erb

@@ -0,0 +1,34 @@
+<% if current_page.data.title %> <%# this is a proxy for if !homepage %>
+  <header class="header header-layout">
+    <h1 class="logo">
+      <a href="/"><%= vars.book_title || 'Default Book Title' %></a>
+    </h1>
+    <%= yield_for_archive_drop_down_menu %>
+    <div class="header-links js-bar-links">
+      <div class="btn-menu" data-behavior="MenuMobile"></div>
+      <%= vars.product_link %>
+      <div class="header-item">
+        <%= vars.support_link %>
+      </div>
+      <%= partial 'layouts/book-search' %>
+    </div>
+  </header>
+<% else %>
+  <header class="header-home">
+    <div class="home-links js-bar-links">
+      <div class="btn-menu" data-behavior="MenuMobile"></div>
+      <%= vars.product_link %>
+      <div class="header-item">
+        <%= vars.support_call_to_action %>
+      </div>
+      <%= partial 'layouts/book-search' %>
+    </div>
+    <h1 class="title-flashy">
+      <%= partial 'layouts/book-title' %>
+    </h1>
+
+    <h2 class="title-intro">
+      <%= vars.hero_text %>
+    </h2>
+  </header>
+<% end %>