bookbindery 2.0.1 → 2.1.0

data/lib/bookbinder/commands/push_to_prod.rb

@@ -38,10 +38,9 @@ module Bookbinder
           build_number: arguments[0],
 
           aws_credentials: config.aws_credentials,
-          cf_credentials: config.cf_production_credentials,
+          cf_credentials: config.cf_credentials('production'),
 
           book_repo: config.book_repo,
-          production: true
         }
       end
 

data/lib/bookbinder/commands/run_publish_ci.rb

@@ -2,7 +2,7 @@ require_relative 'bind'
 require_relative 'build_and_push_tarball'
 require_relative 'chain'
 require_relative 'naming'
-require_relative 'push_local_to_staging'
+require_relative 'push_from_local'
 
 module Bookbinder
   module Commands

data/lib/bookbinder/commands/tag.rb

@@ -1,6 +1,6 @@
 require_relative '../book'
-require_relative '../bookbinder_logger'
 require_relative '../cli_error'
+require_relative '../deprecated_logger'
 
 require_relative 'bookbinder_command'
 require_relative 'naming'

data/lib/bookbinder/commands/version.rb

@@ -9,10 +9,6 @@ module Bookbinder
         @logger = logger
       end
 
-      def command_name
-        '--version'
-      end
-
       def usage
         [command_name, "Print the version of bookbinder"]
       end
@@ -23,6 +19,11 @@ module Bookbinder
         0
       end
 
+      private
+
+      def command_name
+        '--version'
+      end
     end
   end
 end

data/lib/bookbinder/configuration.rb

@@ -1,6 +1,6 @@
-require_relative 'remote_yaml_credential_provider'
-require_relative 'git_hub_repository'
 require 'git'
+require_relative 'git_hub_repository'
+require_relative 'remote_yaml_credential_provider'
 
 module Bookbinder
   class Configuration
@@ -8,14 +8,11 @@ module Bookbinder
     CURRENT_SCHEMA_VERSION = '1.0.0'
     STARTING_SCHEMA_VERSION = '1.0.0'
 
-    class CredentialKeyError < StandardError;
-    end
-
-    class ConfigSchemaUnsupportedError < StandardError;
-    end
+    CredentialKeyError = Class.new(StandardError)
+    ConfigSchemaUnsupportedError = Class.new(StandardError)
 
     class AwsCredentials
-      REQUIRED_KEYS = %w(access_key secret_key green_builds_bucket).freeze
+      REQUIRED_KEYS = %w(access_key secret_key green_builds_bucket)
 
       def initialize(cred_hash)
         @creds = cred_hash
@@ -37,12 +34,11 @@ module Bookbinder
     end
 
     class CfCredentials
-      REQUIRED_KEYS = %w(api_endpoint organization app_name).freeze
-      OPTIONAL_KEYS = %w(username password production_space production_host staging_space staging_host).freeze
+      REQUIRED_KEYS = %w(api_endpoint organization app_name)
 
-      def initialize(cred_hash, is_production)
+      def initialize(cred_hash, environment)
         @creds = cred_hash
-        @is_production = is_production
+        @environment = environment
       end
 
       REQUIRED_KEYS.each do |method_name|
@@ -51,15 +47,33 @@ module Bookbinder
         end
       end
 
-      OPTIONAL_KEYS.each do |method_name|
-        define_method(method_name) do
-          creds.fetch(method_name, nil)
+      def ==(other)
+        [@creds, @environment] == [
+          other.instance_variable_get(:@creds),
+          other.instance_variable_get(:@environment)
+        ]
+      end
+
+      def username
+        creds['username']
+      end
+
+      def password
+        creds['password']
+      end
+
+      def download_archive_before_push?
+        production?
+      end
+
+      def push_warning
+        if production?
+          'Warning: You are pushing to CF Docs production. Be careful.'
         end
       end
 
       def routes
-        key = is_production ? 'production_host' : 'staging_host'
-        fetch(key) if correctly_formatted_domain_and_routes?(key)
+        fetch(host_key) if correctly_formatted_domain_and_routes?(host_key)
       end
 
       def flat_routes
@@ -70,13 +84,16 @@ module Bookbinder
       end
 
       def space
-        key = is_production ? 'production_space' : 'staging_space'
-        fetch(key)
+        fetch(space_key)
       end
 
       private
 
