jekyll-scholar 4.0.2 → 4.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 20b4bc03a55f59b2ff1546d6ae1932afd3e9d662
-  data.tar.gz: 61c9c0815aad016ee18ddbabd4937950705ea3ed
+  metadata.gz: 9fd48f190b2abc3b973877fee2e909b65efc61bb
+  data.tar.gz: 0c0736c080e65a1d5366ae492c85ec70ef3a80e3
 SHA512:
-  metadata.gz: cefd79645e48e268df1ef87c91a86c293af6167f68fa76307fdba20c8c9e986138cad03f5199b031d220738e3bb91aa8ac7caede94d34614726967a7c1c68ff1
-  data.tar.gz: e6d3dec27c119926edc628ba59c97757ed762d8aabae00e2c5e5497433977f6464b077537c15bfc293e78ba43cda9d2a149a05096dc29022d5f1d40a2003ee58
+  metadata.gz: 24aad2ada7dd544baae2c8c1832de09f3d31e81d4543c621e8ecfbb9e2b834ff1a583a7e1fe2e1a17cb5330241bb57ecb2bfa5fa21c8be15228ab53d3753b79c
+  data.tar.gz: 06d0ed70b9e9b33deda291b05f0bc787ca302abdaf013ee762058c98a89114836605b7845f28fc3c5d80d41f8651710b2ebd8c393a8958e39310827eca3b96ef

data/README.md

@@ -248,6 +248,12 @@ the `cited` option to the bibliography tag:
 
     {% bibliography --cited %}
 
+By default, the `--cited` option will still sort your bibliography if you set
+the sort option. Especially for styles using citation numbers, this is usually
+not the desired behaviour. In such cases you can use `--cited_in_order` instead
+of `--cited` and your bibliography will contain all cited items in the order
+they were cited on the page.
+
 For longer quotes, Jekyll-Scholar provides a `quote` tag:
 
     {% quote derrida:purveyor %}

data/features/bibtex.feature

@@ -94,7 +94,7 @@ Feature: BibTeX
     Given I have a scholar configuration with:
       | key                   | value                                         |
       | source                | ./_bibliography                               |
-      | bibliography_template | <abbr>{{index}} [{{key}}]</abbr>{{reference}} |
+      | bibliography_template | <abbr>{{index}} {{entry.type}} [{{key}}]</abbr>{{reference}} |
     And I have a "_bibliography" directory
     And I have a file "_bibliography/references.bib":
       """
@@ -115,7 +115,7 @@ Feature: BibTeX
     Then the _site directory should exist
     And the "_site/scholar.html" file should exist
     And I should see "<i>The Ruby Programming Language</i>" in "_site/scholar.html"
-    And I should see "<abbr>1 \[ruby\]</abbr><span" in "_site/scholar.html"
+    And I should see "<abbr>1 book \[ruby\]</abbr><span" in "_site/scholar.html"
 
   @tags @filter
   Scenario: Filtered Bibliography Loaded From Default Directory
@@ -151,6 +151,41 @@ 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"
 
+  @tags @filter @variables
+  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":
+      """
+      @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":
+      """
+      ---
+      ---
+      {% assign yr = 2000 %}
+      {% bibliography -f references --query @book[year <= {{ yr }}] %}
+      """
+    When I run jekyll
+    Then the _site directory should exist
+    And the "_site/scholar.html" file should exist
+    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"
+
   @tags @bibliography @prefix
   Scenario: A Prefixed Bibliography
     Given I have a scholar configuration with:

data/features/citation.feature

@@ -277,3 +277,49 @@ Feature: Citations
     Then the _site directory should exist
     And the "_site/scholar.html" file should exist
     And I should see "Flanagan" in "_site/scholar.html"
