bookbindery 2.1.1 → 2.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2d3d076039145f8f2a2bafee423be060af21aa0e
-  data.tar.gz: fcbf5db4664f0117c1fd6344c28d3bff3a075db1
+  metadata.gz: 738c31dab5c4057b6f486aef21926f603615651c
+  data.tar.gz: 3a149c514e408ff32ba77c6835dbd7b315646cd7
 SHA512:
-  metadata.gz: facaf7d83bbf83e2c2a867614a0b2c789aec2c3e1658564f942529cb669dccacf51fdebffac8ffe5c402159dd5b9513eb2da5db786f2341ab94c43c634ce3031
-  data.tar.gz: 6f656bd9e4a870d60030b68a00d7396f1374df69f9c43e8bfb091b343e968c6b83a315da20fd31cf25c342e183118ff82cf8b1610fde38ce5674e78e683d6450
+  metadata.gz: b9f7024799d3f9318cdcc19d5a42653614a6f70bc1577d70cc796a8115ceae219ce29fef032f15c920581fbe9a35445e102ad436ce61c8fbbf5be6aecdbe1413
+  data.tar.gz: e3cc42e4d350875b1115348fba6aaa1e12c9c8c41306f65991e03474edd1cb2966a2853ac8aa653830fc7ecd3c9c05979d2fcd74f3f2c374e5763c5964ac0ae6

data/install_bin/bookbinder

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

data/lib/bookbinder.rb

@@ -13,9 +13,9 @@ require 'puma'
 
 require_relative 'bookbinder/deprecated_logger'
 require_relative 'bookbinder/git_client'
-require_relative 'bookbinder/section'
+require_relative 'bookbinder/values/section'
 require_relative 'bookbinder/book'
-require_relative 'bookbinder/code_example'
+require_relative 'bookbinder/values/code_example'
 require_relative 'bookbinder/remote_yaml_credential_provider'
 require_relative 'bookbinder/configuration'
 require_relative 'bookbinder/configuration_fetcher'

data/lib/bookbinder/app_fetcher.rb

@@ -1,5 +1,5 @@
-require_relative "blue_green_app"
-require_relative "cf_routes"
+require_relative 'values/blue_green_app'
+require_relative 'values/cf_routes'
 
 module Bookbinder
 

data/lib/bookbinder/cf_command_runner.rb

@@ -1,5 +1,5 @@
 require 'open3'
-require_relative 'blue_green_app'
+require_relative 'values/blue_green_app'
 
 module Bookbinder
   class CfCommandRunner

data/lib/bookbinder/cli.rb

@@ -8,11 +8,15 @@ require_relative 'user_message_presenter'
 
 module Bookbinder
   class Cli
+    def initialize(version_control_system)
+      @version_control_system = version_control_system
+    end
+
     def run(args)
       command_name, *command_arguments = args
 
       logger = DeprecatedLogger.new
-      commands = Repositories::CommandRepository.new(logger)
+      commands = Repositories::CommandRepository.new(logger, version_control_system)
 
       command_validator = CommandValidator.new(commands, commands.help.usage_message)
       command_runner = CommandRunner.new(logger, commands)
@@ -52,5 +56,10 @@ module Bookbinder
         1
       end
     end
+
+    private
+    
+    attr_reader :version_control_system
+
   end
 end

data/lib/bookbinder/command_runner.rb

@@ -1,4 +1,4 @@
-require_relative 'cli_error'
+require_relative 'errors/cli_error'
 require_relative 'local_dita_to_html_converter'
 require_relative 'sheller'
 

data/lib/bookbinder/command_validator.rb

@@ -1,7 +1,7 @@
 require 'ostruct'
-require_relative 'cli_error'
+require_relative 'errors/cli_error'
 require_relative 'commands/naming'
-require_relative 'user_message'
+require_relative 'values/user_message'
 
 module Bookbinder
   class CommandValidator

data/lib/bookbinder/commands/bind.rb

