jekyll-scholar 6.6.0 → 6.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 553c6ce018f518f25bb57bd76a547da001554588f947d158db5630ca3a863294
-  data.tar.gz: 8e18201f73e7157d096d84447c6fc526dbe6094b8bcf4f43a407d91b780ff3b9
+  metadata.gz: bf67ce28716d6238d1ba9306450a14c19ba4f9856071373dd05f3796b655bdaf
+  data.tar.gz: 96ab65e69d8c14e01e5d802dafe9091458c28eb373d5b37b9479bdd3439bf8ef
 SHA512:
-  metadata.gz: 98d42799eb2356464ef26cef26cff2de39e1e3b39352ec4bb77e41c5a70dc9fe39dafc4ad8b4fc0a261c90530ea9bc5152e5b66468c3715f422910bf96061a89
-  data.tar.gz: '09f0301742a895a3cb8a1d09a604715bf79034cb08f55b946bf3733999700f69d4adc537befd01f376e9bd4d06bb26891f97ef290d1023acf4083c989ba08810'
+  metadata.gz: d0629713d0e4f78640df2b32f7c9895726a17db5087eed933f2b7c34b7242b9aeff4ff0bcd6d7e4ae2401ac4c4946d158d454189a7653089b3f44ca2dd373751
+  data.tar.gz: 49272efe88a89be98a9f5c9b06ea3b825579c536abc342e6197607340a9aa4a14ae94bf7f324718c100875633506e098ba9bc28554fd2cf5e765e82a0d4789ac

data/README.md

@@ -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/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/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/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/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
@@ -548,8 +552,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 +566,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%}"

data/lib/jekyll/scholar/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   class Scholar
-    VERSION = '6.6.0'.freeze
+    VERSION = '6.6.1'.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: 6.6.1
 platform: ruby
 authors:
 - Sylvester Keil
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-24 00:00:00.000000000 Z
+date: 2020-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll