bookbindery 5.0.1 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 20f7d3bff67f0bf6db5e937eebaa27c123bac001
-  data.tar.gz: 5f86b7351237c3dafa61f4253bf3cab8d2c40c66
+  metadata.gz: c73a7a9a4f263f7730ce38c6e09b98ae457a9571
+  data.tar.gz: bbd94c2710ce6052e2ad401525b9e024a584245b
 SHA512:
-  metadata.gz: 254c768d3ef65b50837e05c35f3f9fd35014d4dc6b16170e6406aaf1f5399b44d211c40bd999494cda1df0345ec08ee5dadac11d02a6b34b1073993eeb1d6b58
-  data.tar.gz: 81a255158580983914a0d5fbc90640d7db9f5404e116c67f2e11361f6ed9b92f14cfca8b74677b0b5d3b5e42bcefb47dba9d7d368b82abb2aac7ab25bc778164
+  metadata.gz: e6dbef842e82feb7bb9e4ab4dd273cc25bee08d6fb0ce4119f041c304e461ecca957269b2a96b96677e8ab03e8bfb05579654a9b47f1ff4cebe3e82723d76e5a
+  data.tar.gz: c6331e3c72ee6a989f26b879d1234f2e9ae1d809b10c50bc6e2e8e633157ee155d6ffa97b7243e1d9f7944b18d532d0ed1eaa517fb7876f3fae6377db8883e2f

data/bookbinder.gemspec

@@ -2,7 +2,7 @@ require 'base64'
 
 Gem::Specification.new do |s|
   s.name        = 'bookbindery'
-  s.version     = '5.0.1'
+  s.version     = '6.0.0'
   s.summary     = 'Markdown to Rackup application documentation generator'
   s.description = 'A command line utility to be run in Book repositories to stitch together their constituent Markdown repos into a static-HTML-serving application'
   s.authors     = ['Mike Grafton', 'Lucas Marks', 'Gavin Morgan', 'Nikhil Gajwani', 'Dan Wendorf', 'Brenda Chan', 'Matthew Boedicker', 'Frank Kotsianas', 'Elena Sharma', 'Christa Hartsock']

data/lib/bookbinder/code_example_reader.rb

@@ -15,7 +15,7 @@ module Bookbinder
       if working_copy.available?
         process_snippet(marker, working_copy)
       else
-        out << "  skipping (not found) #{working_copy.full_name}"
+        out.puts("  skipping (not found) #{working_copy.full_name}")
         ''
       end
     end
@@ -67,7 +67,8 @@ module Bookbinder
     def find_text(start_path, pattern)
       fs.find_files_recursively(start_path).
         lazy.
-        map {|path| fs.read(path)}.
+        select {|path| fs.file_exist?(path) }.
+        map {|path| fs.read(path) }.
         map {|contents|
           begin
             contents.scan(pattern)

data/lib/bookbinder/commands/collection.rb

@@ -13,7 +13,7 @@ require_relative '../dita_html_to_middleman_formatter'
 require_relative '../html_document_manipulator'
 require_relative '../ingest/cloner_factory'
 require_relative '../ingest/section_repository'
-require_relative '../local_file_system_accessor'
+require_relative '../local_filesystem_accessor'
 require_relative '../middleman_runner'
 require_relative '../postprocessing/sitemap_writer'
 require_relative '../preprocessing/dita_preprocessor'
@@ -60,7 +60,7 @@ module Bookbinder
       def standard_commands
         @standard_commands ||= [
           Commands::Generate.new(
-            local_file_system_accessor,
+            local_filesystem_accessor,
             sheller,
             Dir.pwd,
             streams
@@ -71,7 +71,6 @@ module Bookbinder
           push_local_to_staging,
           Commands::PushToProd.new(streams, logger, configuration_fetcher, Dir.mktmpdir),
           Commands::RunPublishCI.new(bind, push_local_to_staging, build_and_push_tarball),
-          Commands::Tag.new(streams, configuration_fetcher, version_control_system),
           Commands::UpdateLocalDocRepos.new(
             streams,
             configuration_fetcher,
@@ -91,19 +90,19 @@ module Bookbinder
           OutputLocations.new(final_app_dir: final_app_directory, context_dir: File.absolute_path('.')),
           configuration_fetcher,
           Config::ArchiveMenuConfiguration.new(loader: config_loader, config_filename: 'bookbinder.yml'),
-          local_file_system_accessor,
+          local_filesystem_accessor,
           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,
+              DitaHtmlToMiddlemanFormatter.new(local_filesystem_accessor, subnav_formatter, html_document_manipulator),
+              local_filesystem_accessor,
               DitaCommandCreator.new(ENV['PATH_TO_DITA_OT_LIBRARY']),
               sheller
             ),
-            Preprocessing::LinkToSiteGenDir.new(local_file_system_accessor),
+            Preprocessing::LinkToSiteGenDir.new(local_filesystem_accessor),
           ),
-          Ingest::ClonerFactory.new(streams, local_file_system_accessor, version_control_system),
+          Ingest::ClonerFactory.new(streams, local_filesystem_accessor, version_control_system),
           Ingest::SectionRepository.new,
           directory_preparer
         )
@@ -116,8 +115,8 @@ module Bookbinder
           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)),