+
+  @tags @cite @variables @data
+  Scenario: Multiple Citations in a list 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}
+      }
+
+      @book{gof,
+         Author = {Erich Gamma and Richard Helm and Ralph Johnson and John Vlissides},
+         Title = {Design Patterns: Elements of Reusable Object-Oriented Software},
+         Publisher = {Addison-Wesley Professional},
+         Year = {1994},                   
+      }
+      """
+    And I have a "_data" directory
+    And I have a file "_data/covers.yml":
+      """
+      - reference: "ruby"
+        image: "/img/covers/cover_01.png"
+      - reference: "gof"
+        image: "/img/covers/cover_02.png"
+      """
+    And I have a page "scholar.html":
+      """
+      ---
+      ---
+      {% for cover in site.data.covers %}
+        {% cite cover.reference %}
+      {% endfor %}
+      """
+    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"
+    And I should see "Gamma" in "_site/scholar.html"
+

data/features/sorting.feature

@@ -150,3 +150,43 @@ Feature: Sorting BibTeX Bibliographies
     Then "Ruby Programming" should come before "Smalltalk" in "_site/scholar.html"
     And I should not see "<i>Ruby Not Cited</i>" in "_site/scholar.html"
 
+  @tags @sorting @cited_in_order
+  Scenario: Sort By Year Cited in Order
+    Given I have a scholar configuration with:
+      | key     | value             |
+      | sort_by | year              |
+    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":
+      """
+      ---
+      ---
+      {% cite ruby1 %}
+      {% cite smalltalk %}
+      {% bibliography --cited_in_order %}
+      """
+    When I run jekyll
+    Then the _site directory should exist
+    And the "_site/scholar.html" file should exist
+    Then "Ruby Programming" should come before "Smalltalk" in "_site/scholar.html"
+    And I should not see "<i>Ruby Not Cited</i>" in "_site/scholar.html"

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

@@ -15,15 +15,23 @@ module Jekyll
       def render(context)
         set_context_to context
 
-        references = entries
-
-        references.select! do |e|
-          cited_references.include? e.key
-        end if cited_only?
+        items = entries
+
+        if cited_only?
+          items = if skip_sort?
+            cited_references.uniq.map do |key|
+              items.detect { |e| e.key == key }
+            end
+          else
+            entries.select do |e|
+              cited_references.include? e.key
+            end
+          end
+        end
 
-        references = references.take(max.to_i) if limit_entries?
+        items = items.take(max.to_i) if limit_entries?
 
-        bibliography = references.each_with_index.map { |entry, index|
+        bibliography = items.each_with_index.map { |entry, index|
           reference = bibliography_tag(entry, index + 1)
 
           if generate_details?

data/lib/jekyll/scholar/utilities.rb

@@ -14,8 +14,7 @@ module Jekyll
     # #site readers
     module Utilities
 
-      attr_reader :config, :site, :query,
-        :context, :prefix, :keys, :text, :max
+      attr_reader :config, :site, :context, :prefix, :text, :max
 
       def split_arguments(arguments)
 
@@ -35,6 +34,10 @@ module Jekyll
             @cited = true
           end
 
+          opts.on('-C', '--cited_in_order') do |cited|
+            @cited, @skip_sort = true, true
+          end
+
           opts.on('-f', '--file FILE') do |file|
             @bibtex_files ||= []
             @bibtex_files << file
@@ -69,7 +72,7 @@ module Jekyll
           end
         end
 
-        argv = arguments.split(/(\B-[cfqptTslm]|\B--(?:cited|file|query|prefix|text|style|template|locator|max|))/)
+        argv = arguments.split(/(\B-[cCfqptTslm]|\B--(?:cited(_in_order)?|file|query|prefix|text|style|template|locator|max|))/)
 
         parser.parse argv.map(&:strip).reject(&:empty?)
       end
@@ -119,6 +122,10 @@ module Jekyll
         @bibliography
       end
 
+      def query
+        interpolate @query
+      end
+
       def entries
         sort bibliography[query || config['query']]
       end
@@ -128,7 +135,7 @@ module Jekyll
       end
 
       def sort(unsorted)
-        return unsorted if config['sort_by'] == 'none'
+        return unsorted if skip_sort?
 
         sorted = unsorted.sort_by { |e| e[config['sort_by']].to_s }
         sorted.reverse! if config['order'] =~ /^(desc|reverse)/i
@@ -167,6 +174,10 @@ module Jekyll
         !!@cited
       end
 
+      def skip_sort?
+        @skip_sort || config['sort_by'] == 'none'
+      end
+
       def extend_path(name)
         if name.nil? || name.empty?
           name = config['bibliography']
@@ -228,7 +239,7 @@ module Jekyll
           'entry' => liquidify(entry),
           'reference' => reference_tag(entry, index),
           'key' => entry.key,
-          'type' => entry.type,
+          'type' => entry.type.to_s,
           'link' => repository_link_for(entry),
           'index' => index
         })
@@ -238,7 +249,7 @@ module Jekyll
         e = {}
 
         e['key'] = entry.key
-        e['type'] = entry.type
+        e['type'] = entry.type.to_s
 
         if entry.field?(:abstract)
           tmp = entry.dup
@@ -327,9 +338,6 @@ 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?
@@ -373,15 +381,26 @@ module Jekyll
         context && context['cited'] || []
       end
 
+      def keys
+        # De-reference keys (in case they are variables)
+        # We need to do this every time, to support for loops,
+        # where the context can change for each invocation.
+        Array(@keys).map do |key|
+          context.send(:resolve, key) || key
+        end
+      end
+
+      def interpolate(string)
+        return unless string
+
+        string.gsub(/{{\s*([\w\.]+)\s*}}/) do |match|
+          context.send(:resolve, $1) || match
+        end
+      end
+
       def set_context_to(context)
         @context, @site, = context, context.registers[:site]
         config.merge!(site.config['scholar'] || {})
-
-        # De-reference keys
-        keys.map! do |key|
-          context.send(:resolve, key) || key
-        end unless keys.nil?
-
         self
       end
     end

data/lib/jekyll/scholar/version.rb

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

metadata

@@ -1,84 +1,84 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-scholar
 version: !ruby/object:Gem::Version
-  version: 4.0.2
+  version: 4.0.4
 platform: ruby
 authors:
 - Sylvester Keil
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-22 00:00:00.000000000 Z
+date: 2014-06-20 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: []