bookbindery 7.3.0 → 7.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 88ea31dee49567678221b2f7ec08271dbee24d4d
-  data.tar.gz: dc7bc2856531c909147a8c215466e4ca78f29224
+  metadata.gz: 6fbb90bb60080378f6d5e9080fa9739307cc1f73
+  data.tar.gz: 7f59d507842d42be00fd7084ef8764ca50415fe1
 SHA512:
-  metadata.gz: 7edb2efc47d478fa5908c40ad733bcfd1ab73b56af875dcbbc00c49768c6356f544b1c4ff5e378e3c9ff8623a598d8628c3e53d81d8ead55a023a0e42791054c
-  data.tar.gz: 5899419c8b5cd1ab847ba3dd9d556f2dbc68a4fc832deb1536b306fae063fe6bfe28705dccb894c5175d342c85bb4593025e54f0ce45eb4edebcd63ef691ea42
+  metadata.gz: 0c374ea381928402b7acf3b9bbbcd3958e8696ef6377d5207250f855e056ef11f3c9903a415b7f879771ad1932dcb4b711726b3ea9c06b2c80e60ddd647a396b
+  data.tar.gz: 1d1c6a97884de5e8bb5ce86829c43d40bdccf7e17a3b128cec15ad703b04e31369712312b053727980d3f496e30e9c3494d73ba884d6f6ff9815737cd6a77258

data/bookbinder.gemspec

@@ -2,10 +2,10 @@ require 'base64'
 
 Gem::Specification.new do |s|
   s.name        = 'bookbindery'
-  s.version     = '7.3.0'
+  s.version     = '7.4.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']
+  s.authors     = ['Mike Grafton', 'Lucas Marks', 'Gavin Morgan', 'Nikhil Gajwani', 'Dan Wendorf', 'Brenda Chan', 'Matthew Boedicker', 'Frank Kotsianas', 'Elena Sharma', 'Christa Hartsock', 'Michael Trestman']
   s.email       = Base64.decode64('Z21vcmdhbkBnb3Bpdm90YWwuY29t') # Gavin's
 
   s.files       = Dir['lib/**/*'] + Dir['template_app/**/*'] + Dir['master_middleman/**/*'] + Dir['install_bin/**/*'] + Dir['bookbinder.gemspec']

data/lib/bookbinder/commands/collection.rb

@@ -3,7 +3,7 @@ Dir.glob(File.expand_path('../../commands/*.rb', __FILE__)).each do |command_fil
 end
 
 require_relative '../commands/bind/directory_preparer'
-require_relative '../config/archive_menu_configuration'
+require_relative '../config/configuration_decorator'
 require_relative '../config/fetcher'
 require_relative '../config/remote_yaml_credential_provider'
 require_relative '../config/validator'
@@ -90,7 +90,7 @@ module Bookbinder
           streams,
           output_locations,
           configuration_fetcher,
-          Config::ArchiveMenuConfiguration.new(loader: config_loader, config_filename: 'bookbinder.yml'),
+          Config::ConfigurationDecorator.new(loader: config_loader, config_filename: 'bookbinder.yml'),
           local_filesystem_accessor,
           runner,
           Postprocessing::SitemapWriter.build(logger, final_app_directory, sitemap_port),
@@ -116,7 +116,7 @@ module Bookbinder
           middleman_runner: runner,
           output_locations: output_locations,
           config_fetcher: configuration_fetcher,
-          config_decorator: Config::ArchiveMenuConfiguration.new(loader: config_loader, config_filename: 'bookbinder.yml'),
+          config_decorator: Config::ConfigurationDecorator.new(loader: config_loader, config_filename: 'bookbinder.yml'),
           file_system_accessor: local_filesystem_accessor,
           preprocessor: Preprocessing::Preprocessor.new(Preprocessing::LinkToSiteGenDir.new(local_filesystem_accessor, subnav_generator_factory)),
           cloner: local_file_system_cloner,

data/lib/bookbinder/config/configuration.rb

@@ -66,7 +66,7 @@ module Bookbinder
       end
 
       CONFIG_REQUIRED_KEYS = %w(book_repo public_host)
-      CONFIG_OPTIONAL_KEYS = %w(archive_menu book_repo_url cred_repo cred_repo_url layout_repo layout_repo_ref layout_repo_url sections subnav_exclusions feedback_enabled)
+      CONFIG_OPTIONAL_KEYS = %w(archive_menu book_repo_url cred_repo cred_repo_url repo_link_enabled repo_links feedback_enabled layout_repo layout_repo_ref layout_repo_url sections subnav_exclusions)
 
       CONFIG_REQUIRED_KEYS.each do |method_name|
         define_method(method_name) do

data/lib/bookbinder/config/{archive_menu_configuration.rb → configuration_decorator.rb}

@@ -2,7 +2,7 @@ require_relative 'configuration'
 
 module Bookbinder
   module Config
-    class ArchiveMenuConfiguration
+    class ConfigurationDecorator
       def initialize(loader: nil, config_filename: nil)
         @loader = loader
         @config_filename = config_filename
