jekyll-scholar 6.8.0 → 7.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9003e905d46343a563b51568a93777e2fda49ede94e0cf34f0efc326eff8d6f8
-  data.tar.gz: cc3020a8bd67e1ae7e1a7d069b47c3ffa359dd22f003ab05e7ea15d3fcc66b34
+  metadata.gz: 287c638fa9bd7e062280db1af05a5d98cc9d509c423ce1b8d0f7d948f3498b16
+  data.tar.gz: 606db44855a017a7694b61560ef7779c95118f461301298e7875bc1fbf5d2785
 SHA512:
-  metadata.gz: 4d297673512e24ba530830d62ae7c3ff89a3a6360593f6bb0cda41ad93e4a64276576ed4d05d47283b66d6825ef9a399f970b01bc616eb5f3bf1aa83794a9978
-  data.tar.gz: 57901b71b3ac3c289b19d8c60167593a08928f6a2d8c9608456806e0bab8d5e22e181e2ba547fe9f9db8cbb5e76c0132e9c71205115454355829a7efe6787a9d
+  metadata.gz: babca3507daca599a095c21b0c7d517bc6dd0ad3e4f3cce22763b36784fc8be09fe84d2af9b32efdf221239a4ef4b0bdbbd9b85d7eca513368e2e6e6e99297c7
+  data.tar.gz: c40b99a30e36cce98d1bcc11fb3e9bf53dd0c605f79b1701499f7d21a91fe63f26ad836cff952d9ca8bba7d2c52b89fbb25afff87cade2faf404f4808f5d69a4

data/README.md

@@ -32,7 +32,7 @@ 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/)
 for details.
 
