jekyll-scholar 5.14.0 → 5.14.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd0dce701856f7a79d97fa09d8588178990d844d2f7d9ae119625c1cf38edf35
-  data.tar.gz: 0ed8d1968b07c393f098640e16c77a4265672832686fc4fa455acc36eec874d8
+  metadata.gz: dc3a085adf1accd384777754f269e3d5d367d7bd460c561a381aa5b058cae5d8
+  data.tar.gz: a24a018883dd8eb5d468cfe79d778aa284a21f9c8edcf2fa0eafdeb6c3df2ba3
 SHA512:
-  metadata.gz: f3b2b3aa1e84ebfdcc4013162c37f61b447461ef823448108d119a71e35f15099c9dc56c6ab35ab61b2b9d06a27ddb406f1e98a23e339a4b3f9aecfc1c9af324
-  data.tar.gz: ef5bff524cd70702b239bd4e260afe8907fd54139b02079af87eed5432ebdc4dfe7fe339cc2d0757380168935e6e30f4dd3bd6345fec0671c71fbd263d4ea2f7
+  metadata.gz: 9caadbd232a0fccbf5b43e28c8de9d078978ee8a19aea22c774fffce183a3d0b128abae12a68907fbc02b9989186eb98283f050ba2e9ee5d59300f3f98eaa3c0
+  data.tar.gz: 98692f7f538e0dc2082ffdea20f3070538b5182beee571324b558cfd3ee10df31ad28856515682d093859674b7a33bb0e7f38200a2208bb63652085948dfcdf4

data/README.md

