jekyll-scholar 6.6.0 → 7.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 553c6ce018f518f25bb57bd76a547da001554588f947d158db5630ca3a863294
-  data.tar.gz: 8e18201f73e7157d096d84447c6fc526dbe6094b8bcf4f43a407d91b780ff3b9
+  metadata.gz: f0e78bd7c9317137c98678772de2dcc7299fcc02f44c9f425334100b87c2f369
+  data.tar.gz: f78feb1a7fccce706830d2a3956bdbf0b3ec4245576e2b454492b20bb6832877
 SHA512:
-  metadata.gz: 98d42799eb2356464ef26cef26cff2de39e1e3b39352ec4bb77e41c5a70dc9fe39dafc4ad8b4fc0a261c90530ea9bc5152e5b66468c3715f422910bf96061a89
-  data.tar.gz: '09f0301742a895a3cb8a1d09a604715bf79034cb08f55b946bf3733999700f69d4adc537befd01f376e9bd4d06bb26891f97ef290d1023acf4083c989ba08810'
+  metadata.gz: d6ee7f7510ca466d16ec3112ed47df4bfc02d8a17b736ab323d5ee5ac77d523ab3083dccf073bdb328be397006b67230cf7d8fcff4aaae4e9d8095ddd1665dd5
+  data.tar.gz: 5ea56025a3f93e3cbb3db96f81cc4bc7ffafa4524cdd53beec6b412b1c6d1fc331dc7b38c9d02e7704a89bc28dd51f4b377db8e97bc81805e1814a02deac1f21

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
 
@@ -53,10 +53,10 @@ configuration:
 
 In your Jekyll configuration file you can adjust the Jekyll-Scholar settings
 using the `scholar` key. For example, the following sets the bibliography style
-to `mla`.
+to `modern-language-association`.
 
     scholar:
-      style: mla
+      style: modern-language-association
 
 The table below describes some commonly used configuration options. For a
 description of all options and their defaults, see
@@ -64,7 +64,7 @@ description of all options and their defaults, see
 
 | Option | Default | Description |
 |--------|---------|-------------|
