bhook 0.1.6 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 17b89ce589acd0d94792144dd145e2470612ebdd7ea566cba91e4174e9bc414c
-  data.tar.gz: d819bec1768b629f94ef192f9053e35df93a9c966246d50c85dc3684bc4fa543
+  metadata.gz: b8daa36a6bba5cff236d6bf93f33ff088d7baa4abb975fe372674c94746e3600
+  data.tar.gz: 499905877d932384d7cb982290ed6bfced51398b63a85ef3101a625783f2113b
 SHA512:
-  metadata.gz: b4c46ca4fd8820d9898bf5cefe79c8fd82bff9f2aebfa9aba41f75c1920d898441624be2740c528b357f1548e537f1651dc737df26a7f9c888278aa2aff91e79
-  data.tar.gz: 9b8fbcfec88fc338ab13ec03cafe6cbe73752ed3b3cae23cb4f98117f0f8913756743e3d930f62d91d5b3c0ff71e3cbe864f99fab0db110539ecbcba9f767213
+  metadata.gz: e7538dd31e1790aab7fabca99e652ff97752c52bd0afeb7ade8d42d517eee6bd2f6687e642c06b95afe4e51cc48724b84646f6f9ee5803d3a73ae9b23f64023e
+  data.tar.gz: 1d5aa665979f1be6f1ba0a96d7068622c782e604a1407a0757e6d254f538dde59507972e15412fcb7141d38f430ff0897c9e95ca8b3a6227b727f575d32bfb36

data/.rubocop.yml

@@ -4,3 +4,32 @@ require:
   
 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.6)
+    bhook (0.2.0)
       git (~> 1.10)
       kramdown (~> 2.3)
       listen (~> 3.7)
@@ -14,15 +14,15 @@ GEM
     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.2)
+    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.1.0)
+    parallel (1.22.1)
+    parser (3.1.2.0)
       ast (~> 2.4.1)
     rainbow (3.1.1)
     rake (13.0.6)
@@ -30,7 +30,7 @@ GEM
     rb-inotify (0.10.1)
       ffi (~> 1.0)
     rchardet (1.8.0)
-    regexp_parser (2.2.1)
+    regexp_parser (2.5.0)
     rexml (3.2.5)
     rspec (3.11.0)
       rspec-core (~> 3.11.0)
@@ -41,36 +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.26.0)
+    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.16.0, < 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.16.0)
+    rubocop-ast (1.18.0)
       parser (>= 3.1.1.0)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-    rubocop-rspec (2.9.0)
+    rubocop-rspec (2.11.1)
       rubocop (~> 1.19)
     ruby-progressbar (1.11.0)
     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.9775)
-      sorbet-static (= 0.5.9775)
-    sorbet-runtime (0.5.9775)
-    sorbet-static (0.5.9775-universal-darwin-21)
+    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
@@ -84,6 +87,7 @@ DEPENDENCIES
   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,15 +12,23 @@ task :sorbet do
   sh('bundle exec srb tc')
 end
 
-cops = %w[
+basic_style_cops = %w[
   Layout/TrailingWhitespace
   Layout/SpaceInsideBlockBraces
   Style/StringLiterals
 ]
 
-desc "Apply #{cops.join(', ')}"
-task :lint_with_autocorrect do
-  sh("bundle exec rubocop -a --only #{cops.join(',')}")
+desc "Apply #{basic_style_cops.join(', ')}"
+task :autocorrect_basic_style_issues do
+  sh("bundle exec rubocop -a --only #{basic_style_cops.join(',')}")
 end
 
-task default: %i[lint_with_autocorrect sorbet spec]
+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/lib/bhook/args_parser.rb

@@ -16,10 +16,8 @@ module Bhook
     def parse
       begin
         @opt_parser.parse(@argv)
-        if generate_theme_missing? && help_missing?
-          if source_or_output_paths_missing?
-            raise OptionParser::MissingArgument.new('See --help.')
-          end
+        if generate_theme_missing? && help_missing? && source_or_output_paths_missing?
+          raise OptionParser::MissingArgument, 'See --help.'
         end
       rescue OptionParser::ParseError => e
         puts "\nError! #{e.message}\n"
@@ -91,7 +89,7 @@ module Bhook
           @args.benchmark = true
         end
 
-        opts.on('-h', '--help', FalseClass, 'Prints this help') do |help|
+        opts.on('-h', '--help', FalseClass, 'Prints this help') do |_help|
           @args.help = true
         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)
+    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
-        {}.merge(additional_options)
-      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)
-        File.join(@website_url, src_file_sha, relative_file_path)
+      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

