bhook 0.1.0 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 004e13098155733cadddffee89a4085b4c7dc78fafa28de82b4266cd86c95eab
-  data.tar.gz: aa6a9773afd270b0d63f230142b3ac86a3f90719b6602a7ae26cee712b36ffff
+  metadata.gz: b4ef3049d516cd681eac21ac34923cf9cdd292cbb79ca238d7228e1a18a9a323
+  data.tar.gz: 942754c6193f0e19d1b2dc028aa13e9033e7d2e4f5a01e3edb76248ce2d1e3f6
 SHA512:
-  metadata.gz: 757d1a3bcabc583116a5d02b41beb198f19dc891cb3ce948482614bd77f7a18ae5082ee5e3e535ee777739b030d25887ae7d1b8c3ccaa566943035e7ca51cd2e
-  data.tar.gz: e41a385694dabe87e08d21fa51a5d0091028b7317d81f48b107e2a73797d8b9eacc1eafdf52a42715149706ecbe30c604a1aab7f3cd39e3147a767a4fc6ddb85
+  metadata.gz: cb421ebe8b1ea40155b8fec5139d249b99c99bdc17f44587b07d4af8824a2519ca3edba0134f1029475df2be577da5f140149a0a11d7ea05273de23734c2fcc3
+  data.tar.gz: 9563f8a81b32da179e8f4582f36dfa619076237fe64880fdd3047feafc7f89826bc8098e884ce8ef3c59afc35c155d882d709a74d9e41cf54936b0af2fd21862

data/Gemfile.lock

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

data/README.md

@@ -1,6 +1,8 @@
 # Bhook
 
-Bhook is a static bliki generator.
+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
 
@@ -10,17 +12,32 @@ Install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Getting help:
 
-## Development
+	$ bhook --help
+	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
+	    -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:
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+	➜  essays git:(main) ✗ bhook -s . -o /tmp/out -t /tmp/out/theme -w -v
+
+## Development
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+1. `git clone --recursive git@gitlab.com:kaiwren/bhook.git`
+2. After checking out the repo, run `bundle install` to install dependencies.
+4. Then, run `bundle exec rake` to run the specs and sorbet typechecking. 
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/bhook.
+Bug reports and pull requests are welcome on Gitlab at https://gitlab.com/kaiwren/bhook.
 
 ## License
 

data/bin/bhook

@@ -5,7 +5,29 @@ require 'bundler/setup'
 require 'bhook'
 
 puts "Bhook version #{Bhook::VERSION}"
-args = Bhook::ArgsParser.new(ARGV).parse!
-workspace = Bhook::Workspace.new(args.source, args.output)
+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,23 +1,30 @@
+# typed: false
+# frozen_string_literal: true
+
 module Bhook
   class ArgsParser
-    Options = Struct.new(:source, :output, :watch)
+    extend T::Sig
+    
+    Options = Struct.new(:source, :output, :watch, :verbose, :theme, :generate_theme, :benchmark)
         
     def initialize(argv)
-      @args = Options.new(nil, nil, false)
+      @args = Options.new(nil, nil, false, false, nil, nil, false)
       @argv = argv.clone
       @opt_parser = build_opt_parser
     end
     
-    def parse!
+    def parse
       begin
-        @opt_parser.parse!(@argv)
-      rescue OptionParser::InvalidOption => e
+        @opt_parser.parse(@argv)
+      rescue OptionParser::ParseError => e
         puts
         puts "Error! #{e.message}"
         puts
+        puts @opt_parser
+        exit
       end
-
-      if !@argv.empty? || (!@args.source || !@args.output)
+      
+      if source_or_output_paths_missing? && generate_theme_missing?
         puts @opt_parser
         exit
       end
@@ -25,26 +32,59 @@ module Bhook
     end
     
     private
+        
+    def source_or_output_paths_missing?
+      !@args.source || !@args.output
+    end
+    
+    def generate_theme_missing?
+      !@args.generate_theme
+    end
+    
     def build_opt_parser      
       OptionParser.new do |opts|
         opts.banner = "Usage: bhook --source /source/path --output /output/path"
 
         opts.on("-sSOURCE", "--source=SOURCE", 
-                String, "Path to version controlled directory containing source md files") do |s|
-          @args.source = s
+                String, "Path to version controlled directory containing source md files") do |source_path|
+          @args.source = source_path
         end
 
         opts.on("-oOUTPUT", "--output=OUTPUT", 
-                String, "Path to directory where output files are to be generated") do |o|
-          @args.output = o
+                String, "Path to directory where output files are to be generated") do |out_path|
+          @args.output = out_path
         end
 
         opts.on("-w", "--watch", 
                 FalseClass, 
-                "Continuously watch the source directory for changes and generate output") do |w|
+                "Continuously watch the source directory for changes and generate output") do
           @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|
+          @args.theme = path
+        end
+
+        opts.on("--generate-theme=PATH",
+                String, 
+                "Generate a baseline theme that you can then modify to your needs") do |path|
+          @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/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

@@ -1,62 +1,61 @@
-# typed: true
+# typed: strict
 # frozen_string_literal: true
 
 module Bhook
   class Directory
+    extend T::Sig
+    
     GIT_DIR = '.git'
     MD_EXT = '.md'
     
-    attr_reader :sub_dirs, :md_files
-
-    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 = []
-      @md_files = []
+      @sub_dirs = T.let([], T::Array[Directory])
+      @md_files = T.let([], T::Array[MdFile])
       build_next_level_nodes
     end
 
-    def root_dir_for_a_commit?
-      !@git
-    end
-
-    def write!(out_path)
-      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) }
-      @md_files.each { |file| file.write!(dir_path) }
+    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]) }
     def all_md_files
       @md_files + @sub_dirs.map(&:all_md_files).flatten
     end
 
