bookbindery 7.4.4 → 7.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 90579d5dc063e5b9444b2816d6018cab3e47f76f
-  data.tar.gz: f9ef0aa5d4f40113f4bc951bc8fcc9634ad8748b
+  metadata.gz: 0dd2c6b574a77666001273739f0136dd0465e51c
+  data.tar.gz: 854939e21e33cc8bd187f2b7560966d3b0698cb0
 SHA512:
-  metadata.gz: c1521e286256db035705dbd91383b0f1ea8d978a10412ce07d3d6238e06eb990ea0fc1e6a8416f6722da605856c2cf7d980fae8d043479e6b9c74f663e976fa6
-  data.tar.gz: f8b05f4ac7c8cb76abcf5a67eeb6a23ae60f925824e3c28779fa95dc05f9017a4e7238945af26eab21822e88f9994ebe5ce460cfaf7771c67819a118aa7e8ec6
+  metadata.gz: a56e6c5664b07e1b6bc862bc21ad716b299999a36baed3889fec5aa227ca8d8c962e3e71dd0281f6bd677dbdc64ff77e154d53ac6597658e7c2c27f3aa32208a
+  data.tar.gz: 863e5303ef86d674eba079dd486278e7e11e44f143140b858c8743c2567e31afe73db57315c1946b63b3a159222e460840648b0cbe4cc9a9fd83fb366b62c0cd

data/bookbinder.gemspec

@@ -2,7 +2,7 @@ require 'base64'
 
 Gem::Specification.new do |s|
   s.name        = 'bookbindery'
-  s.version     = '7.4.4'
+  s.version     = '7.5.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']

data/lib/bookbinder/cli.rb

@@ -36,7 +36,7 @@ module Bookbinder
       end
 
       begin
-        command_runner.run command_name, command_arguments
+        command_runner.run(command_name, command_arguments)
 
       rescue Config::CfCredentials::CredentialKeyError => e
         colorized_streams[:err].puts "#{e.message}, in credentials.yml"

data/lib/bookbinder/commands/bind.rb

@@ -1,7 +1,6 @@
 require 'middleman-syntax'
 
-require_relative '../errors/cli_error'
-require_relative 'bind/bind_options'
+require_relative 'components/command_options'
 require_relative 'naming'
 
 module Bookbinder
@@ -10,22 +9,23 @@ module Bookbinder
       include Commands::Naming
 
       def initialize(base_streams,
-                     output_locations,
-                     config_fetcher,
-                     config_decorator,
-                     file_system_accessor,
-                     static_site_generator,
-                     sitemap_writer,
-                     preprocessor,
-                     cloner_factory,
-                     section_repository,
-                     directory_preparer)
+                     output_locations: nil,
+                     config_fetcher: nil,
+                     config_decorator: nil,
+                     file_system_accessor: nil,
+                     middleman_runner: nil,
+                     sitemap_writer: nil,
+                     preprocessor: nil,
+                     cloner_factory: nil,
+                     section_repository: nil,
+                     directory_preparer: nil)
+
         @base_streams = base_streams
         @output_locations = output_locations
         @config_fetcher = config_fetcher
         @config_decorator = config_decorator
         @file_system_accessor = file_system_accessor
-        @static_site_generator = static_site_generator
+        @middleman_runner = middleman_runner
         @sitemap_writer = sitemap_writer
         @preprocessor = preprocessor
         @cloner_factory = cloner_factory
@@ -34,7 +34,7 @@ module Bookbinder
       end
 
       def usage
