jekyll-scholar 1.2.4 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ffca0a664f0e309ee908f64975dc099f9ceff79b
-  data.tar.gz: 6c1a6d4cd580ccafc4e1c20d65627481d696cf2e
+  metadata.gz: 082fd7a25a1d8bec380e5311248c00a86680f5bc
+  data.tar.gz: 34123cf9d4f87b7fad1d8d2312fa727df7ba3cd2
 SHA512:
-  metadata.gz: 5025b635d86ab250602f3b98da5ad15cef4988f1ebf1660bba751980ab46b3c0e2354c9c2d9783b962be71f2d8c7f1b24c50d92e801bf9d83f87426c64d628a2
-  data.tar.gz: 3acf746063713b66b7ba3636fc89872e990a214cbb6dacce0a557656a16e755b6c085b0b060229271bf6c4e006cd9ba5eff409e45e40481134fea1889f04613b
+  metadata.gz: 41d977833e021bf6d06e42ab6eef3650c07eab7fd1ffdcdaf02595df83956a5cc238ca743f8847f65fef3082f0dec9f14efa4999832599835ca41c19c26ca21f
+  data.tar.gz: 503c8db545f09233ea25239705778d3c724dc4180c21201672e574b00c0b5b40d7563d8ce2cde705204c469811dd0437dafe437add161fdabd137bbf80071cde

data/.gitignore

