bookbindery 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 19c1ec695ede30996441a72bccd9617f0802d6d1
-  data.tar.gz: e711b4cfe5f5af59d1e4ec68d0c98975295eab60
+  metadata.gz: 56679c8bf251f348c3dd66d86317c0c848b35706
+  data.tar.gz: e6a280ed228236c2fa381393d5bdeb5f3710f8e1
 SHA512:
-  metadata.gz: 1ab45230d391a2aac4d84ff67015bd48d44e82fbfb55188bbf03db798efada981a635a6d7d15e71e763eff98b45e1798850f85f0e41f1ffc346785782f683abb
-  data.tar.gz: 04f5b2b527d2c90a99b47942e6b440054d47e4e6ac74712cdb4c4fd8b80d0efb67a5a263fd7ea6cc615e6262554f0cb3824f9783259eeee5fc4025809a26a78b
+  metadata.gz: b28159d61a3847f29100709af210253bc25e90ed5770273d4891ea928a24f643f7537832c36e8e3efe2780b5dfdab773b4dd3c41ab994a3ce4c8cddfcedc9cb9
+  data.tar.gz: 3463e88ed1b0044e735c0e0ffd25c572b4258cc0906985f0b74c6bfca47d1e2269895700f4ca07c694c83c2a4ee25268be1c9dd9be2e5c8284cb286564510097

data/lib/bookbinder/archive.rb

@@ -1,4 +1,4 @@
-require 'fog'
+require 'fog/aws'
 require 'tmpdir'
 require_relative 'bookbinder_logger'
 require_relative 'artifact_namer'

data/lib/bookbinder/archive_menu_configuration.rb

@@ -0,0 +1,34 @@
+module Bookbinder
+  class ArchiveMenuConfiguration
+    def initialize(loader: nil, config_filename: nil)
+      @loader = loader
+      @config_filename = config_filename
+    end
+
+    def generate(base_config, sections)
+      base_config.merge(
+        archive_menu: root_config(base_config).merge(section_config(sections))
+      )
+    end
+
+    private
+
+    attr_reader :loader, :config_filename
+
+    def root_config(base_config)
+      { '.' => base_config[:archive_menu] }
+    end
+
+    def section_config(sections)
+      sections.reduce({}) {|config, section|
+        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)
+        else
+          config
+        end
+      }
+    end
+  end
+end

data/lib/bookbinder/book.rb

@@ -4,7 +4,6 @@ require_relative 'directory_helpers'
 module Bookbinder
   class Book
     include DirectoryHelperMethods
-    attr_reader :sections
 
     def self.from_remote(logger: nil, full_name: nil, destination_dir: nil, ref: nil, git_accessor: Git)
       book = new(logger: logger, full_name: full_name, target_ref: ref, git_accessor: git_accessor)
@@ -12,12 +11,23 @@ module Bookbinder
       book
     end
 
-    def initialize(logger: nil, full_name: nil, target_ref: nil, github_token: nil, sections: [], git_accessor: Git)
-      @sections = sections.map do |section|
-        GitHubRepository.new logger: logger, full_name: section['repository']['name']
+    def initialize(logger: nil,
+                   full_name: nil,
+                   target_ref: nil,
+                   github_token: nil,
+                   sections: [],
+                   git_accessor: Git)
+      @section_vcs_repos = sections.map do |section|
+        GitHubRepository.new(logger: logger,
+                             full_name: section['repository']['name'],
+                             git_accessor: git_accessor)
       end
 
-      @repository = GitHubRepository.new(logger: logger, full_name: full_name, target_ref: target_ref, github_token: github_token)
+      @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
     end
 
@@ -33,22 +43,12 @@ module Bookbinder
       @repository.directory
     end
 
-    def get_modification_date_for(file: nil, full_path: nil)
-      git_directory, file_relative_path = full_path.split(output_dir_name+'/')
-      begin
-        git_base_object = Git.open(git_directory)
-      rescue => e
-        raise "Invalid git repository! #{git_directory} is not a .git directory"
-      end
-      @repository.get_modification_date_for(file: file_relative_path, git: git_base_object)
-    end
-
     def copy_from_remote(destination_dir)
-      @repository.copy_from_remote(destination_dir, @git_accessor)
+      @repository.copy_from_remote(destination_dir)
     end
 
     def tag_self_and_sections_with(tag)
-      (@sections + [@repository]).each { |repo| repo.tag_with tag }
+      (@section_vcs_repos + [@repository]).each { |repo| repo.tag_with tag }
     end
   end
 end

data/lib/bookbinder/cli.rb

@@ -1,53 +1,42 @@
+require_relative 'colorizer'
 require_relative 'command_runner'
-require_relative 'local_file_system_accessor'
 require_relative 'command_validator'
-
-require_relative 'commands/build_and_push_tarball'
-require_relative 'commands/generate_pdf'
-require_relative 'commands/publish'
-require_relative 'commands/version'
-require_relative 'commands/help'
+require_relative 'configuration'
+require_relative 'repositories/command_repository'
+require_relative 'terminal'
+require_relative 'user_message_presenter'
 
 module Bookbinder
   class Cli
-    FLAGS = [
-      Commands::Version,
-      Commands::Help
-    ]
-
-    COMMANDS = [
-      Commands::BuildAndPushTarball,
-      Commands::GeneratePDF,
-      Commands::Publish,
-      Commands::PushLocalToStaging,
-      Commands::PushToProd,
-      Commands::RunPublishCI,
-      Commands::Tag,
-      Commands::UpdateLocalDocRepos,
-    ].freeze
-
     def run(args)
       command_name = args[0]
       command_arguments = args[1..-1]
 
       logger = BookbinderLogger.new
-      yaml_loader = YAMLLoader.new
-      local_file_system_accessor = LocalFileSystemAccessor.new
-      configuration_validator = ConfigurationValidator.new(logger, local_file_system_accessor)
-      configuration_fetcher = ConfigurationFetcher.new(logger, configuration_validator, yaml_loader)
-      configuration_fetcher.set_config_file_path './config.yml'
-      usage_messenger = UsageMessenger.new
-      usage_message = usage_messenger.construct_for(COMMANDS, FLAGS)
-      command_validator = CommandValidator.new usage_messenger, COMMANDS + FLAGS, usage_message
-
-      command_runner = CommandRunner.new(configuration_fetcher, usage_message, logger, COMMANDS + FLAGS)
+      commands = Repositories::CommandRepository.new(logger)
+
+      command_validator = CommandValidator.new(commands, commands.help.usage_message)
+      command_runner = CommandRunner.new(logger, commands)
+      command_name = command_name ? command_name : '--help'
+
+      colorizer = Colorizer.new
+      user_message_presenter = UserMessagePresenter.new(colorizer)
+      terminal = Terminal.new
+
+      user_message = command_validator.validate(command_name)
+      if user_message.escalation_type == EscalationType.error
+        error_message = user_message_presenter.get_error(user_message)
+        terminal.update(error_message)
+        return 1
+      elsif user_message.escalation_type == EscalationType.warn
+        warning_message = user_message_presenter.get_warning(user_message)
+        terminal.update(warning_message)
+      end
 
       begin
-        command_name ? command_validator.validate!(command_name) : command_name = '--help'
-
         command_runner.run command_name, command_arguments
 
-      rescue Commands::Publish::VersionUnsupportedError => e
+      rescue Commands::Bind::VersionUnsupportedError => e
         logger.error "config.yml at version '#{e.message}' has an unsupported API."
         1
       rescue Configuration::CredentialKeyError => e

data/lib/bookbinder/code_example.rb

@@ -1,40 +1,7 @@
-require_relative 'section'
-
 module Bookbinder
