bookbindery 6.0.0 → 7.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c73a7a9a4f263f7730ce38c6e09b98ae457a9571
-  data.tar.gz: bbd94c2710ce6052e2ad401525b9e024a584245b
+  metadata.gz: 0fb5495aa9aaa1b4337177fd9659ff1770edb7d1
+  data.tar.gz: 6aaa6711faed7f97fb649b8f0a7d76b259fdbc6d
 SHA512:
-  metadata.gz: e6dbef842e82feb7bb9e4ab4dd273cc25bee08d6fb0ce4119f041c304e461ecca957269b2a96b96677e8ab03e8bfb05579654a9b47f1ff4cebe3e82723d76e5a
-  data.tar.gz: c6331e3c72ee6a989f26b879d1234f2e9ae1d809b10c50bc6e2e8e633157ee155d6ffa97b7243e1d9f7944b18d532d0ed1eaa517fb7876f3fae6377db8883e2f
+  metadata.gz: d9d3278fb5effbab9c2591a5700685a78af34d9095a28d16dd1eb95144188fa498607a920cbc30224347ae972ec7e870a6a88be060e7091e7961fd609762865b
+  data.tar.gz: ae8ebb4008aedf58c261ce94ab0569ea8bec4caacf367ce9c2b5f611523b5793cc9650b9f987579cb95b507fd64f20d5a5ed5b1d5b688e345c75a656ee6cd98b

data/bookbinder.gemspec

@@ -2,7 +2,7 @@ require 'base64'
 
 Gem::Specification.new do |s|
   s.name        = 'bookbindery'
-  s.version     = '6.0.0'
+  s.version     = '7.0.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', 'Frank Kotsianas', 'Elena Sharma', 'Christa Hartsock']
@@ -14,7 +14,7 @@ Gem::Specification.new do |s|
   s.bindir      = 'install_bin'
   s.executable  = 'bookbinder'
 
-  s.required_ruby_version = '~> 2.0'
+  s.required_ruby_version = '>= 2.0'
   s.add_runtime_dependency 'fog-aws', ['~> 0.7.1']
   s.add_runtime_dependency 'ansi', ['~> 1.4']
   s.add_runtime_dependency 'unf', ['~> 0.1']

data/lib/bookbinder/commands/bind.rb

@@ -68,7 +68,8 @@ module Bookbinder
           sections,
           output_locations,
           options: bind_options.options,
-          output_streams: bind_options.streams
+          output_streams: bind_options.streams,
+          config: bind_config
         )
         if file_system_accessor.file_exist?('redirects.rb')
           file_system_accessor.copy('redirects.rb', output_locations.final_app_dir)

data/lib/bookbinder/commands/bind/directory_preparer.rb

@@ -1,3 +1,5 @@
+require_relative 'layout_preparer'
+
 module Bookbinder
   module Commands
     module BindComponents
@@ -13,8 +15,7 @@ module Bookbinder
           copy_directory_from_gem(gem_root, 'template_app', output_locations.final_app_dir)
           copy_directory_from_gem(gem_root, 'master_middleman', output_locations.site_generator_home)
 
-          layout_repo_path = fetch_layout_repo(config, cloner)
-          fs.copy_contents(layout_repo_path, output_locations.site_generator_home)
+          LayoutPreparer.new(fs).prepare(output_locations, cloner, config)
         end
 
         private
@@ -24,16 +25,6 @@ module Bookbinder
         def copy_directory_from_gem(gem_root, dir, output_dir)
           fs.copy_contents(File.join(gem_root, dir), output_dir)
         end
-
-        def fetch_layout_repo(config, cloner)
-          if config.has_option?('layout_repo')
-            cloned_repo = cloner.call(source_repo_name: config.layout_repo,
-                          destination_parent_dir: Dir.mktmpdir)
-            cloned_repo.path
-          else
-            File.absolute_path('master_middleman')
-          end
-        end
       end
     end
   end

data/lib/bookbinder/commands/bind/layout_preparer.rb

@@ -0,0 +1,23 @@
+module Bookbinder
+  module Commands
+    module BindComponents
+      class LayoutPreparer
+        def initialize(fs)
+          @fs = fs
+        end
+
+        attr_reader :fs
+
+        def prepare(output_locations, cloner, config)
+          if config.has_option?('layout_repo')
+            cloned_repo = cloner.call(source_repo_name: config.layout_repo,
+                                      destination_parent_dir: Dir.mktmpdir)
+
+            fs.copy_contents(cloned_repo.path, output_locations.site_generator_home)
+          end
+          fs.copy_contents(File.absolute_path('master_middleman'), output_locations.site_generator_home)
+        end
+      end
+    end
+  end
+end

data/lib/bookbinder/commands/collection.rb

