jekyll-scholar 0.0.4 → 0.0.5

data/README.md

@@ -35,9 +35,11 @@ default configuration is as follows:
       source: ./_bibliography
       bibliography: references.bib
       
-      details_dir    ./bibliography
-      details_layout bibtex.html
+      details_dir:    bibliography
+      details_layout: bibtex.html
+      details_link:   Details
       
+    	query: "@*"  
 
 You can use any style that ships with
 [CiteProc-Ruby](https://github.com/inukshuk/citeproc-ruby) by name (e.g.,
@@ -180,6 +182,25 @@ of your BibTeX entry. Here is an example of a details page layout:
     </body>
     </html>
 
+When Jekyll-Scholar generates detail pages, it also adds links to each
+entry's detail page to the generated bibliography. You can alter the
+name of the link via the 'details_link' configuration option.
+
+
+### Bibliography Filters
+
+By default, Jekyll-Scholar includes all entries in you main BibTeX file
+when generating bibliographies. If you want to include only those entries
+matching certain criteria, you can do so by adjusting the 'query'
+configuration option. For example:
+
+    query: "@book" #=> includes only books
+    query: "@article[year>=2003]" #=> includes only articles published 2003 or later
+    query: "@*[url]" #=> includes all entries with a url field
+    query: "@*[status!=review]" #=> includes all entries whose status field is not set to 'review' 
+
+Please note that some of these queries require bibtex-ruby 2.0.7 or
+later versions.
 
 Contributing
 ------------

data/features/details.feature

@@ -34,4 +34,4 @@ Feature: BibTeX
 	  When I run jekyll
 	  Then the _site directory should exist
 		And the "_site/bibliography/ruby.html" file should exist
-	  And I should see "<i>The Ruby Programming Language</i>" in "_site/bibliography/ruby.html"
+	  And I should see "The Ruby Programming Language" in "_site/bibliography/ruby.html"

data/features/filter.feature

@@ -0,0 +1,39 @@
+Feature: BibTeX
+  As a scholar who likes to blog
+  I want to apply filters to my BibTeX bibliography
+  In order to have control over the references that go up on my website
+
+  @tags @filters
+	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"

data/features/step_definitions/jekyll_steps.rb

@@ -54,9 +54,15 @@ Then /^the (.*) directory should exist$/ do |dir|
 end
 
 Then /^I should see "(.*)" in "(.*)"$/ do |text, file|
+  puts File.open(file).readlines.join
   assert_match Regexp.new(text), File.open(file).readlines.join
 end
 
+Then /^I should not see "(.*)" in "(.*)"$/ do |text, file|
+  assert !File.open(file).readlines.join.match(Regexp.new(text))
+end
+
+
 Then /^the "(.*)" file should exist$/ do |file|
   assert File.file?(file)
 end

data/lib/jekyll/scholar.rb

@@ -5,33 +5,10 @@ require 'bibtex'
 require 'citeproc'
 
 require 'jekyll/scholar/version'
+require 'jekyll/scholar/defaults'
+require 'jekyll/scholar/utilities'
+
 require 'jekyll/scholar/converters/bibtex'
 require 'jekyll/scholar/tags/bibliography'
 require 'jekyll/scholar/tags/cite'
 require 'jekyll/scholar/generators/details'
-
-module Jekyll
-  class Scholar
-    
-    @defaults = Hash[*%w{
-	
-      style        apa
-      locale       en
-
-      sort_by      none
-      order        ascending
-
-      source       ./_bibliography
-      bibliography references.bib
-
-      details_dir    ./bibliography
-      details_layout bibtex.html
-
-    }].freeze
-    
-    class << self
-      attr_reader :defaults
-    end
-    
-  end
-end

data/lib/jekyll/scholar/converters/bibtex.rb

@@ -2,8 +2,9 @@ module Jekyll
   class Scholar
     class BibTeXConverter < Converter
       safe true
-    
       priority :highest
+
+			attr_reader :config
     
       @pattern = (/bib(tex)?$/i).freeze
       @extension = '.html'.freeze
@@ -12,10 +13,10 @@ module Jekyll
 				attr_reader :pattern, :extension
 			end
 			
-      def initialize (config = {})
+      def initialize(config = {})
         super
         @config['scholar'] = Scholar.defaults.merge(@config['scholar'] || {})
-        @markdown = MarkdownConverter.new config
+        @markdown = MarkdownConverter.new(config)
       end
     
       def matches(extension)
@@ -26,15 +27,16 @@ module Jekyll
 				BibTeXConverter.extension
 			end
     
-      def convert (content)
-        content = BibTeX.parse(content, :strict => true, :include => [:meta_content], :filter => [:latex]).map do |b|
+      def convert(content)
+				content = BibTeX.parse(content, :strict => true, :include => [:meta_content], :filter => [:latex]).map do |b|
           if b.respond_to?(:to_citeproc)
-            CiteProc.process b.to_citeproc, :style => @config['style'],
-              :locale => @config['locale'], :format => 'html'
+            CiteProc.process b.to_citeproc, :style => config['style'],
+              :locale => config['locale'], :format => 'html'
           else
               b.is_a?(BibTeX::MetaContent) ? b.to_s : ''
           end
         end
+
         @markdown.convert(content.join("\n"))
       end
     

data/lib/jekyll/scholar/defaults.rb

@@ -0,0 +1,26 @@
+module Jekyll
+  class Scholar
+    @defaults = Hash[*%w{
+
+      style        apa
+      locale       en
+
+      sort_by      none
+      order        ascending
+
+      source       ./_bibliography
+      bibliography references.bib
+
+      details_dir    bibliography
+      details_layout bibtex.html
+      details_link   Details
+      
+    	query  @*
+	
+    }].freeze
+
+    class << self
+      attr_reader :defaults
+    end
+  end
+end

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

@@ -2,15 +2,14 @@ module Jekyll
   class Scholar
 
     class Details < Page
-      
-      attr_reader :config
+      include Scholar::Utilities
       
       def initialize(site, base, dir, entry)
         @site, @base, @dir = site, base, dir
 
         @config = Scholar.defaults.merge(site.config['scholar'] || {})
 
-        @name = [entry.key, 'html'].join('.')
+        @name = details_file_for(entry)
 
         process(@name)
         read_yaml(File.join(base, '_layouts'), config['details_layout'])
@@ -34,16 +33,17 @@ module Jekyll
     end
 
     class DetailsGenerator < Generator
+      include Scholar::Utilities
       safe true
 
       attr_reader :config
       
       def generate(site)
-        @config = Scholar.defaults.merge(site.config['scholar'] || {})
+        @site, @config = site, Scholar.defaults.merge(site.config['scholar'] || {})
 
-        if site.layouts.key?(File.basename(config['details_layout'], '.html'))
-          bibliography.each do |entry|
-            details = Details.new(site, site.source, config['details_dir'], entry)
+        if generate_details?
+          entries.each do |entry|
+            details = Details.new(site, site.source, details_path, entry)
             details.render(site.layouts, site.site_payload)
             details.write(site.dest)
             
@@ -53,17 +53,6 @@ module Jekyll
         end
       end
 			
-      private
-      
-      def bibliography
-        @bibliography ||= BibTeX.open(bibliography_path, :filter => :latex)
-      end          
-      
-      def bibliography_path
-        p = File.join(config['source'], config['bibliography'])
-        p << '.bib' unless File.exists?(p)
-        p
-      end      
     end
 
 

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

@@ -2,65 +2,35 @@ module Jekyll
   class Scholar
 
     class BibliographyTag < Liquid::Tag
+      include Scholar::Utilities
   
-      attr_reader :file, :config
-    
       def initialize(tag_name, arguments, tokens)
         super
 
         @config = Scholar.defaults.dup
-        @file = arguments.strip
+        @bibtex_file = arguments.strip
       end
 
       def render(context)
-        config.merge!(context.registers[:site].config['scholar'] || {})
+        @site = context.registers[:site]
+        config.merge!(site.config['scholar'] || {})
 
         references = entries.map do |e|
-          r = CiteProc.process e.to_citeproc, :style => config['style'],
+          reference = CiteProc.process e.to_citeproc, :style => config['style'],
             :locale => config['locale'], :format => 'html'
                     
-          r = "<span id='#{e.key}'>#{r}</span>"
+          reference = "<span id='#{e.key}'>#{reference}</span>"
           
-          if e.field?(:url)
-            r << "<a href='#{e.url}'>URL</a>"
-          end
-
-          if e.field?(:doi)
-            r << "<a href='#{e.doi}'>DOI</a>"
+          if generate_details?
+            reference << "<a href='#{details_link_for(e)}'>#{config['details_link']}</a>"            
           end
-          
-          "<li>#{r}</li>"
+                    
+          "<li>#{reference}</li>"
         end
-        
-        "<ol>\n#{references.join("\n")}\n</ol>"
-      end
-      
-      private
-      
-      def bibliography
-        @bibliography ||= BibTeX.open(extend_path(file), :filter => :latex)
-      end          
-      
-      def entries
-        b = bibliography['@*']
 
-        unless config['sort_by'] == 'none'
-          b.sort_by! { |e| e[config['sort_by']].to_s }
-          b.reverse! if config['order'] =~ /^(desc|reverse)/i
-        end
-        
-        b
+        "<ol>\n#{references.join("\n")}\n</ol>"
       end
       
-      def extend_path(name)
-        if name.nil? || name.empty?
-          name = config['bibliography']
-        end
-        
-        p = File.join(config['source'], name)
-        p << '.bib' unless File.exists?(p)
-        p
-      end
     end
     
   end

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

@@ -2,7 +2,8 @@ module Jekyll
   class Scholar
 
     class CiteTag < Liquid::Tag
-  
+      include Scholar::Utilities
+      
       attr_reader :key, :pages, :config
     
       def initialize(tag_name, arguments, tokens)
@@ -15,29 +16,18 @@ module Jekyll
       def render(context)
         config.merge!(context.registers[:site].config['scholar'] || {})
 
-        e = bibliography[key]
+        entry = bibliography[key]
 
-        if e
-          c = CiteProc.process e.to_citeproc, :style => config['style'],
+        if entry
+          c = CiteProc.process entry.to_citeproc, :style => config['style'],
             :locale => config['locale'], :format => 'html', :mode => :citation
           
-          "<a href='##{e.key}'>#{c}</a>"
+          "<a href='##{entry.key}'>#{c}</a>"
         else
           "(missing reference)"
         end
       end
       
-      private
-      
-      def bibliography
-        @bibliography ||= BibTeX.open(extend_path(config['bibliography']), :filter => :latex)
-      end          
-      
-      def extend_path(name)
-        p = File.join(config['source'], name)
-        p << '.bib' unless File.exists?(p)
-        p
-      end
     end
     
   end

data/lib/jekyll/scholar/utilities.rb

@@ -0,0 +1,67 @@
+module Jekyll
+  class Scholar
+    
+    # Utility methods used by several Scholar plugins. The methods in this
+    # module may depend on the presence of #config, #bibtex_file, and
+    # #site readers
+    module Utilities
+      
+      attr_reader :bibtex_file, :config, :site
+      
+      def bibtex_options
+        @bibtex_options ||= { :filter => :latex }
+      end
+      
+      def bibtex_path
+        @bibtex_path ||= extend_path(bibtex_file)
+      end
+      
+      def bibliography
+        @bibliography ||= BibTeX.open(bibtex_path, bibtex_options)
+      end          
+      
+      def entries
+        b = bibliography[config['query']]
+
+        unless config['sort_by'] == 'none'
+          b.sort_by! { |e| e[config['sort_by']].to_s }
+          b.reverse! if config['order'] =~ /^(desc|reverse)/i
+        end
+        
+        b
+      end
+      
+      def extend_path(name)
+        if name.nil? || name.empty?
+          name = config['bibliography']
+        end
+        
+        p = File.join(config['source'], name)
+        p << '.bib' unless File.exists?(p)
+        p
+      end
+      
+      def generate_details?
+        site.layouts.key?(File.basename(config['details_layout'], '.html'))
+      end
+      
+      def details_file_for(entry)
+        name = entry.key.to_s.dup
+        
+        name.gsub!(/[:\s]+/, '_')
+        
+        [name, 'html'].join('.')
+      end
+      
+      def details_link_for(entry)
+        [site.source, details_path, details_file_for(entry)].join('/')
+      end
+      
+      def details_path
+        config['details_dir']
+      end
+      
+    end
+    
+  end
+end

data/lib/jekyll/scholar/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-scholar
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-27 00:00:00.000000000 Z
+date: 2012-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
-  requirement: &70309233363880 !ruby/object:Gem::Requirement
+  requirement: &70227972382420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '0.10'
   type: :runtime
   prerelease: false
-  version_requirements: *70309233363880
+  version_requirements: *70227972382420
 - !ruby/object:Gem::Dependency
   name: citeproc-ruby
-  requirement: &70309233363360 !ruby/object:Gem::Requirement
+  requirement: &70227972381880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 0.0.6
   type: :runtime
   prerelease: false
-  version_requirements: *70309233363360
+  version_requirements: *70227972381880
 - !ruby/object:Gem::Dependency
   name: bibtex-ruby
-  requirement: &70309233362460 !ruby/object:Gem::Requirement
+  requirement: &70227972380880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 2.0.5
   type: :runtime
   prerelease: false
-  version_requirements: *70309233362460
+  version_requirements: *70227972380880
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70309233361220 !ruby/object:Gem::Requirement
+  requirement: &70227972379520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: '0.9'
   type: :development
   prerelease: false
-  version_requirements: *70309233361220
+  version_requirements: *70227972379520
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &70309233358000 !ruby/object:Gem::Requirement
+  requirement: &70227972376480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: '3.11'
   type: :development
   prerelease: false
-  version_requirements: *70309233358000
+  version_requirements: *70227972376480
 - !ruby/object:Gem::Dependency
   name: redgreen
-  requirement: &70309233372520 !ruby/object:Gem::Requirement
+  requirement: &70227972391080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +76,10 @@ dependencies:
         version: '1.2'
   type: :development
   prerelease: false
-  version_requirements: *70309233372520
+  version_requirements: *70227972391080
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &70309233371740 !ruby/object:Gem::Requirement
+  requirement: &70227972390320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -87,10 +87,10 @@ dependencies:
         version: '2.11'
   type: :development
   prerelease: false
-  version_requirements: *70309233371740
+  version_requirements: *70227972390320
 - !ruby/object:Gem::Dependency
   name: rr
-  requirement: &70309233371260 !ruby/object:Gem::Requirement
+  requirement: &70227972389840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -98,10 +98,10 @@ dependencies:
         version: '1.0'
   type: :development
   prerelease: false
-  version_requirements: *70309233371260
+  version_requirements: *70227972389840
 - !ruby/object:Gem::Dependency
   name: cucumber
-  requirement: &70309233370720 !ruby/object:Gem::Requirement
+  requirement: &70227972389320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -109,10 +109,10 @@ dependencies:
         version: '1.1'
   type: :development
   prerelease: false
-  version_requirements: *70309233370720
+  version_requirements: *70227972389320
 - !ruby/object:Gem::Dependency
   name: RedCloth
-  requirement: &70309233370180 !ruby/object:Gem::Requirement
+  requirement: &70227972388780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -120,10 +120,10 @@ dependencies:
         version: '4.2'
   type: :development
   prerelease: false
-  version_requirements: *70309233370180
+  version_requirements: *70227972388780
 - !ruby/object:Gem::Dependency
   name: rdiscount
-  requirement: &70309233369560 !ruby/object:Gem::Requirement
+  requirement: &70227972388160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -131,10 +131,10 @@ dependencies:
         version: '1.6'
   type: :development
   prerelease: false
-  version_requirements: *70309233369560
+  version_requirements: *70227972388160
 - !ruby/object:Gem::Dependency
   name: redcarpet
-  requirement: &70309233368920 !ruby/object:Gem::Requirement
+  requirement: &70227972387500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -142,7 +142,7 @@ dependencies:
         version: '1.9'
   type: :development
   prerelease: false
-  version_requirements: *70309233368920
+  version_requirements: *70227972387500
 description: A set of jekyll extensions for academic blogging.
 email: http://sylvester.keil.or.at
 executables: []
@@ -156,6 +156,7 @@ files:
 - features/bibtex.feature
 - features/citation.feature
 - features/details.feature
+- features/filter.feature
 - features/sorting.feature
 - features/step_definitions/jekyll_steps.rb
 - features/step_definitions/scholar_steps.rb
@@ -163,9 +164,11 @@ files:
 - jekyll-scholar.gemspec
 - lib/jekyll/scholar.rb
 - lib/jekyll/scholar/converters/bibtex.rb
+- lib/jekyll/scholar/defaults.rb
 - lib/jekyll/scholar/generators/details.rb
 - lib/jekyll/scholar/tags/bibliography.rb
 - lib/jekyll/scholar/tags/cite.rb
+- lib/jekyll/scholar/utilities.rb
 - lib/jekyll/scholar/version.rb
 homepage: http://github.com/inukshuk/jekyll-scholar
 licenses: []
@@ -195,6 +198,7 @@ test_files:
 - features/bibtex.feature
 - features/citation.feature
 - features/details.feature
+- features/filter.feature
 - features/sorting.feature
 - features/step_definitions/jekyll_steps.rb
 - features/step_definitions/scholar_steps.rb