bhook 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a429bac22b3cc378e763dabbad48a1b22263160b1ce2e84a8e476f69c2f0783
-  data.tar.gz: bebc1d4b7ae5e570e29a8075505d8a326adc16af6abc6d62113e1cb21db4c14f
+  metadata.gz: e294643cd33777109cba77c7582e4d145f300f8d3960c4dbf5862f616a6a6929
+  data.tar.gz: 4031364646363638654b1b98a9c8d026c2d8c6ac368554315853701d918bb188
 SHA512:
-  metadata.gz: 9bbffd373a9b185635617be72154d16f358fad87b6592b1e9bb23e9295eb7a682f229dc004bcf43f1fef02e5e9838b0b15475343b2040a94b78803cbd6844e61
-  data.tar.gz: 2033c32dc2107c52197a6b71581970324cf0e05164948b5c83cdbf80bf0bc7665b8d3f89372e432344b6d0e23728a4b5b68a8c0bb6df40dcb079b47c6f8121a4
+  metadata.gz: 11a403217488e651e2627f053e7de1658a831d2def49679b1fb767bb35885008431cc37c333fd37e4b97b564289af9f6a573fb074b40e48dccb8c6e46e42bfd1
+  data.tar.gz: 16336203e9e8c511361cd529bae17dcb845ba8bb654a63719b378e66ceda6188b4ac7854ec98fa0057afeabd88cc385c19c0669718a1e6613836fac4c8b69180

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    bhook (0.1.1)
+    bhook (0.1.2)
       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,20 @@ Install it yourself as:
 Getting help:
 
 	$ bhook --help
-	Bhook version 0.1.0
+	Bhook version 0.1.2
 	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
 	    -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,6 +7,12 @@ 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

data/lib/bhook/args_parser.rb

@@ -1,6 +1,6 @@
 module Bhook
   class ArgsParser
-    Options = Struct.new(:source, :output, :watch, :typechecking, :theme, :generate_theme)
+    Options = Struct.new(:source, :output, :watch, :verbose, :theme, :generate_theme)
         
     def initialize(argv)
       @args = Options.new(nil, nil, false, false, nil, nil)
@@ -56,6 +56,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|

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,25 @@ 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, git: Git::Base).void }
+    def initialize(src_path, out_path, git)
       @src_path = src_path
+      @out_path = T.let(out_path.join(src_path.basename), Pathname)
       @git = git
       @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, verbose: true)
+      @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 +38,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)
+        elsif child_path.extname == MD_EXT
+          file_threads << Thread.new { MdFile.new(child_path, @out_path, @git) }
         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,34 @@ 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).void }
+    def initialize(src_file_path, out_path, git)
+      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 = src_file_path
+      @out_path = out_path
+      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_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)
 
-    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}"
+      L.debug "Processing: #{@src_file_sha || 'unversioned'} #{@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 "Writing: #{@src_file_sha} #{out_file_path}"
       File.write(out_file_path, rendered_page)
     end
 

data/lib/bhook/root_directory.rb

@@ -0,0 +1,13 @@
+# typed: false
+# 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))
+    end
+  end
+end

data/lib/bhook/version.rb

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

data/lib/bhook/workspace.rb

@@ -7,25 +7,25 @@ module Bhook
 
     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
-
-    sig { returns(Bhook::Directory) }
+    
+    private 
+    sig { returns(Bhook::RootDirectory) }
     def root_dir
-      Directory.new(Pathname.new(@src_path))
+      RootDirectory.new(@src_path, @out_path)
     end
   end
 end

data/lib/bhook.rb

@@ -6,6 +6,7 @@ require 'fileutils'
 require 'pathname'
 require 'erb'
 require 'optparse'
+require 'logger'
 require 'sorbet-runtime'
 require 'git'
 require 'kramdown'
@@ -22,10 +23,12 @@ module Bhook
 end
 
 require_relative 'bhook/version'
+require_relative 'bhook/logger'
 require_relative 'bhook/args_parser'
 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'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bhook
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Sidu Ponnappa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-03-13 00:00:00.000000000 Z
+date: 2022-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: git
@@ -171,7 +171,9 @@ files:
 - lib/bhook/args_parser.rb
 - lib/bhook/converter/html.rb
 - 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