jekyll-last-modified-date 1.3.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1e17aa123ab964e982f6532ce856f7e5795ecb477a0a54c3075f0275f18e77d4
+  data.tar.gz: 4dff3e6ebb2155feecc3199c29057d886103cdb1d74c41712d72dd1e035b01eb
+SHA512:
+  metadata.gz: 721150c3de5fe5292ddbae1bba9c626f74c36b657bac359eb01ad7637c3230eb51b40a5777d5e84b1a8a2bc74d3edcf98bcae1144f538acfc419a851e94b7775
+  data.tar.gz: a92d3fa5b4ad62053dfe2c947cea0b7cb72ed18a668ff948642b5ba383eb2bb105ad6c3e626b430a83f440006ba921134e5d601487a944408b2410ebd59a3caa

data/lib/jekyll-last-modified-date.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module LastModifiedDate
+    require 'jekyll-last-modified-date/tag'
+    require 'jekyll-last-modified-date/hook'
+
+    autoload :VERSION, 'jekyll-last-modified-date/version'
+    autoload :Executor, 'jekyll-last-modified-date/executor'
+    autoload :Determinator, 'jekyll-last-modified-date/determinator'
+    autoload :Git, 'jekyll-last-modified-date/git'
+
+    PATH_CACHE = {} # rubocop:disable Style/MutableConstant
+    REPO_CACHE = {} # rubocop:disable Style/MutableConstant
+  end
+end

data/lib/jekyll-last-modified-date/determinator.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module LastModifiedDate
+    class Determinator
+      attr_reader :site_source, :page_path
+      attr_accessor :format
+
+      def initialize(site_source, page_path, format = nil)
+        @site_source = site_source
+        @page_path   = page_path
+        @format      = format || '%d-%b-%y'
+      end
+
+      def git
+        return REPO_CACHE[site_source] unless REPO_CACHE[site_source].nil?
+
+        REPO_CACHE[site_source] = Git.new(site_source)
+        REPO_CACHE[site_source]
+      end
+
+      def formatted_last_modified_date
+        return PATH_CACHE[page_path] unless PATH_CACHE[page_path].nil?
+
+        last_modified = last_modified_at_time.strftime(@format)
+        PATH_CACHE[page_path] = last_modified
+        last_modified
+      end
+
+      def last_modified_at_time
+        raise Errno::ENOENT, "#{absolute_path_to_article} does not exist!" unless File.exist? absolute_path_to_article
+
+        Time.at(last_modified_at_unix.to_i)
+      end
+
+      def last_modified_at_unix
+        if git.git_repo?
+          last_commit_date = Executor.sh(
+            'git',
+            '--git-dir',
+            git.top_level_directory,
+            'log',
+            '-n',
+            '1',
+            '--format="%ct"',
+            '--',
+            relative_path_from_git_dir
+          )[/\d+/]
+          # last_commit_date can be nil iff the file was not committed.
+          last_commit_date.nil? || last_commit_date.empty? ? mtime(absolute_path_to_article) : last_commit_date
+        else
+          mtime(absolute_path_to_article)
+        end
+      end
+
+      def to_s
+        @to_s ||= formatted_last_modified_date
+      end
+
+      def to_liquid
+        @to_liquid ||= last_modified_at_time
+      end
+
+      private
+
+      def absolute_path_to_article
+        @absolute_path_to_article ||= Jekyll.sanitized_path(site_source, @page_path)
+      end
+
+      def relative_path_from_git_dir
+        return nil unless git.git_repo?
+
+        @relative_path_from_git_dir ||= Pathname.new(absolute_path_to_article)
+                                                .relative_path_from(
+                                                  Pathname.new(File.dirname(git.top_level_directory))
+                                                ).to_s
+      end
+
+      def mtime(file)
+        File.mtime(file).to_i.to_s
+      end
+    end
+  end
+end

