bookbindery 3.0.1 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 61ee95fb7c8fa4d8f94f82fb98582fd65cb95b00
-  data.tar.gz: 402dbbe4d95e314482d09803c85d2560f424bde5
+  metadata.gz: 76b73998f089e3dd934d8eb163cddfd19f66be5e
+  data.tar.gz: 98e8dc00c79fad5bd569f4532adde577588afe7a
 SHA512:
-  metadata.gz: 657c1ab7338a891a60f59b3f3a01d683f65cac80a528907ee9918d55ef45202615684a57069c72525a65bbf6a310bb4183fecaabde6c2bfa73743ef9daeaa2b1
-  data.tar.gz: 725747cd9531772d3df4fe41af349bc165bc13fbc8db64c886debfc7f0866d720c730a72ee977ff3759d0f046e3f20dd18267ebe19fe5d47aed302b0f84532ef
+  metadata.gz: 932df3bf015a4f130ecbfde27454d173fbdfb58ea187527f60871de14d7066ff797e0c91c01573cf4da8473149a466618021c2cda517a18e3f9275a80d8faae1
+  data.tar.gz: 8e481e936fbf7f12f16d4f735d58f6b28f4db037fe42a9393bfa2315f9725f3eaaaa3a965ecaada1e1023c61c84d1ba8820710ef7460f557f9a662df6d25f072

data/lib/bookbinder.rb

@@ -1,7 +1,6 @@
 require 'fog/aws'
 require 'tmpdir'
 require 'ansi'
-require 'octokit'
 require 'middleman-syntax'
 require 'middleman-core/cli'
 require 'middleman-core/profiling'
@@ -11,10 +10,7 @@ require 'vienna'
 require 'puma'
 
 require_relative 'bookbinder/deprecated_logger'
-require_relative 'bookbinder/git_client'
 require_relative 'bookbinder/values/section'
-require_relative 'bookbinder/book'
-require_relative 'bookbinder/values/code_example'
 require_relative 'bookbinder/remote_yaml_credential_provider'
 require_relative 'bookbinder/configuration'
 require_relative 'bookbinder/configuration_fetcher'

data/lib/bookbinder/archive.rb

@@ -2,20 +2,22 @@ require 'fog/aws'
 require 'tmpdir'
 require_relative 'artifact_namer'
 require_relative 'deprecated_logger'
+require_relative 'time_fetcher'
 
 module Bookbinder
   class Archive
     class FileDoesNotExist < StandardError; end
     class NoNamespaceGiven < StandardError; end
 
-    def initialize(logger: nil, key: '', secret: '')
+    def initialize(logger: nil, time_fetcher: TimeFetcher.new, key: '', secret: '')
       @logger = logger
+      @time_fetcher = time_fetcher
       @aws_key = key
       @aws_secret_key = secret
     end
 
     def create_and_upload_tarball(build_number: nil, app_dir: 'final_app', bucket: '', namespace: nil)
-      raise 'You must provide a build_number to push an identifiable build.' unless build_number
+      build_number ||= time_fetcher.current_time
       raise 'You must provide a namespace to push an identifiable build.' unless namespace
 
       tarball_filename, tarball_path = create_tarball(app_dir, build_number, namespace)
@@ -48,8 +50,14 @@ module Bookbinder
       @logger.log "Green build ##{build_number.to_s.green} has been downloaded from S3 and untarred into #{download_dir.to_s.cyan}"
     end
 
+    def tarball_name_regex(namespace)
+      /^#{namespace}-(\d+_?\d*)\.tgz/
+    end
+
     private
 
+    attr_reader :time_fetcher
+
     def find_or_create_directory(name)
       connection.directories.create(key: name)
     rescue Excon::Errors::Conflict
@@ -69,15 +77,14 @@ module Bookbinder
 
       all_files_with_namespace = all_files.map do |file|
         filename = file.key
-        matches = /^#{namespace}-([\d]+)\.tgz/.match(filename)
-        file if matches
+        file if filename[tarball_name_regex(namespace)]
       end.compact
 
       return nil if all_files_with_namespace.empty?
       most_recent_file = all_files_with_namespace.sort_by { |file| file.last_modified }.last
 
       most_recent_filename = most_recent_file.key
-      most_recent_build_number = /^#{namespace}-([\d]+)\.tgz/.match(most_recent_filename)[1]
+      most_recent_filename[tarball_name_regex(namespace), 1]
     end
 
     def connection

data/lib/bookbinder/archive_menu_configuration.rb

@@ -7,8 +7,8 @@ module Bookbinder
 
     def generate(base_config, sections)
       base_config.merge(
-        archive_menu: root_config(base_config).merge(section_config(sections))
-      )
+        Configuration.parse(
+          'archive_menu' => root_config(base_config).merge(section_config(sections))))
     end
 
     private
@@ -16,7 +16,7 @@ module Bookbinder
     attr_reader :loader, :config_filename
 
     def root_config(base_config)
-      { '.' => base_config[:archive_menu] }
+      { '.' => base_config.archive_menu }
     end
 
     def section_config(sections)
@@ -24,7 +24,7 @@ module Bookbinder
         config_path = section.path_to_repository.join(config_filename)
         archive_config = loader.load_key(config_path, 'archive_menu')
         if archive_config
-          config.merge(section.directory_name => archive_config)
+          config.merge(section.desired_directory_name => archive_config)
         else
           config
         end

data/lib/bookbinder/commands/bind.rb

@@ -1,13 +1,10 @@
 require 'middleman-syntax'
 
 require_relative '../archive_menu_configuration'
-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 'bind/bind_options'
 require_relative 'naming'
 
 module Bookbinder
@@ -15,10 +12,7 @@ module Bookbinder
     class Bind
       include Commands::Naming
 
-      DitaToHtmlLibraryFailure = Class.new(RuntimeError)
-
       def initialize(logger,
-                     config_fetcher,
                      config_factory,
                      archive_menu_config,
                      version_control_system,
@@ -27,15 +21,11 @@ module Bookbinder
                      sitemap_writer,
                      final_app_directory,
                      context_dir,
-                     dita_preprocessor,
+                     preprocessor,
                      cloner_factory,
-                     dita_section_gatherer_factory,
-                     section_repository,
-                     command_creator,
-                     sheller,
+                     section_repository_factory,
                      directory_preparer)
         @logger = logger
-        @config_fetcher = config_fetcher
         @config_factory = config_factory
         @archive_menu_config = archive_menu_config
         @version_control_system = version_control_system
@@ -44,18 +34,15 @@ module Bookbinder
         @sitemap_writer = sitemap_writer
         @final_app_directory = final_app_directory
         @context_dir = context_dir
-        @dita_preprocessor = dita_preprocessor
+        @preprocessor = preprocessor
         @cloner_factory = cloner_factory
-        @dita_section_gatherer_factory = dita_section_gatherer_factory
-        @section_repository = section_repository
-        @command_creator = command_creator
-        @sheller = sheller
+        @section_repository_factory = section_repository_factory
         @directory_preparer = directory_preparer
       end
 
       def usage
