bhook 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b4ef3049d516cd681eac21ac34923cf9cdd292cbb79ca238d7228e1a18a9a323
-  data.tar.gz: 942754c6193f0e19d1b2dc028aa13e9033e7d2e4f5a01e3edb76248ce2d1e3f6
+  metadata.gz: 5ffd9eb1c5db23eb8abdd4a3fab6932720c3774697c27656ecf4ddcae1732eeb
+  data.tar.gz: cf87062c2146ca04a7dc3e64e85909a8dd5d53799e6f6cea8aeccf2d197701e3
 SHA512:
-  metadata.gz: cb421ebe8b1ea40155b8fec5139d249b99c99bdc17f44587b07d4af8824a2519ca3edba0134f1029475df2be577da5f140149a0a11d7ea05273de23734c2fcc3
-  data.tar.gz: 9563f8a81b32da179e8f4582f36dfa619076237fe64880fdd3047feafc7f89826bc8098e884ce8ef3c59afc35c155d882d709a74d9e41cf54936b0af2fd21862
+  metadata.gz: d2071d0b4baf4b58dd94ec675323f416bc4864f964506e79c04db3618a4338c44f7d151aff1137467f174c07df06ce26bc2cbf2d13b0f66476b6f47ef960305f
+  data.tar.gz: 3e3693defc38e9e1598c1cca637c48fbc305bfb012602d4b458f916c024f9260de650863ed25a4ba15737a4933fc4e5b037a75b70f7fcd70559e561cdb285752

data/Gemfile.lock

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

data/README.md

@@ -15,7 +15,7 @@ Install it yourself as:
 Getting help:
 
 	$ bhook --help
-	Bhook version 0.1.2
+	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
@@ -23,6 +23,7 @@ Getting help:
 	    -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:

data/lib/bhook/args_parser.rb

@@ -8,7 +8,7 @@ module Bhook
     Options = Struct.new(:source, :output, :watch, :verbose, :theme, :generate_theme, :benchmark)
         
     def initialize(argv)
-      @args = Options.new(nil, nil, false, false, nil, nil, false)
+      @args = Options.new(nil, nil, false, false, Bhook::THEME_DIR_PATH, nil, false)
       @argv = argv.clone
       @opt_parser = build_opt_parser
     end

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/directory.rb

@@ -8,11 +8,18 @@ module Bhook
     GIT_DIR = '.git'
     MD_EXT = '.md'
     
-    sig { params(src_path: Pathname, out_path: Pathname, git: Git::Base).void }
-    def initialize(src_path, out_path, git)
+    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
@@ -50,9 +57,9 @@ module Bhook
       file_threads = []
       children.each do |child_path|
         if child_path.directory?
-          @sub_dirs << Directory.new(child_path, @out_path, @git)
+          @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) }
+          file_threads << Thread.new { MdFile.new(child_path, @out_path, @git, @config) }
         end
       end
       file_threads.each { |thread| @md_files << thread.value }

data/lib/bhook/md_file.rb

@@ -11,18 +11,15 @@ module Bhook
     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)
+    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 = 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('|')
+      @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
@@ -31,9 +28,10 @@ module Bhook
     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)
 
       L.debug "Processing: #{@src_file_sha || 'unversioned'} #{@src_file_path}"
-      rendered_page = theme.render_page(@md, @src_file_sha, @src_file_date)
+      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)
@@ -43,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.3'
+  VERSION = '0.1.4'
 end

data/lib/bhook/workspace.rb

@@ -4,7 +4,7 @@
 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 = T.let(Pathname.new(src_path).expand_path, Pathname)
@@ -36,10 +36,10 @@ module Bhook
       root_dir.all_md_files
     end
     
-    private 
-    sig { returns(Bhook::RootDirectory) }
+    private    
+    sig { returns(Bhook::Directory) }
     def root_dir
-      RootDirectory.new(@src_path, @out_path)
+      Directory.new_root_directory(@src_path, @out_path)
     end
   end
 end

data/lib/bhook.rb

@@ -7,6 +7,8 @@ require 'pathname'
 require 'erb'
 require 'optparse'
 require 'logger'
+require 'uri'
+require 'yaml'
 require 'sorbet-runtime'
 require 'git'
 require 'kramdown'
@@ -25,10 +27,10 @@ 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'
 require_relative 'bhook/directory'
-require_relative 'bhook/root_directory'
 require_relative 'bhook/md_file'
 require_relative 'bhook/workspace'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bhook
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Sidu Ponnappa
@@ -169,11 +169,11 @@ 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/root_directory.rb
 - lib/bhook/theme.rb
 - lib/bhook/theme/_after_h1.erb
 - lib/bhook/theme/page.erb

data/lib/bhook/root_directory.rb

@@ -1,13 +0,0 @@
-# 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