-      attr_reader :creds, :is_production
+      attr_reader :creds, :environment
+
+      def production?
+        environment == 'production'
+      end
 
       def fetch(key)
         creds.fetch(key)
@@ -97,6 +114,14 @@ module Bookbinder
         raise "Hosts in credentials must be nested as an array under the desired domain #{domain}." unless routes_hash[domain].is_a? Array
         raise "Did you mean to provide a hostname for the domain #{domain}? Check your credentials.yml." if routes_hash[domain].any?(&:nil?)
       end
+
+      def host_key
+        "#{environment}_host"
+      end
+
+      def space_key
+        "#{environment}_space"
+      end
     end
 
     attr_reader :schema_version, :schema_major_version, :schema_minor_version, :schema_patch_version
@@ -106,8 +131,8 @@ module Bookbinder
       @config = config_hash
     end
 
-    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 = %w(book_repo public_host)
+    CONFIG_OPTIONAL_KEYS = %w(archive_menu dita_sections layout_repo versions pdf_index cred_repo pdf)
 
     CONFIG_REQUIRED_KEYS.each do |method_name|
       define_method(method_name) do
@@ -137,12 +162,8 @@ module Bookbinder
       @aws_creds ||= AwsCredentials.new(credentials.fetch('aws'))
     end
 
-    def cf_staging_credentials
-      @cf_staging_creds ||= CfCredentials.new(credentials.fetch('cloud_foundry'), false)
-    end
-
-    def cf_production_credentials
-      @cf_prod_creds ||= CfCredentials.new(credentials.fetch('cloud_foundry'), true)
+    def cf_credentials(environment)
+      CfCredentials.new(credentials.fetch('cloud_foundry'), environment)
     end
 
     def ==(o)

data/lib/bookbinder/configuration_fetcher.rb

@@ -14,7 +14,7 @@ module Bookbinder
     end
 
     def set_config_file_path config_file_path
-      @config_file_path = config_file_path
+      @config_file_path = File.expand_path config_file_path
     end
 
     private

data/lib/bookbinder/configuration_validator.rb

@@ -1,6 +1,40 @@
 require 'active_support/core_ext/object/blank'
 
 module Bookbinder
+  class ConfigurationValidator
+    DuplicateSectionNameError = Class.new(RuntimeError)
+    MissingArchiveMenuPartialError = Class.new(RuntimeError)
+    EmptyArchiveItemsError = Class.new(RuntimeError)
+    ArchiveMenuNotDefinedError = Class.new(RuntimeError)
+    MissingRequiredKeyError = Class.new(RuntimeError)
+
+    def initialize(logger, file_system_accessor)
+      @logger = logger
+      @file_system_accessor = file_system_accessor
+    end
+
+    def valid?(config_hash, bookbinder_schema_version, starting_schema_version)
+      raise 'Your config.yml appears to be empty. Please check and try again.' unless config_hash
+
+      user_config_schema_version = config_hash['schema_version']
+      exceptions = [
+        RequiredKeysChecker.new,
+        ConfigVersionChecker.new(Version.parse(bookbinder_schema_version),
+                                 Version.parse(starting_schema_version),
+                                 VersionCheckerMessages.new(Version.parse(user_config_schema_version),
+                                                         bookbinder_schema_version),
+                                 @logger),
+        DuplicateSectionNameChecker.new,
+        ArchiveMenuChecker.new(@file_system_accessor)
+      ].map do |checker|
+        checker.check(config_hash)
+      end
+      exception = exceptions.compact.first
+      raise exception if exception
+
+      true
+    end
+  end
 
   class DuplicateSectionNameChecker
     def check(config)
@@ -12,8 +46,12 @@ module Bookbinder
     private
 
     def duplicate_section_names?(config)
-      directory_names = config['sections'].map {|section| section['directory']}
-      directory_names.length != directory_names.uniq.length
+      if config['sections']
+        directory_names = config['sections'].map {|section| section['directory']}
+        directory_names.length != directory_names.uniq.length
+      else
+        false
+      end
     end
 
   end
@@ -147,39 +185,4 @@ module Bookbinder
       end
     end
   end
-
-  class ConfigurationValidator
-    DuplicateSectionNameError = Class.new(RuntimeError)
-    MissingArchiveMenuPartialError = Class.new(RuntimeError)
-    EmptyArchiveItemsError = Class.new(RuntimeError)
-    ArchiveMenuNotDefinedError = Class.new(RuntimeError)
-    MissingRequiredKeyError = Class.new(RuntimeError)
-
-    def initialize(logger, file_system_accessor)
-      @logger = logger
-      @file_system_accessor = file_system_accessor
-    end
-
-    def valid?(config_hash, bookbinder_schema_version, starting_schema_version)
-      raise 'Your config.yml appears to be empty. Please check and try again.' unless config_hash
-
-      user_config_schema_version = config_hash['schema_version']
-      exceptions = [
-        RequiredKeysChecker.new,
-        ConfigVersionChecker.new(Version.parse(bookbinder_schema_version),
-                                 Version.parse(starting_schema_version),
-                                 VersionCheckerMessages.new(Version.parse(user_config_schema_version),
-                                                         bookbinder_schema_version),
-                                 @logger),
-        DuplicateSectionNameChecker.new,
-        ArchiveMenuChecker.new(@file_system_accessor)
-      ].map do |checker|
-        checker.check(config_hash)
-      end
-      exception = exceptions.compact.first
-      raise exception if exception
-
-      true
-    end
-  end
 end

data/lib/bookbinder/{bookbinder_logger.rb → deprecated_logger.rb}

@@ -5,7 +5,7 @@ class String
 end
 
 module Bookbinder
-  class BookbinderLogger
+  class DeprecatedLogger
     def log(message)
       puts message
     end

data/lib/bookbinder/distributor.rb

@@ -1,4 +1,5 @@
 require_relative 'app_fetcher'
+require_relative 'artifact_namer'
 
 module Bookbinder
   class Distributor
@@ -27,14 +28,18 @@ module Bookbinder
 
     def distribute
       begin
-        download if options[:production]
+        download if cf_credentials.download_archive_before_push?
         push_app
         nil
       rescue => e
-        cf_credentials = options[:cf_credentials]
-        cf_space = options[:production] ? cf_credentials.production_space : cf_credentials.staging_space
-        cf_routes = options[:production] ? cf_credentials.production_host : cf_credentials.staging_host
-        @logger.error "[ERROR] #{e.message}\n[DEBUG INFO]\nCF organization: #{cf_credentials.organization}\nCF space: #{cf_space}\nCF account: #{cf_credentials.username}\nroutes: #{cf_routes}"
+        @logger.error(<<-ERROR.chomp)
+[ERROR] #{e.message}
+[DEBUG INFO]
+CF organization: #{cf_credentials.organization}
+CF space: #{cf_credentials.space}
+CF account: #{cf_credentials.username}
+routes: #{cf_credentials.routes}
+        ERROR
       ensure
         upload_trace
       end
@@ -45,12 +50,14 @@ module Bookbinder
     attr_reader :options, :archive, :namer, :namespace, :pusher
 
     def download
