jekyll-git-authors 0.2.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 73738a3355402aebd9970f7e614524d0ce9a966f9f9589051f9cc95cbec334b9
-  data.tar.gz: 16431182d8bda9f840291c0b8545e7ea247b20b17f7252fbc3d45d497e1488d3
+  metadata.gz: 5d79ac6675cf9272be647f7c39270514d4e29f4405302d72b60a9f96704267a4
+  data.tar.gz: fc858a9204cb0ff846422b75f84df532b6c46c5ccf1eaefde0277873f3e8cd61
 SHA512:
-  metadata.gz: f8a0275a90429c8f5136689dbfc3ecf112de4967ffddb2bc2783992487c9794b31e1c5c4070589f1bfd807f850740cf9496d281a43a79131886a919b7487fbe7
-  data.tar.gz: 18c332e37a3308d65a172705b5949dba8351b33da4dd6550fb628a772628b2f7e85a5ff37d05e85cf67ff803a3266e771e4035835da197358fb7cbc4d242a506
+  metadata.gz: 8e394c23ab9d5f9a523f7da65e111e24c50879a472c20115abf614ace6f673f794c2dde0beebf728c9ce88ecb4ecf5c7b59004ca23b27f8d6d48aac78d302ddd
+  data.tar.gz: 200b1990014d53dca919c14dd6987514040dab36363606267abad1bc1c7371f1daa70f04a2b996d8a2c1027e994904bd4e33e762c03b19c358ef556bef32805e

data/.rubocop.yml

@@ -0,0 +1,42 @@
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Metrics/BlockLength:
+  Exclude:
+    - 'jekyll-git-authors.gemspec'
+
+Metrics/MethodLength:
+  Max: 15
+
+Metrics/LineLength:
+  Max: 110
+  Exclude:
+    - 'features/**/*'
+
+Naming/BinaryOperatorParameterName:
+  Enabled: false
+
+Naming/FileName:
+  Enabled: false
+
+Style/BarePercentLiterals:
+  EnforcedStyle: percent_q
+
+Style/Documentation:
+  Enabled: false
+
+Style/HashSyntax:
+  EnforcedStyle: hash_rockets
+
+Style/ParallelAssignment:
+  Enabled: false
+
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    default: '||'
+
+Style/RegexpLiteral:
+  Enabled: false
+
+Style/SymbolArray:
+  EnforcedStyle: brackets

data/Gemfile

@@ -1,4 +1,4 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 git_source(:gitlab) { |repo_name| "https://gitlab.com/#{repo_name}" }
 

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2018 jackorp
+Copyright (c) 2018 Jaroslav Prokop
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/Rakefile

@@ -1,13 +1,16 @@
 require 'rake/testtask'
 require 'cucumber/rake/task'
+require 'rubocop/rake_task'
 
-desc "Run tests by default"
-task :default => [:test]
+desc 'Run tests by default'
+task :default => [:test, :rubocop]
 
 Rake::TestTask.new(:test) do |t|
-  t.libs = ["lib"]
+  t.libs = ['lib']
   t.verbose = true
   t.test_files = FileList['test/*_test.rb']
 end
 
 Cucumber::Rake::Task.new(:test)
+
+RuboCop::RakeTask.new(:rubocop)

data/features/options.feature

@@ -0,0 +1,36 @@
+Feature: Jekyll-git-authors uses options specified by user
+
+  Background:
+    Given There is a fixture named "page.md" and it is in a subdirectory named "subdir"
+
+  Scenario: User wants to have different number of max authors
+    Given There is 8 commits on the "subdir/page.md"
+    And There is "_config.yml" with "max_authors" set to "7"
+    When Jekyll generates authors with set option
+    Then There should be 7 authors on the "subdir/page.md"
+
+  Scenario: User sets multiple options at once
+    Given There are 2 commits on the "subdir/page.md"
+    And There is "_config.yml" with following configuration:
+    """
+    git_authors:
+      center: false
+      thematic_break: false
+      prefix: 'Contributors:'
+    """
+    When Jekyll generates authors with set option
+    Then Authors should not be centered
+    And Authors should not have thematic break
+    And Authors should have "Contributors:" prefix
+
+  Scenario Outline: Setting one option
+    Given There are 2 commits on the "subdir/page.md"
+    And There is "_config.yml" with "<option>" set to "<value>"
+    When Jekyll generates authors with set option
+    Then Authors should <result>
+
+    Examples:
+      | option         | value           | result                      |
+      | center         | false           | not be centered             |
+      | thematic_break | false           | not have thematic break     |
+      | prefix         | 'Contributors:' | have "Contributors:" prefix |

data/features/render_output.feature

@@ -2,11 +2,9 @@ Feature: Jekyll renders output of jekyll-git-authors
 
   Background:
     Given There is a fixture named "page.md" and it is in a subdirectory named "subdir"
-    And Git is intialized
 
   Scenario: Authors are generated correctly
     Given There are 6 commits on the "subdir/page.md"