@@ -1,11 +1,12 @@
 require_relative '../archive_menu_configuration'
 require_relative '../book'
-require_relative '../cli_error'
+require_relative '../errors/cli_error'
 require_relative '../directory_helpers'
 require_relative '../publisher'
-require_relative '../section'
-require_relative '../dita_section'
+require_relative '../values/section'
+require_relative '../values/dita_section'
 require_relative '../dita_section_gatherer'
+require_relative '../values/output_locations'
 require_relative 'naming'
 
 module Bookbinder
@@ -57,39 +58,38 @@ module Bookbinder
 
       def run(cli_arguments)
         raise CliError::InvalidArguments unless arguments_are_valid?(cli_arguments)
+
         @section_repository = Repositories::SectionRepository.new(logger)
         @gem_root = File.expand_path('../../../../', __FILE__)
-
         @publisher = Publisher.new(logger, sitemap_generator, static_site_generator, server_director, file_system_accessor)
 
         bind_source, *options = cli_arguments
 
-        output_paths = output_directory_paths(bind_source)
-
         bind_config = bind_config(bind_source)
         @versions = bind_config.fetch(:versions, [])
         @book_repo = bind_config[:book_repo]
 
+        output_paths = output_directory_paths(bind_source)
         master_middleman_dir = output_paths.fetch(:master_middleman_dir)
         output_dir = output_paths.fetch(:output_dir)
-
         master_dir = File.join output_dir, 'master_middleman'
-        workspace_dir = File.join master_dir, 'source'
 
-        dita_processing_dir = File.join output_dir, 'dita'
-        dita_section_dir = File.join dita_processing_dir, 'dita_sections'
-        dita_processed_dir = File.join dita_processing_dir, 'html_from_dita'
-        subnavs_dir = File.join workspace_dir, 'subnavs'
-        dita_subnav_template_path = File.join workspace_dir, 'subnavs', '_dita_subnav_template.erb'
-        formatted_dir = File.join dita_processing_dir, 'site_generator_ready'
+        output_locations = OutputLocations.new(
+          workspace_dir = File.join(master_dir, 'source'),
+          dita_home_dir = File.join(output_dir, 'dita'),
+          cloned_dita_dir = File.join(dita_home_dir, 'dita_sections'),
+          html_from_dita_dir = File.join(dita_home_dir, 'html_from_dita'),
+          formatted_dir = File.join(dita_home_dir, 'site_generator_ready'),
+          subnavs_for_layout_dir = File.join(workspace_dir, 'subnavs'),
+          dita_subnav_template_path = File.join(workspace_dir, 'subnavs', '_dita_subnav_template.erb')
+        )
 
         prepare_directories(final_app_directory,
                             output_dir,
                             workspace_dir,
                             master_middleman_dir,
                             master_dir,
-                            dita_processing_dir,
-                            formatted_dir)
+                            dita_home_dir)
 
         dita_section_config_hash = config.dita_sections || {}
         dita_sections = dita_section_config_hash.map do |dita_section_config|
@@ -98,12 +98,12 @@ module Bookbinder
           target_ref = dita_section_config.fetch('repository', {})['ref']
           directory = dita_section_config['directory']
 
-          DitaSection.new(nil, relative_path_to_dita_map, full_name, target_ref, directory)
+          DitaSection.new(nil, relative_path_to_dita_map, full_name, target_ref, directory, output_locations)
         end
 
         if bind_source == 'github'
-          dita_section_gatherer = DitaSectionGatherer.new(version_control_system, logger)
-          gathered_dita_sections = dita_section_gatherer.gather(dita_sections, to: dita_section_dir)
+          dita_section_gatherer = DitaSectionGatherer.new(version_control_system, output_locations, logger)
+          gathered_dita_sections = dita_section_gatherer.gather(dita_sections, to: cloned_dita_dir)
         else
           gathered_dita_sections = dita_sections.map do |dita_section|
             relative_path_to_dita_map = dita_section.ditamap_location
@@ -113,16 +113,13 @@ module Bookbinder
 
             path_to_local_copy = File.join output_paths[:local_repo_dir], directory
 
-            DitaSection.new(path_to_local_copy, relative_path_to_dita_map, full_name, target_ref, directory)
+            DitaSection.new(path_to_local_copy, relative_path_to_dita_map, full_name, target_ref, directory, output_locations)
           end
         end
 
         gathered_dita_sections.each do |dita_section|
           dita_preprocessor.preprocess(dita_section,
-                                       dita_processed_dir,
-                                       formatted_dir,
-                                       workspace_dir,
-                                       subnavs_dir,
+                                       subnavs_for_layout_dir,
                                        dita_subnav_template_path)
         end
 
@@ -187,16 +184,10 @@ module Bookbinder
                               middleman_source,
                               master_middleman_dir,
                               middleman_dir,
-                              dita_processing_dir,
-                              formatted_dir)
+                              dita_processing_dir)
         forget_sections(output_dir)
         file_system_accessor.remove_directory File.join final_app, '.'
         file_system_accessor.remove_directory dita_processing_dir
-        file_system_accessor.make_directory output_dir
-        file_system_accessor.make_directory formatted_dir
-        file_system_accessor.make_directory File.join dita_processing_dir, 'dita_sections'
-        file_system_accessor.make_directory File.join final_app, 'public'
-        file_system_accessor.make_directory middleman_source
 
         copy_directory_from_gem 'template_app', final_app
         copy_directory_from_gem 'master_middleman', middleman_dir

data/lib/bookbinder/commands/tag.rb

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

data/lib/bookbinder/dita_html_to_middleman_formatter.rb

@@ -1,4 +1,4 @@
-require_relative 'subnav'
+require_relative 'values/subnav'
 
 module Bookbinder
 

data/lib/bookbinder/dita_section_gatherer.rb

@@ -1,7 +1,8 @@
 module Bookbinder
   class DitaSectionGatherer
-    def initialize(version_control_system, view_updater)
+    def initialize(version_control_system, output_locations, view_updater)
       @version_control_system = version_control_system
+      @output_locations = output_locations
       @view_updater = view_updater
     end
 
@@ -16,13 +17,14 @@ module Bookbinder
                         dita_section.ditamap_location,
                         dita_section.full_name,
                         dita_section.target_ref,
-                        dita_section.directory)
+                        dita_section.directory,
+                        output_locations)
         end
     end
 
     private
 
-    attr_reader :version_control_system, :view_updater
+    attr_reader :version_control_system, :view_updater, :output_locations
 
   end
 end

data/lib/bookbinder/git_accessor.rb

@@ -12,6 +12,6 @@ module Bookbinder
 
     private
 
-    attr_reader :cache, :third_party
+    attr_reader :cache
   end
 end

data/lib/bookbinder/ingest/cloner_factory.rb

@@ -1,5 +1,5 @@
-require_relative 'git_hub_repository_cloner_facade'
-require_relative 'local_filesystem_cloner_facade'
+require_relative 'git_hub_repository_cloner'
+require_relative 'local_filesystem_cloner'
 
 module Bookbinder
   module Ingest
@@ -11,9 +11,9 @@ module Bookbinder
 
       def produce(source, user_repo_dir)
         if user_repo_dir
-          LocalFilesystemClonerFacade.new(logger, version_control_system, user_repo_dir)
+          LocalFilesystemCloner.new(logger, version_control_system, user_repo_dir)
         else
-          GitHubRepositoryClonerFacade.new(logger, version_control_system)
+          GitHubRepositoryCloner.new(logger, version_control_system)
         end
       end
 

data/lib/bookbinder/ingest/{git_hub_repository_cloner_facade.rb → git_hub_repository_cloner.rb}

@@ -1,6 +1,6 @@
 module Bookbinder
   module Ingest
