bookbindery 2.0.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c8da72c5e68bd509530fa1ce2bbff37521223d5c
-  data.tar.gz: 1339eff7f48eeaea5bdfdd2e91f9cefc6c813533
+  metadata.gz: abe74d9727cc4ccb6456bb2c8e6b5474a99951b7
+  data.tar.gz: 80e90cd7e5c6f7582eb2c41683c75e0b7df2f10c
 SHA512:
-  metadata.gz: a6d61852a9dc656b5aeddfc23b87ea57147ac4b3ff3faac4d7b01afd02242891d7f2aae37fb82c869441c5a3979dbbbda50891c37e1fb13d9dbf82727fdd196f
-  data.tar.gz: dd24ebb1819201b38eb6213ffe80ec7c8e50d675d89b98c12a60ba4459681847a5d2b58833a1f5fe3e3b4fce87351434550e3d45511ef3160a4699ca3d36a0b2
+  metadata.gz: 5e16a8861042949b496d942efa08fb59441ca789f7f73bfaa244a1b5b1c9cf266b267d3333b389e4f1f88c565bb9c622fbb3879b7f7c5ce5348247f04d0d0c8b
+  data.tar.gz: 6a12e088c5ec3ca21f2f229b92235eec8644fc18cc4c86e71eb5a7beb9e60a8f97dca26e9ee72072e2082f32007b3c34bcfaa300556e252d9923bd68ff847b74

data/lib/bookbinder.rb

@@ -11,7 +11,7 @@ require 'vienna'
 require 'popen4'
 require 'puma'
 
-require_relative 'bookbinder/bookbinder_logger'
+require_relative 'bookbinder/deprecated_logger'
 require_relative 'bookbinder/git_client'
 require_relative 'bookbinder/section'
 require_relative 'bookbinder/book'
@@ -39,7 +39,7 @@ require_relative 'bookbinder/distributor'
 require_relative 'bookbinder/commands/bookbinder_command'
 require_relative 'bookbinder/commands/build_and_push_tarball'
 require_relative 'bookbinder/commands/bind'
-require_relative 'bookbinder/commands/push_local_to_staging'
+require_relative 'bookbinder/commands/push_from_local'
 require_relative 'bookbinder/commands/push_to_prod'
 require_relative 'bookbinder/commands/run_publish_ci'
 require_relative 'bookbinder/commands/update_local_doc_repos'

data/lib/bookbinder/app_fetcher.rb

@@ -17,12 +17,8 @@ module Bookbinder
         cf_routes.apps_by_host_and_domain.has_key?([host, domain])
       end
 
-      app_groups =
-          if existing_hosts.any?
-            existing_hosts.map { |domain, host| apps_for_host(cf_routes, domain, host) }
-          else
-            raise "cannot find currently deployed app."
-          end
+      return nil if existing_hosts.empty?
+      app_groups = existing_hosts.map { |domain, host| apps_for_host(cf_routes, domain, host) }
       apps_for_existing_routes = app_groups.first
       apps_for_existing_routes.first
     end

data/lib/bookbinder/archive.rb

@@ -1,7 +1,7 @@
 require 'fog/aws'
 require 'tmpdir'
-require_relative 'bookbinder_logger'
 require_relative 'artifact_namer'
+require_relative 'deprecated_logger'
 
 module Bookbinder
   class Archive

data/lib/bookbinder/book.rb

@@ -23,9 +23,10 @@ module Bookbinder
                              git_accessor: git_accessor)
       end
 
+      @target_ref = target_ref || 'master'
+
       @repository = GitHubRepository.new(logger: logger,
                                          full_name: full_name,
-                                         target_ref: target_ref,
                                          github_token: github_token,
                                          git_accessor: git_accessor)
       @git_accessor = git_accessor
@@ -44,11 +45,15 @@ module Bookbinder
     end
 
     def copy_from_remote(destination_dir)
-      @repository.copy_from_remote(destination_dir)
+      @repository.copy_from_remote(destination_dir, target_ref)
     end
 
     def tag_self_and_sections_with(tag)
       (@section_vcs_repos + [@repository]).each { |repo| repo.tag_with tag }
     end
+
+    private
+
+    attr_reader :target_ref
   end
 end

data/lib/bookbinder/cli.rb

@@ -9,10 +9,9 @@ require_relative 'user_message_presenter'
 module Bookbinder
   class Cli
     def run(args)
-      command_name = args[0]
-      command_arguments = args[1..-1]
+      command_name, *command_arguments = args
 
