bookbindery 4.2.0 → 5.0.0

data/lib/bookbinder/commands/collection.rb

@@ -3,7 +3,7 @@ Dir.glob(File.expand_path('../../commands/*.rb', __FILE__)).each do |command_fil
 end
 
 require_relative '../commands/bind/directory_preparer'
-require_relative '../config/bind_config_factory'
+require_relative '../config/archive_menu_configuration'
 require_relative '../config/fetcher'
 require_relative '../config/remote_yaml_credential_provider'
 require_relative '../config/validator'
@@ -12,7 +12,7 @@ require_relative '../dita_command_creator'
 require_relative '../dita_html_to_middleman_formatter'
 require_relative '../html_document_manipulator'
 require_relative '../ingest/cloner_factory'
-require_relative '../ingest/section_repository_factory'
+require_relative '../ingest/section_repository'
 require_relative '../local_file_system_accessor'
 require_relative '../middleman_runner'
 require_relative '../postprocessing/sitemap_writer'
@@ -61,7 +61,7 @@ module Bookbinder
         @standard_commands ||= [
           Commands::Generate.new(
             local_file_system_accessor,
-            Sheller.new,
+            sheller,
             Dir.pwd,
             streams
           ),
@@ -77,6 +77,7 @@ module Bookbinder
             configuration_fetcher,
             version_control_system
           ),
+          watch
         ]
       end
 
@@ -88,23 +89,38 @@ module Bookbinder
         @bind ||= Commands::Bind.new(
           streams,
           OutputLocations.new(final_app_dir: final_app_directory, context_dir: File.absolute_path('.')),
-          Config::BindConfigFactory.new(version_control_system, configuration_fetcher),
+          configuration_fetcher,
           Config::ArchiveMenuConfiguration.new(loader: config_loader, config_filename: 'bookbinder.yml'),
           local_file_system_accessor,
-          MiddlemanRunner.new(logger, version_control_system),
+          runner,
           Postprocessing::SitemapWriter.build(logger, final_app_directory, sitemap_port),
           Preprocessing::Preprocessor.new(
             Preprocessing::DitaPreprocessor.new(
               DitaHtmlToMiddlemanFormatter.new(local_file_system_accessor, subnav_formatter, html_document_manipulator),
               local_file_system_accessor,
               DitaCommandCreator.new(ENV['PATH_TO_DITA_OT_LIBRARY']),
-              Sheller.new
+              sheller
             ),
             Preprocessing::LinkToSiteGenDir.new(local_file_system_accessor),
           ),
           Ingest::ClonerFactory.new(streams, local_file_system_accessor, version_control_system),
-          Ingest::SectionRepositoryFactory.new(logger),
-          Commands::BindComponents::DirectoryPreparer.new(logger, local_file_system_accessor, version_control_system)
+          Ingest::SectionRepository.new,
+          directory_preparer
+        )
+      end
+
+      def watch
+        @watch ||= Commands::Watch.new(
+          streams,
+          middleman_runner: runner,
+          output_locations: OutputLocations.new(final_app_dir: final_app_directory, context_dir: File.absolute_path('.')),
+          config_fetcher: configuration_fetcher,
+          config_decorator: Config::ArchiveMenuConfiguration.new(loader: config_loader, config_filename: 'bookbinder.yml'),
+          file_system_accessor: local_file_system_accessor,
+          preprocessor: Preprocessing::Preprocessor.new(Preprocessing::LinkToSiteGenDir.new(local_file_system_accessor)),
+          cloner: local_file_system_cloner,
+          section_repository: Ingest::SectionRepository.new,
+          directory_preparer: directory_preparer
         )
       end
 
@@ -138,6 +154,10 @@ module Bookbinder
         @config_loader ||= Config::YAMLLoader.new
       end
 
+      def directory_preparer
+        Commands::BindComponents::DirectoryPreparer.new(local_file_system_accessor)
+      end
+
       def final_app_directory
         @final_app_directory ||= File.absolute_path('final_app')
       end
@@ -154,9 +174,21 @@ module Bookbinder
         @local_file_system_accessor ||= LocalFileSystemAccessor.new
       end
 
+      def sheller
+        @sheller ||= Sheller.new
+      end
+
       def sitemap_port
         41722
       end
+
+      def runner
+        MiddlemanRunner.new(local_file_system_accessor, sheller)
+      end
+
+      def local_file_system_cloner
+        Ingest::LocalFilesystemCloner.new(streams, local_file_system_accessor, File.expand_path('..'))
+      end
     end
   end
 end

