bookbindery 7.4.4 → 7.5.0

data/lib/bookbinder/preprocessing/dita_pdf_preprocessor.rb

@@ -0,0 +1,50 @@
+require_relative 'dita_preprocessor'
+
+module Bookbinder
+  module Preprocessing
+    class DitaPDFPreprocessor < DitaPreprocessor
+      DitaToPDFLibraryFailure = Class.new(RuntimeError)
+
+      def initialize(fs, command_creator, sheller)
+        @fs = fs
+        @command_creator = command_creator
+        @sheller = sheller
+      end
+
+      def applicable_to?(section)
+        !!section.pdf_output_filename
+      end
+
+      def preprocess(sections, output_locations, options: [], output_streams: nil, **_)
+        sections.each do |section|
+          command = command_creator.convert_to_pdf_command(
+            section,
+            dita_flags: dita_flags(options),
+            write_to: output_locations.pdf_from_preprocessing_dir
+          )
+          status = sheller.run_command(command, output_streams.to_h)
+
+          if status.success?
+            pdf_path = most_recent_pdf(output_locations.pdf_from_preprocessing_dir)
+            pdf_destination = output_locations.pdf_artifact_dir.join(section.pdf_output_filename)
+            fs.copy_and_rename(pdf_path, pdf_destination)
+          else
+            raise DitaToPDFLibraryFailure.new 'The DITA-to-PDF 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
+      end
+
+      def most_recent_pdf(dir_path)
+        pdfs_by_modified_date = Dir.glob(dir_path + '*.pdf').sort_by{ |f| File.mtime(f) }
+        pdfs_by_modified_date.last
+      end
+
+      private
+
+      attr_reader :command_creator, :sheller, :fs
+    end
+  end
+end

data/lib/bookbinder/preprocessing/dita_preprocessor.rb

@@ -1,88 +1,8 @@
-require_relative '../values/subnav_template'
-require_relative '../../../lib/bookbinder/subnav/json_from_html_toc'
-
 module Bookbinder
   module Preprocessing
     class 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
+      protected
 
       def dita_flags(opts)
         matching_flags = opts.map {|o| o[flag_value_regex("dita-flags"), 1] }
@@ -90,11 +10,7 @@ module Bookbinder
       end
 
       def flag_value_regex(flag_name)
-        Regexp.new(/--#{flag_name}=(.+)/)
-      end
-
-      def subnav_generator
-        @subnav_generator ||= subnav_gen_factory.produce(Subnav::JsonFromHtmlToc.new(fs))
+        Regexp.new(/--#{flag_name}="(.+)"/)
       end
     end
   end

data/lib/bookbinder/values/output_locations.rb

@@ -46,6 +46,10 @@ module Bookbinder
       preprocessing_home_dir.join('html_from_preprocessing')
     end
 
+    def pdf_from_preprocessing_dir
+      preprocessing_home_dir.join('pdf_from_preprocessing')
+    end
+
     def formatted_dir
       preprocessing_home_dir.join('site_generator_ready')
     end
@@ -66,6 +70,14 @@ module Bookbinder
       context_dir
     end
 
+    def artifact_dir
+      context_dir.join('artifacts')
+    end
+
+    def pdf_artifact_dir
+      artifact_dir.join('pdfs')
+    end
+
     private
 
     def context_dir

data/lib/bookbinder/values/section.rb

@@ -10,7 +10,9 @@ module Bookbinder
                        :preprocessor_config,
                        :at_repo_path,
                        :repo_name,
-                       :source_ref) do
+                       :source_ref,
+                       :pdf_output_filename) do
+
     def path_to_repo_dir
       at_repo_path.nil? ? path_to_repository : path_to_repository.join(at_repo_path)
     end

data/master_middleman/bookbinder_helpers.rb

@@ -83,13 +83,12 @@ module Bookbinder
         @_out_buf.concat "<div class='mermaid'>#{escaped_text}</div>"
       end
 
-      def modified_date(format: "%B %-d, %Y", default_date: nil)
-        date = page_last_modified_date
-        author_date = date.strftime(format) if date
+      def modified_date(default_date: nil)
+        parsed_default_date = Time.parse(default_date).utc if default_date
 
-        display_date = author_date || default_date
+        date = page_last_modified_date || parsed_default_date
 
-        "Page last updated: #{display_date}" if display_date
+        "Page last updated: <span data-behavior=\"DisplayModifiedDate\" data-modified-date=\"#{date}\"></span>" if date
       end
 
       def breadcrumbs
