bhook 0.1.1 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a429bac22b3cc378e763dabbad48a1b22263160b1ce2e84a8e476f69c2f0783
-  data.tar.gz: bebc1d4b7ae5e570e29a8075505d8a326adc16af6abc6d62113e1cb21db4c14f
+  metadata.gz: 5ffd9eb1c5db23eb8abdd4a3fab6932720c3774697c27656ecf4ddcae1732eeb
+  data.tar.gz: cf87062c2146ca04a7dc3e64e85909a8dd5d53799e6f6cea8aeccf2d197701e3
 SHA512:
-  metadata.gz: 9bbffd373a9b185635617be72154d16f358fad87b6592b1e9bb23e9295eb7a682f229dc004bcf43f1fef02e5e9838b0b15475343b2040a94b78803cbd6844e61
-  data.tar.gz: 2033c32dc2107c52197a6b71581970324cf0e05164948b5c83cdbf80bf0bc7665b8d3f89372e432344b6d0e23728a4b5b68a8c0bb6df40dcb079b47c6f8121a4
+  metadata.gz: d2071d0b4baf4b58dd94ec675323f416bc4864f964506e79c04db3618a4338c44f7d151aff1137467f174c07df06ce26bc2cbf2d13b0f66476b6f47ef960305f
+  data.tar.gz: 3e3693defc38e9e1598c1cca637c48fbc305bfb012602d4b458f916c024f9260de650863ed25a4ba15737a4933fc4e5b037a75b70f7fcd70559e561cdb285752

data/Gemfile.lock

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

data/README.md

@@ -1,6 +1,8 @@
 # Bhook
 
-Bhook is a static website generator that works off a git repo containing a markdown file based wiki.
+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).
+
+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
 
@@ -13,17 +15,21 @@ Install it yourself as:
 Getting help:
 
 	$ bhook --help
-	Bhook version 0.1.0
+	Bhook version 0.1.4
 	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
 	    -w, --watch                      Continuously watch the source directory for changes and generate output
-	    -t, --typechecking               Enables sorbet runtime typechecking. Only useful when developing bhook.
+	    -v, --verbose                    Print detailed information about files as they are processed
+	    -t, --theme=PATH                 Path to directory containing theme files to use when generating html
+	        --generate-theme=PATH        Generate a baseline theme that you can then modify to your needs
+	        --benchmark                  Run a performance benchmark for the specified source
 	    -h, --help                       Prints this help
 
 How I use it:
 
-	➜  essays git:(main) ✗ bhook -s . -o /tmp/out -w
+	➜  essays git:(main) ✗ bhook -s . -o /tmp/out -t /tmp/out/theme -w -v
+
 ## Development
 
 1. `git clone --recursive git@gitlab.com:kaiwren/bhook.git`

data/bin/bhook

@@ -7,10 +7,27 @@ require 'bhook'
 puts "Bhook version #{Bhook::VERSION}"
 args = Bhook::ArgsParser.new(ARGV).parse
 
+if args.verbose
+  Bhook::L.level = Logger::DEBUG
+else
+  Bhook::L.level = Logger::INFO
+end
+
 if args.generate_theme
   Bhook::ThemeGenerator.new(args.generate_theme).generate!
   exit
 end  
 
 workspace = Bhook::Workspace.new(args.source, args.output, args.theme)
+
+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! } }
+  end
+  exit
+end
+
 args.watch ? workspace.watch! : workspace.process!

data/lib/bhook/args_parser.rb

@@ -1,9 +1,14 @@
+# typed: false
+# frozen_string_literal: true
+
 module Bhook
   class ArgsParser
-    Options = Struct.new(:source, :output, :watch, :typechecking, :theme, :generate_theme)
+    extend T::Sig
+    
+    Options = Struct.new(:source, :output, :watch, :verbose, :theme, :generate_theme, :benchmark)
         
     def initialize(argv)
-      @args = Options.new(nil, nil, false, false, nil, nil)
+      @args = Options.new(nil, nil, false, false, Bhook::THEME_DIR_PATH, nil, false)
       @argv = argv.clone
       @opt_parser = build_opt_parser
     end
@@ -56,6 +61,12 @@ module Bhook
           @args.watch = true
         end
 