data/lib/bookbinder/commands/watch.rb

@@ -0,0 +1,90 @@
+require_relative 'bind/bind_options'
+require_relative 'naming'
+
+module Bookbinder
+  module Commands
+    class Watch
+      include Commands::Naming
+
+      def initialize(streams,
+                     middleman_runner: nil,
+                     output_locations: nil,
+                     config_fetcher: nil,
+                     config_decorator: nil,
+                     file_system_accessor: nil,
+                     preprocessor: nil,
+                     cloner: nil,
+                     section_repository: nil,
+                     directory_preparer: nil)
+        @streams = streams
+        @middleman_runner = middleman_runner
+        @output_locations = output_locations
+        @config_fetcher = config_fetcher
+        @config_decorator = config_decorator
+        @file_system_accessor = file_system_accessor
+        @preprocessor = preprocessor
+        @cloner = cloner
+        @section_repository = section_repository
+        @directory_preparer = directory_preparer
+      end
+
+      def usage
+        ["watch",
+         "Bind and serve a local book, watching for changes"]
+      end
+
+      def run(_)
+        watch_config = config_fetcher.fetch_config
+
+        directory_preparer.prepare_directories(
+          watch_config,
+          File.expand_path('../../../../', __FILE__),
+          output_locations,
+          cloner
+        )
+        sections = section_repository.fetch(
+          configured_sections: watch_config.sections,
+          destination_dir: output_locations.cloned_preprocessing_dir,
+          cloner: cloner,
+          streams: streams
+        )
+        preprocessor.preprocess(
+          sections,
+          output_locations,
+          output_streams: streams
+        )
+        if file_system_accessor.file_exist?('redirects.rb')
+          file_system_accessor.copy('redirects.rb', output_locations.final_app_dir)
+        end
+
+        middleman_runner.run("server --force-polling --latency=5.0",
+          output_locations: output_locations,
+          config: config_decorator.generate(watch_config, sections),
+          local_repo_dir: File.expand_path('..'),
+          streams: streams,
+          subnavs: subnavs(sections)
+        ).exitstatus
+      end
+
+      private
+
+      attr_reader(
+        :streams,
+        :middleman_runner,
+        :output_locations,
+        :config_fetcher,
+        :config_decorator,
+        :file_system_accessor,
+        :preprocessor,
+        :cloner,
+        :section_repository,
+        :directory_preparer
+      )
+
+      def subnavs(sections)
+        sections.map(&:subnav).reduce({}, :merge)
+      end
+
+    end
+  end
+end

data/lib/bookbinder/config/configuration.rb

@@ -73,10 +73,6 @@ module Bookbinder
         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

data/lib/bookbinder/ingest/git_accessor.rb

@@ -8,12 +8,8 @@ module Bookbinder
       TagExists = Class.new(RuntimeError)
       InvalidTagRef = Class.new(RuntimeError)
 
-      def initialize
-        @cache = {}
-      end
-
       def clone(url, name, path: nil, checkout: 'master')
-        cached_clone(url, name, path).tap do |git|
+        cached_clone(url, name, Pathname(path)).tap do |git|
           git.checkout(checkout)
         end
       end
@@ -35,7 +31,7 @@ module Bookbinder
       def read_file(filename, from_repo: nil, checkout: 'master')
         Dir.mktmpdir do |dir|
           path = Pathname(dir)
-          git = _clone(from_repo, temp_name("read-file"), path)
+          git = cached_clone(from_repo, temp_name("read-file"), path)
           git.checkout(checkout)
           path.join(temp_name("read-file"), filename).read
         end
@@ -44,7 +40,7 @@ module Bookbinder
       def remote_tag(url, tagname, commit_or_object)
         Dir.mktmpdir do |dir|
           path = Pathname(dir)
-          git = _clone(url, temp_name("tag"), path)
+          git = cached_clone(url, temp_name("tag"), path)
           git.config('user.name', 'Bookbinder')
           git.config('user.email', 'bookbinder@cloudfoundry.org')
           begin
@@ -66,18 +62,17 @@ module Bookbinder
 
       private
 
-      attr_reader :cache
-
       def temp_name(purpose)
         "bookbinder-git-accessor-#{purpose}"
       end
 
       def cached_clone(url, name, path)