@@ -11,13 +11,29 @@ module Bookbinder
       def generate(base_config, sections)
         base_config.merge(
           Configuration.new(
-            archive_menu: root_config(base_config).merge(section_config(sections))))
+            repo_links: repo_link_config(base_config, sections),
+            archive_menu: root_config(base_config).merge(section_config(sections)))
+        )
       end
 
       private
 
       attr_reader :loader, :config_filename
 
+      def repo_link_config(base_config, sections)
+        if base_config.repo_link_enabled
+          sections.reduce({}) {|config, section|
+            config.merge(
+              section.desired_directory_name => {
+                'repo' => section.repo_name,
+                'ref' => section.source_ref,
+                'at_path' => section.at_repo_path
+              }
+            )
+          }
+        end
+      end
+
       def root_config(base_config)
         { '.' => base_config.archive_menu }
       end

data/lib/bookbinder/dita_html_for_middleman_formatter.rb

@@ -39,7 +39,7 @@ module Bookbinder
     end
 
     def revert_to_erb(text)
-      text.gsub('&lt;%', '<%').gsub('%&gt;', '%>')
+      text.gsub('&lt;%', '<%').gsub('%&gt;', '%>').gsub('&lt;\%', '&lt;%')
     end
   end
 end

data/lib/bookbinder/ingest/git_accessor.rb

@@ -62,11 +62,15 @@ module Bookbinder
         end
       end
 
-      def author_date(path)
+      def author_date(path, exclusion_flag: '[exclude]')
         Pathname(path).dirname.ascend do |current_dir|
           if current_dir.to_s.include?(source_dir_name) && current_dir.entries.include?(Pathname(".git"))
             git = Git.open(current_dir)
-            return git.gblob(path).log.first.author.date
+            logs = git.gblob(path).log
+
+            last_non_excluded_commit = logs.detect { |log| !log.message.include?(exclusion_flag) }
+
+            return last_non_excluded_commit.author.date
           end
         end
       end

data/lib/bookbinder/ingest/git_cloner.rb

@@ -24,6 +24,7 @@ module Bookbinder
         WorkingCopy.new(
           copied_to: copied_to,
           full_name: source_repo_name,
+          ref: source_ref
         )
       end
 

data/lib/bookbinder/ingest/missing_working_copy.rb

@@ -1,9 +1,10 @@
 module Bookbinder
   module Ingest
     class MissingWorkingCopy
-      def initialize(source_repo_name, source_dir)
+      def initialize(source_repo_name, source_dir, source_ref=nil)
         @source_repo_name = source_repo_name
-        @source_dir= source_dir
+        @source_dir = source_dir
+        @source_ref = source_ref
       end
 
       def full_name
@@ -14,6 +15,10 @@ module Bookbinder
         Pathname(@source_dir)
       end
 
+      def ref
+        @source_ref
+      end
+
       def available?
         false
       end

data/lib/bookbinder/ingest/section_repository.rb

@@ -32,7 +32,9 @@ module Bookbinder
             section_config.subnav_template,
             section_config.subnav_name,
             section_config.preprocessor_config,
-            section_config.at_repo_path
+            section_config.at_repo_path,
+            section_config.repo_name,
+            working_copy.ref
           )
         end
       end

data/lib/bookbinder/ingest/working_copy.rb

@@ -3,15 +3,17 @@ require_relative '../errors/programmer_mistake'
 module Bookbinder
   module Ingest
     class WorkingCopy
-      attr_reader :full_name
+      attr_reader :full_name, :ref
 
       def initialize(copied_to: nil,
-                     full_name: nil)
+                     full_name: nil,
+                     ref: nil)
         if [copied_to, full_name].none?
           raise Errors::ProgrammerMistake.new("Must provide copied_to and/or full_name to WorkingCopy.new")
         else
           @copied_to = copied_to
           @full_name = full_name
+          @ref = ref
         end
       end
 
@@ -24,9 +26,10 @@ module Bookbinder
       end
 
       def ==(other)
-        [@copied_to, @full_name] ==
+        [@copied_to, @full_name, @ref] ==
           [other.instance_variable_get(:@copied_to),
-           other.instance_variable_get(:@full_name)]
+           other.instance_variable_get(:@full_name),
+           other.instance_variable_get(:@ref)]
       end
     end
   end

data/lib/bookbinder/middleman_runner.rb

@@ -25,7 +25,9 @@ module Bookbinder
           template_variables: config.template_variables,
           local_repo_dir: local_repo_dir,
           workspace: output_locations.workspace_dir,
-          feedback_enabled: config.feedback_enabled
+          feedback_enabled: config.feedback_enabled,
+          repo_link_enabled: config.repo_link_enabled,
+          repo_links: config.repo_links
         }
         fs.write(to: "bookbinder_config.yml", text: YAML.dump(config))
         sheller.run_command({'MM_ROOT' => output_locations.master_dir.to_s},

data/lib/bookbinder/values/section.rb

@@ -8,7 +8,9 @@ module Bookbinder
                        :subnav_templ,
                        :desired_subnav_name,
                        :preprocessor_config,
-                       :at_repo_path) do
+                       :at_repo_path,
+                       :repo_name,
+                       :source_ref) do
     def path_to_repo_dir
       at_repo_path.nil? ? path_to_repository : path_to_repository.join(at_repo_path)
     end

