jekyll-scholar 1.0.0 → 1.1.0

data/features/filter.feature

@@ -4,36 +4,36 @@ Feature: BibTeX
   In order to have control over the references that go up on my website
 
   @tags @filters
-	Scenario: Filter by Year
+  Scenario: Filter by Year
     Given I have a scholar configuration with:
-  	  | key    | value             |
-  	  | source | ./_bibliography   |
-		  | query  | "@*[year=2009]"   |
-		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{pickaxe,
-			  title     = {Programming Ruby 1.9: The Pragmatic Programmer's Guide},
-			  author    = {Thomas, Dave and Fowler, Chad and Hunt, Andy},
-			  year      = {2009},
-			  edition   = 3,
-			  publisher = {Pragmatic Bookshelf}
-			}
-			"""
-	  And I have a page "scholar.html":
-			"""
-			---
-			---
-			{% bibliography %}
-			"""
-	  When I run jekyll
-	  Then the _site directory should exist
-		And the "_site/scholar.html" file should exist
-	  And I should see "Programming Ruby" in "_site/scholar.html"
-	  And I should not see "The Ruby Programming Language" in "_site/scholar.html"
+      | key    | value             |
+      | source | ./_bibliography   |
+      | query  | "@*[year=2009]"   |
+    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{pickaxe,
+        title     = {Programming Ruby 1.9: The Pragmatic Programmer's Guide},
+        author    = {Thomas, Dave and Fowler, Chad and Hunt, Andy},
+        year      = {2009},
+        edition   = 3,
+        publisher = {Pragmatic Bookshelf}
+      }
+      """
+    And I have a page "scholar.html":
+      """
+      ---
+      ---
+      {% bibliography %}
+      """
+    When I run jekyll
+    Then the _site directory should exist
+    And the "_site/scholar.html" file should exist
+    And I should see "Programming Ruby" in "_site/scholar.html"
+    And I should not see "The Ruby Programming Language" in "_site/scholar.html"

data/features/reference.feature

@@ -29,7 +29,7 @@ Feature: Formatted References
     And the "_site/scholar.html" file should exist
     And I should see "Matsumoto, Y. \(2008\). <i>The Ruby" in "_site/scholar.html"
 
-  @tags @reference
+  @tags @reference @missing
   Scenario: Missing references
     Given I have a scholar configuration with:
       | key          | value             |
@@ -54,4 +54,33 @@ Feature: Formatted References
     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"
+    And I should see "(missing reference)" in "_site/scholar.html"
+
+  @tags @reference @missing
+  Scenario: Missing references with a custom text
+    Given I have a scholar configuration with:
+      | key                | value             |
+      | source             | ./_bibliography   |
+      | bibliography       | my_references     |
+      | missing_reference  | not found!        |
+    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 "not found!" in "_site/scholar.html"
+    And I should not see "(missing reference)" in "_site/scholar.html"

data/features/sorting.feature

@@ -3,67 +3,67 @@ Feature: Sorting BibTeX Bibliographies
   I want to sort my bibliographies according to configurable parameters
 
   @tags @sorting
-	Scenario: Sort By Year
+  Scenario: Sort By Year
     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     = {The Ruby Programming Language},
-			  author    = {Flanagan, David and Matsumoto, Yukihiro},
-			  year      = {2007},
-			  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
+      | 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     = {The Ruby Programming Language},
+        author    = {Flanagan, David and Matsumoto, Yukihiro},
+        year      = {2007},
+        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
     Then "2007" should come before "2008" in "_site/scholar.html"
 
   @tags @sorting
-	Scenario: Reverse Sort Order
+  Scenario: Reverse Sort Order
     Given I have a scholar configuration with:
-  	  | key     | value             |
-  	  | sort_by | year              |
-  	  | order   | descending        |
-		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     = {The Ruby Programming Language},
-			  author    = {Flanagan, David and Matsumoto, Yukihiro},
-			  year      = {2007},
-			  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
+      | key     | value             |
+      | sort_by | year              |
+      | order   | descending        |
+    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     = {The Ruby Programming Language},
+        author    = {Flanagan, David and Matsumoto, Yukihiro},
+        year      = {2007},
+        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
     Then "2008" should come before "2007" in "_site/scholar.html"
 

data/features/support/env.rb

@@ -3,7 +3,11 @@ require 'test/unit'
 
 require 'jekyll/scholar'
 
-require 'debugger'
+begin
+  require 'debugger'
+rescue LoadError
+  # ignore
+end
 
 
 World do

data/jekyll-scholar.gemspec

@@ -26,17 +26,7 @@ Gem::Specification.new do |s|
 
   s.add_runtime_dependency('jekyll', '~> 0.10')
   s.add_runtime_dependency('citeproc-ruby', '~> 0.0.6')
-  s.add_runtime_dependency('bibtex-ruby', '~> 2.2')
-
-  s.add_development_dependency('rake', "~> 0.9")
-  s.add_development_dependency('rdoc', "~> 3.11")
-  s.add_development_dependency('redgreen', "~> 1.2")
-  s.add_development_dependency('shoulda', "~> 2.11")
-  s.add_development_dependency('rr', "~> 1.0")
-  s.add_development_dependency('cucumber', "1.1")
-  s.add_development_dependency('RedCloth', "~> 4.2")
-  s.add_development_dependency('rdiscount', "~> 1.6")
-  s.add_development_dependency('redcarpet', "~> 1.9")  
+  s.add_runtime_dependency('bibtex-ruby', '~> 2.3')
 
   s.files        = `git ls-files`.split("\n")
   s.test_files   = `git ls-files -- {test,spec,features}/*`.split("\n")

data/lib/jekyll/scholar/defaults.rb

@@ -1,26 +1,33 @@
 module Jekyll
   class Scholar
-    @defaults = Hash[*%w{
+    @defaults = {
+      'style'                 => 'apa',
+      'locale'                => 'en',
 
-      style        apa
-      locale       en
+      'sort_by'               => 'none',
+      'order'                 => 'ascending',
 
-      sort_by      none
-      order        ascending
+      'source'                => './_bibliography',
+      'bibliography'          => 'references.bib',
 
-      source       ./_bibliography
-      bibliography references.bib
+      'bibtex_options'        => { :strip => false },
+      'bibtex_filters'        => [ :latex ],
 
-      details_dir    bibliography
-      details_layout bibtex.html
-      details_link   Details
-      
-      bibliography_class bibliography
-      details_link_class details
+      'details_dir'           => 'bibliography',
+      'details_layout'        => 'bibtex.html',
+      'details_link'          => 'Details',
 
-    	query  @*
-	
-    }].freeze
+      'bibliography_class'    => 'bibliography',
+      'bibliography_template' => '%{reference}',
+
+      'reference_tagname'     => 'span',
+      'missing_reference'     => '(missing reference)',
+
+      'details_link_class'    => 'details',
+
+    	'query'                 => '@*'
+
+    }.freeze
 
     class << self
       attr_reader :defaults

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

@@ -25,11 +25,13 @@ module Jekyll
         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']['bibtex'] = entry.to_s
       end
 
     end

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

@@ -23,8 +23,8 @@ module Jekyll
           end          
         end
 
-        references.map! do |entry|
-          reference = reference_tag entry
+        bibliography = references.map.with_index { |entry, index|
+          reference = bibliography_tag(entry, index + 1)
 
           if generate_details?
             reference << link_to(details_link_for(entry),
@@ -32,9 +32,9 @@ module Jekyll
           end
 
           content_tag :li, reference
-        end
+        }.join("\n")
 
-        content_tag :ol, references.join("\n"), :class => config['bibliography_class']
+        content_tag :ol, bibliography, :class => config['bibliography_class']
       end
     end
 

data/lib/jekyll/scholar/utilities.rb

@@ -40,7 +40,11 @@ module Jekyll
       end
 
       def bibtex_options
-        @bibtex_options ||= { :filter => :latex }
+        config['bibtex_options'] ||= {}
+      end
+
+      def bibtex_filters
+        config['bibtex_filters'] ||= []
       end
 
       def bibtex_path
@@ -80,12 +84,37 @@ module Jekyll
       end
 
       def reference_tag(entry)
-        return '(missing reference)' unless entry
+        return missing_reference unless entry
 
+        entry = entry.convert(*bibtex_filters) unless bibtex_filters.empty?
         reference = CiteProc.process entry.to_citeproc,
           :style => config['style'], :locale => config['locale'], :format => 'html'
 
-        content_tag :span, reference, :id => [prefix, entry.key].compact.join('-')
+        content_tag reference_tagname, reference,
+          :id => [prefix, entry.key].compact.join('-')
+      end
+
+      def missing_reference
+        config['missing_reference']
+      end
+
+      def reference_tagname
+        config['reference_tagname'] || :span
+      end
+
+      def bibliography_template
+        config['bibliography_template'] || '%{reference}'
+      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
+        }
       end
 
       def generate_details?
@@ -113,18 +142,19 @@ module Jekyll
       end
 
       def cite(key)
-        entry = bibliography[key]
-
         context['cited'] ||= []
         context['cited'] << key
 
         if bibliography.key?(key)
+          entry = bibliography[key]
+          entry = entry.convert(*bibtex_filters) unless bibtex_filters.empty?
+
           citation = CiteProc.process entry.to_citeproc, :style => config['style'],
             :locale => config['locale'], :format => 'html', :mode => :citation
 
           link_to "##{[prefix, entry.key].compact.join('-')}", citation.join
         else
-          '(missing reference)'
+          missing_reference
         end
       rescue
         "(#{key})"
@@ -134,7 +164,7 @@ module Jekyll
         if bibliography.key?(key)
           link_to details_link_for(bibliography[key]), text || config['details_link']
         else
-          '(missing reference)'
+          missing_reference
         end
       end
 

data/lib/jekyll/scholar/version.rb

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