bookbindery 9.9.0 → 9.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d3e9b9d9984fdb5afedfa756024384d4a9bf9e5b
-  data.tar.gz: 9cdf1c79a329c48f0811bfa4f418d17f7ec5a8e9
+  metadata.gz: 99c1606223bcc841a9f5c9abd0f8bb3df7212e13
+  data.tar.gz: f92ba6323770d66d4f00db7194535ff46bac06e3
 SHA512:
-  metadata.gz: aab7f18000c610ea0fb322f403ebc2c3703b734fb3ff6867f260bf4666e375bf76564a12465a199205c8a5392f787c2ec8c686e37f15fe3fb53c46eb2924a43b
-  data.tar.gz: 55271d726387b9e4108c0519373c31eb26ff4e05e5e4166585c933f7d59f201442ba825fba387b2b121341514a1e372660a88e381bea513b7b35beca0e02fd0c
+  metadata.gz: 04376d1753d497e4b55ef42960ef90948de5a106d7706d296e8c225081e54b7b4e73cea9ee1c85e8791a4ce849a3c3563e9d623f95fe0c36b55aeadbd7ee47d1
+  data.tar.gz: 58d72ca85fda5c537c48da63752c041c1785da464b77e7928cfb34e4c289e1e4e1153d58eca3710a10f75d73ea7e98a95a7570ec4c12951b846d29f0c9dcdd30

data/bookbinder.gemspec

@@ -2,7 +2,7 @@ require 'base64'
 
 Gem::Specification.new do |s|
   s.name        = 'bookbindery'
-  s.version     = '9.9.0'
+  s.version     = '9.10.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

@@ -52,9 +52,15 @@ module Bookbinder
       raise Thor::Error, '' if code != 0
     end
 
-    desc 'watch', 'Bind and serve a local book, watching for changes'
-    def watch
-      code = legacy_commands.watch
+    desc 'watch [repo1 [repo2]]', 'Bind and serve a local book, watching for changes'
+    long_desc <<-LONG_DESC
+Bind and serve a local book, watching for changes
+
+Optionally, you can provide a subset of the repositories in the book to be watched.
+This will exclude any repositories not specified from being available in the bound book, even if they exist on your file system.
+    LONG_DESC
+    def watch(*repos)
+      code = legacy_commands.watch(repos)
       raise Thor::Error, '' if code != 0
     end
 

data/lib/bookbinder/commands/collection.rb

@@ -64,11 +64,11 @@ module Bookbinder
       def bind(*args)
         @bind ||= Commands::Bind.new(
           streams,
+          middleman_runner: runner,
           output_locations: output_locations,
           config_fetcher: configuration_fetcher(Config::Configuration),
           config_decorator: Config::ConfigurationDecorator.new(loader: config_loader, config_filename: 'bookbinder.yml'),
           file_system_accessor: local_filesystem_accessor,
-          middleman_runner: runner,
           broken_links_checker: Postprocessing::BrokenLinksChecker.build(final_app_directory, sitemap_port),
           preprocessor: Preprocessing::Preprocessor.new(
             Preprocessing::DitaHTMLPreprocessor.new(
@@ -86,7 +86,7 @@ module Bookbinder
         ).run(*args)
       end
 
-      def watch
+      def watch(repos=[])
         @watch ||= Commands::Watch.new(
           streams,
           middleman_runner: runner,
@@ -97,7 +97,8 @@ module Bookbinder
           preprocessor: Preprocessing::Preprocessor.new(Preprocessing::LinkToSiteGenDir.new(local_filesystem_accessor, subnav_generator_factory)),
           cloner: local_file_system_cloner,
           section_repository: Ingest::SectionRepository.new,
-          directory_preparer: directory_preparer
+          directory_preparer: directory_preparer,
+          repo_restrictions: repos
         ).run
       end
 

data/lib/bookbinder/commands/watch.rb

@@ -10,7 +10,8 @@ module Bookbinder
                      preprocessor: nil,
                      cloner: nil,
                      section_repository: nil,
-                     directory_preparer: nil)
+                     directory_preparer: nil,
+                     repo_restrictions: [])
         @streams = streams
         @middleman_runner = middleman_runner
         @output_locations = output_locations
@@ -21,6 +22,7 @@ module Bookbinder
         @cloner = cloner
         @section_repository = section_repository
         @directory_preparer = directory_preparer
+        @repo_restrictions = repo_restrictions
       end
 
       def run
@@ -33,7 +35,7 @@ module Bookbinder
           cloner
         )
         sections = section_repository.fetch(
-          configured_sections: watch_config.sections,
+          configured_sections: filter_sections(watch_config.sections),
           destination_dir: output_locations.cloned_preprocessing_dir,
           cloner: cloner,
           streams: streams
@@ -84,6 +86,15 @@ module Bookbinder
         end
         temp
       end
+
+      def filter_sections(section_configs)
+        return section_configs if @repo_restrictions.nil? || @repo_restrictions.empty?
+
+        section_configs.select do |config|
+          repo_name = (config.repo_name || '').split('/').last
+          @repo_restrictions.include?(repo_name)
+        end
+      end
     end
   end
 end

data/lib/bookbinder/spider.rb

@@ -42,8 +42,7 @@ Found #{@broken_links.count} broken links!
     def find_broken_links(port, broken_link_exclusions: /(?!.*)/)
       temp_host = "localhost:#{port}"
       sieve = Sieve.new domain: "http://#{temp_host}"
-      links = crawl_from "http://#{temp_host}#{ENV['CUSTOM_ROOT']}/index.html", sieve
-      broken_links = links.first
+      broken_links = crawl_from "http://#{temp_host}#{ENV['CUSTOM_ROOT']}/index.html", sieve
       public_broken_links = broken_links.reject {|l| l.match(broken_link_exclusions)}
 
       Result.new(public_broken_links)
@@ -55,22 +54,20 @@ Found #{@broken_links.count} broken links!
 
     def crawl_from(url, sieve)
       broken_links = []
-      sitemap = [url]
       2.times do |i|
         is_first_pass = (i==0)
 
-        Anemone.crawl(url) do |anemone|
+        Anemone.crawl(url, discard_page_bodies: true) do |anemone|
           dont_visit_fragments(anemone)
           anemone.on_every_page do |page|
             broken, working = sieve.links_from(Stabilimentum.new(page), is_first_pass)
             broken_links.concat broken
-            sitemap.concat working
           end
         end
       end
 
       broken_links.concat Dir.chdir(@app_dir) { CssLinkChecker.new.broken_links_in_all_stylesheets }
-      [broken_links.compact.uniq, sitemap.compact.uniq]
+      broken_links.compact.uniq
     end
 
     def dont_visit_fragments(anemone)

data/lib/bookbinder/subnav/template_creator.rb

@@ -1,4 +1,5 @@
 require 'erb'
+require 'rack/utils'
 
 module Bookbinder
   module Subnav
@@ -60,6 +61,10 @@ module Bookbinder
         def links?(links)
           (links || []).empty?
         end
+
+        def escape_html(str)
+          Rack::Utils.escape_html(str)
+        end
       end
     end
   end

data/master_middleman/source/subnavs/_nav-links.erb

@@ -2,7 +2,7 @@
   <ul>
     <% @links.each do |link| %>
       <li class="<%= submenu_class(link) %>">
-        <a href="<%= link[:url] %>"><%= link[:text] %></a>
+        <a href="<%= link[:url] %>"><%= escape_html link[:text] %></a>
         <%= render_links link[:nested_links] %>
       </li>
     <% end %>

data/template_app/lib/search/hit.rb

@@ -8,7 +8,11 @@ module Bookbinder
         @product_name = source_fields['product_name']
         @product_version = source_fields['product_version']
 
-        @text = attrs.fetch('highlight').fetch('text').first.strip
+        if attrs.has_key?('highlight')
+          @text = attrs.fetch('highlight').fetch('text').first.strip
+        else
+          @text = source_fields.fetch('summary')
+        end
       end
 
       attr_reader :title, :url, :text, :product_name, :product_version

data/template_app/search-results.html.erb

@@ -1,3 +1,9 @@
+<%
+def escape_html(str)
+  Rack::Utils.escape_html(str)
+end
+%>
+
 <div class="search-results">
   <form method="get">
 
@@ -8,12 +14,12 @@
         <% end %>
       </h4>
     <% end %>
-    <input name="q" value="<%= search_term %>"/>
+    <input name="q" value="<%= escape_html search_term %>"/>
     <% unless product_name.nil? %>
-      <input type="hidden" name="product_name" value="<%= product_name %>"/>
+      <input type="hidden" name="product_name" value="<%= escape_html product_name %>"/>
     <% end %>
     <% unless product_version.nil? %>
-      <input type="hidden" name="product_version" value="<%= product_version %>"/>
+      <input type="hidden" name="product_version" value="<%= escape_html product_version %>"/>
     <% end %>
   </form>
 

data/template_app/search.yml

@@ -13,6 +13,7 @@ size: 10
 _source:
 - url
 - title
+- summary
 - product_name
 - product_version
 highlight:

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bookbindery
 version: !ruby/object:Gem::Version
-  version: 9.9.0
+  version: 9.10.0
 platform: ruby
 authors:
 - Mike Grafton
@@ -22,7 +22,7 @@ authors:
 autorequire: 
 bindir: install_bin
 cert_chain: []
-date: 2016-06-10 00:00:00.000000000 Z
+date: 2016-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fog-aws