bookbindery 3.1.0 → 3.1.2

data/lib/bookbinder/config/archive_menu_configuration.rb

@@ -0,0 +1,38 @@
+require_relative 'configuration'
+
+module Bookbinder
+  module Config
+    class ArchiveMenuConfiguration
+      def initialize(loader: nil, config_filename: nil)
+        @loader = loader
+        @config_filename = config_filename
+      end
+
+      def generate(base_config, sections)
+        base_config.merge(
+          Configuration.new(
+            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.desired_directory_name => archive_config)
+          else
+            config
+          end
+        }
+      end
+    end
+  end
+end

data/lib/bookbinder/config/checkers/archive_menu_checker.rb

@@ -0,0 +1,35 @@
+module Bookbinder
+  module Config
+    module Checkers
+      class ArchiveMenuChecker
+        MissingArchiveMenuPartialError = Class.new(RuntimeError)
+        ArchiveMenuNotDefinedError = Class.new(RuntimeError)
+        EmptyArchiveItemsError = Class.new(RuntimeError)
+
+        def initialize(file_system_accessor)
+          @file_system_accessor = file_system_accessor
+        end
+
+        def check(config)
+          partial_location = './master_middleman/source/archive_menus/_default.erb'
+          if config.has_key?("archive_menu") && config["archive_menu"].nil?
+            ArchiveMenuNotDefinedError.new 'Did you mean to provide an archive menu value to display? If you use the archive_menu key, you must provide at least one value.'
+          elsif archive_items(config).include?(nil)
+            EmptyArchiveItemsError.new 'Did you forget to add a value to the archive_menu?'
+          elsif config.has_key?("archive_menu") && !file_system_accessor.file_exist?(partial_location)
+            MissingArchiveMenuPartialError.new "You must provide a template partial named at #{partial_location}"
+          end
+        end
+
+        private
+
+        attr_reader :file_system_accessor
+
+        def archive_items(config)
+          config.fetch('archive_menu', [])
+        end
+
+      end
+    end
+  end
+end

data/lib/bookbinder/config/checkers/dita_section_checker.rb

@@ -0,0 +1,24 @@
+module Bookbinder
+  module Config
+    module Checkers
+      class DitaSectionChecker
+        DitamapLocationError = Class.new(RuntimeError)
+
+        def check(config)
+          dita_sections = config['dita_sections'].to_a
+
+          sum = 0
+          dita_sections.each do |section|
+            if section['ditamap_location']
+              sum += 1
+            end
+          end
+
+          if !dita_sections.empty? && (sum < 1)
+            DitamapLocationError.new "You must have at least one 'ditamap_location' key in dita_sections."
+          end
+        end
+      end
+    end
+  end
+end

data/lib/bookbinder/config/checkers/duplicate_section_name_checker.rb

@@ -0,0 +1,29 @@
+module Bookbinder
+  module Config
+    module Checkers
+      class DuplicateSectionNameChecker
+        DuplicateSectionNameError = Class.new(RuntimeError)
+
+        def check(config)
+          if duplicate_section_names?(config)
+            DuplicateSectionNameError.new error_message
+          end
+        end
+
+        private
+
+        def duplicate_section_names?(config)
+          sections = config['sections'].to_a + config['dita_sections'].to_a
+          directory_names = sections.map {|section| section['directory']}
+          directory_names.length != directory_names.uniq.length
+        end
+
+        def error_message
+          <<-ERROR
+    Duplicate repository names are not allowed.
+          ERROR
+        end
+      end
+    end
+  end
+end

data/lib/bookbinder/config/checkers/repository_name_presence_checker.rb

@@ -0,0 +1,37 @@
+module Bookbinder
+  module Config
+    module Checkers
+      class RepositoryNamePresenceChecker
+        MissingRepositoryNameError = Class.new(RuntimeError)
+
+        def check(config)
+          all_sections = config['sections'].to_a + config['dita_sections'].to_a
+          failures = all_sections.map do |section|
+            if !section['repository'] || !section['repository']['name']
+              true
+            end
+          end
+
+          if failures.compact.empty?
+            nil
+          else
+            MissingRepositoryNameError.new error_message
+          end
+        end
+
+        private
+
+        def error_message
+          <<-ERROR
+    Cannot locate a specific section.
+    All sections must provide the section 'name' key under the 'repository' key:
+
+    sections:
+      - repository:
+          name: 'your-org/your-repo'
+          ERROR
+        end
+      end
+    end
+  end
+end

data/lib/bookbinder/config/checkers/required_keys_checker.rb

@@ -0,0 +1,47 @@
+require_relative '../configuration'
+
+module Bookbinder
+  module Config
+    module Checkers
+      class RequiredKeysChecker
+        MissingRequiredKeyError = Class.new(RuntimeError)
+        SectionAbsenceError = Class.new(RuntimeError)
+
+        def check(config)
+          missing_keys = []
+
+          Config::Configuration::CONFIG_REQUIRED_KEYS.map do |required_key|
+            config_keys = config.keys
+            unless config_keys.include?(required_key)
+              missing_keys.push(required_key)
+            end
+          end
+
+          if missing_keys.length > 0
+            MissingRequiredKeyError.new("Your config.yml is missing required key(s). Required keys are #{missing_keys.join(", ")}.")
+          elsif !config['sections'] && !config['dita_sections']
+            SectionAbsenceError.new error_message
+          end
+        end
+
+        private
+
+        def error_message
+          <<-ERROR
+    Cannot locate your sections.
+    Must specify at least one of 'sections' and/or 'dita_sections' in config.yml:
+
+    sections:
+      - repository:
+          name: 'your-org/your-repo'
+
+    dita_sections:
+      - repository:
+          name: 'dita-org/dita-repo'
+        ditamap_location: 'example.ditamap'
+          ERROR
+        end
+      end
+    end
+  end
+end

data/lib/bookbinder/config/configuration.rb

@@ -0,0 +1,99 @@
+require_relative '../ingest/repo_identifier'
+require_relative 'section_config'
+
+module Bookbinder
+  module Config
+    class Configuration
+      class << self
+        def parse(input_config)
+          new(symbolize_keys(input_config).
+              merge(expand_repo_identifiers(input_config)).
+              merge(sections: combined_sections(input_config)))
+        end
+
+        private
+
+        def symbolize_keys(h)
+          h.reduce({}) {|acc, (k, v)| acc.merge(k.to_sym => v) }
+        end
+
+        def expand_repo_identifiers(input_config)
+          input_config.select {|k, _| k.match(/_repo$/)}.
+            reduce({}) {|h, (k, v)| h.merge(:"#{k}_url" => Ingest::RepoIdentifier.new(v))}
+        end
+
+        def combined_sections(input_config)
+          (regular_sections(input_config) + dita_sections(input_config)).
+            map { |section| Config::SectionConfig.new(section) }
+        end
+
+        def regular_sections(input_config)
+          input_config['sections'] || []
+        end
+
+        def dita_sections(input_config)
+          (input_config['dita_sections'] || []).map { |dita_section|
+            dita_section.merge(
+              'preprocessor_config' => {
+                'ditamap_location' => dita_section['ditamap_location'],
+                'ditaval_location' => dita_section['ditaval_location']
+              },
+              'subnav_template' => 'dita_subnav'
+            ).reject { |k, _|
+              %w(ditamap_location ditaval_location).include?(k)
+            }
+          }
+        end
+      end
+
+      def initialize(config)
+        @config = config
+      end
+
+      CONFIG_REQUIRED_KEYS = %w(book_repo public_host)
+      CONFIG_OPTIONAL_KEYS = %w(archive_menu book_repo_url cred_repo cred_repo_url layout_repo layout_repo_url sections)
+
+      CONFIG_REQUIRED_KEYS.each do |method_name|
+        define_method(method_name) do
+          config.fetch(method_name.to_sym)
+        end
+      end
+
+      CONFIG_OPTIONAL_KEYS.each do |method_name|
+        define_method(method_name) do
+          config[method_name.to_sym]
+        end
+      end
+
+      def template_variables
+        config.fetch(:template_variables, {})
+      end
+
+      def versions
+        config.fetch(:versions, [])
+      end
+
+      def merge(other_configuration)
+        Configuration.new(config.merge(other_configuration.instance_variable_get(:@config)))
+      end
+
+      def merge_sections(incoming_sections)
+        merge(Configuration.new(sections: sections + incoming_sections))
+      end
+
+      def has_option?(key)
+        !!config[key.to_sym]
+      end
+
+      def ==(o)
+        o.class == self.class && o.instance_variable_get(:@config) == @config
+      end
+
+      alias_method :eql?, :==
+
+      private
+
+      attr_reader :config
+    end
+  end
+end

