jekyll-git-authors 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 56f16a9833a6d2c0ea29b3af6e0ede1455154b8d0e8216018c68f058e37d10a4
-  data.tar.gz: 5e069b91a4fc9179d3b6b7b0f3aee15ab72a23365e2c2a07b340ff6b57fcc2d3
+  metadata.gz: ad4da7350ddf894bb087396bbcdd866cc128e03d7678c471f56e6ea08fafc4e2
+  data.tar.gz: 3b92eef4c6399de9bc9384331ef53bebf38c2b300dd7b49d564232e68eade1d8
 SHA512:
-  metadata.gz: 6db8590b31df33735fb64dcb05679c555f153e9f33017b6a7ae76dc843e923a0f1ab4f46d8dff2d8526ac894da9506abe5aa71f8aee074a1e1e39ed72cd8ff16
-  data.tar.gz: 8c179ba6c81ab872ab7660a8f7e1c0b063e8c211f115e947a96136af406d6bbd12c73412ea29665eb2c6def510fb1f3f3e0dbddb86c88f84189add4488f1877d
+  metadata.gz: 2fc25d3f46dba490466259ce48d19d16fecf30d8abc3edcf4584929d64f088f821418e2788c7d170fcdc8a6d273124fc98aed8d12c4e73d22b2397fab0db22f0
+  data.tar.gz: 0e832ecd08ec6d381eebae13bc5c36bd080f1674a6aee10d2e8a21202fdfa3a9bca783c47f12aaf2b74a4918698f11481bd73d2eab402ab67785358cc3f33cd0

data/.gitignore

@@ -9,3 +9,4 @@
 *.swp
 *.gem
 *.bak
+Gemfile.lock

data/.gitlab-ci.yml

@@ -1,13 +1,28 @@
 before_script:
-  - bundle update listen
   - bundle install
 
 test:2.4:
   image: ruby:2.4
   script:
-    - bundle exec rake
+    - rake
 
 test:2.5:
   image: ruby:2.5
   script:
-    - bundle exec rake
+    - CODE_COV=TRUE rake
+  artifacts:
+    paths:
+      - coverage/
+
+pages:
+  stage: deploy
+  dependencies:
+    - test:2.5
+  script:
+    - mv coverage/ public/
+  artifacts:
+    paths:
+      - public
+    expire_in: 30 days
+  only:
+    - master

data/Gemfile

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

data/README.md

@@ -1,3 +1,5 @@
+[![coverage report](https://gitlab.com/jackorp/jekyll-git-authors/badges/master/coverage.svg)](https://gitlab.com/jackorp/jekyll-git-authors/commits/master) [![pipeline status](https://gitlab.com/jackorp/jekyll-git-authors/badges/master/pipeline.svg)](https://gitlab.com/jackorp/jekyll-git-authors/commits/master) 
+
 # Git Authors Generator for Jekyll
 
 This generator adds last 5 authors and their obfuscated email adress from git commit history into markdown formatted page.
@@ -24,7 +26,7 @@ $ gem install jekyll-git-authors
 After the plugin has been installed successfully, add the following lines to your `_config.yml` in order to tell Jekyll to use the plugin:
 
 ```
-gems:
+plugins:
 - jekyll-git-authors
 ```
 ## Contributing

data/Rakefile

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

data/jekyll-git-authors.gemspec

@@ -1,4 +1,3 @@
-
 lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "jekyll-git-authors/version"
@@ -6,7 +5,7 @@ require "jekyll-git-authors/version"
 Gem::Specification.new do |spec|
   spec.name          = "jekyll-git-authors"
   spec.version       = JekyllGitAuthors::VERSION
-  spec.authors       = ["jackorp"]
+  spec.authors       = ["Jaroslav Prokop"]
   spec.email         = ["jar.prokop@volny.cz"]
 
   spec.summary       = %q{Jekyll plugin that adds git authors into your page.}
@@ -31,7 +30,10 @@ Gem::Specification.new do |spec|
   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"
 end

data/lib/jekyll-git-authors.rb

@@ -1,98 +1,11 @@
-require_relative './jekyll-git-authors/version.rb'
+require 'jekyll-git-authors/version'
+require 'jekyll-git-authors/markdown'
+require 'jekyll-git-authors/git'
+
 require 'jekyll'
 
 # This script gets last 5 authors of a file and writes them at the end of the file.
 
-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
-    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.
-    def author_email
-      author_email = Hash.new
-      @log.each_line do |line|
-        author, mail = line.strip.split(';')
-
-        author_email[author] = mail unless author_email.key?(author)
-      end
-      author_email
-    end
-
-    # To ensure log will be text when we want
-    def to_s
-      @log
-    end
-  end
-
-  # Git::Submodules parses output from Git#submodules and creates an array of submodules
-  class Submodules
-    # Expected input is "git submodule foreach 'echo $path'".
-    # That command gives us paths relative to current directory.
-    def initialize(paths)
-      @paths = paths
-    end
-
-    # Clean the @path from redundant text that git generates.
-    # First we take the @paths. We iterate through each line,
-    # ignore ballast git puts there 'Entering ...'
-    # and make it a path relative to the current directory
-    # that git puts there, we then add the absolute path into an array.
-    def extract_path
-      submodules = Array.new
-      @paths.each_line do |line|
-        unless line =~ /Entering/
-          line.strip!
-          line.sub!(/^#{Dir.pwd}\//, '')
-
-          submodules << line
-        end
-      end
-      submodules
-    end
-  end
-
-  # Take a git command and execute
-  # Abort if command didn't execute successfully
-  # then return output of the command.
-  def self.execute(command)
-    output = `git #{command}`
-
-    abort "Unknown git command: '#{command}'" unless $?.success?
-
-    return output
-  end
-
-  # Create instance of Git::Submodules and execute expected command.
-  # We receive array of absolute paths of all submodules
-  def self.submodules
-    Submodules.new(execute('submodule foreach pwd'))
-  end
-
-  # 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)
-    Log.new(execute("log -5 --pretty=format:'%an;%ae' #{file}"))
-  end
-end
-
-module Markdown
-  def self.mailto(a, e)
-    "[#{a}](mailto:{{ '#{e}' | encode_email }})"
-  end
-
-  def self.center(text)
-    '{:center: style="text-align: center"}' + "\n#{text}\n{:center}"
-  end
-end
-
 module Jekyll
   class AuthorsGenerator < Generator
     safe true
@@ -104,46 +17,34 @@ module Jekyll
     def generate(site)
       puts "\nGenerating authors"
 
-      repositories = Git.submodules.extract_path
-
-      # For each submodule we go into directory of that submodule
-      # delete the submodule dir from page path
-      # before executing Git#log, then go back where we were.
+      # 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
-        if file =~ /\.md/
-          repositories.each do |repository|
-            if file =~ /^#{repository}/
-              original_dir = Dir.pwd
-              Dir.chdir repository
-
-              file.sub!(repository, '.')
-
-              author_md = Git.log(file).author_email
-              author_md = author_md.sort
-              author_md = author_md.map { |a, e| Markdown.mailto(a, e) }
-
-              output = author_md.join ', '
-              output = "Authors: #{output}"
-              output = Markdown.center output
-
-              page.content += output
-
-              Dir.chdir original_dir
-            else
-              author_md = Git.log(file).author_email
-              author_md = author_md.sort
-              author_md = author_md.map { |a, e| Markdown.mailto(a, e) }
-
-              output = author_md.join ', '
-              output = "Authors: #{output}"
-              output = Markdown.center output
-
-              page.content += output
-            end
+        # 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)
+
+            page.content += output
           end
         end
       end
     end
+
+    # Gets the authors and then adds required formatting.
+    def authors(file)
+      author_md = Git.log(file).author_email
+      author_md = author_md.sort
+      author_md = author_md.map { |a, e| Markdown.mailto(a, e) }
+
+      output = author_md.join ', '
+      output = "Authors: #{output}"
+      Markdown.center output
+    end
   end
 end

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

@@ -0,0 +1,55 @@
+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
+    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(';')
+
+        author_email[author] = mail unless author_email.key?(author)
+
+        return author_email if author_email.size == 5
+      end
+      author_email
+    end
+
+    # To ensure log will be text when we want
+    def to_s
+      @log
+    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}`
+
+    abort "Git command failed: '#{command}'" + " #{msg}" unless $?.success?
+
+    return output
+  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}"))
+  end
+end

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

@@ -0,0 +1,9 @@
+module Markdown
+  def self.mailto(a, e)
+    "[#{a}](mailto:{{ '#{e}' | encode_email }})"
+  end
+
+  def self.center(text)
+    '{:center: style="text-align: center"}' + "\n#{text}\n{:center}"
+  end
+end

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-git-authors
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
-- jackorp
+- Jaroslav Prokop
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-10 00:00:00.000000000 Z
+date: 2018-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +94,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Jekyll plugin that adds git authors and their obfuscated email address
   into page using markdown and liquid.
 email:
@@ -91,12 +133,13 @@ files:
 - ".gitignore"
 - ".gitlab-ci.yml"
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - 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
 homepage: https://gitlab.com/jackorp/jekyll-git-authors
 licenses:

data/Gemfile.lock

@@ -1,73 +0,0 @@
-PATH
-  remote: .
-  specs:
-    jekyll-git-authors (0.1.0)
-      jekyll
-      jekyll-email-protect
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    addressable (2.5.2)
-      public_suffix (>= 2.0.2, < 4.0)
-    colorator (1.1.0)
-    concurrent-ruby (1.0.5)
-    em-websocket (0.5.1)
-      eventmachine (>= 0.12.9)
-      http_parser.rb (~> 0.6.0)
-    eventmachine (1.2.7)
-    ffi (1.9.25)
-    forwardable-extended (2.6.0)
-    http_parser.rb (0.6.0)
-    i18n (0.9.5)
-      concurrent-ruby (~> 1.0)
-    jekyll (3.8.3)
-      addressable (~> 2.4)
-      colorator (~> 1.0)
-      em-websocket (~> 0.5)
-      i18n (~> 0.7)
-      jekyll-sass-converter (~> 1.0)
-      jekyll-watch (~> 2.0)
-      kramdown (~> 1.14)
-      liquid (~> 4.0)
-      mercenary (~> 0.3.3)
-      pathutil (~> 0.9)
-      rouge (>= 1.7, < 4)
-      safe_yaml (~> 1.0)
-    jekyll-email-protect (1.1.0)
-    jekyll-sass-converter (1.5.2)
-      sass (~> 3.4)
-    jekyll-watch (2.0.0)
-      listen (~> 3.0)
-    kramdown (1.17.0)
-    liquid (4.0.0)
-    listen (3.1.5)
-      rb-inotify (~> 0.9, >= 0.9.7)
-    mercenary (0.3.6)
-    minitest (5.11.3)
-    pathutil (0.16.1)
-      forwardable-extended (~> 2.6)
-    public_suffix (3.0.2)
-    rake (10.5.0)
-    rb-fsevent (0.10.3)
-    rb-inotify (0.9.10)
-      ffi (>= 0.5.0, < 2)
-    rouge (3.1.1)
-    safe_yaml (1.0.4)
-    sass (3.5.6)
-      sass-listen (~> 4.0.0)
-    sass-listen (4.0.0)
-      rb-fsevent (~> 0.9, >= 0.9.4)
-      rb-inotify (~> 0.9, >= 0.9.7)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.16)
-  jekyll-git-authors!
-  minitest
-  rake (~> 10.0)
-
-BUNDLED WITH
-   1.16.1