bhook 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5ffd9eb1c5db23eb8abdd4a3fab6932720c3774697c27656ecf4ddcae1732eeb
-  data.tar.gz: cf87062c2146ca04a7dc3e64e85909a8dd5d53799e6f6cea8aeccf2d197701e3
+  metadata.gz: 39c52c51debcaf48107b16abf83358b72740cd6372229b28d1d8bf40b026990f
+  data.tar.gz: bf55558bfdb2a19282ff64104bf5d909a1d83713af3f8ebf8b1751cf5758ed6e
 SHA512:
-  metadata.gz: d2071d0b4baf4b58dd94ec675323f416bc4864f964506e79c04db3618a4338c44f7d151aff1137467f174c07df06ce26bc2cbf2d13b0f66476b6f47ef960305f
-  data.tar.gz: 3e3693defc38e9e1598c1cca637c48fbc305bfb012602d4b458f916c024f9260de650863ed25a4ba15737a4933fc4e5b037a75b70f7fcd70559e561cdb285752
+  metadata.gz: 0a94bfa98e43a47608d0c5caf83b9f70cb710ae759ee7e051aa2043ea36f23b2f81a98b7040902ba178f88132e5129ab3b4c881ab1ac4d190b414bed6020532f
+  data.tar.gz: 2aa3aabcd3e8431f0a296f8264cd486037a13074cea31f64942c8416b7ec2481aad99f2802a11931bbaf3417ad213fa88ee7f478f405f144c816f6a7113c543b

data/.rubocop.yml

@@ -1,3 +1,6 @@
 require:
   - rubocop-rake
-  - rubocop-rspec
+  - rubocop-rspec
+  
+AllCops:
+  NewCops: enable

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    bhook (0.1.4)
+    bhook (0.1.5)
       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)
       rchardet (~> 1.8)
-    kramdown (2.3.1)
+    kramdown (2.3.2)
       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)
+    parser (3.1.1.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.2.1)
     rexml (3.2.5)
     rspec (3.11.0)
       rspec-core (~> 3.11.0)
@@ -44,26 +45,32 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.11.0)
     rspec-support (3.11.0)
-    rubocop (1.25.1)
+    rubocop (1.26.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)
+      rubocop-ast (>= 1.16.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.16.0)
+      parser (>= 3.1.1.0)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-    rubocop-rspec (2.8.0)
+    rubocop-rspec (2.9.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)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    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)
     unicode-display_width (2.1.0)
 
 PLATFORMS
@@ -76,6 +83,7 @@ DEPENDENCIES
   rubocop (~> 1.0)
   rubocop-rake (~> 0.6)
   rubocop-rspec (~> 2.8)
+  simplecov (~> 0.21)
   sorbet (~> 0.5)
 
 BUNDLED WITH

data/Rakefile

@@ -10,4 +10,15 @@ task :sorbet do
   sh('bundle exec srb tc')
 end
 
-task default: %i[sorbet spec]
+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(',')}")
+end
+
+task default: %i[lint_with_autocorrect 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,100 @@
-# 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?
+          if source_or_output_paths_missing?
+            raise OptionParser::MissingArgument.new('See --help.')
+          end
+        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

@@ -6,24 +6,24 @@ module Bhook
     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)
+
+    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)) 
+        YAML.load(File.read(config_file_path))
       else
-        {}
+        {}.merge(additional_options)
       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
+        File.join(@website_url, src_file_sha, relative_file_path)
       end
     end
   end

data/lib/bhook/directory.rb

@@ -4,16 +4,16 @@
 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))
     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 +30,13 @@ 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
-    
+
     sig { returns(T::Array[MdFile]) }
     def all_md_files
       @md_files + @sub_dirs.map(&:all_md_files).flatten
@@ -46,14 +46,14 @@ 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))
-      
+
       file_threads = []
       children.each do |child_path|
         if child_path.directory?

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,34 @@ 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))
+
+      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))
     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',

data/lib/bhook/theme_generator.rb

@@ -5,17 +5,19 @@ module Bhook
   class ThemeGenerator
     extend T::Sig
 
-    sig {params(output_path: String).void}
+    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}
+    sig { void }
     def generate!
-      FileUtils.mkdir_p(@output_path, verbose: true)
-      FileUtils.cp(@template_files, @output_path, verbose: true)
+      FileUtils.mkdir_p(@output_path)
+      L.debug("mkdir: #{@output_path}")
+      FileUtils.cp(@template_files, @output_path)
+      L.debug("cp: #{@template_files.join(' ')} #{@output_path}")
     end
   end
 end

data/lib/bhook/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module Bhook
-  VERSION = '0.1.4'
+  VERSION = '0.1.5'
 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)
@@ -13,9 +13,9 @@ module Bhook
     end
 
     sig { void }
-    def process!      
+    def process!
       root_dir.write!(@theme)
-      L.info "Done!"
+      L.info 'Done!'
     end
 
     sig { void }
@@ -24,7 +24,7 @@ module Bhook
 
       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..."
+        L.info 'Detected changes...'
         process!
       end
       listener.start
@@ -35,8 +35,8 @@ module Bhook
     def all_md_files
       root_dir.all_md_files
     end
-    
-    private    
+
+    private
     sig { returns(Bhook::Directory) }
     def root_dir
       Directory.new_root_directory(@src_path, @out_path)

data/sorbet/rbi/gems/bhook.rbi

@@ -7,9 +7,10 @@
 #
 #   https://github.com/sorbet/sorbet-typed/new/master?filename=lib/bhook/all/bhook.rbi
 #
-# bhook-0.1.0
+# bhook-0.1.4
 
 module Bhook
+  extend T::Sig
 end
 class Bhook::Error < StandardError
 end

data/sorbet/rbi/gems/docile.rbi

@@ -0,0 +1,36 @@
+# 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/docile/all/docile.rbi
+#
+# docile-1.4.0
+
+module Docile
+  def dsl_eval(dsl, *args, &block); end
+  def dsl_eval_immutable(dsl, *args, &block); end
+  def dsl_eval_with_block_return(dsl, *args, &block); end
+  def self.dsl_eval(dsl, *args, &block); end
+  def self.dsl_eval_immutable(dsl, *args, &block); end
+  def self.dsl_eval_with_block_return(dsl, *args, &block); end
+  extend Docile::Execution
+end
+module Docile::Execution
+  def exec_in_proxy_context(dsl, proxy_type, *args, &block); end
+  def self.exec_in_proxy_context(dsl, proxy_type, *args, &block); end
+end
+class Docile::FallbackContextProxy
+  def initialize(receiver, fallback); end
+  def instance_variables; end
+  def method_missing(method, *args, &block); end
+end
+class Docile::ChainingFallbackContextProxy < Docile::FallbackContextProxy
+  def method_missing(method, *args, &block); end
+end
+module Docile::BacktraceFilter
+  def backtrace; end
+  def backtrace_locations; end
+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.1
+# kramdown-2.3.2
 
 module Kramdown
   def self.data_dir; 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.0.0
+# parser-3.1.1.0
 
 module Parser
 end

data/sorbet/rbi/gems/regexp_parser.rbi

@@ -7,7 +7,7 @@
 #
 #   https://github.com/sorbet/sorbet-typed/new/master?filename=lib/regexp_parser/all/regexp_parser.rbi
 #
-# regexp_parser-2.2.0
+# regexp_parser-2.2.1
 
 class Regexp
 end
@@ -123,6 +123,7 @@ class Regexp::Scanner
   def literal=(arg0); end
   def scan(input_object, options: nil, &block); end
   def self.long_prop_map; end
+  def self.parse_prop_map(name); end
   def self.scan(input_object, options: nil, &block); end
   def self.short_prop_map; end
   def set_depth; end

data/sorbet/rbi/gems/rubocop-ast.rbi

@@ -7,7 +7,7 @@
 #
 #   https://github.com/sorbet/sorbet-typed/new/master?filename=lib/rubocop-ast/all/rubocop-ast.rbi
 #
-# rubocop-ast-1.15.1
+# rubocop-ast-1.16.0
 
 module RuboCop
 end