bhook 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5ffd9eb1c5db23eb8abdd4a3fab6932720c3774697c27656ecf4ddcae1732eeb
-  data.tar.gz: cf87062c2146ca04a7dc3e64e85909a8dd5d53799e6f6cea8aeccf2d197701e3
+  metadata.gz: b8daa36a6bba5cff236d6bf93f33ff088d7baa4abb975fe372674c94746e3600
+  data.tar.gz: 499905877d932384d7cb982290ed6bfced51398b63a85ef3101a625783f2113b
 SHA512:
-  metadata.gz: d2071d0b4baf4b58dd94ec675323f416bc4864f964506e79c04db3618a4338c44f7d151aff1137467f174c07df06ce26bc2cbf2d13b0f66476b6f47ef960305f
-  data.tar.gz: 3e3693defc38e9e1598c1cca637c48fbc305bfb012602d4b458f916c024f9260de650863ed25a4ba15737a4933fc4e5b037a75b70f7fcd70559e561cdb285752
+  metadata.gz: e7538dd31e1790aab7fabca99e652ff97752c52bd0afeb7ade8d42d517eee6bd2f6687e642c06b95afe4e51cc48724b84646f6f9ee5803d3a73ae9b23f64023e
+  data.tar.gz: 1d5aa665979f1be6f1ba0a96d7068622c782e604a1407a0757e6d254f538dde59507972e15412fcb7141d38f430ff0897c9e95ca8b3a6227b727f575d32bfb36

data/.rubocop.yml

@@ -1,3 +1,35 @@
 require:
   - rubocop-rake
-  - rubocop-rspec
+  - rubocop-rspec
+  
+AllCops:
+  NewCops: enable
+
+Style/AccessorGrouping:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Naming/MethodParameterName:
+  Enabled: false
+
+RSpec/MessageSpies:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Exclude:
+    - spec/bhook/theme_generator_spec.rb
+
+Metrics/MethodLength:
+  Exclude:
+    - lib/bhook/args_parser.rb
+
+Metrics/BlockLength:
+  Exclude:
+    - lib/bhook/args_parser.rb
+
+Metrics/AbcSize:
+  Exclude:
+    - lib/bhook/args_parser.rb
+

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    bhook (0.1.4)
+    bhook (0.2.0)
       git (~> 1.10)
       kramdown (~> 2.3)
       listen (~> 3.7)
@@ -12,16 +12,17 @@ GEM
   specs:
     ast (2.4.2)
     diff-lcs (1.5.0)
+    docile (1.4.0)
     ffi (1.15.5)
-    git (1.10.2)
+    git (1.11.0)
       rchardet (~> 1.8)
-    kramdown (2.3.1)
+    kramdown (2.4.0)
       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)
+    parallel (1.22.1)
+    parser (3.1.2.0)
       ast (~> 2.4.1)
     rainbow (3.1.1)
     rake (13.0.6)
@@ -29,7 +30,7 @@ GEM
     rb-inotify (0.10.1)
       ffi (~> 1.0)
     rchardet (1.8.0)
-    regexp_parser (2.2.0)
+    regexp_parser (2.5.0)
     rexml (3.2.5)
     rspec (3.11.0)
       rspec-core (~> 3.11.0)
@@ -40,30 +41,39 @@ GEM
     rspec-expectations (3.11.0)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.11.0)
-    rspec-mocks (3.11.0)
+    rspec-mocks (3.11.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.11.0)
     rspec-support (3.11.0)
-    rubocop (1.25.1)
+    rubocop (1.30.0)
       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)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.18.0, < 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-ast (1.18.0)
+      parser (>= 3.1.1.0)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-    rubocop-rspec (2.8.0)
+    rubocop-rspec (2.11.1)
       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)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-cobertura (2.1.0)
+      rexml
+      simplecov (~> 0.19)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    sorbet (0.5.10042)
+      sorbet-static (= 0.5.10042)
+    sorbet-runtime (0.5.10042)
+    sorbet-static (0.5.10042-universal-darwin-21)
     unicode-display_width (2.1.0)
 
 PLATFORMS
@@ -76,6 +86,8 @@ DEPENDENCIES
   rubocop (~> 1.0)
   rubocop-rake (~> 0.6)
   rubocop-rspec (~> 2.8)