+          file_system_accessor: local_filesystem_accessor,
+          preprocessor: Preprocessing::Preprocessor.new(Preprocessing::LinkToSiteGenDir.new(local_filesystem_accessor)),
           cloner: local_file_system_cloner,
           section_repository: Ingest::SectionRepository.new,
           directory_preparer: directory_preparer
@@ -142,7 +141,7 @@ module Bookbinder
 
       def configuration_fetcher
         @configuration_fetcher ||= Config::Fetcher.new(
-          Config::Validator.new(local_file_system_accessor),
+          Config::Validator.new(local_filesystem_accessor),
           config_loader,
           Config::RemoteYamlCredentialProvider.new(logger, version_control_system)
         ).tap do |fetcher|
@@ -155,7 +154,7 @@ module Bookbinder
       end
 
       def directory_preparer
-        Commands::BindComponents::DirectoryPreparer.new(local_file_system_accessor)
+        Commands::BindComponents::DirectoryPreparer.new(local_filesystem_accessor)
       end
 
       def final_app_directory
@@ -170,8 +169,8 @@ module Bookbinder
         @html_document_manipulator ||= HtmlDocumentManipulator.new
       end
 
-      def local_file_system_accessor
-        @local_file_system_accessor ||= LocalFileSystemAccessor.new
+      def local_filesystem_accessor
+        @local_filesystem_accessor ||= LocalFilesystemAccessor.new
       end
 
       def sheller
@@ -183,11 +182,11 @@ module Bookbinder
       end
 
       def runner
-        MiddlemanRunner.new(local_file_system_accessor, sheller)
+        MiddlemanRunner.new(local_filesystem_accessor, sheller)
       end
 
       def local_file_system_cloner
-        Ingest::LocalFilesystemCloner.new(streams, local_file_system_accessor, File.expand_path('..'))
+        Ingest::LocalFilesystemCloner.new(streams, local_filesystem_accessor, File.expand_path('..'))
       end
     end
   end

data/lib/bookbinder/config/configuration.rb

@@ -1,3 +1,4 @@
+require_relative '../ingest/destination_directory'
 require_relative '../ingest/repo_identifier'
 require_relative 'section_config'
 
@@ -32,18 +33,34 @@ module Bookbinder
         end
 
         def dita_sections(input_config)
-          (input_config['dita_sections'] || []).map { |dita_section|
+          dita_sections = input_config['dita_sections']
+          (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'
+              'subnav_template' => dita_subnav_template(dita_sections, dita_section)
             ).reject { |k, _|
               %w(ditamap_location ditaval_location).include?(k)
             }
           }
         end
+
+        def dita_subnav_template(all_sections, current_section)
+          subnav_sections = all_sections.select { |section| section['ditamap_location'] }
+          if subnav_sections.empty?
+            nil
+          elsif subnav_sections.one?
+            "dita_subnav"
+          else
+            subnav_section = subnav_sections.include?(current_section) ? current_section : subnav_sections.first
+            dest_dir = Ingest::DestinationDirectory.new(
+              subnav_section.fetch('repository', {})['name'], subnav_section['directory'])
+
+            dest_dir ? "dita_subnav_#{dest_dir}" : "dita_subnav"
+          end
+        end
       end
 
       def initialize(config)

data/lib/bookbinder/dita_command_creator.rb

@@ -40,11 +40,7 @@ module Bookbinder
     end
 
     def filter(ditaval_path)
-      if ditaval_path
-        { 'args.filter' => ditaval_path }
-      else
-        {}
-      end
+      ditaval_path ? { 'args.filter' => ditaval_path } : {}
     end
 
     def base_flags
@@ -59,18 +55,19 @@ module Bookbinder
 
     def optional_flags(flags_str)
       flags = flags_str ? flags_str.split(" ") : []
-      flags.inject({}) do |h, f|
-        k,v = f.split('=')
-        h[k] = v
-        raise MissingDitaOTFlagValue.new("The DITA-flag '#{k}' that you passed is missing a value. Please pass your DITA option in the format '#{k}=<value>'.") unless v
-        h
+      {}.tap do |h|
+        flags.each do |f|
+          k,v = f.split('=')
+          h[k] = v
+          raise MissingDitaOTFlagValue.new("The DITA-flag '#{k}' that you passed is missing a value. Please pass your DITA option in the format '#{k}=<value>'.") unless v
+        end
       end
     end
 
     def format(flags)
       flags.inject("") do |res, f|
         k,v = f
-        res += "-D#{k}='#{stripped_flag_value v}' "
+        res + "-D#{k}='#{stripped_flag_value v}' "
       end
     end
 

data/lib/bookbinder/ingest/git_accessor.rb

@@ -1,4 +1,5 @@
 require 'git'
+require_relative '../directory_helpers'
 require_relative 'update_failure'
 require_relative 'update_success'
 
@@ -7,6 +8,7 @@ module Bookbinder
     class GitAccessor
       TagExists = Class.new(RuntimeError)
       InvalidTagRef = Class.new(RuntimeError)
+      include DirectoryHelperMethods
 
       def clone(url, name, path: nil, checkout: 'master')
         cached_clone(url, name, Pathname(path)).tap do |git|
@@ -37,26 +39,12 @@ module Bookbinder
         end
       end
 
-      def remote_tag(url, tagname, commit_or_object)
-        Dir.mktmpdir do |dir|
-          path = Pathname(dir)
-          git = cached_clone(url, temp_name("tag"), path)
-          git.config('user.name', 'Bookbinder')
-          git.config('user.email', 'bookbinder@cloudfoundry.org')
-          begin
-            git.add_tag(tagname, "origin/#{commit_or_object}",
-                        message: 'Tagged by Bookbinder')
-          rescue Git::GitExecuteError => e
-            case e.message
-            when /already exists/
-              raise TagExists
-            when /as a valid ref/
-              raise InvalidTagRef
-            else
-              raise
-            end
+      def author_date(path)
+        Pathname(path).dirname.ascend do |current_dir|
+          if current_dir.to_s.include?(source_dir_name) && current_dir.entries.include?(Pathname(".git"))
+            git = Git.open(current_dir)
+            return git.gblob(path).log.first.author.date
           end
-          git.push("origin", "master", tags: true)
         end
       end
 

data/lib/bookbinder/ingest/section_repository.rb

