jekyll-scholar 7.1.3 → 7.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a5c64ff0482f1ca07fb43024f2498088c276ecda97488b7d90374c828749712
-  data.tar.gz: fbc7bee4de5eb9453b4d6ee7245b2bc6cc7a6edf86b66ae9bce8c073ad4d32b3
+  metadata.gz: 2a514c66d1cbe097d3d8837a024e5957ef136a03b54823915e6de74d4b7d395d
+  data.tar.gz: 49430b47d8eacc48bf7b34ffad39ad813bfcb223acbeb38ab9f95b4493381f29
 SHA512:
-  metadata.gz: 625643f937acb714f7a8da96e621170786cd448a27e59bacac8ed9af4f6e268bf8f94de91efe7035cba1b0ddcf7f5349176e9c8946d78087517d72077ef86250
-  data.tar.gz: 9cbc3ca90920c3267b90b2c08be6e4a7282c6f58d49ef57c9d9f5a364bf46b9e8ac9717236cd1e5325a505640675ec3ad2a64d2387dceb9c3057c1eacdf10d2d
+  metadata.gz: d7219d317f46e6c14e49a3a1a90c674022944511c5f71aab5688a8d22d3e50bade5d0b81660fe3a26157035ac3d1b5fa1726361c299bc7717753539e95b3cb4a
+  data.tar.gz: df23787617a54cd0275167ccc956482c086d9485db06fe6ce31e074711bbe7992b8182b4e7bf86ed665f839e010d4bd4aa1974a79a841637fdddc9e53d83275a

data/.github/workflows/ci.yml

@@ -4,9 +4,6 @@ on:
     branches: [ main ]
   pull_request:
     branches: [ main ]
-concurrency:
-  group: ci-${{ github.ref }}
-  cancel-in-progress: true
 jobs:
   ci:
     name: ${{ matrix.ruby-version }} ${{ matrix.friendlyName }}-${{ matrix.arch }}
@@ -15,11 +12,10 @@ jobs:
     strategy:
       matrix:
         ruby-version:
-          - "2.6"
-          - "2.7"
-          - "3.0"
           - "3.1"
           - "3.2"
+          - "3.3"
+          - "3.4"
         os:
           - ubuntu-latest
           - macos-latest

data/Gemfile

@@ -1,19 +1,9 @@
 source 'https://rubygems.org'
 gemspec
 
-group :development do
-  gem 'cucumber'
-  gem 'rake'
-  gem 'redcarpet'
-  gem 'redgreen'
-  gem 'shoulda'
-  gem 'test-unit'
-  gem 'unicode_utils' if RUBY_VERSION < '2.4'
-end
-
-group :extra do
-  gem 'listen'
-end
+gem 'cucumber'
+gem 'minitest'
+gem 'rake'
 
 group :coverage do
   gem 'simplecov', :require => false

data/features/cache.feature

@@ -0,0 +1,89 @@
+Feature: BibTex
+  As as scholar who likes to blog and has limited time
+  I want to render my bibliography quickly
+  by caching the bibliography entries
+
+  Scenario: Normal usage
+    Given I have a scholar configuration with:
+      | key    | value             |
+      | source | ./_bibliography   |
+    And I have a "_bibliography" directory
+    And I have a file "_bibliography/references.bib":
+      """
+      @book{ruby,
+        title     = {The Ruby Programming Language},
+        author    = {Flanagan, David and Matsumoto, Yukihiro},
+        year      = {2008},
+        publisher = {O'Reilly Media}
+      }
+      """
+    And I have a page "scholar.html":
+      """
+      ---
+      ---
+      {% cite ruby %}
+      {% bibliography -f references %}
+      """
+    And I clear the jekyll caches
+    When I run jekyll
+    Then I should have 1 bibliography cache entry
+    And I should have 1 cite cache entry
+    And I should have a cite cache entry for ruby
+
+  Scenario: Changed file
+    Given I have a scholar configuration with:
+      | key    | value             |
+      | source | ./_bibliography   |
+    And I have a "_bibliography" directory
+    And I have a file "_bibliography/references.bib":
+      """
+      @book{ruby,
+        title     = {The Ruby Programming Language},
+        author    = {Flanagan, David and Matsumoto, Yukihiro},
+        year      = {2008},
+        publisher = {O'Reilly Media}
+      }
+      """
+    And I have a page "scholar.html":
+      """
+      ---
+      ---
+      {% cite ruby %}
+      {% bibliography -f references %}
+      """
+    And I clear the jekyll caches
+    When I run jekyll
+    Then I should have 1 bibliography cache entry
+    And I should have 1 cite cache entry
+    And I should have a cite cache entry for ruby
+    And I should see "Ruby" in "_site/scholar.html"
+    When I have a file "_bibliography/references.bib":
+      """
+      @book{ruby,
+        title     = {The Scooby Programming Language},
+        author    = {Flanagan, David and Matsumoto, Yukihiro},
+        year      = {2008},
+        publisher = {O'Reilly Media}
+      }
+      @book{newbie,
+        title     = {The Newbie Programming Language},
+        author    = {Programmer, Tennex},
+        year      = {2009},
+        publisher = {O'Reilly Media}
+      }
+      """
+    And I have a page "scholar.html":
+      """
+      ---
+      ---
+      {% cite ruby %}
+      {% cite newbie %}
+      {% bibliography -f references %}
+      """
+    And I run jekyll
+    Then I should have 2 bibliography cache entries
+    And I should have 2 cite cache entries
+    And I should have a cite cache entry for ruby
+    And I should have a cite cache entry for newbie
+    And I should see "Scooby" in "_site/scholar.html"
+    And I should see "Newbie" in "_site/scholar.html"

data/features/step_definitions/jekyll_steps.rb

@@ -35,6 +35,15 @@ Given(/^I have a configuration file with:$/) do |table|
   end
 end
 
+Given(/^I clear the jekyll caches$/) do
+  begin
+    Jekyll::Scholar::Utilities.class_variable_get(:@@bib_cache).clear
+    Jekyll::Scholar::Utilities.class_variable_get(:@@cite_cache).clear
+  rescue NameError
+    # Ignored
+  end
+end
+
 When(/^I run jekyll$/) do
   run_jekyll
 end

data/features/step_definitions/scholar_steps.rb

@@ -54,3 +54,30 @@ Then(/^"(.*)" should come before "(.*)" in "(.*)"$/) do |p1, p2, file|
   assert m1.offset(0)[0] < m2.offset(0)[0]
 end
 
+Then(/^I should have a (bibliography|cite) cache entry for (.*)$/) do |cache_type, key|
+  require "digest"
+  case cache_type
+  when "bibliography"
+    raise NotImplementedError "Can't load temporary files for some reason"
+    # paths = key.split(", ")
+    # bib_mtimes = paths.reduce('') { |s, p| s << File.mtime(p).inspect }
+    # bib_hash = Digest::SHA256.hexdigest bib_mtimes
+    # assert Jekyll::Scholar::Utilities.bib_cache.key?(bib_hash)
+  when "cite"
+    assert Jekyll::Scholar::Utilities.class_variable_get(:@@cite_cache).key?(key)
+  else
+    raise "Unknown cache type"
+  end
+end
+
+Then(/^I should have (\d*) (bibliography|cite) cache entr(?:ies|y)$/) do |n_entries, cache_type|
+  case cache_type
+  when "bibliography"
+    assert Jekyll::Scholar::Utilities.class_variable_get(:@@bib_cache).instance_variable_get(:@cache).length == n_entries.to_i
+  when "cite"
+    assert Jekyll::Scholar::Utilities.class_variable_get(:@@cite_cache).instance_variable_get(:@cache).length == n_entries.to_i
+  else
+    raise "Unknown cache type"
+  end
+end
+

data/jekyll-scholar.gemspec

@@ -25,8 +25,8 @@ Gem::Specification.new do |s|
   s.required_rubygems_version = '>= 1.3.6'
 
   s.add_runtime_dependency('jekyll', '~> 4.0')
-  s.add_runtime_dependency('citeproc-ruby', '~> 1.0')
-  s.add_runtime_dependency('csl-styles', '~> 1.0')
+  s.add_runtime_dependency('citeproc-ruby', '~> 2.0')
+  s.add_runtime_dependency('csl-styles', '~> 2.0')
   s.add_runtime_dependency('bibtex-ruby', '~> 6.0')
 
   s.files        = `git ls-files`.split("\n")

data/lib/jekyll/scholar/utilities.rb

@@ -1,6 +1,7 @@
 module Jekyll
   class Scholar
     require 'date'
+    require 'digest'
 
     # Load styles into static memory.
     # They should be thread safe as long as they are
@@ -47,7 +48,7 @@ module Jekyll
 
           opts.on('-r', '--remove_duplicates [MATCH_FIELDS]') do |match_field|
             @remove_duplicates = true
-            @match_fields = match_field.split(/,\s+/) if not match_field.nil? 
+            @match_fields = match_field.split(/,\s+/) if not match_field.nil?
           end
 
           opts.on('-A', '--suppress_author') do |cited|
@@ -181,33 +182,37 @@ module Jekyll
         bibtex_paths[0]
       end
 
+      def bib_cache
+        @@bib_cache ||= Jekyll::Cache.new("jekyll-scholar::BibCache")
+      end
+
+      def cite_cache
+        @@cite_cache ||= Jekyll::Cache.new("jekyll-scholar::CiteCache")
+      end
+
       def bibliography
         paths = bibtex_paths
+        bib_mtimes = paths.reduce('') { |s, p| s << p << File.mtime(p).inspect }
+        bib_hash = Digest::SHA256.hexdigest bib_mtimes
 
-        # Clear @bibliography if sources change! See #282
-        unless @paths.nil? || @paths == paths
-          @bibliography = nil
-        end
-
-        unless @bibliography
-          @bibliography = BibTeX::Bibliography.parse(
+        bib_cache.getset(bib_hash) do
+          bib = BibTeX::Bibliography.parse(
             paths.reduce('') { |s, p| s << IO.read(p) },
             bibtex_options
           )
 
+          # clear cite caches on bibliography update
+          cite_cache.clear
+
           @paths = paths
 
-          @bibliography.replace_strings if replace_strings?
-          @bibliography.join if join_strings? && replace_strings?
+          bib.replace_strings if replace_strings?
+          bib.join if join_strings? && replace_strings?
 
           # Remove duplicate entries
-          @bibliography.uniq!(*match_fields) if remove_duplicates?
+          bib.uniq!(*match_fields) if remove_duplicates?
+          bib
         end
-
-        @bibliography
-      end
-
-      def bibliography_stale?
       end
 
 
@@ -389,7 +394,7 @@ module Jekyll
 
       def remove_duplicates?
         @remove_duplicates || config['remove_duplicates']
-      end 
+      end
 
       def suppress_author?
         !!@suppress_author
@@ -597,7 +602,7 @@ module Jekyll
           return false
         end
         return true
-      end 
+      end
 #
       def generate_details?
         site.layouts.key?(File.basename(config['details_layout'], '.html'))
@@ -631,7 +636,7 @@ module Jekyll
 
         # First generate placeholders for all items in the bibtex entry
         url_placeholders = {}
-        entry.fields.each_pair do |k, v| 
+        entry.fields.each_pair do |k, v|
           value = v.to_s.dup
           value = Jekyll::Utils::slugify(value, :mode => 'pretty') unless k == :doi
           url_placeholders[k] = value
@@ -731,7 +736,9 @@ module Jekyll
         items = keys.map do |key|
           if bibliography.key?(key)
             entry = bibliography[key]
-            entry = entry.convert(*bibtex_filters) unless bibtex_filters.empty?
+            cite_cache.getset(key) do
+              entry.convert(*bibtex_filters) unless bibtex_filters.empty?
+            end
           else
             return missing_reference
           end

data/lib/jekyll/scholar/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   class Scholar
-    VERSION = '7.1.3'.freeze
+    VERSION = '7.2.0'.freeze
   end
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-scholar
 version: !ruby/object:Gem::Version
-  version: 7.1.3
+  version: 7.2.0
 platform: ruby
 authors:
 - Sylvester Keil
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-22 00:00:00.000000000 Z
+date: 2025-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -30,28 +29,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: csl-styles
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: bibtex-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -87,6 +86,7 @@ files:
 - features/191.feature
 - features/215.feature
 - features/bibtex.feature
+- features/cache.feature
 - features/citation.feature
 - features/cite_details.feature
 - features/cited_only.feature
@@ -136,7 +136,6 @@ homepage: http://github.com/inukshuk/jekyll-scholar
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -151,8 +150,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-rubygems_version: 3.4.2
-signing_key:
+rubygems_version: 3.6.6
 specification_version: 4
 summary: Jekyll extensions for the academic blogger.
 test_files:
@@ -160,6 +158,7 @@ test_files:
 - features/191.feature
 - features/215.feature
 - features/bibtex.feature
+- features/cache.feature
 - features/citation.feature
 - features/cite_details.feature
 - features/cited_only.feature