-    class GitHubRepositoryClonerFacade
+    class GitHubRepositoryCloner
       def initialize(logger, version_control_system)
         @logger = logger
         @version_control_system = version_control_system

data/lib/bookbinder/ingest/{local_filesystem_cloner_facade.rb → local_filesystem_cloner.rb}

@@ -1,6 +1,6 @@
 module Bookbinder
   module Ingest
-    class LocalFilesystemClonerFacade
+    class LocalFilesystemCloner
       def initialize(logger, version_control_system, user_repo_dir)
         @logger = logger
         @version_control_system = version_control_system

data/lib/bookbinder/local_dita_preprocessor.rb

@@ -1,4 +1,4 @@
-require_relative 'subnav'
+require_relative 'values/subnav'
 
 module Bookbinder
   class LocalDitaPreprocessor
@@ -10,19 +10,14 @@ module Bookbinder
     end
 
     def preprocess(dita_section,
-                   html_from_dita_dir,
-                   formatted_dita_dir,
-                   workspace_dir,
                    subnavs_dir,
                    dita_subnav_template_path)
-      dita_converter.convert_to_html dita_section, write_to: html_from_dita_dir
+      dita_converter.convert_to_html dita_section, write_to: dita_section.html_from_dita_section_dir
 
-      dita_formatter.format_html html_from_dita_dir, formatted_dita_dir
+      dita_formatter.format_html dita_section.html_from_dita_section_dir, dita_section.formatted_section_dir
 
       dita_subnav_template_text = local_file_system_accessor.read(dita_subnav_template_path)
-      tocjs_text = local_file_system_accessor.read(File.join html_from_dita_dir,
-                                                             dita_section.directory,
-                                                             'index.html')
+      tocjs_text = local_file_system_accessor.read(File.join dita_section.html_from_dita_section_dir, 'index.html')
 
       json_props_location = File.join(dita_section.directory + '-props.json')
       props_file_location = File.join(subnavs_dir, json_props_location)
@@ -39,11 +34,11 @@ module Bookbinder
                                                      filename="#{dita_section.directory}_subnav.erb")
 
       local_file_system_accessor.copy_named_directory_with_path('images',
-                                                                html_from_dita_dir,
-                                                                workspace_dir)
+                                                                dita_section.html_from_dita_section_dir,
+                                                                dita_section.section_source_for_site_generator)
 
-      local_file_system_accessor.copy_contents(formatted_dita_dir,
-                                               workspace_dir)
+      local_file_system_accessor.copy_contents(dita_section.formatted_section_dir,
+                                               dita_section.section_source_for_site_generator)
     end
 
 

data/lib/bookbinder/local_dita_to_html_converter.rb

@@ -1,4 +1,4 @@
-require_relative '../bookbinder/dita_section'
+require_relative '../bookbinder/values/dita_section'
 
 module Bookbinder
   class LocalDitaToHtmlConverter
@@ -21,11 +21,10 @@ module Bookbinder
                   "#{path_to_dita_ot_library}:" +
                   "#{path_to_dita_ot_library}/lib/:" +
                   "#{path_to_dita_ot_library}/lib/dost.jar"
-      out_dir = File.join write_to, dita_section.directory
       command = "export CLASSPATH=#{classpath}; " +
                 "ant -f #{path_to_dita_ot_library} " +
                 "-Dbasedir='/' " +
-                "-Doutput.dir=#{out_dir} " +
+                "-Doutput.dir=#{write_to} " +
                 "-Dtranstype='tocjs' " +
                 "-Ddita.temp.dir='/tmp/bookbinder_dita' " +
                 "-Dargs.input=#{absolute_path_to_ditamap} "

data/lib/bookbinder/local_file_system_accessor.rb

@@ -32,6 +32,10 @@ module Bookbinder
     end
 
     def copy(src, dest)
+      unless File.directory?(dest)
+        FileUtils.mkdir_p(dest)
+      end
+
       FileUtils.cp_r src, dest
     end
 

data/lib/bookbinder/middleman_runner.rb

@@ -1,7 +1,7 @@
 require 'middleman-core'
 require 'middleman-core/cli'
 require 'middleman-core/profiling'
-require_relative 'code_example'
+require_relative 'values/code_example'
 require_relative 'code_example_reader'
 
 class Middleman::Cli::BuildAction

data/lib/bookbinder/repositories/command_repository.rb

@@ -4,7 +4,6 @@ end
 require_relative '../configuration_fetcher'
 require_relative '../configuration_validator'
 require_relative '../dita_html_to_middleman_formatter'
-require_relative '../git_accessor'
 require_relative '../html_document_manipulator'
 require_relative '../ingest/cloner_factory'
 require_relative '../local_dita_preprocessor'
@@ -20,8 +19,9 @@ module Bookbinder
     class CommandRepository
       include Enumerable
 
-      def initialize(logger)
+      def initialize(logger, version_control_system)
         @logger = logger
+        @version_control_system = version_control_system
       end
 
       def each(&block)
@@ -37,7 +37,7 @@ module Bookbinder
 
       private
 
-      attr_reader :logger
+      attr_reader :logger, :version_control_system
 
       def list
         standard_commands + flags
@@ -73,7 +73,7 @@ module Bookbinder
             loader: config_loader,
             config_filename: 'bookbinder.yml'
           ),
-          git_accessor,
+          version_control_system,
           local_file_system_accessor,
           middleman_runner,
           spider,
@@ -81,7 +81,7 @@ module Bookbinder
           server_director,
           File.absolute_path('.'),
           dita_preprocessor,
-          Ingest::ClonerFactory.new(logger, git_accessor)
+          Ingest::ClonerFactory.new(logger, version_control_system)
         )
       end
 
@@ -112,7 +112,7 @@ module Bookbinder
       end
 
       def middleman_runner
-        @middleman_runner ||= MiddlemanRunner.new(logger, git_accessor)
+        @middleman_runner ||= MiddlemanRunner.new(logger, version_control_system)
       end
 
       def configuration_fetcher
@@ -160,10 +160,6 @@ module Bookbinder
         @html_document_manipulator ||= HtmlDocumentManipulator.new
       end
 
-      def git_accessor
-        @git_accessor ||= GitAccessor.new
-      end
-
       def local_file_system_accessor
         @local_file_system_accessor ||= LocalFileSystemAccessor.new
       end

data/lib/bookbinder/values/dita_section.rb

@@ -0,0 +1,26 @@
+module Bookbinder
+  DitaSection = Struct.new(:path_to_local_repo,
+                           :ditamap_location,
+                           :full_name,
+                           :target_ref,
+                           :directory,
+                           :output_locations) do
+                             def subnav
+                               namespace = directory.gsub('/', '_')
+                               template = "#{directory}_subnav"
+                               {namespace => template}
+                             end
+
+                             def html_from_dita_section_dir
+                               File.join(output_locations.html_from_dita_dir, directory)
+                             end
+
+                             def formatted_section_dir
+                               File.join(output_locations.formatted_dir, directory)
+                             end
+
+                             def section_source_for_site_generator
+                               File.join(output_locations.source_for_site_generator, directory)
+                             end
+                           end
+end

data/lib/bookbinder/values/output_locations.rb

@@ -0,0 +1,11 @@
+module Bookbinder
+  OutputLocations = Struct.new(
+      :source_for_site_generator,
+      :dita_home_dir,
+      :cloned_dita_dir,
+      :html_from_dita_dir,
+      :formatted_dir,
+      :subnavs_for_layout_dir,
+      :dita_subnav_template_path
+  )
+end

data/lib/bookbinder/{section.rb → values/section.rb}

@@ -1,5 +1,4 @@
 module Bookbinder
-
   Section = Struct.new(:path_to_repository,
                        :full_name,
                        :copied,

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bookbindery
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.1.3
 platform: ruby
 authors:
 - Mike Grafton
@@ -15,7 +15,7 @@ authors:
 autorequire: 
 bindir: install_bin
 cert_chain: []
-date: 2015-03-07 00:00:00.000000000 Z
+date: 2015-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fog-aws
@@ -309,13 +309,9 @@ files:
 - lib/bookbinder/archive.rb
 - lib/bookbinder/archive_menu_configuration.rb
 - lib/bookbinder/artifact_namer.rb
-- lib/bookbinder/blue_green_app.rb
 - lib/bookbinder/book.rb
 - lib/bookbinder/cf_command_runner.rb
-- lib/bookbinder/cf_routes.rb
 - lib/bookbinder/cli.rb
-- lib/bookbinder/cli_error.rb
-- lib/bookbinder/code_example.rb
 - lib/bookbinder/code_example_reader.rb
 - lib/bookbinder/colorizer.rb
 - lib/bookbinder/command_runner.rb
@@ -341,15 +337,15 @@ files:
 - lib/bookbinder/directory_helpers.rb
 - lib/bookbinder/distributor.rb
 - lib/bookbinder/dita_html_to_middleman_formatter.rb
-- lib/bookbinder/dita_section.rb
 - lib/bookbinder/dita_section_gatherer.rb
+- lib/bookbinder/errors/cli_error.rb
 - lib/bookbinder/git_accessor.rb
 - lib/bookbinder/git_client.rb
 - lib/bookbinder/git_hub_repository.rb
 - lib/bookbinder/html_document_manipulator.rb
 - lib/bookbinder/ingest/cloner_factory.rb
-- lib/bookbinder/ingest/git_hub_repository_cloner_facade.rb
-- lib/bookbinder/ingest/local_filesystem_cloner_facade.rb
+- lib/bookbinder/ingest/git_hub_repository_cloner.rb
+- lib/bookbinder/ingest/local_filesystem_cloner.rb
 - lib/bookbinder/local_dita_preprocessor.rb
 - lib/bookbinder/local_dita_to_html_converter.rb
 - lib/bookbinder/local_file_system_accessor.rb
@@ -360,7 +356,6 @@ files:
 - lib/bookbinder/remote_yaml_credential_provider.rb
 - lib/bookbinder/repositories/command_repository.rb
 - lib/bookbinder/repositories/section_repository.rb
-- lib/bookbinder/section.rb
 - lib/bookbinder/server_director.rb
 - lib/bookbinder/shell_out.rb
 - lib/bookbinder/sheller.rb
@@ -368,11 +363,17 @@ files:
 - lib/bookbinder/sitemap_generator.rb
 - lib/bookbinder/spider.rb
 - lib/bookbinder/stabilimentum.rb
-- lib/bookbinder/subnav.rb
 - lib/bookbinder/subnav_formatter.rb
 - lib/bookbinder/terminal.rb
-- lib/bookbinder/user_message.rb
 - lib/bookbinder/user_message_presenter.rb
+- lib/bookbinder/values/blue_green_app.rb
+- lib/bookbinder/values/cf_routes.rb
+- lib/bookbinder/values/code_example.rb
+- lib/bookbinder/values/dita_section.rb
+- lib/bookbinder/values/output_locations.rb
+- lib/bookbinder/values/section.rb
+- lib/bookbinder/values/subnav.rb
+- lib/bookbinder/values/user_message.rb
 - lib/bookbinder/yaml_loader.rb
 - lib/bookbinder.rb
 - template_app/app.rb

data/lib/bookbinder/dita_section.rb

@@ -1,13 +0,0 @@
-module Bookbinder
-  DitaSection = Struct.new(:path_to_local_repo,
-                           :ditamap_location,
-                           :full_name,
-                           :target_ref,
-                           :directory) do
-                             def subnav
-                               namespace = directory.gsub('/', '_')
-                               template = "#{directory}_subnav"
-                               {namespace => template}
-                             end
-                           end
-end