-
+Alternatively, you can use a [Github Actions](https://github.com/features/actions) called [jekyll-action](https://github.com/helaili/jekyll-action) to deploy your site to Github Pages
 
 Usage
 -----
@@ -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`.  |

data/features/nocite.feature

@@ -0,0 +1,78 @@
+Feature: Nocited Bibliographies
+  As a scholar who likes to blog
+  I want to sort my bibliography by hand
+  But do not want to cite anything
+
+  Scenario: Nocite references from a single bibliography
+    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":
+      """
+      @book{ruby1,
+        title     = {The Ruby Programming Language},
+        author    = {Flanagan, David and Matsumoto, Yukihiro},
+        year      = {2008},
+        publisher = {O'Reilly Media}
+      },
+      @book{ruby2,
+        title     = {Ruby Not Cited},
+        author    = {Flanagan, David and Matsumoto, Yukihiro},
+        year      = {2007},
+        publisher = {O'Reilly Media}
+      },
+      @book{smalltalk,
+        title     = {Smalltalk Best Practice Patterns},
+        author    = {Kent Beck},
+        year      = {1996},
+        publisher = {Prentice Hall}
+      }
+
+      """
+    And I have a page "scholar.html":
+      """
+      ---
+      ---
+      {% nocite smalltalk ruby1 %}
+      {% bibliography --cited %}
+      """
+    When I run jekyll
+    Then the _site directory should exist
+    And the "_site/scholar.html" file should exist
+    And I should see "<i>Smalltalk Best Practice Patterns</i>" in "_site/scholar.html"
+    And I should see "<i>The Ruby Programming Language</i>" in "_site/scholar.html"
+    And I should not see "<i>Ruby Not Cited</i>" in "_site/scholar.html"
+
+Scenario: No nocite references results in empty bibliography
+    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":
+      """
+      @book{ruby,
+        title     = {The Ruby Programming Language},
+        author    = {Flanagan, David and Matsumoto, Yukihiro},
+        year      = {2008},
+        publisher = {O'Reilly Media}
+      },
+      @book{smalltalk,
+        title     = {Smalltalk Best Practice Patterns},
+        author    = {Kent Beck},
+        year      = {1996},
+        publisher = {Prentice Hall}
+      }
+
+      """
+    And I have a page "scholar.html":
+      """
+      ---
+      ---
+      {% bibliography --cited %}
+      """
+    When I run jekyll
+    Then the _site directory should exist
+    And the "_site/scholar.html" file should exist
+    And I should not see "<i>Smalltalk Best Practice Patterns</i>" in "_site/scholar.html"
+    And I should not see "<i>The Ruby Programming Language</i>" in "_site/scholar.html"

data/features/page_config.feature

@@ -40,3 +40,33 @@ Feature: Page Configuration
     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/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/converters/bibtex.rb

@@ -17,7 +17,7 @@ module Jekyll
 
       def initialize(config = {})
         super
-        @config['scholar'] = Scholar.defaults.merge(@config['scholar'] || {})
+        @config = Scholar.defaults.merge(@config['scholar'] || {})
         @markdown = Jekyll::Converters::Markdown.new(config)
       end
 
@@ -31,7 +31,7 @@ module Jekyll
 
       def convert(content)
         content = BibTeX.parse(content, :strict => true, :include => [:meta_content],
-                               :filter => @config['scholar']['bibtex_filters']).map do |b|
+                               :filter => config['bibtex_filters']).map do |b|
           if b.respond_to?(:to_citeproc)
             render_bibliography b
           else

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

@@ -0,0 +1,28 @@
+module Jekyll
+  class Scholar
+
+    class NoCiteTag < Liquid::Tag
+      include Scholar::Utilities
+
+      attr_reader :pages
+
+      def initialize(tag_name, arguments, tokens)
+        super
+
+        @config = Scholar.defaults.dup
+        @keys, arguments = split_arguments(arguments)
+
+        optparse(arguments)
+      end
+
+      def render(context)
+        set_context_to context
+        nocite keys
+      end
+
+    end
+
+  end
+end
+
+Liquid::Template.register_tag('nocite', Jekyll::Scholar::NoCiteTag)

data/lib/jekyll/scholar/utilities.rb

@@ -384,7 +384,7 @@ module Jekyll
       def month_names
         return @month_names unless @month_names.nil?
 
-        @month_names = config['month_names'].nil? ? Date::MONTHNAMES : config['month_names'].unshift(nil)
+        @month_names = config['month_names'].nil? ? Date::MONTHNAMES : [nil] + config['month_names']
       end
 
       def remove_duplicates?
@@ -527,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
@@ -730,6 +731,18 @@ module Jekyll
         link_to link_target_for(keys[0]), render_citation(items), {class: config['cite_class']}
       end
 
+      def nocite(keys)
+        items = keys.map do |key|
+          if bibliography.key?(key)
+            entry = bibliography[key]
+            cited_keys << entry.key
+            cited_keys.uniq!
+          else
+            return missing_reference
+          end
+        end
+      end
+
       def cite_details(key, text)
         if bibliography.key?(key)
           link_to details_link_for(bibliography[key]), text || config['details_link']

data/lib/jekyll/scholar/version.rb

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

data/lib/jekyll/scholar.rb

@@ -18,6 +18,7 @@ require 'jekyll/scholar/tags/bibtex'
 require 'jekyll/scholar/tags/cite'
 require 'jekyll/scholar/tags/cite_details'
 require 'jekyll/scholar/tags/details_link'
+require 'jekyll/scholar/tags/nocite'
 require 'jekyll/scholar/tags/quote'
 require 'jekyll/scholar/tags/reference'
 require 'jekyll/scholar/generators/details'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-scholar
 version: !ruby/object:Gem::Version
-  version: 6.8.0
+  version: 7.1.0
 platform: ruby
 authors:
 - Sylvester Keil
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-06-08 00:00:00.000000000 Z
+date: 2022-05-19 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/nocite.feature
 - features/page_config.feature
 - features/reference.feature
 - features/removeduplicate.feature
@@ -127,6 +128,7 @@ files:
 - lib/jekyll/scholar/tags/cite.rb
 - lib/jekyll/scholar/tags/cite_details.rb
 - lib/jekyll/scholar/tags/details_link.rb
+- lib/jekyll/scholar/tags/nocite.rb
 - lib/jekyll/scholar/tags/quote.rb
 - lib/jekyll/scholar/tags/reference.rb
 - lib/jekyll/scholar/utilities.rb
@@ -150,7 +152,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.15
 signing_key:
 specification_version: 4
 summary: Jekyll extensions for the academic blogger.
@@ -168,6 +170,7 @@ test_files:
 - features/interpolate.feature
 - features/layout.feature
 - features/multiple_files.feature
+- features/nocite.feature
 - features/page_config.feature
 - features/reference.feature
 - features/removeduplicate.feature