bookbindery 1.0.0 → 2.0.0

data/lib/bookbinder.rb

@@ -1,10 +1,7 @@
-require 'fog'
+require 'fog/aws'
 require 'tmpdir'
 require 'ansi'
-require 'faraday'
-require 'faraday_middleware'
 require 'octokit'
-require 'padrino-contrib'
 require 'middleman-syntax'
 require 'middleman-core/cli'
 require 'middleman-core/profiling'
@@ -14,10 +11,8 @@ require 'vienna'
 require 'popen4'
 require 'puma'
 
-#require_relative 'bookbinder/shell_out'
 require_relative 'bookbinder/bookbinder_logger'
 require_relative 'bookbinder/git_client'
-#require_relative 'bookbinder/repository'
 require_relative 'bookbinder/section'
 require_relative 'bookbinder/book'
 require_relative 'bookbinder/code_example'
@@ -43,7 +38,7 @@ require_relative 'bookbinder/distributor'
 
 require_relative 'bookbinder/commands/bookbinder_command'
 require_relative 'bookbinder/commands/build_and_push_tarball'
-require_relative 'bookbinder/commands/publish'
+require_relative 'bookbinder/commands/bind'
 require_relative 'bookbinder/commands/push_local_to_staging'
 require_relative 'bookbinder/commands/push_to_prod'
 require_relative 'bookbinder/commands/run_publish_ci'
@@ -51,8 +46,6 @@ require_relative 'bookbinder/commands/update_local_doc_repos'
 require_relative 'bookbinder/commands/tag'
 require_relative 'bookbinder/commands/generate_pdf'
 
-require_relative 'bookbinder/usage_messenger'
-
 require_relative 'bookbinder/cli'
 
 # Finds the project root for both spec & production

data/master_middleman/archive_drop_down_menu.rb

@@ -0,0 +1,46 @@
+module Bookbinder
+  class ArchiveDropDownMenu
+    def initialize(config, current_path: nil)
+      @config = config || default_config
+      @current_path = current_path
+    end
+
+    def title
+      directory_config.first
+    end
+
+    def dropdown_links
+      versions_to_paths.map { |version_path|
+        {version_path.keys.first => "/#{version_path.values.first}"}
+      }
+    end
+
+    private
+
+    attr_reader :config, :current_path
+
+    def versions_to_paths
+      directory_config[1..-1]
+    end
+
+    def directory_config
+      config.fetch(directory, config.fetch(root_menu_reference)) || empty_menu
+    end
+
+    def directory
+      File.dirname(current_path)
+    end
+
+    def default_config
+      { root_menu_reference => empty_menu }
+    end
+
+    def empty_menu
+      [nil]
+    end
+
+    def root_menu_reference
+      '.'
+    end
+  end
+end

data/master_middleman/bookbinder_helpers.rb

@@ -1,15 +1,9 @@
 require 'date'
-# mostly from https://github.com/multiscan/middleman-navigation but modified slightly
+require_relative 'archive_drop_down_menu'
 require_relative 'quicklinks_renderer'
 
 I18n.enforce_available_locales = false
 
-class ArchiveMenuTemplateNotFound < StandardError;
-end
-
-class ArchiveConfigFormatError < StandardError;
-end
-
 module Bookbinder
   module Navigation
     class << self
@@ -23,8 +17,44 @@ module Bookbinder
     module HelperMethods
 
       def yield_for_code_snippet(from: nil, at: nil)
-        example = CodeExample.get_instance(bookbinder_logger, section_hash: {'repository' => {'name' => from}}, local_repo_dir: config[:local_repo_dir], git_accessor: config[:git_accessor])
-        snippet, language = example.get_snippet_and_language_at(at)
+        git_accessor = config[:git_accessor]
+        local_repo_dir = config[:local_repo_dir]
+        attributes = {'repository' => {'name' => from}}
+        workspace = config[:workspace]
+        code_example_reader = CodeExampleReader.new(bookbinder_logger)
+
+        vcs_repo =
+          if local_repo_dir
+            GitHubRepository.
+              build_from_local(bookbinder_logger,
+                               attributes,
+                               local_repo_dir,
+                               git_accessor).
+              tap { |repo| repo.copy_from_local(workspace) }
+          else
+            GitHubRepository.
+              build_from_remote(bookbinder_logger, attributes, nil, git_accessor).
+              tap { |repo| repo.copy_from_remote(workspace) }
+          end
+        example = code_example_repo.get_instance(attributes,
+                                                 vcs_repo: vcs_repo,
+                                                 build: ->(path_to_repository,
+                                                     full_name,
+                                                     copied,
+                                                     _,
+                                                     destination_dir,
+                                                     directory_name) {
+                                                   CodeExample.new(path_to_repository,
+                                                                   full_name,
+                                                                   copied,
+                                                                   destination_dir,
+                                                                   directory_name)
+        })
+        snippet, language = code_example_reader.get_snippet_and_language_at(at,
+                                                                            example.path_to_repository,
+                                                                            example.copied,
+                                                                            example.full_name)
+
         delimiter = '```'
 
         snippet.prepend("#{delimiter}#{language}\n").concat("\n#{delimiter}")
