bookbindery 7.5.0 → 8.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0dd2c6b574a77666001273739f0136dd0465e51c
-  data.tar.gz: 854939e21e33cc8bd187f2b7560966d3b0698cb0
+  metadata.gz: 1a0d33f4425ffc7d20e10ef7d4db181383434597
+  data.tar.gz: 9e46a1a8c6a91b3c204b337c11db14b49b4297d6
 SHA512:
-  metadata.gz: a56e6c5664b07e1b6bc862bc21ad716b299999a36baed3889fec5aa227ca8d8c962e3e71dd0281f6bd677dbdc64ff77e154d53ac6597658e7c2c27f3aa32208a
-  data.tar.gz: 863e5303ef86d674eba079dd486278e7e11e44f143140b858c8743c2567e31afe73db57315c1946b63b3a159222e460840648b0cbe4cc9a9fd83fb366b62c0cd
+  metadata.gz: 64b3f89db50a12afb1d050d5a993c630061a46c158113a318508546e825da51e1b66d0e96bf3da7c92f9276d781a2e69655f1b2adcad8cf61c98d638e50d9ccf
+  data.tar.gz: a62cd292cbaa71a015a02d39f6cc88cdeab30f5f3837c72e05e874720b87c38dbc7b8f972e784680ab1b111b635cb8df042ccb0648afca9528ee41751d1e802a

data/bookbinder.gemspec

@@ -2,7 +2,7 @@ require 'base64'
 
 Gem::Specification.new do |s|
   s.name        = 'bookbindery'
-  s.version     = '7.5.0'
+  s.version     = '8.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', 'Michael Trestman']
@@ -29,11 +29,11 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'rack-rewrite'
   s.add_runtime_dependency 'therubyracer'
   s.add_runtime_dependency 'git', '~> 1.2.8'
-  s.add_runtime_dependency 'sendgrid-ruby'
   s.add_runtime_dependency 'nokogiri', ['1.6.7.2']
 
   s.add_development_dependency 'license_finder'
   s.add_development_dependency 'pry-byebug'
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec'
+  s.add_development_dependency 'sendgrid-ruby'
 end

data/lib/bookbinder/commands/collection.rb

@@ -71,10 +71,9 @@ module Bookbinder
           ),
           build_and_push_tarball,
           bind,
-          Commands::PushFromLocal.new(streams, logger, configuration_fetcher(Config::Configuration), 'acceptance'),
-          push_local_to_staging,
+          push_local_to,
           Commands::PushToProd.new(streams, logger, configuration_fetcher(Config::Configuration), Dir.mktmpdir),
-          Commands::RunPublishCI.new(bind, push_local_to_staging, build_and_push_tarball),
+          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,
@@ -146,12 +145,11 @@ module Bookbinder
         )
       end
 
