jekyll-last-commit 0.0.2 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b37651ca4010358f65dc170a7a30a6e59eadc345c0f63c785a8a591f38fb6c0
-  data.tar.gz: 70248fe1802e7901b23a7fccc39e090ac7c3a4119b2ba05829ce082fd29cf83c
+  metadata.gz: b5e8ca51ac4e8b52849fcfcfec308024e65fcfb88535c4d95a2543aa098326c4
+  data.tar.gz: 64dfaa2a3f92cbcc7b183492143406619b0d3384124c83269be5b2eaa5d185d9
 SHA512:
-  metadata.gz: ffc9f7cb61b802b5b57807c0cf7e3aac824bb7300c1b4265b0afc5d235cca4fd579ad8db5e96a6e909fcb736a1a44bd0541968885f536b10a290e84f905e75be
-  data.tar.gz: d77971574e7154b23109361195b2eae6465bd88dabbd647cab03a017d25d34a95318d5004571e6b02d1da864c97cd3ffe04a5f149cfdd413e45daef0908520ec
+  metadata.gz: b21f0e0acb5a08c19fce6f53b8ab3fd4112839cea6edf668409f92cba53d267cf07137ae39c5e87bd5adfe1178e52eed59312596f0ef480d14a657da9f5a0760
+  data.tar.gz: 1c5a7f7d3195e2bd98cb55874a7279a02d78e0adfb8a8985d09ee7a1b3b34e749294098d6635a088100f1db8d62c967323bba2cc7cedab36e42034664929e06d

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

@@ -0,0 +1,108 @@
+require 'jekyll'
+
+module JekyllLastCommit
+  class Generator < Jekyll::Generator
+    priority :highest
+
+    def generate(site)
+      @site = site
+
+      @repo_man = JekyllLastCommit::RepoMan.new(site.source)
+      @repo_man.discover_repo()
+
+      @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 ||= true
+
+      @repo_man.discover_commits(site.documents.map {|d| d.relative_path })
+      populate_jekyll(site.documents)
+
+      @repo_man.discover_commits(site.pages.map {|p| p.relative_path })
+      populate_jekyll(site.pages)
+
+      index_static_files = site.config.dig('jekyll-last-commit', 'index_static_files')
+      index_static_files ||= false
+      if index_static_files
+        @repo_man.discover_commits(site.static_files.map {|sf| '.' + sf.relative_path })
+        populate_jekyll(site.static_files, '.')
+      end
+
+      index_data_files = site.config.dig('jekyll-last-commit', 'index_data_files')
+      index_data_files ||= false
+      if index_data_files
+        data_file_extensions = ['.yml', '.yaml', '.json', '.tsv', '.csv']
+        data_files = []
+        site.data.keys.each do |data_file|
+          data_file_extensions.each do |data_file_extension|
+            data_file_name = data_file + data_file_extension
+            if File.file?('./_data/' + data_file_name)
+              data_files.append(data_file_name)
+              break
+            end
+          end
+        end
+      
+        data_files_key = site.config.dig('jekyll-last-commit', 'data_files_key')
+        data_files_key ||= 'meta'
+
+        @repo_man.discover_commits(data_files.map {|df| './_data/' + df })
+
+        site.data[data_files_key] = {}
+        populate_data(data_files, site.data[data_files_key], './_data/')
+      end
+    end
+
+    def populate_jekyll(files, prepend_path = '')
+      files.each do |file|
+        commit = @repo_man.find_commit(prepend_path + file.relative_path)
+
+        if commit.nil?
+          if @should_fall_back_to_mtime
+            path_file = Jekyll.sanitized_path(@site.source, prepend_path + file.relative_path)
+
+            if File.file?(path_file)
+              raw_time = Time.at(File.mtime(path_file).to_i)
+              file.data['commit'] = prepend_path + file.relative_path
+              file.data['last_modified_at'] = raw_time
+              file.data['last_modified_at_formatted'] = raw_time.strftime(@date_format)
+            end
+          end
+
+        else
+          raw_time = Time.at(commit["time"].to_i)
+          file.data['last_commit'] = commit
+          file.data['last_modified_at'] = raw_time
+          file.data['last_modified_at_formatted'] = raw_time.strftime(@date_format)
+        end
+      end
+    end
+
+    def populate_data(source, output = {}, prepend_path = '')
+      source.each do |file|
+        output[file] ||= {}
+
+        relative_path = prepend_path + file
+        commit = @repo_man.find_commit(relative_path)
+
+        if commit.nil?
+          if @should_fall_back_to_mtime
+            path_file = Jekyll.sanitized_path(@site.source, relative_path)
+
+            if File.file?(file)
+              raw_time = Time.at(File.mtime(path_file).to_i)
+              output[file]['last_modified_at'] = raw_time
+              output[file]['last_modified_at_formatted'] = raw_time.strftime(@date_format)
+            end
+          end
+        else
+          raw_time = Time.at(commit['time'].to_i)
+          output[file]['last_commit'] = commit
+          output[file]['last_modified_at'] = raw_time
+          output[file]['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.4
 platform: ruby
 authors:
 - Kip Landergren
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-12-17 00:00:00.000000000 Z
+date: 2024-09-28 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