bookbindery 8.5.0 → 9.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 339d708a52273a3e142c40918a6be2022f0fb4e9
-  data.tar.gz: 0b8b092004e2580d7ca90e71610886018d21c303
+  metadata.gz: 11c7ab2f100519423aa8e8b3d7f209bb53f800ff
+  data.tar.gz: 8b95f5075fb79af6b8e9dbe4f21ffccdcd84e30d
 SHA512:
-  metadata.gz: 23bb176375b82fa847e9792eb94cbb51b377a6eeefec08eae31345b9049550db0d70d6f6ec2da5a046c5b23943a55645cb3c7e66cd7edf2fe39ef5eef92a0e0e
-  data.tar.gz: 14da519c15b02a8f18e6b2b949dbac0310792c6d86c4c2ad55fae62f35af667b1bc689b1f0cc1a8564229186f23119767390e347c8b3b1e7d4ecc15456d42566
+  metadata.gz: b8ce590ae60e8ac526c04ac42f62c8235dfc4ea05ff762735dc7339c694272aabab6602aac95be592ee7291ac9247ff24cfc9f362133cb61068adbac2699b9da
+  data.tar.gz: 0862ee6272e546779e1b1332d4b6071211611f157f3a2acff2a096abb9cdabf4d58f526077ba079ddc922a912f0ec90ca540eb59f5e9105c77477cc9d6c95124

data/bookbinder.gemspec

@@ -2,7 +2,7 @@ require 'base64'
 
 Gem::Specification.new do |s|
   s.name        = 'bookbindery'
-  s.version     = '8.5.0'
+  s.version     = '9.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', 'Andrew Bruce', 'Frank Kotsianas', 'Elena Sharma', 'Christa Hartsock', 'Michael Trestman', 'Alpha Chen', 'Sarah McAlear', 'Gregg Van Hove']

data/lib/bookbinder/cli.rb

@@ -1,11 +1,16 @@
 require 'thor'
-require 'ansi/code'
 
 require_relative 'ingest/git_accessor'
-require_relative 'legacy/cli'
+require_relative 'streams/colorized_stream'
+require_relative 'colorizer'
+require_relative 'commands/collection'
 
 module Bookbinder
   class CLI < Thor
+    def self.exit_on_failure?
+      true
+    end
+
     map '--version' => :version
     map '--help' => :help
 
@@ -22,95 +27,71 @@ module Bookbinder
 
     desc 'generate <book_name>', 'Generate a skeleton book that can be bound with "bookbinder bind"'
     def generate(book_name)
-      run_legacy_cli('generate', book_name)
-    end
-
-    desc 'build_and_push_tarball', 'Create a tarball from the final_app directory and push to the S3 bucket specified in your credentials.yml'
-    def build_and_push_tarball
-      print_deploy_deprecation_message
-      run_legacy_cli('build_and_push_tarball')
+      code = legacy_commands.generate(book_name)
+      raise Thor::Error, '' if code != 0
     end
 
     desc 'bind <local|remote> [--verbose] [--dita-flags=\"<dita-option>=<value>\"]', 'Bind the sections specified in config.yml from <local> or <remote> into the final_app directory'
     option :verbose, type: :boolean
     option 'dita-flags'
     def bind(source)
-      args = ['bind', source]
-      args << '--verbose' if options[:verbose]
-      args << "--dita-flags=\\\"#{options['dita-flags']}\\\""
-      run_legacy_cli(*args)
-    end
-
-    desc 'push_local_to <environment>', 'Push the contents of final_app to the specified environment using the credentials.yml'
-    def push_local_to(environment)
-      print_deploy_deprecation_message
-      run_legacy_cli('push_local_to', environment)
-    end
-
-    desc 'push_to_prod [build_#]', 'Push latest or <build_#> from your S3 bucket to the production host specified in credentials.yml'
-    def push_to_prod(build_num=nil)
-      print_deploy_deprecation_message
-      args = ['push_to_prod', build_num].compact
-      run_legacy_cli(*args)
-    end
-
-    desc 'run_publish_ci', 'Run publish, push_local_to staging, and build_and_push_tarball for CI purposes'
-    def run_publish_ci
-      print_deploy_deprecation_message
-      run_legacy_cli('run_publish_ci')
+      code = legacy_commands.bind(source, options[:verbose], options['dita-flags'])
+      raise Thor::Error, '' if code != 0
     end
 
     desc 'punch <git tag>', 'Apply the specified <git tag> to your book, sections, and layout repo'
     def punch(git_tag)
-      run_legacy_cli('punch', git_tag)
+      code = legacy_commands.punch(git_tag)
+      raise Thor::Error, '' if code != 0
     end
 
     desc 'update_local_doc_repos', 'Run `git pull` on all sections that exist at the same directory level as your book directory'
     def update_local_doc_repos
-      run_legacy_cli('update_local_doc_repos')
+      code = legacy_commands.update_local_doc_repos
+      raise Thor::Error, '' if code != 0
     end
 
     desc 'watch', 'Bind and serve a local book, watching for changes'
     def watch
-      run_legacy_cli('watch')
+      code = legacy_commands.watch
+      raise Thor::Error, '' if code != 0
     end
 
     desc 'imprint <local|remote> [--verbose] [--dita-flags=\"<dita-option>=<value>\"]', 'Generate a PDF for a given book'
     option :verbose, type: :boolean
     option 'dita-flags'
     def imprint(source)
-      args = ['imprint', source]
-      args << '--verbose' if options[:verbose]
-      args << "--dita-flags=\\\"#{options['dita-flags']}\\\""
-      run_legacy_cli(*args)
+      code = legacy_commands.imprint(source, options[:verbose], options['dita-flags'])
+      raise Thor::Error, '' if code != 0
+    end
+
+    def method_missing(command, *args)
+      puts "Unknown command '#{command}'"
+      puts ""
+      help
     end
 
     private
 
-    attr_reader :legacy_cli
+    attr_reader :legacy_commands
 
     def initialize(*)
       super
 
-      @legacy_cli = Legacy::Cli.new(Ingest::GitAccessor.new)
+      @legacy_commands = Bookbinder::Commands::Collection.new(colorized_streams, git)
     end
 
-    def run_legacy_cli(*args)
-      status = legacy_cli.run(args)
-      exit status unless status.zero?
+    def git
+      @git ||= Ingest::GitAccessor.new
     end
 
-    def print_deploy_deprecation_message
-      message = ANSI.red do
-        <<-EOM
-
-DEPRECATED: In a future version Bookbinder will no longer deploy to Cloud Foundry
-            The appropriate Concourse pipeline should be doing all deploys going forward.
-
-        EOM
-      end
-
-      puts message
+    def colorized_streams
+      @streams ||= {
+        err: Streams::ColorizedStream.new(Colorizer::Colors.red, $stderr),
+        out: $stdout,
+        success: Streams::ColorizedStream.new(Colorizer::Colors.green, $stdout),
+        warn: Streams::ColorizedStream.new(Colorizer::Colors.yellow, $stdout),
+      }
     end
   end
 end

data/lib/bookbinder/commands/bind.rb

@@ -1,13 +1,10 @@
 require 'middleman-syntax'
 
 require_relative 'components/command_options'
-require_relative 'naming'
 
 module Bookbinder
   module Commands
     class Bind