@@ -19,8 +19,9 @@ require_relative '../postprocessing/sitemap_writer'
 require_relative '../preprocessing/dita_preprocessor'
 require_relative '../preprocessing/link_to_site_gen_dir'
 require_relative '../preprocessing/preprocessor'
+require_relative '../subnav/subnav_generator_factory'
 require_relative '../sheller'
-require_relative '../subnav_formatter'
+require_relative '../subnav/json_from_html'
 require_relative '../values/output_locations'
 
 module Bookbinder
@@ -87,7 +88,7 @@ module Bookbinder
       def bind
         @bind ||= Commands::Bind.new(
           streams,
-          OutputLocations.new(final_app_dir: final_app_directory, context_dir: File.absolute_path('.')),
+          output_locations,
           configuration_fetcher,
           Config::ArchiveMenuConfiguration.new(loader: config_loader, config_filename: 'bookbinder.yml'),
           local_filesystem_accessor,
@@ -95,12 +96,12 @@ module Bookbinder
           Postprocessing::SitemapWriter.build(logger, final_app_directory, sitemap_port),
           Preprocessing::Preprocessor.new(
             Preprocessing::DitaPreprocessor.new(
-              DitaHtmlToMiddlemanFormatter.new(local_filesystem_accessor, subnav_formatter, html_document_manipulator),
+              DitaHtmlToMiddlemanFormatter.new(local_filesystem_accessor, dita_json_generator, html_document_manipulator),
               local_filesystem_accessor,
               DitaCommandCreator.new(ENV['PATH_TO_DITA_OT_LIBRARY']),
               sheller
             ),
-            Preprocessing::LinkToSiteGenDir.new(local_filesystem_accessor),
+            Preprocessing::LinkToSiteGenDir.new(local_filesystem_accessor, subnav_generator_factory)
           ),
           Ingest::ClonerFactory.new(streams, local_filesystem_accessor, version_control_system),
           Ingest::SectionRepository.new,
@@ -112,11 +113,11 @@ module Bookbinder
         @watch ||= Commands::Watch.new(
           streams,
           middleman_runner: runner,
-          output_locations: OutputLocations.new(final_app_dir: final_app_directory, context_dir: File.absolute_path('.')),
+          output_locations: output_locations,
           config_fetcher: configuration_fetcher,
           config_decorator: Config::ArchiveMenuConfiguration.new(loader: config_loader, config_filename: 'bookbinder.yml'),
           file_system_accessor: local_filesystem_accessor,
-          preprocessor: Preprocessing::Preprocessor.new(Preprocessing::LinkToSiteGenDir.new(local_filesystem_accessor)),
+          preprocessor: Preprocessing::Preprocessor.new(Preprocessing::LinkToSiteGenDir.new(local_filesystem_accessor, subnav_generator_factory)),
           cloner: local_file_system_cloner,
           section_repository: Ingest::SectionRepository.new,
           directory_preparer: directory_preparer
@@ -146,6 +147,7 @@ module Bookbinder
           Config::RemoteYamlCredentialProvider.new(logger, version_control_system)
         ).tap do |fetcher|
           fetcher.set_config_file_path './config.yml'
+          fetcher.set_config_dir_path './config/'
         end
       end
 
@@ -153,16 +155,28 @@ module Bookbinder
         @config_loader ||= Config::YAMLLoader.new
       end
 
+      def subnav_generator_factory
+        Subnav::SubnavGeneratorFactory.new(local_filesystem_accessor, output_locations)
+      end
+
+      def json_generator
+        Subnav::JsonFromConfig.new
+      end
+
       def directory_preparer
         Commands::BindComponents::DirectoryPreparer.new(local_filesystem_accessor)
       end
 
+      def output_locations
+        OutputLocations.new(final_app_dir: final_app_directory, context_dir: File.absolute_path('.'))
+      end
+
       def final_app_directory
         @final_app_directory ||= File.absolute_path('final_app')
       end
 
-      def subnav_formatter
-        @subnav_formatter ||= SubnavFormatter.new
+      def dita_json_generator
+        Subnav::JsonFromHtml.new
       end
 
       def html_document_manipulator

data/lib/bookbinder/commands/watch.rb

@@ -51,7 +51,8 @@ module Bookbinder
         preprocessor.preprocess(
           sections,
           output_locations,
-          output_streams: streams
+          output_streams: streams,
+          config: watch_config
         )
         if file_system_accessor.file_exist?('redirects.rb')
           file_system_accessor.copy('redirects.rb', output_locations.final_app_dir)

data/lib/bookbinder/config/checkers/subnavs_checker.rb

@@ -0,0 +1,49 @@
+module Bookbinder
+  module Config
+    module Checkers
+      class SubnavsChecker
+        MissingRequiredKeyError = Class.new(RuntimeError)
+        MissingSubnavsKeyError = Class.new(RuntimeError)
+        MissingSubnavNameError = Class.new(RuntimeError)
+
+        def check(config)
+          @config = config
+
+          if section_subnav_names.count > 0
+            if config.subnavs.empty?
+               MissingSubnavsKeyError.new("You must specify at least one subnav under the subnavs key in config.yml")
+            elsif missing_subnavs.count != 0
+              MissingSubnavNameError.new("Your config.yml is missing required subnav names under the subnavs key. Required subnav names are #{missing_subnavs.join(", ")}.")
+            elsif invalid_subnavs.any?
+              MissingRequiredKeyError.new("Your config.yml is missing required key(s) for subnavs #{invalid_subnav_names}. Required keys are #{required_subnav_keys.join(", ")}.")
+            end
+          end
+        end
+
+        attr_reader :config
+
+        private
+
+        def invalid_subnavs
+          config.subnavs.map {|subnav_config| subnav_config unless subnav_config.valid? }
+        end
+
+        def invalid_subnav_names
+          invalid_subnavs.map(&:name).join(", ")
+        end
+
+        def missing_subnavs
+          section_subnav_names - config.subnavs.map(&:name)
+        end
+
+        def required_subnav_keys
+          Bookbinder::Config::SubnavConfig::CONFIG_REQUIRED_KEYS
+        end
+
+        def section_subnav_names
+          config.sections.map(&:subnav_name).compact.uniq
+        end
+      end
+    end
+  end
+end

data/lib/bookbinder/config/checkers/topics_checker.rb

@@ -0,0 +1,37 @@
+module Bookbinder
+  module Config
+    module Checkers
+      class TopicsChecker
+        MissingRequiredKeyError = Class.new(RuntimeError)
+
+        def check(config)
+          @config = config
+
+          if invalid_subnavs.any?
+            MissingRequiredKeyError.new("Your config.yml is missing required key(s) for subnav(s) #{invalid_subnav_names}. Required keys are #{required_topic_keys.join(", ")}.")
+          end
+        end
+
+        attr_reader :config
+
+        private
+
+        def invalid_subnavs
+          config.subnavs.select { |subnav_config| invalid_topics(subnav_config.topics).any? }
+        end
+
+        def invalid_topics(topics)
+          topics.map {|topic| topic unless topic.valid? }
+        end
+
+        def invalid_subnav_names
+          invalid_subnavs.map(&:name).join(', ')
+        end
+
+        def required_topic_keys
+          Bookbinder::Config::TopicConfig::CONFIG_REQUIRED_KEYS
+        end
+      end
+    end
+  end
+end

data/lib/bookbinder/config/configuration.rb

@@ -1,6 +1,7 @@
 require_relative '../ingest/destination_directory'
 require_relative '../ingest/repo_identifier'
 require_relative 'section_config'
+require_relative 'subnav_config'
 
 module Bookbinder
   module Config
@@ -65,10 +66,11 @@ module Bookbinder
 
       def initialize(config)
         @config = config
+        @subnavs = assemble_subnavs || []
       end
 
       CONFIG_REQUIRED_KEYS = %w(book_repo public_host)
-      CONFIG_OPTIONAL_KEYS = %w(archive_menu book_repo_url cred_repo cred_repo_url layout_repo layout_repo_url sections)
+      CONFIG_OPTIONAL_KEYS = %w(archive_menu book_repo_url cred_repo cred_repo_url layout_repo layout_repo_url sections subnav_exclusions)
 
       CONFIG_REQUIRED_KEYS.each do |method_name|
         define_method(method_name) do
@@ -108,8 +110,19 @@ module Bookbinder
 
       alias_method :eql?, :==
 
+      attr_reader :subnavs
+
       private
 
+      def assemble_subnavs
+        if config[:subnavs]
+          config[:subnavs].map do |subnav|
+            subnav.merge!({'subnav_exclusions' => subnav_exclusions})
+            Config::SubnavConfig.new(subnav)
+          end
+        end
+      end
+
       attr_reader :config
     end
   end

data/lib/bookbinder/config/fetcher.rb

@@ -13,7 +13,10 @@ module Bookbinder
       end
 
       def fetch_config
-        @config ||= validate(read_config_file)
+        @base_config ||= read_config_file
+        @optional_configs ||= read_optional_configs
+
+        @config ||= validate(@base_config, @optional_configs)
       end
 
       def fetch_credentials(environment = 'null-environment')
@@ -29,13 +32,17 @@ module Bookbinder
         }
       end
 
