bookbindery 9.0.0 → 9.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 11c7ab2f100519423aa8e8b3d7f209bb53f800ff
-  data.tar.gz: 8b95f5075fb79af6b8e9dbe4f21ffccdcd84e30d
+  metadata.gz: d5e7b71a753cfd7cbb99c11b2beb2d43cf7fea1e
+  data.tar.gz: ea6520b8bea5845c849ca53a1623c04d3279fbaa
 SHA512:
-  metadata.gz: b8ce590ae60e8ac526c04ac42f62c8235dfc4ea05ff762735dc7339c694272aabab6602aac95be592ee7291ac9247ff24cfc9f362133cb61068adbac2699b9da
-  data.tar.gz: 0862ee6272e546779e1b1332d4b6071211611f157f3a2acff2a096abb9cdabf4d58f526077ba079ddc922a912f0ec90ca540eb59f5e9105c77477cc9d6c95124
+  metadata.gz: 6b3f3af6783dc22bb73b7deb0df1a1f7f5339dcee1630a9a87afb4e68db954f24d87c996c7e1e59065ff3a554b87551770b8be081c82924d5c67404d756f57ee
+  data.tar.gz: 573b1a2f0262ff4a3c72e89b275e97a32e6c3acb20cdde45636320f43b11d3af0df7110e97456aa1f7ab697f98c9aa8ed7113e11046812819a60ee5968a9f237

data/bookbinder.gemspec

@@ -2,7 +2,7 @@ require 'base64'
 
 Gem::Specification.new do |s|
   s.name        = 'bookbindery'
-  s.version     = '9.0.0'
+  s.version     = '9.2.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']
@@ -14,7 +14,7 @@ Gem::Specification.new do |s|
   s.bindir      = 'install_bin'
   s.executable  = 'bookbinder'
 
-  s.required_ruby_version = '~> 2.3.0'
+  s.required_ruby_version = '~> 2.0.0'
   s.add_runtime_dependency 'fog-aws', ['~> 0.7.1']
   s.add_runtime_dependency 'ansi', ['~> 1.4']
   s.add_runtime_dependency 'middleman', ['~> 3.4.0']
@@ -30,6 +30,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'git', '~> 1.2.8'
   s.add_runtime_dependency 'nokogiri', ['1.6.7.2']
   s.add_runtime_dependency 'thor'
+  s.add_runtime_dependency 'elasticsearch'
 
   s.add_development_dependency 'license_finder'
   s.add_development_dependency 'pry-byebug'

data/lib/bookbinder/commands/generate.rb

@@ -10,13 +10,13 @@ module Bookbinder
         @streams = streams
       end
 
-      def run((name))
+      def run(name, special_bookbinder_gem_args={})
         path = context_dir.join(name)
         streams[:out].puts "Generating book at #{path}…"
         if fs.file_exist?(path)
           streams[:err].puts "Cannot generate book: directory already exists"
           1
-        elsif install(path).success?
+        elsif install(path, special_bookbinder_gem_args).success?
           streams[:success].puts "Successfully generated book at #{path}"
           0
         else
@@ -28,9 +28,9 @@ module Bookbinder
 
       attr_reader :fs, :sheller, :streams
 
-      def install(path)
+      def install(path, special_bookbinder_gem_args)
         make_middleman_dir(path)
-        init_gemfile(path)
+        init_gemfile(path, special_bookbinder_gem_args)
         init_config(path)
         init_index(path)
         bundle_install(path)
@@ -40,12 +40,19 @@ module Bookbinder
         fs.make_directory(path.join('master_middleman/build'))
       end
 
-      def init_gemfile(path)
+      def init_gemfile(path, special_bookbinder_gem_args)
+        bookbinder_config = ''
+
+        unless special_bookbinder_gem_args.empty?
+          config = special_bookbinder_gem_args.first
+          bookbinder_config = ", #{config.first}: \"#{config.last}\""
+        end
+
         fs.write(
           text: <<-GEMFILE,
 source "https://rubygems.org"
 
-gem "bookbindery"
+gem "bookbindery"#{bookbinder_config}
           GEMFILE
           to: path.join('Gemfile')
         )

