bookbindery 1.0.3 → 2.0.0

data/lib/bookbinder/commands/build_and_push_tarball.rb

@@ -5,7 +5,7 @@ require_relative '../archive'
 module Bookbinder
   module Commands
     class BuildAndPushTarball < BookbinderCommand
-      extend Commands::Naming
+      include Commands::Naming
 
       class MissingBuildNumber < StandardError
         def initialize
@@ -13,17 +13,18 @@ module Bookbinder
         end
       end
 
-      def self.usage
-        "build_and_push_tarball \t  \t  \t Create a tarball from the final_app directory and push to the S3 bucket specified in your credentials.yml"
+      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 = config.aws_credentials
-        repository = Archive.new(logger: @logger, key: aws_credentials.access_key, secret: aws_credentials.secret_key)
-        repository.create_and_upload_tarball(build_number: ENV['BUILD_NUMBER'], bucket: aws_credentials.green_builds_bucket,
-                                             namespace: GitHubRepository.new(logger: @logger, full_name: config.book_repo).short_name)
+        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: GitHubRepository.new(logger: @logger, full_name: config.book_repo, git_accessor: Git).short_name)
         0
       end
     end

data/lib/bookbinder/commands/chain.rb

@@ -0,0 +1,11 @@
+module Bookbinder
+  module Commands
+    module Chain
+      private
+
+      def command_chain(*commands)
+        commands.all? {|command| command[] == 0} ? 0 : 1
+      end
+    end
+  end
+end

data/lib/bookbinder/commands/generate_pdf.rb

@@ -6,7 +6,7 @@ require_relative 'naming'
 module Bookbinder
   module Commands
     class GeneratePDF < BookbinderCommand
-      extend Commands::Naming
+      include Commands::Naming
 
       class AppNotPublished < StandardError
         def initialize(msg='You must publish locally before you generate a PDF.')
@@ -32,8 +32,9 @@ module Bookbinder
         end
       end
 
-      def self.usage
-        "generate_pdf [<file_name>.yml] \t \t Generate a PDF from the files specified in <file_name.yml>"
+      def usage
+        ["generate_pdf [<file_name>.yml]",
+         "Generate a PDF from the files specified in <file_name.yml>"]
       end
 
       def run(params)

data/lib/bookbinder/commands/help.rb

@@ -1,21 +1,21 @@
+require_relative 'naming'
+
 module Bookbinder
   module Commands
     class Help
-      def initialize(logger, usage_message)
-        @logger = logger
-        @usage_message = usage_message
-      end
+      include Commands::Naming
 
-      def self.to_s
-        'help'
+      def initialize(logger, other_commands)
+        @logger = logger
+        @other_commands = other_commands
       end
 
-      def self.command_name
+      def command_name
         '--help'
       end
 
-      def self.usage
-        "--help \t \t \t \t \t Print this message"
+      def usage
+        [command_name, "Print this message"]
       end
 
       def run(*)
@@ -23,9 +23,48 @@ module Bookbinder
         0
       end
 
+      def usage_message
+        [usage_header, command_usage_messages].join("\n")
+      end
+
       private
 