-      def set_config_file_path config_file_path
-        @config_file_path = File.expand_path config_file_path
+      def set_config_dir_path(config_dir_path)
+        @config_dir_path = File.expand_path(config_dir_path)
+      end
+
+      def set_config_file_path(config_file_path)
+        @config_file_path = File.expand_path(config_file_path)
       end
 
       private
 
-      attr_reader(:loader, :configuration_validator, :config, :config_file_path,
+      attr_reader(:loader, :configuration_validator, :config, :config_file_path, :config_dir_path,
                   :credentials_provider)
 
       def read_config_file
@@ -44,17 +51,29 @@ module Bookbinder
       rescue FileNotFoundError => e
         raise "The configuration file specified does not exist. Please create a config #{e} file at #{config_file_path} and try again."
       rescue InvalidSyntaxError => e
-        raise "There is a syntax error in your config file: \n #{e}"
+        raise syntax_error(e)
+      end
+
+      def read_optional_configs
+        Dir["#{config_dir_path}/*.yml"].map do |config_file|
+          loader.load(File.expand_path(config_file)) || {}
+        end.reduce({}, :merge)
+      rescue InvalidSyntaxError => e
+        raise syntax_error(e)
       end
 
-      def validate(config_hash)
-        raise 'Your config.yml appears to be empty. Please check and try again.' unless config_hash
+      def validate(base_hash, optional_hash)
+        raise 'Your config.yml appears to be empty. Please check and try again.' unless base_hash
 
-        Configuration.parse(config_hash).tap do |config|
+        Configuration.parse(base_hash.merge(optional_hash)).tap do |config|
           errors = configuration_validator.exceptions(config)
           raise errors.first if errors.any?
         end
       end
+
+      def syntax_error(e)
+        "There is a syntax error in your config file: \n #{e}"
+      end
     end
   end
 end

data/lib/bookbinder/config/section_config.rb

@@ -11,6 +11,10 @@ module Bookbinder
         config['subnav_template']
       end
 
+      def subnav_name
+        config['subnav_name']
+      end
+
       def desired_directory_name
         config['directory']
       end

data/lib/bookbinder/config/subnav_config.rb

@@ -0,0 +1,41 @@
+require_relative '../config/topic_config'
+
+module Bookbinder
+  module Config
+    class SubnavConfig
+      def initialize(config)
+        @config = config
+        @topics = assemble_topics || []
+      end
+
+      def name
+        config['name']
+      end
+
+      def pdf_config
+        config['pdf_config']
+      end
+
+      def subnav_exclusions
+        config['subnav_exclusions'] || []
+      end
+
+      def valid?
+        (CONFIG_REQUIRED_KEYS - config.keys).empty?
+      end
+
+      CONFIG_REQUIRED_KEYS = %w(name topics)
+
+      attr_reader :topics
+
+      private
+
+      attr_reader :config
+
+      def assemble_topics
+        config['topics'].map{|topic| Config::TopicConfig.new(topic)} if config['topics']
+      end
+    end
+  end
+end
+

data/lib/bookbinder/config/topic_config.rb

@@ -0,0 +1,29 @@
+module Bookbinder
+  module Config
+    class TopicConfig
+      def initialize(config)
+        @config = config
+      end
+
+      def title
+        config['title']
+      end
+
+      def toc_path
+        Pathname(config['toc_path'])
+      end
+
+      def toc_nav_name
+        config['toc_nav_name'] || title
+      end
+
+      def valid?
+        (CONFIG_REQUIRED_KEYS - config.keys).empty?
+      end
+
+      CONFIG_REQUIRED_KEYS = %w(title toc_path)
+
+      attr_reader :config
+    end
+  end
+end

data/lib/bookbinder/config/validator.rb

@@ -3,6 +3,8 @@ require_relative 'checkers/archive_menu_checker'
 require_relative 'checkers/required_keys_checker'
 require_relative 'checkers/repository_name_presence_checker'
 require_relative 'checkers/dita_section_checker'
+require_relative 'checkers/subnavs_checker'
+require_relative 'checkers/topics_checker'
 
 module Bookbinder
   module Config
@@ -17,7 +19,9 @@ module Bookbinder
           Checkers::DuplicateSectionNameChecker.new,
           Checkers::RepositoryNamePresenceChecker.new,
           Checkers::DitaSectionChecker.new,
-          Checkers::ArchiveMenuChecker.new(@file_system_accessor)
+          Checkers::ArchiveMenuChecker.new(@file_system_accessor),
+          Checkers::SubnavsChecker.new,
+          Checkers::TopicsChecker.new
         ].map do |checker|
           checker.check(config)
         end

data/lib/bookbinder/dita_command_creator.rb

@@ -24,13 +24,13 @@ module Bookbinder
           write_to: write_to,
           dita_flags: dita_flags,
           ditamap_path: dita_section.path_to_preprocessor_attribute('ditamap_location'),
-          ditaval_path: dita_section.path_to_preprocessor_attribute('ditaval_location'),
+          ditaval_path: dita_section.path_to_preprocessor_attribute('ditaval_location')
       )
     end
 
     private
 
-    def unduplicated_flags(write_to: nil, ditamap_path: nil, ditaval_path: nil, dita_flags: dita_flags)
+    def unduplicated_flags(write_to: nil, ditamap_path: nil, ditaval_path: nil, dita_flags: nil)
       arg_flags = {
           'output.dir' => write_to,
           'args.input' => ditamap_path,

data/lib/bookbinder/dita_html_to_middleman_formatter.rb

@@ -1,4 +1,4 @@
-require_relative 'values/subnav'
+require_relative 'values/subnav_template'
 
 module Bookbinder
 
@@ -40,7 +40,7 @@ module Bookbinder
                                                          selector: 'div.nav-content',
                                                          attribute: 'data-props-location',
                                                          value: json_props_location)
-      Subnav.new(formatted_json_links, nav_text)
+      SubnavTemplate.new(formatted_json_links, nav_text)
     end
 
     private