-| `style` | `apa` | Indicates the style used for the bibliography and citations. You can use any style that ships with [CiteProc-Ruby](https://github.com/inukshuk/citeproc-ruby) by name (e.g., apa, mla, chicago-fullnote-bibliography) which is usually the filename as seen [here](https://github.com/citation-style-language/styles) without the `.csl` ending; note that you have to use `dependent/style` if you want to use one from that directory. Alternatively you can add a link to any CSL  style (e.g., you could link to any of the styles available at the official [CSL style repository](https://github.com/citation-style-language/styles)). |
+| `style` | `apa` | Indicates the style used for the bibliography and citations. You can use any style that ships with [CiteProc-Ruby](https://github.com/inukshuk/citeproc-ruby) by name (e.g., apa, chicago-fullnote-bibliography) which is usually the filename as seen [here](https://github.com/citation-style-language/styles) without the `.csl` ending; note that you have to use `dependent/style` if you want to use one from that directory. Alternatively you can add a link to any CSL  style (e.g., you could link to any of the styles available at the official [CSL style repository](https://github.com/citation-style-language/styles)). |
 | `locale` | `en` | Defines what language to use when formatting your references (this typically applies to localized terms, e.g., 'Eds.' for editors in English). |
 | `source` | `./_bibliography` |  Indicates where your bibliographies are stored. |
 | `bibliography` | `references.bib` | Indicates the name of your default bibliography. For best results, please ensure that your bibliography is encoded as ASCII or UTF-8. A string that contains a `*` will be passed to `Dir::glob`, so `**/*.bib{,tex}` will find all files named `*.bib` and `*.bibtex` under `source`.  |
@@ -74,6 +74,7 @@ description of all options and their defaults, see
 | `group_by` | `none` | Specifies how bibliography items are grouped. Grouping can be multi-level, e.g. `type, year` groups entries per publication type, and within those groups per year. |
 | `group_order` | `ascending` |  Ordering for groups is specified in the same way as the sort order. Publication types -- specified with group key `type`, can be ordered by adding `type_order` to the configuration. For example, `type_order: [article,techreport]` lists journal articles before technical reports. Types not mentioned in `type_order` are considered smaller than types that are mentioned. Types can be merge in one group using the `type_aliases` setting. By default `phdthesis` and `mastersthesis` are grouped as `thesis`. By using, for example, `type_aliases: { inproceedings: article}`, journal and conference articles appear in a single group. The display names for entry types are specified with `type_names`. Names for common types are provided, but they can be extended or overridden. For example, the default name for `article` is *Journal Articles*, but it can be changed to *Papers* using `type_names: { article: Papers }`. |
 | `bibtex_filters` | `latex,smallcaps,superscript` | Configures which [BibTeX-Ruby](https://github.com/inukshuk/bibtex-ruby) formatting filters values of entries should be passed through. The default `latex` filter converts LaTeX character escapes into unicode, `smallcaps` converts the `\textsc` command into a HTML `<font style=\"font-variant: small-caps\">` tag, and `superscript` which converts the `\textsuperscript` command into a HTML `<sup>` tag. |
+| `raw_bibtex_filters` | ` ` | Configures which [BibTeX-Ruby](https://github.com/inukshuk/bibtex-ruby) formatting filters the raw BiBTeX entry (i.e. that available through `{{ entry.bibtex }}`) should be passed through. This can be used to e.g. strip excess newlines by using the `linebreaks` filter. |
 
 
 ### Bibliographies

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/filter.feature

@@ -609,3 +609,39 @@ Feature: BibTeX
     And the "_site/scholar.html" file should exist
     And I should see "This is <span class="tiny">i is tiny</span> to me." in "_site/scholar.html"
 
+  @tags @filters
+  Scenario: Apply raw BiBTeX filters
+    Given I have a scholar configuration with:
+      | key                   | value             |
+      | source                | ./_bibliography   |
+      | bibliography_template | bibliography      |
+    And I have the following raw BibTeX filters:
+      | linebreaks |
+    And I have a "_bibliography" directory
+    And I have a file "_bibliography/references.bib":
+      """
+      @misc{pickaxe,
+        title = {Long
+                 line},
+        series = {Longer
+                  line}
+      }
+      """
+    And I have a "_layouts" directory
+    And I have a file "_layouts/bibliography.html":
+      """
+      ---
+      ---
+      {{ entry.bibtex }}
+      """
+    And I have a page "scholar.html":
+      """
+      ---
+      ---
+      {% bibliography %}
+      """
+    When I run jekyll
+    Then the _site directory should exist
+    And the "_site/scholar.html" file should exist
+    And I should see "@misc{pickaxe,\n  title = {Long line},\n  series = {Longer line}" in "_site/scholar.html"
+

data/features/page_config.feature

@@ -0,0 +1,72 @@
+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"
+
+
+  @tags
+  Scenario: Template access to page config
+    Given I have a scholar configuration with:
+      | key                   | value                     |
+      | source                | ./_bibliography           |
+      | bibliography_template | <p>{{page.scholar.x}}</p> |
+    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":
+      """
+      ---
+      scholar:
+        x: Asa-Nisi-Masa
+      ---
+      {% bibliography %}
+      """
+    When I run jekyll
+    Then the _site directory should exist
+    And the "_site/scholar.html" file should exist
+    And I should see "<p>Asa-Nisi-Masa</p>" in "_site/scholar.html"
+

data/features/step_definitions/scholar_steps.rb

@@ -36,6 +36,15 @@ Given(/^I have the following BibTeX filters:$/) do |table|
   end
 end
 
+Given(/^I have the following raw BibTeX filters:$/) do |table|
+  File.open('_config.yml', 'a') do |f|
+    f.write("  raw_bibtex_filters:\n")
+    table.raw.flatten.each do |row|
+      f.write("    - #{row}\n")
+    end
+  end
+end
+
 Then(/^"(.*)" should come before "(.*)" in "(.*)"$/) do |p1, p2, file|
   data = File.open(file).readlines.join('')
 

data/jekyll-scholar.gemspec

@@ -27,7 +27,7 @@ Gem::Specification.new do |s|
   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('bibtex-ruby', '~> 5.0')
+  s.add_runtime_dependency('bibtex-ruby', '~> 6.0')
 
   s.files        = `git ls-files`.split("\n")
   s.test_files   = `git ls-files -- {test,spec,features}/*`.split("\n")

data/lib/jekyll/scholar/defaults.rb

@@ -37,6 +37,7 @@ module Jekyll
 
       'bibtex_options'         => { :strip => false, :parse_months => true },
       'bibtex_filters'         => [ :smallcaps, :superscript, :italics, :textit, :lowercase, :textregistered, :tiny, :latex ],
+      'raw_bibtex_filters'     => [ ],
       'bibtex_skip_fields'     => [ :abstract, :month_numeric ],
       'bibtex_quotes'          => ['{', '}'],
 

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/tags/bibliography.rb

@@ -1,6 +1,5 @@
 module Jekyll
   class Scholar
-
     class BibliographyTag < Liquid::Tag
       include Scholar::Utilities
 
@@ -34,7 +33,7 @@ module Jekyll
       def render_groups(groups)
         def group_renderer(groupsOrItems,keys,order,tags)
           if keys.count == 0
-            renderer(true)
+            csl_renderer(true)
             render_items(groupsOrItems)
           else
             groupsOrItems

data/lib/jekyll/scholar/tags/bibtex.rb

@@ -1,6 +1,5 @@
 module Jekyll
   class Scholar
-
     class BibTeXTag < Liquid::Block
       include Scholar::Utilities
 
@@ -15,16 +14,13 @@ module Jekyll
 
       def render(context)
         set_context_to context
-        
+
         BibTeX.parse(super, bibtex_options).map { |entry|
           reference_tag entry
-
         }.join("\n")
       end
     end
-
   end
 end
 
 Liquid::Template.register_tag('bibtex', Jekyll::Scholar::BibTeXTag)
-

data/lib/jekyll/scholar/utilities.rb

@@ -165,6 +165,10 @@ module Jekyll
         config['bibtex_filters'] ||= []
       end
 
+      def raw_bibtex_filters
+        config['raw_bibtex_filters'] ||= []
+      end
+
       def bibtex_paths
         bibtex_files.map { |file|
           interpolated_file = interpolate file
@@ -523,10 +527,11 @@ module Jekyll
           .merge(site.site_payload)
           .merge({
           'index' => index,
+          'page' => context.registers[:page],
           'details' => details_link_for(entry)
         }),
         {
-          :registers => { :site => site },
+          :registers => context.registers,
           :filters => [Jekyll::Filters]
         })
       end
@@ -548,8 +553,13 @@ module Jekyll
         e['key'] = entry.key
         e['type'] = entry.type.to_s
 
+        conv_opts = { quotes: config['bibtex_quotes'] }
+        if !raw_bibtex_filters.empty?
+          conv_opts[:filter] = *raw_bibtex_filters
+        end
+
         if entry.field_names(config['bibtex_skip_fields']).empty?
-          e['bibtex'] = entry.to_s({ quotes: config['bibtex_quotes'] })
+          e['bibtex'] = entry.to_s(conv_opts)
         else
           tmp = entry.dup
 
@@ -557,7 +567,7 @@ module Jekyll
             tmp.delete name if tmp.field?(name)
           end
 
-          e['bibtex'] = tmp.to_s({ quotes: config['bibtex_quotes'] })
+          e['bibtex'] = tmp.to_s(conv_opts)
         end
 
         #e['raw_bibtex'] = "{%raw%}#{e['bibtex']}{%endraw%}"
@@ -606,6 +616,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
@@ -615,29 +629,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
@@ -648,15 +663,15 @@ module Jekyll
         config['details_dir']
       end
 
-      def renderer(force = false)
-        return @renderer if @renderer && !force
+      def csl_renderer(force = false)
+        return @csl_renderer if @csl_renderer && !force
 
-        @renderer = CiteProc::Ruby::Renderer.new :format => 'html',
+        @csl_renderer = CiteProc::Ruby::Renderer.new :format => 'html',
           :style => style, :locale => config['locale']
       end
 
       def render_citation(items)
-        renderer.render items.zip(locators.zip(labels)).map { |entry, (locator, label)|
+        csl_renderer.render items.zip(locators.zip(labels)).map { |entry, (locator, label)|
           cited_keys << entry.key
           cited_keys.uniq!
 
@@ -670,17 +685,17 @@ module Jekyll
 
       def render_bibliography(entry, index = nil)
         begin
-          original_locale, renderer.locale =
-            renderer.locale, locales(entry.language)
+          original_locale = csl_renderer.locale
+          csl_renderer.locale = locales(entry.language)
         rescue
           # Locale failed to load; just use original one!
         end if allow_locale_overrides? &&
-        entry['language'] != renderer.locale.language
+          entry['language'] != csl_renderer.locale.language
 
-        renderer.render citation_item_for(entry, index),
+        csl_renderer.render citation_item_for(entry, index),
           styles(style).bibliography
       ensure
-        renderer.locale = original_locale unless original_locale.nil?
+        csl_renderer.locale = original_locale unless original_locale.nil?
       end
 
       def citation_item_for(entry, citation_number = nil)
@@ -774,8 +789,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.0'.freeze
+    VERSION = '7.0.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-scholar
 version: !ruby/object:Gem::Version
-  version: 6.6.0
+  version: 7.0.0
 platform: ruby
 authors:
 - Sylvester Keil
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-02-24 00:00:00.000000000 Z
+date: 2021-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
 description: " Jekyll-Scholar is for all the academic bloggers out there. It is a
   set of extensions for Jekyll the awesome, blog aware, static site generator; it
   formats your BibTeX bibliographies for the web using CSL citation styles and generally
@@ -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
@@ -134,7 +135,7 @@ homepage: http://github.com/inukshuk/jekyll-scholar
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -149,8 +150,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Jekyll extensions for the academic blogger.
 test_files:
@@ -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