-      attr_reader :logger, :usage_message
+      def command_usage_messages
+        (flags + standard_commands).reduce('') { |message, command|
+          "#{message}#{usage_indent}#{formatted_usage(command)}\n"
+        }
+      end
+
+      def formatted_usage(command)
+        "#{command.usage[0].ljust(chars_for_usage_definition)}#{command.usage[1]}"
+      end
+
+      def usage_indent
+        " " * 4
+      end
+
+      def chars_for_usage_definition
+        33
+      end
+
+      def flags
+        other_commands.select(&:flag?) + [self]
+      end
+
+      def standard_commands
+        other_commands.reject(&:flag?)
+      end
+
+      def usage_header
+        <<TEXT
+
+  \e[1;39;49mDocumentation\e[0m: https://github.com/pivotal-cf/docs-bookbinder
+
+  \e[1;39;49mUsage\e[0m: bookbinder <command|flag> [args]
+TEXT
+      end
+
+      attr_reader :logger, :other_commands
     end
   end
 end

data/lib/bookbinder/commands/naming.rb

@@ -2,7 +2,15 @@ module Bookbinder
   module Commands
     module Naming
       def command_name
-        name.demodulize.underscore
+        self.class.name.demodulize.underscore
+      end
+
+      def command_for?(test_command_name)
+        command_name == test_command_name
+      end
+
+      def flag?
+        command_name.match(/^--/)
       end
     end
   end

data/lib/bookbinder/commands/push_local_to_staging.rb

@@ -5,10 +5,11 @@ require_relative 'naming'
 module Bookbinder
   module Commands
     class PushLocalToStaging < BookbinderCommand
-      extend Commands::Naming
+      include Commands::Naming
 
-      def self.usage
-        "push_local_to_staging \t \t  \t Push the contents of final_app to the staging host specified in credentials.yml"
+      def usage
+        [command_name,
+         "Push the contents of final_app to the staging host specified in credentials.yml"]
       end
 
       def run(_)

data/lib/bookbinder/commands/push_to_prod.rb

@@ -3,21 +3,35 @@ require_relative 'bookbinder_command'
 require_relative 'naming'
 
 module Bookbinder
+  class PushToProdValidator
+    MissingRequiredKeyError = Class.new(RuntimeError)
+  end
+
   module Commands
-    class PushToProd < BookbinderCommand
-      extend Commands::Naming
+    class PushToProd
+      include Commands::Naming
+      CONFIG_REQUIRED_KEYS = %w(cred_repo)
+
+      def initialize(logger, configuration_fetcher)
+        @logger = logger
+        @configuration_fetcher = configuration_fetcher
+      end
 
-      def self.usage
-        "push_to_prod [build_#] \t \t \t Push latest or <build_#> from your S3 bucket to the production host specified in credentials.yml"
+      def usage
+        ["push_to_prod [build_#]",
+         "Push latest or <build_#> from your S3 bucket to the production host specified in credentials.yml"]
       end
 
       def run(arguments)
+        validate
         Distributor.build(@logger, options(arguments)).distribute
         0
       end
 
       private
 
+      attr_reader :configuration_fetcher
+
       def options(arguments)
         {
           app_dir: Dir.mktmpdir,
@@ -30,6 +44,24 @@ module Bookbinder
           production: true
         }
       end
+
+      def config
+        @config ||= configuration_fetcher.fetch_config
+      end
+
+      def validate
+        missing_keys = []
+        CONFIG_REQUIRED_KEYS.map do |required_key|
+          unless config.has_option?(required_key)
+            missing_keys.push(required_key)
+          end
+        end
+
+        if missing_keys.length > 0
+          raise PushToProdValidator::MissingRequiredKeyError.new "Your config.yml is missing required key(s). The require keys for this commands are " + missing_keys.join(", ")
+        end
+      end
+
     end
   end
 end

data/lib/bookbinder/commands/run_publish_ci.rb

@@ -1,42 +1,39 @@
-require_relative 'bookbinder_command'
+require_relative 'bind'
+require_relative 'build_and_push_tarball'
+require_relative 'chain'
 require_relative 'naming'
-require_relative 'publish'
 require_relative 'push_local_to_staging'
-require_relative 'build_and_push_tarball'
 
 module Bookbinder
   module Commands
-    class RunPublishCI < BookbinderCommand
-      extend Commands::Naming
+    class RunPublishCI
+      include Commands::Naming
+      include Commands::Chain
 
-      def self.usage
-        "run_publish_ci \t \t \t \t Run publish, push_local_to_staging, and build_and_push_tarball for CI purposes"
+      def usage
+        [command_name,
+         "Run publish, push_local_to_staging, and build_and_push_tarball for CI purposes"]
       end
 
-      def run(cli_args)
-        check_params
-        all_successfully_ran = publish(cli_args) == 0 && push_to_staging == 0 && push_tarball == 0
-        all_successfully_ran ? 0 : 1
+      def initialize(publish_command, push_local_to_staging_command, build_and_push_tarball_command)
+        @publish_command = publish_command
+        @push_local_to_staging_command = push_local_to_staging_command
+        @build_and_push_tarball_command = build_and_push_tarball_command
       end
 
-      private
-
-      def check_params
+      def run(cli_args)
         raise BuildAndPushTarball::MissingBuildNumber unless ENV['BUILD_NUMBER']
-        config.book_repo
-      end
 
-      def publish(cli_args)
-        Publish.new(@logger, @configuration_fetcher).run(['github'] + cli_args)
+        command_chain(
+          ->{publish_command.run(['github'] + cli_args)},
+          ->{push_local_to_staging_command.run([])},
+          ->{build_and_push_tarball_command.run([])}
+        )
       end
 
-      def push_to_staging
-        PushLocalToStaging.new(@logger, @configuration_fetcher).run []
-      end
+      private
 
-      def push_tarball
-        BuildAndPushTarball.new(@logger, @configuration_fetcher).run []
-      end
+      attr_reader :publish_command, :push_local_to_staging_command, :build_and_push_tarball_command
     end
   end
 end

data/lib/bookbinder/commands/tag.rb

@@ -8,10 +8,10 @@ require_relative 'naming'
 module Bookbinder
   module Commands
     class Tag < BookbinderCommand
-      extend Commands::Naming
+      include Commands::Naming
 
-      def self.usage
-        "tag <git tag> \t \t \t \t Apply the specified <git tag> to your book and all sections of your book"
+      def usage
+        ["tag <git tag>", "Apply the specified <git tag> to your book and all sections of your book"]
       end
 
       def run(params)

data/lib/bookbinder/commands/update_local_doc_repos.rb

@@ -4,10 +4,11 @@ require_relative 'naming'
 module Bookbinder
   module Commands
     class UpdateLocalDocRepos < BookbinderCommand
-      extend Commands::Naming
+      include Commands::Naming
 
-      def self.usage
-        "update_local_doc_repos \t \t \t Run `git pull` on all sections that exist at the same directory level as your book directory"
+      def usage
+        [command_name,
+         "Run `git pull` on all sections that exist at the same directory level as your book directory"]
       end
 
       def run(_)
@@ -20,7 +21,7 @@ module Bookbinder
       def repo_for(section_config)
         local_repo_dir = File.absolute_path('../')
         GitHubRepository.new(logger: @logger, full_name: section_config['repository']['name'],
-                             local_repo_dir: local_repo_dir)
+                             local_repo_dir: local_repo_dir, git_accessor: Git)
       end
     end
   end

data/lib/bookbinder/commands/version.rb

@@ -1,22 +1,25 @@
-require_relative 'bookbinder_command'
+require_relative 'naming'
 
 module Bookbinder
   module Commands
-    class Version < BookbinderCommand
-      def self.to_s
-        'version'
+    class Version
+      include Commands::Naming
+
+      def initialize(logger)
+        @logger = logger
       end
 
-      def self.command_name
+      def command_name
         '--version'
       end
 
-      def self.usage
-        "--version \t \t \t \t Print the version of bookbinder"
+      def usage
+        [command_name, "Print the version of bookbinder"]
       end
 
       def run(*)
-        @logger.log "bookbinder #{Gem::Specification::load(File.join GEM_ROOT, "bookbinder.gemspec").version}"
+        root = File.expand_path('../../../../', __FILE__)
+        @logger.log "bookbinder #{Gem::Specification::load(File.join root, "bookbinder.gemspec").version}"
         0
       end
 

data/lib/bookbinder/configuration.rb

@@ -1,5 +1,6 @@
 require_relative 'remote_yaml_credential_provider'
 require_relative 'git_hub_repository'
+require 'git'
 
 module Bookbinder
   class Configuration
@@ -105,8 +106,8 @@ module Bookbinder
       @config = config_hash
     end
 
-    CONFIG_REQUIRED_KEYS = %w(book_repo layout_repo cred_repo sections public_host pdf pdf_index versions)
-    CONFIG_OPTIONAL_KEYS = %w(archive_menu)
+    CONFIG_REQUIRED_KEYS = %w(book_repo public_host pdf)
+    CONFIG_OPTIONAL_KEYS = %w(archive_menu dita_sections layout_repo versions pdf_index cred_repo)
 
     CONFIG_REQUIRED_KEYS.each do |method_name|
       define_method(method_name) do
@@ -120,6 +121,10 @@ module Bookbinder
       end
     end
 
+    def sections
+      config.fetch('sections', [])
+    end
+
     def has_option?(key)
       @config.has_key?(key)
     end
@@ -157,7 +162,7 @@ module Bookbinder
     end
 
     def credentials_repository
-      @credentials_repository ||= GitHubRepository.new(logger: @logger, full_name: cred_repo)
+      @credentials_repository ||= GitHubRepository.new(logger: @logger, full_name: cred_repo, git_accessor: Git)
     end
   end
 end

data/lib/bookbinder/configuration_fetcher.rb

@@ -1,13 +1,8 @@
+require_relative 'configuration'
 require_relative 'yaml_loader'
 
 module Bookbinder
-
   class ConfigurationFetcher
-    attr_reader   :logger,
-                  :configuration_validator,
-                  :config,
-                  :config_file_path
-
     def initialize(logger, configuration_validator, loader)
       @loader = loader
       @logger = logger
@@ -22,30 +17,17 @@ module Bookbinder
       @config_file_path = config_file_path
     end
 
-
     private
 
-    attr_reader :loader
+    attr_reader(:loader, :logger, :configuration_validator, :config, :config_file_path)
 
     def read_config_file
+      loader.load(config_file_path).merge('pdf_index' => nil)
 
-      begin
-        config_hash = loader.load(config_file_path)
-      rescue FileNotFoundError => e
-        raise "The configuration file specified does not exist. Please create a config #{e} file at #{config_file_path} and try again."
-      rescue InvalidSyntaxError => e
-        raise "There is a syntax error in your config file: \n #{e}"
-      end
-
-      if config_hash
-        if File.exists?('./pdf_index.yml')
-          config_hash['pdf_index'] = loader.load(config_file_path)
-        else
-          config_hash['pdf_index'] = nil
-        end
-      end
-
-      config_hash
+    rescue FileNotFoundError => e
+      raise "The configuration file specified does not exist. Please create a config #{e} file at #{config_file_path} and try again."
+    rescue InvalidSyntaxError => e
+      raise "There is a syntax error in your config file: \n #{e}"
     end
 
     def validate(config_hash)