+        opts.on("-v", "--verbose", 
+                FalseClass, 
+                "Print detailed information about files as they are processed") do
+          @args.verbose = true
+        end
+
         opts.on("-tPATH", "--theme=PATH",
                 String, 
                 "Path to directory containing theme files to use when generating html") do |path|
@@ -68,6 +79,12 @@ module Bhook
           @args.generate_theme = path
         end
 
+        opts.on("--benchmark",
+                FalseClass,
+                "Run a performance benchmark for the specified source") do
+          @args.benchmark = true
+        end
+
         opts.on("-h", "--help", "Prints this help") do
           puts opts
           exit

data/lib/bhook/config.rb

@@ -0,0 +1,30 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Bhook
+  class Config
+    extend T::Sig
+    BHOOK_CONFIG_FILE = T.let('.bhook', String)
+    WEBSITE_KEY = T.let('website', String)
+    
+    sig { params(root_dir_path: Pathname).void }
+    def initialize(root_dir_path)
+      config_file_path = root_dir_path.join(BHOOK_CONFIG_FILE)
+      config = if File.exist?(config_file_path)
+        YAML.load(File.read(config_file_path)) 
+      else
+        {}
+      end
+      @root_dir_path = root_dir_path
+      @website_url = T.let(config[WEBSITE_KEY], T.nilable(String))
+    end
+    
+    sig { params(src_file_path: Pathname, src_file_sha: T.nilable(String)).returns(T.nilable(String)) }
+    def website_url_for(src_file_path, src_file_sha)
+      if @website_url && src_file_sha
+        relative_file_path = src_file_path.relative_path_from(@root_dir_path)
+        URI::join(@website_url, "#{src_file_sha}/#{relative_file_path}").to_s
+      end
+    end
+  end
+end

data/lib/bhook/converter/html.rb

@@ -16,7 +16,7 @@ module Bhook
       def convert_a(el, indent)
         href_path = el.attr['href']
         if valid_relative_md_link?(href_path)
-          puts "Found link: #{href_path}"
+          L.debug "Found link: #{href_path}"
           el.attr['href'].gsub!(/\.md/, '.html')
         end
         super(el, indent)

data/lib/bhook/directory.rb

@@ -8,31 +8,33 @@ module Bhook
     GIT_DIR = '.git'
     MD_EXT = '.md'
     
