bhook 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b8daa36a6bba5cff236d6bf93f33ff088d7baa4abb975fe372674c94746e3600
-  data.tar.gz: 499905877d932384d7cb982290ed6bfced51398b63a85ef3101a625783f2113b
+  metadata.gz: 90521640ce67d31a8e080b88cb860559033426b3afc55f1a03d09d42d0a415c5
+  data.tar.gz: f10067505bfdaa6c8e6bc4892340bd07d6937c0882b5472772f815705ca463ec
 SHA512:
-  metadata.gz: e7538dd31e1790aab7fabca99e652ff97752c52bd0afeb7ade8d42d517eee6bd2f6687e642c06b95afe4e51cc48724b84646f6f9ee5803d3a73ae9b23f64023e
-  data.tar.gz: 1d5aa665979f1be6f1ba0a96d7068622c782e604a1407a0757e6d254f538dde59507972e15412fcb7141d38f430ff0897c9e95ca8b3a6227b727f575d32bfb36
+  metadata.gz: ee03d8c7ea7a5e39db17acbf3638dcf53c3d2f37a55b897e6800ca24a0dde2efd4037806619438ea8097781a7c75e15de6a5a34bb25c7693cdd1b98f069f4193
+  data.tar.gz: 94bf726b2a6a3afb8490f172a01f992ea8bfd063a54ed2143b3ace48c644c15b93c5b5faf2a68f110b0a04a79bbed7b167846a60ec44e7bb206c1d24e5d5cfb3

data/.rubocop.yml

@@ -32,4 +32,5 @@ Metrics/BlockLength:
 Metrics/AbcSize:
   Exclude:
     - lib/bhook/args_parser.rb
+    - spec/**/*_spec.rb
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    bhook (0.2.0)
+    bhook (0.3.0)
       git (~> 1.10)
       kramdown (~> 2.3)
       listen (~> 3.7)

data/README.md