+  simplecov (~> 0.21)
+  simplecov-cobertura (~> 2.1.0)
   sorbet (~> 0.5)
 
 BUNDLED WITH

data/README.md

@@ -1,5 +1,12 @@
 # Bhook
 
+[![Build Status](https://gitlab.com/kaiwren/bhook/badges/main/pipeline.svg)](https://gitlab.com/kaiwren/bhook/commits/main)
+[![Coverage Report](https://gitlab.com/kaiwren/bhook/badges/main/coverage.svg)](https://gitlab.com/kaiwren/bhook/commits/main)
+[![Gem Version](https://badge.fury.io/rb/bhook.svg)](https://rubygems.org/gems/bhook)
+[![Downloads](http://ruby-gem-downloads-badge.herokuapp.com/bhook?type=total)](https://rubygems.org/gems/bhook)
+
+
+
 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.
@@ -15,7 +22,7 @@ Install it yourself as:
 Getting help:
 
 	$ bhook --help
-	Bhook version 0.1.4
+	Bhook version 0.2.0
 	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
@@ -30,6 +37,8 @@ How I use it:
 
 	➜  essays git:(main) ✗ bhook -s . -o /tmp/out -t /tmp/out/theme -w -v
 
+Here's an example `.bhook.yml` [config file](https://gitlab.com/india-startups/wiki/-/blob/master/.bhook.yml).
+
 ## Development
 
 1. `git clone --recursive git@gitlab.com:kaiwren/bhook.git`

data/Rakefile

@@ -2,7 +2,9 @@
 
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
 
+RuboCop::RakeTask.new
 RSpec::Core::RakeTask.new(:spec)
 
 desc 'Run Sorbet Typechecker'
@@ -10,4 +12,23 @@ task :sorbet do
   sh('bundle exec srb tc')
 end
 
-task default: %i[sorbet spec]
+basic_style_cops = %w[
+  Layout/TrailingWhitespace
+  Layout/SpaceInsideBlockBraces
+  Style/StringLiterals
+]
+
+desc "Apply #{basic_style_cops.join(', ')}"
+task :autocorrect_basic_style_issues do
+  sh("bundle exec rubocop -a --only #{basic_style_cops.join(',')}")
+end
+
+namespace :ci do
+  desc 'Tasks to run in Gitlab CI build stage'
+  task build: %i[sorbet rubocop]
+
+  desc 'Tasks to run in Gitlab CI spec stage'
+  task spec: %i[spec]
+end
+
+task default: %i[autocorrect_basic_style_issues rubocop sorbet spec]

data/bin/bhook

@@ -5,18 +5,23 @@ require 'bundler/setup'
 require 'bhook'
 
 puts "Bhook version #{Bhook::VERSION}"
-args = Bhook::ArgsParser.new(ARGV).parse
+parser = Bhook::ArgsParser.new(ARGV)
+args = parser.parse
 
-if args.verbose
-  Bhook::L.level = Logger::DEBUG
-else
-  Bhook::L.level = Logger::INFO
+exit unless args
+
+if args.help
+  puts parser.help_text
+  exit
 end
 
 if args.generate_theme
+  Bhook::L.level = Logger::DEBUG
   Bhook::ThemeGenerator.new(args.generate_theme).generate!
   exit
-end  
+end
+
+Bhook::L.level = args.verbose ? Logger::DEBUG : Logger::INFO
 
 workspace = Bhook::Workspace.new(args.source, args.output, args.theme)
 

data/lib/bhook/args_parser.rb

@@ -1,95 +1,98 @@
-# typed: false
+# typed: true
 # frozen_string_literal: true
 
 module Bhook
   class ArgsParser
     extend T::Sig
-    
-    Options = Struct.new(:source, :output, :watch, :verbose, :theme, :generate_theme, :benchmark)
-        
+
+    Options = Struct.new(:source, :output, :watch, :verbose, :theme, :generate_theme, :benchmark, :help)
+
     def initialize(argv)
-      @args = Options.new(nil, nil, false, false, Bhook::THEME_DIR_PATH, nil, false)
+      @args = Options.new(nil, nil, false, false, Bhook::THEME_DIR_PATH, nil, false, false)
       @argv = argv.clone
       @opt_parser = build_opt_parser
     end
-    
+
     def parse
       begin
         @opt_parser.parse(@argv)
+        if generate_theme_missing? && help_missing? && source_or_output_paths_missing?
+          raise OptionParser::MissingArgument, 'See --help.'
+        end
       rescue OptionParser::ParseError => e
-        puts
-        puts "Error! #{e.message}"
-        puts
-        puts @opt_parser
-        exit
-      end
-      
-      if source_or_output_paths_missing? && generate_theme_missing?
-        puts @opt_parser
-        exit
+        puts "\nError! #{e.message}\n"
+        return nil
       end
+
       @args
     end
-    
+
+    def help_text
+      @opt_parser.to_s
+    end
+
     private
-        
+
+    def help_missing?
+      !@args.help
+    end
+
     def source_or_output_paths_missing?
       !@args.source || !@args.output
     end
-    
+
     def generate_theme_missing?
       !@args.generate_theme
     end
-    
-    def build_opt_parser      
+
+    def build_opt_parser
       OptionParser.new do |opts|
-        opts.banner = "Usage: bhook --source /source/path --output /output/path"
+        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 |source_path|
+        opts.on('-sSOURCE', '--source=SOURCE',
+                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 |out_path|
+        opts.on('-oOUTPUT', '--output=OUTPUT',
+                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
+        opts.on('-w', '--watch',
+                FalseClass,
+                '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
+        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|
+        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|
+        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",
+        opts.on('--benchmark',
                 FalseClass,
-                "Run a performance benchmark for the specified source") do
+                'Run a performance benchmark for the specified source') do
           @args.benchmark = true
         end
 
-        opts.on("-h", "--help", "Prints this help") do
-          puts opts
-          exit
+        opts.on('-h', '--help', FalseClass, 'Prints this help') do |_help|
+          @args.help = true
         end
-      end      
+      end
     end
   end
 end

data/lib/bhook/config.rb

@@ -2,29 +2,58 @@
 # frozen_string_literal: true
 
 module Bhook
+  #
+  # Valid keys:
+  # - website
+  #   - link to place in the footer
+  # - exclude
+  #   - list of .md file paths relative to config files
   class Config
     extend T::Sig
-    BHOOK_CONFIG_FILE = T.let('.bhook', String)
+    BHOOK_CONFIG_FILE = T.let('.bhook.yml', String)
     WEBSITE_KEY = T.let('website', String)
-    
-    sig { params(root_dir_path: Pathname).void }
-    def initialize(root_dir_path)
+    EXCLUDE_KEY = T.let('exclude', String)
+
+    sig { params(root_dir_path: Pathname, additional_options: T::Hash[String, String]).void }
+    def initialize(root_dir_path, additional_options = {})
       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
+      config = load_config(config_file_path).merge(additional_options)
       @root_dir_path = root_dir_path
       @website_url = T.let(config[WEBSITE_KEY], T.nilable(String))
+      @excluded_files = T.let(parse_excluded_files(config[EXCLUDE_KEY] || []), T::Array[Pathname])
     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
+      return unless @website_url && src_file_sha
+
+      relative_file_path = src_file_path.relative_path_from(@root_dir_path)
+      File.join(@website_url, src_file_sha, relative_file_path)
+    end
+
+    sig { params(pathname: Pathname).returns(T::Boolean) }
+    def excluded?(pathname)
+      @excluded_files.include?(pathname)
+    end
+
+    private
+
+    sig { params(excluded_files: T::Array[String]).returns(T::Array[Pathname]) }
+    def parse_excluded_files(excluded_files)
+      excluded_files.map { |file_path| @root_dir_path.join(file_path) }
+    end
+
+    sig do
+      params(config_file_path: Pathname).returns(T::Hash[String, T.untyped])
+    end
+    def load_config(config_file_path)
+      if File.exist?(config_file_path)
+        L.debug("Config found: #{config_file_path}")
+        YAML.safe_load(File.read(config_file_path))
+      else
+        L.debug("Config not found: #{config_file_path}")
+        {}
       end
     end
   end
-end
+end

data/lib/bhook/converter/html.rb

@@ -25,14 +25,12 @@ module Bhook
       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)
+        after_h1_html = @options[:after_h1_strategy].call(binding)
 
         level = output_header_level(el.options[:level])
         if level == 1
-          h1_callback.call(src_title)
+          @options[:h1_callback].call(src_title)
           "#{header}#{' ' * indent}#{after_h1_html}"
         else
           header

data/lib/bhook/directory.rb

@@ -4,16 +4,15 @@
 module Bhook
   class Directory
     extend T::Sig
-    
+
     GIT_DIR = '.git'
     MD_EXT = '.md'
-    
+
     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))
+      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
@@ -30,13 +29,11 @@ module Bhook
       FileUtils.mkdir_p(@out_path)
       L.debug("mkdir: #{@out_path}")
       @sub_dirs.each { |dir| dir.write!(theme) }
-      @md_files.map do |file| 
+      @md_files.map do |file|
         Thread.new { file.write!(theme) }
-      end.each do |thread|
-        thread.join
-      end
+      end.each(&:join)
     end
-    
+
     sig { returns(T::Array[MdFile]) }
     def all_md_files
       @md_files + @sub_dirs.map(&:all_md_files).flatten
@@ -46,19 +43,23 @@ module Bhook
     def to_s
       @src_path.to_s
     end
-    
+
     private
 
     sig { void }
     def build_next_level_nodes
       children = @src_path.children
       children.delete(@src_path.join(GIT_DIR))
-      
+      build_nodes(children)
+    end
+
+    sig { params(children: T::Array[Pathname]).void }
+    def build_nodes(children)
       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
+        elsif child_path.extname == MD_EXT && !@config.excluded?(child_path)
           file_threads << Thread.new { MdFile.new(child_path, @out_path, @git, @config) }
         end
       end

data/lib/bhook/logger.rb

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

data/lib/bhook/md_file.rb

@@ -4,13 +4,19 @@
 module Bhook
   class MdFile
     extend T::Sig
-    
+
     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
-    
+    attr_reader :src_file_path, :out_file_path
+
+    sig { returns(T.nilable(String)) }
+    attr_reader :src_file_date, :src_file_sha, :src_file_url
+
+    sig { returns(String) }
+    attr_reader :md
+
     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}"
@@ -19,31 +25,31 @@ module Bhook
       @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))
+      @out_file_path = T.let(@out_path.join(out_file_name), Pathname)
+      initialize_file_details
     end
 
     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)
-
       L.debug "Processing: #{@src_file_sha || 'unversioned'} #{@src_file_path}"
-      rendered_page = theme.render_page(@md, @src_file_sha, @src_file_date, file_url)
+      rendered_page = theme.render_page(@md, @src_file_sha, @src_file_date, @src_file_url)
 
       L.debug "Writing: #{@src_file_sha} #{out_file_path}"
-      File.write(out_file_path, rendered_page)
+      File.write(@out_file_path, rendered_page)
     end
 
-    sig { returns(String) }
-    def to_s
-      @src_file_path.to_s
-    end
-    
     private
-    
+
+    sig { returns(Pathname) }
+    def out_file_name
+      @src_file_path.basename.sub(/\.md$/, '.html')
+    end
+
+    sig { returns(T.nilable(String)) }
+    def file_url
+      @config.website_url_for(@src_file_path, @src_file_sha)
+    end
+
     sig { returns(T::Array[String]) }
     def load_git_file_metadata
       @git.lib.send(:command, 'log',
@@ -53,5 +59,13 @@ module Bhook
                     '--',
                     @src_file_path).split('|')
     end
+
+    sig { void }
+    def initialize_file_details
+      file_date, file_sha = load_git_file_metadata
+      @src_file_date = T.let(file_date, T.nilable(String))
+      @src_file_sha = T.let(file_sha, T.nilable(String))
+      @src_file_url = T.let(file_url, T.nilable(String))
+    end
   end
 end

data/lib/bhook/theme/page.erb

@@ -48,7 +48,16 @@
           padding: 1em;
 		}
 	</style>
-  <title><%= src_title -%></title>	
+	<!-- Global site tag (gtag.js) - Google Analytics -->
+	<script async src="https://www.googletagmanager.com/gtag/js?id=G-CT9TWBW0WR"></script>
+	<script>
+	  window.dataLayer = window.dataLayer || [];
+	  function gtag(){dataLayer.push(arguments);}
+	  gtag('js', new Date());
+
+	  gtag('config', 'G-CT9TWBW0WR');
+	</script>
+  	<title><%= src_title -%></title>
   </head>
   <body>
 	<div class="body container">
@@ -69,16 +78,5 @@
 			</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>