-        ["bind <local|remote> [--verbose] [--dita-flags='<dita-option>=<value>']",
+        ["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"]
       end
 
@@ -47,7 +47,7 @@ module Bookbinder
       end
 
       def run(cli_arguments)
-        bind_options        = BindComponents::BindOptions.new(cli_arguments, base_streams).tap(&:validate!)
+        bind_options        = Components::CommandOptions.new(cli_arguments, base_streams).tap(&:validate!)
         bind_config         = config_fetcher.fetch_config
         cloner              = cloner_factory.produce(bind_options.local_repo_dir)
 
@@ -75,7 +75,7 @@ module Bookbinder
         if file_system_accessor.file_exist?('redirects.rb')
           file_system_accessor.copy('redirects.rb', output_locations.final_app_dir)
         end
-        generation_result = static_site_generator.run(
+        generation_result = middleman_runner.run(
           ["build", bind_options.verbosity].compact.join(" "),
           streams: bind_options.streams,
           output_locations: output_locations,
@@ -114,7 +114,7 @@ module Bookbinder
         :preprocessor,
         :section_repository,
         :sitemap_writer,
-        :static_site_generator,
+        :middleman_runner,
       )
 
       def subnavs(sections)

data/lib/bookbinder/commands/collection.rb

@@ -2,12 +2,15 @@ Dir.glob(File.expand_path('../../commands/*.rb', __FILE__)).each do |command_fil
   require command_file
 end
 
-require_relative '../commands/bind/directory_preparer'
+require_relative '../commands/components/bind/directory_preparer'
+require_relative '../commands/components/imprint/directory_preparer'
 require_relative '../config/configuration_decorator'
 require_relative '../config/fetcher'
 require_relative '../config/remote_yaml_credential_provider'
 require_relative '../config/validator'
 require_relative '../config/yaml_loader'
+require_relative '../config/configuration'
+require_relative '../config/imprint/configuration'
 require_relative '../dita_command_creator'
 require_relative '../dita_html_for_middleman_formatter'
 require_relative '../html_document_manipulator'
@@ -16,7 +19,8 @@ require_relative '../ingest/section_repository'
 require_relative '../local_filesystem_accessor'
 require_relative '../middleman_runner'
 require_relative '../postprocessing/sitemap_writer'
-require_relative '../preprocessing/dita_preprocessor'
+require_relative '../preprocessing/dita_html_preprocessor'
+require_relative '../preprocessing/dita_pdf_preprocessor'
 require_relative '../preprocessing/link_to_site_gen_dir'
 require_relative '../preprocessing/preprocessor'
 require_relative '../subnav/subnav_generator_factory'
@@ -67,17 +71,18 @@ module Bookbinder
           ),
           build_and_push_tarball,
           bind,
-          Commands::PushFromLocal.new(streams, logger, configuration_fetcher, 'acceptance'),
+          Commands::PushFromLocal.new(streams, logger, configuration_fetcher(Config::Configuration), 'acceptance'),
           push_local_to_staging,
-          Commands::PushToProd.new(streams, logger, configuration_fetcher, Dir.mktmpdir),
+          Commands::PushToProd.new(streams, logger, configuration_fetcher(Config::Configuration), Dir.mktmpdir),
           Commands::RunPublishCI.new(bind, push_local_to_staging, build_and_push_tarball),
-          Commands::Punch.new(streams, configuration_fetcher, version_control_system),
+          Commands::Punch.new(streams, configuration_fetcher(Config::Configuration), version_control_system),
           Commands::UpdateLocalDocRepos.new(
             streams,
-            configuration_fetcher,
+            configuration_fetcher(Config::Configuration),
             version_control_system
           ),
-          watch
+          watch,
+          imprint
         ]
       end
 