@@ -43,20 +73,13 @@ module Bookbinder
       end
 
       def yield_for_archive_drop_down_menu
-        if config.respond_to?(:archive_menu)
-          title = config[:archive_menu].first
-          links = config[:archive_menu][1..-1]
-
-          new_links_based_from_root = links.map do |link|
-            link_from_root = link.dup
-            link_from_root.map do |k, v|
-              link_from_root[k] = "/#{v}"
-            end
-            link_from_root
-          end
+        menu = ArchiveDropDownMenu.new(
+          config[:archive_menu],
+          current_path: current_page.path
+        )
 
-          partial 'archive_menus/default', locals: { menu_title: title, dropdown_links: new_links_based_from_root }
-        end
+        partial 'archive_menus/default', locals: { menu_title: menu.title,
+                                                   dropdown_links: menu.dropdown_links }
       end
 
       def breadcrumbs
@@ -72,13 +95,6 @@ module Bookbinder
         OpenStruct.new config[:template_variables]
       end
 
-      def modified_date(format=nil)
-        current_file_in_repo = current_path.dup.gsub(File.basename(current_path), File.basename(current_page.source_file))
-        current_section = get_section_or_book_for(current_file_in_repo)
-        modified_time = current_section.get_modification_date_for(file: current_file_in_repo, full_path: current_page.source_file)
-        (format.nil? ? modified_time : modified_time.strftime(format))
-      end
-
       def quick_links
         page_src = File.read(current_page.source_file)
         quicklinks_renderer = QuicklinksRenderer.new(vars)
@@ -87,17 +103,8 @@ module Bookbinder
 
       private
 
