jekyll-scholar 3.0.0 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c7d2bffb292d27ff2150ac22f4f08c16725933e1
-  data.tar.gz: df29da3988760f7cf35edfa13c147ff1a11b8a1d
+  metadata.gz: 6c8ccd2ac58af0bf1f408e492607526d4ecd8b5a
+  data.tar.gz: 6172bf565989e36b457cc3de16437a53fa02ecae
 SHA512:
-  metadata.gz: a3e5ad5b114cc0b8c2ac03c79a3154964c32bc81f72d1187e304c0028e596775fd260ca674037cf59e9038f6b25e989d4f2a29b0ba9e52e8b57df2d7b6c9aa15
-  data.tar.gz: e4c94ec420ef8e67cd4fdbabf188dc79a08930b53461c151cb00a203fa680604f3e11f4e3926feb87eecb9ee70b35d3abae32d64cde1eb55d8d52d11aa116de3
+  metadata.gz: bc5af627007cab164c6ea82c4628904b4819b6b55a08d1ac49723a9b5e1b895ac199e287b76535a67a5d78800188e697870d0a5fd3f01b521f43c7444c06749f
+  data.tar.gz: 568c21dd446843dfa6753713599b9bfd973a885b5f09fc1292cd2b3756e493bfdfa6add069f97889f648d7e103362adf0b60d6d7ef9153d5c304f05a4ae7af45

data/README.md

@@ -43,6 +43,7 @@ default configuration is as follows:
       bibliography_template: "{{reference}}"
 
       replace_strings: true
+      join_strings:    true
 
       details_dir:    bibliography
       details_layout: bibtex.html
@@ -260,13 +261,13 @@ You can cite multiple items in a single citation by referencing all ids
 of the items you wish to quote separated by spaces. For example,
 `{% cite ruby microscope %}` would produce a cite tag like:
 
-    <a href="#ruby">(Flanagan, D. &amp; Matsumoto, Y. 2008; Shaughnessy, P. 2013)</a>
+    <a href="#ruby">(Flanagan &amp; Matsumoto 2008; Shaughnessy 2013)</a>
 
 #### Page numbers and locators
 
 If you would like to add page numbers to your citation, you can use the
 `-l` or `--locator` option. For example, `{% cite ruby -l 23-5 %}` would
-produce a citation like `(Matsumoto, Y., 2008, pp. 23-5)`.
+produce a citation like `(Matsumoto, 2008, pp. 23-5)`.
 
 When quoting multiple items (see above) you can add multiple locators after
 the list of ids. For example, `{% cite ruby microscope -l 2 -l 24 & 32 %}`.
@@ -462,7 +463,7 @@ License
 
 Jekyll-Scholar is distributed under the same license as Jekyll.
 
-Copyright (c) 2011-2013 [Sylvester Keil](http://sylvester.keil.or.at/)
+Copyright (c) 2011-2014 [Sylvester Keil](http://sylvester.keil.or.at/)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the 'Software'), to deal

data/features/string.feature

@@ -0,0 +1,114 @@
+Feature: String replacement
+  As a scholar who likes to blog
+  I want to publish my BibTeX bibliography on my blog
+  And make sure that strings are correctly substituted
+
+  @tags @string
+  Scenario: String replacement
+    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":
+      """
+      @string{ rubypl = "The Ruby Programming Language" }
+      @book{ruby,
+        title     = rubypl,
+        author    = {Flanagan, David and Matsumoto, Yukihiro},
+        year      = {2008},
+        publisher = {O'Reilly Media}
+      }
+      """
+    And I have a page "scholar.html":
+      """
+      ---
+      ---
+      {% bibliography -f references %}
+      """
+    When I run jekyll
+    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"
+
+  @tags @string
+  Scenario: String replacement disabled
+    Given I have a scholar configuration with:
+      | key             | value             |
+      | source          | ./_bibliography   |
+      | replace_strings | false             |
+    And I have a "_bibliography" directory
+    And I have a file "_bibliography/references.bib":
+      """
+      @string{ rubypl = "The Ruby Programming Language" }
+      @book{ruby,
+        title     = rubypl,
+        author    = {Flanagan, David and Matsumoto, Yukihiro},
+        year      = {2008},
+        publisher = {O'Reilly Media}
+      }
+      """
+    And I have a page "scholar.html":
+      """
+      ---
+      ---
+      {% bibliography -f references %}
+      """
+    When I run jekyll
+    Then the _site directory should exist
+    And the "_site/scholar.html" file should exist
+    And I should see "<i>rubypl</i>" in "_site/scholar.html"
+
+  @tags @string
+  Scenario: Join strings
+    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":
+      """
+      @string{ ruby = "Ruby" }
+      @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":
+      """
+      ---
+      ---
+      {% bibliography -f references %}
+      """
+    When I run jekyll
+    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"
+
+  @tags @string
+  Scenario: Join strings disabled
+    Given I have a scholar configuration with:
+      | key          | value             |
+      | source       | ./_bibliography   |
+      | join_strings | false             |
+    And I have a "_bibliography" directory
+    And I have a file "_bibliography/references.bib":
+      """
+      @string{ ruby = "Ruby" }
+      @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":
+      """
+      ---
+      ---
+      {% bibliography -f references %}
+      """
+    When I run jekyll
+    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"

data/lib/jekyll/scholar/defaults.rb

@@ -15,6 +15,7 @@ module Jekyll
       'bibtex_filters'        => [ :latex ],
 
       'replace_strings'       => true,
+      'join_strings'          => true,
 
       'details_dir'           => 'bibliography',
       'details_layout'        => 'bibtex.html',

data/lib/jekyll/scholar/utilities.rb

@@ -109,6 +109,7 @@ module Jekyll
             bibtex_options
           )
           @bibliography.replace_strings if replace_strings?
+          @bibliography.join if join_strings? && replace_strings?
         end
 
         @bibliography
@@ -149,6 +150,10 @@ module Jekyll
         config['replace_strings']
       end
 
+      def join_strings?
+        config['join_strings']
+      end
+
       def cited_only?
         !!@cited
       end

data/lib/jekyll/scholar/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-scholar
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.0.1
 platform: ruby
 authors:
 - Sylvester Keil
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-13 00:00:00.000000000 Z
+date: 2014-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -96,6 +96,7 @@ files:
 - features/sorting.feature
 - features/step_definitions/jekyll_steps.rb
 - features/step_definitions/scholar_steps.rb
+- features/string.feature
 - features/support/env.rb
 - features/support/hooks.rb
 - jekyll-scholar.gemspec
@@ -147,6 +148,7 @@ test_files:
 - features/sorting.feature
 - features/step_definitions/jekyll_steps.rb
 - features/step_definitions/scholar_steps.rb
+- features/string.feature
 - features/support/env.rb
 - features/support/hooks.rb
 has_rdoc: