bookbindery 3.1.0 → 3.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 76b73998f089e3dd934d8eb163cddfd19f66be5e
-  data.tar.gz: 98e8dc00c79fad5bd569f4532adde577588afe7a
+  metadata.gz: db0253fb2ff70df7454081ccad6222b3cd61ac6e
+  data.tar.gz: 12281076319eae008bad526b376bba7348007722
 SHA512:
-  metadata.gz: 932df3bf015a4f130ecbfde27454d173fbdfb58ea187527f60871de14d7066ff797e0c91c01573cf4da8473149a466618021c2cda517a18e3f9275a80d8faae1
-  data.tar.gz: 8e481e936fbf7f12f16d4f735d58f6b28f4db037fe42a9393bfa2315f9725f3eaaaa3a965ecaada1e1023c61c84d1ba8820710ef7460f557f9a662df6d25f072
+  metadata.gz: 137791f967ff0fc2df6728d215ce6cd072f9a617e2461a05cc4e55c17affb2fbe932b147b40cd901cf89f891f8b7aa41b2de4ab005f60efa4d3d7de69b0eeb4a
+  data.tar.gz: 53af686a48cfc52f35b87a825aea6870f1cbe5da92e4e9a7e7b31624e5156e09193b83722fce212c48005a6986c190227371c919db394da92e99fe8d617649d8

data/install_bin/bookbinder

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-require 'bookbinder'
+require_relative '../lib/bookbinder/cli'
 require_relative '../lib/bookbinder/git_accessor'
 
 return_code = Bookbinder::Cli.new(Bookbinder::GitAccessor.new).run ARGV

data/lib/bookbinder/cf_command_runner.rb

@@ -45,7 +45,7 @@ module Bookbinder
       # Currently --no-routes is used to blow away all existing routes from a newly deployed app.
       # The routes will then be recreated from the creds repo.
       status = sheller.run_command(environment_variables,
-                                   "#{cf_binary_path} push #{deploy_target_app} --no-route -m 256M -i 3",
+                                   "#{cf_binary_path} push #{deploy_target_app} -s cflinuxfs2 --no-route -m 256M -i 3",
                                    out: $stdout,
                                    err: $stderr)
       raise "Could not deploy app to #{deploy_target_app}" unless status.success?

data/lib/bookbinder/cli.rb

@@ -1,9 +1,9 @@
-require_relative 'repositories/command_repository'
-require_relative 'command_validator'
+require_relative 'colorizer'
 require_relative 'command_runner'
+require_relative 'command_validator'
+require_relative 'commands/collection'
 require_relative 'config/cf_credentials'
-require_relative 'configuration'
-require_relative 'colorizer'
+require_relative 'config/configuration'
 require_relative 'terminal'
 
 module Bookbinder
@@ -16,7 +16,7 @@ module Bookbinder
       command_name, *command_arguments = args
 
       logger = DeprecatedLogger.new
-      commands = Repositories::CommandRepository.new(logger, version_control_system)
+      commands = Commands::Collection.new(logger, version_control_system)
 
       command_validator = CommandValidator.new(commands, commands.help.usage_message)
       command_runner = CommandRunner.new(logger, commands)

data/lib/bookbinder/code_example_reader.rb

@@ -12,29 +12,67 @@ module Bookbinder
       @logger = logger
     end
 
