bookbindery 7.4.4 → 7.5.0

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

@@ -0,0 +1,15 @@
+module Bookbinder
+  module Config
+    module Checkers
+      class SectionPresenceChecker
+        NoSectionsError = Class.new(RuntimeError)
+
+        def check(config)
+          if config.sections.none?
+            NoSectionsError.new('No sections found in your config.yml. Add sections under the appropriate key(s) and try again.')
+          end
+        end
+      end
+    end
+  end
+end

data/lib/bookbinder/config/configuration.rb

@@ -1,3 +1,4 @@
+require_relative '../../../lib/bookbinder/config/dita_config_generator'
 require_relative '../ingest/destination_directory'
 require_relative '../ingest/repo_identifier'
 require_relative 'section_config'
@@ -8,13 +9,18 @@ module Bookbinder
     class Configuration
       class << self
         def parse(input_config)
+          section_configs = to_section_configs(combined_sections(input_config))
+          parse_sections(input_config, section_configs)
+        end
+
+        protected
+
+        def parse_sections(input_config, section_configs)
           new(symbolize_keys(input_config).
               merge(expand_repo_identifiers(input_config)).
-              merge(sections: combined_sections(input_config)))
+              merge(sections: section_configs))
         end
 
-        private
-
         def symbolize_keys(h)
           h.reduce({}) {|acc, (k, v)| acc.merge(k.to_sym => v) }
         end
@@ -24,9 +30,14 @@ module Bookbinder
             reduce({}) {|h, (k, v)| h.merge(:"#{k}_url" => Ingest::RepoIdentifier.new(v))}
         end
 
+        def to_section_configs sections
+          sections.map { |section| Config::SectionConfig.new(section) }
+        end
+
+        private
+
         def combined_sections(input_config)
-          (regular_sections(input_config) + dita_sections(input_config)).
-            map { |section| Config::SectionConfig.new(section) }
+          regular_sections(input_config) + dita_sections(input_config)
         end
 
         def regular_sections(input_config)
@@ -34,30 +45,10 @@ module Bookbinder
         end
 
         def dita_sections(input_config)
-          dita_sections = input_config['dita_sections']
-          (dita_sections || []).map { |dita_section|
-            dita_section.merge(
-              'preprocessor_config' => {
-                'ditamap_location' => dita_section['ditamap_location'],
-                'ditaval_location' => dita_section['ditaval_location']
-              },
-              'subnav_template' => dita_subnav_template(dita_sections, dita_section)
-            ).reject { |k, _|
-              %w(ditamap_location ditaval_location).include?(k)
-            }
+          (input_config['dita_sections'] || []).map { |dita_section|
+            DitaConfigGenerator.new(dita_section).to_hash
           }
         end
-
-        def dita_subnav_template(all_sections, current_section)
-          subnav_sections = all_sections.select { |section| section['ditamap_location'] }
-          if subnav_sections.any?
-            subnav_section = subnav_sections.include?(current_section) ? current_section : subnav_sections.first
-            dest_dir = Ingest::DestinationDirectory.new(
-              subnav_section.fetch('repository', {})['name'], subnav_section['directory'])
-
-            "dita_subnav_#{dest_dir}"
-          end
-        end
       end
 
       def initialize(config)

data/lib/bookbinder/config/dita_config_generator.rb

@@ -0,0 +1,61 @@
+require_relative '../../../lib/bookbinder/ingest/destination_directory'
+
+module Bookbinder
+  module Config
+    class DitaConfigGenerator
+
+      def initialize(section_hash)
+        @section_hash = section_hash
+      end
+
+      def subnav_template
+        dest_dir = Ingest::DestinationDirectory.new(section_hash.fetch('repository', {})['name'], section_hash['directory'])
+
+        "dita_subnav_#{dest_dir}"
+      end
+
+      def ditamap_location
+        section_hash['ditamap_location'] if section_hash['ditamap_location'] && !section_hash['ditamap_location'].empty?
+      end
+
+      def pdf_output_filename
+        if present?(section_hash['output_filename'])
+          filename = section_hash['output_filename']
+        elsif ditamap_location
+          filename =  ditamap_location.gsub(/\.ditamap/, '')
+        else
+          return
+        end
+
+        filename + '.pdf'
+      end
+
+      def preprocessor_config
+        {
+          'preprocessor_config' => {
+            'ditamap_location' => ditamap_location,
+            'ditaval_location' => section_hash['ditaval_location']
+          }
+        }
+      end
+
+      def to_hash
+        section_hash.tap do |hash|
+          hash.merge!(preprocessor_config)
+              .merge!('subnav_template' => subnav_template, 'output_filename' => pdf_output_filename)
+
+          hash.delete('ditaval_location')
+          hash.delete('ditamap_location')
+        end
+      end
+
+      private
+
+      attr_reader :section_hash
+      
+      def present?(value)
+        value && !value.empty?
+      end
+    end
+  end
+end

data/lib/bookbinder/config/fetcher.rb

@@ -6,10 +6,11 @@ require_relative 'yaml_loader'
 module Bookbinder
   module Config
     class Fetcher
-      def initialize(configuration_validator, loader, credentials_provider)
+      def initialize(configuration_validator, loader, credentials_provider, config_class)
         @loader = loader
         @configuration_validator = configuration_validator
         @credentials_provider = credentials_provider
+        @config_class = config_class
       end
 
       def fetch_config
@@ -43,7 +44,7 @@ module Bookbinder
       private
 
       attr_reader(:loader, :configuration_validator, :config, :config_file_path, :config_dir_path,
-                  :credentials_provider)
+                  :credentials_provider, :config_class)
 
       def read_config_file
         loader.load(config_file_path)