-      def push_local_to_staging
-        @push_local_to_staging ||= Commands::PushFromLocal.new(
+      def push_local_to
+        @push_local_to ||= Commands::PushFromLocal.new(
           streams,
           logger,
-          configuration_fetcher(Config::Configuration),
-          'staging'
+          configuration_fetcher(Config::Configuration)
         )
       end
 

data/lib/bookbinder/commands/push_from_local.rb

@@ -12,19 +12,19 @@ module Bookbinder
       REQUIRED_AWS_KEYS = %w(access_key secret_key green_builds_bucket)
       REQUIRED_CF_KEYS = %w(username password api_endpoint organization app_name)
 
-      def initialize(streams, logger, configuration_fetcher, environment)
+      def initialize(streams, logger, configuration_fetcher)
         @streams = streams
         @logger = logger
         @configuration_fetcher = configuration_fetcher
-        @environment = environment
       end
 
       def usage
-        [command_name,
-         "Push the contents of final_app to the #{environment} host specified in credentials.yml"]
+        ["push_local_to <environment>",
+         "Push the contents of final_app to the specified environment using the credentials.yml"]
       end
 
-      def run(_)
+      def run(cli_arguments)
+        @environment = cli_arguments.first
         validate
         deployment = Deploy::Deployment.new(
           app_dir: './final_app',
@@ -50,6 +50,10 @@ module Bookbinder
 
       attr_reader :configuration_fetcher, :environment, :streams
 
+      def command_name
+        'push_local_to'
+      end
+
       def config
         configuration_fetcher.fetch_config
       end
@@ -58,10 +62,6 @@ module Bookbinder
         configuration_fetcher.fetch_credentials(environment)
       end
 
-      def command_name
-        "push_local_to_#{environment}"
-      end
-
       def creds_error_message
         <<-ERROR
 Cannot locate a specific key in credentials.yml.

data/lib/bookbinder/commands/run_publish_ci.rb

@@ -12,26 +12,26 @@ module Bookbinder
 
       def usage
         [command_name,
-         "Run publish, push_local_to_staging, and build_and_push_tarball for CI purposes"]
+         "Run publish, push_local_to staging, and build_and_push_tarball for CI purposes"]
       end
 
-      def initialize(publish_command, push_local_to_staging_command, build_and_push_tarball_command)
+      def initialize(publish_command, push_local_to_command, build_and_push_tarball_command)
         @publish_command = publish_command
-        @push_local_to_staging_command = push_local_to_staging_command
+        @push_local_to_command = push_local_to_command
         @build_and_push_tarball_command = build_and_push_tarball_command
       end
 
       def run(cli_args)
         command_chain(
           ->{publish_command.run(['remote'] + cli_args)},
-          ->{push_local_to_staging_command.run([])},
+          ->{push_local_to_command.run(['staging'])},
           ->{build_and_push_tarball_command.run([])}
         )
       end
 
       private
 
-      attr_reader :publish_command, :push_local_to_staging_command, :build_and_push_tarball_command
+      attr_reader :publish_command, :push_local_to_command, :build_and_push_tarball_command
     end
   end
 end

data/lib/bookbinder/config/cf_credentials.rb

@@ -23,7 +23,7 @@ module Bookbinder
       end
 
       def routes
-        fetch(host_key) if correctly_formatted_domain_and_routes?(host_key)
+        fetch('host') if correctly_formatted_domain_and_routes?
       end
 
       def flat_routes
@@ -31,25 +31,21 @@ module Bookbinder
       end
 
       def space
-        fetch(space_key)
+        fetch('space')
       end
 
       private
 
       attr_reader :creds, :environment
 
-      def production?
-        environment == 'production'
-      end
-
       def fetch(key)
-        creds.fetch(key)
+        creds.fetch('env').fetch(environment).fetch(key)
       rescue KeyError => e
         raise CredentialKeyError, e
       end
 
-      def correctly_formatted_domain_and_routes?(deploy_environment)
-        routes_hash = fetch(deploy_environment)
+      def correctly_formatted_domain_and_routes?
+        routes_hash = fetch('host')
         domains = routes_hash.keys
         domains.each { |domain| correctly_formatted_domain?(domain, routes_hash) }
       end
@@ -61,14 +57,6 @@ module Bookbinder
         raise "Hosts in credentials must be nested as an array under the desired domain #{domain}." unless routes_hash[domain].is_a? Array
         raise "Did you mean to provide a hostname for the domain #{domain}? Check your credentials.yml." if routes_hash[domain].any?(&:nil?)
       end
-
-      def host_key
-        "#{environment}_host"
-      end
-
-      def space_key
-        "#{environment}_space"
-      end
     end
   end
 end

data/lib/bookbinder/config/checkers/products_checker.rb

@@ -0,0 +1,49 @@
+module Bookbinder
+  module Config
+    module Checkers
+      class ProductsChecker
+        MissingRequiredKeyError = Class.new(RuntimeError)
+        MissingProductsKeyError = Class.new(RuntimeError)
+        MissingProductIdError = Class.new(RuntimeError)
+
+        def check(config)
+          @config = config
+
+          if section_product_ids.count > 0
+            if config.products.empty?
+               MissingProductsKeyError.new('You must specify at least one product under the products key in config.yml')
+            elsif missing_products.count != 0
+              MissingProductIdError.new("Your config.yml is missing required product id under the products key. Required product ids are #{missing_products.join(", ")}.")
+            elsif invalid_products.any?
+              MissingRequiredKeyError.new("Your config.yml is missing required key(s) for products #{invalid_product_ids}. Required keys are #{required_product_keys.join(", ")}.")
+            end
+          end
+        end
+
+        attr_reader :config
+
+        private
+
+        def invalid_products
+          config.products.map {|product_config| product_config unless product_config.valid? }
+        end
+
+        def invalid_product_ids
+          invalid_products.map(&:id).join(', ')
+        end
+
+        def missing_products
+          section_product_ids - config.products.map(&:id)
+        end
+
+        def required_product_keys
+          Bookbinder::Config::ProductConfig::CONFIG_REQUIRED_KEYS
+        end
+
+        def section_product_ids
+          config.sections.map(&:product_id).compact.uniq
+        end
+      end
+    end
+  end
+end

data/lib/bookbinder/config/checkers/{topics_checker.rb → subnav_topics_checker.rb}

@@ -1,14 +1,14 @@
 module Bookbinder
   module Config
     module Checkers
-      class TopicsChecker
+      class SubnavTopicsChecker
         MissingRequiredKeyError = Class.new(RuntimeError)
 
         def check(config)
           @config = config
 
-          if invalid_subnavs.any?
-            MissingRequiredKeyError.new("Your config.yml is missing required key(s) for subnav(s) #{invalid_subnav_names}. Required keys are #{required_topic_keys.join(", ")}.")
+          if invalid_products.any?
+            MissingRequiredKeyError.new("Your config.yml is missing required key(s) for subnav_topics in product id(s) #{invalid_product_ids}. Required keys are #{required_topic_keys.join(", ")}.")
           end
         end
 
@@ -16,16 +16,16 @@ module Bookbinder
 
         private
 
-        def invalid_subnavs
-          config.subnavs.select { |subnav_config| invalid_topics(subnav_config.topics).any? }
+        def invalid_products
+          config.products.select { |product_config| invalid_topics(product_config.subnav_topics).any? }
         end
 
         def invalid_topics(topics)
           topics.map {|topic| topic unless topic.valid? }
         end
 
-        def invalid_subnav_names
-          invalid_subnavs.map(&:subnav_name).join(', ')
+        def invalid_product_ids
+          invalid_products.map(&:id).join(', ')
         end
 
         def required_topic_keys

data/lib/bookbinder/config/configuration.rb

@@ -2,7 +2,7 @@ require_relative '../../../lib/bookbinder/config/dita_config_generator'
 require_relative '../ingest/destination_directory'
 require_relative '../ingest/repo_identifier'
 require_relative 'section_config'
-require_relative 'subnav_config'
+require_relative 'product_config'
 
 module Bookbinder
   module Config
@@ -53,7 +53,7 @@ module Bookbinder
 
       def initialize(config)
         @config = config
-        @subnavs = assemble_subnavs || []
+        @products = assemble_products || []
       end
 
       CONFIG_REQUIRED_KEYS = %w(book_repo public_host)
@@ -97,15 +97,15 @@ module Bookbinder
 
       alias_method :eql?, :==
 
-      attr_reader :subnavs
+      attr_reader :products
 
       private
 
-      def assemble_subnavs
-        if config[:subnavs]
-          config[:subnavs].map do |subnav|
-            subnav.merge!({'subnav_exclusions' => subnav_exclusions})
-            Config::SubnavConfig.new(subnav)
+      def assemble_products
+        if config[:products]
+          config[:products].map do |product|
+            product.merge!({'subnav_exclusions' => subnav_exclusions})
+            Config::ProductConfig.new(product)
           end
         end
       end

data/lib/bookbinder/config/{subnav_config.rb → product_config.rb}

@@ -2,14 +2,14 @@ require_relative '../config/topic_config'
 
 module Bookbinder
   module Config
-    class SubnavConfig
+    class ProductConfig
       def initialize(config)
         @config = config
-        @topics = assemble_topics || []
+        @subnav_topics = assemble_topics || []
       end
 
-      def subnav_name
-        config['name']
+      def id
+        config['id']
       end
 
       def pdf_config
@@ -20,20 +20,25 @@ module Bookbinder
         config['subnav_exclusions'] || []
       end
 
+      def specifies_subnav?
+        !subnav_topics.empty?
+      end
+
       def valid?
         (CONFIG_REQUIRED_KEYS - config.keys).empty?
       end
 
-      CONFIG_REQUIRED_KEYS = %w(name topics)
+      CONFIG_REQUIRED_KEYS = %w(id subnav_topics)
 
-      attr_reader :topics
+      attr_reader :subnav_topics
+      alias_method :subnav_name, :id
 
       private
 
       attr_reader :config
 
       def assemble_topics
-        config['topics'].map{|topic| Config::TopicConfig.new(topic)} if config['topics']
+        config['subnav_topics'].map{|topic| Config::TopicConfig.new(topic)} if config['subnav_topics']
       end
     end
   end

data/lib/bookbinder/config/section_config.rb

@@ -11,8 +11,8 @@ module Bookbinder
         config['subnav_template']
       end
 
-      def subnav_name
-        config['subnav_name']
+      def product_id
+        config['product_id']
       end
 
       def desired_directory_name
@@ -60,6 +60,7 @@ module Bookbinder
       def inspect
         config.inspect
       end
+      alias_method :subnav_name, :product_id
 
       private
 

data/lib/bookbinder/config/validator.rb

@@ -4,8 +4,8 @@ require_relative 'checkers/required_keys_checker'
 require_relative 'checkers/repository_name_presence_checker'
 require_relative 'checkers/ditamap_presence_checker'
 require_relative 'checkers/section_presence_checker'
-require_relative 'checkers/subnavs_checker'
-require_relative 'checkers/topics_checker'
+require_relative 'checkers/products_checker'
+require_relative 'checkers/subnav_topics_checker'
 
 module Bookbinder
   module Config
@@ -22,8 +22,8 @@ module Bookbinder
           Checkers::SectionPresenceChecker.new,
           Checkers::DitamapPresenceChecker.new,
           Checkers::ArchiveMenuChecker.new(@file_system_accessor),
-          Checkers::SubnavsChecker.new,
-          Checkers::TopicsChecker.new
+          Checkers::ProductsChecker.new,
+          Checkers::SubnavTopicsChecker.new
         ].map do |checker|
           checker.check(config)
         end