-    def get_snippet_and_language_at(marker, path_to_repository, copied, repo_name)
-      unless copied
-        logger.log '  skipping (not found) '.magenta + repo_name
-        return ''
-      end
-
-      snippet = ''
-      FileUtils.cd(path_to_repository) { locale = 'LC_CTYPE=C LANG=C' # Quiets 'sed: RE error: illegal byte sequence'
-      result = `#{locale} find . -exec sed -ne '/code_snippet #{marker} start/,/code_snippet #{marker} end/ p' {} \\; 2> /dev/null`
-      result = "" unless result.lines.last && result.lines.last.match(/code_snippet #{marker} end/)
-      scrape_for_value = result
-      snippet = scrape_for_value }
-
-      raise InvalidSnippet.new(repo_name, marker) if snippet.empty?
-      lines = snippet.split("\n")
-      language_match = lines[0].match(/code_snippet #{Regexp.escape(marker)} start (\w+)/)
-      language = language_match[1] if language_match
-      [lines[1..-2].join("\n"), language]
+    def get_snippet_and_language_at(marker, working_copy)
+      snippet = Snippet.new(marker, working_copy)
+      if snippet.available? && !snippet.valid?
+        raise InvalidSnippet.new(working_copy.full_name, marker)
+      elsif snippet.available?
+        [snippet.content, snippet.language]
+      else
+        logger.log '  skipping (not found) '.magenta + working_copy.full_name
+        ''
+      end
+    end
+
+    class Snippet
+      def initialize(marker, working_copy)
+        @marker = marker
+        @working_copy = working_copy
+      end
+
+      def available?
+        working_copy.available?
+      end
+
+      def valid?
+        ! get_snippet(marker, working_copy).empty?
+      end
+
+      def language
+        lines = get_snippet(marker, working_copy).split("\n")
+        language_match = lines[0].match(/code_snippet #{Regexp.escape(marker)} start (\w+)/)
+        Array(language_match)[1]
+      end
+
+      def content
+        lines = get_snippet(marker, working_copy).split("\n")
+        lines[1..-2].join("\n")
+      end
+
+      private
+
+      attr_reader :marker, :working_copy
+
+      def get_snippet(marker, working_copy)
+        @snippet ||=
+          begin
+            snippet = ''
+            FileUtils.cd(working_copy.path) {
+              locale = 'LC_CTYPE=C LANG=C' # Quiets 'sed: RE error: illegal byte sequence'
+              result = `#{locale} find . -exec sed -ne '/code_snippet #{marker} start/,/code_snippet #{marker} end/ p' {} \\; 2> /dev/null`
+              snippet = if result.lines.last && result.lines.last.match(/code_snippet #{marker} end/)
+                          result
+                        else
+                          ""
+                        end
+            }
+            snippet
+          end
+      end
     end
 
     private
 
     attr_reader :logger
-
   end
 end

data/lib/bookbinder/colorizer.rb

@@ -3,8 +3,11 @@ require 'ostruct'
 
 module Bookbinder
   class Colorizer
-    Colors = OpenStruct.new(red: Proc.new { |msg| ANSI.red {msg} },
-                            yellow: Proc.new { |msg| ANSI.yellow {msg} })
+    Colors = OpenStruct.new(
+      green: ->(msg) { ANSI.green {msg} },
+      red: ->(msg) { ANSI.red {msg} },
+      yellow: ->(msg) { ANSI.yellow {msg} },
+    )
 
     def colorize(string, color)
       color.call string.to_s

data/lib/bookbinder/commands/bind.rb

@@ -1,9 +1,7 @@
 require 'middleman-syntax'
 
-require_relative '../archive_menu_configuration'
+require_relative '../config/archive_menu_configuration'
 require_relative '../errors/cli_error'
-require_relative '../values/output_locations'
-require_relative '../values/section'
 require_relative 'bind/bind_options'
 require_relative 'naming'
 
@@ -12,28 +10,24 @@ module Bookbinder
     class Bind
       include Commands::Naming
 
-      def initialize(logger,
+      def initialize(base_streams,
+                     output_locations,
                      config_factory,
                      archive_menu_config,
-                     version_control_system,
                      file_system_accessor,
                      static_site_generator,
                      sitemap_writer,
-                     final_app_directory,
-                     context_dir,
                      preprocessor,
                      cloner_factory,
                      section_repository_factory,
                      directory_preparer)
-        @logger = logger
+        @base_streams = base_streams
+        @output_locations = output_locations
         @config_factory = config_factory
         @archive_menu_config = archive_menu_config
-        @version_control_system = version_control_system
         @file_system_accessor = file_system_accessor
         @static_site_generator = static_site_generator
         @sitemap_writer = sitemap_writer
-        @final_app_directory = final_app_directory
-        @context_dir = context_dir
         @preprocessor = preprocessor
         @cloner_factory = cloner_factory
         @section_repository_factory = section_repository_factory
@@ -54,25 +48,21 @@ module Bookbinder
       end
 
       def run(cli_arguments)
-        bind_options = BindComponents::BindOptions.new(cli_arguments)
+        bind_options = BindComponents::BindOptions.new(cli_arguments, base_streams)
         bind_options.validate!
 
         bind_source, *options = cli_arguments
         bind_config = config_factory.produce(bind_source)
 
-        output_locations = OutputLocations.new(
-          context_dir: context_dir,
-          final_app_dir: final_app_directory,
-          layout_repo_dir: layout_repo_path(bind_config, generate_local_repo_dir(context_dir, bind_source)),
-          local_repo_dir: generate_local_repo_dir(context_dir, bind_source)
-        )
-        cloner = cloner_factory.produce(output_locations.local_repo_dir)
+        local_repo_dir = generate_local_repo_dir(context_dir, bind_source)
+        cloner = cloner_factory.produce(local_repo_dir)
         section_repository = section_repository_factory.produce(cloner)
 
         directory_preparer.prepare_directories(
           bind_config,
           File.expand_path('../../../../', __FILE__),
-          output_locations
+          output_locations,
+          layout_repo_path(bind_config, cloner)
         )
 
         sections = section_repository.fetch(
@@ -87,8 +77,9 @@ module Bookbinder
                                 output_streams: bind_options.streams)
 
         success = publish(
-          sections.map(&:subnav).reduce(&:merge),
+          sections.map(&:subnav).reduce({}, :merge),
           {verbose: options.include?('--verbose')},
+          bind_options.streams,
           output_locations,
           archive_menu_config.generate(bind_config, sections),
           cloner
@@ -99,21 +90,23 @@ module Bookbinder
 
       private
 
-      attr_reader :version_control_system,
-                  :config_factory,
-                  :archive_menu_config,
-                  :logger,
-                  :file_system_accessor,
-                  :static_site_generator,
-                  :final_app_directory,
-                  :sitemap_writer,
-                  :context_dir,
-                  :preprocessor,
-                  :cloner_factory,
-                  :section_repository_factory,
-                  :directory_preparer
-
-      def publish(subnavs, cli_options, output_locations, publish_config, cloner)
+      attr_reader(
+        :archive_menu_config,
+        :base_streams,
+        :cloner_factory,
+        :config_factory,
+        :context_dir,
+        :directory_preparer,
+        :file_system_accessor,
+        :final_app_directory,
+        :output_locations,
+        :preprocessor,
+        :section_repository_factory,
+        :sitemap_writer,
+        :static_site_generator,
+      )
+
+      def publish(subnavs, cli_options, streams, output_locations, publish_config, cloner)
         FileUtils.cp 'redirects.rb', output_locations.final_app_dir if File.exists?('redirects.rb')
 
         host_for_sitemap = publish_config.public_host
@@ -128,7 +121,7 @@ module Bookbinder
 
         result = generate_sitemap(host_for_sitemap)
 
-        logger.log "Bookbinder bound your book into #{output_locations.final_app_dir.to_s.green}"
+        streams[:success].puts "Bookbinder bound your book into #{output_locations.final_app_dir}"
 
         !result.has_broken_links?
       end
@@ -142,11 +135,8 @@ module Bookbinder
         File.expand_path('..', context_dir) if bind_source == 'local'
       end
 
-      def layout_repo_path(config, local_repo_dir)
-        if local_repo_dir && config.has_option?('layout_repo')
-          File.join(local_repo_dir, config.layout_repo.split('/').last)
-        elsif config.has_option?('layout_repo')
-          cloner = cloner_factory.produce(nil)
+      def layout_repo_path(config, cloner)
+        if config.has_option?('layout_repo')
           working_copy = cloner.call(source_repo_name: config.layout_repo,
                                      destination_parent_dir: Dir.mktmpdir)
           working_copy.path

data/lib/bookbinder/commands/bind/bind_options.rb

@@ -5,8 +5,9 @@ module Bookbinder
   module Commands
     module BindComponents
       class BindOptions
-        def initialize(opts)
+        def initialize(opts, base_streams)
           @opts = opts
+          @base_streams = base_streams
         end
 
         def validate!
@@ -19,14 +20,15 @@ module Bookbinder
 
         def streams
           {
-            out: opts.include?('--verbose') ? $stdout : Sheller::DevNull.new,
-            err: Streams::ColorizedStream.new(Colorizer::Colors.red, $stderr)
+            out: opts.include?('--verbose') ? base_streams[:out] : Sheller::DevNull.new,
+            success: Streams::ColorizedStream.new(Colorizer::Colors.green, base_streams[:out]),
+            err: Streams::ColorizedStream.new(Colorizer::Colors.red, base_streams[:err]),
           }
         end
 
         private
 
-        attr_accessor :opts
+        attr_accessor :base_streams, :opts
 
         def arguments_are_valid?
           valid_options = %w(--verbose --ignore-section-refs --dita-flags).to_set

data/lib/bookbinder/commands/bind/directory_preparer.rb

@@ -13,17 +13,16 @@ module Bookbinder
           @version_control_system = version_control_system
         end
 
-        def prepare_directories(config, gem_root, locations)
-          forget_sections(locations.output_dir)
-          file_system_accessor.remove_directory(File.join(locations.final_app_dir, '.'))
-          file_system_accessor.remove_directory(locations.preprocessing_home_dir)
+        def prepare_directories(config, gem_root, output_locations, layout_repo_dir)
+          file_system_accessor.remove_directory(output_locations.output_dir)
+          file_system_accessor.remove_directory(output_locations.final_app_dir)
 
-          copy_directory_from_gem(gem_root, 'template_app', locations.final_app_dir)
-          copy_directory_from_gem(gem_root, 'master_middleman', locations.site_generator_home)
-          file_system_accessor.copy(File.join(locations.layout_repo_dir, '.'), locations.site_generator_home)
+          copy_directory_from_gem(gem_root, 'template_app', output_locations.final_app_dir)
+          copy_directory_from_gem(gem_root, 'master_middleman', output_locations.site_generator_home)
+          file_system_accessor.copy_contents(layout_repo_dir, output_locations.site_generator_home)
 
           config.versions.each do |version|
-            copy_index_file_from_version_to_master_middleman(version, locations.source_for_site_generator, config.book_repo_url)
+            copy_index_file_from_version_to_master_middleman(version, output_locations.source_for_site_generator, config.book_repo_url)
           end
         end
 
@@ -48,12 +47,8 @@ module Bookbinder
           end
         end
 
-        def forget_sections(middleman_scratch)
-          file_system_accessor.remove_directory File.join middleman_scratch, '.'
-        end
-
         def copy_directory_from_gem(gem_root, dir, output_dir)
-          file_system_accessor.copy File.join(gem_root, "#{dir}/."), output_dir
+          file_system_accessor.copy_contents(File.join(gem_root, dir), output_dir)
         end
       end
     end

data/lib/bookbinder/{repositories/command_repository.rb → commands/collection.rb}

@@ -4,27 +4,28 @@ end
 
 require_relative '../commands/bind/directory_preparer'
 require_relative '../config/bind_config_factory'
-require_relative '../configuration_fetcher'
-require_relative '../configuration_validator'
+require_relative '../config/fetcher'
+require_relative '../config/remote_yaml_credential_provider'
+require_relative '../config/validator'
+require_relative '../config/yaml_loader'
 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 '../local_file_system_accessor'
 require_relative '../middleman_runner'
 require_relative '../post_production/sitemap_writer'
 require_relative '../preprocessing/copy_to_site_gen_dir'
 require_relative '../preprocessing/dita_preprocessor'
 require_relative '../preprocessing/preprocessor'
-require_relative '../remote_yaml_credential_provider'
 require_relative '../sheller'
 require_relative '../subnav_formatter'
-require_relative '../yaml_loader'
-require_relative 'section_repository_factory'
+require_relative '../values/output_locations'
 
 module Bookbinder
-  module Repositories
-    class CommandRepository
+  module Commands
+    class Collection
       include Enumerable
 
       def initialize(logger, version_control_system)
@@ -74,21 +75,16 @@ module Bookbinder
 
       def bind
         @bind ||= Commands::Bind.new(
-          logger,
-          bind_config_factory,
-          ArchiveMenuConfiguration.new(
-            loader: config_loader,
-            config_filename: 'bookbinder.yml'
-          ),
-          version_control_system,
+          {out: $stdout, err: $stderr},
+          OutputLocations.new(final_app_dir: final_app_directory, context_dir: File.absolute_path('.')),
+          Config::BindConfigFactory.new(version_control_system, configuration_fetcher),
+          Config::ArchiveMenuConfiguration.new(loader: config_loader, config_filename: 'bookbinder.yml'),
           local_file_system_accessor,
-          middleman_runner,
+          MiddlemanRunner.new(logger, version_control_system),
           PostProduction::SitemapWriter.build(logger, final_app_directory, sitemap_port),
-          final_app_directory,
-          File.absolute_path('.'),
           Preprocessing::Preprocessor.new(
             Preprocessing::DitaPreprocessor.new(
-              dita_html_to_middleman_formatter,
+              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
@@ -96,7 +92,7 @@ module Bookbinder
             Preprocessing::CopyToSiteGenDir.new(local_file_system_accessor),
           ),
           Ingest::ClonerFactory.new(logger, local_file_system_accessor, version_control_system),
-          Repositories::SectionRepositoryFactory.new(logger),
+          Ingest::SectionRepositoryFactory.new(logger),
           Commands::BindComponents::DirectoryPreparer.new(logger, local_file_system_accessor, version_control_system)
         )
       end
@@ -116,35 +112,25 @@ module Bookbinder
         )
       end
 
-      def middleman_runner
-        @middleman_runner ||= MiddlemanRunner.new(logger, version_control_system)
-      end
-
       def configuration_fetcher
-        @configuration_fetcher ||= ConfigurationFetcher.new(
+        @configuration_fetcher ||= Config::Fetcher.new(
           logger,
-          ConfigurationValidator.new(logger, local_file_system_accessor),
+          Config::Validator.new(logger, local_file_system_accessor),
           config_loader,
-          RemoteYamlCredentialProvider.new(logger, version_control_system)
+          Config::RemoteYamlCredentialProvider.new(logger, version_control_system)
         ).tap do |fetcher|
           fetcher.set_config_file_path './config.yml'
         end
       end
 
       def config_loader
-        @config_loader ||= YAMLLoader.new
+        @config_loader ||= Config::YAMLLoader.new
       end
 
       def final_app_directory
         @final_app_directory ||= File.absolute_path('final_app')
       end
 
-      def dita_html_to_middleman_formatter
-        @dita_html_to_middleman_formatter ||= DitaHtmlToMiddlemanFormatter.new(local_file_system_accessor,
-                                                                               subnav_formatter,
-                                                                               html_document_manipulator)
-      end
-
       def subnav_formatter
         @subnav_formatter ||= SubnavFormatter.new
       end
@@ -157,10 +143,6 @@ module Bookbinder
         @local_file_system_accessor ||= LocalFileSystemAccessor.new
       end
 
-      def bind_config_factory
-        @bind_config_factory  ||= Config::BindConfigFactory.new(version_control_system, configuration_fetcher)
-      end
-
       def sitemap_port
         41722
       end