-        ["bind <local|github> [--verbose]",
-         "Bind the sections specified in config.yml from <local> or <github> into the final_app directory"]
+        ["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
 
       def command_for?(test_command_name)
@@ -67,59 +54,40 @@ module Bookbinder
       end
 
       def run(cli_arguments)
-        bind_source, *options = cli_arguments
-        validate(bind_source, options)
+        bind_options = BindComponents::BindOptions.new(cli_arguments)
+        bind_options.validate!
 
+        bind_source, *options = cli_arguments
         bind_config = config_factory.produce(bind_source)
-        output_streams = Streams::SwitchableStdoutAndRedStderr.new(options)
 
         output_locations = OutputLocations.new(
           context_dir: context_dir,
           final_app_dir: final_app_directory,
-          layout_repo_dir: layout_repo_path(generate_local_repo_dir(context_dir, bind_source)),
+          layout_repo_dir: layout_repo_path(bind_config, generate_local_repo_dir(context_dir, bind_source)),
           local_repo_dir: generate_local_repo_dir(context_dir, bind_source)
         )
+        cloner = cloner_factory.produce(output_locations.local_repo_dir)
+        section_repository = section_repository_factory.produce(cloner)
 
         directory_preparer.prepare_directories(
+          bind_config,
           File.expand_path('../../../../', __FILE__),
-          bind_config.fetch(:versions, []),
-          output_locations,
-          bind_config[:book_repo]
+          output_locations
         )
 
-        dita_gatherer = dita_section_gatherer_factory.produce(bind_source, output_locations)
-        gathered_dita_sections = dita_gatherer.gather(config.dita_sections)
-
-        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(
-          bind_source,
-          output_locations.local_repo_dir
-        )
-        sections = gather_sections(
-          output_locations.source_for_site_generator,
-          cloner,
-          ('master' if options.include?('--ignore-section-refs'))
+        sections = section_repository.fetch(
+          configured_sections: bind_config.sections,
+          destination_dir: output_locations.cloned_preprocessing_dir,
+          ref_override: bind_options.ref_override
         )
 
-        subnavs = (sections + gathered_dita_sections).map(&:subnav).reduce(&:merge)
+        preprocessor.preprocess(sections,
+                                output_locations,
+                                options: options,
+                                output_streams: bind_options.streams)
 
         success = publish(
-          subnavs,
+          sections.map(&:subnav).reduce(&:merge),
           {verbose: options.include?('--verbose')},
           output_locations,
           archive_menu_config.generate(bind_config, sections),
@@ -132,7 +100,6 @@ module Bookbinder
       private
 
       attr_reader :version_control_system,
-                  :config_fetcher,
                   :config_factory,
                   :archive_menu_config,
                   :logger,
@@ -141,18 +108,15 @@ module Bookbinder
                   :final_app_directory,
                   :sitemap_writer,
                   :context_dir,
-                  :dita_preprocessor,
+                  :preprocessor,
                   :cloner_factory,
-                  :dita_section_gatherer_factory,
-                  :section_repository,
-                  :command_creator,
-                  :sheller,
+                  :section_repository_factory,
                   :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)
+        host_for_sitemap = publish_config.public_host
 
         static_site_generator.run(output_locations,
                                   publish_config,
@@ -178,34 +142,11 @@ module Bookbinder
         File.expand_path('..', context_dir) if bind_source == 'local'
       end
 
-      def gather_sections(workspace, cloner, ref_override)
-        config.sections.map do |section_config|
-          target_ref = ref_override ||
-            section_config.fetch('repository', {})['ref'] ||
-            'master'
-          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(
-            section_config,
-            working_copy: working_copy,
-            destination_dir: workspace
-          ) { |*args| Section.new(*args) }
-        end
-      end
-
-      def config
-        config_fetcher.fetch_config
-      end
-
-      def layout_repo_path(local_repo_dir)
+      def layout_repo_path(config, local_repo_dir)
         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)
+          cloner = cloner_factory.produce(nil)
           working_copy = cloner.call(source_repo_name: config.layout_repo,
                                      destination_parent_dir: Dir.mktmpdir)
           working_copy.path
@@ -213,15 +154,6 @@ module Bookbinder
           File.absolute_path('master_middleman')
         end
       end
-
-      def validate(bind_source, options)
-        raise CliError::InvalidArguments unless arguments_are_valid?(bind_source, options)
-      end
-
-      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
 end

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

@@ -0,0 +1,50 @@
+require_relative '../../sheller'
+require_relative '../../streams/colorized_stream'
+
+module Bookbinder
+  module Commands
+    module BindComponents
+      class BindOptions
+        def initialize(opts)
+          @opts = opts
+        end
+
+        def validate!
+          raise CliError::InvalidArguments unless arguments_are_valid?
+        end
+
+        def ref_override
+          'master' if opts.include?('--ignore-section-refs')
+        end
+
+        def streams
+          {
+            out: opts.include?('--verbose') ? $stdout : Sheller::DevNull.new,
+            err: Streams::ColorizedStream.new(Colorizer::Colors.red, $stderr)
+          }
+        end
+
+        private
+
+        attr_accessor :opts
+
+        def arguments_are_valid?
+          valid_options = %w(--verbose --ignore-section-refs --dita-flags).to_set
+          %w(local remote github).include?(bind_source) && flag_names.to_set.subset?(valid_options)
+        end
+
+        def flag_names
+          options.map {|o| o.split('=').first}
+        end
+
+        def bind_source
+          opts.first
+        end
+
+        def options
+          opts[1..-1]
+        end
+      end
+    end
+  end
+end

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

@@ -1,4 +1,5 @@
 require_relative '../../directory_helpers'
+require_relative '../../ingest/destination_directory'
 
 module Bookbinder
   module Commands
@@ -12,17 +13,17 @@ module Bookbinder
           @version_control_system = version_control_system
         end
 
-        def prepare_directories(gem_root, versions, locations, book_repo)
+        def prepare_directories(config, gem_root, 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)
+          file_system_accessor.remove_directory(locations.preprocessing_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)
+          config.versions.each do |version|
+            copy_index_file_from_version_to_master_middleman(version, locations.source_for_site_generator, config.book_repo_url)
           end
         end
 
@@ -30,18 +31,18 @@ module Bookbinder
 
         attr_reader :logger, :file_system_accessor, :version_control_system
 
-        def copy_index_file_from_version_to_master_middleman(version, dest_dir, book_repo)
+        def copy_index_file_from_version_to_master_middleman(version, dest_dir, url)
+          clone_dir_name = Ingest::DestinationDirectory.new(url)
           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)
+            version_control_system.clone(url,
+                                         clone_dir_name,
+                                         path: tmpdir,
+                                         checkout: version)
+            index_source_dir = Pathname(tmpdir).join(clone_dir_name, '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|
+            Dir.glob(index_source_dir.join('index.*')) do |f|
               file_system_accessor.copy(File.expand_path(f), index_dest_dir)
             end
           end

data/lib/bookbinder/commands/build_and_push_tarball.rb

@@ -8,24 +8,17 @@ module Bookbinder
     class BuildAndPushTarball < BookbinderCommand
       include Commands::Naming
 
-      class MissingBuildNumber < StandardError
-        def initialize
-          super 'You must set $BUILD_NUMBER to push an identifiable build.'
-        end
-      end
-
       def usage
         [command_name,
          "Create a tarball from the final_app directory and push to the S3 bucket specified in your credentials.yml"]
       end
 
       def run(_)
-        raise MissingBuildNumber unless ENV['BUILD_NUMBER']
         config = configuration_fetcher.fetch_config
         aws_credentials = configuration_fetcher.fetch_credentials[:aws]
         archive = Archive.new(logger: @logger, key: aws_credentials.access_key, secret: aws_credentials.secret_key)
         archive.create_and_upload_tarball(build_number: ENV['BUILD_NUMBER'], bucket: aws_credentials.green_builds_bucket,
-                                          namespace: Ingest::DestinationDirectory.new(config.book_repo, nil))
+                                          namespace: Ingest::DestinationDirectory.new(config.book_repo))
         0
       end
     end