data/lib/bookbinder/config/fetcher.rb

@@ -0,0 +1,61 @@
+require_relative 'aws_credentials'
+require_relative 'cf_credentials'
+require_relative 'configuration'
+require_relative 'yaml_loader'
+
+module Bookbinder
+  module Config
+    class Fetcher
+      def initialize(logger, configuration_validator, loader, credentials_provider)
+        @loader = loader
+        @logger = logger
+        @configuration_validator = configuration_validator
+        @credentials_provider = credentials_provider
+      end
+
+      def fetch_config
+        @config ||= validate(read_config_file)
+      end
+
+      def fetch_credentials(environment = 'null-environment')
+        @credentials ||= credentials_provider.credentials(fetch_config.cred_repo_url)
+        {
+          aws: Config::AwsCredentials.new(
+            @credentials.fetch('aws', {})
+          ),
+          cloud_foundry: Config::CfCredentials.new(
+            @credentials.fetch('cloud_foundry', {}),
+            environment
+          )
+        }
+      end
+
+      def set_config_file_path config_file_path
+        @config_file_path = File.expand_path config_file_path
+      end
+
+      private
+
+      attr_reader(:loader, :logger, :configuration_validator, :config, :config_file_path,
+                  :credentials_provider)
+
+      def read_config_file
+        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
+
+      def validate(config_hash)
+        raise 'Your config.yml appears to be empty. Please check and try again.' unless config_hash
+
+        errors = configuration_validator.exceptions(config_hash)
+        raise errors.first if errors.any?
+
+        Configuration.parse(config_hash)
+      end
+    end
+  end
+end

data/lib/bookbinder/config/remote_yaml_credential_provider.rb

@@ -0,0 +1,22 @@
+require 'yaml'
+require 'ansi/code'
+
+module Bookbinder
+  module Config
+    class RemoteYamlCredentialProvider
+      def initialize(logger, version_control_system)
+        @logger = logger
+        @version_control_system = version_control_system
+      end
+
+      def credentials(repo_url)
+        logger.log "Processing #{ANSI.cyan{repo_url}}"
+        YAML.load(version_control_system.read_file("credentials.yml", from_repo: repo_url))
+      end
+
+      private
+
+      attr_reader :logger, :version_control_system
+    end
+  end
+end

data/lib/bookbinder/config/validator.rb

@@ -0,0 +1,30 @@
+require_relative 'checkers/duplicate_section_name_checker'
+require_relative 'checkers/archive_menu_checker'
+require_relative 'checkers/required_keys_checker'
+require_relative 'checkers/repository_name_presence_checker'
+require_relative 'checkers/dita_section_checker'
+
+module Bookbinder
+  module Config
+    class Validator
+      def initialize(logger, file_system_accessor)
+        @logger = logger
+        @file_system_accessor = file_system_accessor
+      end
+
+      def exceptions(config_hash)
+        exceptions = [
+          Checkers::RequiredKeysChecker.new,
+          Checkers::DuplicateSectionNameChecker.new,
+          Checkers::RepositoryNamePresenceChecker.new,
+          Checkers::DitaSectionChecker.new,
+          Checkers::ArchiveMenuChecker.new(@file_system_accessor)
+        ].map do |checker|
+          checker.check(config_hash)
+        end
+
+        exceptions.compact
+      end
+    end
+  end
+end

data/lib/bookbinder/config/yaml_loader.rb

@@ -0,0 +1,34 @@
+require 'yaml'
+
+module Bookbinder
+  module Config
+    FileNotFoundError = Class.new(RuntimeError)
+    InvalidSyntaxError = Class.new(RuntimeError)
+
+    class YAMLLoader
+      def load(path)
+        if File.exist?(path)
+          config(path)
+        else
+          raise FileNotFoundError.new, "YAML"
+        end
+      rescue Psych::SyntaxError => e
+        raise InvalidSyntaxError.new e
+      end
+
+      def load_key(path, key)
+        if File.exist?(path)
+          config(path)[key]
+        end
+      rescue Psych::SyntaxError => e
+        raise InvalidSyntaxError.new e
+      end
+
+      private
+
+      def config(path)
+        YAML.load_file(path) || {}
+      end
+    end
+  end
+end