jekyll-git-authors 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ad4da7350ddf894bb087396bbcdd866cc128e03d7678c471f56e6ea08fafc4e2
-  data.tar.gz: 3b92eef4c6399de9bc9384331ef53bebf38c2b300dd7b49d564232e68eade1d8
+  metadata.gz: 73738a3355402aebd9970f7e614524d0ce9a966f9f9589051f9cc95cbec334b9
+  data.tar.gz: 16431182d8bda9f840291c0b8545e7ea247b20b17f7252fbc3d45d497e1488d3
 SHA512:
-  metadata.gz: 2fc25d3f46dba490466259ce48d19d16fecf30d8abc3edcf4584929d64f088f821418e2788c7d170fcdc8a6d273124fc98aed8d12c4e73d22b2397fab0db22f0
-  data.tar.gz: 0e832ecd08ec6d381eebae13bc5c36bd080f1674a6aee10d2e8a21202fdfa3a9bca783c47f12aaf2b74a4918698f11481bd73d2eab402ab67785358cc3f33cd0
+  metadata.gz: f8a0275a90429c8f5136689dbfc3ecf112de4967ffddb2bc2783992487c9794b31e1c5c4070589f1bfd807f850740cf9496d281a43a79131886a919b7487fbe7
+  data.tar.gz: 18c332e37a3308d65a172705b5949dba8351b33da4dd6550fb628a772628b2f7e85a5ff37d05e85cf67ff803a3266e771e4035835da197358fb7cbc4d242a506

data/features/render_output.feature

@@ -0,0 +1,19 @@
+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"
+
+  Scenario: Authors are not generated for non-section pages
+    Given There is a fixture "page.md"
+    And There is 1 commit on the "page.md"
+    And There is 1 commit on the "subdir/page.md"
+    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"

data/features/step_definitions/render_output.rb

@@ -0,0 +1,55 @@
+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|
+  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
+
+  expect(log).to be_a_kind_of(Hash)
+end
+
+Given("There is/are {int} commit(s) on the {string}") do |int, file|
+  GitHelper.add_commit int, file
+
+  log = Git.execute("log --oneline #{file}").split("\n")
+  expect(log.size).to eq(int)
+end
+
+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')
+
+  @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("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
+
+  expect(matched_authors).to eq(int)
+end

data/features/support/env.rb

@@ -0,0 +1,26 @@
+$LOAD_PATH.unshift File.expand_path('../../../lib', __FILE__)
+require 'tmpdir'
+require 'fileutils'
+require 'jekyll'
+require 'jekyll-git-authors'
+# Using this file as a global hook to set up environment
+
+if ENV['CODE_COV']
+  require 'simplecov'
+  SimpleCov.start
+end
+
+Before do
+  @original_dir = Dir.pwd
+  @dir = Dir.mktmpdir 'jekyll-git-authors'
+  @subdir = File.join(@dir, 'subdir')
+
+  Dir.mkdir @subdir
+
+  Dir.chdir @dir
+end
+
+After do
+  Dir.chdir @original_dir
+  FileUtils.rm_rf @dir
+end

data/features/support/helper.rb

@@ -0,0 +1,27 @@
+module GitHelper
+  # Initialize git environment in current directory.
+  def self.init_repo
+    Git.execute 'init'
+
+    change_author('')
+  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}'"
+  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}" + '."'
+    end
+  end
+end

data/jekyll-git-authors.gemspec

@@ -22,9 +22,8 @@ Gem::Specification.new do |spec|
       "public gem pushes."
   end
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
-  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.add_dependency "jekyll"

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

@@ -1,3 +1,3 @@
 module JekyllGitAuthors
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

data/test/git_test.rb