data/lib/jekyll-last-modified-date/executor.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'posix/spawn'
+
+module Jekyll
+  module LastModifiedDate
+    module Executor
+      extend POSIX::Spawn
+
+      def self.sh(*args)
+        r, w = IO.pipe
+        e, eo = IO.pipe
+        pid = spawn(*args,
+                    :out => w, r => :close,
+                    :err => eo, e => :close)
+
+        if pid.positive?
+          w.close
+          eo.close
+          out = r.read
+          err = e.read
+          ::Process.waitpid(pid)
+          "#{out} #{err}".strip if out
+        end
+      ensure
+        [r, w, e, eo].each do |io|
+          begin
+                                   io.close
+          rescue StandardError
+            nil
+                                 end
+        end
+      end
+    end
+  end
+end

data/lib/jekyll-last-modified-date/git.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module LastModifiedDate
+    class Git
+      attr_reader :site_source
+
+      def initialize(site_source)
+        @site_source = site_source
+        @is_git_repo = nil
+      end
+
+      def top_level_directory
+        return nil unless git_repo?
+
+        @top_level_directory ||= begin
+          Dir.chdir(@site_source) do
+            @top_level_directory = File.join(Executor.sh('git', 'rev-parse', '--show-toplevel'), '.git')
+          end
+                                 rescue StandardError
+                                   ''
+        end
+      end
+
+      def git_repo?
+        return @is_git_repo unless @is_git_repo.nil?
+
+        @is_git_repo = begin
+          Dir.chdir(@site_source) do
+            Executor.sh('git', 'rev-parse', '--is-inside-work-tree').eql? 'true'
+          end
+                       rescue StandardError
+                         false
+        end
+      end
+    end
+  end
+end

data/lib/jekyll-last-modified-date/hook.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module LastModifiedDate
+    module Hook
+      def self.add_determinator_proc
+        proc { |item|
+          format = item.site.config.dig('last-modified-date', 'date-format')
+          item.data['last_modified_date'] = Determinator.new(item.site.source, item.path,
+                                                           format)
+        }
+      end
+
+      Jekyll::Hooks.register :posts, :post_init, &Hook.add_determinator_proc
+      Jekyll::Hooks.register :pages, :post_init, &Hook.add_determinator_proc
+      Jekyll::Hooks.register :documents, :post_init, &Hook.add_determinator_proc
+    end
+  end
+end

data/lib/jekyll-last-modified-date/tag.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module LastModifiedDate
+    class Tag < Liquid::Tag
+      def initialize(tag_name, format, tokens)
+        super
+        @format = format.empty? ? nil : format.strip
+      end
+
+      def render(context)
+        site = context.registers[:site]
+        format = @format || site.config.dig('last-modified-date', 'date-format')
+        article_file = context.environments.first['page']['path']
+        Determinator.new(site.source, article_file, format)
+                    .formatted_last_modified_date
+      end
+    end
+  end
+end
+
+Liquid::Template.register_tag('last_modified_date', Jekyll::LastModifiedDate::Tag)

data/lib/jekyll-last-modified-date/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module LastModifiedDate
+    VERSION = '1.3.1'
+  end
+end

metadata

@@ -0,0 +1,167 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-last-modified-date
+version: !ruby/object:Gem::Version
+  version: 1.3.1
+platform: ruby
+authors:
+- Garen J. Torikian
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-07-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: posix-spawn
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.9
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: rubocop-performance
+  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: rubocop-standard
+  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: spork
+  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: 
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/jekyll-last-modified-date.rb
+- lib/jekyll-last-modified-date/determinator.rb
+- lib/jekyll-last-modified-date/executor.rb
+- lib/jekyll-last-modified-date/git.rb
+- lib/jekyll-last-modified-date/hook.rb
+- lib/jekyll-last-modified-date/tag.rb
+- lib/jekyll-last-modified-date/version.rb
+homepage: https://github.com/Hofled/jekyll-last-modified-at
+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.1.2
+signing_key: 
+specification_version: 4
+summary: A liquid tag for Jekyll to indicate the last time a file was modified.
+test_files: []