jekyll-last-commit 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b37651ca4010358f65dc170a7a30a6e59eadc345c0f63c785a8a591f38fb6c0
-  data.tar.gz: 70248fe1802e7901b23a7fccc39e090ac7c3a4119b2ba05829ce082fd29cf83c
+  metadata.gz: 545441f5818c9b03538f579d7635922c4d5d7b8e589f8260be880d2edc06173f
+  data.tar.gz: a8ef1cec4beedd36ce060af9844e93be188e17f9cd40c3b3f20c1a0b2c08aada
 SHA512:
-  metadata.gz: ffc9f7cb61b802b5b57807c0cf7e3aac824bb7300c1b4265b0afc5d235cca4fd579ad8db5e96a6e909fcb736a1a44bd0541968885f536b10a290e84f905e75be
-  data.tar.gz: d77971574e7154b23109361195b2eae6465bd88dabbd647cab03a017d25d34a95318d5004571e6b02d1da864c97cd3ffe04a5f149cfdd413e45daef0908520ec
+  metadata.gz: 43926e5afb45d6af9d59d4b775d18bc35dd4df9c75b2a70ea5f40b839b0bf96405088767d5e6e61e90a91e8c5f41d5c7ef6be7865cfcedbdaf4153433f77c067
+  data.tar.gz: fa3dedb65542e16d3c02b9ce1fa50ed0082fe029e89c5a649b074859f4b0f6ff42969dec6c8f218d495035acb90219405c629bea8f42ae7837c69ccdd4dd86b4

data/lib/jekyll-last-commit/generator.rb

@@ -0,0 +1,67 @@
+require 'jekyll'
+
+module JekyllLastCommit
+  class Generator < Jekyll::Generator
+
+    def generate(site)
+      repo_man = JekyllLastCommit::RepoMan.new(site.source)
+      repo_man.discover_repo()
+      repo_man.discover_commits(site.documents.map {|d| d.relative_path })
+      repo_man.discover_commits(site.pages.map {|p| p.relative_path })
+
+      date_format = site.config.dig('jekyll-last-commit', 'date_format')
+      date_format ||= '%B %d, %Y'
+
+      should_fall_back_to_mtime = site.config.dig('jekyll-last-commit', 'should_fall_back_to_mtime')
+      should_fall_back_to_mtime = should_fall_back_to_mtime.nil? ? true : should_fall_back_to_mtime
+
+      site.documents.each do |document|
+        commit = repo_man.find_commit(document.relative_path)
+
+        if commit.nil?
+          if should_fall_back_to_mtime
+            path_document = Jekyll.sanitized_path(site.source, document.relative_path)
+
+            if File.file?(path_document)
+              raw_time = Time.at(File.mtime(path_document).to_i)
+
+              Jekyll.logger.warn "JekyllLastCommit: unable to find commit information for #{document.relative_path}. falling back to `mtime` for last_modified_at"
+              document.data['last_modified_at'] = raw_time
+              document.data['last_modified_at_formatted'] = raw_time.strftime(date_format)
+            end
+          end
+        else
+          raw_time = Time.at(commit["time"].to_i)
+
+          document.data['last_commit'] = commit
+          document.data['last_modified_at'] = raw_time
+          document.data['last_modified_at_formatted'] = raw_time.strftime(date_format)
+        end
+      end
+
+      site.pages.each do |page|
+        commit = repo_man.find_commit(page.relative_path)
+
+        if commit.nil?
+          if should_fall_back_to_mtime
+            path_page = Jekyll.sanitized_path(site.source, page.relative_path)
+
+            if File.file?(path_page)
+              raw_time = Time.at(File.mtime(path_page).to_i)
+              page.data['last_modified_at'] = raw_time
+              page.data['last_modified_at_formatted'] = raw_time.strftime(date_format)
+            end
+          end
+
+        else
+          raw_time = Time.at(commit["time"].to_i)
+
+          page.data['last_commit'] = commit
+          page.data['last_modified_at'] = raw_time
+          page.data['last_modified_at_formatted'] = raw_time.strftime(date_format)
+        end
+      end
+    end
+
+  end
+end

data/lib/jekyll-last-commit/repo_man.rb

@@ -0,0 +1,104 @@
+require 'pathname'
+require 'rugged'
+require 'set'
+
+module JekyllLastCommit
+  class RepoMan
+
+    def initialize(path_site)
+      @path_site = Pathname.new(path_site)
+    end
+
+    def discover_repo
+      begin
+        @repo = Rugged::Repository.discover(@path_site)
+
+        path_dot_git = Pathname.new(@repo.path)
+        path_repo = path_dot_git.parent
+
+        # necessary to handle situations where site is not top level in repo
+        @path_relative = @path_site.relative_path_from(path_repo)
+
+      rescue
+        Jekyll.logger.warn "JekyllLastCommit: unable to find git repository at #{@path_site}"
+      end
+    end
+
+    def discover_commits(relative_file_paths)
+      return if @repo.nil?
+
+      document_paths = relative_file_paths.map {|rfp| generate_relative_path(rfp) }.to_set
+
+      # gets updated with renames pointing to original path
+      paths_lookup = document_paths.reduce({}) do |memo, original_path|
+        memo[original_path] = original_path
+        memo
+      end
+
+      # starting with the most recent commit, look for data on paths_undetermined
+      walker = Rugged::Walker.new(@repo)
+      walker.push(@repo.head.target.oid) # start with most recent commit
+
+      find_similar_opts = {rename_limit: 1000}
+
+      @paths_determined ||= {}
+
+      walker.each_with_index do |commit, i|
+        diff = commit.diff
+
+        # ignore renames
+        diff.find_similar!(**find_similar_opts)
+
+        diff.deltas.each do |delta|
+          new_file_path = delta.new_file[:path]
+
+          original_path = paths_lookup[new_file_path]
+
+          if document_paths.include?(new_file_path)
+            if delta.status == :renamed
+              # special case
+              old_file_path = delta.old_file[:path]
+
+              paths_lookup[old_file_path] = original_path
+
+              # no longer looking for the new file, looking for the old file
+              document_paths.delete(new_file_path)
+              document_paths.add(old_file_path)
+            else
+              @paths_determined[original_path] = commit
+              document_paths.delete(new_file_path)
+            end
+          end
+        end
+
+        break if document_paths.empty?
+      end
+    end
+
+    def find_commit(relative_path)
+      return nil if @repo.nil?
+
+      commit = @paths_determined[generate_relative_path(relative_path)]
+
+      return nil if commit.nil?
+
+      commit_hash = commit.to_hash
+                      .tap {|h| h.delete(:tree) }    # just reduce noise; can always add back later
+                      .tap {|h| h.delete(:parents) }
+                      .transform_keys(&:to_s)        # transform symbols to keys so liquid will render
+                      .transform_values {|v| v.is_a?(Hash) ? v.transform_keys(&:to_s) : v.strip! }
+      commit_hash['sha'] = commit.oid
+      commit_hash['time'] = commit.time
+      commit_hash['time_epoch'] = commit.time.to_i
+
+      commit_hash
+    end
+
+    private
+
+    def generate_relative_path(relative_path)
+      (@path_relative + Pathname.new(relative_path)).to_s
+    end
+
+  end
+end

data/lib/jekyll-last-commit/tag.rb

@@ -0,0 +1,31 @@
+module JekyllLastCommit
+  class Tag < Liquid::Tag
+    def initialize(tag_name, date_format, tokens)
+      super
+      @date_format = date_format.empty? ? nil : date_format.strip
+    end
+
+    def render(context)
+      @date_format ||= default_date_format(context)
+
+      page = context.registers[:page]
+
+      time = page['last_modified_at']
+
+      time.nil? ? "" : Time.at(time.to_i).strftime(@date_format)
+    end
+
+    def default_date_format(context)
+      site = context.registers[:site]
+
+      date_format = site.config.dig('jekyll-last-commit', 'date_format')
+      date_format ||= '%B %d, %Y'
+
+      date_format
+    end
+
+  end
+
+end
+
+Liquid::Template.register_tag('last_modified_at', JekyllLastCommit::Tag)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-last-commit
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Kip Landergren
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-12-17 00:00:00.000000000 Z
+date: 2022-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -52,6 +52,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/jekyll-last-commit.rb
+- lib/jekyll-last-commit/generator.rb
+- lib/jekyll-last-commit/repo_man.rb
+- lib/jekyll-last-commit/tag.rb
 homepage: https://github.com/klandergren/jekyll-last-commit
 licenses:
 - MIT