jekyll-last-modified 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f47e0601cefb896369bac29cb594fadd2647f9c953bffd3c4b3b3bbc64e9b770
+  data.tar.gz: 7d97a4177607ff4360d21559ace39bfc59e0205895e6ad6570e21aca0143aa9d
+SHA512:
+  metadata.gz: cc8b09475d9272ee8336429619fcc811e443a40273ef8c3ce2f7dbfb0d304d703f9780ebc72e373fe6cf383b1f43b5bce7246ca315344790c43b544c303d8455
+  data.tar.gz: 17e32abb23844638dc404325ee64834a61dcc71f1343dbe1ced216c83d3605f47fff0059f54e6ad10ed9dfce681ad3dfbd07d14eb90b1fdbf1cb860f0fe9a3e9

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+sudo: required
+dist: trusty
+script: bundle exec rake test
+

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in jekyll-last-modified.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Ivan Tse
+
+MIT License
+
+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,3 @@
+# Jekyll::LastModified
+
+This is a fork of [ivantsepp/jekyll-git_metadata](https://github.com/ivantsepp/jekyll-git_metadata), with the addition that it populates `page.date` (if unset) and `page.last_modified_at` from retrieved Git metadata.

data/jekyll-last-modified.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "jekyll-last-modified"
+  spec.version       = '1.0.0'
+  spec.authors       = ["iBug"]
+  spec.email         = ["i@ibugone.com"]
+  spec.summary       = %q{Set page date from Git database}
+  spec.description   = %q{Populate page date and last modified date from Git database}
+  spec.homepage      = "https://github.com/iBug/jekyll-last-modified"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split "\0"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "jekyll", '>= 3.0'
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "shoulda"
+  spec.add_development_dependency "mocha"
+end

data/lib/jekyll-last-modified.rb

@@ -0,0 +1,6 @@
+require 'jekyll/last_modified'
+
+module Jekyll
+  module LastModified
+  end
+end

data/lib/jekyll/last_modified.rb

@@ -0,0 +1,149 @@
+require 'rbconfig'
+
+module Jekyll
+  module LastModified
+    class Generator < Jekyll::Generator
+
+      safe true
+
+      def generate(site)
+        raise "Git is not installed" unless git_installed?
+
+        Dir.chdir(site.source) do
+          data = load_git_metadata(site)
+          site.config['git'] = data['site_data']
+          jekyll_items(site).each do |page|
+            if page.is_a?(Jekyll::Page)
+              path = page.path
+            else
+              path = page.relative_path
+            end
+            page.data['git'] = data['pages_data'][path]
+            unless page.data['git'].nil?
+              page.data['last_modified_at'] = page.data['git']['last_commit']['commit_date']
+              if page.data['date'] == site.time
+                page.data['date'] = page.data['git']['first_commit']['commit_date']
+              end
+            end
+          end
+        end
+      end
+
+      def load_git_metadata(site)
+        current_sha = %x{ git rev-parse HEAD }.strip
+
+        cache_dir = site.source + '/.git-metadata'
+        FileUtils.mkdir_p(cache_dir) unless File.directory?(cache_dir)
+        cache_file = cache_dir + "/#{current_sha}.json"
+
+        if File.exist?(cache_file)
+          return JSON.parse(IO.read(cache_file))
+        end
+
+        pages_data = {}
+        jekyll_items(site).each do |page|
+          if page.is_a?(Jekyll::Page)
+            path = page.path
+          else
+            path = page.relative_path
+          end
+          pages_data[path] = page_data(path)
+        end
+        data = { 'site_data' => site_data, 'pages_data' => pages_data }
+
+        File.open(cache_file, 'w') { |f| f.write(data.to_json) }
+
+        data
+      end
+
+      def site_data
+        {
+          'project_name' => project_name,
+          'files_count' => files_count,
+        }.merge!(page_data)
+      end
+
+      def page_data(relative_path = nil)
+        return if relative_path && !tracked_files.include?(relative_path)
+
+        authors = self.authors(relative_path)
+        lines = self.lines(relative_path)
+        {
+          'authors' => authors,
+          'total_commits' => authors.inject(0) { |sum, h| sum += h['commits'] },
+          'total_additions' => lines.inject(0) { |sum, h| sum += h['additions'] },
+          'total_subtractions' => lines.inject(0) { |sum, h| sum += h['subtractions'] },
+          'first_commit' => commit(lines.last['sha']),
+          'last_commit' => commit(lines.first['sha'])
+        }
+      end
+
+      def authors(file = nil)
+        results = []
+        cmd = 'git shortlog -se HEAD'
+        cmd << " -- #{file}" if file
+        result = %x{ #{cmd} }
+        result.lines.each do |line|
+          commits, name, email = line.scan(/(.*)\t(.*)<(.*)>/).first.map(&:strip)
+          results << { 'commits' => commits.to_i, 'name' => name, 'email' => email }
+        end
+        results
+      end
+
+      def lines(file = nil)
+        cmd = "git log --numstat --format=%h"
+        cmd << " -- #{file}" if file
+        result = %x{ #{cmd} }
+        results = result.scan(/(.*)\n\n((?:.*\t.*\t.*\n)*)/)
+        results.map do |line|
+          files = line[1].scan(/(.*)\t(.*)\t(.*)\n/)
+          line[1] = files.inject(0){|s,a| s+=a[0].to_i}
+          line[2] = files.inject(0){|s,a| s+=a[1].to_i}
+        end
+        results.map do |line|
+          { 'sha' => line[0], 'additions' => line[1], 'subtractions' => line[2] }
+        end
+      end
+
+      def commit(sha)
+        result = %x{ git show --format=fuller --name-only #{sha} }
+        long_sha, author_name, author_email, author_date, commit_name, commit_email, commit_date, message, changed_files = result.scan(/commit (.*)\nAuthor:(.*)<(.*)>\nAuthorDate:(.*)\nCommit:(.*)<(.*)>\nCommitDate:(.*)\n\n((?:\s\s\s\s[^\r\n]*\n)*)\n(.*)/m).first.map(&:strip)
+        {
+          'short_sha' => sha,
+          'long_sha' => long_sha,
+          'author_name' => author_name,
+          'author_email' => author_email,
+          'author_date' => author_date,
+          'commit_name' => commit_name,
+          'commit_email' => commit_email,
+          'commit_date' => commit_date,
+          'message' => message.gsub(/    /, ''),
+          'changed_files' => changed_files.split("\n")
+        }
+      end
+
+      def tracked_files
+        @tracked_files ||= %x{ git ls-tree --full-tree -r --name-only HEAD }.split("\n")
+      end
+
+      def project_name
+        File.basename(%x{ git rev-parse --show-toplevel }.strip)
+      end
+
+      def files_count
+        %x{ git ls-tree -r HEAD }.lines.count
+      end
+
+      def git_installed?
+        null = RbConfig::CONFIG['host_os'] =~ /msdos|mswin|djgpp|mingw/ ? 'NUL' : '/dev/null'
+        system "git --version >>#{null} 2>&1"
+      end
+
+      private
+
+      def jekyll_items(site)
+        site.pages + site.collections.values.map(&:docs).flatten
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-last-modified
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- iBug
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-10-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  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: mocha
+  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: Populate page date and last modified date from Git database
+email:
+- i@ibugone.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- jekyll-last-modified.gemspec
+- lib/jekyll-last-modified.rb
+- lib/jekyll/last_modified.rb
+homepage: https://github.com/iBug/jekyll-last-modified
+licenses:
+- MIT
+metadata: {}
+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: []
+rubygems_version: 3.0.4
+signing_key: 
+specification_version: 4
+summary: Set page date from Git database
+test_files: []