jekyll-scholar 0.0.1

data/.gitignore

@@ -0,0 +1 @@
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,4 @@
+source :rubygems
+gemspec
+
+gem 'unicode_utils'

data/LICENSE

@@ -0,0 +1,21 @@
+(The MIT License)
+
+Copyright (c) 2011-2012 Sylvester Keil
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the 'Software'), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,101 @@
+Jekyll-Scholar
+==============
+
+Jekyll-Scholar is for all the academic bloggers out there. It is a set of
+extensions to [Jekyll](http://jekyllrb.com/), the awesome, blog aware, static
+site generator; it formats your bibliographies and reading lists for the web
+and gives your blog posts citation super-powers.
+
+Installation
+------------
+
+    $ [sudo] gem install jekyll-scholar
+
+
+Usage
+-----
+
+Install and setup a new [Jekyll](http://jekyllrb.com/) directory (see the
+[Jekyll-Wiki](https://github.com/mojombo/jekyll/wiki/Usage) for detailed
+instructions). To enable the Jekyll-Scholar add the following statement
+to a file in your plugin directory (e.g., to `_plugins/ext.rb`):
+
+    require 'jekyll/scholar'
+
+In your configuration you can now adjust the Jekyll-Scholar settings
+
+    citation_style: apa
+    citation_language: en
+
+You can use any style that ships with
+[CiteProc-Ruby](https://github.com/inukshuk/citeproc-ruby) by name (e.g.,
+apa, mla, chicago-fullnote-bibliography), or else you can add a link
+to any CSL style (e.g., you could link to any of the styles available at
+the official [CSL style repository](https://github.com/citation-style-language/styles)).
+
+The `citation_language` settings defines what language to use when formatting
+your references (this typically applies to localized terms, e.g., 'Eds.' for
+editors in English).
+
+### Bibliographies
+
+Once you have loaded Jekyll-Scholar, all files with the extension `.bib` or
+`.bibtex` will be converted when you run Jekyll (don't forget to add a YAML
+header to the files); the file can contain regular HTML or Markdown and
+BibTeX entries; the latter will be formatted by Jekyll-Scholar according to
+the citation style and language defined in your configuration file.
+
+For example, if you had a file `bibliography.bib` in your root directory:
+
+      ---
+      ---
+      References
+      ==========
+
+      @book{ruby,
+        title     = {The Ruby Programming Language},
+        author    = {Flanagan, David and Matsumoto, Yukihiro},
+        year      = {2008},
+        publisher = {O'Reilly Media}
+      }
+
+It would be converted to `bibliography.html` with the following content:
+
+    <h1 id='references'>References</h1>
+
+    <p>Flanagan, D., &#38; Matsumoto, Y. (2008). <i>The Ruby Programming Language</i>. O&#8217;Reilly Media.</p>
+
+This makes it very easy for you to add you bibliography to your Jekyll-powered
+blog or website.
+
+
+### Citations
+
+Jekyll-Scholar will support inline citations and automatic generation of
+a list of references for individual blog posts. Stay tuned.
+
+
+License
+-------
+
+Jekyll-Scholar is distributed under the same license as Jekyll.
+
+Copyright (c) 2011-2012 [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
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/features/bibtex.feature

@@ -0,0 +1,41 @@
+Feature: BibTeX
+  As a scholar who likes to blog
+  I want to publish my BibTeX bibliography on my blog
+  In order to share my awesome references with my peers
+
+	Scenario: Simple Bibliography
+		Given I have a configuration file with "citation_style" set to "apa"
+	  And I have a page "references.bib":
+			"""
+			---
+			---
+			@book{ruby,
+			  title     = {The Ruby Programming Language},
+			  author    = {Flanagan, David and Matsumoto, Yukihiro},
+			  year      = {2008},
+			  publisher = {O'Reilly Media}
+			}
+			"""
+	  When I run jekyll
+	  Then the _site directory should exist
+		And the "_site/references.html" file should exist
+	  And I should see "<i>The Ruby Programming Language</i>" in "_site/references.html"
+
+	Scenario: Markdown Formatted Bibliography
+		Given I have a configuration file with "citation_style" set to "apa"
+	  And I have a page "references.bib":
+			"""
+			---
+			---
+			References
+			==========
+			
+			@book{ruby,
+			  title     = {The Ruby Programming Language},
+			  author    = {Flanagan, David and Matsumoto, Yukihiro},
+			  year      = {2008},
+			  publisher = {O'Reilly Media}
+			}
+			"""
+	  When I run jekyll
+	  Then I should see "<h1[^>]*>References</h1>" in "_site/references.html"

data/features/step_definitions/jekyll_steps.rb

@@ -0,0 +1,76 @@
+Before do
+  FileUtils.rm_rf(TEST_DIR)
+  FileUtils.mkdir(TEST_DIR)
+  Dir.chdir(TEST_DIR)
+end
+
+After do
+  Dir.chdir(TEST_DIR)
+  FileUtils.rm_rf(TEST_DIR)
+end
+ 
+# Like "I have a foo file" but gives a yaml front matter so jekyll actually processes it
+Given /^I have an? "(.*)" page(?: with (.*) "(.*)")? that contains "(.*)"$/ do |file, key, value, text|
+  File.open(file, 'w') do |f|
+    f.write <<EOF
+---
+#{key || 'layout'}: #{value || 'nil'}
+---
+#{text}
+EOF
+    f.close
+  end
+end
+
+Given /^I have an? "(.*)" file that contains "(.*)"$/ do |file, text|
+  File.open(file, 'w') do |f|
+    f.write(text)
+    f.close
+  end
+end
+
+Given /^I have a configuration file with "(.*)" set to "(.*)"$/ do |key, value|
+  File.open('_config.yml', 'w') do |f|
+    f.write("#{key}: #{value}\n")
+    f.close
+  end
+end
+
+Given /^I have a configuration file with:$/ do |table|
+  File.open('_config.yml', 'w') do |f|
+    table.hashes.each do |row|
+      f.write("#{row["key"]}: #{row["value"]}\n")
+    end
+    f.close
+  end
+end
+
+Given /^I have a configuration file with "([^\"]*)" set to:$/ do |key, table|
+  File.open('_config.yml', 'w') do |f|
+    f.write("#{key}:\n")
+    table.hashes.each do |row|
+      f.write("- #{row["value"]}\n")
+    end
+    f.close
+  end
+end
+
+When /^I run jekyll$/ do
+  run_jekyll
+end
+
+Then /^the (.*) directory should exist$/ do |dir|
+  assert File.directory?(dir)
+end
+
+Then /^I should see "(.*)" in "(.*)"$/ do |text, file|
+  assert_match Regexp.new(text), File.open(file).readlines.join
+end
+
+Then /^the "(.*)" file should exist$/ do |file|
+  assert File.file?(file)
+end
+
+Then /^the "(.*)" file should not exist$/ do |file|
+  assert !File.exists?(file)
+end

data/features/step_definitions/scholar_steps.rb

@@ -0,0 +1,6 @@
+
+Given /^I have a page "([^"]*)":$/ do |file, string|
+  File.open(file, 'w') do |f|
+   f.write(string)
+  end
+end

data/features/support/env.rb

@@ -0,0 +1,25 @@
+require 'rr'
+require 'test/unit'
+
+require 'jekyll/scholar'
+
+# require 'ruby-debug'
+# Debugger.start
+
+World do
+  include Test::Unit::Assertions
+end
+
+TEST_DIR = File.join('/', 'tmp', 'jekyll')
+
+def run_jekyll(options = {})
+  
+  options['source'] ||= TEST_DIR
+  options['destination'] ||= File.join(TEST_DIR, '_site')
+  
+  options = Jekyll.configuration(options)
+
+  site = Jekyll::Site.new(options)
+  site.process
+
+end

data/jekyll-scholar.gemspec

@@ -0,0 +1,42 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib/', __FILE__)
+$:.unshift lib unless $:.include?(lib)
+
+require 'jekyll/scholar/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'jekyll-scholar'
+  s.version     = Jekyll::Scholar::VERSION.dup
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Sylvester Keil']
+  s.email       = 'http://sylvester.keil.or.at'
+  s.homepage    = 'http://github.com/inukshuk/jekyll-scholar'
+  s.summary     = 'Jekyll extensions for the academic blogger.'
+  s.description = 'A set of jekyll extensions for academic blogging.'
+  s.date        = Time.now
+
+  s.required_rubygems_version = '>= 1.3.6'
+  s.rubyforge_project = s.name
+
+  s.add_runtime_dependency('jekyll', '~> 0.10')
+  s.add_runtime_dependency('citeproc-ruby', '~> 0.0.6')
+  s.add_runtime_dependency('bibtex-ruby', '~> 2.0.5')
+  
+  s.add_development_dependency('bundler', '~> 1.1')
+  s.add_development_dependency('rdoc', '~> 3.12')
+  s.add_development_dependency('rake', '~> 0.9')
+  s.add_development_dependency('redgreen', ">= 1.2.2")
+  s.add_development_dependency('shoulda', ">= 2.11.3")
+  s.add_development_dependency('rr', ">= 1.0.2")
+  s.add_development_dependency('cucumber', ">= 0.10.0")
+  s.add_development_dependency('RedCloth', ">= 4.2.1")
+  s.add_development_dependency('rdiscount', ">= 1.6.5")
+
+  s.files        = `git ls-files`.split("\n")
+  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.rb

@@ -0,0 +1,4 @@
+
+require 'jekyll'
+require 'jekyll/scholar/version'
+require 'jekyll/scholar/converters/bibtex'

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

@@ -0,0 +1,43 @@
+require 'bibtex'
+require 'citeproc'
+
+module Jekyll
+  module Scholar
+    class BibTeXConverter < Converter
+      safe true
+    
+      priority :highest
+    
+      DEFAULTS = Hash[*%w{
+        citation_style  apa
+        citation_locale en
+      }].freeze
+      
+      PATTERN = (/bib(tex)?$/i).freeze
+      EXTENSION = '.html'.freeze
+      
+      def initialize (config = {})
+        super
+        @config['scholar'] = DEFAULTS.merge(@config['scholar'] || {})
+        @markdown = MarkdownConverter.new config
+      end
+    
+      def matches (extension); extension =~ PATTERN; end
+    
+      def output_ext (extension); EXTENSION; end
+    
+      def convert (content)
+        content = BibTeX.parse(content, :include => [:meta_content]).map do |b|
+          if b.respond_to?(:to_citeproc)
+            CiteProc.process b.to_citeproc, :style => @config['citation_style'],
+              :locale => @config['citation_locale'], :format => 'html'
+          else
+              b.is_a?(BibTeX::MetaContent) ? b.to_s : ''
+          end
+        end
+        @markdown.convert(content.join("\n"))
+      end
+    
+    end
+  end
+end

data/lib/jekyll/scholar/version.rb

@@ -0,0 +1,5 @@
+module Jekyll
+  module Scholar
+    VERSION = '0.0.1'.freeze
+  end
+end

metadata

@@ -0,0 +1,192 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-scholar
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Sylvester Keil
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: &70277834274540 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70277834274540
+- !ruby/object:Gem::Dependency
+  name: citeproc-ruby
+  requirement: &70277834273580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.6
+  type: :runtime
+  prerelease: false
+  version_requirements: *70277834273580
+- !ruby/object:Gem::Dependency
+  name: bibtex-ruby
+  requirement: &70277834288720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: *70277834288720
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70277834287260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: *70277834287260
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: &70277834286200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: *70277834286200
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70277834285300 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: *70277834285300
+- !ruby/object:Gem::Dependency
+  name: redgreen
+  requirement: &70277834284200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.2.2
+  type: :development
+  prerelease: false
+  version_requirements: *70277834284200
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: &70277834283440 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.11.3
+  type: :development
+  prerelease: false
+  version_requirements: *70277834283440
+- !ruby/object:Gem::Dependency
+  name: rr
+  requirement: &70277834282580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+  type: :development
+  prerelease: false
+  version_requirements: *70277834282580
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: &70277834281600 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :development
+  prerelease: false
+  version_requirements: *70277834281600
+- !ruby/object:Gem::Dependency
+  name: RedCloth
+  requirement: &70277834297280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 4.2.1
+  type: :development
+  prerelease: false
+  version_requirements: *70277834297280
+- !ruby/object:Gem::Dependency
+  name: rdiscount
+  requirement: &70277834296260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.6.5
+  type: :development
+  prerelease: false
+  version_requirements: *70277834296260
+description: A set of jekyll extensions for academic blogging.
+email: http://sylvester.keil.or.at
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- features/bibtex.feature
+- features/step_definitions/jekyll_steps.rb
+- features/step_definitions/scholar_steps.rb
+- features/support/env.rb
+- jekyll-scholar.gemspec
+- lib/jekyll/scholar.rb
+- lib/jekyll/scholar/converters/bibtex.rb
+- lib/jekyll/scholar/version.rb
+homepage: http://github.com/inukshuk/jekyll-scholar
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: jekyll-scholar
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Jekyll extensions for the academic blogger.
+test_files:
+- features/bibtex.feature
+- features/step_definitions/jekyll_steps.rb
+- features/step_definitions/scholar_steps.rb
+- features/support/env.rb