jekyll-scholar 0.1.0 → 0.2.0

data/README.md

@@ -177,6 +177,32 @@ For example, this could be rendered as:
       </cite>
     </blockquote>
 
+#### Displaying formatted references
+
+If you want to display the full formatted reference entry, you can use the
+`reference` tag. For example, given the following Bibtex entry,
+
+    @book{ruby,
+      title     = {The Ruby Programming Language},
+      author    = {Flanagan, David and Matsumoto, Yukihiro},
+      year      = {2008},
+      publisher = {O'Reilly Media}
+    }
+
+using `{% reference ruby %}` anywhere in your page, it will print
+"Flanagan, D., & Matsumoto, Y. (2008). *The Ruby Programming Language.*.
+O'Reilly Media" (the exact result depends on your formatting style).
+
+The `reference` tag accepts a second optional argument that specifies the
+absolute path of the BibTeX file to use as input. Using it, you can override
+the file from which the bib entries are read. This can be handy if you
+want to use a special BibTeX file as input for a specific page. As an example,
+the tag
+
+    {% reference ruby, /home/foo/bar.bib %}
+
+will attempt to read the key `ruby` from file `/home/foo/bar.bib`. It will not
+fallback to the default BibTeX file.
 
 ### Detail Pages
 
@@ -253,7 +279,6 @@ If you've found a bug or have a question, please open an issue on the
 Or, for extra credit, clone the Jekyll-Scholar repository, write a failing
 example, fix the bug and submit a pull request.
 
-
 License
 -------
 

data/features/reference.feature

@@ -0,0 +1,57 @@
+Feature: Formatted References
+  As a scholar who likes to blog
+  I want to reference cool papers and books from my bibliography
+
+  @tags @referebce
+  Scenario: A Simple Reference
+    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":
+      """
+      ---
+      ---
+      {% reference ruby %}
+      """
+    When I run jekyll
+    Then the _site directory should exist
+    And the "_site/scholar.html" file should exist
+    And I should see "Matsumoto, Y. \(2008\). <i>The Ruby" in "_site/scholar.html"
+
+  @tags @reference
+  Scenario: Missing references
+    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":
+      """
+      ---
+      ---
+      {% reference java %}
+      """
+    When I run jekyll
+    Then the _site directory should exist
+    And the "_site/scholar.html" file should exist
+    And I should see "missing reference" in "_site/scholar.html"

data/lib/jekyll/scholar.rb

@@ -13,4 +13,5 @@ require 'jekyll/scholar/tags/bibliography'
 require 'jekyll/scholar/tags/cite'
 require 'jekyll/scholar/tags/cite_details'
 require 'jekyll/scholar/tags/quote'
+require 'jekyll/scholar/tags/reference'
 require 'jekyll/scholar/generators/details'

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

@@ -0,0 +1,43 @@
+module Jekyll
+  class Scholar
+
+    class ReferenceTag < Liquid::Tag
+      include Scholar::Utilities
+
+      attr_reader :key, :file
+
+      def initialize(tag_name, arguments, tokens)
+        super
+
+        @config = Scholar.defaults.dup
+        @key, @file = arguments.strip.split(/\s*,\s*/, 2)
+      end
+
+      def render(context)
+        set_context_to context
+        bib = unless file.nil?
+                BibTeX.open(file, { :filter => :latex })
+              else
+                set_context_to context
+                bibliography
+              end
+
+        entry = bib[key]
+
+        if bib.key?(key)
+          CiteProc.process entry.to_citeproc,
+                           :style => config['style'],
+                           :locale => config['locale'],
+                           :format => 'html'
+        else
+          "(missing reference)"
+        end
+      rescue
+        "(#{key})"
+      end
+    end
+
+  end
+end
+
+Liquid::Template.register_tag('reference', Jekyll::Scholar::ReferenceTag)

data/lib/jekyll/scholar/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-scholar
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-04 00:00:00.000000000 Z
+date: 2012-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
-  requirement: &70230385479620 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,15 @@ dependencies:
         version: '0.10'
   type: :runtime
   prerelease: false
-  version_requirements: *70230385479620
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.10'
 - !ruby/object:Gem::Dependency
   name: citeproc-ruby
-  requirement: &70230385479100 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +37,15 @@ dependencies:
         version: 0.0.6
   type: :runtime
   prerelease: false
-  version_requirements: *70230385479100
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.6
 - !ruby/object:Gem::Dependency
   name: bibtex-ruby
-  requirement: &70230385478620 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +53,15 @@ dependencies:
         version: 2.0.7
   type: :runtime
   prerelease: false
-  version_requirements: *70230385478620
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.7
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70230385478160 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +69,15 @@ dependencies:
         version: '0.9'
   type: :development
   prerelease: false
-  version_requirements: *70230385478160
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &70230385477680 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +85,15 @@ dependencies:
         version: '3.11'
   type: :development
   prerelease: false
-  version_requirements: *70230385477680
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.11'
 - !ruby/object:Gem::Dependency
   name: redgreen
-  requirement: &70230385477180 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +101,15 @@ dependencies:
         version: '1.2'
   type: :development
   prerelease: false
-  version_requirements: *70230385477180
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &70230385476700 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -87,10 +117,15 @@ dependencies:
         version: '2.11'
   type: :development
   prerelease: false
-  version_requirements: *70230385476700
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
 - !ruby/object:Gem::Dependency
   name: rr
-  requirement: &70230385476240 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -98,21 +133,31 @@ dependencies:
         version: '1.0'
   type: :development
   prerelease: false
-  version_requirements: *70230385476240
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: cucumber
-  requirement: &70230385475780 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - =
+    - - '='
       - !ruby/object:Gem::Version
         version: '1.1'
   type: :development
   prerelease: false
-  version_requirements: *70230385475780
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: RedCloth
-  requirement: &70230385475320 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -120,10 +165,15 @@ dependencies:
         version: '4.2'
   type: :development
   prerelease: false
-  version_requirements: *70230385475320
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.2'
 - !ruby/object:Gem::Dependency
   name: rdiscount
-  requirement: &70230385495740 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -131,10 +181,15 @@ dependencies:
         version: '1.6'
   type: :development
   prerelease: false
-  version_requirements: *70230385495740
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: redcarpet
-  requirement: &70230385495240 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -142,7 +197,12 @@ dependencies:
         version: '1.9'
   type: :development
   prerelease: false
-  version_requirements: *70230385495240
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.9'
 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
@@ -161,6 +221,7 @@ files:
 - features/cite_details.feature
 - features/details.feature
 - features/filter.feature
+- features/reference.feature
 - features/sorting.feature
 - features/step_definitions/jekyll_steps.rb
 - features/step_definitions/scholar_steps.rb
@@ -174,6 +235,7 @@ files:
 - lib/jekyll/scholar/tags/cite.rb
 - lib/jekyll/scholar/tags/cite_details.rb
 - lib/jekyll/scholar/tags/quote.rb
+- lib/jekyll/scholar/tags/reference.rb
 - lib/jekyll/scholar/utilities.rb
 - lib/jekyll/scholar/version.rb
 homepage: http://github.com/inukshuk/jekyll-scholar
@@ -196,7 +258,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: jekyll-scholar
-rubygems_version: 1.8.10
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Jekyll extensions for the academic blogger.
@@ -206,6 +268,7 @@ test_files:
 - features/cite_details.feature
 - features/details.feature
 - features/filter.feature
+- features/reference.feature
 - features/sorting.feature
 - features/step_definitions/jekyll_steps.rb
 - features/step_definitions/scholar_steps.rb