bookbindery 3.0.1 → 3.1.0

data/lib/bookbinder/dita_command_creator.rb

@@ -1,12 +1,12 @@
-require_relative '../bookbinder/values/dita_section'
-
 module Bookbinder
   class DitaCommandCreator
+    MissingDitaOTFlagValue = Class.new(RuntimeError)
+
     def initialize(path_to_dita_ot_library)
       @path_to_dita_ot_library = path_to_dita_ot_library
     end
 
-    def convert_to_html_command(dita_section, write_to: nil)
+    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:" +
@@ -17,23 +17,67 @@ module Bookbinder
                   "#{path_to_dita_ot_library}:" +
                   "#{path_to_dita_ot_library}/lib/:" +
                   "#{path_to_dita_ot_library}/lib/dost.jar"
-      command = "export CLASSPATH=#{classpath}; " +
-                "ant -f #{path_to_dita_ot_library} " +
-                "-Dbasedir='/' " +
-                "-Doutput.dir=#{write_to} " +
-                "-Dtranstype='tocjs' " +
-                "-Ddita.temp.dir='/tmp/bookbinder_dita' " +
-                "-Dgenerate.copy.outer='2' " +
-                "-Dargs.input=#{dita_section.absolute_path_to_ditamap} "
-
-      if dita_section.absolute_path_to_ditaval
-        command += "-Dargs.filter=#{dita_section.absolute_path_to_ditaval} "
-      end
-      command
+
+      "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'),
+      )
     end
 
     private
 