@@ -19,7 +19,6 @@ module Bookbinder
           Section.new(
             working_copy.path,
             working_copy.full_name,
-            destination_dir,
             section_config.desired_directory_name,
             section_config.subnav_template,
             section_config.preprocessor_config

data/lib/bookbinder/{local_file_system_accessor.rb → local_filesystem_accessor.rb}

@@ -5,7 +5,7 @@ require_relative 'errors/programmer_mistake'
 
 module Bookbinder
 
-  class LocalFileSystemAccessor
+  class LocalFilesystemAccessor
     def file_exist?(path)
       File.exist?(path)
     end

data/lib/bookbinder/preprocessing/dita_preprocessor.rb

@@ -15,36 +15,31 @@ module Bookbinder
       end
 
       def applicable_to?(section)
-        section.subnav_template == 'dita_subnav'
+        section.subnav_template.include?('dita_subnav') if section.subnav_template
       end
 
-      def preprocess(dita_sections, output_locations, options: nil, output_streams: nil)
-        dita_sections.select { |dita_section| dita_section.path_to_preprocessor_attribute('ditamap_location') }.each do |dita_section|
-          command = command_creator.convert_to_html_command(
-            dita_section,
-            dita_flags: dita_flags(options),
-            write_to: output_locations.html_from_preprocessing_dir.join(dita_section.destination_directory)
-          )
-          status = sheller.run_command(command, output_streams.to_h)
-          unless status.success?
-            raise DitaToHtmlLibraryFailure.new 'The DITA-to-HTML conversion failed. ' +
-              'Please check that you have specified the path to your DITA-OT library in the ENV, ' +
-              'that your DITA-specific keys/values in config.yml are set, ' +
-              'and that your DITA toolkit is correctly configured.'
+      def preprocess(dita_sections, output_locations, options: [], output_streams: nil)
+        dita_options = dita_flags(options)
+        dita_sections.each do |dita_section|
+          if dita_section.path_to_preprocessor_attribute('ditamap_location')
+            convert_dita_files(dita_section,
+                               command_creator,
+                               dita_options,
+                               output_locations.html_from_preprocessing_dir.join(dita_section.destination_directory),
+                               sheller,
+                               output_streams)
+
+            generate_subnav(dita_section,
+                            output_locations,
+                            output_locations.source_for_site_generator.join('subnavs', '_dita_subnav_template.erb'),
+                            output_locations.subnavs_for_layout_dir)
           end
 
-          generate_subnav(dita_section.destination_directory,
-                          output_locations,
-                          output_locations.source_for_site_generator.join('subnavs', '_dita_subnav_template.erb'),
-                          output_locations.subnavs_for_layout_dir)
-        end
-
-        dita_sections.each do |dita_section|
-          html_dir = output_locations.html_from_preprocessing_dir.join(dita_section.destination_directory)
+          section_html_dir = output_locations.html_from_preprocessing_dir.join(dita_section.destination_directory)
           formatted_dir = output_locations.formatted_dir.join(dita_section.destination_directory)
           source_for_site_gen_dir = output_locations.source_for_site_generator.join(dita_section.destination_directory)
 
-          dita_formatter.format_html html_dir, formatted_dir
+          dita_formatter.format_html section_html_dir, formatted_dir
 
           copy_images(dita_section.path_to_repository, formatted_dir)
 
@@ -56,26 +51,41 @@ module Bookbinder
 
       attr_reader :dita_formatter, :local_fs_accessor, :command_creator, :sheller
 
-      def generate_subnav(dita_section_dir, output_locations, dita_subnav_template_path, subnavs_dir)
+      def convert_dita_files(section, command_creator, options, section_html_dir, sheller, output_streams)
+        command = command_creator.convert_to_html_command(
+          section,
+          dita_flags: options,
+          write_to: section_html_dir
+        )
+        status = sheller.run_command(command, output_streams.to_h)
+        unless status.success?
+          raise DitaToHtmlLibraryFailure.new 'The DITA-to-HTML conversion failed. ' +
+                'Please check that you have specified the path to your DITA-OT library in the ENV, ' +
+                'that your DITA-specific keys/values in config.yml are set, ' +
+                'and that your DITA toolkit is correctly configured.'
+        end
+      end
+
+      def generate_subnav(dita_section, output_locations, dita_subnav_template_path, subnavs_dir)
         dita_subnav_template_text = local_fs_accessor.read(dita_subnav_template_path)
 
         tocjs_text = local_fs_accessor.read(
           File.join(
-            output_locations.html_from_preprocessing_dir.join(dita_section_dir),
+            output_locations.html_from_preprocessing_dir.join(dita_section.destination_directory),
             'index.html')
         )
-        json_props_location = File.join('dita-subnav-props.json')
+        json_props_location = json_props_location(dita_section.destination_directory)
         props_file_location = File.join(subnavs_dir, json_props_location)
 
-        subnav = dita_formatter.format_subnav(dita_section_dir,
+        subnav = dita_formatter.format_subnav(dita_section.destination_directory,
                                               dita_subnav_template_text,
                                               json_props_location,
                                               tocjs_text)
 
-       local_fs_accessor.write text: subnav.json_links, to: props_file_location
+        local_fs_accessor.write text: subnav.json_links, to: props_file_location
 
-       local_fs_accessor.write text: subnav.text,
-                               to: File.join(subnavs_dir, "dita_subnav.erb")
+        local_fs_accessor.write text: subnav.text,
+                                to: File.join(subnavs_dir, "#{dita_section.subnav_template}.erb")
       end
 
       def copy_images(src, dest)
@@ -90,6 +100,10 @@ module Bookbinder
         end
       end
 
+      def json_props_location(section_dir)
+        (["dita-subnav-props"] + Array(section_dir.to_s)).join("-") + ".json"
+      end
+
       def dita_flags(opts)
         matching_flags = opts.map {|o| o[flag_value_regex("dita-flags"), 1] }
         matching_flags.compact.first

data/lib/bookbinder/values/section.rb

@@ -4,7 +4,6 @@ require_relative '../ingest/destination_directory'
 module Bookbinder
   Section = Struct.new(:path_to_repository,
                        :full_name,
-                       :destination_dir,
                        :desired_directory_name,
                        :subnav_templ,
                        :preprocessor_config) do

data/master_middleman/bookbinder_helpers.rb

@@ -1,7 +1,7 @@
 require 'bookbinder/code_example_reader'
 require 'bookbinder/ingest/cloner_factory'
 require 'bookbinder/ingest/git_accessor'
-require 'bookbinder/local_file_system_accessor'
+require 'bookbinder/local_filesystem_accessor'
 require 'date'
 require_relative 'archive_drop_down_menu'
 require_relative 'quicklinks_renderer'
@@ -22,12 +22,12 @@ module Bookbinder
 
       def yield_for_code_snippet(from: nil, at: nil)
         cloner_factory = Ingest::ClonerFactory.new({out: $stdout},
-                                                   LocalFileSystemAccessor.new,
+                                                   LocalFilesystemAccessor.new,
                                                    Ingest::GitAccessor.new)
 
         cloner = cloner_factory.produce(config[:local_repo_dir])
         code_example_reader = CodeExampleReader.new({out: $stdout},
-                                                    LocalFileSystemAccessor.new)
+                                                    LocalFilesystemAccessor.new)
         working_copy = cloner.call(source_repo_name: from,
                                    source_ref: 'master',
                                    destination_parent_dir: config[:workspace])
@@ -53,6 +53,12 @@ module Bookbinder
                                                    dropdown_links: menu.dropdown_links }
       end
 