@@ -88,34 +93,38 @@ module Bookbinder
       def bind
         @bind ||= Commands::Bind.new(
           streams,
-          output_locations,
-          configuration_fetcher,
-          Config::ConfigurationDecorator.new(loader: config_loader, config_filename: 'bookbinder.yml'),
-          local_filesystem_accessor,
-          runner,
-          Postprocessing::SitemapWriter.build(logger, final_app_directory, sitemap_port),
-          Preprocessing::Preprocessor.new(
-            Preprocessing::DitaPreprocessor.new(
+          output_locations: output_locations,
+          config_fetcher: configuration_fetcher(Config::Configuration),
+          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),
+          preprocessor: Preprocessing::Preprocessor.new(
+            Preprocessing::DitaHTMLPreprocessor.new(
               local_filesystem_accessor,
               subnav_generator_factory,
               DitaHtmlForMiddlemanFormatter.new(local_filesystem_accessor, html_document_manipulator),
-              DitaCommandCreator.new(ENV['PATH_TO_DITA_OT_LIBRARY']),
+              dita_command_creator,
               sheller
             ),
             Preprocessing::LinkToSiteGenDir.new(local_filesystem_accessor, subnav_generator_factory)
           ),
-          Ingest::ClonerFactory.new(streams, local_filesystem_accessor, version_control_system),
-          Ingest::SectionRepository.new,
-          directory_preparer
+          cloner_factory: Ingest::ClonerFactory.new(streams, local_filesystem_accessor, version_control_system),
+          section_repository: Ingest::SectionRepository.new,
+          directory_preparer: directory_preparer
         )
       end
 
+      def dita_command_creator
+        DitaCommandCreator.new(ENV['PATH_TO_DITA_OT_LIBRARY'])
+      end
+
       def watch
         @watch ||= Commands::Watch.new(
           streams,
           middleman_runner: runner,
           output_locations: output_locations,
-          config_fetcher: configuration_fetcher,
+          config_fetcher: configuration_fetcher(Config::Configuration),
           config_decorator: Config::ConfigurationDecorator.new(loader: config_loader, config_filename: 'bookbinder.yml'),
           file_system_accessor: local_filesystem_accessor,
           preprocessor: Preprocessing::Preprocessor.new(Preprocessing::LinkToSiteGenDir.new(local_filesystem_accessor, subnav_generator_factory)),
@@ -125,11 +134,23 @@ module Bookbinder
         )
       end
 
+      def imprint
+        Commands::Imprint.new(
+          streams,
+          output_locations: output_locations,
+          config_fetcher: configuration_fetcher(Config::Imprint::Configuration),
+          preprocessor: Preprocessing::Preprocessor.new(Preprocessing::DitaPDFPreprocessor.new(local_filesystem_accessor, dita_command_creator, sheller)),
+          cloner_factory: Ingest::ClonerFactory.new(streams, local_filesystem_accessor, version_control_system),
+          section_repository: Ingest::SectionRepository.new,
+          directory_preparer: Commands::Components::Imprint::DirectoryPreparer.new(local_filesystem_accessor)
+        )
+      end
+
       def push_local_to_staging
         @push_local_to_staging ||= Commands::PushFromLocal.new(
           streams,
           logger,
-          configuration_fetcher,
+          configuration_fetcher(Config::Configuration),
           'staging'
         )
       end
@@ -137,15 +158,16 @@ module Bookbinder
       def build_and_push_tarball
         @build_and_push_tarball ||= Commands::BuildAndPushTarball.new(
           streams,
-          configuration_fetcher
+          configuration_fetcher(Config::Configuration)
         )
       end
 
-      def configuration_fetcher
-        @configuration_fetcher ||= Config::Fetcher.new(
+      def configuration_fetcher(config_class)
+        Config::Fetcher.new(
           Config::Validator.new(local_filesystem_accessor),
           config_loader,
-          Config::RemoteYamlCredentialProvider.new(logger, version_control_system)
+          Config::RemoteYamlCredentialProvider.new(logger, version_control_system),
+          config_class
         ).tap do |fetcher|
           fetcher.set_config_file_path './config.yml'
           fetcher.set_config_dir_path './config/'
@@ -161,7 +183,7 @@ module Bookbinder
       end
 
       def directory_preparer
-        Commands::BindComponents::DirectoryPreparer.new(local_filesystem_accessor)
+        Commands::Components::Bind::DirectoryPreparer.new(local_filesystem_accessor)
       end
 
       def output_locations

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

@@ -0,0 +1,33 @@
+require_relative 'layout_preparer'
+
+module Bookbinder
+  module Commands
+    module Components
+      module Bind
+        class DirectoryPreparer
+          def initialize(fs)
+            @fs = fs
+          end
+
+          def prepare_directories(config, gem_root, output_locations, cloner, ref_override: nil)
+            fs.remove_directory(output_locations.output_dir)
+            fs.empty_directory(output_locations.final_app_dir)
+
+            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)
+
+            LayoutPreparer.new(fs).prepare(output_locations, cloner, ref_override, config)
+          end
+
+          private
+
+          attr_reader :fs
+
+          def copy_directory_from_gem(gem_root, dir, output_dir)
+            fs.copy_contents(File.join(gem_root, dir), output_dir)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+module Bookbinder
+  module Commands
+    module Components
+      module Bind
+        class LayoutPreparer
+          def initialize(fs)
+            @fs = fs
+          end
+
+          attr_reader :fs
+
+          def prepare(output_locations, cloner, ref_override, config)
+            if config.has_option?('layout_repo')
+
+              cloned_repo = cloner.call(source_repo_name: config.layout_repo,
+                                        source_ref: ref_override || config.layout_repo_ref,
+                                        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
+end

data/lib/bookbinder/commands/{bind/bind_options.rb → components/command_options.rb}

@@ -2,8 +2,8 @@ require_relative '../../sheller'
 
 module Bookbinder
   module Commands
-    module BindComponents
-      class BindOptions
+    module Components
+      class CommandOptions
         def initialize(opts, base_streams)
           @opts = opts
           @base_streams = base_streams

data/lib/bookbinder/commands/components/imprint/directory_preparer.rb

@@ -0,0 +1,24 @@
+module Bookbinder
+  module Commands
+    module Components
+      module Imprint
+        class DirectoryPreparer
+          def initialize(fs)
+            @fs = fs
+          end
+
+          def prepare_directories(output_locations)
+            fs.empty_directory(output_locations.output_dir)
+            fs.make_directory(output_locations.pdf_from_preprocessing_dir)
+
+            fs.empty_directory(output_locations.pdf_artifact_dir)
+          end
+
+          private
+
+          attr_reader :fs
+        end
+      end
+    end
+  end
+end

data/lib/bookbinder/commands/imprint.rb

@@ -0,0 +1,62 @@
+require_relative 'components/command_options'
+require_relative 'naming'
+
+module Bookbinder
+  module Commands
+    class Imprint
+      include Commands::Naming
+
+      def initialize(base_streams,
+                     output_locations: nil,
+                     config_fetcher: nil,
+                     preprocessor: nil,
+                     cloner_factory: nil,
+                     section_repository: nil,
+                     directory_preparer: nil)
+
+        @base_streams = base_streams
+        @output_locations = output_locations
+        @config_fetcher = config_fetcher
+        @preprocessor = preprocessor
+        @cloner_factory = cloner_factory
+        @section_repository = section_repository
+        @directory_preparer = directory_preparer
+      end
+
+      def usage
+        ["imprint <local|remote> [--verbose] [--dita-flags=\\\"<dita-option>=<value>\\\"]", "Generate a PDF for a given book"]
+      end
+
+      def run(cli_arguments)
+        options        = Components::CommandOptions.new(cli_arguments, base_streams).tap(&:validate!)
+        config         = config_fetcher.fetch_config
+        cloner         = cloner_factory.produce(options.local_repo_dir)
+
+        directory_preparer.prepare_directories(output_locations)
+
+        sections = section_repository.fetch(
+          configured_sections: config.sections,
+          destination_dir: output_locations.cloned_preprocessing_dir,
+          ref_override: options.ref_override,
+          cloner: cloner,
+          streams: base_streams
+        )
+
+        preprocessor.preprocess(
+          sections,
+          output_locations,
+          options: options.options,
+          output_streams: options.streams,
+          config: config
+        )
+
+        options.streams[:success].puts "Bookbinder printed your pdf(s) into #{output_locations.pdf_artifact_dir}"
+        0
+      end
+
+      private
+
+      attr_reader :preprocessor, :output_locations, :section_repository, :base_streams, :config_fetcher, :directory_preparer, :cloner_factory
+    end
+  end
+end

data/lib/bookbinder/commands/watch.rb

@@ -1,4 +1,3 @@
-require_relative 'bind/bind_options'
 require_relative 'naming'
 
 module Bookbinder

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

@@ -0,0 +1,27 @@
+module Bookbinder
+  module Config
+    module Checkers
+      class DitamapPresenceChecker
+        DitamapLocationError = Class.new(RuntimeError)
+
+        def check(config)
+          if any_sections_missing_ditamaps?(config.sections)
+            DitamapLocationError.new(
+              "You must have a 'ditamap_location' for each key in dita_sections."
+            )
+          end
+        end
+
+        private
+
+        def any_sections_missing_ditamaps?(sections)
+          sections.any? do |s|
+            if s.preprocessor_config.has_key?('ditamap_location')
+              s.preprocessor_config['ditamap_location'].nil? || s.preprocessor_config['ditamap_location'].empty?
+            end
+          end
+        end
+      end
+    end
+  end
+end