bookbindery 2.1.5 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 86f65f7bef679ee010fe1e1e48699f25c8a52459
-  data.tar.gz: 36903b0839abb3d2d34de78b685497900920572a
+  metadata.gz: 61ee95fb7c8fa4d8f94f82fb98582fd65cb95b00
+  data.tar.gz: 402dbbe4d95e314482d09803c85d2560f424bde5
 SHA512:
-  metadata.gz: 642e96e2a97bddd0492c9eac223d1b0b07db5bf5897f5926a25029c4246de28c26cb6bf9f6cf4066a2344b9faa6e99403d22825aeaa6ef2057d82c4c30adc99e
-  data.tar.gz: 6710d7e2f7a298e5c7dd94ae5ad74684389e5426b1abd2a0dd9bfbc4f1222c3dd26d9aae71a1912e2aa0d52b604fc65e1c6ef628bc3ad6b3d2fa943f532b014b
+  metadata.gz: 657c1ab7338a891a60f59b3f3a01d683f65cac80a528907ee9918d55ef45202615684a57069c72525a65bbf6a310bb4183fecaabde6c2bfa73743ef9daeaa2b1
+  data.tar.gz: 725747cd9531772d3df4fe41af349bc165bc13fbc8db64c886debfc7f0866d720c730a72ee977ff3759d0f046e3f20dd18267ebe19fe5d47aed302b0f84532ef

data/lib/bookbinder.rb

@@ -8,7 +8,6 @@ require 'middleman-core/profiling'
 require 'anemone'
 require 'css_parser'
 require 'vienna'
-require 'popen4'
 require 'puma'
 
 require_relative 'bookbinder/deprecated_logger'
@@ -28,9 +27,7 @@ require_relative 'bookbinder/server_director'
 require_relative 'bookbinder/spider'
 
 require_relative 'bookbinder/archive'
-require_relative 'bookbinder/pdf_generator'
 require_relative 'bookbinder/middleman_runner'
-require_relative 'bookbinder/publisher'
 require_relative 'bookbinder/cf_command_runner'
 require_relative 'bookbinder/pusher'
 require_relative 'bookbinder/artifact_namer'
@@ -44,7 +41,6 @@ require_relative 'bookbinder/commands/push_to_prod'
 require_relative 'bookbinder/commands/run_publish_ci'
 require_relative 'bookbinder/commands/update_local_doc_repos'
 require_relative 'bookbinder/commands/tag'
-require_relative 'bookbinder/commands/generate_pdf'
 
 require_relative 'bookbinder/cli'
 

data/lib/bookbinder/cf_command_runner.rb

@@ -3,8 +3,9 @@ require_relative 'values/blue_green_app'
 
 module Bookbinder
   class CfCommandRunner
-    def initialize(logger, cf_credentials, trace_file)
+    def initialize(logger, sheller, cf_credentials, trace_file)
       @logger = logger
+      @sheller = sheller
       @creds = cf_credentials
       @trace_file = trace_file
     end
@@ -35,14 +36,19 @@ module Bookbinder
       # Theoretically we shouldn't need this (and corresponding "stop" below), but we've seen CF pull files from both
       # green and blue when a DNS redirect points to HOST.cfapps.io
       # Also, shutting down the unused app saves $$
-      Kernel.system("#{cf_binary_path} start #{deploy_target_app} ")
+      sheller.run_command("#{cf_binary_path} start #{deploy_target_app}",
+                          out: $stdout,
+                          err: $stderr)
     end
 
     def push(deploy_target_app)
       # Currently --no-routes is used to blow away all existing routes from a newly deployed app.
       # The routes will then be recreated from the creds repo.
-      success = Kernel.system(environment_variables, "#{cf_binary_path} push #{deploy_target_app} --no-route -m 256M -i 3")
-      raise "Could not deploy app to #{deploy_target_app}" unless success
+      status = sheller.run_command(environment_variables,
+                                   "#{cf_binary_path} push #{deploy_target_app} --no-route -m 256M -i 3",
+                                   out: $stdout,
+                                   err: $stderr)
+      raise "Could not deploy app to #{deploy_target_app}" unless status.success?
     end
 
     def unmap_routes(app)