data/lib/bookbinder/config/configuration.rb

@@ -91,6 +91,10 @@ module Bookbinder
         !!config[key.to_sym]
       end
 
+      def elastic_search?
+        config.fetch(:elastic_search, false)
+      end
+
       def ==(o)
         o.class == self.class && o.instance_variable_get(:@config) == @config
       end

data/lib/bookbinder/local_filesystem_accessor.rb

@@ -94,9 +94,9 @@ module Bookbinder
     end
 
     def find_files_extension_agnostically(pattern, directory='.')
-      extensionless_pattern = pattern.to_s.split('.').first
+      extensionless_pattern = File.join(File.dirname(pattern), File.basename(pattern).split('.').first)
 
-      `find -L #{directory} -path '*/#{extensionless_pattern}.*'`.
+      `find -L #{directory} -path '*/#{extensionless_pattern}.*' -type f`.
         lines.
         map(&:chomp).
         map(&Pathname.method(:new))

data/lib/bookbinder/middleman_runner.rb

@@ -29,7 +29,8 @@ module Bookbinder
           feedback_enabled: config.feedback_enabled,
           repo_link_enabled: config.repo_link_enabled,
           repo_links: config.repo_links,
-          product_info: product_info
+          product_info: product_info,
+          elastic_search: config.elastic_search?
         }
 
         fs.write(to: "bookbinder_config.yml", text: YAML.dump(config))

data/master_middleman/bookbinder_helpers.rb

@@ -39,6 +39,10 @@ module Bookbinder
         snippet.prepend("#{delimiter}#{language}\n").concat("\n#{delimiter}")
       end
 
+      def elastic_search?
+        !!config[:elastic_search]
+      end
+
       def yield_for_subnav
         partial "subnavs/#{subnav_template_name}"
       end

data/template_app/Gemfile

@@ -7,3 +7,4 @@ gem 'rack-rewrite'
 gem 'puma'
 gem 'therubyracer'
 gem 'sendgrid-ruby'
+gem 'elasticsearch'

data/template_app/Gemfile.lock

@@ -1,10 +1,19 @@
 GEM
   remote: http://rubygems.org/
   specs:
+    elasticsearch (1.0.17)
+      elasticsearch-api (= 1.0.17)
+      elasticsearch-transport (= 1.0.17)
+    elasticsearch-api (1.0.17)
+      multi_json
+    elasticsearch-transport (1.0.17)
+      faraday
+      multi_json
     faraday (0.9.2)
       multipart-post (>= 1.2, < 3)
     libv8 (3.16.14.7)
     mimemagic (0.3.0)
+    multi_json (1.11.2)
     multipart-post (2.0.0)
     puma (3.3.0)
     rack (1.5.2)
@@ -23,6 +32,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  elasticsearch
   puma
   rack
   rack-rewrite

data/template_app/lib/search.rb

@@ -0,0 +1,93 @@
+require 'elasticsearch'
+require 'yaml'
+require 'erb'
+
+module Bookbinder
+  module Search
+    def self.call(env)
+      search_data = search(get_search_query(env['QUERY_STRING']), get_page_number(env['QUERY_STRING']))
+
+      erb = ERB.new(File.read(File.expand_path('../../search-results.html.erb', __FILE__)))
+
+      [200, {'Content-Type' => 'text/html'}, [search_data.render(erb)]]
+    rescue Exception => e
+      puts e.message
+      puts e.backtrace.join("\n")
+
+      [500, {'Content-Type' => 'text/plain'}, ['An error occurred']]
+    end
+
+    def self.search(query, page_number)
+      return Result.new(query, 0, [], 1) if query == ''
+
+      query_options = YAML.load_file(File.expand_path('../../search.yml', __FILE__))
+      query_options['from'] = (page_number - 1) * 10
+      query_options['query']['query_string']['query'] = query
+
+      results = search_client.search index: 'searching', body: query_options
+
+      Result.new(
+        query,
+        results['hits']['total'],
+        results['hits']['hits'],
+        page_number
+      )
+    end
+
+    def self.get_search_query(query_string)
+      q_param = query_string.split('&').detect { |s| s =~ /\Aq=/ }
+
+      return '' if q_param.nil?
+
+      q_param.split('=')[1] || ''
+    end
+
+    def self.get_page_number(query_string)
+      q_param = query_string.split('&').detect { |s| s =~ /\Apage=/ }
+
+      return 1 if q_param.nil?
+
+      q_param.split('=')[1].to_i || 1
+    end
+
+    def self.search_client
+      Elasticsearch::Client.new url: JSON.parse(ENV['VCAP_SERVICES'])['searchly'][0]['credentials']['uri']
+    end
+
+    Result = Struct.new(:query, :result_count, :search_results, :page_number) do
+      def render(erb)
+        bind = binding
+        render_layout do
+          erb.result(bind)
+        end
+      end
+
+      def last_page
+        (result_count / 10.0).ceil
+      end
+
+      def 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
+
+      def render_layout
+        ERB.new(self.class.layout_content).result(binding)
+      end
+
+      def self.layout_content
+        File.read(File.expand_path('../../public/search.html', __FILE__))
+      end
+    end
+  end
+end

data/template_app/rack_app.rb

@@ -1,6 +1,7 @@
 require 'rack'
 require 'rack/rewrite'
 require_relative './lib/server'
+require_relative './lib/search'
 
 module Bookbinder
   class RackApp
@@ -21,6 +22,9 @@ module Bookbinder
           use MailFeedback, client
           run Bookbinder::NotFound.new('public/404.html')
         end
+        map '/search' do
+          run Bookbinder::Search
+        end
         if ENV['CUSTOM_ROOT']
           map ENV['CUSTOM_ROOT'] do
             run Bookbinder::Server

data/template_app/search-results.html.erb

@@ -0,0 +1,48 @@
+<div class="search-results">
+  <form method="get">
+    <input name="q" value="<%= query %>"/>
+  </form>
+
+  <% 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, result_count].min %> of <%= result_count %> results.
+    </div>
+
+    <ul class="search-results-list">
+      <% search_results.each do |result| %>
+        <li>
+          <a href="<%= result['_source']['url'] %>"><%= result['_source']['title'] %></a>
+          <div><%= result['highlight']['text'].first.strip %></div>
+        </li>
+      <% end %>
+    </ul>
+
+    <div class="pagination">
+      <% 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>
+      <% 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>
+        <% end %>
+      <% end %>
+
+      <% if page_number == last_page %>
+        <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>
+      <% end %>
+    </div>
+  <% end %>
+</div>

data/template_app/search.yml

@@ -0,0 +1,14 @@
+---
+query:
+  query_string:
+    query: ''
+    default_field: text
+from: 0
+size: 10
+_source:
+- url
+- title
+highlight:
+  fields:
+    text:
+      type: plain

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bookbindery
 version: !ruby/object:Gem::Version
-  version: 9.0.0
+  version: 9.2.0
 platform: ruby
 authors:
 - Mike Grafton
@@ -22,7 +22,7 @@ authors:
 autorequire: 
 bindir: install_bin
 cert_chain: []
-date: 2016-04-14 00:00:00.000000000 Z
+date: 2016-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fog-aws
@@ -234,6 +234,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: elasticsearch
+  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: license_finder
   requirement: !ruby/object:Gem::Requirement
@@ -398,9 +412,12 @@ files:
 - template_app/Gemfile.lock
 - template_app/config.ru
 - template_app/lib/rack_static_if_exists.rb
+- template_app/lib/search.rb
 - template_app/lib/server.rb
 - template_app/mail_sender.rb
 - template_app/rack_app.rb
+- template_app/search-results.html.erb
+- template_app/search.yml
 homepage: https://github.com/pivotal-cf/bookbinder
 licenses:
 - MIT
@@ -413,7 +430,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - "~>"
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -421,7 +438,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.3
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Markdown to Rackup application documentation generator