-      archive.download(download_dir: options[:app_dir], bucket: options[:aws_credentials].green_builds_bucket, build_number: options[:build_number],
+      archive.download(download_dir: options[:app_dir],
+                       bucket: options[:aws_credentials].green_builds_bucket,
+                       build_number: options[:build_number],
                        namespace: namespace)
     end
 
     def push_app
-      warn if options[:production]
+      @logger.warn(cf_credentials.push_warning) if cf_credentials.push_warning
       pusher.push(options[:app_dir])
     end
 
@@ -62,8 +69,8 @@ module Bookbinder
       @logger.error "Could not find CF trace file: #{namer.full_path}"
     end
 
-    def warn
-      @logger.warn 'Warning: You are pushing to CF Docs production. Be careful.'
+    def cf_credentials
+      options[:cf_credentials]
     end
   end
 end

data/lib/bookbinder/dita_html_to_middleman_formatter.rb

@@ -1,19 +1,24 @@
+require_relative 'subnav'
+
 module Bookbinder
 
   class DitaHtmlToMiddlemanFormatter
-    def initialize(file_system_accessor)
+    def initialize(file_system_accessor, subnav_formatter, html_document_manipulator)
       @file_system_accessor = file_system_accessor
+      @subnav_formatter = subnav_formatter
+      @html_document_manipulator = html_document_manipulator
     end
 
-    def format(src, dest)
+    def format_html(src, dest)
       all_files_with_ext = file_system_accessor.find_files_with_ext('.html', src)
 
       all_files_with_ext.map do |filepath|
-        file_title_text = file_system_accessor.read_html_in_tag(path: filepath,
-                                                                marker: 'title')
+        file_text = file_system_accessor.read filepath
+        file_title_text = html_document_manipulator.read_html_in_tag(document: file_text,
+                                                                     tag: 'title')
 
-        file_body_text = file_system_accessor.read_html_in_tag(path: filepath,
-                                                               marker: 'body')
+        file_body_text = html_document_manipulator.read_html_in_tag(document: file_text,
+                                                                    tag: 'body')
 
         relative_path_to_file = file_system_accessor.relative_path_from(src, filepath)
         new_filepath = File.join dest, "#{relative_path_to_file}.erb"
@@ -24,14 +29,27 @@ module Bookbinder
       end
     end
 
+    def format_subnav(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)
+
+      nav_text = html_document_manipulator.set_attribute(document: subnav_template_text,
+                                                         selector: 'div.nav-content',
+                                                         attribute: 'data-props-location',
+                                                         value: json_props_location)
+      Subnav.new(formatted_json_links, nav_text)
+    end
+
     private
 
-    attr_reader :file_system_accessor
+    attr_reader :file_system_accessor, :subnav_formatter, :html_document_manipulator
 
     def frontmatter(title)
       sanitized_title = title.gsub('"', '\"')
       "---\ntitle: \"#{sanitized_title}\"\ndita: true\n---\n"
     end
-
   end
+
 end

data/lib/bookbinder/dita_section.rb

@@ -3,5 +3,11 @@ module Bookbinder
                            :ditamap_location,
                            :full_name,
                            :target_ref,
-                           :directory)
-end
+                           :directory) do
+                             def subnav
+                               namespace = directory.gsub('/', '_')
+                               template = "#{directory}_subnav"
+                               {namespace => template}
+                             end
+                           end
+end

data/lib/bookbinder/git_hub_repository.rb

@@ -1,7 +1,7 @@
-require 'bookbinder/shell_out'
 require 'git'
-require_relative 'bookbinder_logger'
+require_relative 'deprecated_logger'
 require_relative 'git_client'
+require_relative 'shell_out'
 
 module Bookbinder
   class GitHubRepository
@@ -13,14 +13,11 @@ module Bookbinder
 
     def self.build_from_remote(logger,
                                section_hash,
-                               target_ref,
                                git_accessor)
       full_name = section_hash.fetch('repository', {}).fetch('name')
-      target_ref = target_ref || section_hash.fetch('repository', {})['ref']
       directory = section_hash['directory']
       new(logger: logger,
           full_name: full_name,
-          target_ref: target_ref,
           github_token: ENV['GITHUB_API_TOKEN'],
           directory: directory,
           git_accessor: git_accessor)
@@ -42,7 +39,6 @@ module Bookbinder
 
     def initialize(logger: nil,
                    full_name: nil,
-                   target_ref: nil,
                    github_token: nil,
                    directory: nil,
                    local_repo_dir: nil,
@@ -50,7 +46,6 @@ module Bookbinder
       @logger = logger
       raise 'No full_name provided ' unless full_name
       @full_name = full_name
-      @target_ref = target_ref
       @directory = directory
       @local_repo_dir = local_repo_dir
 
@@ -75,7 +70,7 @@ module Bookbinder
       @directory || short_name
     end
 
-    def copy_from_remote(destination_dir)
+    def copy_from_remote(destination_dir, target_ref)
       begin
         @git_base_object = git_accessor.clone("git@github.com:#{full_name}",
                                               directory,
@@ -131,22 +126,14 @@ module Bookbinder
       @logger.log '  skipping (not found) '.magenta + path_to_local_repo
     end
 
-    def path_to_local_repo
-      if @local_repo_dir
-        File.join(@local_repo_dir, short_name)
-      end
-    end
-
-    def has_git_object?
-      !!@git_base_object
-    end
-
     private
 
     attr_reader :git_accessor
 
-    def target_ref
-      @target_ref ||= 'master'
+    def path_to_local_repo
+      if @local_repo_dir
+        File.join(@local_repo_dir, short_name)
+      end
     end
 
     def tags