jekyll-scholar 4.0.0 → 4.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 953182d6b21be19f9aaa67ac7212e36f977d3d8d
-  data.tar.gz: 39fd7df236b9f05ff6393069b741ce68f09e802d
+  metadata.gz: 283d672bb247fb3d0acae3704b5b4309a25f708d
+  data.tar.gz: 1ae644d03d9eca66381959e740b42dc5e604b79c
 SHA512:
-  metadata.gz: c1a9c763ddb481a6bede4db299aaf6938994d22c5b84c3be3c3b42ee0b936d5d1b384b50d14f43d22433c3edb88b8f6d643a228c9b3887b30833ec6a60b247d1
-  data.tar.gz: 21db98dd52bc7655a8e5894922f0d849256e5eb82cfa521ea0ccfd4a9d77a2da209445ae57b9d21d94d328762dc3d60dbed894d4c96c4924eb7e3bdc712547d4
+  metadata.gz: 679b74e725f93ee3ac61667778e6324b88504eb50ea5461cb2f4778e509d5a4ccaaa43b23654100fdb24020971620241b68453603bd16a49be3c808ef3053684
+  data.tar.gz: 421510aa6e53b425ec10c8e8e5822acce8ad07a8b05e2d029e284dfcff444e6bd3d472415454be3eb843a8a7fc53cdc733a02844140758171881c4fcc940519a

data/README.md

@@ -31,7 +31,7 @@ to a file in your plugin directory (e.g., to `_plugins/ext.rb`):
 Alternatively, add `jekyll-scholar` to your `gem` list in your Jekyll
 configuration:
 
-    gem: ['jekyll-scholar']
+    gems: ['jekyll/scholar']
 
 In your configuration you can now adjust the Jekyll-Scholar settings. The
 default configuration is as follows:
@@ -152,6 +152,14 @@ For more details about filters, see the corresponding section below or
 consult the [BibTeX-Ruby](https://github.com/inukshuk/bibtex-ruby)
 documentation.
 
+If you need to limit the number of entries in your bibliography, you can
+use the `--max` option:
+
+    {% bibliography --max 5 %}
+
+This would generate a bibliography containing only the first 5 entries
+of your bibliography (after query filters and sort options have been applied).
+
 ### Bibliography Template
 
 Your bibliography is always rendered as an ordered list. Additionally,

data/features/citation.feature

@@ -215,3 +215,30 @@ Feature: Citations
     And the "_site/scholar.html" file should exist
     And I should see "\[1\], \[2\]" in "_site/scholar.html"
 
+  @tags @cite @variables
+  Scenario: A Simple Citation using 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 page "scholar.html":
+      """
+      ---
+      ---
+      {% assign myVariable = 'ruby' %}
+      {% cite myVariable %}
+      """
+    When I run jekyll
+    Then the _site directory should exist
+    And the "_site/scholar.html" file should exist
+    And I should see "Flanagan" in "_site/scholar.html"

data/features/filter.feature

@@ -37,3 +37,37 @@ Feature: BibTeX
     And the "_site/scholar.html" file should exist
     And I should see "Programming Ruby" in "_site/scholar.html"
     And I should not see "The Ruby Programming Language" in "_site/scholar.html"
+
+  @tags @max
+  Scenario: Limit number of entries
+    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{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":
+      """
+      ---
+      ---
+      {% bibliography --max 1 %}
+      """
+    When I run jekyll
+    Then the _site directory should exist
+    And the "_site/scholar.html" file should exist
+    And I should not see "Programming Ruby" in "_site/scholar.html"
+    And I should see "The Ruby Programming Language" in "_site/scholar.html"

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

@@ -21,6 +21,8 @@ module Jekyll
           cited_references.include? e.key
         end if cited_only?
 
+        references = references.take(max.to_i) if limit_entries?
+
         bibliography = references.each_with_index.map { |entry, index|
           reference = bibliography_tag(entry, index + 1)
 

data/lib/jekyll/scholar/utilities.rb

@@ -15,7 +15,7 @@ module Jekyll
     module Utilities
 
       attr_reader :config, :site, :query,
-        :context, :prefix, :keys, :text
+        :context, :prefix, :keys, :text, :max
 
       def split_arguments(arguments)
 
@@ -56,6 +56,10 @@ module Jekyll
             locators << locator
           end
 
+          opts.on('-m', '--max MAX') do |max|
+            @max = max
+          end
+
           opts.on('-s', '--style STYLE') do |style|
             @style = style
           end
@@ -65,7 +69,7 @@ module Jekyll
           end
         end
 
-        argv = arguments.split(/(\B-[cfqptTsl]|\B--(?:cited|file|query|prefix|text|style|template|locator|))/)
+        argv = arguments.split(/(\B-[cfqptTslm]|\B--(?:cited|file|query|prefix|text|style|template|locator|max|))/)
 
         parser.parse argv.map(&:strip).reject(&:empty?)
       end
@@ -119,6 +123,10 @@ module Jekyll
         sort bibliography[query || config['query']]
       end
 
+      def limit_entries?
+        !max.nil?
+      end
+
       def sort(unsorted)
         return unsorted if config['sort_by'] == 'none'
 
@@ -319,6 +327,9 @@ module Jekyll
 
       def cite(keys)
         items = keys.map do |key|
+          # dereference variables in current scope
+          key = context.scopes.last[key] || key
+
           if bibliography.key?(key)
             entry = bibliography[key]
             entry = entry.convert(*bibtex_filters) unless bibtex_filters.empty?

data/lib/jekyll/scholar/version.rb

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

metadata

@@ -1,84 +1,84 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-scholar
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.0.1
 platform: ruby
 authors:
 - Sylvester Keil
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-15 00:00:00.000000000 Z
+date: 2014-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
   name: citeproc-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
   name: csl-styles
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
   name: bibtex-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: ' Jekyll-Scholar is for all the academic bloggers out there. It is a
+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
-  gives your blog posts citation super-powers.'' '
+  gives your blog posts citation super-powers.' "
 email: http://sylvester.keil.or.at
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .coveralls.yml
-- .gitignore
-- .simplecov
-- .travis.yml
+- ".coveralls.yml"
+- ".gitignore"
+- ".simplecov"
+- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
@@ -121,12 +121,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []