bookbindery 2.1.5 → 3.0.1

data/lib/bookbinder/server_director.rb

@@ -1,4 +1,6 @@
-require 'popen4'
+require 'puma'
+require 'rack/rewrite'
+require 'vienna'
 
 module Bookbinder
   class ServerDirector
@@ -10,16 +12,14 @@ module Bookbinder
 
     def use_server
       Dir.chdir(@directory) do
-        result = nil
-        POpen4::popen4("puma -p #{@port}") do |stdout, stderr, stdin, pid|
-          begin
-            wait_for_server(stdout)
-            consume_stream_in_separate_thread(stdout)
-            consume_stream_in_separate_thread(stderr)
-            result = yield @port
-          ensure
-            stop_server(pid)
-          end
+        events = Puma::Events.new $stdout, $stderr
+        server = Puma::Server.new app, events
+        server.add_tcp_listener "localhost", @port
+        server.run
+        begin
+          result = yield @port
+        ensure
+          server.stop(true)
         end
         result
       end
@@ -27,28 +27,11 @@ module Bookbinder
 
     private
 
-    def wait_for_server(io)
-      Kernel.sleep(1)
-      begin
-        line = io.gets
-        raise 'Puma could not start' if line.nil?
-
-        @logger.log "Vienna says, #{line}"
-      end until line.include?('Listening on')
-
-      @logger.log 'Vienna is lovely this time of year.'
-    end
-
-    def stop_server(pid)
-      Process.kill 'KILL', pid
-    end
-
-    # avoids deadlocks by ensuring rack doesn't hang waiting to write to stderr
-    def consume_stream_in_separate_thread(stream)
-      Thread.new do
-        s = nil
-        while stream.read(1024, s)
-        end
+    def app
+      if File.exists?('redirects.rb')
+        Rack::Rewrite.new(Vienna) { eval(File.read('redirects.rb')) }
+      else
+        Vienna
       end
     end
   end

data/lib/bookbinder/sheller.rb

@@ -1,17 +1,43 @@
+require 'open3'
+
 module Bookbinder
   class Sheller
     ShelloutFailure = Class.new(RuntimeError)
 
-    def initialize(view_updater)
-      @view_updater = view_updater
+    class DevNull
+      def puts(_)
+      end
     end
 
-    def run_command(command)
-      IO.popen(command) do |stdout|
-        stdout.each { |line| view_updater.log line }
-      end
+    def run_command(*command)
+      out, err =
+        if Hash === command.last
+          command.last.values_at(:out, :err)
+        else
+          [DevNull.new, DevNull.new]
+        end
 
-      raise ShelloutFailure.new "Shelling out failed." unless $?.success?
+      env_vars, executable =
+        if Hash === command.first
+          command[0..1]
+        else
+          [{}, command[0]]
+        end
+
+      exit_status = nil
+      Open3.popen3(env_vars, executable) do |stdin, stdout, stderr, wait_thr|
+        t = Thread.new do
+          stdout.each do |line|
+            out.puts(line)
+          end
+        end
+        stderr.each do |line|
+          err.puts(line)
+        end
+        t.join
+        exit_status = wait_thr.value
+      end
+      exit_status
     end
 
     attr_reader :view_updater

data/lib/bookbinder/spider.rb

@@ -79,6 +79,9 @@ module Bookbinder
         Anemone.crawl(url) do |anemone|
           dont_visit_fragments(anemone)
           anemone.on_every_page do |page|
+            if $sitemap_debug
+              puts "\n\n********** Visiting page: #{page.url}\n\n#{page.body}"
+            end
             broken, working = sieve.links_from Stabilimentum.new(page), is_first_pass
             broken_links.concat broken
             sitemap.concat working

data/lib/bookbinder/streams/switchable_stdout_and_red_stderr.rb

@@ -0,0 +1,38 @@
+require_relative '../colorizer'
+
+module Bookbinder
+  module Streams
+    class SwitchableStdoutAndRedStderr
+      def initialize(options)
+        @options = options
+      end
+
+      def to_h
+        {
+          out: options.include?('--verbose') ? $stdout : Sheller::DevNull.new,
+          err: ColorizedStream.new(Colorizer::Colors.red, $stderr)
+        }
+      end
+
+      private
+
+      attr_reader :options
+    end
+
+    class ColorizedStream
+      def initialize(color, stream)
+        @color = color
+        @stream = stream
+        @colorizer = Colorizer.new
+      end
+
+      def puts(line)
+        stream << colorizer.colorize(line, color)
+      end
+
+      private
+
+      attr_reader :color, :colorizer, :stream
+    end
+  end
+end

data/lib/bookbinder/terminal.rb

@@ -3,8 +3,18 @@ require_relative 'colorizer'
 
 module Bookbinder
   class Terminal
+    def initialize(colorizer)
+      @colorizer = colorizer
+    end
+
     def update(user_message)
-      puts user_message
+      if user_message.error?
+        error_message = @colorizer.colorize(user_message.message, Colorizer::Colors.red)
+        $stderr.puts error_message
+      elsif user_message.warn?
+        warning_message = @colorizer.colorize(user_message.message, Colorizer::Colors.yellow)
+        puts warning_message
+      end
     end
   end
 end

data/lib/bookbinder/validation_checkers/archive_menu_checker.rb

@@ -0,0 +1,31 @@
+module Bookbinder
+  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

data/lib/bookbinder/validation_checkers/config_version_checker.rb

@@ -0,0 +1,91 @@
+require 'active_support/core_ext/object/blank'
+require_relative '../configuration'
+
+module Bookbinder
+  class ConfigVersionChecker
+    def initialize(bookbinder_schema_version, starting_schema_version, messages, view_updater)
+      @bookbinder_schema_version = bookbinder_schema_version
+      @starting_schema_version = starting_schema_version
+      @messages = messages
+      @view_updater = view_updater
+    end
+
+    def check(config)
+      user_schema_version = Version.parse(config['schema_version'])
+      if user_schema_version.valid?
+        if user_schema_version.major > bookbinder_schema_version.major
+          raise Configuration::ConfigSchemaUnsupportedError.new messages.unrecognized_schema_version_message
+        elsif user_schema_version.minor > bookbinder_schema_version.minor
+          raise Configuration::ConfigSchemaUnsupportedError.new messages.unrecognized_schema_version_message
+        elsif user_schema_version.patch > bookbinder_schema_version.patch
+          raise Configuration::ConfigSchemaUnsupportedError.new messages.unrecognized_schema_version_message
+        elsif user_schema_version.major < bookbinder_schema_version.major
+          raise Configuration::ConfigSchemaUnsupportedError.new messages.incompatible_schema_message
+        elsif user_schema_version.minor < bookbinder_schema_version.minor
+          view_updater.warn nonbreaking_schema_message_for("minor")
+        elsif user_schema_version.patch < bookbinder_schema_version.patch
+          view_updater.warn nonbreaking_schema_message_for("patch")
+        end
+      elsif bookbinder_schema_version != starting_schema_version
+        raise Configuration::ConfigSchemaUnsupportedError.new messages.schema_now_required_message
+      end
+    end
+
+    private
+
+    attr_reader :bookbinder_schema_version, :starting_schema_version, :messages, :view_updater
+
+    def nonbreaking_schema_message_for(version_level)
+      "[WARNING] Your schema is valid, but there exists a new #{version_level} version. Consider updating your config.yml."
+    end
+  end
+
+  Version = Struct.new(:major, :minor, :patch) do
+    class << self
+      def parse(raw_version)
+        if raw_version
+          new(*raw_version.split('.'))
+        else
+          new(nil, nil, nil)
+        end
+      end
+    end
+
+    def valid?
+      [major, minor, patch].all?(&:present?)
+    end
+
+    def to_s
+      [major, minor, patch].compact.join('.')
+    end
+  end
+
+  class VersionCheckerMessages
+    def initialize(user_schema_version, bookbinder_schema_version)
+      @user_schema_version = user_schema_version
+      @bookbinder_schema_version = bookbinder_schema_version
+    end
+
+    def schema_now_required_message
+      "[ERROR] Bookbinder now requires a certain schema. Please see README " +
+          "and provide a schema version."
+    end
+
+    def incompatible_schema_message
+      "[ERROR] Your config.yml format, schema version #{user_schema_version}, " +
+          "is older than this version of Bookbinder can support. Please update " +
+          "your config.yml keys and format to version #{bookbinder_schema_version} " +
+          "and try again."
+    end
+
+    def unrecognized_schema_version_message
+      "[ERROR] The config schema version #{user_schema_version} is " +
+          "unrecognized by this version of Bookbinder. The latest schema version " +
+          "is #{bookbinder_schema_version}."
+    end
+
+    private
+
+    attr_reader :user_schema_version, :bookbinder_schema_version
+  end
+end

data/lib/bookbinder/validation_checkers/dita_section_checker.rb

@@ -0,0 +1,20 @@
+module Bookbinder
+  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 || sum > 1)
+        DitamapLocationError.new "You must have exactly one 'ditamap_location' key in dita_sections."
+      end
+    end
+  end
+end

data/lib/bookbinder/validation_checkers/duplicate_section_name_checker.rb

@@ -0,0 +1,25 @@
+module Bookbinder
+  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

data/lib/bookbinder/validation_checkers/repository_name_presence_checker.rb

@@ -0,0 +1,33 @@
+module Bookbinder
+  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

data/lib/bookbinder/validation_checkers/required_keys_checker.rb

@@ -0,0 +1,43 @@
+require_relative '../configuration'
+
+module Bookbinder
+  class RequiredKeysChecker
+    MissingRequiredKeyError = Class.new(RuntimeError)
+    SectionAbsenceError = Class.new(RuntimeError)
+
+    def check(config)
+      missing_keys = []
+
+      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

data/lib/bookbinder/values/dita_section.rb

@@ -4,7 +4,7 @@ module Bookbinder
                            :ditaval_location,
                            :full_name,
                            :target_ref,
-                           :directory,
+                           :directory_name,
                            :output_locations) do
                              def subnav
                                namespace = directory.gsub('/', '_')
@@ -31,5 +31,9 @@ module Bookbinder
                              def absolute_path_to_ditaval
                                ditaval_location ? File.join(path_to_local_repo, ditaval_location) : nil
                              end
+
+                             def directory
+                               directory_name || full_name.split('/').last
+                             end
                            end
 end