data/lib/bookbinder/ingest/git_accessor.rb

@@ -103,7 +103,7 @@ module Bookbinder
         if dest_dir.exist?
           Git.open(dest_dir)
         else
-          Git.clone(url, name, path: path)
+          Git.clone(url, name, path: path, recursive: true)
         end
       end
     end

data/lib/bookbinder/preprocessing/link_to_site_gen_dir.rb

@@ -21,8 +21,8 @@ module Bookbinder
           )
         end
 
-        config.subnavs.each do |subnav|
-          subnav_generator.generate(subnav)
+        config.products.each do |product|
+          subnav_generator.generate(product)
         end
       end
 

data/lib/bookbinder/subnav/json_from_markdown_toc.rb

@@ -24,7 +24,7 @@ module Bookbinder
       def get_links_and_headers
         menu_items = []
 
-        config.topics.map do |topic|
+        config.subnav_topics.map do |topic|
           menu_items << { text: topic.title, title: true }
           menu_items << { url: "/#{topic.toc_path}.html", text: topic.toc_nav_name }
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bookbindery
 version: !ruby/object:Gem::Version
-  version: 7.5.0
+  version: 8.0.0
 platform: ruby
 authors:
 - Mike Grafton
@@ -18,7 +18,7 @@ authors:
 autorequire: 
 bindir: install_bin
 cert_chain: []
