jekyll-scholar 5.11.0 → 5.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 3a12c04213d5d4a7f2b7e6915f4484a2b0cd50d6
-  data.tar.gz: b028593919ff9c53a799f814727bae13fd8ddb64
+SHA256:
+  metadata.gz: 58e25d6efe7c8dee59ef300050b011a440db405e8faf3d67df0a7cd338f66463
+  data.tar.gz: 95d5957d275047e9039124fa70e33662450e8e7032671c3639ce7d5247dd83ad
 SHA512:
-  metadata.gz: 37de3db56995dd2a662b8606d07a597beba91df7454ca2139fc3238a9212a47e7222c5a91b154ea7ed028664ed52dd65d4c52a7d412f1dc172cf5c6c7d1062e1
-  data.tar.gz: f45693b66aea36d5af8aae6ad0210e5325fbf7cca0e60aeac77b9c4d4b010200999e5f56c84f8c7a70aed4fe1380ee6b06dfc4a27de4d644e2e3237800eab788
+  metadata.gz: 386d44e9ad73e9f48ffc82c7bce87347a3087192358227271962df940e046c64df085af49c40040e1d9779494476005b371f0f66501746fdeaab2a4449446656
+  data.tar.gz: e39490aa41dee0744b9a1eb158d0e7e1b16c48c97f4e74147708d1f4c57b2fa9ce49022234840531c1ce51e1d125861cb35882d1afc986bd510f0069069158f1

data/.travis.yml

@@ -3,8 +3,10 @@ sudo: false
 cache: bundler
 matrix:
   include:
-  - rvm: 2.4
+  - rvm: 2.5
     env: WITH_COVERALLS=true
+  - rvm: 2.4
+    env: WITH_COVERALLS=false
   - rvm: 2.3
     env: WITH_COVERALLS=false
 install:

data/Gemfile

@@ -13,8 +13,6 @@ group :development do
   gem 'shoulda', '~> 3.5'
   gem 'cucumber', '1.3.11'
   gem 'redcarpet'
-
-  gem 'unicode_utils'
 end
 
 group :extra do

data/README.md

@@ -68,7 +68,7 @@ description of all options and their defaults, see
 | `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)). | 
 | `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. |
+| `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`.  |
 | `use_raw_bibtex_entry` | `true` | When `true`, disables parsing of Liquid tags embedded in the Bibtex fields. This option provides a way to circumvent the problem that (the conflicting syntax of) the double braces functionality of BibTex is accidentally parsed by Liquid, while it was intended to keep the exact capitalization style. |
 | `sort_by` | `none` | Specifies if and how bibliography entries are sorted. Entries can be sorted on multiple fields, by using a list of keys, e.g. `year,month`. Ordering can be specified per sort level, e.g. `order: descending,ascending` will sort the years descending, but per year the months are ascending. If there are more sort keys than order directives, the last order entry is used for the remaining keys. |
 | `order` | `ascending` | Specifies order bibliography entries are sorted in. Can be `ascending` or descending. Ordering can be specified per sort level, e.g. `descending,ascending` will sort in descending on the first key then ascending order on the second key. If there are more sort keys than order directives, the last order entry is used for the remaining keys. |
@@ -167,6 +167,17 @@ This would generate a bibliography containing only the first 5 entries
 of your bibliography (after query filters and sort options have been
 applied). Limiting entries is disabled if grouping is active.
 