+      def modified_date(format="%B %-d, %Y")
+        git_accessor = Ingest::GitAccessor.new
+        date = git_accessor.author_date(current_page.source_file) || Time.new(1984,1,1)
+        "Page last updated: #{date.strftime(format)}"
+      end
+
       def breadcrumbs
         page_chain = add_ancestors_of(current_page, [])
         breadcrumbs = page_chain.map do |page|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bookbindery
 version: !ruby/object:Gem::Version
-  version: 5.0.1
+  version: 6.0.0
 platform: ruby
 authors:
 - Mike Grafton
@@ -17,7 +17,7 @@ authors:
 autorequire: 
 bindir: install_bin
 cert_chain: []
-date: 2015-08-27 00:00:00.000000000 Z
+date: 2015-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fog-aws
@@ -311,7 +311,6 @@ files:
 - lib/bookbinder/commands/push_from_local.rb
 - lib/bookbinder/commands/push_to_prod.rb
 - lib/bookbinder/commands/run_publish_ci.rb
-- lib/bookbinder/commands/tag.rb
 - lib/bookbinder/commands/update_local_doc_repos.rb
 - lib/bookbinder/commands/version.rb
 - lib/bookbinder/commands/watch.rb
@@ -358,7 +357,7 @@ files:
 - lib/bookbinder/ingest/update_failure.rb
 - lib/bookbinder/ingest/update_success.rb
 - lib/bookbinder/ingest/working_copy.rb
-- lib/bookbinder/local_file_system_accessor.rb
+- lib/bookbinder/local_filesystem_accessor.rb
 - lib/bookbinder/middleman_runner.rb
 - lib/bookbinder/postprocessing/sitemap_writer.rb
 - lib/bookbinder/preprocessing/dita_preprocessor.rb

data/lib/bookbinder/commands/tag.rb

@@ -1,44 +0,0 @@
-require_relative '../errors/cli_error'
-require_relative 'naming'
-
-module Bookbinder
-  module Commands
-    class Tag
-      include Commands::Naming
-
-      def initialize(streams, configuration_fetcher, version_control_system)
-        @streams = streams
-        @configuration_fetcher = configuration_fetcher
-        @version_control_system = version_control_system
-      end
-
-      def usage
-        ["tag <git tag>", "Apply the specified <git tag> to your book and all sections of your book"]
-      end
-
-      def run((tag, *))
-        raise CliError::InvalidArguments unless tag
-
-        urls(config).each do |url|
-          version_control_system.remote_tag(url, tag, 'HEAD')
-        end
-
-        streams[:success].puts 'Success!'
-        streams[:out].puts "#{config.book_repo} and its sections were tagged with #{tag}"
-        0
-      end
-
-      private
-
-      attr_reader :streams, :configuration_fetcher, :version_control_system
-
-      def urls(config)
-        [config.book_repo_url] + config.sections.map(&:repo_url).uniq
-      end
-
-      def config
-        @config ||= configuration_fetcher.fetch_config
-      end
-    end
-  end
-end