middleman-bibtex 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4a9852d3435be7ec344a056458e76090c209c3f1
-  data.tar.gz: dfb09c8bf2546af9632b9cce6699e678726d6dcd
+  metadata.gz: 22a56b668bb2b8aea72faf37588cece920981b6b
+  data.tar.gz: 8bc2db3cb2a7cf7669124b50587cb7a00695d0f5
 SHA512:
-  metadata.gz: 0b261ab3a1434fb3c38ec78a023635a9aaa5037424a721ae67289edca4558dfc16e9afe24f0a07ca195cfa326282162bbbfb4ca3b254aa2a0e2b4c821e7b4dad
-  data.tar.gz: 44075978702c11c7a54a8cb3d599bbc62e38793a51f5573bd16cb056502d9128ba574b815ef87cc83873f17a5753f39415f8cfb4830e58a1594ef46695f40533
+  metadata.gz: 2bbcb96d3e16132359d1f1139414ba11edbd1d91f7e6fcb9452a99c54dd9b29d1848b855e0a55d181d86c97f4ea45a87138525924d3fdc84899956df9247e8bb
+  data.tar.gz: 6d127f13911ad968fb58e0cf21f1a66933ac6a52282a08ba8789cf5c0c843666ee08a60c8a60850ef02dd4464cf7726c5b80ae10ad0b09a2d22eb981e7f4b8dd

data/.gitignore

@@ -1,2 +1 @@
-.ruby-version
 pkg

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+cache: bundler
+rvm:
+ - 2.0.0
+ - 2.1.0
+ - 2.2.0
+script:
+ - 'bundle exec rake spec'

data/Gemfile

@@ -1,5 +1,2 @@
 source 'https://rubygems.org'
-
-# Specify your gem's dependencies in multimarkdown.gemspec
 gemspec
-

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    middleman-citation (0.0.1)
+    middleman-bibtex (0.2.0)
       bibtex-ruby
       citeproc-ruby (~> 0.0.6)
       middleman-core (~> 3)
@@ -9,80 +9,100 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (4.1.5)
-      i18n (~> 0.6, >= 0.6.9)
+    activesupport (4.2.5.2)
+      i18n (~> 0.7)
       json (~> 1.7, >= 1.7.7)
       minitest (~> 5.1)
-      thread_safe (~> 0.1)
+      thread_safe (~> 0.3, >= 0.3.4)
       tzinfo (~> 1.1)
-    bibtex-ruby (4.0.3)
+    bibtex-ruby (4.2.0)
       latex-decode (~> 0.0)
-    celluloid (0.15.2)
-      timers (~> 1.1.0)
+    capybara (2.4.4)
+      mime-types (>= 1.16)
+      nokogiri (>= 1.3.3)
+      rack (>= 1.0.0)
+      rack-test (>= 0.5.4)
+      xpath (~> 2.0)
     citeproc-ruby (0.0.6)
       logging (~> 1.5)
       nokogiri (~> 1.5)
+    diff-lcs (1.2.5)
     erubis (2.7.0)
-    ffi (1.9.3)
-    hooks (0.4.0)
-      uber (~> 0.0.4)
-    i18n (0.6.11)
-    json (1.8.1)
-    latex-decode (0.1.1)
+    ffi (1.9.10)
+    hooks (0.4.1)
+      uber (~> 0.0.14)
+    i18n (0.7.0)
+    json (1.8.3)
+    latex-decode (0.2.2)
       unicode (~> 0.4)
-    listen (2.7.9)
-      celluloid (>= 0.15.2)
+    listen (3.0.6)
       rb-fsevent (>= 0.9.3)
-      rb-inotify (>= 0.9)
-    little-plugger (1.1.3)
+      rb-inotify (>= 0.9.7)
+    little-plugger (1.1.4)
     logging (1.8.2)
       little-plugger (>= 1.1.3)
       multi_json (>= 1.8.4)
-    middleman-core (3.3.5)
-      activesupport (~> 4.1.0)
+    middleman-core (3.4.1)
+      activesupport (~> 4.1)
       bundler (~> 1.1)
+      capybara (~> 2.4.4)
       erubis
       hooks (~> 0.3)
-      i18n (~> 0.6.9)
-      listen (>= 2.7.9, < 3.0)
+      i18n (~> 0.7.0)
+      listen (~> 3.0.3)
       padrino-helpers (~> 0.12.3)
       rack (>= 1.4.5, < 2.0)
-      rack-test (~> 0.6.2)
       thor (>= 0.15.2, < 2.0)
       tilt (~> 1.4.1, < 2.0)
-    mini_portile (0.6.0)
-    minitest (5.4.0)
-    multi_json (1.10.1)
-    nokogiri (1.6.3.1)
-      mini_portile (= 0.6.0)
-    padrino-helpers (0.12.3)
+    mime-types (3.0)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0221)
+    mini_portile2 (2.0.0)
+    minitest (5.8.4)
+    multi_json (1.11.2)
+    nokogiri (1.6.7.2)
+      mini_portile2 (~> 2.0.0.rc2)
+    padrino-helpers (0.12.5)
       i18n (~> 0.6, >= 0.6.7)
-      padrino-support (= 0.12.3)
+      padrino-support (= 0.12.5)
       tilt (~> 1.4.1)
-    padrino-support (0.12.3)
+    padrino-support (0.12.5)
       activesupport (>= 3.1)
-    rack (1.5.2)
-    rack-test (0.6.2)
+    rack (1.6.4)
+    rack-test (0.6.3)
       rack (>= 1.0)
-    rake (10.3.2)
-    rb-fsevent (0.9.4)
-    rb-inotify (0.9.5)
+    rake (10.5.0)
+    rb-fsevent (0.9.7)
+    rb-inotify (0.9.7)
       ffi (>= 0.5.0)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.3)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
     thor (0.19.1)
-    thread_safe (0.3.4)
+    thread_safe (0.3.5)
     tilt (1.4.1)
-    timers (1.1.0)
     tzinfo (1.2.2)
       thread_safe (~> 0.1)
-    uber (0.0.8)
-    unicode (0.4.4.1)
-    yard (0.8.7.4)
+    uber (0.0.15)
+    unicode (0.4.4.2)
+    xpath (2.0.0)
+      nokogiri (~> 1.3)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.3)
-  middleman-citation!
+  bundler
+  middleman-bibtex!
   rake
-  yard
+  rspec

data/README.md

@@ -1,17 +1,19 @@
-# Middleman-citation
+# Middleman-bibtex
 
-This is an extension for the [Middleman](http://middlemanapp.com/) static
-site generator that adds functions you can use in your templates for 
-formating citations from BibTeX.
+An extension for the [Middleman](http://middlemanapp.com/) static
+site generator for formating BibTeX bibliographies.  This is a fork
+of the extension
+[middleman-citation](https://github.com/gabysbrain/middleman-citation)
+which offers similar functionailty.
 
 An example of a Middleman template using this plugin is available at
-<https://github.com/gabysbrain/website/blob/master/source/cv.html.slim>.
+<http://soliton.vm.bytemark.co.uk/pub/jjg/en/mathematics/papers/>.
 
 ## Installation
 
 Add this line to your Gemfile:
 
-    gem 'middleman-citation'
+    gem 'middleman-bibtex'
 
 And then execute:
 
@@ -19,18 +21,18 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install middleman-citation
+    $ gem install middleman-bibtex
 
 ## Configuration
 
 In your `config.rb` file for your site add:
 
-    require 'middleman-citation'
+    require 'middleman-bibtex'
 
-    activate :citation do |opts|
-      opts.bibtex = '/path/to/your.bib' # path to a bibtex file
-      opts.style  = 'ieee'              # style from citeproc-styles
-      opts.format = 'html'              # output format
+    activate :bibtex do |opts|
+      opts.path = '/path/to/your.bib' # path to a bibtex file
+      opts.style = 'ieee'             # style from citeproc-styles
+      opts.format = 'html'            # output format
     end
 
 ## Usage
@@ -50,32 +52,26 @@ templates.
 For extra control on the output, one can use:
 
 * `citation_entry(key)`: Return the unformatted entry (a hash)
-  corresponding to the BibTeX citation key. 
+  corresponding to the BibTeX citation key.
 
 * `citation_formatted(entry)`: Format an unformatted entry.
 
 In fact the `citation` method is implemented using these:
 
     def citation(key)
-      entry = citation_entry(key)
-      citation_formatted(entry)
+      citation_formatted(citation_entry(key))
     end
 
 The point is that one can interrogate the unformatted entry to
 add extra formatting: The following code adds a DOI link if the
 entry matching the `key` has a `URL` field containing the DOI.
 
-    entry      = citation_entry(key)
+    entry = citation_entry(key)
     entry_html = citation_formatted(entry)
-    if doi_url = entry.fetch('URL', false) then
-      doi_link = "(%s)" % link_to('doi', doi_url)
+    unless (doi_url = entry['URL']).nil? then
+      doi_link = format('(%s)', link_to('doi', doi_url))
     end
     [entry_html, doi_link].compact.join(' ')
 
-## Contributing
-
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+[![Gem Version](https://badge.fury.io/rb/middleman-bibtex.svg)](https://badge.fury.io/rb/middleman-bibtex)
+[![Build Status](https://travis-ci.org/jjgreen/middleman-bibtex.svg)](https://travis-ci.org/jjgreen/middleman-bibtex)

data/Rakefile

@@ -1 +1,10 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+desc 'run rspec tests'
+RSpec::Core::RakeTask.new do |spec|
+  spec.pattern = 'spec/*_spec.rb'
+  spec.rspec_opts = ['--color', '--format', 'documentation']
+end
+
+require 'rake/clean'

data/lib/middleman-bibtex/version.rb

@@ -1,5 +1,6 @@
 module Middleman
   module Bibtex
-    VERSION = '0.1.0'
+    VERSION = '0.2.0'
+    class KeyNotFound < RuntimeError ; end
   end
 end

data/lib/middleman-bibtex.rb

@@ -3,58 +3,77 @@ require 'middleman-core'
 require 'bibtex'
 require 'citeproc'
 
+module BibtexHelper
+  extend self
+
+  def citations_search(bib, search_key, author = nil)
+    entries_matching_key = bib.query(search_key)
+    entries =
+      if author then
+        search_by_author(entries_matching_key, author)
+      else
+        entries_matching_key
+      end
+    entries
+      .sort_by { |x| x.year.to_i }
+      .map(&:key)
+  end
+
+  def citation_formatted(entry, style, format)
+    CiteProc.process(entry, :style => style, :format => format)
+  end
+
+  def citation_entry(bib, key)
+    unless entry = bib[key] then
+      message = format('No entry for key %s', key)
+      raise Middleman::Bibtex::KeyNotFound, message
+    end
+    entry.convert_latex.to_citeproc
+  end
+
+  def search_by_author(entries, author)
+    bib_author = BibTeX::Name.parse(author)
+    entries.select do |e|
+      e.respond_to?(:author) &&
+        e.author &&
+        e.author.include?(bib_author)
+    end
+  end
+
+end
+
 module Middleman
 
   class BibtexExtension < Middleman::Extension
 
-    option :bibtex, nil, 'Path to the bibtex file'
+    option :path, nil, 'Path to the bibtex file'
     option :style, 'chicago-author-date', 'BibTeX style'
     option :format, 'html', 'Bibliography format'
 
-    def initialize(app, options_hash={}, &block)
+    def initialize(app, options_hash = {}, &block)
       super
-      app.set(:bibtex,      BibTeX.open(options.bibtex))
-      app.set(:cite_style,  options.style)
+      app.set(:bib, BibTeX.open(options.path))
+      app.set(:cite_style, options.style)
       app.set(:cite_format, options.format)
     end
 
     helpers do
 
       def citations_search(search_key, author = nil)
-        entries_matching_key = bibtex.query(search_key)
-        entries =
-          if author then
-            search_by_author(entries_matching_key, author)
-          else
-            entries_matching_key
-          end
-        entries.sort { |x, y| y.year.to_i <=> x.year.to_i }.map(&:key)
+        BibtexHelper.citation_search(bib, search_key, author)
       end
 
       def citation_entry(key)
-        bibtex[key].convert_latex.to_citeproc
+        BibtexHelper.citation_entry(bib, key)
       end
 
       def citation_formatted(entry)
-        CiteProc.process(entry, :style => cite_style, :format => cite_format)
+        BibtexHelper.citation_formatted(entry, cite_style, cite_format)
       end
 
       def citation(key)
-        entry = citation_entry(key)
-        citation_formatted(entry)
+        citation_formatted(citation_entry(key))
       end
-
-      private
-
-      def search_by_author(entries, author)
-        bib_author = BibTeX::Name.parse(author)
-        entries.select do |e|
-          e.respond_to?(:author) &&
-            e.author &&
-            e.author.include?(bib_author)
-        end
-      end
-
     end
   end
 end

data/middleman-bibtex.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'citeproc-ruby', ['~> 0.0.6']
   spec.add_runtime_dependency 'middleman-core', ['~> 3']
 
-  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'yard'
+  spec.add_development_dependency 'rspec'
 end

data/spec/bibtex_spec.rb

@@ -0,0 +1,128 @@
+require 'bibtex'
+require 'middleman-bibtex'
+require_relative 'spec_helper'
+
+describe BibtexHelper, 'helpers' do
+  let(:bib){ BibTeX.open(fixture('test.bib'), :filter => :latex) }
+
+  describe 'citation_entry' do
+
+    context 'for a key not in the bibliography' do
+
+      it 'should raise' do
+        expect {
+          BibtexHelper.citation_entry(bib, 'no-such')
+        }.to raise_error(Middleman::Bibtex::KeyNotFound)
+      end
+    end
+
+    context 'for a key in the bibliography' do
+
+      it 'should not raise' do
+        expect {
+          BibtexHelper.citation_entry(bib, 'godel:1933')
+        }.to_not raise_error
+      end
+
+      describe 'the return value' do
+        let(:result) { BibtexHelper.citation_entry(bib, 'godel:1933') }
+
+        it 'should be a Hash' do
+          expect(result).to be_a Hash
+        end
+
+        it 'should have the expected keys' do
+          expect(result.keys)
+            .to match_array ['author',
+                             'container-title',
+                             'id',
+                             'issued',
+                             'page',
+                             'title',
+                             'type',
+                             'volume']
+        end
+
+        it 'should correctly split the author name' do
+          expect(result['author'])
+            .to match_array [ {'family' => 'Gödel', 'given' => 'K.'} ]
+        end
+      end
+    end
+  end
+
+  describe 'citation_formatted' do
+    let(:entry) { BibtexHelper.citation_entry(bib, 'godel:1933') }
+    let(:result) { BibtexHelper.citation_formatted(entry, 'ieee', 'html') }
+
+    it 'should return a String' do
+      expect(result).to be_a String
+    end
+
+    it 'should have the expected author' do
+      expect(result).to match /K. Gödel/
+    end
+  end
+
+  describe 'citation_search' do
+
+    shared_examples 'the expected search results' do
+
+      it 'should be an Array' do
+        expect(subject).to be_an Array
+      end
+
+      it 'should have the expected number of elements' do
+        expect(subject.length).to eq results.length
+      end
+
+      it 'should have String elements' do
+        subject.each { |item| expect(item).to be_a String }
+      end
+
+      it 'should have the expected elements' do
+        expect(subject).to match_array results
+      end
+
+      it 'should be in year order' do
+        expect(subject).to eq results
+      end
+    end
+
+    context 'when search_term and author are nil' do
+      it_should_behave_like 'the expected search results' do
+        let(:subject) {
+          BibtexHelper.citations_search(bib, nil, nil)
+        }
+        let(:results) { ['godel:1933', 'turing:1936', 'turing:1946'] }
+      end
+    end
+
+    context 'when search_term is "@article", but author is nil' do
+      it_should_behave_like 'the expected search results' do
+        let(:subject) {
+          BibtexHelper.citations_search(bib, '@article', nil)
+        }
+        let(:results) { ['godel:1933', 'turing:1936'] }
+      end
+    end
+
+    context 'when search_term is nil, but author is given' do
+      it_should_behave_like 'the expected search results' do
+        let(:subject) {
+          BibtexHelper.citations_search(bib, nil, 'A. M. Turing')
+        }
+        let(:results) { ['turing:1936', 'turing:1946'] }
+      end
+    end
+
+    context 'when search_term is "@article" and author is given' do
+      it_should_behave_like 'the expected search results' do
+        let(:subject) {
+          BibtexHelper.citations_search(bib, '@article', 'A. M. Turing')
+        }
+        let(:results) { ['turing:1936'] }
+      end
+    end
+  end
+end

data/spec/fixtures/test.bib

@@ -0,0 +1,27 @@
+@Article{godel:1933,
+  author = 	 {K. G\"{o}del},
+  title = 	 {\"{U}ber formal unentschedibare Sätze der
+                  Principia Mathematica und verwandter Systeme, I},
+  journal = 	 {Monatsh. Math. Phys.},
+  year = 	 1931,
+  volume = 	 38,
+  pages = 	 {173--198}}
+
+@Article{turing:1936,
+  author =       {A. M. Turing},
+  title =        {On Computable Numbers, with an Application to the
+                 {Entscheidungsproblem}},
+  journal =      {Proc. London Math. Soc. (2)},
+  volume =       42,
+  pages =        {230--265},
+  year =         1936
+}
+
+@TechReport{turing:1946,
+  author =       {A. M. Turing},
+  title =        {Proposed Electronic Calculator},
+  type =         {Report},
+  institution =  {National Physical Laboratory},
+  pages =        48,
+  year =         1946
+}

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+def fixture(subpath)
+  [File.dirname(__FILE__), 'fixtures', subpath].join('/')
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: middleman-bibtex
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - J. J. Green
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-04 00:00:00.000000000 Z
+date: 2016-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bibtex-ruby
@@ -56,16 +56,16 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -81,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: yard
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -105,6 +105,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -113,6 +114,9 @@ files:
 - lib/middleman-bibtex.rb
 - lib/middleman-bibtex/version.rb
 - middleman-bibtex.gemspec
+- spec/bibtex_spec.rb
+- spec/fixtures/test.bib
+- spec/spec_helper.rb
 homepage: https://github.com/jjgreen/middleman-bibtex
 licenses:
 - MIT
@@ -137,4 +141,7 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Middleman extension for bibtex bibliographies
-test_files: []
+test_files:
+- spec/bibtex_spec.rb
+- spec/fixtures/test.bib
+- spec/spec_helper.rb