@@ -8,7 +8,6 @@ and gives your blog posts citation super-powers.
 
 [![Build Status](https://travis-ci.org/inukshuk/jekyll-scholar.png?branch=master)](https://travis-ci.org/inukshuk/jekyll-scholar)
 [![Coverage Status](https://coveralls.io/repos/inukshuk/jekyll-scholar/badge.png)](https://coveralls.io/r/inukshuk/jekyll-scholar)
-[![Dependency Status](https://gemnasium.com/inukshuk/jekyll-scholar.png)](https://gemnasium.com/inukshuk/jekyll-scholar)
 
 Already using Jekyll-Scholar and interested to help out? Please get in touch with us if you would like to become a maintainer!
 
@@ -24,10 +23,10 @@ Or add it to your `Gemfile`:
 ### Github Pages
 
 Note that it is not possible to use this plugin with the
-  [default Github pages workflow](https://help.github.com/articles/using-jekyll-with-pages/). 
+  [default Github pages workflow](https://help.github.com/articles/using-jekyll-with-pages/).
 Github does not allow any but a few select plugins to run for security reasons,
 and Jekyll-Scholar is not among them.
-You will have to generate your site locally and push the results to the `master` resp. `gh-pages` 
+You will have to generate your site locally and push the results to the `master` resp. `gh-pages`
 branch of your site repository.
 You can keep sources, configuration and plugins in a separate branch; see e.g.
   [here](http://davidensinger.com/2013/07/automating-jekyll-deployment-to-github-pages-with-rake/)
@@ -65,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, 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. A string that contains a `*` will be passed to `Dir::glob`, so `**/*.bib{,tex}` will find all files named `*.bib` and `*.bibtex` under `source`.  |
@@ -169,9 +168,9 @@ 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. 
+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] %}
 
@@ -302,16 +301,16 @@ of the items you wish to quote separated by spaces. For example,
 
 #### Citations when there's more than one bibliography
 
-Let's return to the example above where you have two bibliographies stored 
+Let's return to the example above where you have two bibliographies stored
 in `_bibliography/books.bib` and `_bibliography/papers.bib`. We also must
 have the main bibliography, e.g., `_bibliography/references.bib`. As we
 know from above, it's possible to use bibliographies other than the main
-bibliography by calling `{% bibliography --file books %}` or 
-`{% bibliography --file papers %}`. 
+bibliography by calling `{% bibliography --file books %}` or
+`{% bibliography --file papers %}`.
 
-Though what if we want to cite an article that's not in the main bibliography? 
-We use the same approach as above; to cite an article in the `books.bib` 
-bibliography, we simply call `{% cite ruby --file books %}` 
+Though what if we want to cite an article that's not in the main bibliography?
+We use the same approach as above; to cite an article in the `books.bib`
+bibliography, we simply call `{% cite ruby --file books %}`
 
 #### Suppressing author names
 
@@ -423,6 +422,15 @@ assigned unique identifiers linking to the respective references
 section, although both posts will be rendered into a single HTML
 document.
 
+#### Add a custom class for the citation reference
+By default Jekyll Scholar generate a link with a class:
+
+    <a href="#ruby" class="citation">(Derrida, 1975)</a>
+
+You can custom this class in your configuration:
+
+    scholar:
+      cite_class: citation
 
 ### File Repositories
 

data/features/bibtex.feature

@@ -364,6 +364,53 @@ Feature: BibTeX
     And I should not see "<i>The Ruby Programming Language</i>" in "_site/scholar.html"
     And I should see "<i>Smalltalk Best Practice Patterns</i>" in "_site/scholar.html"
 
+  @filter @regex
+  Scenario: Filter using interpolated query variable
+    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":
+      """
+      @article{testa,
+        title={test1},
+        author={Albert, Alex A and Booth, Brian and Cook, Cathy},
+        journal={Irrelevant},
+        year={2018}
+      }
+      @article{testb,
+        title={test2},
+        author={Booth, Brian and Albert, Alex and Cook, Cathy},
+        journal={Irrelevant},
+        year={2018}
+      }
+      @article{testc,
+        title={test3},
+        author={Cook, Cathy and Booth, Brian and Albert, Alex},
+        journal={Irrelevant},
+        year={2018}
+      }
+      @article{testd,
+        title={test4},
+        author={Done, Daniel},
+        journal={Irrelevant},
+        year={2018}
+      }
+      """
+    And I have a page "scholar.html":
+      """
+      ---
+      ---
+      {% bibliography --query @*[author ~= \bAlbert\b] %}
+      """
+    When I run jekyll
+    Then the _site directory should exist
+    And the "_site/scholar.html" file should exist
+    And I should see "test1" in "_site/scholar.html"
+    And I should see "test2" in "_site/scholar.html"
+    And I should see "test3" in "_site/scholar.html"
+    And I should not see "test4" in "_site/scholar.html"
+
   @tags @bibliography @prefix
   Scenario: A Prefixed Bibliography
     Given I have a scholar configuration with:

data/lib/jekyll/scholar/defaults.rb

@@ -58,6 +58,8 @@ module Jekyll
 
       'query'                  => '@*',
 
+      'cite_class'             => 'citation',
+
       'type_names' => {
         'article' => 'Journal Articles',
         'book' => 'Books',

data/lib/jekyll/scholar/utilities.rb

@@ -147,7 +147,7 @@ module Jekyll
       def bibtex_paths
         @bibtex_paths ||= bibtex_files.map { |file|
            interpolated_file = interpolate file
-           extend_path interpolated_file 
+           extend_path interpolated_file
         }
       end
 
@@ -488,7 +488,7 @@ module Jekyll
             :filters => [Jekyll::Filters]
           }
         )
-        # process the generated reference with Liquid, to get the same behaviour as 
+        # process the generated reference with Liquid, to get the same behaviour as
         # when it is used on a page
         Liquid::Template.parse(tmp).render(
           site.site_payload,
@@ -656,7 +656,7 @@ module Jekyll
           end
         end
 
-        link_to link_target_for(keys[0]), render_citation(items)
+        link_to link_target_for(keys[0]), render_citation(items), {class: config['cite_class']}
       end
 
       def cite_details(key, text)

data/lib/jekyll/scholar/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-scholar
 version: !ruby/object:Gem::Version
-  version: 5.14.0
+  version: 5.14.1
 platform: ruby
 authors:
 - Sylvester Keil
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-09 00:00:00.000000000 Z
+date: 2019-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll