bookbindery 8.0.0 → 8.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1a0d33f4425ffc7d20e10ef7d4db181383434597
-  data.tar.gz: 9e46a1a8c6a91b3c204b337c11db14b49b4297d6
+  metadata.gz: 6cb870420c8d260fe02e262c3d8db416a668a3fa
+  data.tar.gz: c2b4a7842bcdbcba9006096c7f5b4e08c04eff33
 SHA512:
-  metadata.gz: 64b3f89db50a12afb1d050d5a993c630061a46c158113a318508546e825da51e1b66d0e96bf3da7c92f9276d781a2e69655f1b2adcad8cf61c98d638e50d9ccf
-  data.tar.gz: a62cd292cbaa71a015a02d39f6cc88cdeab30f5f3837c72e05e874720b87c38dbc7b8f972e784680ab1b111b635cb8df042ccb0648afca9528ee41751d1e802a
+  metadata.gz: a45300da2301b2e37ea278f03d221d52592f9a6ad42429b349fe7169f75ae9b15aade134740f9c17a0effd101e807f00476f73970a8a4573ffea1a3ce0210e50
+  data.tar.gz: 1b3fa518acaa00628b2115d4c166df2272d08ca564416565a36e3d60aa69c82404d8dd97de84f2ed939eb2a04b608b11d8e4dfce8eadcb37f0d042f0a607c8e6

data/bookbinder.gemspec

@@ -2,7 +2,7 @@ require 'base64'
 
 Gem::Specification.new do |s|
   s.name        = 'bookbindery'
-  s.version     = '8.0.0'
+  s.version     = '8.1.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', 'Michael Trestman']
@@ -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.3.0'
   s.add_runtime_dependency 'fog-aws', ['~> 0.7.1']
   s.add_runtime_dependency 'ansi', ['~> 1.4']
   s.add_runtime_dependency 'unf', ['~> 0.1']
@@ -30,6 +30,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'therubyracer'
   s.add_runtime_dependency 'git', '~> 1.2.8'
   s.add_runtime_dependency 'nokogiri', ['1.6.7.2']
+  s.add_runtime_dependency 'thor'
 
   s.add_development_dependency 'license_finder'
   s.add_development_dependency 'pry-byebug'

data/install_bin/bookbinder

@@ -1,7 +1,5 @@
 #!/usr/bin/env ruby
 
 require_relative '../lib/bookbinder/cli'
-require_relative '../lib/bookbinder/ingest/git_accessor'
 
-return_code = Bookbinder::Cli.new(Bookbinder::Ingest::GitAccessor.new).run ARGV
-exit return_code.to_i
+Bookbinder::CLI.start

data/lib/bookbinder/cli.rb

@@ -1,69 +1,98 @@
-require_relative 'command_runner'
-require_relative 'command_validator'
-require_relative 'commands/collection'
-require_relative 'config/cf_credentials'
-require_relative 'streams/colorized_stream'
-require_relative 'terminal'
+require 'thor'
+
+require_relative 'ingest/git_accessor'
+require_relative 'legacy/cli'
 
 module Bookbinder
-  class Cli
-    def initialize(version_control_system)
-      @version_control_system = version_control_system
+  class CLI < Thor
+    map '--version' => :version
+    map '--help' => :help
+
+    desc '--version', 'Print the version of bookbinder'
+    def version
+      gemspec = File.expand_path('../../../bookbinder.gemspec', __FILE__)
+      say "bookbinder #{Gem::Specification::load(gemspec).version}"
+    end
+
+    desc '--help', 'Print this message'
+    def help
+      super
     end
 
-    def run(args)
-      command_name, *command_arguments = args
-
-      logger = DeprecatedLogger.new
-      commands = Commands::Collection.new(
-        logger,
-        colorized_streams,
-        version_control_system
-      )
-
-      command_validator = CommandValidator.new(commands, commands.help.usage_message)
-      command_runner = CommandRunner.new(logger, commands)
-      command_name = command_name ? command_name : '--help'
-
-      colorizer = Colorizer.new
-      terminal = Terminal.new(colorizer)
-
-      user_message = command_validator.validate(command_name)
-      terminal.update(user_message)
-
-      if user_message.error?
-        return 1
-      end
-
-      begin
-        command_runner.run(command_name, command_arguments)
-
-      rescue Config::CfCredentials::CredentialKeyError => e
-        colorized_streams[:err].puts "#{e.message}, in credentials.yml"
-        1
-      rescue KeyError => e
-        colorized_streams[:err].puts "#{e.message} from your configuration."
-        1
-      rescue CliError::UnknownCommand => e
-        colorized_streams[:out].puts e.message
-        1
-      rescue RuntimeError => e
-        colorized_streams[:err].puts e.message
-        1
-      end
+    desc 'generate <book_name>', 'Generate a skeleton book that can be bound with "bookbinder bind"'
+    def generate(book_name)
+      run_legacy_cli('generate', book_name)
+    end
+
+    desc 'build_and_push_tarball', 'Create a tarball from the final_app directory and push to the S3 bucket specified in your credentials.yml'
+    def build_and_push_tarball
+      run_legacy_cli('build_and_push_tarball')
+    end
+
+    desc 'bind <local|remote> [--verbose] [--dita-flags=\"<dita-option>=<value>\"]', 'Bind the sections specified in config.yml from <local> or <remote> into the final_app directory'
+    option :verbose, type: :boolean
+    option 'dita-flags'
+    def bind(source)
+      args = ['bind', source]
+      args << '--verbose' if options[:verbose]
+      args << "--dita-flags=\\\"#{options['dita-flags']}\\\""
+      run_legacy_cli(*args)
+    end
+
+    desc 'push_local_to <environment>', 'Push the contents of final_app to the specified environment using the credentials.yml'
+    def push_local_to(environment)
+      run_legacy_cli('push_local_to', environment)
+    end
+
+    desc 'push_to_prod [build_#]', 'Push latest or <build_#> from your S3 bucket to the production host specified in credentials.yml'
+    def push_to_prod(build_num=nil)
+      args = ['push_to_prod', build_num].compact
+      run_legacy_cli(*args)
+    end
+
+    desc 'run_publish_ci', 'Run publish, push_local_to staging, and build_and_push_tarball for CI purposes'
+    def run_publish_ci
+      run_legacy_cli('run_publish_ci')
+    end
+
+    desc 'punch <git tag>', 'Apply the specified <git tag> to your book, sections, and layout repo'
+    def punch(git_tag)
+      run_legacy_cli('punch', git_tag)
+    end
+
+    desc 'update_local_doc_repos', 'Run `git pull` on all sections that exist at the same directory level as your book directory'
+    def update_local_doc_repos
+      run_legacy_cli('update_local_doc_repos')
+    end
+
+    desc 'watch', 'Bind and serve a local book, watching for changes'
+    def watch
+      run_legacy_cli('watch')
+    end
+
+    desc 'imprint <local|remote> [--verbose] [--dita-flags=\"<dita-option>=<value>\"]', 'Generate a PDF for a given book'
+    option :verbose, type: :boolean
+    option 'dita-flags'
+    def imprint(source)
+      args = ['imprint', source]
+      args << '--verbose' if options[:verbose]
+      args << "--dita-flags=\\\"#{options['dita-flags']}\\\""
+      run_legacy_cli(*args)
     end
 
     private
 
-    attr_reader :version_control_system
+    attr_reader :legacy_cli
+
+    def initialize(*)
+      super
+
+      @legacy_cli = Legacy::Cli.new(Ingest::GitAccessor.new)
+    end
 
-    def colorized_streams
-      {
-        err: Streams::ColorizedStream.new(Colorizer::Colors.red, $stderr),
-        out: $stdout,
-        success: Streams::ColorizedStream.new(Colorizer::Colors.green, $stdout),
-        warn: Streams::ColorizedStream.new(Colorizer::Colors.yellow, $stdout),
-      }
+    def run_legacy_cli(*args)
+      status = legacy_cli.run(args)
+      exit status unless status.zero?
     end
   end
 end

data/lib/bookbinder/commands/bind.rb

@@ -14,7 +14,7 @@ module Bookbinder
                      config_decorator: nil,
                      file_system_accessor: nil,
                      middleman_runner: nil,
-                     sitemap_writer: nil,
+                     broken_links_checker: nil,
                      preprocessor: nil,
                      cloner_factory: nil,
                      section_repository: nil,
@@ -26,7 +26,7 @@ module Bookbinder
         @config_decorator = config_decorator
         @file_system_accessor = file_system_accessor
         @middleman_runner = middleman_runner
-        @sitemap_writer = sitemap_writer
+        @broken_links_checker = broken_links_checker
         @preprocessor = preprocessor
         @cloner_factory = cloner_factory
         @section_repository = section_repository
@@ -85,15 +85,13 @@ module Bookbinder
         )
         if generation_result.success?
           file_system_accessor.copy(output_locations.build_dir, output_locations.public_dir)
-          result = sitemap_writer.write(
-            bind_config.public_host,
-            bind_options.streams,
-            bind_config.broken_link_exclusions
-          )
+
+          broken_links_checker.check!(bind_config.broken_link_exclusions)
+          broken_links_checker.announce(bind_options.streams)
 
           bind_options.streams[:success].puts "Bookbinder bound your book into #{output_locations.final_app_dir}"
 
-          result.has_broken_links? ? 1 : 0
+          broken_links_checker.has_broken_links? ? 1 : 0
         else
           bind_options.streams[:err].puts "Your bind failed. Rerun with --verbose to troubleshoot."
           1
@@ -113,7 +111,7 @@ module Bookbinder
         :output_locations,
         :preprocessor,
         :section_repository,
-        :sitemap_writer,
+        :broken_links_checker,
         :middleman_runner,
       )
 

data/lib/bookbinder/commands/collection.rb

@@ -18,7 +18,7 @@ require_relative '../ingest/cloner_factory'
 require_relative '../ingest/section_repository'
 require_relative '../local_filesystem_accessor'
 require_relative '../middleman_runner'
-require_relative '../postprocessing/sitemap_writer'
+require_relative '../postprocessing/broken_links_checker'
 require_relative '../preprocessing/dita_html_preprocessor'
 require_relative '../preprocessing/dita_pdf_preprocessor'
 require_relative '../preprocessing/link_to_site_gen_dir'
@@ -97,7 +97,7 @@ module Bookbinder
           config_decorator: Config::ConfigurationDecorator.new(loader: config_loader, config_filename: 'bookbinder.yml'),
           file_system_accessor: local_filesystem_accessor,
           middleman_runner: runner,
-          sitemap_writer: Postprocessing::SitemapWriter.build(logger, final_app_directory, sitemap_port),
+          broken_links_checker: Postprocessing::BrokenLinksChecker.build(final_app_directory, sitemap_port),
           preprocessor: Preprocessing::Preprocessor.new(
             Preprocessing::DitaHTMLPreprocessor.new(
               local_filesystem_accessor,

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

@@ -2,7 +2,6 @@ module Bookbinder
   module Config
     module Checkers
       class ProductsChecker
-        MissingRequiredKeyError = Class.new(RuntimeError)
         MissingProductsKeyError = Class.new(RuntimeError)
         MissingProductIdError = Class.new(RuntimeError)
 
@@ -11,11 +10,9 @@ module Bookbinder
 
           if section_product_ids.count > 0
             if config.products.empty?
-               MissingProductsKeyError.new('You must specify at least one product under the products key in config.yml')
+              MissingProductsKeyError.new('You must specify at least one product under the products key in config.yml')
             elsif missing_products.count != 0
               MissingProductIdError.new("Your config.yml is missing required product id under the products key. Required product ids are #{missing_products.join(", ")}.")
-            elsif invalid_products.any?
-              MissingRequiredKeyError.new("Your config.yml is missing required key(s) for products #{invalid_product_ids}. Required keys are #{required_product_keys.join(", ")}.")
             end
           end
         end
@@ -24,22 +21,10 @@ module Bookbinder
 
         private
 
-        def invalid_products
-          config.products.map {|product_config| product_config unless product_config.valid? }
-        end
-
-        def invalid_product_ids
-          invalid_products.map(&:id).join(', ')
-        end
-
         def missing_products
           section_product_ids - config.products.map(&:id)
         end
 
-        def required_product_keys
-          Bookbinder::Config::ProductConfig::CONFIG_REQUIRED_KEYS
-        end
-
         def section_product_ids
           config.sections.map(&:product_id).compact.uniq
         end

data/lib/bookbinder/config/configuration.rb

@@ -57,7 +57,7 @@ module Bookbinder
       end
 
       CONFIG_REQUIRED_KEYS = %w(book_repo public_host)
-      CONFIG_OPTIONAL_KEYS = %w(archive_menu book_repo_url cred_repo cred_repo_url repo_link_enabled repo_links feedback_enabled layout_repo layout_repo_ref layout_repo_url sections subnav_exclusions)
+      CONFIG_OPTIONAL_KEYS = %w(archive_menu book_repo_url cred_repo cred_repo_url repo_link_enabled repo_links feedback_enabled layout_repo layout_repo_ref layout_repo_url sections)
 
       CONFIG_REQUIRED_KEYS.each do |method_name|
         define_method(method_name) do
@@ -104,7 +104,6 @@ module Bookbinder
       def assemble_products
         if config[:products]
           config[:products].map do |product|
-            product.merge!({'subnav_exclusions' => subnav_exclusions})
             Config::ProductConfig.new(product)
           end
         end

data/lib/bookbinder/config/product_config.rb

@@ -1,11 +1,8 @@
-require_relative '../config/topic_config'
-
 module Bookbinder
   module Config
     class ProductConfig
       def initialize(config)
         @config = config
-        @subnav_topics = assemble_topics || []
       end
 
       def id
@@ -16,30 +13,21 @@ module Bookbinder
         config['pdf_config']
       end
 
-      def subnav_exclusions
-        config['subnav_exclusions'] || []
-      end
-
-      def specifies_subnav?
-        !subnav_topics.empty?
+      def subnav_root
+        config['subnav_root']
       end
 
       def valid?
         (CONFIG_REQUIRED_KEYS - config.keys).empty?
       end
 
-      CONFIG_REQUIRED_KEYS = %w(id subnav_topics)
+      CONFIG_REQUIRED_KEYS = %w(id)
 
-      attr_reader :subnav_topics
       alias_method :subnav_name, :id
 
       private
 
       attr_reader :config
-
-      def assemble_topics
-        config['subnav_topics'].map{|topic| Config::TopicConfig.new(topic)} if config['subnav_topics']
-      end
     end
   end
 end

data/lib/bookbinder/config/validator.rb

@@ -5,7 +5,6 @@ require_relative 'checkers/repository_name_presence_checker'
 require_relative 'checkers/ditamap_presence_checker'
 require_relative 'checkers/section_presence_checker'
 require_relative 'checkers/products_checker'
-require_relative 'checkers/subnav_topics_checker'
 
 module Bookbinder
   module Config
@@ -22,8 +21,7 @@ module Bookbinder
           Checkers::SectionPresenceChecker.new,
           Checkers::DitamapPresenceChecker.new,
           Checkers::ArchiveMenuChecker.new(@file_system_accessor),
-          Checkers::ProductsChecker.new,
-          Checkers::SubnavTopicsChecker.new
+          Checkers::ProductsChecker.new
         ].map do |checker|
           checker.check(config)
         end

data/lib/bookbinder/html_document_manipulator.rb

@@ -12,13 +12,6 @@ module Bookbinder
       doc.to_html
     end
 
-    def add_class(document: nil, selector: nil, classname: nil)
-      doc = Nokogiri::HTML.fragment(document)
-      node_set = doc.css(selector)
-      node_set.add_class(classname)
-      doc.to_html
-    end
-
     def read_html_in_tag(document: nil, tag: nil)
       doc = Nokogiri::HTML(document)
       doc.css(tag).inner_html

data/lib/bookbinder/legacy/cli.rb

@@ -0,0 +1,71 @@
+require_relative '../command_runner'
+require_relative '../command_validator'
+require_relative '../commands/collection'
+require_relative '../config/cf_credentials'
+require_relative '../streams/colorized_stream'
+require_relative '../terminal'
+
+module Bookbinder
+  module Legacy
+    class Cli
+      def initialize(version_control_system)
+        @version_control_system = version_control_system
+      end
+
+      def run(args)
+        command_name, *command_arguments = args
+
+        logger = DeprecatedLogger.new
+        commands = Commands::Collection.new(
+          logger,
+          colorized_streams,
+          version_control_system
+        )
+
+        command_validator = CommandValidator.new(commands, commands.help.usage_message)
+        command_runner = CommandRunner.new(logger, commands)
+        command_name = command_name ? command_name : '--help'
+
+        colorizer = Colorizer.new
+        terminal = Terminal.new(colorizer)
+
+        user_message = command_validator.validate(command_name)
+        terminal.update(user_message)
+
+        if user_message.error?
+          return 1
+        end
+
+        begin
+          command_runner.run(command_name, command_arguments)
+
+        rescue Config::CfCredentials::CredentialKeyError => e
+          colorized_streams[:err].puts "#{e.message}, in credentials.yml"
+          1
+        rescue KeyError => e
+          colorized_streams[:err].puts "#{e.message} from your configuration."
+          1
+        rescue CliError::UnknownCommand => e
+          colorized_streams[:out].puts e.message
+          1
+        rescue RuntimeError => e
+          colorized_streams[:err].puts e.message
+          1
+        end
+      end
+
+      private
+
+      attr_reader :version_control_system
+
+      def colorized_streams
+        {
+          err: Streams::ColorizedStream.new(Colorizer::Colors.red, $stderr),
+          out: $stdout,
+          success: Streams::ColorizedStream.new(Colorizer::Colors.green, $stdout),
+          warn: Streams::ColorizedStream.new(Colorizer::Colors.yellow, $stdout),
+        }
+      end
+    end
+  end
+end

data/lib/bookbinder/postprocessing/{sitemap_writer.rb → broken_links_checker.rb}

@@ -4,8 +4,8 @@ require_relative '../../../template_app/rack_app'
 
 module Bookbinder
   module Postprocessing
-    class SitemapWriter
-      def self.build(logger, final_app_directory, port)
+    class BrokenLinksChecker
+      def self.build(final_app_directory, port)
         new(
           Spider.new(app_dir: final_app_directory),
           ServerDirector.new(
@@ -21,17 +21,18 @@ module Bookbinder
         @server_director = server_director
       end
 
-      def write(host_for_sitemap, streams, broken_link_exclusions)
+      def check!(broken_link_exclusions)
         server_director.use_server { |port|
-          spider.generate_sitemap(
-            host_for_sitemap,
-            port,
-            streams,
-            broken_link_exclusions: broken_link_exclusions
-          )
-        }.tap do |sitemap|
-          File.write(sitemap.to_path, sitemap.to_xml)
-        end
+          @result = spider.find_broken_links(port, broken_link_exclusions: broken_link_exclusions)
+        }
+      end
+
+      def announce(streams)
+        @result.announce_broken_links(streams)
+      end
+
+      def has_broken_links?
+        @result.has_broken_links?
       end
 
       private

data/lib/bookbinder/spider.rb

@@ -3,27 +3,31 @@ require 'pty'
 require_relative 'css_link_checker'
 require_relative 'sieve'
 require_relative 'stabilimentum'
-require_relative 'sitemap_generator'
 
 module Bookbinder
   class Spider
     class Result
-      def initialize(broken_links, sitemap, app_dir)
+      def initialize(broken_links)
         @broken_links = broken_links
-        @sitemap = sitemap
-        @app_dir = app_dir
       end
 
       def has_broken_links?
         @broken_links.any?
       end
 
-      def to_xml
-        @sitemap
-      end
+      def announce_broken_links(streams)
+        if @broken_links.none?
+          streams[:out].puts "\nNo broken links!"
+        else
+          streams[:err].puts(<<-MESSAGE)
+
+Found #{@broken_links.count} broken links!
 
-      def to_path
-        Pathname(@app_dir).join('public/sitemap.xml')
+#{@broken_links.sort.join("\n")}
+
+Found #{@broken_links.count} broken links!
+          MESSAGE
+        end
       end
     end
 
@@ -35,41 +39,20 @@ module Bookbinder
       @app_dir = app_dir || raise('Spiders must be initialized with an app directory.')
     end
 
-    def generate_sitemap(target_host, port, streams,
-                         broken_link_exclusions: /(?!.*)/)
+    def find_broken_links(port, broken_link_exclusions: /(?!.*)/)
       temp_host = "localhost:#{port}"
-
       sieve = Sieve.new domain: "http://#{temp_host}"
       links = crawl_from "http://#{temp_host}/index.html", sieve
-      broken_links, working_links = links
-      sitemap_links = substitute_hostname(temp_host, target_host, working_links)
+      broken_links = links.first
       public_broken_links = broken_links.reject {|l| l.match(broken_link_exclusions)}
-      announce_broken_links(public_broken_links, streams)
-      Result.new(
-        public_broken_links,
-        SitemapGenerator.new.generate(sitemap_links), app_dir
-      )
+
+      Result.new(public_broken_links)
     end
 
     private
 
     attr_reader :app_dir
 
-    def announce_broken_links(broken_links, streams)
-      if broken_links.none?
-        streams[:out].puts "\nNo broken links!"
-      else
-        streams[:err].puts(<<-MESSAGE)
-
-Found #{broken_links.count} broken links!
-
-#{broken_links.sort.join("\n")}
-
-Found #{broken_links.count} broken links!
-        MESSAGE
-      end
-    end
-
     def crawl_from(url, sieve)
       broken_links = []
       sitemap = [url]
@@ -79,7 +62,7 @@ Found #{broken_links.count} broken links!
         Anemone.crawl(url) do |anemone|
           dont_visit_fragments(anemone)
           anemone.on_every_page do |page|
-            broken, working = sieve.links_from Stabilimentum.new(page), is_first_pass
+            broken, working = sieve.links_from(Stabilimentum.new(page), is_first_pass)
             broken_links.concat broken
             sitemap.concat working
           end
@@ -93,9 +76,5 @@ Found #{broken_links.count} broken links!
     def dont_visit_fragments(anemone)
       anemone.focus_crawl { |page| page.links.reject { |link| link.to_s.match(/%23/) } }
     end
-
-    def substitute_hostname(temp_host, target_host, links)
-      links.map { |l| l.gsub(/#{Regexp.escape(temp_host)}/, target_host) }
-    end
   end
 end

data/lib/bookbinder/subnav/json_from_markdown_toc.rb

@@ -5,72 +5,79 @@ require 'redcarpet'
 module Bookbinder
   module Subnav
     class JsonFromMarkdownToc
+      SubnavDuplicateLinkError = Class.new(RuntimeError)
+      SubnavBrokenLinkError = Class.new(RuntimeError)
+      SubnavRootMissingError = Class.new(RuntimeError)
+
       def initialize(fs)
         @fs = fs
         @renderer = Redcarpet::Markdown.new(Redcarpet::Render::HTML.new)
       end
 
-      def get_links(subnav_config, output_locations)
+      def get_links(product_config, output_locations)
         @source_for_site_gen = output_locations.source_for_site_generator
-        @config = subnav_config
+        @config = product_config
 
-        { links: get_links_and_headers }.to_json
-      end
+        root = absolute_source_from_path(Pathname(config.subnav_root))
 
-      attr_reader :fs, :source_for_site_gen, :renderer, :config
-
-      private
+        raise SubnavRootMissingError.new('Subnav root not found at: ' + config.subnav_root) if root.nil?
 
-      def get_links_and_headers
-        menu_items = []
+        @parsed_files = { Pathname(root) => '(root)'}
 
-        config.subnav_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
+        {links: gather_urls_and_texts(root)}.to_json
       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)
+      attr_reader :fs, :source_for_site_gen, :renderer, :config
 
-        gather_urls_and_texts(toc_html.css('html'), topic)
-      end
+      private
 
       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
+      def absolute_source_from_path(path)
+        full_sources = fs.find_files_extension_agnostically(path, source_for_site_gen)
+        full_sources.first
       end
 
-      def nav_items(base_node)
-        base_node.css('h2, ul') - base_node.css(*exclusions)
-      end
+      # href: ./cat/index.html
+      # expanded href: my/cat/index.html
+      # full source: my/cat/index.html.md.erb
+      def gather_urls_and_texts(source)
+        toc_md = fs.read(source)
+        base_node = get_html(toc_md).css('html')
 
-      def exclusions
-        @exclusions ||= config.subnav_exclusions << '.nav-exclude'
+        nav_items(base_node).map do |element|
+          href = element['href']
+          expanded_href = (source.dirname + href).relative_path_from(source_for_site_gen)
+          next_source = absolute_source_from_path(expanded_href)
+
+          raise SubnavBrokenLinkError.new(<<-ERROR) unless next_source
+Broken link found in subnav for product_id: #{config.id}
+
+Link: #{expanded_href}
+Source file: #{source}
+          ERROR
+          raise SubnavDuplicateLinkError.new(<<-ERROR) if @parsed_files.has_key?(next_source)
+)
+Duplicate link found in subnav for product_id: #{config.id}
+
+Link: #{expanded_href}
+Original file: #{@parsed_files[next_source]}
+Current file: #{source}
+          ERROR
+
+          @parsed_files[next_source] = source
+          nested_urls_and_texts = gather_urls_and_texts(next_source)
+          nested_links = {}
+          nested_links.merge!(nestedLinks: nested_urls_and_texts) unless nested_urls_and_texts.empty?
+
+          {url: '/' + expanded_href.to_s, text: element.inner_text}.merge(nested_links)
+        end
       end
 
-      def frontmatter_header?(element)
-        element.inner_html.include?('title: ')
+      def nav_items(base_node)
+        base_node.css('a.subnav')
       end
     end
   end

data/lib/bookbinder/subnav/template_creator.rb

@@ -18,21 +18,13 @@ module Bookbinder
                                                             attribute: 'data-props-location',
                                                             value: props_filename)
 
-        nav_content = html_doc_manipulator.add_class(document: nav_with_props,
-                                                         selector: 'div.nav-content',
-                                                         classname: nav_type(subnav_spec))
-
-        fs.write(text: nav_content, to: subnav_destination(subnav_spec.subnav_name))
+        fs.write(text: nav_with_props, to: subnav_destination(subnav_spec.subnav_name))
       end
 
       attr_reader :fs, :output_locations, :html_doc_manipulator
 
       private
 
-      def nav_type(subnav_spec)
-        subnav_spec.subnav_name.include?('dita') ? 'deepnav-content' : 'shallownav-content'
-      end
-
       def subnavs_path
         output_locations.subnavs_for_layout_dir
       end

data/master_middleman/bookbinder_helpers.rb

@@ -110,6 +110,13 @@ module Bookbinder
         Redcarpet::Markdown.new(quicklinks_renderer).render(page_src)
       end
 
+      def owners
+        html_resources = sitemap.resources.select { |r| r.path.end_with?('.html') }
+        html_resources.each.with_object({}) { |resource, owners|
+          owners[resource.path] = Array(resource.data['owner'])
+        }
+      end
+
       private
 
       def subnav_template_name

data/master_middleman/config.rb

@@ -23,6 +23,8 @@ set :images_dir, 'images'
 
 set :relative_links, false
 
+page '/owners.json', :layout => false
+
 activate :subdirectory_aware_assets
 
 activate :navigation

data/template_app/Gemfile

@@ -1,6 +1,6 @@
 source 'http://rubygems.org'
 
-ruby '2.0.0'
+ruby '2.3.0'
 
 gem 'vienna'
 gem 'rack-rewrite'

data/template_app/lib/vienna_application.rb

@@ -15,7 +15,10 @@ module Bookbinder
               urls: Dir.glob("#{root}/**/*").map { |fn| fn.gsub(/^#{root}/, '')},
               root: root,
               index: 'index.html',
-              header_rules: [[:all, {'Cache-Control' => 'public, max-age=3600'}]]
+              header_rules: [[:all, {
+                'Cache-Control' => 'public, max-age=3600',
+                'Access-Control-Allow-Origin' => '*'
+              }]]
             }
           run NotFound.new("#{root}/404.html")
         end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bookbindery
 version: !ruby/object:Gem::Version
-  version: 8.0.0
+  version: 8.1.0
 platform: ruby
 authors:
 - Mike Grafton
@@ -18,7 +18,7 @@ authors:
 autorequire: 
 bindir: install_bin
 cert_chain: []
-date: 2016-02-23 00:00:00.000000000 Z
+date: 2016-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fog-aws
@@ -230,6 +230,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 1.6.7.2
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: license_finder
   requirement: !ruby/object:Gem::Requirement
@@ -344,7 +358,6 @@ files:
 - lib/bookbinder/config/checkers/repository_name_presence_checker.rb
 - lib/bookbinder/config/checkers/required_keys_checker.rb
 - lib/bookbinder/config/checkers/section_presence_checker.rb
-- lib/bookbinder/config/checkers/subnav_topics_checker.rb
 - lib/bookbinder/config/configuration.rb
 - lib/bookbinder/config/configuration_decorator.rb
 - lib/bookbinder/config/dita_config_generator.rb
@@ -353,7 +366,6 @@ files:
 - lib/bookbinder/config/product_config.rb
 - lib/bookbinder/config/remote_yaml_credential_provider.rb
 - lib/bookbinder/config/section_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
@@ -385,9 +397,10 @@ files:
 - lib/bookbinder/ingest/update_failure.rb
 - lib/bookbinder/ingest/update_success.rb
 - lib/bookbinder/ingest/working_copy.rb
+- lib/bookbinder/legacy/cli.rb
 - lib/bookbinder/local_filesystem_accessor.rb
 - lib/bookbinder/middleman_runner.rb
-- lib/bookbinder/postprocessing/sitemap_writer.rb
+- lib/bookbinder/postprocessing/broken_links_checker.rb
 - lib/bookbinder/preprocessing/dita_html_preprocessor.rb
 - lib/bookbinder/preprocessing/dita_pdf_preprocessor.rb
 - lib/bookbinder/preprocessing/dita_preprocessor.rb
@@ -396,7 +409,6 @@ files:
 - lib/bookbinder/server_director.rb
 - lib/bookbinder/sheller.rb
 - lib/bookbinder/sieve.rb
-- lib/bookbinder/sitemap_generator.rb
 - lib/bookbinder/spider.rb
 - lib/bookbinder/stabilimentum.rb
 - lib/bookbinder/streams/colorized_stream.rb
@@ -435,9 +447,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '2.0'
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -445,7 +457,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Markdown to Rackup application documentation generator

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

@@ -1,37 +0,0 @@
-module Bookbinder
-  module Config
-    module Checkers
-      class SubnavTopicsChecker
-        MissingRequiredKeyError = Class.new(RuntimeError)
-
-        def check(config)
-          @config = config
-
-          if invalid_products.any?
-            MissingRequiredKeyError.new("Your config.yml is missing required key(s) for subnav_topics in product id(s) #{invalid_product_ids}. Required keys are #{required_topic_keys.join(", ")}.")
-          end
-        end
-
-        attr_reader :config
-
-        private
-
-        def invalid_products
-          config.products.select { |product_config| invalid_topics(product_config.subnav_topics).any? }
-        end
-
-        def invalid_topics(topics)
-          topics.map {|topic| topic unless topic.valid? }
-        end
-
-        def invalid_product_ids
-          invalid_products.map(&:id).join(', ')
-        end
-
-        def required_topic_keys
-          Bookbinder::Config::TopicConfig::CONFIG_REQUIRED_KEYS
-        end
-      end
-    end
-  end
-end

data/lib/bookbinder/config/topic_config.rb

@@ -1,29 +0,0 @@
-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/sitemap_generator.rb

@@ -1,18 +0,0 @@
-require 'nokogiri'
-
-module Bookbinder
-  class SitemapGenerator
-    def generate(links)
-      Nokogiri::XML::Builder.new(encoding: 'UTF-8') { |xml|
-        xml.urlset('xmlns' => 'http://www.sitemaps.org/schemas/sitemap/0.9') {
-          links.each do |link|
-            xml.url {
-              xml.loc link
-              xml.changefreq 'daily'
-            }
-          end
-        }
-      }.to_xml
-    end
-  end
-end