+    sig { returns(String) }
     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

@@ -1,50 +1,47 @@
-# typed: false
+# typed: strict
 # frozen_string_literal: true
 
 module Bhook
   class MdFile
     extend T::Sig
-    PAGE_TEMPLATE = File.read(File.join(File.dirname(__FILE__), 'theme', 'page.erb'))
-    AFTER_H1_TEMPLATE = File.read(File.join(File.dirname(__FILE__), 'theme', '_after_h1.erb'))
-
-    def initialize(src_file_path, git)
+    
+    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 { 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 = src_file_path.expand_path
-      file_meta_data = git.lib.send(:command, 'log', 
-        '-n 1', 
-        '--pretty=format:%ad|%h', 
-        '--date=short', 
-        '--', 
-        @src_file_path)
-      @src_file_date, @src_file_sha = file_meta_data.split('|')
+      @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).void }
-    def write!(out_path)
-      out_file_name = File.basename(@src_file_path).gsub(/\.md$/, '.html')
-      out_file_path = File.join(out_path, out_file_name)
-      src_file_sha = @src_file_sha
-      src_file_date = @src_file_date
-      src_title = ''
-      puts "Parsing: #{@src_file_sha} #{out_file_path}"
-      after_h1_strategy = ->(binding_instance) { ERB.new(AFTER_H1_TEMPLATE, trim_mode: '-').result(binding_instance) }
+      L.debug "Processing: #{@src_file_sha || 'unversioned'} #{@src_file_path}"
+      rendered_page = theme.render_page(@md, @src_file_sha, @src_file_date)
 
-      doc = Kramdown::Document.new(@md)
-      output, warnings = Converter::Html.convert(doc.root, doc.options.merge(
-                                                             after_h1_strategy: after_h1_strategy,
-                                                             h1_callback: ->(str) { src_title = str }
-                                                           ))
-      rendered_page = ERB.new(PAGE_TEMPLATE, trim_mode: '-').result(binding)
-      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
 
     sig { returns(String) }
     def to_s
-      @src_file_path
+      @src_file_path.to_s
     end
   end
 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/theme/_after_h1.erb

@@ -4,4 +4,3 @@ href="https://twitter.com/intent/tweet?text=<%= CGI.escape(src_title) -%>&via=po
 <a class="twitter-follow-button" href="https://twitter.com/ponnappa">Follow @ponnappa</a>
 <script async src="https://platform.twitter.com/widgets.js" charset="utf-8"></script>
 </div>
-			  

data/lib/bhook/theme.rb

@@ -0,0 +1,28 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Bhook
+  class Theme
+    extend T::Sig
+
+    sig { params(theme_path: String).void }
+    def initialize(theme_path)
+      @page_template = T.let(File.read(File.join(theme_path, 'page.erb')), String)
+      @after_h1_template = T.let(File.read(File.join(theme_path, '_after_h1.erb')), String)
+      strategy = ->(binding_instance) { ERB.new(@after_h1_template, trim_mode: '-').result(binding_instance) }
+      @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)
+      src_title = T.let('', String)
+
+      doc = Kramdown::Document.new(md)
+      output, warnings = Converter::Html.convert(doc.root, doc.options.merge(
+                                                             after_h1_strategy: @after_h1_strategy,
+                                                             h1_callback: ->(str) { src_title = str }
+                                                           ))
+      ERB.new(@page_template, trim_mode: '-').result(binding)
+    end
+  end
+end

data/lib/bhook/theme_generator.rb

@@ -0,0 +1,21 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Bhook
+  class ThemeGenerator
+    extend T::Sig
+
+    sig {params(output_path: String).void}
+    def initialize(output_path)
+      @output_path = T.let(File.join(output_path, 'theme'), String)
+      @template_files = T.let([Bhook::PAGE_TEMPLATE_PATH,
+                                Bhook::AFTER_H1_TEMPLATE_PATH], T::Array[String])
+    end
+
+    sig {void}
+    def generate!
+      FileUtils.mkdir_p(@output_path, verbose: true)
+      FileUtils.cp(@template_files, @output_path, verbose: true)
+    end
+  end
+end

data/lib/bhook/version.rb

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

data/lib/bhook/workspace.rb

@@ -5,26 +5,27 @@ module Bhook
   class Workspace
     extend T::Sig
 
-    sig { params(src_path: String, out_path: String).void }
-    def initialize(src_path, out_path)
-      @src_path = src_path
-      @out_path = out_path
+    sig { params(src_path: String, out_path: String, theme_path: String).void }
+    def initialize(src_path, out_path, theme_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)
+    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
@@ -34,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,17 +6,29 @@ require 'fileutils'
 require 'pathname'
 require 'erb'
 require 'optparse'
+require 'logger'
 require 'sorbet-runtime'
 require 'git'
 require 'kramdown'
 require 'listen'
+
+module Bhook
+  extend T::Sig
+
+  THEME_DIR_PATH = T.let(File.join(File.dirname(__FILE__), 'bhook', 'theme'), String)
+  PAGE_TEMPLATE_PATH = T.let(File.join(THEME_DIR_PATH, 'page.erb'), String)
+  AFTER_H1_TEMPLATE_PATH = T.let(File.join(THEME_DIR_PATH, '_after_h1.erb'), String)
+
+  class Error < StandardError; end
+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'
-
-module Bhook
-  class Error < StandardError; end
-end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bhook
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.3
 platform: ruby
 authors:
 - Sidu Ponnappa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-03-12 00:00:00.000000000 Z
+date: 2022-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: git
@@ -171,9 +171,13 @@ 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
+- lib/bhook/theme_generator.rb
 - lib/bhook/version.rb
 - lib/bhook/workspace.rb
 - sorbet/config