bhook 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 004e13098155733cadddffee89a4085b4c7dc78fafa28de82b4266cd86c95eab
+  data.tar.gz: aa6a9773afd270b0d63f230142b3ac86a3f90719b6602a7ae26cee712b36ffff
+SHA512:
+  metadata.gz: 757d1a3bcabc583116a5d02b41beb198f19dc891cb3ce948482614bd77f7a18ae5082ee5e3e535ee777739b030d25887ae7d1b8c3ccaa566943035e7ca51cd2e
+  data.tar.gz: e41a385694dabe87e08d21fa51a5d0091028b7317d81f48b107e2a73797d8b9eacc1eafdf52a42715149706ecbe30c604a1aab7f3cd39e3147a767a4fc6ddb85

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,3 @@
+require:
+  - rubocop-rake
+  - rubocop-rspec

data/.ruby-version

@@ -0,0 +1 @@
+2.7.5

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in bhook.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,82 @@
+PATH
+  remote: .
+  specs:
+    bhook (0.1.0)
+      git (~> 1.10)
+      kramdown (~> 2.3)
+      listen (~> 3.7)
+      sorbet-runtime (~> 0.5)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.5.0)
+    ffi (1.15.5)
+    git (1.10.2)
+      rchardet (~> 1.8)
+    kramdown (2.3.1)
+      rexml
+    listen (3.7.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    parallel (1.21.0)
+    parser (3.1.0.0)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    rb-fsevent (0.11.1)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rchardet (1.8.0)
+    regexp_parser (2.2.0)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.25.1)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.15.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.15.1)
+      parser (>= 3.0.1.1)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.8.0)
+      rubocop (~> 1.19)
+    ruby-progressbar (1.11.0)
+    sorbet (0.5.9626)
+      sorbet-static (= 0.5.9626)
+    sorbet-runtime (0.5.9626)
+    sorbet-static (0.5.9626-universal-darwin-21)
+    unicode-display_width (2.1.0)
+
+PLATFORMS
+  arm64-darwin-21
+
+DEPENDENCIES
+  bhook!
+  rake (~> 13.0)
+  rspec (~> 3.1)
+  rubocop (~> 1.0)
+  rubocop-rake (~> 0.6)
+  rubocop-rspec (~> 2.8)
+  sorbet (~> 0.5)
+
+BUNDLED WITH
+   2.3.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Sidu Ponnappa
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,27 @@
+# Bhook
+
+Bhook is a static bliki generator.
+
+## Installation
+
+Install it yourself as:
+
+    $ gem install bhook
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+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.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/bhook.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+desc 'Run Sorbet Typechecker'
+task :sorbet do
+  sh('bundle exec srb tc')
+end
+
+task default: %i[sorbet spec]

data/bin/bhook

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+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.watch ? workspace.watch! : workspace.process!

data/lib/bhook/args_parser.rb

@@ -0,0 +1,55 @@
+module Bhook
+  class ArgsParser
+    Options = Struct.new(:source, :output, :watch)
+        
+    def initialize(argv)
+      @args = Options.new(nil, nil, false)
+      @argv = argv.clone
+      @opt_parser = build_opt_parser
+    end
+    
+    def parse!
+      begin
+        @opt_parser.parse!(@argv)
+      rescue OptionParser::InvalidOption => e
+        puts
+        puts "Error! #{e.message}"
+        puts
+      end
+
+      if !@argv.empty? || (!@args.source || !@args.output)
+        puts @opt_parser
+        exit
+      end
+      @args
+    end
+    
+    private
+    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
+        end
+
+        opts.on("-oOUTPUT", "--output=OUTPUT", 
+                String, "Path to directory where output files are to be generated") do |o|
+          @args.output = o
+        end
+
+        opts.on("-w", "--watch", 
+                FalseClass, 
+                "Continuously watch the source directory for changes and generate output") do |w|
+          @args.watch = true
+        end
+
+        opts.on("-h", "--help", "Prints this help") do
+          puts opts
+          exit
+        end
+      end      
+    end
+  end
+end

data/lib/bhook/converter/html.rb

@@ -0,0 +1,51 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Bhook
+  module Converter
+    class Html < ::Kramdown::Converter::Html
+      extend T::Sig
+
+      sig { params(root: Kramdown::Element, options: T::Hash[Symbol, T.untyped]).void }
+      def initialize(root, options)
+        @options = T.let({}, T::Hash[Symbol, T.untyped])
+        super(root, options)
+      end
+
+      sig { params(el: Kramdown::Element, indent: Integer).returns(String) }
+      def convert_a(el, indent)
+        href_path = el.attr['href']
+        if valid_relative_md_link?(href_path)
+          puts "Found link: #{href_path}"
+          el.attr['href'].gsub!(/\.md/, '.html')
+        end
+        super(el, indent)
+      end
+
+      sig { params(el: Kramdown::Element, indent: Integer).returns(String) }
+      def convert_header(el, indent)
+        header = super(el, indent)
+        after_h1_strategy = @options[:after_h1_strategy]
+        h1_callback = @options[:h1_callback]
+        src_title = el.options[:raw_text]
+        after_h1_html = after_h1_strategy.call(binding)
+
+        level = output_header_level(el.options[:level])
+        if level == 1
+          h1_callback.call(src_title)
+          "#{header}#{' ' * indent}#{after_h1_html}"
+        else
+          header
+        end
+      end
+
+      private
+
+      sig { params(href_path: String).returns(T::Boolean) }
+      def valid_relative_md_link?(href_path)
+        (href_path.end_with?('.md') || href_path.include?('.md#')) &&
+          Pathname.new(href_path).relative?
+      end
+    end
+  end
+end