@@ -9,11 +9,15 @@
 
 Bhook is a static website generator that works off a git repo containing a markdown file based wiki, like for example, the [India Startup Wiki](https://gitlab.com/india-startups/wiki).
 
+Since you control the source markdown, Bhook applies no restrictions on what you can put in there. Wanna embed a YouTube video in an `iframe`? Sure thing!
+
 I use this to create [HTML versions of the wiki](https://sidu.in/wiki/startups) and of [my essays](https://sidu.in/essays/) that I can publish.
 
 ## Installation
 
-Install it yourself as:
+`bhook` requires [`ruby`](https://www.ruby-lang.org/en/documentation/installation/). If you are on OSX or Linux, it is likely to already be installed. 
+
+To install `bhook` run:
 
     $ gem install bhook
 
@@ -22,7 +26,7 @@ Install it yourself as:
 Getting help:
 
 	$ bhook --help
-	Bhook version 0.2.0
+	Bhook version 0.3.0
 	Usage: bhook --source /source/path --output /output/path
 	    -s, --source=SOURCE              Path to version controlled directory containing source md files
 	    -o, --output=OUTPUT              Path to directory where output files are to be generated
@@ -33,11 +37,20 @@ Getting help:
 	        --benchmark                  Run a performance benchmark for the specified source
 	    -h, --help                       Prints this help
 
-How I use it:
+### 1-to-1 mode
 
 	➜  essays git:(main) ✗ bhook -s . -o /tmp/out -t /tmp/out/theme -w -v
 
-Here's an example `.bhook.yml` [config file](https://gitlab.com/india-startups/wiki/-/blob/master/.bhook.yml).
+Here's an example `.bhook.yml` [config file](https://gitlab.com/india-startups/wiki/-/blob/master/.bhook.yml) for a source directory.
+
+### n-to-1 mode
+
+This requires the destination directory to have a `bhook.yml` config file set up that describes all the sources.
+
+	➜  kaiwren.github.com git:(main) ✗ bhook -w -v
+
+Here's an example `.bhook.yml` [config file](https://github.com/kaiwren/kaiwren.github.com/blob/master/.bhook.yml) for a destination directory
+with multiple source directories.
 
 ## Development
 

data/Rakefile

@@ -31,4 +31,4 @@ namespace :ci do
   task spec: %i[spec]
 end
 
-task default: %i[autocorrect_basic_style_issues rubocop sorbet spec]
+task default: %i[autocorrect_basic_style_issues sorbet spec rubocop]

data/bin/bhook

@@ -2,7 +2,7 @@
 # frozen_string_literal: true
 
 require 'bundler/setup'
-require 'bhook'
+require_relative File.join('..', 'lib', 'bhook')
 
 puts "Bhook version #{Bhook::VERSION}"
 parser = Bhook::ArgsParser.new(ARGV)
@@ -15,24 +15,35 @@ if args.help
   exit
 end
 
+Bhook::L.level = args.verbose ? Logger::DEBUG : Logger::INFO
+
 if args.generate_theme
   Bhook::L.level = Logger::DEBUG
   Bhook::ThemeGenerator.new(args.generate_theme).generate!
   exit
 end
 
-Bhook::L.level = args.verbose ? Logger::DEBUG : Logger::INFO
+workspaces = Bhook::Workspaces.new
 
-workspace = Bhook::Workspace.new(args.source, args.output, args.theme)
+if args.mount
+  args.mount.each do |project, from_to|
+    from = File.expand_path(from_to['from'])
+    to = File.expand_path(from_to['to'])
+    Bhook::L.debug "Mounting: #{project} \n\tfrom #{from} \n\tto #{to}"
+    workspaces.mount(Bhook::Workspace.new(from, to, args.theme))
+  end
+else
+  workspaces.mount(Bhook::Workspace.new(args.source, args.output, args.theme))
+end
 
 if args.benchmark
   require 'benchmark'
   n = 10
   Benchmark.bmbm do |bench|
     Bhook::L.level = Logger::WARN
-    bench.report("Generate HTML #{n} times") { n.times { workspace.process! } }
+    bench.report("Generate HTML #{n} times") { n.times { workspaces.each(&:process!) } }
   end
   exit
 end
 
-args.watch ? workspace.watch! : workspace.process!
+args.watch ? workspaces.watch! : workspaces.process!

data/lib/bhook/args_parser.rb

@@ -5,25 +5,29 @@ module Bhook
   class ArgsParser
     extend T::Sig
 
-    Options = Struct.new(:source, :output, :watch, :verbose, :theme, :generate_theme, :benchmark, :help)
+    Options = Struct.new(:source, :output, :watch, :verbose, :theme, :generate_theme, :benchmark, :mount, :help)
 
     def initialize(argv)
-      @args = Options.new(nil, nil, false, false, Bhook::THEME_DIR_PATH, nil, false, false)
+      @args = Options.new(nil, nil, false, false, Bhook::THEME_DIR_PATH, nil, false, nil, false)
       @argv = argv.clone
       @opt_parser = build_opt_parser
     end
 
     def parse
+      if (mount = detect_and_read_mount_args_from_config_in_pwd)
+        @args.mount = mount
+      end
+
       begin
         @opt_parser.parse(@argv)
-        if generate_theme_missing? && help_missing? && source_or_output_paths_missing?
+        if generate_theme_missing? && help_missing? &&
+           source_or_output_paths_missing? && mount_config_missing?
           raise OptionParser::MissingArgument, 'See --help.'
         end
       rescue OptionParser::ParseError => e
         puts "\nError! #{e.message}\n"
         return nil
       end
-
       @args
     end
 
@@ -33,6 +37,17 @@ module Bhook
 
     private
 
+    def detect_and_read_mount_args_from_config_in_pwd
+      bhook_config_path = File.join(Dir.pwd, Config::BHOOK_CONFIG_FILE)
+      return unless File.exist?(bhook_config_path)
+
+      YAML.safe_load(File.read(bhook_config_path))['mount']
+    end
+
+    def mount_config_missing?
+      !@args.mount
+    end
+
     def help_missing?
       !@args.help
     end

data/lib/bhook/converter/html.rb

@@ -24,21 +24,28 @@ module Bhook
 
       sig { params(el: Kramdown::Element, indent: Integer).returns(String) }
       def convert_header(el, indent)
-        header = super(el, indent)
         src_title = el.options[:raw_text]
         after_h1_html = @options[:after_h1_strategy].call(binding)
 
         level = output_header_level(el.options[:level])
         if level == 1
           @options[:h1_callback].call(src_title)
-          "#{header}#{' ' * indent}#{after_h1_html}"
+          "#{super(el, indent)}#{' ' * indent}#{after_h1_html}"
         else
-          header
+          insert_anchor_into_header!(el)
+          super(el, indent)
         end
       end
 
       private
 
+      sig { params(el: Kramdown::Element).void }
+      def insert_anchor_into_header!(el)
+        el.attr['id'] = generate_id(el.options[:raw_text]) if @options[:auto_ids] && !el.attr['id']
+        anchor = Kramdown::Element.new(:a, '', { 'href' => "##{el.attr['id']}", 'class' => 'header-anchor' })
+        el.children << anchor
+      end
+
       sig { params(href_path: String).returns(T::Boolean) }
       def valid_relative_md_link?(href_path)
         (href_path.end_with?('.md') || href_path.include?('.md#')) &&

data/lib/bhook/directory.rb

@@ -8,15 +8,15 @@ module Bhook
     GIT_DIR = '.git'
     MD_EXT = '.md'
 
-    sig { params(src_path: Pathname, out_path: Pathname).returns(Bhook::Directory) }
+    sig { params(src_path: Pathname, out_path: Pathname).returns(Bhook::RootDirectory) }
     def self.new_root_directory(src_path, out_path)
-      new(src_path, out_path, Git.open(src_path), Bhook::Config.new(src_path))
+      RootDirectory.new(src_path, out_path)
     end
 
     sig { params(src_path: Pathname, out_path: Pathname, git: Git::Base, config: Bhook::Config).void }
     def initialize(src_path, out_path, git, config)
       @src_path = src_path
-      @out_path = T.let(out_path.join(src_path.basename), Pathname)
+      @out_path = T.let(build_out_path(src_path, out_path), Pathname)
       @git = git
       @config = config
       @sub_dirs = T.let([], T::Array[Directory])
@@ -46,6 +46,11 @@ module Bhook
 
     private
 
+    sig { params(src_path: Pathname, out_path: Pathname).returns(Pathname) }
+    def build_out_path(src_path, out_path)
+      out_path.join(src_path.basename)
+    end
+
     sig { void }
     def build_next_level_nodes
       children = @src_path.children

data/lib/bhook/root_directory.rb

@@ -0,0 +1,20 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Bhook
+  class RootDirectory < Directory
+    extend T::Sig
+
+    sig { params(src_path: Pathname, out_path: Pathname).void }
+    def initialize(src_path, out_path)
+      super(src_path, out_path, Git.open(src_path), Bhook::Config.new(src_path))
+    end
+
+    private
+
+    sig { params(_src_path: Pathname, out_path: Pathname).returns(Pathname) }
+    def build_out_path(_src_path, out_path)
+      out_path
+    end
+  end
+end

data/lib/bhook/theme/page.erb

@@ -1,82 +1,128 @@
 <!DOCTYPE html>
 <html lang="en">
-  <head>
-    <meta charset="utf-8">
-    <meta http-equiv="X-UA-Compatible" content="IE=edge">
-    <meta name="viewport" content="width=device-width, initial-scale=1">
-    <!-- The above 3 meta tags *must* come first in the head; any other head content must come *after* these tags -->
-    <link href='https://fonts.googleapis.com/css?family=Fira+Sans' rel='stylesheet' type='text/css'>
+<head>
+  <meta charset="utf-8">
+  <meta http-equiv="X-UA-Compatible" content="IE=edge">
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+  <!-- The above 3 meta tags *must* come first in the head; any other head content must come *after* these tags -->
+  <link href='https://fonts.googleapis.com/css?family=Fira+Sans' rel='stylesheet' type='text/css'>
 
-    <!-- Bootstrap -->
-    <link href="https://cdn.jsdelivr.net/npm/bootstrap@5.1.3/dist/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-1BmE4kWBq78iYhFldvKuhfTAU6auU8tT94WrHftjDbrCEXSU1oBoqyl2QvZ6jIW3" crossorigin="anonymous">
-	<style>
-		body {
-		  font-family: 'Fira Sans', sans-serif;
-		  color: #000000;
-		}
-		
-		h2, h5 {
-		  margin-bottom: 0.5em;
-		}
-		
-		.after-h1 {
-		  border-bottom: 1px solid #bbbbbb;
-		  margin-bottom: 1.5em;
-		}
-		
-		.footer {
-		  margin: 0.5em 0 1.5em 0;
-		}
-		
-		table {
-		  margin: 0.5em 0 0.5em 0.5em;
-		}
-		
-		table thead tr {
-		  background: #eeeeee;		  
-		}
-				
-		table td, table th {
-		  padding: 0.1em 1em 0.1em 1em;
-		  border: 1px solid #bbbbbb;
-		}
+  <!-- Bootstrap -->
+  <link href="https://cdn.jsdelivr.net/npm/bootstrap@5.1.3/dist/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-1BmE4kWBq78iYhFldvKuhfTAU6auU8tT94WrHftjDbrCEXSU1oBoqyl2QvZ6jIW3" crossorigin="anonymous">
+  <style>
+      body {
+          font-family: 'Fira Sans', sans-serif;
+          color: #000000;
+      }
 
-		blockquote {
+      h2, h3, h4, h5 {
+          margin-bottom: 0.5em;
+          margin-top: 0.5em;
+      }
+
+      h2 {
+          border-bottom: 1px solid #eaeaea;
+      }
+
+      h2 a.header-anchor, h3 a.header-anchor,
+      h4 a.header-anchor, h5 a.header-anchor {
+          float: left;
+          margin-left: -20px;
+          text-decoration: none;
+          outline: none;
+          position: relative;
+      }
+
+      h2 a.header-anchor:after, h3 a.header-anchor:after,
+      h4 a.header-anchor:after, h5 a.header-anchor:after {
+          content: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' width='16' height='16' viewBox='0 0 16 16'%3E%3Cpath fill='%23333' fill-rule='evenodd' d='M9.683 6.676l-.047-.048C8.27 5.26 6.07 5.243 4.726 6.588l-2.29 2.29c-1.344 1.344-1.328 3.544.04 4.91 1.366 1.368 3.564 1.385 4.908.04l1.753-1.752c-.695.074-1.457-.078-2.176-.444L5.934 12.66c-.634.634-1.67.625-2.312-.017-.642-.643-.65-1.677-.017-2.312L6.035 7.9c.634-.634 1.67-.625 2.312.017.024.024.048.05.07.075l.003-.002c.36.36.943.366 1.3.01.355-.356.35-.938-.01-1.3l-.027-.024zM6.58 9.586l.048.05c1.367 1.366 3.565 1.384 4.91.04l2.29-2.292c1.344-1.343 1.328-3.542-.04-4.91-1.366-1.366-3.564-1.384-4.908-.04L7.127 4.187c.695-.074 1.457.078 2.176.444l1.028-1.027c.635-.634 1.67-.624 2.313.017.643.644.652 1.678.018 2.312l-2.43 2.432c-.635.634-1.67.624-2.313-.018-.024-.024-.048-.05-.07-.075l-.003.004c-.36-.362-.943-.367-1.3-.01-.355.355-.35.937.01 1.3.01.007.018.015.027.023z'/%3E%3C/svg%3E");
+          box-sizing: border-box;
+          font-size: medium;
+          visibility: hidden;
+      }
+
+      h2:hover a.header-anchor:after, h3:hover a.header-anchor:after,
+      h4:hover a.header-anchor:after, h5:hover a.header-anchor:after {
+          visibility: visible;
+      }
+
+      div.after-h1 {
+          border-bottom: 1px solid #bbbbbb;
+          margin-bottom: 1.5em;
+      }
+
+      div.youtube-video {
+          margin: 1em 0 1em 0;
+          width: 100%;
+          justify-content: center;
+          display: flex;
+      }
+
+      div.content {
+      }
+
+      div.footer {
+          margin: 0.5em 0 0.5em 0;
+      }
+
+      div.bhook-cta a {
+          font-size: x-small;
+          text-decoration: none;
+          margin-bottom: 1.5em;
+          color: #bbbbbb;
+      }
+
+      table {
+          margin: 0.5em 0 1em 0.5em;
+      }
+
+      table thead tr {
+          background: #eeeeee;
+      }
+
+      table td, table th {
+          padding: 0.1em 1em 0.1em 1em;
+          border: 1px solid #bbbbbb;
+      }
+
+      blockquote {
           border-left: 10px solid #cccccc;
           background: #eeeeee;
           display: inline-block;
           padding: 1em;
-		}
-	</style>
-	<!-- Global site tag (gtag.js) - Google Analytics -->
-	<script async src="https://www.googletagmanager.com/gtag/js?id=G-CT9TWBW0WR"></script>
-	<script>
-	  window.dataLayer = window.dataLayer || [];
-	  function gtag(){dataLayer.push(arguments);}
-	  gtag('js', new Date());
-
-	  gtag('config', 'G-CT9TWBW0WR');
-	</script>
-  	<title><%= src_title -%></title>
-  </head>
-  <body>
-	<div class="body container">
-		<div class="content row justify-content-center">
-		  <div class="col-10">
-		  	  <%= output %>
-		  </div>
-		</div>
-	  	<div class="footer d-flex justify-content-center">
-			<div>
-<% short_sha = src_file_sha ? src_file_sha[0..7] : nil -%>
-<% if file_url && short_sha -%>
-				v. <a href="<%= file_url -%>"><%= short_sha -%></a>,
-<% elsif short_sha -%>
-				v. <%= short_sha -%>,
-<% end -%>
-				<%= src_file_date -%> © <a href="https://sidu.in">Sidu Ponnappa</a>
-			</div>
-	  	</div>
-	</div>
-  </body>
+      }
+  </style>
+  <!-- Global site tag (gtag.js) - Google Analytics -->
+  <script async src="https://www.googletagmanager.com/gtag/js?id=G-CT9TWBW0WR"></script>
+  <script>
+      window.dataLayer = window.dataLayer || [];
+      function gtag() { dataLayer.push(arguments); }
+      gtag('js', new Date());
+      gtag('config', 'G-CT9TWBW0WR');
+  </script>
+  <title><%= src_title -%></title>
+</head>
+<body>
+<div class="body container">
+  <div class="content row justify-content-center">
+    <div class="col-10">
+      <%= output %>
+    </div>
+  </div>
+  <div class="footer d-flex justify-content-center">
+    <div>
+      <% short_sha = src_file_sha ? src_file_sha[0..7] : nil -%>
+      <% if file_url && short_sha -%>
+        v. <a href="<%= file_url -%>"><%= short_sha -%></a>,
+      <% elsif short_sha -%>
+        v. <%= short_sha -%>,
+      <% end -%>
+      <%= src_file_date -%> © <a href="https://sidu.in">Sidu Ponnappa</a>
+    </div>
+  </div>
+  <div class="bhook-cta d-flex justify-content-center">
+    <a href="https://gitlab.com/kaiwren/bhook" target="_blank">powered by bhook</a>
+  </div>
+</div>
+</body>
 </html>

data/lib/bhook/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module Bhook
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/lib/bhook/workspace.rb

@@ -28,19 +28,13 @@ module Bhook
         process!
       end
       listener.start
-      sleep
-    end
-
-    sig { returns(T::Array[MdFile]) }
-    def all_md_files
-      root_dir.all_md_files
     end
 
     private
 
     sig { returns(Bhook::Directory) }
     def root_dir
-      Directory.new_root_directory(@src_path, @out_path)
+      RootDirectory.new(@src_path, @out_path)
     end
   end
 end

data/lib/bhook/workspaces.rb

@@ -0,0 +1,29 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Bhook
+  class Workspaces
+    extend T::Sig
+
+    sig { void }
+    def initialize
+      @workspaces = T.let([], T::Array[Bhook::Workspace])
+    end
+
+    sig { params(workspace: Workspace).void }
+    def mount(workspace)
+      @workspaces << workspace
+    end
+
+    sig { void }
+    def process!
+      @workspaces.each(&:process!)
+    end
+
+    sig { void }
+    def watch!
+      @workspaces.each(&:watch!)
+      Kernel.sleep
+    end
+  end
+end

data/lib/bhook.rb

@@ -32,5 +32,7 @@ require_relative 'bhook/theme_generator'
 require_relative 'bhook/theme'
 require_relative 'bhook/converter/html'
 require_relative 'bhook/directory'
+require_relative 'bhook/root_directory'
 require_relative 'bhook/md_file'
 require_relative 'bhook/workspace'
+require_relative 'bhook/workspaces'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bhook
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Sidu Ponnappa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-06-01 00:00:00.000000000 Z
+date: 2022-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: git
@@ -202,12 +202,14 @@ files:
 - lib/bhook/directory.rb
 - lib/bhook/logger.rb
 - lib/bhook/md_file.rb
+- lib/bhook/root_directory.rb
 - lib/bhook/theme.rb
 - lib/bhook/theme/_after_h1.erb
 - lib/bhook/theme/page.erb
 - lib/bhook/theme_generator.rb
 - lib/bhook/version.rb
 - lib/bhook/workspace.rb
+- lib/bhook/workspaces.rb
 - sorbet/config
 - sorbet/rbi/gems/ast.rbi
 - sorbet/rbi/gems/bhook.rbi