jekyll-scholar 4.1.3 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b598b8f5248f77c16aa09aab90485fb2e5262cb1
-  data.tar.gz: e6ec4af6641c6ef0e97af633c842495c70c80094
+  metadata.gz: 975325f5f0952b76b523cd83b8e087bdcc3fe0a0
+  data.tar.gz: 0f49f478269ced160ece93bd80c0c8b3fdaa51f3
 SHA512:
-  metadata.gz: d49f0e8c60a84f3009998b9a464f8554e4827121d375425f299f769a1718b03387ed246811b4833789ee1a92b3537ac71296a0bc2337b5849c2f8488b272199a
-  data.tar.gz: b8e39fb722690e97b90bdb332e841c256aff9be8d3ee420fd42e46b63c251e4760fa79c62bae6fe92d93ae4a199060ddb32d3a2b2c313cc36e20295dc1141ebe
+  metadata.gz: 0455060d84b28ae533113bb7a086c54c7d52b87544bcc96a284bee1994f50e6cb73380b5b2009d657ea1038918e027a2ede9f3182b22ce5ce07b5f9446f44d36
+  data.tar.gz: 5074a8a3ddee8c3c808f55e70badd396b077d4ed59ca01293be19084eb15efcc27d639623657e3307b57f4146a719678a3ad241d3f9ebde50bef876fc5e37447

data/README.md

@@ -282,6 +282,14 @@ of the items you wish to quote separated by spaces. For example,
 
     <a href="#ruby">(Flanagan &amp; Matsumoto 2008; Shaughnessy 2013)</a>
 
+#### Suppressing author names
+
+Sometimes you want to suppress author names in a citation, because the
+name has already been mentioned in your text; for such cases Jekyll-Scholar
+provides the `--suppress_author` option (short form: `-A`):
+`...as Matz explains {% cite ruby -A -l 42 %}` would produce something
+like: `...as Matz explains (2008, p. 42)`.
+
 #### Page numbers and locators
 
 If you would like to add page numbers to your citation, you can use the

data/features/citation.feature

@@ -29,6 +29,34 @@ Feature: Citations
     And the "_site/scholar.html" file should exist
     And I should see "Flanagan" in "_site/scholar.html"
 
+  @tags @cite @suppress-author
+  Scenario: Citations With Suppressed Author
+    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":
+      """
+      ---
+      ---
+      {% cite ruby --suppress_author %}
+      """
+    When I run jekyll
+    Then the _site directory should exist
+    And the "_site/scholar.html" file should exist
+    And I should see "2008" in "_site/scholar.html"
+    And I should not see "Flanagan" in "_site/scholar.html"
+
   @tags @cite
   Scenario: Missing references
     Given I have a scholar configuration with:
@@ -215,6 +243,36 @@ Feature: Citations
     And the "_site/scholar.html" file should exist
     And I should see "\[1\], \[2\]" in "_site/scholar.html"
 
+  @tags @cite @citation_number
+  Scenario: Multiple citations of the same item using citation numbers
+    Given I have a scholar configuration with:
+      | key          | value             |
+      | source       | ./_bibliography   |
+      | bibliography | my_references     |
+      | style        | ieee              |
+    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":
+      """
+      ---
+      ---
+      {% cite ruby %}
+      {% cite ruby %}
+      """
+    When I run jekyll
+    Then the _site directory should exist
+    And the "_site/scholar.html" file should exist
+    And I should see "\[1\]" in "_site/scholar.html"
+    And I should not see "\[2\]" in "_site/scholar.html"
+
   @tags @cite @variables
   Scenario: A Simple Citation using liquid variables
     Given I have a scholar configuration with:

data/lib/jekyll/scholar/utilities.rb

@@ -38,6 +38,10 @@ module Jekyll
             @cited, @skip_sort = true, true
           end
 
+          opts.on('-A', '--suppress_author') do |cited|
+            @suppress_author = true
+          end
+
           opts.on('-f', '--file FILE') do |file|
             @bibtex_files ||= []
             @bibtex_files << file
@@ -72,7 +76,7 @@ module Jekyll
           end
         end
 
-        argv = arguments.split(/(\B-[cCfqptTslm]|\B--(?:cited(_in_order)?|file|query|prefix|text|style|template|locator|max|))/)
+        argv = arguments.split(/(\B-[cCfqptTslmA]|\B--(?:cited(_in_order)?|file|query|prefix|text|style|template|locator|max|suppress_author|))/)
 
         parser.parse argv.map(&:strip).reject(&:empty?)
       end
@@ -142,6 +146,10 @@ module Jekyll
         sorted
       end
 
+      def suppress_author?
+        !!@suppress_author
+      end
+
       def repository?
         !config['repository'].nil? && !config['repository'].empty?
       end
@@ -322,7 +330,7 @@ module Jekyll
         renderer.render items.zip(locators).map { |entry, locator|
           cited_keys << entry.key
 
-          item = citation_item_for entry, citation_number
+          item = citation_item_for entry, citation_number(entry.key)
           item.locator = locator
 
           item
@@ -338,6 +346,7 @@ module Jekyll
         CiteProc::CitationItem.new id: entry.id do |c|
           c.data = CiteProc::Item.new entry.to_citeproc
           c.data[:'citation-number'] = citation_number
+          c.data.suppress! 'author' if suppress_author?
         end
       end
 
@@ -345,10 +354,8 @@ module Jekyll
         context['cited'] ||= []
       end
 
-      def citation_number
-        number = context['citation_number'] || 1
-        context['citation_number'] = number.succ
-        number
+      def citation_number(key)
+        (context['citation_numbers'] ||= {})[key] ||= cited_keys.length
       end
 
       def cite(keys)

data/lib/jekyll/scholar/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-scholar
 version: !ruby/object:Gem::Version
-  version: 4.1.3
+  version: 4.2.0
 platform: ruby
 authors:
 - Sylvester Keil
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-30 00:00:00.000000000 Z
+date: 2014-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll