jekyll-git-authors 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 962f274c866f991682c026c110fce361df5fbb1a138a41ba469ac7be6efc580d
+  data.tar.gz: 8554f452c67fb539b3c02ce4e2ff0193c7518950176c2258d95c34bc97b7d412
+SHA512:
+  metadata.gz: f41aa87099c2b994b1cf66a57fd15a1716c21f72e434611494b7b2cca3fb5786b3844c65e2c8cb111806c8f5a36d6edc9f22d01296f32326d5052651159ea7dd
+  data.tar.gz: 8b1d6dfab838638a2e2f7fc455684fb72e92c203a067fe61d864d6f669915a81ec575254c6afc6cac44430b7b8011978f48a07ef546b356f1a328f7e6f5ada0b

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.swp
+*.gem
+*.bak

data/.gitlab-ci.yml

@@ -0,0 +1,13 @@
+before_script:
+  - bundle update listen
+  - bundle install
+
+test:2.4:
+  image: ruby:2.4
+  script:
+    - bundle exec rake
+
+test:2.5:
+  image: ruby:2.5
+  script:
+    - bundle exec rake

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,73 @@
+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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 jackorp
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,36 @@
+# Git Authors Generator for Jekyll
+
+This generator adds last 5 authors and their obfuscated email adress from git commit history into markdown formatted page.
+Be sure to also have [jekyll-email-protect](https://github.com/vwochnik/jekyll-email-protect) installed correctly to obfuscate email addresses!
+
+## Installation
+
+This plugin is available as a [rubygem]().
+
+Add this line to your application's `Gemfile`:
+
+```
+gem 'jekyll-git-authors'
+```
+
+And then execute the `bundle` command to install the gem.
+
+Alternatively, you can also manually install the gem using the following command:
+
+```
+$ 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:
+- jekyll-git-authors
+```
+## Contributing
+
+Bug reports and pull requests are welcome at https://gitlab.com/jackorp/jekyll-git-authors.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rake/testtask'
+
+task :default => :test
+Rake::TestTask.new do |t|
+  t.libs = ["lib"]
+  t.verbose = true
+  t.test_files = FileList['test/*_test.rb']
+end

data/jekyll-git-authors.gemspec

@@ -0,0 +1,37 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "jekyll-git-authors/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "jekyll-git-authors"
+  spec.version       = JekyllGitAuthors::VERSION
+  spec.authors       = ["jackorp"]
+  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"
+
+  # 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'
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "jekyll"
+  spec.add_dependency "jekyll-email-protect"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+end

data/lib/jekyll-git-authors.rb

@@ -0,0 +1,137 @@
+require_relative './jekyll-git-authors/version.rb'
+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 --recursive 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
+    priority :high
+
+    # 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"
+
+      repositories = Git.submodules
+
+      # For each submodule we go into directory of that submodule
+      # before executing Git#log, then go back where we were.
+      site.pages.each do |page|
+        if page.path =~ /\.md/
+          repositories.each do |repository|
+            original_dir = Dir.pwd
+            Dir.chdir repository
+            p "Going into #{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
+
+            p "Adding Authors into #{page.path}"
+
+            Dir.chdir original_dir
+            p "Going back to #{original_dir}"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,3 @@
+module JekyllGitAuthors
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-git-authors
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- jackorp
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-06-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: jekyll-email-protect
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  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
+    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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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:
+- jar.prokop@volny.cz
+executables: []
+extensions: []
+extra_rdoc_files: []
+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/version.rb
+homepage: https://gitlab.com/jackorp/jekyll-git-authors
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Jekyll plugin that adds git authors into your page.
+test_files: []