data/lib/bookbinder/ingest/section_repository.rb

@@ -1,5 +1,3 @@
-require 'tmpdir'
-require_relative '../deprecated_logger'
 require_relative '../values/section'
 
 module Bookbinder
@@ -21,6 +19,7 @@ module Bookbinder
             working_copy.full_name,
             section_config.desired_directory_name,
             section_config.subnav_template,
+            section_config.subnav_name,
             section_config.preprocessor_config
           )
         end

data/lib/bookbinder/local_filesystem_accessor.rb

@@ -20,6 +20,11 @@ module Bookbinder
       to
     end
 
+    def overwrite(to: nil, text: nil)
+      File.delete(to) if file_exist?(to)
+      write(to: to, text: text)
+    end
+
     def read(path)
       File.read(path)
     end
@@ -80,5 +85,14 @@ module Bookbinder
         reject {|p| p.to_s.match %r{/\.}}.
         reject(&:directory?)
     end
+
+    def find_files_extension_agnostically(pattern, directory='.')
+      extensionless_pattern = pattern.to_s.split('.').first
+
+      `find -L #{directory} -path '*/#{extensionless_pattern}.*'`.
+        lines.
+        map(&:chomp).
+        map(&Pathname.method(:new))
+    end
   end
 end

data/lib/bookbinder/preprocessing/dita_preprocessor.rb

@@ -1,4 +1,4 @@
-require_relative '../values/subnav'
+require_relative '../values/subnav_template'
 
 module Bookbinder
   module Preprocessing
@@ -18,7 +18,7 @@ module Bookbinder
         section.subnav_template.include?('dita_subnav') if section.subnav_template
       end
 
-      def preprocess(dita_sections, output_locations, options: [], output_streams: nil)
+      def preprocess(dita_sections, output_locations, options: [], output_streams: nil, **_)
         dita_options = dita_flags(options)
         dita_sections.each do |dita_section|
           if dita_section.path_to_preprocessor_attribute('ditamap_location')

data/lib/bookbinder/preprocessing/link_to_site_gen_dir.rb

@@ -1,26 +1,38 @@
+require_relative '../subnav/subnav_generator'
+require_relative '../subnav/json_from_config'
+
 module Bookbinder
   module Preprocessing
     class LinkToSiteGenDir
-      def initialize(filesystem)
+      def initialize(filesystem, subnav_generator_factory)
         @filesystem = filesystem
+        @subnav_generator_factory = subnav_generator_factory
       end
 
       def applicable_to?(section)
         filesystem.file_exist?(section.path_to_repository)
       end
 
-      def preprocess(sections, output_locations, *_)
+      def preprocess(sections, output_locations, config: nil, **_)
         sections.each do |section|
           filesystem.link_creating_intermediate_dirs(
             section.path_to_repository,
             output_locations.source_for_site_generator.join(section.destination_directory)
           )
         end
+
+        config.subnavs.each do |subnav|
+          subnav_generator.generate(subnav)
+        end
       end
 
       private
 
-      attr_reader :filesystem
+      def subnav_generator
+        @subnav_generator ||= subnav_generator_factory.produce(Subnav::JsonFromConfig.new(filesystem))
+      end
+
+      attr_reader :filesystem, :subnav_generator_factory
     end
   end
 end

data/lib/bookbinder/server_director.rb

@@ -2,7 +2,7 @@ require 'puma'
 
 module Bookbinder
   class ServerDirector
-    def initialize(app: app, directory: nil, port: 41722)
+    def initialize(app: nil, directory: nil, port: 41722)
       @app = app
       @directory = directory
       @port = port

data/lib/bookbinder/subnav/json_from_config.rb