-  class CodeExample < Section
-    class InvalidSnippet < StandardError
-      def initialize(repo, marker)
-        super "Error with marker #{marker.cyan} #{'in'.red} #{repo.cyan}#{'.'.red}"
-      end
-    end
-
-    def get_snippet_and_language_at(marker)
-      unless @repository.copied?
-        @repository.announce_skip
-        return ''
-      end
-
-      prepared_snippet_at(marker)
-    end
-
-    private
-
-    def prepared_snippet_at(marker)
-      snippet = ''
-      FileUtils.cd(@repository.copied_to) { snippet = scrape_for(marker) }
-
-      raise InvalidSnippet.new(full_name, marker) if snippet.empty?
-      lines = snippet.split("\n")
-      language_match = lines[0].match(/code_snippet #{Regexp.escape(marker)} start (\w+)/)
-      language = language_match[1] if language_match
-      [lines[1..-2].join("\n"), language]
-    end
-
-    def scrape_for(marker)
-      locale = 'LC_CTYPE=C LANG=C' # Quiets 'sed: RE error: illegal byte sequence'
-      result = `#{locale} find . -exec sed -ne '/code_snippet #{marker} start/,/code_snippet #{marker} end/ p' {} \\; 2> /dev/null`
-      result = "" unless result.lines.last && result.lines.last.match(/code_snippet #{marker} end/)
-      result
-    end
-  end
+  CodeExample = Struct.new(:path_to_repository,
+                           :full_name,
+                           :copied,
+                           :destination_dir,
+                           :directory_name)
 end

data/lib/bookbinder/code_example_reader.rb

@@ -0,0 +1,40 @@
+require_relative '../../lib/bookbinder/bookbinder_logger'
+
+module Bookbinder
+  class CodeExampleReader
+    class InvalidSnippet < StandardError
+      def initialize(repo, marker)
+        super "Error with marker #{marker.cyan} #{'in'.red} #{repo.cyan}#{'.'.red}"
+      end
+    end
+
+    def initialize(logger)
+      @logger = logger
+    end
+
+    def get_snippet_and_language_at(marker, path_to_repository, copied, repo_name)
+      unless copied
+        logger.log '  skipping (not found) '.magenta + repo_name
+        return ''
+      end
+
+      snippet = ''
+      FileUtils.cd(path_to_repository) { locale = 'LC_CTYPE=C LANG=C' # Quiets 'sed: RE error: illegal byte sequence'
+      result = `#{locale} find . -exec sed -ne '/code_snippet #{marker} start/,/code_snippet #{marker} end/ p' {} \\; 2> /dev/null`
+      result = "" unless result.lines.last && result.lines.last.match(/code_snippet #{marker} end/)
+      scrape_for_value = result
+      snippet = scrape_for_value }
+
+      raise InvalidSnippet.new(repo_name, marker) if snippet.empty?
+      lines = snippet.split("\n")
+      language_match = lines[0].match(/code_snippet #{Regexp.escape(marker)} start (\w+)/)
+      language = language_match[1] if language_match
+      [lines[1..-2].join("\n"), language]
+    end
+
+    private
+
+    attr_reader :logger
+
+  end
+end

data/lib/bookbinder/colorizer.rb

@@ -0,0 +1,14 @@
+require 'ansi/code'
+require 'ostruct'
+
+module Bookbinder
+
+  class Colorizer
+    Colors = OpenStruct.new(red: Proc.new { |msg| ANSI.red {msg} },
+                            yellow: Proc.new { |msg| ANSI.yellow {msg} })
+
+    def colorize(string, color)
+      color.call string.to_s
+    end
+  end
+end

data/lib/bookbinder/command_runner.rb

@@ -1,32 +1,25 @@
 require_relative 'cli_error'
+require_relative 'local_dita_to_html_converter'
+require_relative 'sheller'
 
 module Bookbinder
   class CommandRunner
-    def initialize(configuration_fetcher, usage_message, logger, commands)
-      @configuration_fetcher = configuration_fetcher
-      @usage_message = usage_message
+    def initialize(logger, commands)
       @logger = logger
       @commands = commands
     end
 
     def run(command_name, command_arguments)
-      command = commands.detect { |known_command| known_command.command_name == command_name }
-      begin
-        if command_name == '--help'
-          command.new(logger, usage_message).run command_arguments
-        else
-          command.new(logger, @configuration_fetcher).run command_arguments
-        end
-      rescue CliError::InvalidArguments
-        logger.log command.usage
-        1
-      end
+      command = commands.detect { |known_command| known_command.command_for?(command_name) }
+      command.run(command_arguments)
+    rescue CliError::InvalidArguments
+      logger.log command.usage
+      1
     end
 
     private
 
-    attr_reader :logger, :usage_message, :commands
-
+    attr_reader :logger, :commands
   end
 end
 

data/lib/bookbinder/command_validator.rb

@@ -1,24 +1,31 @@
 require_relative 'cli_error'
+require 'ostruct'
+require_relative 'user_message'
 
 module Bookbinder
   class CommandValidator
-    def initialize(usage_messenger, commands, usage_text)
-      @usage_messenger = usage_messenger
+    def initialize(commands, usage_text)
       @commands = commands
       @usage_text = usage_text
     end
 
-    def validate! command_name
-      known_command_names = commands.map(&:command_name)
+    def validate command_name
       command_type = "#{command_name}".match(/^--/) ? 'flag' : 'command'
-      if !known_command_names.include?(command_name)
-        raise CliError::UnknownCommand.new "Unrecognized #{command_type} '#{command_name}'\n" + usage_text
+      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
+      else
+        UserMessage.new "Success", EscalationType.success
       end
     end
 
     private
 
-    attr_reader :usage_messenger, :commands, :usage_text
+    attr_reader :commands, :usage_text
   end
 end