-      include Commands::Naming
-
       def initialize(base_streams,
                      output_locations: nil,
                      config_fetcher: nil,
@@ -33,21 +30,8 @@ module Bookbinder
         @directory_preparer = directory_preparer
       end
 
-      def usage
-        ["bind <local|remote> [--verbose] [--dita-flags=\\\"<dita-option>=<value>\\\"]",
-         "Bind the sections specified in config.yml from <local> or <remote> into the final_app directory"]
-      end
-
-      def command_for?(test_command_name)
-        %w(bind publish).include?(test_command_name)
-      end
-
-      def deprecated_command_for?(command_name)
-        %w(publish).include?(command_name)
-      end
-
-      def run(cli_arguments)
-        bind_options        = Components::CommandOptions.new(cli_arguments, base_streams).tap(&:validate!)
+      def run(bind_type, verbose = false, dita_flags = nil)
+        bind_options        = Components::CommandOptions.new([bind_type], base_streams, verbose)
         bind_config         = config_fetcher.fetch_config
         cloner              = cloner_factory.produce(bind_options.local_repo_dir)
 
@@ -69,7 +53,7 @@ module Bookbinder
         preprocessor.preprocess(
           sections,
           output_locations,
-          options: bind_options.options,
+          options: { dita_flags: dita_flags },
           output_streams: bind_options.streams,
           config: bind_config
         )

data/lib/bookbinder/commands/collection.rb

@@ -6,7 +6,6 @@ require_relative '../commands/components/bind/directory_preparer'
 require_relative '../commands/components/imprint/directory_preparer'
 require_relative '../config/configuration_decorator'
 require_relative '../config/fetcher'
-require_relative '../config/remote_yaml_credential_provider'
 require_relative '../config/validator'
 require_relative '../config/yaml_loader'
 require_relative '../config/configuration'
@@ -32,64 +31,37 @@ module Bookbinder
     class Collection
       include Enumerable
 
-      def initialize(logger, streams, version_control_system)
-        @logger = logger
+      def initialize(streams, version_control_system)
         @streams = streams
         @version_control_system = version_control_system
       end
 
-      def each(&block)
-        list.each(&block)
+      def generate(*args)
+        Commands::Generate.new(
+          local_filesystem_accessor,
+          sheller,
+          Dir.pwd,
+          streams
+        ).run(*args)
       end
 
-      def help
-        @help ||= Commands::Help.new(
-          logger,
-          [version] + standard_commands
-        )
-      end
-
-      private
-
-      attr_reader :logger, :streams, :version_control_system
-
-      def list
-        standard_commands + flags
-      end
-
-      def flags
-        @flags ||= [ version, help ]
-      end
-
-      def standard_commands
-        @standard_commands ||= [
-          Commands::Generate.new(
-            local_filesystem_accessor,
-            sheller,
-            Dir.pwd,
-            streams
-          ),
-          build_and_push_tarball,
-          bind,
-          push_local_to,
-          Commands::PushToProd.new(streams, logger, configuration_fetcher(Config::Configuration), Dir.mktmpdir),
-          Commands::RunPublishCI.new(bind, push_local_to, build_and_push_tarball),
-          Commands::Punch.new(streams, configuration_fetcher(Config::Configuration), version_control_system),
-          Commands::UpdateLocalDocRepos.new(
-            streams,
-            configuration_fetcher(Config::Configuration),
-            version_control_system
-          ),
-          watch,
-          imprint
-        ]
+      def punch(*args)
+        Commands::Punch.new(
+          streams,
+          configuration_fetcher(Config::Configuration),
+          version_control_system
+        ).run(*args)
       end
 
-      def version
-        @version ||= Commands::Version.new(logger)
+      def update_local_doc_repos
+        Commands::UpdateLocalDocRepos.new(
+          streams,
+          configuration_fetcher(Config::Configuration),
+          version_control_system
+        ).run
       end
 
-      def bind
+      def bind(*args)
         @bind ||= Commands::Bind.new(
           streams,
           output_locations: output_locations,
@@ -111,11 +83,7 @@ module Bookbinder
           cloner_factory: Ingest::ClonerFactory.new(streams, local_filesystem_accessor, version_control_system),
           section_repository: Ingest::SectionRepository.new,
           directory_preparer: directory_preparer
-        )
-      end
-
-      def dita_command_creator
-        DitaCommandCreator.new(ENV['PATH_TO_DITA_OT_LIBRARY'])
+        ).run(*args)
       end
 
       def watch
@@ -130,11 +98,11 @@ module Bookbinder
           cloner: local_file_system_cloner,
           section_repository: Ingest::SectionRepository.new,
           directory_preparer: directory_preparer
-        )
+        ).run
       end
 
-      def imprint
-        Commands::Imprint.new(
+      def imprint(*args)
+        Bookbinder::Commands::Imprint.new(
           streams,
           output_locations: output_locations,
           config_fetcher: configuration_fetcher(Config::Imprint::Configuration),
@@ -142,29 +110,21 @@ module Bookbinder
           cloner_factory: Ingest::ClonerFactory.new(streams, local_filesystem_accessor, version_control_system),
           section_repository: Ingest::SectionRepository.new,
           directory_preparer: Commands::Components::Imprint::DirectoryPreparer.new(local_filesystem_accessor)
-        )
+        ).run(*args)
       end
 