@@ -133,11 +132,13 @@ module Bookbinder
       def page_last_modified_date
         git_accessor = Ingest::GitAccessor.new
 
-        if current_page.data.dita
+        current_date = if current_page.data.dita
           git_accessor.author_date(preprocessing_path(current_page.source_file), dita: true)
         else
           git_accessor.author_date(current_page.source_file)
         end
+
+        current_date.utc if current_date
       end
 
       def repo_url

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bookbindery
 version: !ruby/object:Gem::Version
-  version: 7.4.4
+  version: 7.5.0
 platform: ruby
 authors:
 - Mike Grafton
@@ -18,7 +18,7 @@ authors:
 autorequire: 
 bindir: install_bin
 cert_chain: []
-date: 2016-01-25 00:00:00.000000000 Z
+date: 2016-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fog-aws
@@ -317,14 +317,16 @@ files:
 - lib/bookbinder/command_runner.rb
 - lib/bookbinder/command_validator.rb
 - lib/bookbinder/commands/bind.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/build_and_push_tarball.rb
 - lib/bookbinder/commands/chain.rb
 - lib/bookbinder/commands/collection.rb
+- lib/bookbinder/commands/components/bind/directory_preparer.rb
+- lib/bookbinder/commands/components/bind/layout_preparer.rb
+- lib/bookbinder/commands/components/command_options.rb
+- lib/bookbinder/commands/components/imprint/directory_preparer.rb
 - lib/bookbinder/commands/generate.rb
 - lib/bookbinder/commands/help.rb
+- lib/bookbinder/commands/imprint.rb
 - lib/bookbinder/commands/naming.rb
 - lib/bookbinder/commands/punch.rb
 - lib/bookbinder/commands/push_from_local.rb
@@ -336,15 +338,18 @@ files:
 - lib/bookbinder/config/aws_credentials.rb
 - lib/bookbinder/config/cf_credentials.rb
 - lib/bookbinder/config/checkers/archive_menu_checker.rb
-- lib/bookbinder/config/checkers/dita_section_checker.rb
+- lib/bookbinder/config/checkers/ditamap_presence_checker.rb
 - 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/section_presence_checker.rb
 - lib/bookbinder/config/checkers/subnavs_checker.rb
 - lib/bookbinder/config/checkers/topics_checker.rb
 - lib/bookbinder/config/configuration.rb
 - lib/bookbinder/config/configuration_decorator.rb
+- lib/bookbinder/config/dita_config_generator.rb
 - lib/bookbinder/config/fetcher.rb
+- lib/bookbinder/config/imprint/configuration.rb
 - lib/bookbinder/config/remote_yaml_credential_provider.rb
 - lib/bookbinder/config/section_config.rb
 - lib/bookbinder/config/subnav_config.rb
@@ -383,6 +388,8 @@ files:
 - lib/bookbinder/local_filesystem_accessor.rb
 - lib/bookbinder/middleman_runner.rb
 - lib/bookbinder/postprocessing/sitemap_writer.rb
+- lib/bookbinder/preprocessing/dita_html_preprocessor.rb
+- lib/bookbinder/preprocessing/dita_pdf_preprocessor.rb
 - lib/bookbinder/preprocessing/dita_preprocessor.rb
 - lib/bookbinder/preprocessing/link_to_site_gen_dir.rb
 - lib/bookbinder/preprocessing/preprocessor.rb

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

@@ -1,31 +0,0 @@
-require_relative 'layout_preparer'
-
-module Bookbinder
-  module Commands
-    module BindComponents
-      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

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

@@ -1,25 +0,0 @@
-module Bookbinder
-  module Commands
-    module BindComponents
-      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

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

@@ -1,31 +0,0 @@
-module Bookbinder
-  module Config
-    module Checkers
-      class DitaSectionChecker
-        DitamapLocationError = Class.new(RuntimeError)
-
-        def check(config)
-          if none_with_pred?(dita_sections(config)) { |s|
-            s.preprocessor_config['ditamap_location']
-          }
-            DitamapLocationError.new(
-              "You must have at least one 'ditamap_location' key in dita_sections."
-            )
-          end
-        end
-
-        private
-
-        def none_with_pred?(coll, &block)
-          coll.any? && coll.none?(&block)
-        end
-
-        def dita_sections(config)
-          config.sections.select {|s|
-            s.preprocessor_config.has_key?('ditamap_location')
-          }
-        end
-      end
-    end
-  end
-end