@@ -0,0 +1,128 @@
+require "fileutils"
+
+require_relative './test_helper.rb'
+require 'jekyll-git-authors.rb'
+
+class TestGit < Minitest::Test
+  def setup
+    @original_dir = Dir.pwd
+    @dir = Dir.mktmpdir 'jekyll-git-authors'
+
+    @subdir = File.join(@dir, 'subdir')
+
+    Dir.mkdir @subdir
+
+    FileUtils.cp './test/fixtures/README.md', @subdir
+
+    Dir.chdir @dir
+
+
+    Git.execute 'init'
+
+    Git.execute 'config user.email "you@example.com"'
+    Git.execute 'config user.name "Your Name"'
+
+    Git.execute 'add .'
+    Git.execute 'commit -m "Initial commit"'
+  end
+
+  def teardown
+    Dir.chdir @original_dir
+    FileUtils.rm_rf @dir
+  end
+
+  def test_that_git_executes_basic_commands
+    assert_match /^git version /, Git.execute('--version')
+  end
+
+  def test_that_git_aborts_on_invalid_command
+    invalid_command = 'patses'
+    assert_output('', /^Git command failed: '#{invalid_command}' /) do
+      assert_raises(SystemExit) do
+        Git.execute invalid_command
+      end
+    end
+  end
+
+  def test_that_git_aborts_with_custom_message
+    invalid_command = 'burger order'
+    err_message = "We do not serve burgers"
+
+    assert_output('', /^Git command failed: '#{invalid_command}' #{err_message}/) do
+      assert_raises(SystemExit)do
+        Git.execute invalid_command, err_message
+      end
+    end
+  end
+
+  def test_git_log
+    method_output = Git.log File.join(@subdir, 'README.md')
+    assert_equal "Your Name;you@example.com", "#{method_output}"
+  end
+
+  def test_latest_author_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)
+  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)
+  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)
+  end
+
+  def test_method_author_email_stops_at_5_authors
+    authors = ""
+    6.times do |num|
+      authors << "Your Name#{num};you#{num}@example.com\n"
+    end
+    git_log = Git::Log.new authors
+
+    assert_equal 5, git_log.author_email.size
+  end
+
+  def test_method_author_email_iterates_through_authors
+    authors = ""
+    3.times do
+      authors << "Your Name0;you0@example.com\n"
+    end
+    3.times do
+      authors << "Your Name1;you1@example.com\n"
+    end
+    2.upto(8) do |num|
+      authors << "Your Name#{num};you#{num}@example.com\n"
+    end
+
+    git_log = Git::Log.new authors
+
+    assert_includes git_log.author_email, 'Your Name4'
+    assert_equal 5, git_log.author_email.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"
+
+    assert_output('', /^#{err_message}/) do
+      assert_raises(SystemExit) do
+        Git.log(file)
+      end
+    end
+  end
+
+  def test_log_called_when_there_is_no_git_repository
+    FileUtils.rm_rf "#{@dir}/.git"
+
+    assert_raises(SystemExit) do
+      Git.log File.join(@subdir, 'README.md')
+    end
+  end
+end

data/test/jekyll-git-authors_test.rb

@@ -0,0 +1,38 @@
+require_relative './test_helper'
+require 'jekyll-git-authors'
+
+class TestJekyllGitAuthors < Minitest::Test
+  def setup
+    @original_dir = Dir.pwd
+    @dir = Dir.mktmpdir 'jekyll-git-authors'
+
+    @subdir = File.join(@dir, 'subdir')
+
+    Dir.mkdir @subdir
+
+    FileUtils.cp './test/fixtures/README.md', @subdir
+
+    Dir.chdir @dir
+
+
+    Git.execute 'init'
+
+    Git.execute 'config user.email "you@example.com"'
+    Git.execute 'config user.name "Your Name"'
+
+    Git.execute 'add .'
+    Git.execute 'commit -m "Initial commit"'
+  end
+
+  def teardown
+    Dir.chdir @original_dir
+    FileUtils.rm_rf @dir
+  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}" 
+    authors_generator = Jekyll::AuthorsGenerator.new
+    actual = authors_generator.authors 'subdir/README.md'
+    assert_equal expected, actual
+  end
+end

data/test/markdown_test.rb

@@ -0,0 +1,14 @@
+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)
+  end
+
+  def test_markdown_center
+    text = 'foo'
+    assert_match %Q|{:center: style="text-align: center"}\n#{text}\n{:center}|, Markdown.center(text)
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,8 @@
+$:.unshift File.join(File.dirname(__FILE__), "..", "lib")
+
+if ENV['CODE_COV']
+  require 'simplecov'
+  SimpleCov.start
+end
+
+require 'minitest/autorun'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-git-authors
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Jaroslav Prokop
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-27 00:00:00.000000000 Z
+date: 2018-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -136,11 +136,21 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- features/fixtures/page.md
+- features/render_output.feature
+- 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/git.rb
 - lib/jekyll-git-authors/markdown.rb
 - lib/jekyll-git-authors/version.rb
+- test/fixtures/README.md
+- test/git_test.rb
+- test/jekyll-git-authors_test.rb
+- test/markdown_test.rb
+- test/test_helper.rb
 homepage: https://gitlab.com/jackorp/jekyll-git-authors
 licenses:
 - MIT
@@ -166,4 +176,14 @@ rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Jekyll plugin that adds git authors into your page.
-test_files: []
+test_files:
+- features/fixtures/page.md
+- features/render_output.feature
+- features/step_definitions/render_output.rb
+- features/support/env.rb
+- features/support/helper.rb
+- test/fixtures/README.md
+- test/git_test.rb
+- test/jekyll-git-authors_test.rb
+- test/markdown_test.rb
+- test/test_helper.rb