@@ -78,7 +84,7 @@ module Bookbinder
 
     private
 
-    attr_reader :creds
+    attr_reader :creds, :sheller
 
     def stop(app)
       success = Kernel.system("#{cf_binary_path} stop #{app}")

data/lib/bookbinder/cli.rb

@@ -1,10 +1,10 @@
-require_relative 'colorizer'
-require_relative 'command_runner'
+require_relative 'repositories/command_repository'
 require_relative 'command_validator'
+require_relative 'command_runner'
+require_relative 'config/cf_credentials'
 require_relative 'configuration'
-require_relative 'repositories/command_repository'
+require_relative 'colorizer'
 require_relative 'terminal'
-require_relative 'user_message_presenter'
 
 module Bookbinder
   class Cli
@@ -23,17 +23,13 @@ module Bookbinder
       command_name = command_name ? command_name : '--help'
 
       colorizer = Colorizer.new
-      user_message_presenter = UserMessagePresenter.new(colorizer)
-      terminal = Terminal.new
+      terminal = Terminal.new(colorizer)
 
       user_message = command_validator.validate(command_name)
+      terminal.update(user_message)
+
       if user_message.error?
-        error_message = user_message_presenter.get_error(user_message)
-        terminal.update(error_message)
         return 1
-      elsif user_message.warn?
-        warning_message = user_message_presenter.get_warning(user_message)
-        terminal.update(warning_message)
       end
 
       begin
@@ -42,7 +38,7 @@ module Bookbinder
       rescue Config::RemoteBindConfiguration::VersionUnsupportedError => e
         logger.error "config.yml at version '#{e.message}' has an unsupported API."
         1
-      rescue Configuration::CredentialKeyError => e
+      rescue Config::CfCredentials::CredentialKeyError => e
         logger.error "#{e.message}, in credentials.yml"
         1
       rescue KeyError => e

data/lib/bookbinder/colorizer.rb

@@ -2,7 +2,6 @@ require 'ansi/code'
 require 'ostruct'
 
 module Bookbinder
-
   class Colorizer
     Colors = OpenStruct.new(red: Proc.new { |msg| ANSI.red {msg} },
                             yellow: Proc.new { |msg| ANSI.yellow {msg} })
@@ -11,4 +10,4 @@ module Bookbinder
       color.call string.to_s
     end
   end
-end
+end

data/lib/bookbinder/command_runner.rb

@@ -1,6 +1,4 @@
 require_relative 'errors/cli_error'
-require_relative 'dita_to_html_converter'
-require_relative 'sheller'
 
 module Bookbinder
   class CommandRunner

data/lib/bookbinder/commands/bind.rb

@@ -1,19 +1,22 @@
-require_relative '../dita_section_gatherer_factory'
+require 'middleman-syntax'
+
 require_relative '../archive_menu_configuration'
-require_relative '../values/output_locations'
-require_relative '../values/dita_section'
+require_relative '../book'
+require_relative '../dita_section_gatherer_factory'
 require_relative '../errors/cli_error'
+require_relative '../streams/switchable_stdout_and_red_stderr'
+require_relative '../values/dita_section'
+require_relative '../values/output_locations'
 require_relative '../values/section'
-require_relative '../publisher'
-require_relative '../book'
 require_relative 'naming'
 
 module Bookbinder
   module Commands
     class Bind
-      include Bookbinder::DirectoryHelperMethods
       include Commands::Naming
 
+      DitaToHtmlLibraryFailure = Class.new(RuntimeError)
+
       def initialize(logger,
                      config_fetcher,
                      config_factory,
@@ -26,7 +29,11 @@ module Bookbinder
                      context_dir,
                      dita_preprocessor,
                      cloner_factory,
-                     dita_section_gatherer_factory)
+                     dita_section_gatherer_factory,
+                     section_repository,
+                     command_creator,
+                     sheller,
+                     directory_preparer)
         @logger = logger
         @config_fetcher = config_fetcher
         @config_factory = config_factory