+    def unduplicated_flags(write_to: nil, ditamap_path: nil, ditaval_path: nil, dita_flags: dita_flags)
+      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))
+      format(all_flags)
+    end
+
+    def filter(ditaval_path)
+      if ditaval_path
+        { 'args.filter' => ditaval_path }
+      else
+        {}
+      end
+    end
+
+    def base_flags
+      {
+          'basedir' => '/',
+          'transtype' => 'tocjs',
+          'dita.temp.dir' => '/tmp/bookbinder_dita',
+          'generate.copy.outer' => '2',
+          'outer.control' => 'warn'
+      }
+    end
+
+    def optional_flags(flags_str)
+      flags = flags_str ? flags_str.split(" ") : []
+      flags.inject({}) do |h, f|
+        k,v = f.split('=')
+        h[k] = v
+        raise MissingDitaOTFlagValue.new("The DITA-flag '#{k}' that you passed is missing a value. Please pass your DITA option in the format '#{k}=<value>'.") unless v
+        h
+      end
+    end
+
+    def format(flags)
+      flags.inject("") do |res, f|
+        k,v = f
+        res += "-D#{k}='#{stripped_flag_value v}' "
+      end
+    end
+
+    def stripped_flag_value(v)
+      v.to_s.gsub(/['|"]/, "")
+    end
+
     attr_reader :path_to_dita_ot_library
   end
 end

data/lib/bookbinder/dita_html_to_middleman_formatter.rb

@@ -29,11 +29,12 @@ module Bookbinder
       end
     end
 
-    def format_subnav(dita_section,
+    def format_subnav(path_to_dita_section,
                       subnav_template_text,
                       json_props_location,
                       unformatted_subnav_text)
-      formatted_json_links = subnav_formatter.get_links_as_json(unformatted_subnav_text, dita_section.directory)
+      formatted_json_links = subnav_formatter.get_links_as_json(unformatted_subnav_text,
+                                                                path_to_dita_section)
 
       nav_text = html_document_manipulator.set_attribute(document: subnav_template_text,
                                                          selector: 'div.nav-content',

data/lib/bookbinder/errors/programmer_mistake.rb

@@ -0,0 +1,5 @@
+module Bookbinder
+  module Errors
+    ProgrammerMistake = Class.new(RuntimeError)
+  end
+end

data/lib/bookbinder/git_accessor.rb

@@ -2,6 +2,9 @@ require 'git'
 
 module Bookbinder
   class GitAccessor
+    TagExists = Class.new(RuntimeError)
+    InvalidTagRef = Class.new(RuntimeError)
+
     def initialize
       @cache = {}
     end
@@ -12,12 +15,39 @@ module Bookbinder
       end
     end
 
+    def update(cloned_path)
+      Git.open(cloned_path).pull
+    end
+
     def read_file(filename, from_repo: nil, checkout: 'master')
       Dir.mktmpdir do |dir|
         path = Pathname(dir)
-        git = _clone(from_repo, "read-file", path)
+        git = _clone(from_repo, temp_name("read-file"), path)
         git.checkout(checkout)
-        path.join("read-file", filename).read
+        path.join(temp_name("read-file"), filename).read
+      end
+    end
+
+    def remote_tag(url, tagname, commit_or_object)
+      Dir.mktmpdir do |dir|
+        path = Pathname(dir)
+        git = _clone(url, temp_name("tag"), path)
+        git.config('user.name', 'Bookbinder')
+        git.config('user.email', 'bookbinder@cloudfoundry.org')
+        begin
+          git.add_tag(tagname, "origin/#{commit_or_object}",
+                      message: 'Tagged by Bookbinder')
+        rescue Git::GitExecuteError => e
+          case e.message
+          when /already exists/
+            raise TagExists
+          when /as a valid ref/
+            raise InvalidTagRef
+          else
+            raise
+          end
+        end
+        git.push("origin", "master", tags: true)
       end
     end
 
@@ -25,6 +55,10 @@ module Bookbinder
 
     attr_reader :cache
 
+    def temp_name(purpose)
+      "bookbinder-git-accessor-#{purpose}"
+    end
+
     def cached_clone(url, name, path)
       cache[[url, name, path]] ||= _clone(url, name, path)
     end

data/lib/bookbinder/ingest/cloner_factory.rb

@@ -1,4 +1,4 @@
-require_relative 'git_hub_repository_cloner'
+require_relative 'git_cloner'
 require_relative 'local_filesystem_cloner'
 
 module Bookbinder
@@ -10,11 +10,11 @@ module Bookbinder
         @version_control_system = version_control_system
       end
 
-      def produce(source, user_repo_dir)
+      def produce(user_repo_dir)
         if user_repo_dir
           LocalFilesystemCloner.new(logger, filesystem, user_repo_dir)
         else
-          GitHubRepositoryCloner.new(version_control_system)
+          GitCloner.new(version_control_system)
         end
       end
 

data/lib/bookbinder/ingest/destination_directory.rb

@@ -2,7 +2,13 @@ module Bookbinder
   module Ingest
     DestinationDirectory = Struct.new(:full_repo_name, :desired_destination_dir_name) do
       def to_str
-        desired_destination_dir_name || full_repo_name.split('/')[1]
+        if desired_destination_dir_name
+          desired_destination_dir_name.to_s
+        elsif full_repo_name
+          full_repo_name.split('/').last
+        else
+          ""
+        end
       end
 
       alias :to_s :to_str

data/lib/bookbinder/ingest/{git_hub_repository_cloner.rb → git_cloner.rb}

@@ -1,9 +1,10 @@
 require_relative 'destination_directory'
+require_relative 'repo_identifier'
 require_relative 'working_copy'
 
 module Bookbinder
   module Ingest
-    class GitHubRepositoryCloner
+    class GitCloner
       def initialize(version_control_system)
         @version_control_system = version_control_system
       end
@@ -15,7 +16,7 @@ module Bookbinder
         dest_dir = DestinationDirectory.new(source_repo_name, destination_dir_name)
         copied_to = Pathname(destination_parent_dir).join(dest_dir)
         version_control_system.clone(
-          "git@github.com:#{source_repo_name}",
+          RepoIdentifier.new(source_repo_name),
           dest_dir,
           path: destination_parent_dir,
           checkout: source_ref

data/lib/bookbinder/ingest/repo_identifier.rb

@@ -0,0 +1,45 @@
+module Bookbinder
+  module Ingest
+    class RepoIdentifier
+      DEFAULT_VCS_PREFIX = 'git@github.com:'
+
+      def initialize(input_identifier)
+        @input_identifier = input_identifier
+      end
+
+      def to_str
+        if input_identifier.nil?
+          ""
+        elsif input_identifier.include?(':')
+          input_identifier
+        else
+          "#{DEFAULT_VCS_PREFIX}#{input_identifier}"
+        end
+      end
+
+      alias :to_s :to_str
+
+      def inspect
+        %Q("#{to_s}")
+      end
+
+      def split(*args)
+        input_identifier.split(*args)
+      end
+
+      def hash
+        to_str.hash
+      end
+
+      def ==(other)
+        to_str == other
+      end
+
+      alias :eql? :==
+
+      private
+
+      attr_reader :input_identifier
+    end
+  end
+end

data/lib/bookbinder/local_file_system_accessor.rb

@@ -1,6 +1,7 @@
 require 'find'
 require 'pathname'
 require 'nokogiri'
+require_relative 'errors/programmer_mistake'
 
 module Bookbinder
 
@@ -32,19 +33,13 @@ module Bookbinder
     end
 
     def copy(src, dest)
-      unless File.directory?(dest)
-        FileUtils.mkdir_p(dest)
-      end
-
+      make_directory(dest)
       FileUtils.cp_r src, dest
     end
 
     def copy_contents(src, dest)
-      unless File.directory?(dest)
-        FileUtils.mkdir_p(dest)
-      end
-
-      FileUtils.cp_r "#{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
     end
 
     def copy_including_intermediate_dirs(file, root, dest)

data/lib/bookbinder/middleman_runner.rb

@@ -1,13 +1,12 @@
+require 'git/lib'
 require 'middleman-core'
 require 'middleman-core/cli'
 require 'middleman-core/profiling'
-require_relative 'values/code_example'
 require_relative 'code_example_reader'
 
 class Middleman::Cli::BuildAction
   def handle_error(file_name, response, e=Thor::Error.new(response))
-    our_errors = [Bookbinder::GitClient::TokenException,
-                  Bookbinder::CodeExampleReader::InvalidSnippet,
+    our_errors = [Bookbinder::CodeExampleReader::InvalidSnippet,
                   QuicklinksRenderer::BadHeadingLevelError,
                   Git::GitExecuteError]
     raise e if our_errors.include?(e.class)
@@ -46,10 +45,10 @@ module Bookbinder
 
       within(output_locations.master_dir) do
         invoke_against_current_dir(output_locations.workspace_dir,
-                                   config[:host_for_sitemap],
+                                   config.public_host,
                                    subnav_templates_by_directory,
-                                   config.fetch(:template_variables, {}),
-                                   config[:archive_menu],
+                                   config.template_variables,
+                                   config.archive_menu,
                                    verbose,
                                    cloner)
       end

data/lib/bookbinder/preprocessing/copy_to_site_gen_dir.rb

@@ -0,0 +1,27 @@
+module Bookbinder
+  module Preprocessing
+    class CopyToSiteGenDir
+      def initialize(filesystem)
+        @filesystem = filesystem
+      end
+
+      def applicable_to?(section)
+        section.subnav_template != 'dita_subnav' &&
+          filesystem.file_exist?(section.path_to_repository)
+      end
+
+      def preprocess(sections, output_locations, *_)
+        sections.each do |section|
+          filesystem.copy_contents(
+            section.path_to_repository,
+            output_locations.source_for_site_generator.join(section.desired_directory)
+          )
+        end
+      end
+
+      private
+
+      attr_reader :filesystem
+    end
+  end
+end

data/lib/bookbinder/preprocessing/dita_preprocessor.rb

@@ -0,0 +1,103 @@
+require_relative '../values/subnav'
+
+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(dita_formatter, local_fs_accessor, command_creator, sheller)
+        @dita_formatter = dita_formatter
+        @local_fs_accessor = local_fs_accessor
+        @command_creator = command_creator
+        @sheller = sheller
+      end
+
+      def applicable_to?(section)
+        section.subnav_template == 'dita_subnav'
+      end
+
+      def preprocess(dita_sections, output_locations, options: nil, output_streams: nil)
+        dita_sections.select { |dita_section| dita_section.path_to_preprocessor_attribute('ditamap_location') }.each do |dita_section|
+          command = command_creator.convert_to_html_command(
+            dita_section,
+            dita_flags: dita_flags(options),
+            write_to: output_locations.html_from_preprocessing_dir.join(dita_section.desired_directory)
+          )
+          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
+
+          generate_subnav(dita_section.desired_directory,
+                          output_locations,
+                          output_locations.source_for_site_generator.join('subnavs', '_dita_subnav_template.erb'),
+                          output_locations.subnavs_for_layout_dir)
+        end
+
+        dita_sections.each do |dita_section|
+          html_dir = output_locations.html_from_preprocessing_dir.join(dita_section.desired_directory)
+          formatted_dir = output_locations.formatted_dir.join(dita_section.desired_directory)
+          source_for_site_gen_dir = output_locations.source_for_site_generator.join(dita_section.desired_directory)
+
+          dita_formatter.format_html html_dir, formatted_dir
+
+          copy_images(dita_section.path_to_repository, formatted_dir)
+
+          local_fs_accessor.copy_contents(formatted_dir, source_for_site_gen_dir)
+        end
+      end
+
+      private
+
+      attr_reader :dita_formatter, :local_fs_accessor, :command_creator, :sheller
+
+      def generate_subnav(dita_section_dir, output_locations, dita_subnav_template_path, subnavs_dir)
+        dita_subnav_template_text = local_fs_accessor.read(dita_subnav_template_path)
+
+        tocjs_text = local_fs_accessor.read(
+          File.join(
+            output_locations.html_from_preprocessing_dir.join(dita_section_dir),
+            'index.html')
+        )
+        json_props_location = File.join('dita-subnav-props.json')
+        props_file_location = File.join(subnavs_dir, json_props_location)
+
+        subnav = dita_formatter.format_subnav(dita_section_dir,
+                                              dita_subnav_template_text,
+                                              json_props_location,
+                                              tocjs_text)
+
+       local_fs_accessor.write text: subnav.json_links, to: props_file_location
+
+       local_fs_accessor.write text: subnav.text,
+                               to: File.join(subnavs_dir, "dita_subnav.erb")
+      end
+
+      def copy_images(src, dest)
+        image_paths = ACCEPTED_IMAGE_FORMATS.map do |format|
+          local_fs_accessor.find_files_with_ext(format, src)
+        end.flatten
+
+        image_paths.each do |image_path|
+          local_fs_accessor.copy_including_intermediate_dirs(image_path,
+                                                             src,
+                                                             dest)
+        end
+      end
+
+      def dita_flags(opts)
+        matching_flags = opts.map {|o| o[flag_value_regex("dita-flags"), 1] }
+        matching_flags.compact.first
+      end
+
+      def flag_value_regex(flag_name)
+        Regexp.new(/--#{flag_name}=(.+)/)
+      end
+    end
+  end
+end