@@ -1,3 +1,4 @@
 Gemfile.lock
 demo
 **/*.swp
+.bundle

data/.travis.yml

@@ -1,6 +1,7 @@
 language: ruby
 bundler_args: --without debug
 rvm:
+  - 2.1.0
   - 2.0.0
   - 1.9.3
 notifications:

data/Gemfile

@@ -12,9 +12,12 @@ group 'development' do
   gem 'redcarpet', '~> 2.2.2'
   gem 'launchy', '~> 2.1.2'
 
-  gem 'unicode_utils'  
+  gem 'unicode_utils'
 end
 
-group 'debug' do
-  gem 'debugger'
+group :debug do
+  gem 'ruby-debug', :require => false, :platform => :jruby
+  gem 'debugger', '~>1.6', :require => false, :platform => :mri
+  gem 'rubinius-compiler', '~>2.0', :require => false, :platform => :rbx
+  gem 'rubinius-debugger', '~>2.0', :require => false, :platform => :rbx
 end

data/README.md

@@ -39,7 +39,7 @@ default configuration is as follows:
 
       source: ./_bibliography
       bibliography: references.bib
-      bibliography_template: "%{reference}"
+      bibliography_template: "{{reference}}"
 
       replace_strings: true
 
@@ -60,7 +60,8 @@ your references (this typically applies to localized terms, e.g., 'Eds.' for
 editors in English).
 
 The `source` option indicates where your bibliographies are stored;
-`bibliography` is the name of your default bibliography.
+`bibliography` is the name of your default bibliography. For best results,
+please ensure that your Bibliography is encoded as ASCII or UTF-8.
 
 
 ### Bibliographies
@@ -151,19 +152,46 @@ each reference is wrapped in an HTML tag (`span` by default but you can
 change this using the `reference_tagname` setting) with the cite key
 as id. The reference string itself is governed by the rules in your
 CSL style but you can also customize the main template a little bit.
-By default, the template is `%{reference}` – this renders only the
-reference tag. The template uses Ruby string interpolation and, in
+By default, the template is `{{reference}}` – this renders only the
+reference tag. The template uses Liquid to render and, in
 addition to the reference, exposes the cite-key (as `key`), the
-entry's `type` and the `index` in the bibliography. Thus, you could
+entry's `type`, the `index` in the bibliography, and the link to
+file repository as `link`. Thus, you could
 customize the template in your configuration as follows:
 
     scholar:
-      bibliography_template: <abbr>[%{key}]</abbr>%{reference}
+      bibliography_template: <abbr>[{{key}}]</abbr>{{reference}}
 
 This would be processed into something like:
 
     <li><abbr>[ruby]</abbr><span id="ruby">Matsumoto, Y. (2008). <i>The Ruby Programming Language</i>. O&#8217;Reilly Media.</span></li>
 
+If you have more complex requirements, it quickly becomes tedious to
+have the template inside the configuration; for this reason, you can
+also put the bibliography template into your layouts directory. Jekyll-Scholar
+will load this template if the option set in your configuration matches
+an existing layout (without the file extension). That is to say, if you set:
+
+    scholar:
+      bibliography_template: bib
+
+And there is a file `_layouts/bib.html` (or with another extension) the
+contents of this file will be used as the template. Please note that it is
+important for this file to contain the YAML front matter! For example, this
+would be a more complex template file:
+
+    ---
+    ---
+    {{ reference }}
+
+    {% if entry.abstract %}
+    <p>{{ entry.abstract %}</p>
+    {% endif %}
+
+    <pre>{{ entry.bibtex %}</pre>
+
+You can also override the default bibliography template, by passing the
+`--template` or `-T` option parameter to the bibliography tag.
 
 ### Citations
 
@@ -305,6 +333,16 @@ section, although both posts will be rendered into a single HTML
 document.
 
 
+### File Repositories
+
+File repository support was added to Jekyll-Scholar starting at version
+4.0. Currently, if you have a folder in your site that contains PDF or
+Postscript files of your papers, you can use the configuration option
+`repository` to indicate this directory. When generating bibliographies,
+Jekyll-Scholar will look in that folder to see if it contains a filename
+matching each entry's BibTeX key: if it does, the path to that file
+will be exposed to the bibliography template.
+
 ### Detail Pages
 
 If your layouts directory contains a layout file for bibliography details

data/features/bibtex.feature

@@ -35,7 +35,7 @@ Feature: BibTeX
       ---
       References
       ==========
-      
+
       @book{ruby,
         title     = {The Ruby Programming Language},
         author    = {Flanagan, David and Matsumoto, Yukihiro},
@@ -93,9 +93,9 @@ Feature: BibTeX
   @tags @bibliography @config
   Scenario: Simple Bibliography With Custom Template
     Given I have a scholar configuration with:
-      | key                   | value                                      |
-      | source                | ./_bibliography                            |
-      | bibliography_template | <abbr>%{index} [%{key}]</abbr>%{reference} |
+      | key                   | value                                         |
+      | source                | ./_bibliography                               |
+      | bibliography_template | <abbr>{{index}} [{{key}}]</abbr>{{reference}} |
     And I have a "_bibliography" directory
     And I have a file "_bibliography/references.bib":
       """

data/features/details.feature

@@ -1,8 +1,8 @@
-Feature: BibTeX
+Feature: Details
   As a scholar who likes to blog
   I want to publish my BibTeX bibliography on my blog
   And I want Jekyll to generate detail pages for all the entries in my bibliography
-  
+
   @generators
   Scenario: A bibliography with a single entry
     Given I have a scholar configuration with:

data/features/repository.feature

@@ -0,0 +1,48 @@
+Feature: PDF Repository
+  As a scholar who likes to blog
+  I want to publish my BibTeX bibliography on my blog
+  And I want Jekyll to generate links to PDFs of my references automatically
+
+  @repository
+  Scenario: A bibliography with a single entry and a repository
+    Given I have a scholar configuration with:
+      | key                   | value             |
+      | source                | ./_bibliography   |
+      | repository            | papers            |
+      | bibliography_template | 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}
+      }
+      """
+    And I have a "papers" directory
+    And I have a file "papers/ruby.pdf":
+      """
+      The PDF
+      """
+    And I have a "_layouts" directory
+    And I have a file "_layouts/bibliography.html":
+      """
+      ---
+      ---
+      {{ reference }} Link: {{ link }}
+      """
+    And I have a page "scholar.html":
+      """
+      ---
+      ---
+      {% bibliography %}
+      """
+    When I run jekyll
+    Then the _site directory should exist
+    And the "_site/papers/ruby.pdf" file should exist
+    And I should see "The Ruby Programming Language" in "_site/scholar.html"
+    And I should see "Link: /papers/ruby.pdf" in "_site/scholar.html"
+
+
+

data/jekyll-scholar.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |s|
     formats your BibTeX bibliographies for the web using CSL citation styles
     and generally gives your blog posts citation super-powers.'
   }.gsub(/\s+/, ' ')
-  
+
   s.date        = Time.now
 
   s.required_rubygems_version = '>= 1.3.6'
@@ -33,7 +33,7 @@ Gem::Specification.new do |s|
   s.test_files   = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables  = []
   s.require_path = 'lib'
-  
+
 end
 
 # vim: syntax=ruby

data/lib/jekyll/scholar/defaults.rb

@@ -9,6 +9,7 @@ module Jekyll
 
       'source'                => './_bibliography',
       'bibliography'          => 'references.bib',
+      'repository'            => nil,
 
       'bibtex_options'        => { :strip => false },
       'bibtex_filters'        => [ :latex ],
@@ -20,7 +21,7 @@ module Jekyll
       'details_link'          => 'Details',
 
       'bibliography_class'    => 'bibliography',
-      'bibliography_template' => '%{reference}',
+      'bibliography_template' => '{{reference}}',
 
       'reference_tagname'     => 'span',
       'missing_reference'     => '(missing reference)',

data/lib/jekyll/scholar/generators/details.rb

@@ -14,31 +14,14 @@ module Jekyll
         process(@name)
         read_yaml(File.join(base, '_layouts'), config['details_layout'])
 
-        liquidify(entry)
-      end
-
-      private
-
-      def liquidify(entry)
-        data['entry'] = {}
-
-        data['entry']['key'] = entry.key
-        data['entry']['type'] = entry.type
-
-        data['entry']['bibtex'] = entry.to_s
-
-        entry.fields.each do |key, value|
-          value = value.convert(*bibtex_filters) unless bibtex_filters.empty?
-          data['entry'][key.to_s] = value.to_s
-        end
-
+        data['entry'] = liquidify(entry)
       end
 
     end
 
     class DetailsGenerator < Generator
       include Scholar::Utilities
-      
+
       safe true
       priority :high
 
@@ -63,4 +46,4 @@ module Jekyll
 
 
   end
-end
+end

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

@@ -20,7 +20,7 @@ module Jekyll
         if cited_only?
           references = cited_references.uniq.map do |key|
             references.detect { |e| e.key == key }
-          end          
+          end
         end
 
         bibliography = references.each_with_index.map { |entry, index|

data/lib/jekyll/scholar/utilities.rb

@@ -35,10 +35,14 @@ module Jekyll
 
           opts.on('-s', '--style STYLE') do |style|
             @style = style
-          end 
+          end
+
+          opts.on('-T', '--template TEMPLATE') do |template|
+            @bibliography_template = template
+          end
         end
 
-        argv = arguments.split(/(\B-[cfqpts]|\B--(?:cited|file|query|prefix|text|style|))/)
+        argv = arguments.split(/(\B-[cfqptTs]|\B--(?:cited|file|query|prefix|text|style|template|))/)
 
         parser.parse argv.map(&:strip).reject(&:empty?)
       end
@@ -75,6 +79,26 @@ module Jekyll
         b
       end
 
+      def repository?
+        !config['repository'].nil? && !config['repository'].empty?
+      end
+
+      def repository
+        @repository ||= load_repository
+      end
+
+      def load_repository
+        return {} unless repository?
+
+        Hash[Dir[File.join(repository_path, '**/*.{pdf,ps}')].map { |path|
+          [File.basename(path).sub(/\.(pdf|ps)$/, ''), path]
+        }]
+      end
+
+      def repository_path
+        config['repository']
+      end
+
       def replace_strings?
         config['replace_strings']
       end