@@ -0,0 +1,77 @@
+require 'json'
+require 'nokogiri'
+require 'redcarpet'
+
+module Bookbinder
+  module Subnav
+    class JsonFromConfig
+      def initialize(fs)
+        @fs = fs
+        @renderer = Redcarpet::Markdown.new(Redcarpet::Render::HTML.new)
+      end
+
+      def get_links(subnav_config, source_for_site_gen)
+        @source_for_site_gen = source_for_site_gen
+        @config = subnav_config
+
+        { links: get_links_and_headers }.to_json
+      end
+
+      attr_reader :fs, :source_for_site_gen, :renderer, :config
+
+      private
+
+      def get_links_and_headers
+        menu_items = []
+
+        config.topics.map do |topic|
+          menu_items << { text: topic.title, title: true }
+          menu_items << { url: "/#{topic.toc_path}.html", text: topic.toc_nav_name }
+
+          links_from_toc_page = parse_toc_file(topic)
+          links_from_toc_page.each {|link| menu_items << link}
+        end
+
+        menu_items
+      end
+
+      def parse_toc_file(topic)
+        toc_files = fs.find_files_extension_agnostically(topic.toc_path, source_for_site_gen)
+        toc_md = fs.read(toc_files.first)
+
+        toc_html = get_html(toc_md)
+
+        gather_urls_and_texts(toc_html.css('html'), topic)
+      end
+
+      def get_html(md)
+        Nokogiri::HTML(renderer.render(md))
+      end
+
+      def gather_urls_and_texts(base_node, topic)
+        nav_items(base_node).map do |element|
+          if element.name == 'h2' && !frontmatter_header?(element)
+            {text: element.inner_html}
+          else
+            list_elements = element.css('li > a', 'li > p > a')
+            list_elements.map do |li|
+              { url: "/#{topic.toc_path.dirname.join(li['href'])}", text: li.inner_text }
+            end
+          end
+        end.flatten
+      end
+
+      def nav_items(base_node)
+        base_node.css('h2, ul') - base_node.css(*exclusions)
+      end
+
+      def exclusions
+        @exclusions ||= config.subnav_exclusions << '.nav-exclude'
+      end
+
+      def frontmatter_header?(element)
+        element.inner_html.include?('title: ')
+      end
+    end
+  end
+end

data/lib/bookbinder/subnav/json_from_html.rb

@@ -0,0 +1,38 @@
+require 'nokogiri'
+require 'active_support/all'
+
+module Bookbinder
+  module Subnav
+    class JsonFromHtml
+      def get_links_as_json(raw_subnav_text, base_dirname)
+        doc = Nokogiri::XML(raw_subnav_text)
+
+        all_anchors = doc.css('a')
+        all_anchors.each do |anchor|
+          anchor['href'] = "/#{base_dirname}/#{anchor['href']}"
+        end
+
+        {
+          links: gather_urls_and_texts(doc.css('body > ul'))
+        }.to_json
+      end
+
+      private
+
+      def gather_urls_and_texts(base_node)
+        top_level_li = base_node.css("> li")
+        top_level_li.map do |li|
+          anchor = li.css('a')[0]
+          href = anchor['href']
+          text = anchor.inner_text
+          ul = li.css('> ul')
+          if ul.size > 0
+            {url: href, text: text, nestedLinks: gather_urls_and_texts(ul)}
+          else
+            {url: href, text: text}
+          end
+        end
+      end
+    end
+  end
+end

data/lib/bookbinder/subnav/json_props_creator.rb

@@ -0,0 +1,35 @@
+module Bookbinder
+  module Subnav
+    class JsonPropsCreator
+      def initialize(fs, output_locations, json_generator)
+        @fs = fs
+        @output_locations = output_locations
+        @json_generator = json_generator
+      end
+
+      def create(subnav_config)
+        json_links = json_generator.get_links(subnav_config, output_locations.source_for_site_generator)
+
+        fs.write(text: json_links, to: props_path(subnav_config.name))
+
+        filename(subnav_config.name)
+      end
+
+      attr_reader :fs, :output_locations, :json_generator
+
+      private
+
+      def filename(name)
+        "#{name}-props.json"
+      end
+
+      def subnavs_path
+        output_locations.subnavs_for_layout_dir
+      end
+
+      def props_path(name)
+        subnavs_path.join(filename(name))
+      end
+    end
+  end
+end

data/lib/bookbinder/subnav/pdf_config_creator.rb