-        cache[[url, name, path]] ||= _clone(url, name, path)
-      end
-
-      def _clone(url, name, path)
-        Git.clone(url, name, path: path)
+        dest_dir = path.join(name)
+        if dest_dir.exist?
+          Git.open(dest_dir)
+        else
+          Git.clone(url, name, path: path)
+        end
       end
     end
   end

data/lib/bookbinder/ingest/local_filesystem_cloner.rb

@@ -15,7 +15,7 @@ module Bookbinder
                source_ref: nil,
                destination_parent_dir: nil,
                destination_dir_name: nil)
-        copy!(
+        link!(
           source_repo_name,
           Pathname(user_repo_dir).join(source_repo_name.split('/').last),
           Pathname(destination_parent_dir).join(DestinationDirectory.new(source_repo_name, destination_dir_name))
@@ -26,29 +26,29 @@ module Bookbinder
 
       attr_reader :streams, :filesystem, :user_repo_dir
 
-      def copy!(source_repo_name, source_dir, dest_dir)
+      def link!(source_repo_name, source_dir, dest_dir)
         source_exists = filesystem.file_exist?(source_dir)
 
         if source_exists && filesystem.file_exist?(dest_dir)
-          announce_copy(source_dir)
+          announce(source_dir)
           WorkingCopy.new(
             copied_to: dest_dir,
             full_name: source_repo_name,
           )
         elsif source_exists
-          announce_copy(source_dir)
-          filesystem.copy_contents(source_dir, dest_dir)
+          announce(source_dir)
+          filesystem.link_creating_intermediate_dirs(source_dir, dest_dir)
           WorkingCopy.new(
             copied_to: dest_dir,
             full_name: source_repo_name,
           )
         else
           streams[:out].puts "  skipping (not found) #{source_dir}"
-          MissingWorkingCopy.new(source_repo_name)
+          MissingWorkingCopy.new(source_repo_name, source_dir)
         end
       end
 
-      def announce_copy(source_dir)
+      def announce(source_dir)
         streams[:out].puts "  copying #{source_dir}"
       end
     end

data/lib/bookbinder/ingest/missing_working_copy.rb

@@ -1,8 +1,9 @@
 module Bookbinder
   module Ingest
     class MissingWorkingCopy
-      def initialize(source_repo_name)
+      def initialize(source_repo_name, source_dir)
         @source_repo_name = source_repo_name
+        @source_dir= source_dir
       end
 
       def full_name
@@ -10,7 +11,7 @@ module Bookbinder
       end
 
       def path
-        Pathname("/this/doesnt/actually/exist/#{SecureRandom.uuid}")
+        Pathname(@source_dir)
       end
 
       def available?

data/lib/bookbinder/ingest/repo_identifier.rb

@@ -10,7 +10,7 @@ module Bookbinder
       def to_str
         if input_identifier.nil?
           ""
-        elsif input_identifier.include?(':')
+        elsif input_identifier.include?(':') || input_identifier.match(/^\//)
           input_identifier
         else
           "#{DEFAULT_VCS_PREFIX}#{input_identifier}"

data/lib/bookbinder/ingest/section_repository.rb

@@ -5,16 +5,13 @@ require_relative '../values/section'
 module Bookbinder
   module Ingest
     class SectionRepository
-      def initialize(logger, cloner)
-        @logger = logger
-        @cloner = cloner
-      end
-
       def fetch(configured_sections: [],
                 destination_dir: nil,
-                ref_override: nil)
+                ref_override: nil,
+                cloner: nil,
+                streams: nil)
         configured_sections.map do |section_config|
-          logger.log "Gathering #{section_config.repo_name.cyan}"
+          streams[:success].puts("Gathering #{section_config.repo_name}")
           working_copy = cloner.call(source_repo_name: section_config.repo_name,
                                      source_ref: ref_override || section_config.repo_ref,
                                      destination_parent_dir: destination_dir,
@@ -29,10 +26,6 @@ module Bookbinder
           )
         end
       end
-
-      private
-
-      attr_reader :logger, :cloner
     end
   end
 end

data/lib/bookbinder/ingest/working_copy.rb

@@ -3,6 +3,8 @@ require_relative '../errors/programmer_mistake'
 module Bookbinder
   module Ingest
     class WorkingCopy
+      attr_reader :full_name
+
       def initialize(copied_to: nil,
                      full_name: nil)
         if [copied_to, full_name].none?
@@ -13,8 +15,6 @@ module Bookbinder
         end
       end
 
-      attr_reader :full_name
-
       def available?
         !! @copied_to
       end
@@ -22,6 +22,12 @@ module Bookbinder
       def path
         Pathname(@copied_to)
       end
+
+      def ==(other)
+        [@copied_to, @full_name] ==
+          [other.instance_variable_get(:@copied_to),
+           other.instance_variable_get(:@full_name)]
+      end
     end
   end
 end

data/lib/bookbinder/local_file_system_accessor.rb

@@ -72,6 +72,13 @@ module Bookbinder
       relative_path.to_s
     end
 
+    def find_files_recursively(from)
+      `find -L #{from}`.
+        lines.
+        map(&:chomp).
+        map(&Pathname.method(:new)).
+        reject {|p| p.to_s.match %r{/\.}}.
+        reject(&:directory?)
+    end
   end
-
 end

data/lib/bookbinder/middleman_runner.rb

@@ -1,94 +1,41 @@
-require 'git/lib'
 require 'middleman-core'
 require 'middleman-core/cli'
 require 'middleman-core/profiling'
-require_relative 'code_example_reader'
-
-class Middleman::Cli::BuildAction
-  def handle_error(file_name, response, e=Thor::Error.new(response))
-    our_errors = [Bookbinder::CodeExampleReader::InvalidSnippet,
-                  QuicklinksRenderer::BadHeadingLevelError,
-                  Git::GitExecuteError]
-    raise e if our_errors.include?(e.class)
-
-    original_handle_error(e, file_name, response)
-  end
-
-  private
-
-  def original_handle_error(e, file_name, response)
-    base.had_errors = true
-
-    base.say_status :error, file_name, :red
-    if base.debugging
-      raise e
-      exit(1)
-    elsif base.options["verbose"]
-      base.shell.say response, :red
-    end
-  end
-end
+require 'yaml'
 
 module Bookbinder
   class MiddlemanRunner
-    def initialize(logger, git_accessor)
-      @logger = logger
-      @git_accessor = git_accessor
+    def initialize(fs, sheller)
+      @fs = fs
+      @sheller = sheller
     end
 
-    def run(output_locations,
-            config,
-            cloner,
-            verbose = false,
-            subnav_templates_by_directory = {})
-      @logger.log "\nRunning middleman...\n\n"
-
-      within(output_locations.master_dir) do
-        invoke_against_current_dir(output_locations.workspace_dir,
-                                   config.public_host,
-                                   subnav_templates_by_directory,
-                                   config.template_variables,
-                                   config.archive_menu,
-                                   verbose,
-                                   cloner)
+    def run(command,
+            streams: nil,
+            output_locations: nil,
+            config: nil,
+            local_repo_dir: nil,
+            subnavs: nil)
+      streams[:out].puts "\nRunning middleman...\n\n"
+      Dir.chdir(output_locations.master_dir) do
+        config = {
+          archive_menu: config.archive_menu,
+          production_host: config.public_host,
+          subnav_templates: subnavs,
+          template_variables: config.template_variables,
+          local_repo_dir: local_repo_dir,
+          workspace: output_locations.workspace_dir,
+        }
+        fs.write(to: "bookbinder_config.yml", text: YAML.dump(config))
+        sheller.run_command({'MM_ROOT' => output_locations.master_dir.to_s},
+                            "middleman #{command}",
+                            streams)
       end
     end
 
     private
 
-    attr_reader :git_accessor
-
-    def within(temp_root, &block)
-      Middleman::Cli::Build.instance_variable_set(:@_shared_instance, nil)
-      original_mm_root  = ENV['MM_ROOT']
-      ENV['MM_ROOT']    = temp_root.to_s
-
-      Dir.chdir(temp_root) { block.call }
-
-      ENV['MM_ROOT']    = original_mm_root
-    end
-
-    def invoke_against_current_dir(workspace_dir,
-                                   production_host,
-                                   subnav_templates,
-                                   template_variables,
-                                   archive_menu,
-                                   verbose,
-                                   cloner)
-      builder = Middleman::Cli::Build.shared_instance(verbose)
+    attr_reader :streams, :fs, :sheller
 
-      config = {
-        archive_menu: archive_menu,
-        cloner: cloner,
-        production_host: production_host,
-        relative_links: false,
-        subnav_templates: subnav_templates,
-        template_variables: template_variables,
-        workspace: workspace_dir,
-      }
-
-      config.each { |k, v| builder.config[k] = v }
-      Middleman::Cli::Build.new([], {quiet: !verbose}, {}).invoke :build, [], {verbose: verbose}
-    end
   end
 end