+### Return number of publications in bibliography
+
+The `bibliography_count` returns the number of items that would be 
+rendered in a bibliography. This tag accepts the same parameters as the 
+`bibliography` tag. 
+
+    {% bibliography_count -f references --query @book[year <=2000] %}
+
+See [#186](https://github.com/inukshuk/jekyll-scholar/blob/master/features/186.feature)
+for further examples.
+
 ### Bibliography Template
 
 Your bibliography is always rendered as an ordered list. Additionally,

data/features/details.feature

@@ -160,7 +160,7 @@ Feature: Details
     Given I have a scholar configuration with:
       | key            | value             |
       | source         | ./_bibliography   |
-      | bibliogaphy    | references        |
+      | bibliography   | references        |
       | details_layout | details.html      |
     And I have a "_bibliography" directory
     And I have a file "_bibliography/references.bib":
@@ -196,13 +196,65 @@ Feature: Details
     And the "_site/bibliography/ruby.html" file should exist
     And I should see "<a[^>]+href=\"/bibliography/ruby.html\">" in "_site/scholar.html"
 
+  @tags @details
+  Scenario: Links to Detail Pages are Generated Automatically With Globbing
+    Given I have a scholar configuration with:
+      | key            | value             |
+      | source         | ./_bibliography   |
+      | bibliography   | "*.bib"           |
+      | details_layout | details.html      |
+    And I have a "_bibliography" directory
+    And I have a file "_bibliography/a.bib":
+      """
+      @book{a,
+        title     = {The Ruby Programming Language},
+        author    = {Flanagan, David and Matsumoto, Yukihiro},
+        year      = {2008},
+        publisher = {O'Reilly Media}
+      }
+      """
+    And I have a file "_bibliography/b.bib":
+      """
+      @book{b,
+        title     = {The Ruby Programming Language},
+        author    = {Flanagan, David and Matsumoto, Yukihiro},
+        year      = {2008},
+        publisher = {O'Reilly Media}
+      }
+      """
+    And I have a "_layouts" directory
+    And I have a file "_layouts/details.html":
+      """
+      ---
+      ---
+      <html>
+      <head></head>
+      <body>
+      {{ page.entry.title }}
+      </body>
+      </html>
+      """
+    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 the "_site/bibliography/a.html" file should exist
+    And the "_site/bibliography/b.html" file should exist
+    And I should see "<a[^>]+href=\"/bibliography/a.html\">" in "_site/scholar.html"
+    And I should see "<a[^>]+href=\"/bibliography/b.html\">" in "_site/scholar.html"
+
   @tags @details
   Scenario: Links to Detail Pages Work With Pretty URLs
     Given I have a configuration file with "permalink" set to "pretty"
     And I have a scholar configuration with:
       | key            | value             |
       | source         | ./_bibliography   |
-      | bibliogaphy    | references        |
+      | bibliography   | references        |
       | details_layout | details.html      |
     And I have a "_bibliography" directory
     And I have a file "_bibliography/references.bib":
@@ -239,6 +291,49 @@ Feature: Details
     And I should see "<a[^>]+href=\"/bibliography/ruby/\">" in "_site/scholar/index.html"
     And the "_site/bibliography/ruby/index.html" file should exist
 
+  @tags @details
+  Scenario: Links to Detail Pages Work With Custom Permalink URLs
+    Given I have a configuration file with "permalink" set to "/:title/"
+    And I have a scholar configuration with:
+      | key            | value             |
+      | source         | ./_bibliography   |
+      | bibliography   | references        |
+      | details_layout | details.html      |
+    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 "_layouts" directory
+    And I have a file "_layouts/details.html":
+      """
+      ---
+      ---
+      <html>
+      <head></head>
+      <body>
+      {{ page.entry.title }}
+      </body>
+      </html>
+      """
+    And I have a page "scholar.html":
+      """
+      ---
+      ---
+      {% bibliography %}
+      """
+    When I run jekyll
+    Then the _site directory should exist
+    And I should see "/:title/" in "_config.yml"
+    And the "_site/scholar/index.html" file should exist
+    And I should see "<a[^>]+href=\"/bibliography/ruby/\">" in "_site/scholar/index.html"
+    And the "_site/bibliography/ruby/index.html" file should exist
+
   @generators @parse_months
   Scenario: Months are parsed by default
     Given I have a scholar configuration with:
@@ -295,7 +390,7 @@ Feature: Details
     Given I have a scholar configuration with:
       | key            | value             |
       | source         | ./_bibliography   |
-      | bibliogaphy    | references        |
+      | bibliography   | references        |
     And I have a "_bibliography" directory
     And I have a file "_bibliography/references.bib":
       """

data/features/interpolate.feature

@@ -0,0 +1,83 @@
+Feature: Interpolations ...
+  As a scholar who likes to blog
+  I want to reference cool papers and books from my bibliography
+
+  @tags @reference @liquid @interpolate
+  Scenario: Interpolate liquid variables
+    Given I have a scholar configuration with:
+      | key                | value             |
+      | source             | ./_bibliography   |
+      | bibliography       | my_references     |
+    And I have a "_bibliography" directory
+    And I have a file "_bibliography/my_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 file "custom.csl":
+      """
+      <style>
+        <citation>
+          <layout>
+            <text variable="title"/>
+          </layout>
+        </citation>
+        <bibliography>
+          <layout>
+            <text variable="title"/>
+          </layout>
+        </bibliography>
+      </style>
+      """
+    And I have a page "scholar.html":
+      """
+      ---
+      ---
+      {% assign style_file = 'custom.csl' %}
+      {% bibliography --style {{style_file}} %}
+      """
+    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"
+ 
+
+  @tags @grouping
+  Scenario: Local grouping override - grouping by year with interpolation
+    Given I have a scholar configuration with:
+      | key         | value             |
+      | group_by    | none              |
+      | group_order | ascending         |
+    And I have a "_bibliography" directory
+    And I have a file "_bibliography/references.bib":
+      """
+      @book{ruby1,
+        title     = {The Ruby Programming Language},
+        author    = {Flanagan, David and Matsumoto, Yukihiro},
+        year      = {2008},
+        publisher = {O'Reilly Media}
+      }
+      @book{ruby2,
+        title     = {The Ruby Programming Language},
+        author    = {Flanagan, David and Matsumoto, Yukihiro},
+        year      = {2007},
+        publisher = {O'Reilly Media}
+      }
+      """
+    And I have a page "scholar.html":
+      """
+      ---
+      ---
+      {% assign group_year = 'year' %}
+      {% bibliography -f references --group_by {{group_year}} --group_order descending %}
+      """
+    When I run jekyll
+    Then the _site directory should exist
+    And the "_site/scholar.html" file should exist
+    Then I should see "<h2 class=\"bibliography\">2007</h2>" in "_site/scholar.html"
+    And I should see "<h2 class=\"bibliography\">2008</h2>" in "_site/scholar.html"
+    And "2008" should come before "2007" in "_site/scholar.html"

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

@@ -59,7 +59,7 @@ module Jekyll
       end
 
       def render_items(items)
-        bibliography = items.each_with_index.map { |entry, index|
+        bibliography = items.compact.each_with_index.map { |entry, index|
           reference = bibliography_tag(entry, index + 1)
 
           if generate_details?

data/lib/jekyll/scholar/utilities.rb

@@ -122,6 +122,11 @@ module Jekyll
       end
 
       def bibtex_files
+        if config['bibliography'].include? '*'
+          @bibtex_files ||= Dir.glob(File.join(config["source"], config['bibliography'])).collect do |f|
+            Pathname(f).relative_path_from(Pathname(config['source'])).to_s
+          end
+        end
         @bibtex_files ||= [config['bibliography']]
       end
 
@@ -222,7 +227,7 @@ module Jekyll
       end
 
       def group_by
-        @group_by ||= config['group_by']
+        @group_by = interpolate(@group_by) || config['group_by']
       end
 
       def group?
@@ -436,7 +441,7 @@ module Jekyll
       end
 
       def style
-        @style || config['style']
+        interpolate(@style)|| config['style']
       end
 
       def missing_reference
@@ -557,6 +562,8 @@ module Jekyll
 
         if site.config['permalink'] == 'pretty'
           name << '/'
+        elsif site.config['permalink'].end_with? '/'
+          name << '/'
         else
           name << '.html'
         end

data/lib/jekyll/scholar/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-scholar
 version: !ruby/object:Gem::Version
-  version: 5.11.0
+  version: 5.12.0
 platform: ruby
 authors:
 - Sylvester Keil
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-05 00:00:00.000000000 Z
+date: 2018-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -100,6 +100,7 @@ files:
 - features/details.feature
 - features/filter.feature
 - features/grouping.feature
+- features/interpolate.feature
 - features/layout.feature
 - features/multiple_files.feature
 - features/reference.feature
@@ -148,7 +149,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: jekyll-scholar
-rubygems_version: 2.6.13
+rubygems_version: 2.7.4
 signing_key: 
 specification_version: 4
 summary: Jekyll extensions for the academic blogger.
@@ -163,6 +164,7 @@ test_files:
 - features/details.feature
 - features/filter.feature
 - features/grouping.feature
+- features/interpolate.feature
 - features/layout.feature
 - features/multiple_files.feature
 - features/reference.feature