@@ -40,6 +47,10 @@ module Bookbinder
         @dita_preprocessor = dita_preprocessor
         @cloner_factory = cloner_factory
         @dita_section_gatherer_factory = dita_section_gatherer_factory
+        @section_repository = section_repository
+        @command_creator = command_creator
+        @sheller = sheller
+        @directory_preparer = directory_preparer
       end
 
       def usage
@@ -56,18 +67,11 @@ module Bookbinder
       end
 
       def run(cli_arguments)
-        raise CliError::InvalidArguments unless arguments_are_valid?(cli_arguments)
-
-        @section_repository = Repositories::SectionRepository.new(logger)
-        @gem_root = File.expand_path('../../../../', __FILE__)
-        publisher = Publisher.new(logger, sitemap_writer, static_site_generator, file_system_accessor)
-
         bind_source, *options = cli_arguments
+        validate(bind_source, options)
 
         bind_config = config_factory.produce(bind_source)
-
-        @versions = bind_config.fetch(:versions, [])
-        @book_repo = bind_config[:book_repo]
+        output_streams = Streams::SwitchableStdoutAndRedStderr.new(options)
 
         output_locations = OutputLocations.new(
           context_dir: context_dir,
@@ -76,15 +80,30 @@ module Bookbinder
           local_repo_dir: generate_local_repo_dir(context_dir, bind_source)
         )
 
-        prepare_directories(output_locations)
+        directory_preparer.prepare_directories(
+          File.expand_path('../../../../', __FILE__),
+          bind_config.fetch(:versions, []),
+          output_locations,
+          bind_config[:book_repo]
+        )
 
         dita_gatherer = dita_section_gatherer_factory.produce(bind_source, output_locations)
         gathered_dita_sections = dita_gatherer.gather(config.dita_sections)
 
-        gathered_dita_sections.each do |dita_section|
-          dita_preprocessor.preprocess(dita_section,
-                                       output_locations.subnavs_for_layout_dir,
-                                       output_locations.dita_subnav_template_path)
+        dita_preprocessor.preprocess(gathered_dita_sections,
+                                     output_locations.subnavs_for_layout_dir,
+                                     output_locations.dita_subnav_template_path) do |dita_section|
+          command = command_creator.convert_to_html_command(
+            dita_section,
+            write_to: dita_section.html_from_dita_section_dir
+          )
+          status = sheller.run_command(command, output_streams.to_h)
+          unless status.success?
+            raise DitaToHtmlLibraryFailure.new 'The DITA-to-HTML conversion failed. ' +
+              'Please check that you have specified the path to your DITA-OT library in the ENV, ' +
+              'that your DITA-specific keys/values in config.yml are set, ' +
+              'and that your DITA toolkit is correctly configured.'
+          end
         end
 
         cloner = cloner_factory.produce(
@@ -99,11 +118,12 @@ module Bookbinder
 
         subnavs = (sections + gathered_dita_sections).map(&:subnav).reduce(&:merge)
 
-        success = publisher.publish(
+        success = publish(
           subnavs,
-          {verbose: cli_arguments.include?('--verbose')},
+          {verbose: options.include?('--verbose')},
           output_locations,
-          archive_menu_config.generate(bind_config, sections)
+          archive_menu_config.generate(bind_config, sections),
+          cloner
         )
 
         success ? 0 : 1
@@ -123,107 +143,84 @@ module Bookbinder
                   :context_dir,
                   :dita_preprocessor,
                   :cloner_factory,
-                  :dita_section_gatherer_factory
+                  :dita_section_gatherer_factory,
+                  :section_repository,
+                  :command_creator,
+                  :sheller,
+                  :directory_preparer
+
+      def publish(subnavs, cli_options, output_locations, publish_config, cloner)
+        FileUtils.cp 'redirects.rb', output_locations.final_app_dir if File.exists?('redirects.rb')
+
+        host_for_sitemap = publish_config.fetch(:host_for_sitemap)
+
+        static_site_generator.run(output_locations,
+                                  publish_config,
+                                  cloner,
+                                  cli_options[:verbose],
+                                  subnavs)
+        file_system_accessor.copy output_locations.build_dir, output_locations.public_dir
+
+
+        result = generate_sitemap(host_for_sitemap)
+
+        logger.log "Bookbinder bound your book into #{output_locations.final_app_dir.to_s.green}"
+
+        !result.has_broken_links?
+      end
+
+      def generate_sitemap(host_for_sitemap)
+        raise "Your public host must be a single String." unless host_for_sitemap.is_a?(String)
+        sitemap_writer.write(host_for_sitemap)
+      end
 
       def generate_local_repo_dir(context_dir, bind_source)
         File.expand_path('..', context_dir) if bind_source == 'local'
       end
 
       def gather_sections(workspace, cloner, ref_override)
-        config.sections.map do |attributes|
+        config.sections.map do |section_config|
           target_ref = ref_override ||
-            attributes.fetch('repository', {})['ref'] ||
+            section_config.fetch('repository', {})['ref'] ||
             'master'
-          repo_name = attributes.fetch('repository').fetch('name')
-          directory = attributes['directory']
-          vcs_repo = cloner.call(from: repo_name,
-                                 ref: target_ref,
-                                 parent_dir: workspace,
-                                 dir_name: directory)
+          repo_name = section_config.fetch('repository').fetch('name')
+          directory = section_config['directory']
+          working_copy = cloner.call(source_repo_name: repo_name,
+                                     source_ref: target_ref,
+                                     destination_parent_dir: workspace,
+                                     destination_dir_name: directory)
           @section_repository.get_instance(
-            attributes,
-            vcs_repo: vcs_repo,
+            section_config,
+            working_copy: working_copy,
             destination_dir: workspace
           ) { |*args| Section.new(*args) }
         end
       end
 
-      def prepare_directories(locations)
-        forget_sections(locations.output_dir)
-        file_system_accessor.remove_directory(File.join(locations.final_app_dir, '.'))
-        file_system_accessor.remove_directory(locations.dita_home_dir)
-
-        copy_directory_from_gem('template_app', locations.final_app_dir)
-        copy_directory_from_gem('master_middleman', locations.site_generator_home)
-        file_system_accessor.copy(File.join(locations.layout_repo_dir, '.'), locations.site_generator_home)
-
-        copy_version_master_middleman(locations.source_for_site_generator)
-      end
-
-      # Copy the index file from each version into the version's directory. Because version
-      # subdirectories are sections, this is the only way they get content from their master
-      # middleman directory.
-      def copy_version_master_middleman(dest_dir)
-        @versions.each do |version|
-          Dir.mktmpdir(version) do |tmpdir|
-            book = Book.from_remote(logger: logger,
-                                    full_name: @book_repo,
-                                    destination_dir: tmpdir,
-                                    ref: version,
-                                    git_accessor: version_control_system)
-            index_source_dir = File.join(tmpdir, book.directory, 'master_middleman', source_dir_name)
-            index_dest_dir = File.join(dest_dir, version)
-            file_system_accessor.make_directory(index_dest_dir)
-
-            Dir.glob(File.join(index_source_dir, 'index.*')) do |f|
-              file_system_accessor.copy(File.expand_path(f), index_dest_dir)
-            end
-          end
-        end
-      end
-
-      def forget_sections(middleman_scratch)
-        file_system_accessor.remove_directory File.join middleman_scratch, '.'
-      end
-
-      def copy_directory_from_gem(dir, output_dir)
-        file_system_accessor.copy File.join(@gem_root, "#{dir}/."), output_dir
-      end
-
       def config
         config_fetcher.fetch_config
       end
 
       def layout_repo_path(local_repo_dir)
-        if config.has_option?('layout_repo')
-          if local_repo_dir
-            File.join(local_repo_dir, config.layout_repo.split('/').last)
-          else
-            section = {'repository' => {'name' => config.layout_repo}}
-            destination_dir = Dir.mktmpdir
-            repository = GitHubRepository.build_from_remote(logger,
-                                                            section,
-                                                            version_control_system)
-            repository.copy_from_remote(destination_dir, 'master')
-            if repository
-              File.join(destination_dir, repository.directory)
-            else
-              raise 'failed to fetch repository'
-            end
-          end
+        if local_repo_dir && config.has_option?('layout_repo')
+          File.join(local_repo_dir, config.layout_repo.split('/').last)
+        elsif config.has_option?('layout_repo')
+          cloner = cloner_factory.produce('github', nil)
+          working_copy = cloner.call(source_repo_name: config.layout_repo,
+                                     destination_parent_dir: Dir.mktmpdir)
+          working_copy.path
         else
           File.absolute_path('master_middleman')
         end
       end
 
-      def arguments_are_valid?(arguments)
-        bind_source, *options = arguments
-        valid_options = %w(--verbose --ignore-section-refs).to_set
-        %w(local github).include?(bind_source) && options.to_set.subset?(valid_options)
+      def validate(bind_source, options)
+        raise CliError::InvalidArguments unless arguments_are_valid?(bind_source, options)
       end
 
-      def binding_from_github?(bind_location)
-        config.has_option?('versions') && bind_location != 'local'
+      def arguments_are_valid?(bind_source, options)
+        valid_options = %w(--verbose --ignore-section-refs).to_set
+        %w(local github).include?(bind_source) && options.to_set.subset?(valid_options)
       end
     end
   end

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

@@ -0,0 +1,60 @@
+require_relative '../../directory_helpers'
+
+module Bookbinder
+  module Commands
+    module BindComponents
+      class DirectoryPreparer
+        include Bookbinder::DirectoryHelperMethods
+
+        def initialize(logger, file_system_accessor, version_control_system)
+          @logger = logger
+          @file_system_accessor = file_system_accessor
+          @version_control_system = version_control_system
+        end
+
+        def prepare_directories(gem_root, versions, locations, book_repo)
+          forget_sections(locations.output_dir)
+          file_system_accessor.remove_directory(File.join(locations.final_app_dir, '.'))
+          file_system_accessor.remove_directory(locations.dita_home_dir)
+
+          copy_directory_from_gem(gem_root, 'template_app', locations.final_app_dir)
+          copy_directory_from_gem(gem_root, 'master_middleman', locations.site_generator_home)
+          file_system_accessor.copy(File.join(locations.layout_repo_dir, '.'), locations.site_generator_home)
+
+          versions.each do |version|
+            copy_index_file_from_version_to_master_middleman(version, locations.source_for_site_generator, book_repo)
+          end
+        end
+
+        private
+
+        attr_reader :logger, :file_system_accessor, :version_control_system
+
+        def copy_index_file_from_version_to_master_middleman(version, dest_dir, book_repo)
+          Dir.mktmpdir(version) do |tmpdir|
+            book = Book.from_remote(logger: logger,
+                                    full_name: book_repo,
+                                    destination_dir: tmpdir,
+                                    ref: version,
+                                    git_accessor: version_control_system)
+            index_source_dir = File.join(tmpdir, book.directory, 'master_middleman', source_dir_name)
+            index_dest_dir = File.join(dest_dir, version)
+            file_system_accessor.make_directory(index_dest_dir)
+
+            Dir.glob(File.join(index_source_dir, 'index.*')) do |f|
+              file_system_accessor.copy(File.expand_path(f), index_dest_dir)
+            end
+          end
+        end
+
+        def forget_sections(middleman_scratch)
+          file_system_accessor.remove_directory File.join middleman_scratch, '.'
+        end
+
+        def copy_directory_from_gem(gem_root, dir, output_dir)
+          file_system_accessor.copy File.join(gem_root, "#{dir}/."), output_dir
+        end
+      end
+    end
+  end
+end