@@ -65,7 +66,7 @@ module Bookbinder
       def validate(base_hash, optional_hash)
         raise 'Your config.yml appears to be empty. Please check and try again.' unless base_hash
 
-        Configuration.parse(base_hash.merge(optional_hash)).tap do |config|
+        config_class.parse(base_hash.merge(optional_hash)).tap do |config|
           errors = configuration_validator.exceptions(config)
           raise errors.first if errors.any?
         end

data/lib/bookbinder/config/imprint/configuration.rb

@@ -0,0 +1,24 @@
+require_relative '../configuration'
+
+module Bookbinder
+  module Config
+    module Imprint
+      class Configuration < Config::Configuration
+        class << self
+          def parse(input_config)
+            section_configs = to_section_configs(pdf_sections(input_config))
+            parse_sections(input_config, section_configs)
+          end
+
+          private
+
+          def pdf_sections(input_config)
+            (input_config['pdf_sections'] || []).map { |pdf_section|
+              DitaConfigGenerator.new(pdf_section).to_hash
+            }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/bookbinder/config/section_config.rb

@@ -19,6 +19,10 @@ module Bookbinder
         config['directory']
       end
 
+      def pdf_output_filename
+        config['output_filename']
+      end
+
       def repo_name
         repo['name']
       end

data/lib/bookbinder/config/validator.rb

@@ -2,7 +2,8 @@ require_relative 'checkers/duplicate_section_name_checker'
 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/ditamap_presence_checker'
+require_relative 'checkers/section_presence_checker'
 require_relative 'checkers/subnavs_checker'
 require_relative 'checkers/topics_checker'
 
@@ -18,7 +19,8 @@ module Bookbinder
           Checkers::RequiredKeysChecker.new,
           Checkers::DuplicateSectionNameChecker.new,
           Checkers::RepositoryNamePresenceChecker.new,
-          Checkers::DitaSectionChecker.new,
+          Checkers::SectionPresenceChecker.new,
+          Checkers::DitamapPresenceChecker.new,
           Checkers::ArchiveMenuChecker.new(@file_system_accessor),
           Checkers::SubnavsChecker.new,
           Checkers::TopicsChecker.new

data/lib/bookbinder/dita_command_creator.rb

@@ -6,36 +6,38 @@ module Bookbinder
       @path_to_dita_ot_library = path_to_dita_ot_library
     end
 