data/lib/bhook/directory.rb

@@ -0,0 +1,62 @@
+# typed: true
+# frozen_string_literal: true
+
+module Bhook
+  class Directory
+    GIT_DIR = '.git'
+    MD_EXT = '.md'
+    
+    attr_reader :sub_dirs, :md_files
+
+    def initialize(src_path, git = nil)
+      @src_path = src_path
+      @git = git
+      @sub_dirs = []
+      @md_files = []
+      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) }
+    end
+
+    def all_md_files
+      @md_files + @sub_dirs.map(&:all_md_files).flatten
+    end
+
+    def to_s
+      @src_path.to_s
+    end
+
+    private
+
+    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)
+        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
+  end
+end

data/lib/bhook/md_file.rb

@@ -0,0 +1,50 @@
+# typed: false
+# 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)
+      @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('|')
+    end
+
+    sig { returns(Pathname) }
+    attr_reader :src_file_path
+
+    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) }
+
+      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}"
+      File.write(out_file_path, rendered_page)
+    end
+
+    sig { returns(String) }
+    def to_s
+      @src_file_path
+    end
+  end
+end

data/lib/bhook/theme/_after_h1.erb

@@ -0,0 +1,7 @@
+<div class="after-h1">
+<a class="twitter-share-button" 
+href="https://twitter.com/intent/tweet?text=<%= CGI.escape(src_title) -%>&via=ponnappa">Tweet</a>
+<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/page.erb

@@ -0,0 +1,71 @@
+<!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'>
+
+    <!-- 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;
+		}
+	</style>
+  <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>
+				v. <%= src_file_sha -%>, <%= src_file_date -%> © <a href="https://sidu.in">Sidu Ponnappa</a>
+			</div>
+	  	</div>
+	</div>
+	<script type='text/javascript'>
+      var _gaq = _gaq || [];
+      _gaq.push(['_setAccount', 'UA-24685691-1']);
+      _gaq.push(['_trackPageview']);
+
+      (function() {
+        var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+        ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
+        var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+      })();
+    </script>
+  </body>
+</html>

data/lib/bhook/version.rb

@@ -0,0 +1,6 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Bhook
+  VERSION = '0.1.0'
+end

data/lib/bhook/workspace.rb

@@ -0,0 +1,45 @@
+# typed: strict
+# frozen_string_literal: true
+
+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
+    end
+
+    sig { void }
+    def process!
+      root = root_dir
+      root.write!(@out_path)
+    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|
+        process!
+        puts "-----\n"
+      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(Pathname.new(@src_path))
+    end
+  end
+end

data/lib/bhook.rb

@@ -0,0 +1,22 @@
+# typed: strict
+# frozen_string_literal: true
+
+require 'set'
+require 'fileutils'
+require 'pathname'
+require 'erb'
+require 'optparse'
+require 'sorbet-runtime'
+require 'git'
+require 'kramdown'
+require 'listen'
+require_relative 'bhook/version'
+require_relative 'bhook/args_parser'
+require_relative 'bhook/converter/html'
+require_relative 'bhook/directory'
+require_relative 'bhook/md_file'
+require_relative 'bhook/workspace'
+
+module Bhook
+  class Error < StandardError; end
+end

data/sorbet/config

@@ -0,0 +1,3 @@
+--dir
+.
+--ignore=/vendor/bundle

data/sorbet/rbi/gems/ast.rbi

@@ -0,0 +1,49 @@
+# This file is autogenerated. Do not edit it by hand. Regenerate it with:
+#   srb rbi gems
+
+# typed: strict
+#
+# If you would like to make changes to this file, great! Please create the gem's shim here:
+#
+#   https://github.com/sorbet/sorbet-typed/new/master?filename=lib/ast/all/ast.rbi
+#
+# ast-2.4.2
+
+module AST
+end
+class AST::Node
+  def +(array); end
+  def <<(element); end
+  def ==(other); end
+  def append(element); end
+  def assign_properties(properties); end
+  def children; end
+  def clone; end
+  def concat(array); end
+  def deconstruct; end
+  def dup; end
+  def eql?(other); end
+  def fancy_type; end
+  def hash; end
+  def initialize(type, children = nil, properties = nil); end
+  def inspect(indent = nil); end
+  def original_dup; end
+  def to_a; end
+  def to_ast; end
+  def to_s(indent = nil); end
+  def to_sexp(indent = nil); end
+  def to_sexp_array; end
+  def type; end
+  def updated(type = nil, children = nil, properties = nil); end
+end
+class AST::Processor
+  include AST::Processor::Mixin
+end
+module AST::Processor::Mixin
+  def handler_missing(node); end
+  def process(node); end
+  def process_all(nodes); end
+end
+module AST::Sexp
+  def s(type, *children); end
+end

data/sorbet/rbi/gems/bhook.rbi

@@ -0,0 +1,15 @@
+# This file is autogenerated. Do not edit it by hand. Regenerate it with:
+#   srb rbi gems
+
+# typed: strict
+#
+# If you would like to make changes to this file, great! Please create the gem's shim here:
+#
+#   https://github.com/sorbet/sorbet-typed/new/master?filename=lib/bhook/all/bhook.rbi
+#
+# bhook-0.1.0
+
+module Bhook
+end
+class Bhook::Error < StandardError
+end