@@ -120,18 +144,57 @@ module Jekyll
       end
 
       def bibliography_template
-        config['bibliography_template'] || '%{reference}'
+        @bibliography_template || config['bibliography_template']
+      end
+
+      def liquid_template
+        return @liquid_template if @liquid_template
+
+        tmp = bibliography_template
+
+        case
+        when tmp.nil?, tmp.empty?
+          tmp = '{{reference}}'
+        when site.layouts.key?(tmp)
+          tmp = site.layouts[tmp].content
+        end
+
+        @liquid_template = Liquid::Template.parse(tmp)
       end
 
       def bibliography_tag(entry, index)
         return missing_reference unless entry
 
-        bibliography_template % {
-          :reference => reference_tag(entry),
-          :key => entry.key,
-          :type => entry.type,
-          :index => index
-        }
+        liquid_template.render({
+          'entry' => liquidify(entry),
+          'reference' => reference_tag(entry),
+          'key' => entry.key,
+          'type' => entry.type,
+          'link' => repository_link_for(entry),
+          'index' => index
+        })
+      end
+
+      def liquidify(entry)
+        e = {}
+
+        e['key'] = entry.key
+        e['type'] = entry.type
+
+        if entry.field?(:abstract)
+          tmp = entry.dup
+          tmp.delete :abstract
+          e['bibtex'] = tmp.to_s
+        else
+          e['bibtex'] = entry.to_s
+        end
+
+        entry.fields.each do |key, value|
+          value = value.convert(*bibtex_filters) unless bibtex_filters.empty?
+          e[key.to_s] = value.to_s
+        end
+
+        e
       end
 
       def generate_details?
@@ -146,6 +209,13 @@ module Jekyll
         [name, 'html'].join('.')
       end
 
+      def repository_link_for(entry, base = base_url)
+        url = repository[entry.key]
+        return unless url
+
+        File.join(base, url)
+      end
+
       def details_link_for(entry, base = base_url)
         File.join(base, details_path, details_file_for(entry))
       end

data/lib/jekyll/scholar/version.rb

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

metadata

@@ -1,68 +1,68 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-scholar
 version: !ruby/object:Gem::Version
-  version: 1.2.4
+  version: 2.0.0
 platform: ruby
 authors:
 - Sylvester Keil
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-07 00:00:00.000000000 Z
+date: 2014-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
   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: citeproc-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.0.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.0.6
 - !ruby/object:Gem::Dependency
   name: bibtex-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.3'
-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:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
@@ -74,6 +74,7 @@ files:
 - features/details.feature
 - features/filter.feature
 - features/reference.feature
+- features/repository.feature
 - features/sorting.feature
 - features/step_definitions/jekyll_steps.rb
 - features/step_definitions/scholar_steps.rb
@@ -100,17 +101,17 @@ 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: []
 rubyforge_project: jekyll-scholar
-rubygems_version: 2.0.14
+rubygems_version: 2.2.1
 signing_key: 
 specification_version: 4
 summary: Jekyll extensions for the academic blogger.
@@ -121,6 +122,7 @@ test_files:
 - features/details.feature
 - features/filter.feature
 - features/reference.feature
+- features/repository.feature
 - features/sorting.feature
 - features/step_definitions/jekyll_steps.rb
 - features/step_definitions/scholar_steps.rb