bookbindery 9.4.2 → 9.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aa865c7b991f92f4fa15398088468c1ccde53178
-  data.tar.gz: 6bcee44842644b0da4edabe3ebd061073c324242
+  metadata.gz: a7fb273894d32de11b696ffd383b8d55ded9b612
+  data.tar.gz: 916e689fdca4e2386643bfe17b85fce557fb46df
 SHA512:
-  metadata.gz: 4a4c3941bd7ee1e34842824cc961be50789a9c1f914fb24f945fad96745cff027836d8d8a97c962933fc590e5d2607b6237b4006533be5b9741f36bcf7b66ca8
-  data.tar.gz: a21bef58bb16babc0584ee099a728b2f4648dd23061ebc6963da1536280afca982b3e65e29c5c596b1f3b5904897584882f517abd919803c34006ad9bde4def6
+  metadata.gz: 4b2e0f90300f0ac55df5d5c48945a03b7249a07fdc4f4723d5e005ef1af611814490b64117a95aea9d5fdab925bced0f9c94d338ec841d6658dbbd88e6e67b5d
+  data.tar.gz: 534dbb03ae216b40205e25e9fc4495f23dda3ab6d90fb3e36201ac25b9c9e57a20d976741e5dd226ff9061bc483426050bfe05bd6148350520a31d09913ce59a

data/bookbinder.gemspec

@@ -2,7 +2,7 @@ require 'base64'
 
 Gem::Specification.new do |s|
   s.name        = 'bookbindery'
-  s.version     = '9.4.2'
+  s.version     = '9.5.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/config/section_config.rb

@@ -65,13 +65,7 @@ module Bookbinder
 
       def product_info
         return '' if config['product_info'].nil?
-        {'use_local_header' => config['product_info']['use_local_header'],
-          'latest_stable_version' => config['product_info']['latest_stable_version'],
-          'changelog_href' => config['product_info']['changelog_href'],
-          'local_header_img' => config['product_info']['local_header_img'],
-          'local_header_title' => config['product_info']['local_header_title'],
-          'local_header_links' => config['product_info']['local_header_links'],
-          'local_header_version_list' => config['product_info']['local_header_version_list']}
+        config['product_info']
       end
 
       private

data/lib/bookbinder/subnav/json_from_markdown_toc.rb

@@ -21,9 +21,15 @@ module Bookbinder
 
         root = absolute_source_from_path(Pathname(config.subnav_root))
 
-        raise SubnavRootMissingError.new('Subnav root not found at: ' + config.subnav_root) if root.nil?
+        if root.nil?
+          if @require_valid_subnav_links
+            raise SubnavRootMissingError.new('Subnav root not found at: ' + config.subnav_root)
+          else
+            return {links: []}.to_json
+          end
+        end
 
-        @parsed_files = { Pathname(root) => '(root)'}
+        @parsed_files = {Pathname(root) => '(root)'}
 
         {links: gather_urls_and_texts(root)}.to_json
       end
@@ -54,14 +60,24 @@ module Bookbinder
           next_source = absolute_source_from_path(expanded_href)
           nested_links = {}
 
-          if @require_valid_subnav_links
-            raise SubnavBrokenLinkError.new(<<-ERROR) unless next_source
-Broken link found in subnav for product_id: #{config.id}
+          no_children = false
+          no_children ||= validate_no_broken_link(expanded_href, next_source, source)
+          no_children ||= validate_no_duplicate_link(expanded_href, next_source, source)
 
-Link: #{expanded_href}
-Source file: #{source}
-            ERROR
-            raise SubnavDuplicateLinkError.new(<<-ERROR) if @parsed_files.has_key?(next_source)
+          unless no_children
+            @parsed_files[next_source] = source
+            nested_urls_and_texts = gather_urls_and_texts(next_source)
+            nested_links.merge!(nestedLinks: nested_urls_and_texts) unless nested_urls_and_texts.empty?
+          end
+
+          {url: '/' + expanded_href.to_s, text: element.inner_text}.merge(nested_links)
+        end
+      end
+
+      def validate_no_duplicate_link(expanded_href, next_source, source)
+        if @parsed_files.has_key?(next_source)
+          if @require_valid_subnav_links
+            raise SubnavDuplicateLinkError.new(<<-ERROR)
 )
 Duplicate link found in subnav for product_id: #{config.id}
 
@@ -69,14 +85,27 @@ Link: #{expanded_href}
 Original file: #{@parsed_files[next_source]}
 Current file: #{source}
             ERROR
-
-            @parsed_files[next_source] = source
-            nested_urls_and_texts = gather_urls_and_texts(next_source)
-            nested_links.merge!(nestedLinks: nested_urls_and_texts) unless nested_urls_and_texts.empty?
+          else
+            no_children = true
           end
+        end
+        no_children
+      end
 