-    def convert_to_html_command(dita_section, dita_flags: nil, write_to: nil)
-      classpath = "#{path_to_dita_ot_library}/lib/xercesImpl.jar:" +
-                  "#{path_to_dita_ot_library}/lib/xml-apis.jar:" +
-                  "#{path_to_dita_ot_library}/lib/resolver.jar:" +
-                  "#{path_to_dita_ot_library}/lib/commons-codec-1.4.jar:" +
-                  "#{path_to_dita_ot_library}/lib/icu4j.jar:" +
-                  "#{path_to_dita_ot_library}/lib/saxon/saxon9-dom.jar:" +
-                  "#{path_to_dita_ot_library}/lib/saxon/saxon9.jar:target/classes:" +
-                  "#{path_to_dita_ot_library}:" +
-                  "#{path_to_dita_ot_library}/lib/:" +
-                  "#{path_to_dita_ot_library}/lib/dost.jar"
+    def convert_to_pdf_command(dita_section, dita_flags: nil, write_to: nil)
+      "export CLASSPATH=#{classpath}; " +
+      "ant -f #{path_to_dita_ot_library} " +
+      unduplicated_flags(
+        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'),
+        default_transtype: 'pdf2'
+      )
+    end
 
+    def convert_to_html_command(dita_section, dita_flags: nil, write_to: nil)
       "export CLASSPATH=#{classpath}; " +
       "ant -f #{path_to_dita_ot_library} " +
         unduplicated_flags(
           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'),
+          default_transtype: 'tocjs'
       )
     end
 
     private
 
-    def unduplicated_flags(write_to: nil, ditamap_path: nil, ditaval_path: nil, dita_flags: nil)
+    def unduplicated_flags(write_to: nil, ditamap_path: nil, ditaval_path: nil, dita_flags: nil, default_transtype: nil)
       arg_flags = {
           'output.dir' => write_to,
           'args.input' => ditamap_path,
       }.merge(filter(ditaval_path))
-      all_flags = arg_flags.merge(base_flags.merge(optional_flags dita_flags))
+      all_flags = arg_flags.merge(base_flags(default_transtype: default_transtype).merge(optional_flags(dita_flags)))
       format(all_flags)
     end
 
@@ -43,10 +45,10 @@ module Bookbinder
       ditaval_path ? { 'args.filter' => ditaval_path } : {}
     end
 