@@ -10,10 +10,9 @@ module Bhook
 
     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
@@ -32,9 +31,7 @@ module Bhook
       @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.each(&:join)
     end
 
     sig { returns(T::Array[MdFile]) }
@@ -53,12 +50,16 @@ module Bhook
     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

@@ -2,8 +2,8 @@
 # frozen_string_literal: true
 
 module Bhook
-  LOG_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)
+  L = Logger.new($stdout, formatter: LOG_FORMATTER)
 end

data/lib/bhook/md_file.rb

@@ -25,12 +25,8 @@ module Bhook
       @out_path = out_path
       @git = git
       @config = config
-
-      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))
       @out_file_path = T.let(@out_path.join(out_file_name), Pathname)
-      @src_file_url = T.let(file_url, T.nilable(String))
+      initialize_file_details
     end
 
     sig { params(theme: Bhook::Theme).void }
@@ -43,6 +39,7 @@ module Bhook
     end
 
     private
+
     sig { returns(Pathname) }
     def out_file_name
       @src_file_path.basename.sub(/\.md$/, '.html')
@@ -62,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.rb

@@ -13,8 +13,10 @@ 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), file_url: T.nilable(String)).returns(String) }
+    sig do
+      params(md: String, src_file_sha: T.nilable(String),
+             src_file_date: T.nilable(String), file_url: T.nilable(String)).returns(String)
+    end
     def render_page(md, src_file_sha, src_file_date, file_url)
       src_title = T.let('', String)
 

data/lib/bhook/theme_generator.rb

@@ -9,7 +9,7 @@ module Bhook
     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])
+                               Bhook::AFTER_H1_TEMPLATE_PATH], T::Array[String])
     end
 
     sig { void }

data/lib/bhook/version.rb

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

data/lib/bhook/workspace.rb

@@ -37,6 +37,7 @@ module Bhook
     end
 
     private
+
     sig { returns(Bhook::Directory) }
     def root_dir
       Directory.new_root_directory(@src_path, @out_path)

data/sorbet/rbi/gems/bhook.rbi

@@ -7,7 +7,7 @@
 #
 #   https://github.com/sorbet/sorbet-typed/new/master?filename=lib/bhook/all/bhook.rbi
 #
-# bhook-0.1.4
+# bhook-0.2.0
 
 module Bhook
   extend T::Sig

data/sorbet/rbi/gems/git.rbi

@@ -7,7 +7,7 @@
 #
 #   https://github.com/sorbet/sorbet-typed/new/master?filename=lib/git/all/git.rbi
 #
-# git-1.10.2
+# git-1.11.0
 
 module Git
   def config(name = nil, value = nil); end

data/sorbet/rbi/gems/kramdown.rbi

@@ -7,7 +7,7 @@
 #
 #   https://github.com/sorbet/sorbet-typed/new/master?filename=lib/kramdown/all/kramdown.rbi
 #
-# kramdown-2.3.2
+# kramdown-2.4.0
 
 module Kramdown
   def self.data_dir; end

data/sorbet/rbi/gems/parallel.rbi

@@ -7,7 +7,7 @@
 #
 #   https://github.com/sorbet/sorbet-typed/new/master?filename=lib/parallel/all/parallel.rbi
 #
-# parallel-1.21.0
+# parallel-1.22.1
 
 module Parallel
   def self.add_progress_bar!(job_factory, options); end
@@ -21,6 +21,8 @@ module Parallel
   def self.flat_map(*args, &block); end
   def self.in_processes(options = nil, &block); end
   def self.in_threads(options = nil); end
+  def self.instrument_finish(item, index, result, options); end
+  def self.instrument_start(item, index, options); end
   def self.map(source, options = nil, &block); end
   def self.map_with_index(array, options = nil, &block); end
   def self.process_incoming_jobs(read, write, job_factory, options, &block); end
@@ -28,6 +30,7 @@ module Parallel
   def self.with_instrumentation(item, index, options); end
   def self.work_direct(job_factory, options, &block); end
   def self.work_in_processes(job_factory, options, &blk); end
+  def self.work_in_ractors(job_factory, options); end
   def self.work_in_threads(job_factory, options, &block); end
   def self.worker(job_factory, options, &block); end
   def self.worker_number; end

data/sorbet/rbi/gems/parser.rbi

@@ -7,7 +7,7 @@
 #
 #   https://github.com/sorbet/sorbet-typed/new/master?filename=lib/parser/all/parser.rbi
 #
-# parser-3.1.1.0
+# parser-3.1.2.0
 
 module Parser
 end