-      def push_local_to
-        @push_local_to ||= Commands::PushFromLocal.new(
-          streams,
-          logger,
-          configuration_fetcher(Config::Configuration)
-        )
-      end
+      private
 
-      def build_and_push_tarball
-        @build_and_push_tarball ||= Commands::BuildAndPushTarball.new(
-          streams,
-          configuration_fetcher(Config::Configuration)
-        )
+      attr_reader :streams, :version_control_system
+
+      def dita_command_creator
+        DitaCommandCreator.new(ENV['PATH_TO_DITA_OT_LIBRARY'])
       end
 
       def configuration_fetcher(config_class)
-        Config::Fetcher.new(
-          Config::Validator.new(local_filesystem_accessor),
+        Bookbinder::Config::Fetcher.new(
+          Bookbinder::Config::Validator.new(local_filesystem_accessor),
           config_loader,
-          Config::RemoteYamlCredentialProvider.new(logger, version_control_system),
           config_class
         ).tap do |fetcher|
           fetcher.set_config_file_path './config.yml'

data/lib/bookbinder/commands/components/command_options.rb

@@ -7,13 +7,10 @@ module Bookbinder
   module Commands
     module Components
       class CommandOptions
-        def initialize(opts, base_streams)
+        def initialize(opts, base_streams, verbose = false)
           @opts = opts
           @base_streams = base_streams
-        end
-
-        def validate!
-          raise CliError::InvalidArguments unless arguments_are_valid?
+          @verbosity = verbose
         end
 
         def bind_source
@@ -39,25 +36,9 @@ module Bookbinder
           )
         end
 
-        def verbosity
-          options.detect {|arg| arg == '--verbose'}
-        end
-
         private
 
-        attr_accessor :base_streams, :opts
-
-        def arguments_are_valid?
-          %w(local remote github).include?(bind_source) && flag_names.subset?(valid_options)
-        end
-
-        def valid_options
-          %w(--verbose --ignore-section-refs --dita-flags).to_set
-        end
-
-        def flag_names
-          options.map {|o| o.split('=').first}.to_set
-        end
+        attr_accessor :base_streams, :opts, :verbosity
       end
     end
   end

data/lib/bookbinder/commands/generate.rb

@@ -3,8 +3,6 @@ require 'bundler'
 module Bookbinder
   module Commands
     class Generate
-      include Commands::Naming
-
       def initialize(fs, sheller, context_dir, streams)
         @fs = fs
         @sheller = sheller
@@ -12,15 +10,6 @@ module Bookbinder
         @streams = streams
       end
 
-      def command_for?(name)
-        name == 'generate'
-      end
-
-      def usage
-        ["generate <book-name>",
-         "Generate a skeleton book that can be bound with 'bookbinder bind'"]
-      end
-
       def run((name))
         path = context_dir.join(name)
         streams[:out].puts "Generating book at #{path}…"

data/lib/bookbinder/commands/imprint.rb

@@ -1,11 +1,8 @@
 require_relative 'components/command_options'
-require_relative 'naming'
 
 module Bookbinder
   module Commands
     class Imprint
-      include Commands::Naming
-
       def initialize(base_streams,
                      output_locations: nil,
                      config_fetcher: nil,
@@ -23,12 +20,8 @@ module Bookbinder
         @directory_preparer = directory_preparer
       end
 
-      def usage
-        ["imprint <local|remote> [--verbose] [--dita-flags=\\\"<dita-option>=<value>\\\"]", "Generate a PDF for a given book"]
-      end
-
-      def run(cli_arguments)
-        options        = Components::CommandOptions.new(cli_arguments, base_streams).tap(&:validate!)
+      def run(bind_type, verbose = false, dita_flags = nil)
+        options        = Components::CommandOptions.new([bind_type], base_streams, verbose)
         config         = config_fetcher.fetch_config
         cloner         = cloner_factory.produce(options.local_repo_dir)
 
@@ -45,7 +38,7 @@ module Bookbinder
         preprocessor.preprocess(
           sections,
           output_locations,
-          options: options.options,
+          options: { dita_flags: dita_flags },
           output_streams: options.streams,
           config: config
         )