-    def base_flags
+    def base_flags(default_transtype: nil)
       {
           'basedir' => '/',
-          'transtype' => 'tocjs',
+          'transtype' => default_transtype,
           'dita.temp.dir' => '/tmp/bookbinder_dita',
           'generate.copy.outer' => '2',
           'outer.control' => 'warn'
@@ -75,6 +77,19 @@ module Bookbinder
       v.to_s.gsub(/['|"]/, "")
     end
 
+    def classpath
+      "#{path_to_dita_ot_library}/lib/xercesImpl.jar:" +
+      "#{path_to_dita_ot_library}/lib/xml-apis.jar:" +
+      "#{path_to_dita_ot_library}/lib/resolver.jar:" +
+      "#{path_to_dita_ot_library}/lib/commons-codec-1.4.jar:" +
+      "#{path_to_dita_ot_library}/lib/icu4j.jar:" +
+      "#{path_to_dita_ot_library}/lib/saxon/saxon9-dom.jar:" +
+      "#{path_to_dita_ot_library}/lib/saxon/saxon9.jar:target/classes:" +
+      "#{path_to_dita_ot_library}:" +
+      "#{path_to_dita_ot_library}/lib/:" +
+      "#{path_to_dita_ot_library}/lib/dost.jar"
+    end
+
     attr_reader :path_to_dita_ot_library
   end
 end

data/lib/bookbinder/ingest/section_repository.rb

@@ -34,7 +34,8 @@ module Bookbinder
             section_config.preprocessor_config,
             section_config.at_repo_path,
             section_config.repo_name,
-            working_copy.ref
+            working_copy.ref,
+            section_config.pdf_output_filename
           )
         end
       end

data/lib/bookbinder/local_filesystem_accessor.rb

@@ -46,6 +46,11 @@ module Bookbinder
       FileUtils.cp_r src, dest
     end
 
+    def copy_and_rename(src, dest)
+      make_directory(Pathname(dest).dirname)
+      FileUtils.cp_r src, dest
+    end
+
     def copy_contents(src, dest)
       raise Errors::ProgrammerMistake.new("The method copy_contents cannot copy the contents of the directory '#{src}' because it was not found.") unless Dir.exists?(src)
       copy "#{src}/.", dest
@@ -68,7 +73,9 @@ module Bookbinder
     end
 
     def find_files_with_ext(ext, path)
-      Dir[File.join path, "**/*.#{ext}"]
+      all_files = find_files_recursively(path)
+      matching_files = all_files.select {|p| p.to_s.match(/\.#{ext}/) }
+      matching_files.map(&:to_s)
     end
 
     def relative_path_from(src, target)
@@ -78,7 +85,7 @@ module Bookbinder
     end
 
     def find_files_recursively(from)
-      `find -L #{from}`.
+      `find -L #{from} -type f`.
         lines.
         map(&:chomp).
         map(&Pathname.method(:new)).

data/lib/bookbinder/preprocessing/dita_html_preprocessor.rb

@@ -0,0 +1,94 @@
+require_relative '../values/subnav_template'
+require_relative '../../../lib/bookbinder/subnav/json_from_html_toc'
+require_relative 'dita_preprocessor'
+
+module Bookbinder
+  module Preprocessing
+    class DitaHTMLPreprocessor < DitaPreprocessor
+      DitaToHtmlLibraryFailure = Class.new(RuntimeError)
+
+      ACCEPTED_IMAGE_FORMATS = %w(png jpeg jpg svg gif bmp tif tiff eps)
+
+      def initialize(fs, subnav_gen_factory, dita_formatter, command_creator, sheller)
+        @fs = fs
+        @subnav_gen_factory = subnav_gen_factory
+        @dita_formatter = dita_formatter
+        @command_creator = command_creator
+        @sheller = sheller
+      end
+
+      def applicable_to?(section)
+        section.subnav_template.include?('dita_subnav') if section.subnav_template
+      end
+
+      def preprocess(sections, output_locations, options: [], output_streams: nil, **_)
+        @output_locations = output_locations
+
+        dita_options = dita_flags(options)
+
+        sections.each do |section|
+          if section.path_to_preprocessor_attribute('ditamap_location')
+            convert_dita_files(section,
+                               command_creator,
+                               dita_options,
+                               section_html_dir(section),
+                               sheller,
+                               output_streams)
+
+            subnav_generator.generate(section)
+          end
+
+          dita_formatter.format_html(section_html_dir(section), formatted_dir(section))
+          copy_images(section.path_to_repo_dir, formatted_dir(section))
+          fs.copy_contents(formatted_dir(section), source_for_site_gen_dir(section))
+        end
+      end
+
+      private
+
+      attr_reader :fs, :subnav_gen_factory, :dita_formatter, :command_creator, :sheller, :subnav_generator, :output_locations
+
+      def section_html_dir(section)
+        output_locations.html_from_preprocessing_dir.join(section.destination_directory)
+      end
+
+      def formatted_dir(section)
+        output_locations.formatted_dir.join(section.destination_directory)
+      end
+
+      def source_for_site_gen_dir(section)
+        output_locations.source_for_site_generator.join(section.destination_directory)
+      end
+
+      def convert_dita_files(section, command_creator, options, section_html_dir, sheller, output_streams)
+        command = command_creator.convert_to_html_command(
+          section,
+          dita_flags: options,
+          write_to: section_html_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
+
+      def copy_images(src, dest)
+        image_paths = ACCEPTED_IMAGE_FORMATS.map do |format|
+          fs.find_files_with_ext(format, src)
+        end.flatten
+
+        image_paths.each do |image_path|
+          fs.copy_including_intermediate_dirs(image_path, src, dest)
+        end
+      end
+
+
+      def subnav_generator
+        @subnav_generator ||= subnav_gen_factory.produce(Subnav::JsonFromHtmlToc.new(fs))
+      end
+    end
+  end
+end