jekyll-scholar 6.6.1 → 6.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf67ce28716d6238d1ba9306450a14c19ba4f9856071373dd05f3796b655bdaf
-  data.tar.gz: 96ab65e69d8c14e01e5d802dafe9091458c28eb373d5b37b9479bdd3439bf8ef
+  metadata.gz: 7d41078acb5e68890960f62592839d27cf1fac7d305f41dac27fedf556f1c62d
+  data.tar.gz: 5a00d7a0c00455a47ccd56b0e9584bdf16811baf4a90f126c05de1b02de975ee
 SHA512:
-  metadata.gz: d0629713d0e4f78640df2b32f7c9895726a17db5087eed933f2b7c34b7242b9aeff4ff0bcd6d7e4ae2401ac4c4946d158d454189a7653089b3f44ca2dd373751
-  data.tar.gz: 49272efe88a89be98a9f5c9b06ea3b825579c536abc342e6197607340a9aa4a14ae94bf7f324718c100875633506e098ba9bc28554fd2cf5e765e82a0d4789ac
+  metadata.gz: f9fafa23f51a0e6790e547271ec26707455beacdfddac3780a83cbd06af5bd6ab42aae3f4a056f3c44323d93758a8c6dc3f4b6f01762f9fea311b4c05b8fa45c
+  data.tar.gz: f9682cccf0b8bea4248b56702dc0e6349b5e5dfcfc074319bfa88bddfc1de2a841f7c49ec57e895dbb747e5c8e04e0600739cb67b2cc299d239904dc593d2794

data/README.md

@@ -18,7 +18,7 @@ Installation
 
 Or add it to your `Gemfile`:
 
-    gem 'jekyll-scholar'
+    gem 'jekyll-scholar', group: :jekyll_plugins
 
 ### Github Pages
 

data/features/details.feature

@@ -107,7 +107,7 @@ Feature: Details
     And I should see "Page title: An Umlaut \\\"a!" in "_site/bibliography/ruby.html"
     And I should see "Title: An Umlaut \\\"a!" in "_site/bibliography/ruby.html"
     And I should see "title = {An Umlaut \\\"a!}" in "_site/bibliography/ruby.html"
-    
+
 
   @generators
   Scenario: Liquid tags should not be parsed inside the bibtex
@@ -438,8 +438,8 @@ Feature: Details
     And the "_site/scholar/index.html" file should exist
     And I should see "<a[^>]+href=\"/blog/bibliography/2008/10.0000/1111/\">" in "_site/scholar/index.html"
     And I should see "<a[^>]+href=\"/blog/bibliography/2018/ruby/\">" in "_site/scholar/index.html"
-    And the "_site/blog/bibliography/2008/10.0000/1111/index.html" file should exist
-    And the "_site/blog/bibliography/2018/ruby/index.html" file should exist
+    And the "_site/bibliography/2008/10.0000/1111/index.html" file should exist
+    And the "_site/bibliography/2018/ruby/index.html" file should exist
 
   @generators @parse_months
   Scenario: Months are parsed by default

data/features/page_config.feature

@@ -0,0 +1,42 @@
+Feature: Page Configuration
+  As a scholar who likes to blog
+  I want to set local jekyll-scholar options per page
+  In order to override the global config
+
+  @tags @filters
+  Scenario: Filter by Year
+    Given I have a scholar configuration with:
+      | key    | value             |
+      | source | ./_bibliography   |
+      | query  | "@*[year=2009]"   |
+    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}
+      }
+      @book{pickaxe,
+        title     = {Programming Ruby 1.9: The Pragmatic Programmer's Guide},
+        author    = {Thomas, Dave and Fowler, Chad and Hunt, Andy},
+        year      = {2009},
+        edition   = 3,
+        publisher = {Pragmatic Bookshelf}
+      }
+      """
+    And I have a page "scholar.html":
+      """
+      ---
+      scholar:
+        query: "@*[year=2008]"
+      ---
+      {% bibliography %}
+      """
+    When I run jekyll
+    Then the _site directory should exist
+    And the "_site/scholar.html" file should exist
+    And I should see "The Ruby Programming Language" in "_site/scholar.html"
+    And I should not see "Programming Ruby" in "_site/scholar.html"
+

data/lib/jekyll/scholar/generators/details.rb

@@ -23,7 +23,7 @@ module Jekyll
 
       def url
         # Reuse the logic in the utilities module for deciding URLs
-        details_link_for(@entry)
+        details_path_for(@entry)
       end
     end
 

data/lib/jekyll/scholar/utilities.rb

@@ -615,6 +615,10 @@ module Jekyll
       end
 
       def details_link_for(entry, base = base_url)
+        File.join(base, details_path_for(entry))
+      end
+
+      def details_path_for(entry)
         # Expand the details_permalink template into the complete URL for this entry.
 
         # First generate placeholders for all items in the bibtex entry
@@ -624,29 +628,30 @@ module Jekyll
           value = Jekyll::Utils::slugify(value, :mode => 'pretty') unless k == :doi
           url_placeholders[k] = value
         end
-        # Maintain the same URLs are previous versions of jekyll-scholar by replicating the way that it
-        # processed the key.
+        # Maintain the same URLs are previous versions of jekyll-scholar
+        # by replicating the way that it processed the key.
         url_placeholders[:key] = entry.key.to_s.gsub(/[:\s]+/, '_')
         url_placeholders[:details_dir] = details_path
-        # Autodetect the appropriate file extension based upon the site config, using the same rules as 
-        # previous versions of jekyll-scholar. Uses can override these settings by defining a details_permalink
+
+        # Autodetect the appropriate file extension based upon the site config,
+        # using the same rules as previous versions of jekyll-scholar. Users can
+        # override these settings by defining a details_permalink
         # without the :extension field.
         if (site.config['permalink'] == 'pretty') || (site.config['permalink'].end_with? '/')
           url_placeholders[:extension] = '/'
         else
           url_placeholders[:extension] = '.html'
         end
-        # Overwrite the 'doi' key with the citation key if the DOI field is empty or missing
+
+        # Overwrite 'doi' key with the citation key if DOI field is empty or missing
         if !entry.has_field?('doi') || entry.doi.empty?
           url_placeholders[:doi] = url_placeholders[:key]
         end
 
-        # generate the URL
-        File.join(base, 
-          URL.new(
-            :template => config['details_permalink'],
-            :placeholders => url_placeholders
-          ).to_s)
+        URL.new(
+          template: config['details_permalink'],
+          placeholders: url_placeholders
+        ).to_s
       end
 
       def base_url
@@ -783,8 +788,9 @@ module Jekyll
       end
 
       def set_context_to(context)
-        @context, @site, = context, context.registers[:site]
+        @context, @site, page, = context, *context.registers.values_at(:site, :page)
         config.merge!(site.config['scholar'] || {})
+        config.merge!(page['scholar'] || {})
         self
       end
 

data/lib/jekyll/scholar/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-scholar
 version: !ruby/object:Gem::Version
-  version: 6.6.1
+  version: 6.7.0
 platform: ruby
 authors:
 - Sylvester Keil
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-09 00:00:00.000000000 Z
+date: 2020-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -97,6 +97,7 @@ files:
 - features/interpolate.feature
 - features/layout.feature
 - features/multiple_files.feature
+- features/page_config.feature
 - features/reference.feature
 - features/removeduplicate.feature
 - features/repository.feature
@@ -167,6 +168,7 @@ test_files:
 - features/interpolate.feature
 - features/layout.feature
 - features/multiple_files.feature
+- features/page_config.feature
 - features/reference.feature
 - features/removeduplicate.feature
 - features/repository.feature