@@ -0,0 +1,52 @@
+require 'yaml'
+require "json"
+
+module Bookbinder
+  module Subnav
+    class PdfConfigCreator
+      def initialize(fs, output_locations)
+        @fs = fs
+        @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'])
+
+        fs.overwrite(to: output_locations.pdf_config_dir.join(subnav_config.pdf_config),
+                     text: config_content)
+      end
+
+      attr_reader :fs, :output_locations
+
+      private
+
+      def props_location(filename)
+        output_locations.subnavs_for_layout_dir.join(filename)
+      end
+
+      def format_links(links)
+        links.map{|item| item['url'] }.compact.map{|link| link.sub(/^\//, '')}
+      end
+
+      def config_content
+        config_keys.inject({}) do |hash, key|
+          hash[key] = content_for(key)
+          hash
+        end.to_yaml
+      end
+
+      def config_keys
+        %w{copyright_notice header executable pages}
+      end
+
+      def content_for(key)
+        key == 'pages' ? @links : default_content
+      end
+
+      def default_content
+        'REPLACE ME'
+      end
+    end
+  end
+end

data/lib/bookbinder/subnav/subnav_generator.rb

@@ -0,0 +1,19 @@
+module Bookbinder
+  module Subnav
+    class SubnavGenerator
+      def initialize(json_props_creator, template_creator, pdf_config_creator)
+        @json_props_creator = json_props_creator
+        @template_creator = template_creator
+        @pdf_config_creator = pdf_config_creator
+      end
+
+      def generate(subnav_config)
+        filename = json_props_creator.create(subnav_config)
+        template_creator.create(filename, subnav_config)
+        pdf_config_creator.create(filename, subnav_config) if subnav_config.pdf_config
+      end
+
+      attr_reader :json_props_creator, :template_creator, :pdf_config_creator
+    end
+  end
+end

data/lib/bookbinder/subnav/subnav_generator_factory.rb

@@ -0,0 +1,35 @@
+require_relative 'json_props_creator'
+require_relative 'template_creator'
+require_relative 'pdf_config_creator'
+require_relative '../html_document_manipulator'
+
+module Bookbinder
+  module Subnav
+    class SubnavGeneratorFactory
+      def initialize(fs, output_locations)
+        @fs = fs
+        @output_locations = output_locations
+      end
+
+      def produce(json_generator)
+        SubnavGenerator.new(json_props_creator(json_generator), template_creator, pdf_config_creator)
+      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)
+      end
+
+      def pdf_config_creator
+        @pdf_config_creator ||= PdfConfigCreator.new(fs, output_locations)
+      end
+    end
+  end
+end

data/lib/bookbinder/subnav/template_creator.rb

@@ -0,0 +1,41 @@
+module Bookbinder
+  module Subnav
+    class TemplateCreator
+      def initialize(fs, output_locations, html_doc_manipulator)
+        @fs = fs
+        @output_locations = output_locations
+        @html_doc_manipulator = html_doc_manipulator
+      end
+
+      def create(props_filename, subnav_config)
+        template_content = fs.read(template_path)
+        nav_content = html_doc_manipulator.set_attribute(document: template_content,
+                                                         selector: 'div.nav-content',
+                                                         attribute: 'data-props-location',
+                                                         value: props_filename)
+
+        fs.write(text: nav_content, to: subnav_destination(subnav_config.name))
+      end
+
+      attr_reader :fs, :output_locations, :html_doc_manipulator
+
+      private
+
+      def subnavs_path
+        output_locations.subnavs_for_layout_dir
+      end
+
+      def filename(name)
+        "#{name}.erb"
+      end
+
+      def template_path
+        subnavs_path.join('subnav_template.erb')
+      end
+
+      def subnav_destination(name)
+        subnavs_path.join(filename(name))
+      end
+    end
+  end
+end

data/lib/bookbinder/values/output_locations.rb

@@ -62,6 +62,10 @@ module Bookbinder
       source_for_site_generator.join('subnavs')
     end
 
+    def pdf_config_dir
+      context_dir
+    end
+
     private
 
     def context_dir

data/lib/bookbinder/values/section.rb

@@ -6,6 +6,7 @@ module Bookbinder
                        :full_name,
                        :desired_directory_name,
                        :subnav_templ,
+                       :subnav_name,
                        :preprocessor_config) do
     def path_to_repository
       Pathname(self[:path_to_repository].to_s)
@@ -21,7 +22,7 @@ module Bookbinder
 
     def subnav
       namespace = destination_directory.to_s.gsub('/', '_')
-      template = subnav_template || 'default'
+      template = subnav_template || subnav_name || 'default'
       {namespace => template}
     end
 

data/lib/bookbinder/values/{subnav.rb → subnav_template.rb}

@@ -1,4 +1,4 @@
 module Bookbinder
-  Subnav = Struct.new(:json_links,
+  SubnavTemplate = Struct.new(:json_links,
                       :text)
-end
+end

data/master_middleman/archive_drop_down_menu.rb

@@ -15,6 +15,10 @@ module Bookbinder
       }
     end
 
+    def empty?
+      title.nil? && dropdown_links.empty?
+    end
+
     private
 
     attr_reader :config, :current_path

data/master_middleman/bookbinder_helpers.rb

@@ -48,9 +48,10 @@ module Bookbinder
           config[:archive_menu],
           current_path: current_page.path
         )