-    sig { params(src_path: Pathname, git: T.nilable(Git::Base)).void }
-    def initialize(src_path, git = nil)
+    sig { params(src_path: Pathname, out_path: Pathname).returns(Bhook::Directory) }
+    def self.new_root_directory(src_path, out_path)
+      self.new(src_path, out_path, Git.open(src_path), Bhook::Config.new(src_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)
       @git = git
+      @config = config
       @sub_dirs = T.let([], T::Array[Directory])
       @md_files = T.let([], T::Array[MdFile])
       build_next_level_nodes
     end
 
-    sig { returns(T::Boolean) }
-    def root_dir_for_a_commit?
-      !@git
-    end
-
-    sig { params(out_path: String, theme: Theme).void }
-    def write!(out_path, theme)
-      dir_path = if root_dir_for_a_commit?
-                   out_path
-                 else
-                   File.join(out_path, @src_path.basename)
-                 end
-
-      FileUtils.mkdir_p(dir_path, verbose: true)
-      @sub_dirs.each { |dir| dir.write!(dir_path, theme) }
-      @md_files.each { |file| file.write!(dir_path, theme) }
+    sig { params(theme: Theme).void }
+    def write!(theme)
+      FileUtils.mkdir_p(@out_path)
+      L.debug("mkdir: #{@out_path}")
+      @sub_dirs.each { |dir| dir.write!(theme) }
+      @md_files.map do |file| 
+        Thread.new { file.write!(theme) }
+      end.each do |thread|
+        thread.join
+      end
     end
     
     sig { returns(T::Array[MdFile]) }
@@ -44,25 +46,23 @@ module Bhook
     def to_s
       @src_path.to_s
     end
-
+    
     private
 
     sig { void }
     def build_next_level_nodes
-      if root_dir_for_a_commit?
-        @git = Git.open(@src_path)
-      end
-
-      @sub_dirs = @src_path.children.map do |child|
-        if child.directory? && child.basename.to_s != GIT_DIR
-          Directory.new(child, @git)
+      children = @src_path.children
+      children.delete(@src_path.join(GIT_DIR))
+      
+      file_threads = []
+      children.each do |child_path|
+        if child_path.directory?
+          @sub_dirs << Directory.new(child_path, @out_path, @git, @config)
+        elsif child_path.extname == MD_EXT
+          file_threads << Thread.new { MdFile.new(child_path, @out_path, @git, @config) }
         end
-      end.compact
-      @md_files = @src_path.children.select do |child|
-        !child.directory? && child.extname == MD_EXT
-      end.map do |child|
-        MdFile.new(child, @git)
-      end.compact
+      end
+      file_threads.each { |thread| @md_files << thread.value }
     end
   end
 end

data/lib/bhook/logger.rb

@@ -0,0 +1,8 @@
+# typed: false
+# frozen_string_literal: true
+
+module Bhook
+  L = Logger.new(STDOUT, formatter: proc {|severity, datetime, progname, msg|
+    "#{Thread.current.object_id} #{msg}\n"
+  })
+end

data/lib/bhook/md_file.rb

@@ -8,30 +8,32 @@ module Bhook
     PAGE_TEMPLATE = T.let(File.read(Bhook::PAGE_TEMPLATE_PATH), String)
     AFTER_H1_TEMPLATE = T.let(File.read(Bhook::AFTER_H1_TEMPLATE_PATH), String)
     
-    sig { params(src_file_path: Pathname, git: Git::Base).void }
-    def initialize(src_file_path, git)
+    sig { returns(Pathname) }
+    attr_reader :src_file_path
+    
+    sig { params(src_file_path: Pathname, out_path: Pathname, git: Git::Base, config: Bhook::Config).void }
+    def initialize(src_file_path, out_path, git, config)
+      L.debug "Reading: #{src_file_path}"
       @md = T.let(File.read(src_file_path), String)
-      @src_file_path = T.let(src_file_path.expand_path, Pathname)
-      src_file_date, src_file_sha = git.lib.send(:command, 'log', 
-                                                  '-n 1', 
-                                                  '--pretty=format:%ad|%h', 
-                                                  '--date=short', 
-                                                  '--', 
-                                                  @src_file_path).split('|')
+      @src_file_path = src_file_path
+      @out_path = out_path
+      @git = git
+      @config = config
+      src_file_date, src_file_sha = load_git_file_metadata
       @src_file_date = T.let(src_file_date, T.nilable(String))
       @src_file_sha = T.let(src_file_sha, T.nilable(String))
     end
 
-    sig { returns(Pathname) }
-    attr_reader :src_file_path
+    sig { params(theme: Bhook::Theme).void }
+    def write!(theme)
+      out_file_name = @src_file_path.basename.sub(/\.md$/, '.html')
+      out_file_path = @out_path.join(out_file_name)
+      file_url = @config.website_url_for(@src_file_path, @src_file_sha)
 
-    sig { params(out_path: String, theme: Bhook::Theme).void }
-    def write!(out_path, theme)
-      out_file_name = File.basename(@src_file_path).gsub(/\.md$/, '.html')
-      out_file_path = File.join(out_path, out_file_name)
-      puts "Processing: #{@src_file_sha} #{@src_file_path}"
-      rendered_page = theme.render_page(@md, @src_file_sha, @src_file_date)
-      puts "Writing: #{@src_file_sha} #{out_file_path}"
+      L.debug "Processing: #{@src_file_sha || 'unversioned'} #{@src_file_path}"
+      rendered_page = theme.render_page(@md, @src_file_sha, @src_file_date, file_url)
+
+      L.debug "Writing: #{@src_file_sha} #{out_file_path}"
       File.write(out_file_path, rendered_page)
     end
 
@@ -39,5 +41,17 @@ module Bhook
     def to_s
       @src_file_path.to_s
     end
+    
+    private
+    
+    sig { returns(T::Array[String]) }
+    def load_git_file_metadata
+      @git.lib.send(:command, 'log',
+                    '-n 1',
+                    '--pretty=format:%ad|%H',
+                    '--date=short',
+                    '--',
+                    @src_file_path).split('|')
+    end
   end
 end

data/lib/bhook/theme/page.erb

@@ -40,6 +40,13 @@
 		  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>
   <title><%= src_title -%></title>	
   </head>
@@ -52,7 +59,13 @@
 		</div>
 	  	<div class="footer d-flex justify-content-center">
 			<div>
-				v. <%= src_file_sha -%>, <%= src_file_date -%> © <a href="https://sidu.in">Sidu Ponnappa</a>
+<% 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>

data/lib/bhook/theme.rb

@@ -13,8 +13,9 @@ module Bhook
       @after_h1_strategy = T.let(strategy, T.proc.params(binding_instance: Binding).returns(String))
     end
 
-    sig { params(md: String, src_file_sha: T.nilable(String), src_file_date: T.nilable(String)).returns(String) }
-    def render_page(md, src_file_sha, src_file_date)
+    sig { params(md: String, src_file_sha: T.nilable(String),
+                  src_file_date: T.nilable(String), file_url: T.nilable(String)).returns(String) }
+    def render_page(md, src_file_sha, src_file_date, file_url)
       src_title = T.let('', String)
 
       doc = Kramdown::Document.new(md)

data/lib/bhook/version.rb

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

data/lib/bhook/workspace.rb

@@ -4,28 +4,28 @@
 module Bhook
   class Workspace
     extend T::Sig
-
+    
     sig { params(src_path: String, out_path: String, theme_path: String).void }
     def initialize(src_path, out_path, theme_path)
-      @src_path = src_path
-      @out_path = out_path
+      @src_path = T.let(Pathname.new(src_path).expand_path, Pathname)
+      @out_path = T.let(Pathname.new(out_path).expand_path, Pathname)
       @theme = T.let(Theme.new(theme_path), Bhook::Theme)
     end
 
     sig { void }
-    def process!
-      root = root_dir
-      root.write!(@out_path, @theme)
+    def process!      
+      root_dir.write!(@theme)
+      L.info "Done!"
     end
 
     sig { void }
     def watch!
       process!
-      puts
-      puts "Watching #{@src_path} for changes..."
-      listener = Listen.to(@src_path, File.join(@src_path, '.git')) do |_modified, _added, _removed|
+
+      L.info "Watching: #{@src_path} for changes..."
+      listener = Listen.to(@src_path.to_s, File.join(@src_path.to_s, '.git')) do |_modified, _added, _removed|
+        L.info "Detected changes..."
         process!
-        puts "-----\n"
       end
       listener.start
       sleep
@@ -35,12 +35,11 @@ module Bhook
     def all_md_files
       root_dir.all_md_files
     end
-
-    private
-
+    
+    private    
     sig { returns(Bhook::Directory) }
     def root_dir
-      Directory.new(Pathname.new(@src_path))
+      Directory.new_root_directory(@src_path, @out_path)
     end
   end
 end

data/lib/bhook.rb

@@ -6,6 +6,9 @@ require 'fileutils'
 require 'pathname'
 require 'erb'
 require 'optparse'
+require 'logger'
+require 'uri'
+require 'yaml'
 require 'sorbet-runtime'
 require 'git'
 require 'kramdown'
@@ -22,7 +25,9 @@ module Bhook
 end
 
 require_relative 'bhook/version'
+require_relative 'bhook/logger'
 require_relative 'bhook/args_parser'
+require_relative 'bhook/config'
 require_relative 'bhook/theme_generator'
 require_relative 'bhook/theme'
 require_relative 'bhook/converter/html'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bhook
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.4
 platform: ruby
 authors:
 - Sidu Ponnappa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-03-13 00:00:00.000000000 Z
+date: 2022-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: git
@@ -169,8 +169,10 @@ files:
 - bin/bhook
 - lib/bhook.rb
 - lib/bhook/args_parser.rb
+- lib/bhook/config.rb
 - lib/bhook/converter/html.rb
 - lib/bhook/directory.rb
+- lib/bhook/logger.rb
 - lib/bhook/md_file.rb
 - lib/bhook/theme.rb
 - lib/bhook/theme/_after_h1.erb