data/master_middleman/bookbinder_helpers.rb

@@ -62,6 +62,16 @@ module Bookbinder
         partial 'layouts/feedback' if config[:feedback_enabled] && !current_page.metadata[:page][:feedback_disabled]
       end
 
+      def exclude_repo_link
+        current_page.add_metadata({page: {repo_link_disabled: true}})
+      end
+
+      def render_repo_link
+        if config[:repo_link_enabled] && !current_page.metadata[:page][:repo_link_disabled] && repo_url
+          "<a href='#{repo_url}'>View the source for this page in GitHub</a>"
+        end
+      end
+
       def mermaid_diagram(&blk)
         escaped_text = capture(&blk).gsub('-','\-')
 
@@ -112,6 +122,39 @@ module Bookbinder
         'NUMERIC_CLASS_PREFIX'
       end
 
+      def repo_url
+        nested_dir, filename = parse_out_nested_dir_and_filename
+        repo_dir = config[:repo_links].keys.select{|key| nested_dir.include? key }[0]
+        page_repo_config = config[:repo_links][repo_dir]
+
+        if page_repo_config && page_repo_config['ref']
+          at_path = at_path(page_repo_config)
+          ref = Pathname(page_repo_config['ref'])
+          org_repo = Pathname(page_repo_config['repo'])
+
+          nested_dir = extract_nested_directory(nested_dir, repo_dir)
+
+          "http://github.com/#{org_repo.join(Pathname('blob'), ref, Pathname(nested_dir), at_path, filename)}.md.erb"
+        end
+      end
+
+      def parse_out_nested_dir_and_filename
+        current_page.path.match(/\/?(.*?)\/?([^\/]*.html$?)/).captures
+      end
+
+      def extract_nested_directory(nested_dir, repo_dir)
+        nested_dir = nested_dir.gsub("#{repo_dir}", '')
+        nested_dir = nested_dir.sub('/', '') if nested_dir[0] == '/'
+
+        nested_dir
+      end
+
+      def at_path(page_repo_config)
+        path = page_repo_config['at_path'] || ""
+
+        Pathname(path)
+      end
+
       def add_ancestors_of(page, ancestors)
         if page
           add_ancestors_of(page.parent, ancestors + [page])

data/template_app/Gemfile

@@ -5,3 +5,4 @@ ruby '2.0.0'
 gem 'vienna'
 gem 'rack-rewrite'
 gem 'therubyracer'
+gem 'sendgrid-ruby'

data/template_app/Gemfile.lock

@@ -1,10 +1,19 @@
 GEM
   remote: http://rubygems.org/
   specs:
+    faraday (0.9.2)
+      multipart-post (>= 1.2, < 3)
     libv8 (3.16.14.7)
+    mimemagic (0.3.0)
+    multipart-post (2.0.0)
     rack (1.5.2)
     rack-rewrite (1.5.0)
     ref (1.0.5)
+    sendgrid-ruby (1.1.5)
+      faraday (~> 0.9)
+      mimemagic
+      smtpapi (~> 0.1)
+    smtpapi (0.1.0)
     therubyracer (0.12.1)
       libv8 (~> 3.16.14.0)
       ref
@@ -16,5 +25,9 @@ PLATFORMS
 
 DEPENDENCIES
   rack-rewrite
+  sendgrid-ruby
   therubyracer
   vienna
+
+BUNDLED WITH
+   1.10.6

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bookbindery
 version: !ruby/object:Gem::Version
-  version: 7.3.0
+  version: 7.4.0
 platform: ruby
 authors:
 - Mike Grafton
@@ -14,10 +14,11 @@ authors:
 - Frank Kotsianas
 - Elena Sharma
 - Christa Hartsock
+- Michael Trestman
 autorequire: 
 bindir: install_bin
 cert_chain: []
-date: 2015-11-11 00:00:00.000000000 Z
+date: 2015-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fog-aws
@@ -316,7 +317,6 @@ files:
 - lib/bookbinder/commands/update_local_doc_repos.rb
 - lib/bookbinder/commands/version.rb
 - lib/bookbinder/commands/watch.rb
-- lib/bookbinder/config/archive_menu_configuration.rb
 - lib/bookbinder/config/aws_credentials.rb
 - lib/bookbinder/config/cf_credentials.rb
 - lib/bookbinder/config/checkers/archive_menu_checker.rb
@@ -327,6 +327,7 @@ files:
 - lib/bookbinder/config/checkers/subnavs_checker.rb
 - lib/bookbinder/config/checkers/topics_checker.rb
 - lib/bookbinder/config/configuration.rb
+- lib/bookbinder/config/configuration_decorator.rb
 - lib/bookbinder/config/fetcher.rb
 - lib/bookbinder/config/remote_yaml_credential_provider.rb
 - lib/bookbinder/config/section_config.rb