-
-        partial 'archive_menus/default', locals: { menu_title: menu.title,
-                                                   dropdown_links: menu.dropdown_links }
+        unless menu.empty?
+          partial 'archive_menus/default', locals: { menu_title: menu.title,
+                                                     dropdown_links: menu.dropdown_links }
+        end
       end
 
       def modified_date(format="%B %-d, %Y")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bookbindery
 version: !ruby/object:Gem::Version
-  version: 6.0.0
+  version: 7.0.0
 platform: ruby
 authors:
 - Mike Grafton
@@ -17,7 +17,7 @@ authors:
 autorequire: 
 bindir: install_bin
 cert_chain: []
-date: 2015-09-08 00:00:00.000000000 Z
+date: 2015-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fog-aws
@@ -301,6 +301,7 @@ files:
 - lib/bookbinder/command_validator.rb
 - lib/bookbinder/commands/bind/bind_options.rb
 - lib/bookbinder/commands/bind/directory_preparer.rb
+- lib/bookbinder/commands/bind/layout_preparer.rb
 - lib/bookbinder/commands/bind.rb
 - lib/bookbinder/commands/build_and_push_tarball.rb
 - lib/bookbinder/commands/chain.rb
@@ -322,10 +323,14 @@ files:
 - lib/bookbinder/config/checkers/duplicate_section_name_checker.rb
 - lib/bookbinder/config/checkers/repository_name_presence_checker.rb
 - lib/bookbinder/config/checkers/required_keys_checker.rb
+- lib/bookbinder/config/checkers/subnavs_checker.rb
+- lib/bookbinder/config/checkers/topics_checker.rb
 - lib/bookbinder/config/configuration.rb
 - lib/bookbinder/config/fetcher.rb
 - lib/bookbinder/config/remote_yaml_credential_provider.rb
 - lib/bookbinder/config/section_config.rb
+- lib/bookbinder/config/subnav_config.rb
+- lib/bookbinder/config/topic_config.rb
 - lib/bookbinder/config/validator.rb
 - lib/bookbinder/config/yaml_loader.rb
 - lib/bookbinder/css_link_checker.rb
@@ -370,11 +375,17 @@ files:
 - lib/bookbinder/spider.rb
 - lib/bookbinder/stabilimentum.rb
 - lib/bookbinder/streams/colorized_stream.rb
-- lib/bookbinder/subnav_formatter.rb
+- lib/bookbinder/subnav/json_from_config.rb
+- lib/bookbinder/subnav/json_from_html.rb
+- lib/bookbinder/subnav/json_props_creator.rb
+- lib/bookbinder/subnav/pdf_config_creator.rb
+- lib/bookbinder/subnav/subnav_generator.rb
+- lib/bookbinder/subnav/subnav_generator_factory.rb
+- lib/bookbinder/subnav/template_creator.rb
 - lib/bookbinder/terminal.rb
 - lib/bookbinder/values/output_locations.rb
 - lib/bookbinder/values/section.rb
-- lib/bookbinder/values/subnav.rb
+- lib/bookbinder/values/subnav_template.rb
 - lib/bookbinder/values/user_message.rb
 - template_app/app.rb
 - template_app/config.ru
@@ -385,6 +396,7 @@ files:
 - template_app/rack_app.rb
 - master_middleman/archive_drop_down_menu.rb
 - master_middleman/bookbinder_helpers.rb
+- master_middleman/compass_runner.rb
 - master_middleman/config.rb
 - master_middleman/quicklinks_renderer.rb
 - master_middleman/subdirectory_aware_assets.rb
@@ -400,7 +412,7 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ~>
+  - - '>='
     - !ruby/object:Gem::Version
       version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement

data/lib/bookbinder/subnav_formatter.rb

@@ -1,37 +0,0 @@
-require 'nokogiri'
-require 'active_support/all'
-
-module Bookbinder
-  class SubnavFormatter
-
-    def get_links_as_json(raw_subnav_text, base_dirname)
-      doc = Nokogiri::XML(raw_subnav_text)
-
-      all_anchors = doc.css('a')
-      all_anchors.each do |anchor|
-        anchor['href'] = "/#{base_dirname}/#{anchor['href']}"
-      end
-
-      {
-        links: gather_urls_and_texts(doc.css('body > ul'))
-      }.to_json
-    end
-
-    private
-
-    def gather_urls_and_texts(base_node)
-      top_level_li = base_node.css("> li")
-      top_level_li.map do |li|
-        anchor = li.css('a')[0]
-        href = anchor['href']
-        text = anchor.inner_text
-        ul = li.css('> ul')
-        if ul.size > 0
-          {url: href, text: text, nestedLinks: gather_urls_and_texts(ul)}
-        else
-          {url: href, text: text}
-        end
-      end
-    end
-  end
-end