-date: 2016-02-16 00:00:00.000000000 Z
+date: 2016-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fog-aws
@@ -216,20 +216,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.2.8
-- !ruby/object:Gem::Dependency
-  name: sendgrid-ruby
-  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: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -300,6 +286,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: sendgrid-ruby
+  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
@@ -340,19 +340,19 @@ files:
 - lib/bookbinder/config/checkers/archive_menu_checker.rb
 - lib/bookbinder/config/checkers/ditamap_presence_checker.rb
 - lib/bookbinder/config/checkers/duplicate_section_name_checker.rb
+- lib/bookbinder/config/checkers/products_checker.rb
 - lib/bookbinder/config/checkers/repository_name_presence_checker.rb
 - lib/bookbinder/config/checkers/required_keys_checker.rb
 - lib/bookbinder/config/checkers/section_presence_checker.rb
-- lib/bookbinder/config/checkers/subnavs_checker.rb
-- lib/bookbinder/config/checkers/topics_checker.rb
+- lib/bookbinder/config/checkers/subnav_topics_checker.rb
 - lib/bookbinder/config/configuration.rb
 - lib/bookbinder/config/configuration_decorator.rb
 - lib/bookbinder/config/dita_config_generator.rb
 - lib/bookbinder/config/fetcher.rb
 - lib/bookbinder/config/imprint/configuration.rb
+- lib/bookbinder/config/product_config.rb
 - lib/bookbinder/config/remote_yaml_credential_provider.rb
 - lib/bookbinder/config/section_config.rb
-- lib/bookbinder/config/subnav_config.rb
 - lib/bookbinder/config/topic_config.rb
 - lib/bookbinder/config/validator.rb
 - lib/bookbinder/config/yaml_loader.rb

data/lib/bookbinder/config/checkers/subnavs_checker.rb

@@ -1,49 +0,0 @@
-module Bookbinder
-  module Config
-    module Checkers
-      class SubnavsChecker
-        MissingRequiredKeyError = Class.new(RuntimeError)
-        MissingSubnavsKeyError = Class.new(RuntimeError)
-        MissingSubnavNameError = Class.new(RuntimeError)
-
-        def check(config)
-          @config = config
-
-          if section_subnav_names.count > 0
-            if config.subnavs.empty?
-               MissingSubnavsKeyError.new("You must specify at least one subnav under the subnavs key in config.yml")
-            elsif missing_subnavs.count != 0
-              MissingSubnavNameError.new("Your config.yml is missing required subnav names under the subnavs key. Required subnav names are #{missing_subnavs.join(", ")}.")
-            elsif invalid_subnavs.any?
-              MissingRequiredKeyError.new("Your config.yml is missing required key(s) for subnavs #{invalid_subnav_names}. Required keys are #{required_subnav_keys.join(", ")}.")
-            end
-          end
-        end
-
-        attr_reader :config
-
-        private
-
-        def invalid_subnavs
-          config.subnavs.map {|subnav_config| subnav_config unless subnav_config.valid? }
-        end
-
-        def invalid_subnav_names
-          invalid_subnavs.map(&:subnav_name).join(", ")
-        end
-
-        def missing_subnavs
-          section_subnav_names - config.subnavs.map(&:subnav_name)
-        end
-
-        def required_subnav_keys
-          Bookbinder::Config::SubnavConfig::CONFIG_REQUIRED_KEYS
-        end
-
-        def section_subnav_names
-          config.sections.map(&:subnav_name).compact.uniq
-        end
-      end
-    end
-  end
-end