-          {url: '/' + expanded_href.to_s, text: element.inner_text}.merge(nested_links)
+      def validate_no_broken_link(expanded_href, next_source, source)
+        unless next_source
+          if @require_valid_subnav_links
+            raise SubnavBrokenLinkError.new(<<-ERROR)
+Broken link found in subnav for product_id: #{config.id}
+
+Link: #{expanded_href}
+Source file: #{source}
+            ERROR
+          else
+            no_children = true
+          end
         end
+        no_children
       end
 
       def nav_items(base_node)

data/template_app/lib/search/handler.rb

@@ -15,9 +15,10 @@ module Bookbinder
       end
 
       def call(request_env)
-        results = query.search(extract_query_params(request_env['QUERY_STRING']))
+        query = Query.new(extract_query_params(request_env['QUERY_STRING']))
+        query.get_results(client_class.new(url: elasticsearch_url))
 
-        [200, {'Content-Type' => 'text/html'}, [renderer.render_results(results)]]
+        [200, {'Content-Type' => 'text/html'}, [renderer.render_results(query)]]
       rescue Exception => e
         puts e.message
         puts e.backtrace.join("\n")
@@ -41,10 +42,6 @@ module Bookbinder
       def elasticsearch_url
         @elasticsearch_url ||= JSON.parse(environment['VCAP_SERVICES'])['searchly'][0]['credentials']['uri']
       end
-
-      def query
-        Query.new(client_class.new(url: elasticsearch_url))
-      end
     end
   end
 end

data/template_app/lib/search/query.rb

@@ -1,41 +1,74 @@
 require 'yaml'
 
-require_relative 'result'
+require_relative 'hit'
 
 module Bookbinder
   module Search
     class Query
-      def initialize(client)
-        @client = client
-      end
+      attr_reader :search_term, :product_name, :product_version, :page_number, :result_list, :result_count, :last_page, :page_window
 
-      def search(params)
-        query = params.fetch('q', '')
+      def initialize(params)
+        @search_term = params.fetch('q', '')
+        @product_name = params.fetch('product_name', nil)
+        @product_version = @product_name && params.fetch('product_version', nil)
+        @page_number = @search_term == '' ? 1 : [params['page'].to_i, 1].max
+      end
 
-        return Result.new(query, 0, [], 1) if query == ''
+      def query_options
+        options = YAML.load_file(File.expand_path('../../../search.yml', __FILE__))
 
-        page_number = [params['page'].to_i, 1].max
+        options['from'] = (page_number - 1) * 10
+        options['query']['bool']['should']['query_string']['query'] = search_term
 
-        query_options = YAML.load_file(File.expand_path('../../../search.yml', __FILE__))
+        unless product_name.nil?
+          filters = [{
+            'term' => { 'product_name' => product_name }
+          }]
 
-        query_options['from'] = (page_number - 1) * 10
-        query_options['query']['query_string']['query'] = query
+          unless product_version.nil?
+            filters << {'term' => { 'product_version' => product_version }}
+          end
 
-        results = client.search index: 'searching', body: query_options
+          options['query']['bool']['filter'] = {
+            'bool' => {
+              'must' => filters
+            }
+          }
+        end
 
-        Result.new(
-          query,
-          results['hits']['total'],
-          results['hits']['hits'],
-          page_number
-        )
+        options
+      end
 
+      def get_results(elasticsearch_client)
+        if search_term == ''
+          @result_count = 0
+          @result_list = []
+          @last_page = 1
+        else
+          results = elasticsearch_client.search index: 'searching', body: query_options
+          @result_count = results['hits']['total']
+          @result_list = results['hits']['hits'].map { |h| Hit.new(h) }
+          @last_page = (result_count / 10.0).ceil
+        end
+        @page_window = calculate_page_window
       end
 
       private
 
-      attr_reader :client
+      def calculate_page_window
+        window_start = [page_number - 2, 1].max
+        window_end = [window_start + 4, last_page].min
+        window = (window_start .. window_end).to_a
 
+        if window.length < 5 && window.last == last_page && window.first != 1
+          window.unshift(window.first - 1)
+          if window.length < 5
+            window.unshift(window.first - 1)
+          end
+        end
+
+        window
+      end
     end
   end
 end

data/template_app/search-results.html.erb

@@ -1,17 +1,31 @@
 <div class="search-results">
   <form method="get">
-    <input name="q" value="<%= query %>"/>
+
+    <% unless product_name.nil? %>
+      <h4 style="border: 1px solid #ccc; padding: 4px 20px;">
+        Filtering by: <%= product_name %>
+        <% unless product_version.nil? %>and <%= product_version %>
+        <% end %>
+      </h4>
+    <% end %>
+    <input name="q" value="<%= search_term %>"/>
+    <% unless product_name.nil? %>
+      <input type="hidden" name="product_name" value="<%= product_name %>"/>
+    <% end %>
+    <% unless product_version.nil? %>
+      <input type="hidden" name="product_version" value="<%= product_version %>"/>
+    <% end %>
   </form>
 
-  <% if hit_count == 0 %>
+  <% if result_count == 0 %>
     <div class="no-results">No Results</div>
   <% else %>
     <div class="result-summary">
-      Showing <%= (page_number - 1) * 10 + 1 %> to <%= [(page_number - 1) * 10 + 10, hit_count].min %> of <%= hit_count %> results.
+      Showing <%= (page_number - 1) * 10 + 1 %> to <%= [(page_number - 1) * 10 + 10, result_count].min %> of <%= result_count %> results.
     </div>
 
     <ul class="search-results-list">
-      <% hits.each do |hit| %>
+      <% result_list.each do |hit| %>
         <li>
           <a href="<%= hit.url %>"><%= hit.title %></a>
           <div><%= hit.text %></div>
@@ -20,19 +34,22 @@
     </ul>
 
     <div class="pagination">
+      <% search_query = "/search?q=#{ search_term }" %>
+      <% search_query << "&product_name=#{ product_name }" unless product_name.nil? %>
+      <% search_query << "&product_version=#{ product_version }" unless product_version.nil? %>
       <% if page_number == 1 %>
         <span class="disabled page first">First</span>
         <span class="disabled page previous">Prev</span>
       <% else %>
-        <a class="page first" href="/search?q=<%= query %>">First</a>
-        <a class="page previous" href="/search?q=<%= query %>&page=<%= page_number - 1 %>">Prev</a>
+        <a class="page first" href="<%= search_query %>">First</a>
+        <a class="page previous" href="<%= search_query %>&page=<%= page_number - 1 %>">Prev</a>
       <% end %>
 
       <% page_window.each do |page| %>
         <% if page == page_number %>
           <span class="current page"><%= page %></span>
         <% else %>
-          <a class="page" href="/search?q=<%= query %>&page=<%= page %>"><%= page %></a>
+          <a class="page" href="<%= search_query %>&page=<%= page %>"><%= page %></a>
         <% end %>
       <% end %>
 
@@ -40,8 +57,8 @@
         <span class="disabled page next">Next</span>
         <span class="disabled page last">Last</span>
       <% else %>
-        <a class="page next" href="/search?q=<%= query %>&page=<%= page_number + 1 %>">Next</a>
-        <a class="page last" href="/search?q=<%= query %>&page=<%= last_page %>">Last</a>
+        <a class="page next" href="<%= search_query %>&page=<%= page_number + 1 %>">Next</a>
+        <a class="page last" href="<%= search_query %>&page=<%= last_page %>">Last</a>
       <% end %>
     </div>
   <% end %>

data/template_app/search.yml

@@ -1,8 +1,11 @@
 ---
 query:
-  query_string:
-    query: ''
-    default_field: text
+  bool:
+    should:
+      query_string:
+        query: ''
+        default_field: text
+    minimum_should_match: 1
 from: 0
 size: 10
 _source:

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bookbindery
 version: !ruby/object:Gem::Version
-  version: 9.4.2
+  version: 9.5.0
 platform: ruby
 authors:
 - Mike Grafton
@@ -22,7 +22,7 @@ authors:
 autorequire: 
 bindir: install_bin
 cert_chain: []
-date: 2016-05-10 00:00:00.000000000 Z
+date: 2016-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fog-aws
@@ -416,7 +416,6 @@ files:
 - template_app/lib/search/hit.rb
 - template_app/lib/search/query.rb
 - template_app/lib/search/renderer.rb
-- template_app/lib/search/result.rb
 - template_app/lib/server.rb
 - template_app/mail_sender.rb
 - template_app/rack_app.rb

data/template_app/lib/search/result.rb

@@ -1,35 +0,0 @@
-require_relative 'hit'
-
-module Bookbinder
-  module Search
-    class Result
-      def initialize(query, hit_count, raw_hits, page_number)
-        @query = query
-        @hit_count = hit_count
-        @hits = raw_hits.map { |h| Hit.new(h) }
-        @page_number = page_number
-        @last_page = (hit_count / 10.0).ceil
-        @page_window = calculate_page_window
-      end
-
-      attr_reader :query, :hit_count, :hits, :page_number, :last_page, :page_window
-
-      private
-
-      def calculate_page_window
-        window_start = [page_number - 2, 1].max
-        window_end = [window_start + 4, last_page].min
-        window = (window_start .. window_end).to_a
-
-        if window.length < 5 && window.last == last_page && window.first != 1
-          window.unshift(window.first - 1)
-          if window.length < 5
-            window.unshift(window.first - 1)
-          end
-        end
-
-        window
-      end
-    end
-  end
-end