-      def get_section_or_book_for(path)
-        sections = config[:sections]
-        book = config[:book]
-
-        raise "Book or Selections are incorrectly specified for Middleman." if book.nil? || sections.nil?
-
-        current_section = nil
-        sections.each { |section| current_section = section if File.dirname(current_path).match(/^#{section.directory}/) }
-
-        return book if current_section.nil?
-        return current_section
+      def code_example_repo
+        @code_example_repo ||= Repositories::SectionRepository.new(bookbinder_logger)
       end
 
       def index_subnav

data/master_middleman/quicklinks_renderer.rb

@@ -30,7 +30,7 @@ class QuicklinksRenderer < Redcarpet::Render::Base
     @items[header_level] = li
     nil
   rescue BadHeadingLevelError => e
-    raise BadHeadingLevelError.new "The header \"#{text}\", which is at level #{e.message} has no higher-level headers occuring before it."
+    raise BadHeadingLevelError.new "The header \"#{text}\", which is at level #{e.message}, has no higher-level headers occurring before it."
   end
 
   private

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bookbindery
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Mike Grafton
@@ -13,24 +13,24 @@ authors:
 - Matthew Boedicker
 - Frank Kotsianas
 autorequire: 
-bindir: bin
+bindir: install_bin
 cert_chain: []
-date: 2015-01-08 00:00:00.000000000 Z
+date: 2015-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: fog
+  name: fog-aws
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: 0.0.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: 0.0.6
 - !ruby/object:Gem::Dependency
   name: octokit
   requirement: !ruby/object:Gem::Requirement
@@ -73,20 +73,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.1'
-- !ruby/object:Gem::Dependency
-  name: padrino-contrib
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: middleman
   requirement: !ruby/object:Gem::Requirement
@@ -157,34 +143,6 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 0.12.3
-- !ruby/object:Gem::Dependency
-  name: faraday
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.8.8
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.8.8
-- !ruby/object:Gem::Dependency
-  name: faraday_middleware
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.9.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.9.0
 - !ruby/object:Gem::Dependency
   name: anemone
   requirement: !ruby/object:Gem::Requirement
@@ -255,20 +213,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: ruby-progressbar
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: therubyracer
   requirement: !ruby/object:Gem::Requirement
@@ -353,20 +297,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: webmock
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: A command line utility to be run in Book repositories to stitch together
   their constituent Markdown repos into a static-HTML-serving application
 email: gmorgan@gopivotal.com
@@ -375,10 +305,9 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- bin/bookbinder
-- lib/bookbinder.rb
 - lib/bookbinder/app_fetcher.rb
 - 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
@@ -388,14 +317,17 @@ files:
 - 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
 - lib/bookbinder/command_validator.rb
+- lib/bookbinder/commands/bind.rb
 - lib/bookbinder/commands/bookbinder_command.rb
 - lib/bookbinder/commands/build_and_push_tarball.rb
+- lib/bookbinder/commands/chain.rb
 - lib/bookbinder/commands/generate_pdf.rb
 - lib/bookbinder/commands/help.rb
 - lib/bookbinder/commands/naming.rb
-- lib/bookbinder/commands/publish.rb
 - lib/bookbinder/commands/push_local_to_staging.rb
 - lib/bookbinder/commands/push_to_prod.rb
 - lib/bookbinder/commands/run_publish_ci.rb
@@ -408,33 +340,47 @@ files:
 - lib/bookbinder/css_link_checker.rb
 - 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/git_accessor.rb
 - lib/bookbinder/git_client.rb
 - lib/bookbinder/git_hub_repository.rb
+- lib/bookbinder/local_dita_preprocessor.rb
+- lib/bookbinder/local_dita_to_html_converter.rb
 - lib/bookbinder/local_file_system_accessor.rb
 - lib/bookbinder/middleman_runner.rb
 - lib/bookbinder/pdf_generator.rb
 - lib/bookbinder/publisher.rb
 - lib/bookbinder/pusher.rb
 - 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
 - lib/bookbinder/sieve.rb
 - lib/bookbinder/sitemap_generator.rb
 - lib/bookbinder/spider.rb
 - lib/bookbinder/stabilimentum.rb
-- lib/bookbinder/usage_messenger.rb
+- lib/bookbinder/terminal.rb
+- lib/bookbinder/user_message.rb
+- lib/bookbinder/user_message_presenter.rb
 - lib/bookbinder/yaml_loader.rb
-- master_middleman/bookbinder_helpers.rb
-- master_middleman/config.rb
-- master_middleman/quicklinks_renderer.rb
-- master_middleman/submodule_aware_assets.rb
-- template_app/Gemfile
-- template_app/Gemfile.lock
+- lib/bookbinder.rb
 - template_app/app.rb
 - template_app/config.ru
+- template_app/Gemfile
+- template_app/Gemfile.lock
 - template_app/lib/rack_static.rb
 - template_app/lib/vienna_application.rb
+- master_middleman/archive_drop_down_menu.rb
+- master_middleman/bookbinder_helpers.rb
+- master_middleman/config.rb
+- master_middleman/quicklinks_renderer.rb
+- master_middleman/submodule_aware_assets.rb
+- install_bin/bookbinder
 homepage: https://github.com/cloudfoundry-incubator/bookbinder
 licenses:
 - MIT
@@ -455,7 +401,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.1
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: Markdown to Rackup application documentation generator

data/lib/bookbinder/commands/publish.rb

@@ -1,138 +0,0 @@
-require_relative '../book'
-require_relative '../cli_error'
-require_relative '../configuration'
-require_relative '../directory_helpers'
-require_relative '../middleman_runner'
-require_relative '../publisher'
-require_relative '../spider'
-require_relative 'bookbinder_command'
-require_relative 'naming'
-
-module Bookbinder
-  module Commands
-    class Publish < BookbinderCommand
-      VersionUnsupportedError = Class.new(StandardError)
-
-      include Bookbinder::DirectoryHelperMethods
-      extend Commands::Naming
-
-      def self.usage
-        "publish <local|github> [--verbose] \t Bind the sections specified in config.yml from <local> or <github> into the final_app directory"
-      end
-
-      def run(cli_arguments, git_accessor=Git)
-        raise CliError::InvalidArguments unless arguments_are_valid?(cli_arguments)
-        @git_accessor = git_accessor
-
-        final_app_dir = File.absolute_path('final_app')
-        bind_book(cli_arguments, final_app_dir)
-      end
-
-      private
-
-      def bind_book(cli_arguments, final_app_dir)
-        generate_site_etc(cli_arguments, final_app_dir)
-      end
-
-      def generate_site_etc(cli_args, final_app_dir, target_tag=nil)
-        # TODO: general solution to turn all string keys to symbols
-        verbosity = cli_args.include?('--verbose')
-        location = cli_args[0]
-
-        cli_options = { verbose: verbosity, target_tag: target_tag }
-        output_paths = output_directory_paths(location, final_app_dir)
-        publish_config = publish_config(location)
-        spider = Spider.new(@logger, app_dir: final_app_dir)
-        static_site_generator = MiddlemanRunner.new(@logger)
-
-        success = Publisher.new(@logger, spider, static_site_generator).publish(cli_options, output_paths, publish_config, @git_accessor)
-        success ? 0 : 1
-      end
-
-      def output_directory_paths(location, final_app_dir)
-        local_repo_dir = (location == 'local') ? File.absolute_path('..') : nil
-
-        {
-          final_app_dir: final_app_dir,
-          local_repo_dir: local_repo_dir,
-          output_dir: File.absolute_path(output_dir_name),
-          master_middleman_dir: layout_repo_path(local_repo_dir)
-        }
-      end
-
-      def publish_config(location)
-        arguments = {
-            sections: config.sections,
-            book_repo: config.book_repo,
-            host_for_sitemap: config.public_host,
-            archive_menu: config.archive_menu
-        }
-
-        optional_arguments = {}
-        optional_arguments.merge!(template_variables: config.template_variables) if config.respond_to?(:template_variables)
-        if publishing_to_github? location
-          config.versions.each { |version| arguments[:sections].concat sections_from version, @git_accessor }
-          optional_arguments.merge!(versions: config.versions)
-        end
-
-        arguments.merge! optional_arguments
-      end
-
-      def sections_from(version, git_accessor)
-        config_file = File.join book_checkout(version, git_accessor), 'config.yml'
-        attrs       = YAML.load(File.read(config_file))['sections']
-        raise VersionUnsupportedError.new(version) if attrs.nil?
-
-        attrs.map do |section_hash|
-          section_hash['repository']['ref'] = version
-          section_hash['directory'] = File.join(version, section_hash['directory'])
-          section_hash
-        end
-      end
-
-      def book_checkout(ref, git_accessor=Git)
-        temp_workspace = Dir.mktmpdir('book_checkout')
-        book = Book.from_remote(logger: @logger,
-                                full_name: config.book_repo,
-                                destination_dir: temp_workspace,
-                                ref: ref,
-                                git_accessor: git_accessor,
-                               )
-
-        File.join temp_workspace, book.directory
-      end
-
-      def layout_repo_path(local_repo_dir)
-        if config.has_option?('layout_repo')
-          if local_repo_dir
-            File.join(local_repo_dir, config.layout_repo.split('/').last)
-          else
-            section = {'repository' => {'name' => config.layout_repo}}
-            destination_dir = Dir.mktmpdir
-            repository =  GitHubRepository.build_from_remote(@logger, section, destination_dir, 'master', @git_accessor)
-            if repository
-              File.join(destination_dir, repository.directory)
-            else
-              raise 'failed to fetch repository'
-            end
-          end
-        else
-          File.absolute_path('master_middleman')
-        end
-      end
-
-      def arguments_are_valid?(arguments)
-        return false unless arguments.any?
-        verbose           = arguments[1] && arguments[1..-1].include?('--verbose')
-        tag_provided      = arguments[1] && (arguments[1..-1] - ['--verbose']).any?
-        nothing_special   = arguments[1..-1].empty?
-
-        %w(local github).include?(arguments[0]) && (tag_provided || verbose || nothing_special)
-      end
-
-      def publishing_to_github?(publish_location)
-        config.has_option?('versions') && publish_location != 'local'
-      end
-    end
-  end
-end

data/lib/bookbinder/usage_messenger.rb

@@ -1,33 +0,0 @@
-module Bookbinder
-  class UsageMessenger
-
-    def construct_for commands, flags
-      log_usage_header + "\n" + flag_usage_messages(flags) + command_usage_messages(commands)
-    end
-
-    private
-
-    def flag_usage_messages(flags)
-      flag_usage_messages = ""
-      flags.each { |f| flag_usage_messages += " \t#{f.usage}\n" }
-      flag_usage_messages
-    end
-
-    def command_usage_messages(commands)
-      flag_command_messages = ""
-      commands.each do |command_class|
-        flag_command_messages += " \t#{command_class.usage}\n"
-      end
-      flag_command_messages
-    end
-
-    def log_usage_header
-      <<TEXT
-
-  \e[1;39;49mDocumentation\e[0m: https://github.com/pivotal-cf/docs-bookbinder
-
-  \e[1;39;49mUsage\e[0m: bookbinder <command|flag> [args]
-TEXT
-    end
-  end
-end