-    And All commits on "subdir/page.md" have different authors
     When Jekyll-git-authors generates authors
     Then There should be 5 authors on the "subdir/page.md"
 
@@ -17,3 +15,21 @@ Feature: Jekyll renders output of jekyll-git-authors
     When Jekyll-git-authors generates authors
     Then There should be 0 authors on the "page.md"
     But There should be 1 author on the "subdir/page.md"
+
+  Scenario Outline: Generating authors when there are multiple commits from same author
+    Given There is a fixture "subdir/page.md"
+    And There are <different> commits from different authors on the "subdir/page.md"
+    And There are <same> commits from the same author on the "subdir/page.md"
+    When Jekyll-git-authors generates authors
+    Then There should be <authors> authors on the "subdir/page.md"
+
+    Examples:
+      | same | different | authors |
+      |    2 |         1 |       2 |
+      |    5 |         5 |       5 |
+      |    3 |         2 |       3 |
+      |    0 |        10 |       5 |
+      |   10 |         0 |       1 |
+      |    1 |         1 |       2 |
+      |   10 |         1 |       2 |
+      |    1 |        10 |       5 |

data/features/step_definitions/options.rb

@@ -0,0 +1,51 @@
+Given('There is {string} with {string} set to {string}') do |config_yml, option, value|
+  File.open(config_yml, 'w') do |file|
+    file.write("git_authors:\n  #{option}: #{value}")
+  end
+  jekyll_configuration = Jekyll::Configuration.new
+  config = jekyll_configuration.read_config_file(config_yml)
+  @site_config = Jekyll::Configuration.from config
+end
+
+Given('There is {string} with following configuration:') do |config_yml, options|
+  File.open('_config.yml', 'w') { |file| file.write(options) }
+  jekyll_configuration = Jekyll::Configuration.new
+  config = jekyll_configuration.read_config_file(config_yml)
+  @site_config = Jekyll::Configuration.from config
+end
+
+When('Jekyll generates authors with set option') do
+  @site_config['source'] = @dir
+  @site_config['destination'] = File.join(@dir, '_site')
+  # Suppress jekyll log output.
+  Jekyll.logger.log_level = :error
+
+  @site = Jekyll::Site.new(@site_config)
+  authors_generator = Jekyll::AuthorsGenerator.new(@site.config)
+  @site.generators = Array(authors_generator)
+
+  # Make jekyll generate every page found and add them into site.pages variable.
+  files = Dir.glob File.join('**', '*.md')
+  files.each do |file|
+    @page = Jekyll::Page.new(@site, File.expand_path(Dir.pwd), '', file)
+    @site.pages << @page
+  end
+  @site.generate
+end
+
+Then('Authors should not be centered') do
+  center = %r|\{:center: style="text-align: center"\}\n[^\n]*\n\{:center\}|
+  page = @site.pages.find { |p| p.path == 'subdir/page.md' }
+  expect(page.content).to_not match(center)
+end
+
+Then('Authors should not have thematic break') do
+  thematic_break = %r|\n_  _  _  _\n{: #authors-rule}|
+  page = @site.pages.find { |p| p.path == 'subdir/page.md' }
+  expect(page.content).to_not match(thematic_break)
+end
+
+Then('Authors should have {string} prefix') do |prefix|
+  page = @site.pages.find { |p| p.path == 'subdir/page.md' }
+  expect(page.content).to match(prefix)
+end

data/features/step_definitions/render_output.rb

@@ -1,37 +1,34 @@
-Given("There is a fixture named {string} and it is in a subdirectory named {string}") do |file, subdir|
+Given('There is a fixture named {string} and it is in a subdirectory named {string}') do |file, subdir|
   FileUtils.cp "#{@original_dir}/features/fixtures/#{file}", File.join(@dir, subdir)
   expect(File).to exist(File.join(subdir, file))
 end
 
-Given("Git is intialized") do
-  GitHelper.init_repo
-end
-
-Given("There is a fixture {string}") do |file|
+Given('There is a fixture {string}') do |file|
   FileUtils.cp "#{@original_dir}/features/fixtures/page.md", @dir
   expect(File).to exist(file)
 end
 
-Given("All commits on {string} have different authors") do |file|
-  log = Git.log(file).author_email
+Given('There is/are {int} commit(s)( from different authors) on the {string}') do |int, file|
+  next if int.zero?
 
-  expect(log).to be_a_kind_of(Hash)
+  GitHelper.add_commits_different_authors file, int
 end
 
-Given("There is/are {int} commit(s) on the {string}") do |int, file|
-  GitHelper.add_commit int, file
+Given('There are {int} commits from the same author on the {string}') do |int, file|
+  next if int.zero?
 
-  log = Git.execute("log --oneline #{file}").split("\n")
-  expect(log.size).to eq(int)
+  GitHelper.add_commits_same_authors file, int
 end
 
-When("Jekyll-git-authors generates authors") do
+When('Jekyll-git-authors generates authors') do
   # Jekyll::Site does not load directory properly if
   # defaults are being loaded more than once.
   # Workaround is copying it into variable and override directories.
   site_config = Jekyll::Configuration::DEFAULTS.dup
   site_config['source'] = @dir
   site_config['destination'] = File.join(@dir, '_site')
+  # Suppress jekyll log output.
+  Jekyll.logger.log_level = :error
 
   @site = Jekyll::Site.new(site_config)
   authors_generator = Jekyll::AuthorsGenerator.new(@site.config)
@@ -46,10 +43,10 @@ When("Jekyll-git-authors generates authors") do
   @site.generate
 end
 
-Then("There should be {int} author(s) on the {string}") do |int, file|
+Then('There should be {int} author(s) on the {string}') do |int, file|
   page = @site.pages.find { |p| p.path == file }
   expression = /\[[^\]]+\]\(mailto:\{\{ '[^']*' \| encode_email \}\}\)/
-  matched_authors = (page.content.scan(expression)).size
+  matched_authors = page.content.scan(expression).size
 
   expect(matched_authors).to eq(int)
 end

data/features/support/env.rb

@@ -1,4 +1,4 @@
-$LOAD_PATH.unshift File.expand_path('../../../lib', __FILE__)
+$LOAD_PATH.unshift File.expand_path('../../lib', __dir__)
 require 'tmpdir'
 require 'fileutils'
 require 'jekyll'
@@ -18,6 +18,9 @@ Before do
   Dir.mkdir @subdir
 
   Dir.chdir @dir
+
+  # Initialize git
+  GitHelper.init_repo
 end
 
 After do

data/features/support/helper.rb

@@ -1,27 +1,49 @@
 module GitHelper
   # Initialize git environment in current directory.
+  # @commit_count is used to track how many times was the author changed.
   def self.init_repo
-    Git.execute 'init'
+    JekyllGitAuthors::Git.execute 'init'
 
-    change_author('')
+    @commit_count = 0
   end
 
   # Change the author name and email by adding additional_info provided when the function gets called.
   def self.change_author(additional_info)
-    Git.execute "config user.email 'you#{additional_info}@example.com'"
-    Git.execute "config user.name 'Your Name #{additional_info}'"
+    JekyllGitAuthors::Git.execute "config user.email 'you#{additional_info}@example.com'"
+    JekyllGitAuthors::Git.execute "config user.name 'Your Name #{additional_info}'"
   end
 
   # Write "Commit #'number'" into the file and then commit the change
-  # The authors will have name "Your name 'number'" and email "you'number'@example.com"
-  def self.add_commit(number, file)
-    number.times do |num|
-      open(file, 'a') do |f|
-        f << "\nCommit #" + "#{num}"
-      end
-      change_author num
-      Git.execute "add #{file}"
-      Git.execute 'commit -m "Commit #' + "#{num}" + '."'
+  def self.add_commit(file)
+    File.open(file, 'a') do |f|
+      f << "\nCommit ##{@commit_count}"
+    end
+
+    JekyllGitAuthors::Git.execute "add #{file}"
+    JekyllGitAuthors::Git.execute %Q|commit -m "Commit ##{@commit_count}."|
+  end
+
+  # Add multiple commits from same author.
+  #
+  # First increment commit_count then n times commit
+  def self.add_commits_same_authors(file, number = 1)
+    @commit_count += 1
+    change_author @commit_count
+
+    number.times do
+      add_commit file
+    end
+  end
+
+  # Commit multiple times with different authors.
+  #
+  # N times increment commit_count and then commit.
+  def self.add_commits_different_authors(file, number = 1)
+    number.times do
+      @commit_count += 1
+      change_author @commit_count
+
+      add_commit file
     end
   end
 end

data/jekyll-git-authors.gemspec

@@ -1,38 +1,40 @@
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "jekyll-git-authors/version"
+require 'jekyll-git-authors/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "jekyll-git-authors"
+  spec.name          = 'jekyll-git-authors'
   spec.version       = JekyllGitAuthors::VERSION
-  spec.authors       = ["Jaroslav Prokop"]
-  spec.email         = ["jar.prokop@volny.cz"]
+  spec.authors       = ['Jaroslav Prokop']
+  spec.email         = ['jar.prokop@volny.cz']
 
-  spec.summary       = %q{Jekyll plugin that adds git authors into your page.}
-  spec.description   = %q{Jekyll plugin that adds git authors and their obfuscated email address into page using markdown and liquid.}
-  spec.homepage      = "https://gitlab.com/jackorp/jekyll-git-authors"
-  spec.license       = "MIT"
+  spec.summary       = 'Jekyll plugin that adds git authors into your page.'
+  spec.description   = 'Jekyll plugin that adds git authors and their obfuscated email address' \
+    'into page using markdown and liquid.'
+  spec.homepage      = 'https://gitlab.com/jackorp/jekyll-git-authors'
+  spec.license       = 'MIT'
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
   # to allow pushing to a single host or delete this section to allow pushing to any host.
   if spec.respond_to?(:metadata)
-    spec.metadata["allowed_push_host"] = 'https://rubygems.org'
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
   else
-    raise "RubyGems 2.0 or newer is required to protect against " \
-      "public gem pushes."
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
   end
 
   spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_dependency "jekyll"
-  spec.add_dependency "jekyll-email-protect"
+  spec.add_dependency 'jekyll'
+  spec.add_dependency 'jekyll-email-protect'
 
-  spec.add_development_dependency "simplecov"
-  spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "minitest"
-  spec.add_development_dependency "cucumber"
-  spec.add_development_dependency "rspec"
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'cucumber'
+  spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'rake', '~> 12'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'simplecov'
 end

data/lib/jekyll-git-authors.rb

@@ -1,50 +1,67 @@
 require 'jekyll-git-authors/version'
 require 'jekyll-git-authors/markdown'
 require 'jekyll-git-authors/git'
+require 'jekyll-git-authors/author'
 
 require 'jekyll'
 
-# This script gets last 5 authors of a file and writes them at the end of the file.
-
 module Jekyll
   class AuthorsGenerator < Generator
     safe true
     priority :high
 
+    def initialize(config = {})
+      super(config)
+
+      @options = {
+        'max_authors' => 5,
+        'center' => true,
+        'thematic_break' => true,
+        'prefix' => 'Authors:'
+      }.merge(config['git_authors'] || {})
+    end
+
     # iterate through pages then pick those which are
     # are markdown file then call Git#log on the page
     # and add authors into its content
-    def generate(site)
-      puts "\nGenerating authors"
+    def generate(site) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+      Jekyll.logger.info 'Git authors:', 'Generating authors...'
 
-      # Find every .md file that is in subdirectory,
-      # then go into directory where page is located.
-      # Git finds authors for us if we call Git#log in directory
-      # where the file is located.
       site.pages.each do |page|
-        file = page.path
+        page_path = page.path
         # If file ends with md and if it is subdir.
-        # Jekyll does not add "./" into pages paths,
-        # so we can use this approach.
-        if file =~ /\.md/ and file =~ /\//
-          Dir.chdir File.dirname(file) do |path|
-            output = authors File.basename(file)
+        # Jekyll does not add "./" into pages paths, so we can use this approach.
+        next unless page_path =~ /\.md/ && page_path =~ /\//
 
-            page.content += output
+        Dir.chdir File.dirname(page_path) do
+          begin
+            output = authors File.basename(page_path)
+          rescue JekyllGitAuthors::Git::ExecutionError => e
+            Jekyll.logger.error 'Error:', "Git authors: #{page_path} is not in git, cannot generate authors."
+            Jekyll.logger.error 'Git authors failed,', " Command: '#{e.command}', Git: '#{e.stderr}'"
+            break
           end
+
+          Jekyll.logger.debug 'Git authors:', 'Generating authors for ' + page_path.to_s
+
+          page.content += output
         end
       end
     end
 
     # Gets the authors and then adds required formatting.
     def authors(file)
-      author_md = Git.log(file).author_email
+      author_md = JekyllGitAuthors::Git.log(file, @options['max_authors']).authors
       author_md = author_md.sort
-      author_md = author_md.map { |a, e| Markdown.mailto(a, e) }
+      format author_md
+    end
 
-      output = author_md.join ', '
-      output = "Authors: #{output}"
-      Markdown.center output
+    def format(authors)
+      markdown = JekyllGitAuthors::Markdown.new authors.map(&:to_markdown).join(', ')
+      markdown = markdown.prefix(@options['prefix'])
+      markdown = markdown.center if @options['center']
+      markdown = markdown.thematic_break if @options['thematic_break']
+      markdown.to_s
     end
   end
 end

data/lib/jekyll-git-authors/author.rb

@@ -0,0 +1,13 @@
+require_relative 'markdown'
+
+module JekyllGitAuthors
+  Author = Struct.new(:name, :email) do
+    def <=>(author)
+      name <=> author.name
+    end
+
+    def to_markdown
+      JekyllGitAuthors::Markdown.new("[#{name}](mailto:{{ '#{email}' | encode_email }})")
+    end
+  end
+end

data/lib/jekyll-git-authors/git.rb

@@ -1,55 +1,76 @@
-module Git
-  # Git::Log parses output passed from Git#log and creates a hash with author as a key and email as value
-  class Log
-    # We are expecting output from "git log" command
-    def initialize(log)
-      @log = log
+require 'open3'
+require_relative 'author'
+
+module JekyllGitAuthors
+  module Git
+    # Git::Log parses output passed from Git#log and creates a hash with author as a key and email as value
+    class Log
+      # We are expecting output from "git log" command
+      # max_authors_count - maximum number of unique authors to return
+      def initialize(log, max_authors_count = 5)
+        @log = log.force_encoding(Encoding::UTF_8)
+        @max_authors_count = max_authors_count
+
+        raise InvalidEncoding unless @log.valid_encoding?
+      end
+
+      # Create array of unique authors and return maximum specified by @max_authors_count.
+      def authors
+        @log.each_line
+          .map { |author| author.strip.split(';') }
+          .map { |name, email| JekyllGitAuthors::Author.new name, email }
+          .uniq { |author| author[:name] }
+          .take @max_authors_count
+      end
+
+      # To ensure log will be text when we want
+      def to_s
+        @log
+      end
     end
 
-    # Iterate through each line in the log
-    # filter out whitespace characters, split the line by semicolon
-    # assign the returned pair (i.e. author and email) to author and email variables
-    # then create hash with author as key and email as value and return it.
-    # Return from function if we have 5 authors
-    def author_email
-      author_email = Hash.new
-      @log.each_line do |line|
-        author, mail = line.strip.split(';')
+    class ExecutionError < StandardError
+      attr_reader :command, :stdout, :stderr
 
-        author_email[author] = mail unless author_email.key?(author)
+      def initialize(command, stdout, stderr)
+        @command = command
+        @stdout = stdout
+        @stderr = stderr
 
-        return author_email if author_email.size == 5
+        super "Git command failed: '#{@command}', Git error message: #{@stderr}"
       end
-      author_email
     end
 
-    # To ensure log will be text when we want
-    def to_s
-      @log
+    # Custom exception to raise when Git::Log receives invalid log.
+    class InvalidEncoding < StandardError
+      def initialize(msg = 'Git log contains invalid UTF-8 bytes.')
+        super
+      end
     end
-  end
 
-  # Take a git command and execute
-  # Abort if command didn't execute successfully
-  # then return output of the command.
-  # Print custom message if required.
-  def self.execute(command, msg = '')
-    output = `git #{command}`
+    # Take a git command and execute
+    # Raise Git::ExecutionError if command didn't execute successfully
+    # then return output of the command.
+    # Print custom message if required.
+    def self.execute(command)
+      stdout, stderr, status = Open3.capture3("git #{command}")
 
-    abort "Git command failed: '#{command}'" + " #{msg}" unless $?.success?
+      raise Git::ExecutionError.new(command, stdout, stderr) unless status.success?
 
-    return output
-  end
+      stdout
+    end
 
-  # Check if file is tracked with git.
-  # If it is not, exit status 1 will be returned by git.
-  # so it will be aborted by execute method.
-  #
-  # Create instance of Git::Log and pass it output from git log command
-  # return 5 last authors of a particular file
-  # %an returns author, semicolon for effortless parsing, %ae return email of author
-  def self.log(file)
-    Git.execute("ls-files --error-unmatch #{file}", "File is not added in git: #{file}")
-    Log.new(execute("log --pretty=format:'%an;%ae' #{file}"))
+    # Check if file is tracked with git.
+    # If it is not, exit status 1 will be returned by git.
+    # so it will be aborted by execute method.
+    # max_authors_count - maximum of returned authors
+    #
+    # Create instance of Git::Log and pass it output from git log command
+    # return 5 last authors of a particular file
+    # %an returns author, semicolon for effortless parsing, %ae return email of author
+    def self.log(file, max_authors_count = 5)
+      Git.execute("ls-files --error-unmatch #{file}")
+      Log.new(execute("log --pretty=format:'%an;%ae' #{file}"), max_authors_count)
+    end
   end
 end

data/lib/jekyll-git-authors/markdown.rb

@@ -1,9 +1,36 @@
-module Markdown
-  def self.mailto(a, e)
-    "[#{a}](mailto:{{ '#{e}' | encode_email }})"
-  end
+module JekyllGitAuthors
+  class Markdown
+    # @param [String] text - string that will be edited.
+    def initialize(text)
+      @text = text
+    end
+
+    # Center @text.
+    # @return [Markdown]
+    def center
+      text = %Q|{:center: style="text-align: center"}\n#{@text}\n{:center}|
+      self.class.new text
+    end
+
+    # Insert horizontal rule with ID 'authors-rule' above '@text'.
+    # @return [Markdown]
+    def thematic_break
+      text = "\n_  _  _  _\n{: #authors-rule}" + "\n#{@text}"
+      self.class.new text
+    end
+
+    # Insert prefix before '@text'.
+    # e.g. +markdown.prefix('Authors:')+ generates 'Authors: foo, bar'
+    # @return [Markdown]
+    def prefix(prefix)
+      text = "#{prefix} #{@text}"
+      self.class.new text
+    end
 
-  def self.center(text)
-    '{:center: style="text-align: center"}' + "\n#{text}\n{:center}"
+    # Return @text.
+    # @return [String]
+    def to_s
+      @text
+    end
   end
 end

data/lib/jekyll-git-authors/version.rb

@@ -1,3 +1,3 @@
 module JekyllGitAuthors
-  VERSION = "0.2.1"
+  VERSION = '1.0.0'.freeze
 end

data/test/author_test.rb

@@ -0,0 +1,23 @@
+require_relative 'test_helper'
+
+class TestAuthor < Minitest::Test
+  def test_spaceship_operator
+    authors = []
+    3.downto(0) do |num|
+      name, email = "you#{num}", "you#{num}@example.com"
+      author = JekyllGitAuthors::Author.new name, email
+      authors << author
+    end
+
+    assert_equal authors.last, authors.min
+    assert_equal authors.first, authors.max
+  end
+
+  def test_to_markdown
+    name, email = 'John Doe', 'john@doe.com'
+    author = JekyllGitAuthors::Author.new name, email
+
+    assert_equal "[#{name}](mailto:{{ '#{email}' | encode_email }})", author.to_markdown.to_s
+    assert_kind_of JekyllGitAuthors::Markdown, author.to_markdown
+  end
+end

data/test/git_test.rb

@@ -1,7 +1,5 @@
-require "fileutils"
-
+require 'fileutils'
 require_relative './test_helper.rb'
-require 'jekyll-git-authors.rb'
 
 class TestGit < Minitest::Test
   def setup
@@ -16,14 +14,13 @@ class TestGit < Minitest::Test
 
     Dir.chdir @dir
 
+    JekyllGitAuthors::Git.execute 'init'
 
-    Git.execute 'init'
-
-    Git.execute 'config user.email "you@example.com"'
-    Git.execute 'config user.name "Your Name"'
+    JekyllGitAuthors::Git.execute 'config user.email "you@example.com"'
+    JekyllGitAuthors::Git.execute 'config user.name "Your Name"'
 
-    Git.execute 'add .'
-    Git.execute 'commit -m "Initial commit"'
+    JekyllGitAuthors::Git.execute 'add .'
+    JekyllGitAuthors::Git.execute 'commit -m "Initial commit"'
   end
 
   def teardown
@@ -32,64 +29,118 @@ class TestGit < Minitest::Test
   end
 
   def test_that_git_executes_basic_commands
-    assert_match /^git version /, Git.execute('--version')
+    assert_match(/^git version /, JekyllGitAuthors::Git.execute('--version'))
   end
 
-  def test_that_git_aborts_on_invalid_command
+  def test_that_git_raises_execution_error_on_invalid_command
     invalid_command = 'patses'
-    assert_output('', /^Git command failed: '#{invalid_command}' /) do
-      assert_raises(SystemExit) do
-        Git.execute invalid_command
-      end
+    err_message = "Git command failed: '#{invalid_command}', "
+
+    exception = assert_raises(JekyllGitAuthors::Git::ExecutionError) do
+      JekyllGitAuthors::Git.execute invalid_command
     end
+    assert_match err_message, exception.message
+  end
+
+  def test_git_log
+    method_output = JekyllGitAuthors::Git.log File.join(@subdir, 'README.md')
+    assert_equal 'Your Name;you@example.com', method_output.to_s
   end
 
-  def test_that_git_aborts_with_custom_message
-    invalid_command = 'burger order'
-    err_message = "We do not serve burgers"
+  def test_that_git_log_raises_exception_with_message_when_file_is_not_tracked_in_git
+    FileUtils.cp "#{@original_dir}/test/fixtures/README.md", @dir
+    file = './README.md'
+    err_message = "Git command failed: 'ls-files --error-unmatch ./README.md'"
 
-    assert_output('', /^Git command failed: '#{invalid_command}' #{err_message}/) do
-      assert_raises(SystemExit)do
-        Git.execute invalid_command, err_message
-      end
+    exception = assert_raises(JekyllGitAuthors::Git::ExecutionError) do
+      JekyllGitAuthors::Git.log(file)
     end
+    assert_match err_message, exception.message
   end
 
-  def test_git_log
-    method_output = Git.log File.join(@subdir, 'README.md')
-    assert_equal "Your Name;you@example.com", "#{method_output}"
+  def test_log_called_when_there_is_no_git_repository
+    FileUtils.rm_rf "#{@dir}/.git"
+    err_message = "Git command failed: 'ls-files"
+
+    exception = assert_raises(JekyllGitAuthors::Git::ExecutionError) do
+      JekyllGitAuthors::Git.log File.join(@subdir, 'README.md')
+    end
+    assert_match err_message, exception.message
+  end
+end
+
+class TestGitExecutionError < Minitest::Test
+  def test_execution_error_has_redeable_executed_command_stdout_and_stderr
+    command, stdout, stderr = 'add .', 'foo', 'bar'
+
+    exception = assert_raises(JekyllGitAuthors::Git::ExecutionError) do
+      raise JekyllGitAuthors::Git::ExecutionError.new(command, stdout, stderr)
+    end
+
+    assert_equal command, exception.command
+    assert_equal stdout, exception.stdout
+    assert_equal stderr, exception.stderr
   end
 
-  def test_latest_author_email_is_used
+  def test_execution_error_has_default_message
+    command = 'ckommnd'
+    err_message = "Git command failed: '#{command}', Git error message: "
+
+    exception = assert_raises(JekyllGitAuthors::Git::ExecutionError) do
+      raise JekyllGitAuthors::Git::ExecutionError.new command, nil, nil
+    end
+
+    assert_match err_message, exception.message
+  end
+end
+
+class TestGitInvalidEncoding < Minitest::Test
+  def test_invalid_encoding_has_default_message
+    err_message = 'Git log contains invalid UTF-8 bytes.'
+
+    exception = assert_raises(JekyllGitAuthors::Git::InvalidEncoding) do
+      raise JekyllGitAuthors::Git::InvalidEncoding
+    end
+
+    assert_match err_message, exception.message
+  end
+end
+
+class TestGitLog < Minitest::Test
+  def author
+    JekyllGitAuthors::Author.new('Your Name', 'you@example.com')
+  end
+
+  def test_latest_email_is_used
     output = "Your Name;you@example.com\nYour Name;me@example.com"
-    git_log = Git::Log.new output
-    assert_equal({"Your Name"=>"you@example.com"}, git_log.author_email)
+    git_log = JekyllGitAuthors::Git::Log.new output
+    assert_equal [author], git_log.authors
   end
 
   def test_that_it_logs_single_author_once_if_author_has_multiple_commits
     output = "Your Name;you@example.com\nYour Name;you@example.com"
-    git_log = Git::Log.new output
-    assert_equal({"Your Name"=>"you@example.com"}, git_log.author_email)
+    git_log = JekyllGitAuthors::Git::Log.new output
+    assert_equal [author], git_log.authors
   end
 
   def test_that_it_logs_multiple_authors
     output = "Your Name;you@example.com\nMy Name;me@example.org"
-    git_log = Git::Log.new output
-    assert_equal({"Your Name"=>"you@example.com", "My Name"=>"me@example.org"}, git_log.author_email)
+    git_log = JekyllGitAuthors::Git::Log.new output
+    assert_equal [author, JekyllGitAuthors::Author.new('My Name', 'me@example.org')], git_log.authors
   end
 
-  def test_method_author_email_stops_at_5_authors
-    authors = ""
-    6.times do |num|
+  def test_method_authors_stops_when_max_authors_count_is_specified
+    authors = ''
+    9.times do |num|
       authors << "Your Name#{num};you#{num}@example.com\n"
     end
-    git_log = Git::Log.new authors
+    git_log = JekyllGitAuthors::Git::Log.new authors, 7
 
-    assert_equal 5, git_log.author_email.size
+    assert_equal 7, git_log.authors.size
   end
 
-  def test_method_author_email_iterates_through_authors
-    authors = ""
+  def test_method_authors_iterates_through_authors
+    authors = ''
     3.times do
       authors << "Your Name0;you0@example.com\n"
     end
@@ -100,29 +151,29 @@ class TestGit < Minitest::Test
       authors << "Your Name#{num};you#{num}@example.com\n"
     end
 
-    git_log = Git::Log.new authors
+    git_log = JekyllGitAuthors::Git::Log.new authors
 
-    assert_includes git_log.author_email, 'Your Name4'
-    assert_equal 5, git_log.author_email.size
+    assert_equal JekyllGitAuthors::Author.new('Your Name4', 'you4@example.com'), git_log.authors.last
+    assert_equal 5, git_log.authors.size
   end
 
-  def test_that_git_log_aborts_with_custom_message_when_file_is_not_tracked_in_git
-    FileUtils.cp "#{@original_dir}/test/fixtures/README.md", @dir
-    file = './README.md'
-    err_message = "Git command failed: 'ls-files --error-unmatch ./README.md' File is not added in git: ./README.md"
+  def test_git_log_parses_valid_utf8_bytes_and_outputs_authors
+    valid_bytes = "\xC4\x9B\xC5\xA1\xC4\x8D\xC5\x99;foo@bar.com".force_encoding('ASCII-8BIT')
+    git_log = JekyllGitAuthors::Git::Log.new valid_bytes
 
-    assert_output('', /^#{err_message}/) do
-      assert_raises(SystemExit) do
-        Git.log(file)
-      end
-    end
+    assert_equal [JekyllGitAuthors::Author.new('ěščř', 'foo@bar.com')], git_log.authors
   end
 
-  def test_log_called_when_there_is_no_git_repository
-    FileUtils.rm_rf "#{@dir}/.git"
+  def test_that_git_log_raises_custom_exception_with_message_if_log_contains_invalid_utf8_bytes
+    # The sequence has randomly erased bytes.
+    invalid_bytes = "\xE3\xD3\x8B\xE3\x83\xBC\x83\xE3\x83\xE3\x82\xB3\xA3\x82\x99" \
+      "\xE3\x83\xB3\xE3\x83\x8F\xE3\x82\x9A\xC3\xBD;foo@bar.com"
+    msg = 'Git log contains invalid UTF-8 bytes.'
 
-    assert_raises(SystemExit) do
-      Git.log File.join(@subdir, 'README.md')
+    exception = assert_raises(JekyllGitAuthors::Git::InvalidEncoding) do
+      JekyllGitAuthors::Git::Log.new invalid_bytes
     end
+
+    assert_match msg, exception.message
   end
 end

data/test/jekyll-git-authors_test.rb

@@ -14,14 +14,13 @@ class TestJekyllGitAuthors < Minitest::Test
 
     Dir.chdir @dir
 
+    JekyllGitAuthors::Git.execute 'init'
 
-    Git.execute 'init'
+    JekyllGitAuthors::Git.execute 'config user.email "you@example.com"'
+    JekyllGitAuthors::Git.execute 'config user.name "Your Name"'
 
-    Git.execute 'config user.email "you@example.com"'
-    Git.execute 'config user.name "Your Name"'
-
-    Git.execute 'add .'
-    Git.execute 'commit -m "Initial commit"'
+    JekyllGitAuthors::Git.execute 'add .'
+    JekyllGitAuthors::Git.execute 'commit -m "Initial commit"'
   end
 
   def teardown
@@ -30,9 +29,23 @@ class TestJekyllGitAuthors < Minitest::Test
   end
 
   def test_that_authors_method_formats_correctly
-    expected ="{:center: style=\"text-align: center\"}\nAuthors: [Your Name](mailto:{{ 'you@example.com' | encode_email }})\n{:center}" 
+    expected = "\n_  _  _  _\n{: #authors-rule}\n{:center: style=\"text-align: center\"}" \
+      "\nAuthors: [Your Name](mailto:{{ 'you@example.com' | encode_email }})\n{:center}"
+
     authors_generator = Jekyll::AuthorsGenerator.new
     actual = authors_generator.authors 'subdir/README.md'
+
+    assert_equal expected, actual
+  end
+
+  def test_format
+    authors = [JekyllGitAuthors::Author.new('Your Name', 'you@example.com')]
+    expected = "\n_  _  _  _\n{: #authors-rule}\n{:center: style=\"text-align: center\"}\n" \
+      "Authors: [Your Name](mailto:{{ 'you@example.com' | encode_email }})\n{:center}"
+
+    authors_generator = Jekyll::AuthorsGenerator.new
+    actual = authors_generator.format authors
+
     assert_equal expected, actual
   end
 end

data/test/markdown_test.rb

@@ -2,13 +2,25 @@ require_relative './test_helper'
 require 'jekyll-git-authors/markdown'
 
 class TestMarkdown < Minitest::Test
-  def test_markdown_mailto
-    author, email = "Your Name", "you@example.com"
-    assert_match "[#{author}](mailto:{{ '#{email}' | encode_email }})", Markdown.mailto(author, email)
+  def setup
+    @author, @email = 'you', 'you@example.com'
+    @author_email = [JekyllGitAuthors::Author.new(@author, @email)]
+    @text = 'foobar'
+  end
+
+  def markdown(text)
+    JekyllGitAuthors::Markdown.new(text)
   end
 
   def test_markdown_center
-    text = 'foo'
-    assert_match %Q|{:center: style="text-align: center"}\n#{text}\n{:center}|, Markdown.center(text)
+    assert_match %Q|{:center: style="text-align: center"}\n#{@text}\n{:center}|, markdown(@text).center.to_s
+  end
+
+  def test_markdown_thematic_break
+    assert_match "\n_  _  _  _\n{: #authors-rule}\n#{@text}", markdown(@text).thematic_break.to_s
+  end
+
+  def test_prefix
+    assert_match "Authors: #{@text}", markdown(@text).prefix('Authors:').to_s
   end
 end

data/test/test_helper.rb

@@ -1,4 +1,4 @@
-$:.unshift File.join(File.dirname(__FILE__), "..", "lib")
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
 
 if ENV['CODE_COV']
   require 'simplecov'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-git-authors
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Jaroslav Prokop
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-29 00:00:00.000000000 Z
+date: 2019-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -39,7 +39,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: cucumber
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,35 +67,35 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -95,7 +109,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: cucumber
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -109,7 +123,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -122,8 +136,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Jekyll plugin that adds git authors and their obfuscated email address
-  into page using markdown and liquid.
+description: Jekyll plugin that adds git authors and their obfuscated email addressinto
+  page using markdown and liquid.
 email:
 - jar.prokop@volny.cz
 executables: []
@@ -132,20 +146,25 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".gitlab-ci.yml"
+- ".rubocop.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - features/fixtures/page.md
+- features/options.feature
 - features/render_output.feature
+- features/step_definitions/options.rb
 - features/step_definitions/render_output.rb
 - features/support/env.rb
 - features/support/helper.rb
 - jekyll-git-authors.gemspec
 - lib/jekyll-git-authors.rb
+- lib/jekyll-git-authors/author.rb
 - lib/jekyll-git-authors/git.rb
 - lib/jekyll-git-authors/markdown.rb
 - lib/jekyll-git-authors/version.rb
+- test/author_test.rb
 - test/fixtures/README.md
 - test/git_test.rb
 - test/jekyll-git-authors_test.rb
@@ -178,10 +197,13 @@ specification_version: 4
 summary: Jekyll plugin that adds git authors into your page.
 test_files:
 - features/fixtures/page.md
+- features/options.feature
 - features/render_output.feature
+- features/step_definitions/options.rb
 - features/step_definitions/render_output.rb
 - features/support/env.rb
 - features/support/helper.rb
+- test/author_test.rb
 - test/fixtures/README.md
 - test/git_test.rb
 - test/jekyll-git-authors_test.rb