-      logger = BookbinderLogger.new
+      logger = DeprecatedLogger.new
       commands = Repositories::CommandRepository.new(logger)
 
       command_validator = CommandValidator.new(commands, commands.help.usage_message)
@@ -24,11 +23,11 @@ module Bookbinder
       terminal = Terminal.new
 
       user_message = command_validator.validate(command_name)
-      if user_message.escalation_type == EscalationType.error
+      if user_message.error?
         error_message = user_message_presenter.get_error(user_message)
         terminal.update(error_message)
         return 1
-      elsif user_message.escalation_type == EscalationType.warn
+      elsif user_message.warn?
         warning_message = user_message_presenter.get_warning(user_message)
         terminal.update(warning_message)
       end

data/lib/bookbinder/code_example_reader.rb

@@ -1,4 +1,4 @@
-require_relative '../../lib/bookbinder/bookbinder_logger'
+require_relative '../../lib/bookbinder/deprecated_logger'
 
 module Bookbinder
   class CodeExampleReader

data/lib/bookbinder/command_validator.rb

@@ -1,5 +1,6 @@
-require_relative 'cli_error'
 require 'ostruct'
+require_relative 'cli_error'
+require_relative 'commands/naming'
 require_relative 'user_message'
 
 module Bookbinder
@@ -9,20 +10,39 @@ module Bookbinder
       @usage_text = usage_text
     end
 
-    def validate command_name
-      command_type = "#{command_name}".match(/^--/) ? 'flag' : 'command'
-      if commands.none? { |command| command.command_for?(command_name) }
-        UserMessage.new "Unrecognized #{command_type} '#{command_name}'\n" + usage_text, EscalationType.error
-      elsif command = commands.find { |command| (command.respond_to? :deprecated_command_for?) &&
-                                                                        (command.deprecated_command_for? command_name) }
-        UserMessage.new "Use of #{command_name} is deprecated. " +
-                            "The preferred usage is below: \n#{command.usage}",
-                        EscalationType.warn
+    def validate(command_name)
+      candidate = Candidate.new(command_name, commands)
+      if candidate.unrecognized?
+        UserMessage.new(
+          "Unrecognized #{candidate.command_type} '#{command_name}'\n#{usage_text}",
+          EscalationType.error
+        )
+      elsif candidate.deprecated_match
+        UserMessage.new(
+          "Use of #{command_name} is deprecated. " +
+          "The preferred usage is below: \n#{candidate.deprecated_match.usage}",
+          EscalationType.warn
+        )
       else
         UserMessage.new "Success", EscalationType.success
       end
     end
 
+    Candidate = Struct.new(:command_name, :commands) do
+      include Bookbinder::Commands::Naming
+
+      def unrecognized?
+        commands.none? { |command| command.command_for?(command_name) }
+      end
+
+      def deprecated_match
+        @deprecated_match ||= commands.find { |command|
+          command.respond_to?(:deprecated_command_for?) &&
+            command.deprecated_command_for?(command_name)
+        }
+      end
+    end
+
     private
 
     attr_reader :commands, :usage_text

data/lib/bookbinder/commands/bind.rb

@@ -26,7 +26,8 @@ module Bookbinder
                      final_app_directory,
                      server_director,
                      context_dir,
-                     dita_preprocessor)
+                     dita_preprocessor,
+                     cloner_factory)
         @logger = logger
         @config_fetcher = config_fetcher
         @archive_menu_config = archive_menu_config
@@ -38,6 +39,7 @@ module Bookbinder
         @server_director = server_director
         @context_dir = context_dir
         @dita_preprocessor = dita_preprocessor
+        @cloner_factory = cloner_factory
       end
 
       def usage
@@ -60,23 +62,27 @@ module Bookbinder
 
         @publisher = Publisher.new(logger, sitemap_generator, static_site_generator, server_director, file_system_accessor)
 
-        location = cli_arguments[0]
+        bind_source, *options = cli_arguments
 
-        output_paths = output_directory_paths(location)
-        publish_config = publish_config(location)
-        @versions = publish_config.fetch(:versions, [])
-        @book_repo = publish_config[:book_repo]
+        output_paths = output_directory_paths(bind_source)
+
+        bind_config = bind_config(bind_source)
+        @versions = bind_config.fetch(:versions, [])
+        @book_repo = bind_config[:book_repo]
 
         master_middleman_dir = output_paths.fetch(:master_middleman_dir)
         output_dir = output_paths.fetch(:output_dir)
 
+        master_dir = File.join output_dir, 'master_middleman'
+        workspace_dir = File.join master_dir, 'source'
+
         dita_processing_dir = File.join output_dir, 'dita'
         dita_section_dir = File.join dita_processing_dir, 'dita_sections'
         dita_processed_dir = File.join dita_processing_dir, 'html_from_dita'
+        subnavs_dir = File.join workspace_dir, 'subnavs'
+        dita_subnav_template_path = File.join workspace_dir, 'subnavs', '_dita_subnav_template.erb'
         formatted_dir = File.join dita_processing_dir, 'site_generator_ready'
 
-        master_dir = File.join output_dir, 'master_middleman'
-        workspace_dir = File.join master_dir, 'source'
         prepare_directories(final_app_directory,
                             output_dir,
                             workspace_dir,
@@ -95,11 +101,11 @@ module Bookbinder
           DitaSection.new(nil, relative_path_to_dita_map, full_name, target_ref, directory)
         end
 
-        if location == 'github'
+        if bind_source == 'github'
           dita_section_gatherer = DitaSectionGatherer.new(version_control_system, logger)
-          final_dita_sections = dita_section_gatherer.gather(dita_sections, to: dita_section_dir)
+          gathered_dita_sections = dita_section_gatherer.gather(dita_sections, to: dita_section_dir)
         else
-          final_dita_sections = dita_sections.map do |dita_section|
+          gathered_dita_sections = dita_sections.map do |dita_section|
             relative_path_to_dita_map = dita_section.ditamap_location
             full_name = dita_section.full_name
             target_ref = dita_section.target_ref
@@ -111,17 +117,32 @@ module Bookbinder
           end
         end
 
-        dita_preprocessor.preprocess final_dita_sections, dita_processed_dir, formatted_dir, workspace_dir
+        gathered_dita_sections.each do |dita_section|
+          dita_preprocessor.preprocess(dita_section,
+                                       dita_processed_dir,
+                                       formatted_dir,
+                                       workspace_dir,
+                                       subnavs_dir,
+                                       dita_subnav_template_path)
+        end
 
-        sections = gather_sections(workspace_dir, output_paths)
+        cloner = cloner_factory.produce(
+          bind_source,
+          output_paths[:local_repo_dir]
+        )
+        sections = gather_sections(
+          workspace_dir,
+          cloner,
+          ('master' if options.include?('--ignore-section-refs'))
+        )
 
-        subnavs = subnavs_by_dir_name(sections)
+        subnavs = (sections + gathered_dita_sections).map(&:subnav).reduce(&:merge)
 
         success = publisher.publish(
           subnavs,
           {verbose: cli_arguments.include?('--verbose')},
           output_paths,
-          archive_menu_config.generate(publish_config, sections)
+          archive_menu_config.generate(bind_config, sections)
         )
 
         success ? 0 : 1
@@ -140,23 +161,20 @@ module Bookbinder
                   :sitemap_generator,
                   :server_director,
                   :context_dir,
-                  :dita_preprocessor
+                  :dita_preprocessor,
+                  :cloner_factory
 
-      def gather_sections(workspace, output_paths)
+      def gather_sections(workspace, cloner, ref_override)
         config.sections.map do |attributes|
-
-          local_repo_dir = output_paths[:local_repo_dir]
-          vcs_repo =
-              if local_repo_dir
-                GitHubRepository.
-                    build_from_local(logger, attributes, local_repo_dir, version_control_system).
-                    tap { |repo| repo.copy_from_local(workspace) }
-              else
-                GitHubRepository.
-                    build_from_remote(logger, attributes, nil, version_control_system).
-                    tap { |repo| repo.copy_from_remote(workspace) }
-              end
-
+          target_ref = ref_override ||
+            attributes.fetch('repository', {})['ref'] ||
+            'master'
+          repo_name = attributes.fetch('repository').fetch('name')
+          directory = attributes['directory']
+          vcs_repo = cloner.call(from: repo_name,
+                                 ref: target_ref,
+                                 parent_dir: workspace,
+                                 dir_name: directory)
           @section_repository.get_instance(attributes,
                                            vcs_repo: vcs_repo,
                                            destination_dir: workspace,
@@ -217,8 +235,8 @@ module Bookbinder
         end
       end
 
-      def output_directory_paths(location)
-        local_repo_dir = (location == 'local') ? File.expand_path('..', context_dir) : nil
+      def output_directory_paths(bind_source)
+        local_repo_dir = (bind_source == 'local') ? File.expand_path('..', context_dir) : nil
 
         {
           final_app_dir: final_app_directory,
@@ -228,7 +246,7 @@ module Bookbinder
         }
       end
 
-      def publish_config(location)
+      def bind_config(bind_source)
         arguments = {
             sections: config.sections,
             book_repo: config.book_repo,
@@ -238,7 +256,7 @@ module Bookbinder
 
         optional_arguments = {}
         optional_arguments.merge!(template_variables: config.template_variables) if config.respond_to?(:template_variables)
-        if publishing_to_github? location
+        if binding_from_github? bind_source
           config.versions.each { |version| arguments[:sections].concat sections_from version }
           optional_arguments.merge!(versions: config.versions)
         end
@@ -281,9 +299,8 @@ module Bookbinder
             destination_dir = Dir.mktmpdir
             repository = GitHubRepository.build_from_remote(logger,
                                                             section,
-                                                            'master',
                                                             version_control_system)
-            repository.copy_from_remote(destination_dir)
+            repository.copy_from_remote(destination_dir, 'master')
             if repository
               File.join(destination_dir, repository.directory)
             else
@@ -296,25 +313,13 @@ module Bookbinder
       end
 
       def arguments_are_valid?(arguments)
-        return false unless arguments.any?
-        verbose           = arguments[1] && arguments[1..-1].include?('--verbose')
-        tag_provided      = arguments[1] && (arguments[1..-1] - ['--verbose']).any?
-        nothing_special   = arguments[1..-1].empty?
-
-        %w(local github).include?(arguments[0]) && (tag_provided || verbose || nothing_special)
+        bind_source, *options = arguments
+        valid_options = %w(--verbose --ignore-section-refs).to_set
+        %w(local github).include?(bind_source) && options.to_set.subset?(valid_options)
       end
 
-      def publishing_to_github?(publish_location)
-        config.has_option?('versions') && publish_location != 'local'
-      end
-
-      def subnavs_by_dir_name(sections)
-        sections.reduce({}) do |subnavs, section|
-          namespace = section.directory.gsub('/', '_')
-          template = section.subnav_template || 'default'
-
-          subnavs.merge(namespace => template)
-        end
+      def binding_from_github?(bind_location)
+        config.has_option?('versions') && bind_location != 'local'
       end
     end
   end

data/lib/bookbinder/commands/help.rb

@@ -10,10 +10,6 @@ module Bookbinder
         @other_commands = other_commands
       end
 
-      def command_name
-        '--help'
-      end
-
       def usage
         [command_name, "Print this message"]
       end
@@ -29,6 +25,10 @@ module Bookbinder
 
       private
 
+      def command_name
+        '--help'
+      end
+
       def command_usage_messages
         (flags + standard_commands).reduce('') { |message, command|
           "#{message}#{usage_indent}#{formatted_usage(command)}\n"

data/lib/bookbinder/commands/naming.rb

@@ -3,10 +3,6 @@ require 'active_support/inflector'
 module Bookbinder
   module Commands
     module Naming
-      def command_name
-        self.class.name.demodulize.underscore
-      end
-
       def command_for?(test_command_name)
         command_name == test_command_name
       end
@@ -14,6 +10,20 @@ module Bookbinder
       def flag?
         command_name.match(/^--/)
       end
+
+      def command_type
+        if flag?
+          'flag'
+        else
+          'command'
+        end
+      end
+
+      private
+
+      def command_name
+        self.class.name.demodulize.underscore
+      end
     end
   end
 end

data/lib/bookbinder/commands/push_from_local.rb

@@ -0,0 +1,51 @@
+require_relative '../distributor'
+require_relative 'bookbinder_command'
+require_relative 'naming'
+
+module Bookbinder
+  module Commands
+    class PushFromLocal
+      include Commands::Naming
+
+      def initialize(logger, configuration_fetcher, environment)
+        @logger = logger
+        @configuration_fetcher = configuration_fetcher
+        @environment = environment
+      end
+
+      def usage
+        [command_name,
+         "Push the contents of final_app to the #{environment} host specified in credentials.yml"]
+      end
+
+      def run(_)
+        Distributor.build(@logger, options).distribute
+        0
+      end
+
+      private
+
+      attr_reader :configuration_fetcher, :environment
+
+      def config
+        @config ||= configuration_fetcher.fetch_config
+      end
+
+      def command_name
+        "push_local_to_#{environment}"
+      end
+
+      def options
+        {
+            app_dir: './final_app',
+            build_number: ENV['BUILD_NUMBER'],
+
+            aws_credentials: config.aws_credentials,
+            cf_credentials: config.cf_credentials(environment),
+
+            book_repo: config.book_repo,
+        }
+      end
+    end
+  end
+end