middleman-citation 0.0.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f55657e35c57b39ea3cf99d18502348145e533fc
-  data.tar.gz: de38334ee3122e3becfae88985479d610d016b57
+  metadata.gz: df3100f95e3b00a8dde2c4e7d4268cf900624e78
+  data.tar.gz: 5334dfdb4123806ec377c7adb1c08b0b48ca12e7
 SHA512:
-  metadata.gz: 0748e82b0a09b4dd9378beb55fb924bc5b142b76260dab2ed53230ea13541399fb41a6961f57255d6824343e554bee272a198dcc9bb06bdf1f8b916dee456e1e
-  data.tar.gz: 72347790ff25cbecd205dc9eadddd17d6bf8fbab77585a9b5a7b2afd60c1a688a07b46d4b5b27eae2986f61adb65edc1d2c1c6f212220de1b4f9f5dead80c548
+  metadata.gz: de796752aab080082f670edde6de3eb85e6a14317e95311db17d448eef37af2d44f909cd40239f51b407264b7d00efbcf472ca61bdeda6c0d941b8a13bc0891b
+  data.tar.gz: cb4c6890411c2a8181818738fde1ec18c308ed2ee7ff57a67e0b2ab91c5472fa5241e9593dc0549a749fe6a7349d6e0ba1a503b943b1f80404c1bbb71412bc24

data/.gitignore

@@ -1,2 +1,4 @@
 .ruby-version
 pkg
+doc
+.yardoc

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.yardopts

@@ -0,0 +1 @@
+lib/**/*.rb

data/Gemfile

@@ -1,5 +1,20 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in multimarkdown.gemspec
+# Specify your gem's dependencies in middleman-citation.gemspec
 gemspec
 
+group :development do
+  gem 'rake'
+  gem 'rdoc'
+  gem 'yard'
+  gem 'guard'
+  gem 'pry'
+end
+
+group :test do
+  gem 'cucumber'
+  gem 'aruba'
+  gem 'rspec'
+  gem 'rspec-html-matchers'
+  gem 'guard-rspec'
+end

data/Gemfile.lock

@@ -1,86 +1,171 @@
 PATH
   remote: .
   specs:
-    middleman-citation (0.0.1)
+    middleman-citation (0.0.2.2)
       bibtex-ruby
-      citeproc-ruby (~> 0.0.6)
+      citeproc-ruby
+      csl-styles
       middleman-core (~> 3)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (4.1.5)
-      i18n (~> 0.6, >= 0.6.9)
+    activesupport (4.2.4)
+      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)
+    aruba (0.10.0)
+      childprocess (~> 0.5.6)
+      contracts (~> 0.9)
+      cucumber (>= 1.3.19)
+      ffi (~> 1.9.10)
+      rspec-expectations (>= 2.99)
+      thor (~> 0.19)
+    bibtex-ruby (4.0.14)
       latex-decode (~> 0.0)
-    celluloid (0.15.2)
-      timers (~> 1.1.0)
-    citeproc-ruby (0.0.6)
-      logging (~> 1.5)
-      nokogiri (~> 1.5)
+    builder (3.2.2)
+    capybara (2.4.4)
+      mime-types (>= 1.16)
+      nokogiri (>= 1.3.3)
+      rack (>= 1.0.0)
+      rack-test (>= 0.5.4)
+      xpath (~> 2.0)
+    childprocess (0.5.7)
+      ffi (~> 1.0, >= 1.0.11)
+    citeproc (1.0.1)
+      namae (~> 0.8)
+    citeproc-ruby (1.0.4)
+      citeproc (~> 1.0)
+      csl (~> 1.2)
+    coderay (1.1.0)
+    contracts (0.12.0)
+    csl (1.2.3)
+      namae (~> 0.7)
+    csl-styles (1.0.1.4)
+      csl (~> 1.0)
+    cucumber (2.1.0)
+      builder (>= 2.1.2)
+      cucumber-core (~> 1.3.0)
+      diff-lcs (>= 1.1.3)
+      gherkin3 (~> 3.1.0)
+      multi_json (>= 1.7.5, < 2.0)
+      multi_test (>= 0.1.2)
+    cucumber-core (1.3.0)
+      gherkin3 (~> 3.1.0)
+    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)
+    formatador (0.2.5)
+    gherkin3 (3.1.2)
+    guard (2.13.0)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, <= 4.0)
+      lumberjack (~> 1.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-rspec (4.3.1)
+      guard (~> 2.1)
+      rspec (>= 2.14, < 4.0)
+    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.3)
       rb-fsevent (>= 0.9.3)
       rb-inotify (>= 0.9)
-    little-plugger (1.1.3)
-    logging (1.8.2)
-      little-plugger (>= 1.1.3)
-      multi_json (>= 1.8.4)
-    middleman-core (3.3.5)
-      activesupport (~> 4.1.0)
+    lumberjack (1.0.9)
+    method_source (0.8.2)
+    middleman-core (3.4.0)
+      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 (2.6.1)
+    mini_portile (0.6.2)
+    minitest (5.8.0)
+    multi_json (1.11.2)
+    multi_test (0.1.2)
+    namae (0.9.2)
+    nenv (0.2.0)
+    nokogiri (1.6.6.2)
+      mini_portile (~> 0.6.0)
+    notiffany (0.0.8)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    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)
+    pry (0.10.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rack (1.6.4)
+    rack-test (0.6.3)
       rack (>= 1.0)
     rake (10.3.2)
-    rb-fsevent (0.9.4)
+    rb-fsevent (0.9.6)
     rb-inotify (0.9.5)
       ffi (>= 0.5.0)
+    rdoc (4.2.0)
+      json (~> 1.4)
+    rspec (3.3.0)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+    rspec-core (3.3.2)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-html-matchers (0.7.0)
+      nokogiri (~> 1)
+      rspec (~> 3)
+    rspec-mocks (3.3.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
+    shellany (0.0.1)
+    slop (3.6.0)
     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)
+    uber (0.0.15)
+    unicode (0.4.4.2)
+    xpath (2.0.0)
+      nokogiri (~> 1.3)
+    yard (0.8.7.6)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.3)
+  aruba
+  cucumber
+  guard
+  guard-rspec
   middleman-citation!
+  pry
   rake
+  rdoc
+  rspec
+  rspec-html-matchers
+  yard

data/Guardfile

@@ -0,0 +1,12 @@
+
+guard 'rspec' do
+  # watch /lib/ files
+  watch(%r{^lib/(.+).rb$}) do |m|
+    system %{rake spec}
+  end
+
+  # watch /spec/ files
+  watch(%r{^spec/(.+).rb$}) do |m|
+    system %{rake spec}
+  end
+end

data/README.md

@@ -1,5 +1,7 @@
 # Middleman-citation
 
+[ ![Codeship Status for gabysbrain/middleman-citation](https://codeship.com/projects/cd5fdc40-6601-0133-2d2b-5adfc3e4cb23/status?branch=master)](https://codeship.com/projects/113648)
+
 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.
@@ -21,16 +23,16 @@ Or install it yourself as:
 
     $ gem install middleman-citation
 
-
 ## Configuration
 
 In your `config.rb` file for your site add:
 
     require 'middleman-citation'
 
-    activate :citation do |options|
-      options.bibtex = "/Users/tom/Dropbox/Research/all.bib" # full path to a bibtex file
-      options.style = "ieee" # or whatever style you want from citeproc-styles
+    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
     end
 
 ## Usage
@@ -38,14 +40,39 @@ In your `config.rb` file for your site add:
 This adds the following helper methods you can use in your Middleman
 templates.
 
+* `citations_search(search_term, author)`: Search the BibTeX file for all
+   citations matching a search term (such as `'@article'`) and by the given
+   author.  The `author` argument can be ommitted to match all authors and
+   a `search_term` of `nil` will match all items in the bibliography.
+
+* `citation(key)`: Given a BibTeX citation key as returned from
+  `citations_search`, return a formatted string the citation according to
+  how the `style` and `format` options were set.
+
+For extra control on the output, one can use:
+
+* `citation_entry(key)`: Return the unformatted entry (a hash)
+  corresponding to the BibTeX citation key. 
 
+* `citation_formatted(entry)`: Format an unformatted entry.
 
-* `cite_full(key)`: given the BibTeX citation key return a formatted string
-                  for the citation according to how the `style` option is set.
-* `find_pubs(search_key, author)`: Search the BibTeX file for all citations 
-                                 of a certain type for a # certain author.  
-                                 Returns a list of citation keys you can send 
-                                 to `cite_full`.
+In fact the `citation` method is implemented using these:
+
+    def citation(key)
+      entry = citation_entry(key)
+      citation_formatted(entry)
+    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_html = citation_formatted(entry)
+    if doi_url = entry.fetch('URL', false) then
+      doi_link = "(%s)" % link_to('doi', doi_url)
+    end
+    [entry_html, doi_link].compact.join(' ')
 
 ## Contributing
 

data/Rakefile

@@ -1 +1,20 @@
-require "bundler/gem_tasks"
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'cucumber/rake/task'
+Cucumber::Rake::Task.new(:cucumber, 'Run features that should pass') do |t|
+  t.cucumber_opts = "--color --tags ~@wip --strict"
+end
+
+require 'rspec/core/rake_task'
+desc "Run RSpec"
+RSpec::Core::RakeTask.new do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rspec_opts = ['--color', '--format documentation']
+end
+
+require 'rake/clean'
+
+task test: ['spec', 'cucumber']
+
+task default: :test

data/features/support/env.rb

@@ -0,0 +1,4 @@
+PROJECT_ROOT_PATH = File.dirname(File.dirname(File.dirname(__FILE__)))
+require 'middleman-core'
+require 'middleman-core/step_definitions'
+require File.join(PROJECT_ROOT_PATH, 'lib', 'middleman-citation')

data/fixtures/test.bib

@@ -0,0 +1,93 @@
+@article{Turkay:2011a,
+	Author = {Turkay, Cagatay and J. Parulek and N. Reuter and Hauser, Helwig},
+	Date-Added = {2015-11-04 09:50:16 +0000},
+	Date-Modified = {2015-11-04 09:50:48 +0000},
+	Doi = {10.1111/j.1467-8659.2011.01920.x},
+	Journal = {Computer Graphics Forum},
+	Month = {jun},
+	Number = {3},
+	Pages = {711--720},
+	Publisher = {Wiley-Blackwell},
+	Title = {Interactive Visual Analysis of Temporal Cluster Structures},
+	Url = {http://dx.doi.org/10.1111/j.1467-8659.2011.01920.x},
+	Volume = {30},
+	Year = 2011,
+	Bdsk-Url-1 = {http://dx.doi.org/10.1111/j.1467-8659.2011.01920.x}}
+
+@article{Correa:2013,
+	Author = {Carlos D. Correa and Peter Lindstrom},
+	Date-Added = {2015-11-02 14:06:07 +0000},
+	Date-Modified = {2015-11-02 14:06:07 +0000},
+	Doi = {10.1615/int.j.uncertaintyquantification.2012003959},
+	Journal = {Int. J. {UncertaintyQuantification}},
+	Number = {3},
+	Pages = {187--201},
+	Publisher = {Begell House},
+	Title = {{THE} {MUTUAL} {INFORMATION} {DIAGRAM} {FOR} {UNCERTAINTY} {VISUALIZATION}},
+	Url = {http://dx.doi.org/10.1615/int.j.uncertaintyquantification.2012003959},
+	Volume = {3},
+	Year = 2013,
+	Bdsk-Url-1 = {http://dx.doi.org/10.1615/int.j.uncertaintyquantification.2012003959}}
+
+@article{Beck:2016,
+	Author = {Fabian Beck and Sebastian Koch and Daniel Weiskopf},
+	Date-Added = {2015-11-02 11:01:01 +0000},
+	Date-Modified = {2015-11-02 11:01:01 +0000},
+	Doi = {10.1109/tvcg.2015.2467757},
+	Journal = {{IEEE} Trans. Visual. Comput. Graphics},
+	Month = {jan},
+	Number = {1},
+	Pages = {180--189},
+	Publisher = {Institute of Electrical {\\&} Electronics Engineers ({IEEE})},
+	Title = {Visual Analysis and Dissemination of Scientific Literature Collections with {SurVis}},
+	Url = {http://dx.doi.org/10.1109/tvcg.2015.2467757},
+	Volume = {22},
+	Year = 2016,
+	Bdsk-Url-1 = {http://dx.doi.org/10.1109/tvcg.2015.2467757}}
+
+@article{Lehmann:2016,
+	Author = {Dirk J. Lehmann and Holger Theisel},
+	Date-Added = {2015-11-02 10:47:37 +0000},
+	Date-Modified = {2015-11-02 10:47:37 +0000},
+	Doi = {10.1109/tvcg.2015.2467132},
+	Journal = {{IEEE} Trans. Visual. Comput. Graphics},
+	Month = {jan},
+	Number = {1},
+	Pages = {609--618},
+	Publisher = {Institute of Electrical {\\&} Electronics Engineers ({IEEE})},
+	Title = {Optimal Sets of Projections of High-Dimensional Data},
+	Url = {http://dx.doi.org/10.1109/tvcg.2015.2467132},
+	Volume = {22},
+	Year = 2016,
+	Bdsk-Url-1 = {http://dx.doi.org/10.1109/tvcg.2015.2467132}}
+
+@article{Rubio-Sanchez:2016,
+	Author = {Manuel Rubio-Sanchez and Laura Raya and Francisco Diaz and Alberto Sanchez},
+	Date-Added = {2015-11-02 10:47:09 +0000},
+	Date-Modified = {2015-11-02 10:47:09 +0000},
+	Doi = {10.1109/tvcg.2015.2467324},
+	Journal = {{IEEE} Trans. Visual. Comput. Graphics},
+	Month = {jan},
+	Number = {1},
+	Pages = {619--628},
+	Publisher = {Institute of Electrical {\\&} Electronics Engineers ({IEEE})},
+	Title = {A comparative study between {RadViz} and Star Coordinates},
+	Url = {http://dx.doi.org/10.1109/tvcg.2015.2467324},
+	Volume = {22},
+	Year = 2016,
+	Bdsk-Url-1 = {http://dx.doi.org/10.1109/tvcg.2015.2467324}}
+
+@article{Torsney-Weir:2011,
+	Author = {Torsney-Weir, Thomas and Saad, Ahmed and M{\"o}ller, Torsten and Weber, Britta and Hege, Hans-Christian and Verbavatz, Jean-Marc and Bergner, Steven},
+	Date-Added = {2012-12-23 15:54:34 +0000},
+	Date-Modified = {2013-04-07 20:00:22 +0000},
+	Journal = {IEEE Transactions on Visualization and Computer Graphics},
+	Keywords = {Visualization, High-D, Image Segmentation, Multi-objective},
+	Month = nov # {\slash } # dec,
+	Number = {12},
+	Pages = {1892--1901},
+	Rating = {0},
+	Title = {Tuner: Principled Parameter Finding for Image Segmentation Algorithms Using Visual Response Surface Exploration},
+	Volume = {17},
+	Year = {2011}}
+  

data/lib/middleman-citation.rb

@@ -1,20 +1,21 @@
 require "middleman-citation/version"
+require "middleman-citation/citations"
 require "middleman-core"
 require "bibtex"
-require "citeproc"
 
 module Middleman
+
   class CitationExtension < Middleman::Extension
-    option :bibtex, "", "The path to the bibtex file to use"
-    option :style, "chicago-author-date", "The citation style to use"
-  
+
+    option :bibtex, nil,                   'Path to the bibtex file'
+    option :style,  'chicago-author-date', 'Citation style'
+    option :format, 'html',                'Citation format'
+
     def initialize(app, options_hash={}, &block)
       super
-  
-      @@bibtex = BibTeX.open(options.bibtex)
-      # for some reason the options function is the one from 
-      # middleman-deploy in the helper methods below...
-      @@cite_style = options.style
+      app.set(:bibtex,      BibTeX.open(options.bibtex, :filter => 'latex'))
+      app.set(:cite_style,  options.style)
+      app.set(:cite_format, options.format)
     end
   
     helpers do
@@ -23,26 +24,52 @@ module Middleman
       # Params:
       # +key+:: bibtex key located in the BibTeX file defined in the config
       def cite_full(key)
-        # need to convert latex special characters, like {\"o} to unicode
-        @@bibtex[key].convert_latex
-        CiteProc.process(@@bibtex[key].to_citeproc, :style => @@cite_style)
+        Citations::cite_full(key, @@bibtex, @@cite_style)
       end
-  
-      # Search the BibTeX file for all citations of a certain type for a 
-      # certain author.  Returns a list of citation keys you can send to
-      # +cite_full+.
+
+      # Given a BibTeX citation return a block containing the citation
+      # that we can embed in a webpage inline
       # Params:
-      # +search_key+:: filter keys for the BibTeX file, e.g. @book, @article,
-      #                etc.
-      # +author+:: The full author name to search for
-      def find_pubs(search_key, author)
-        bib_name = BibTeX::Name.parse(author)
-        results = @@bibtex.query(search_key) do |e|
-          e.respond_to?(:author) and e.author and e.author.include? bib_name
+      # +key+:: bibtex key located in the BibTeX file defined in the config
+      def cite_inline(key)
+        Citations::cite_inline(key, @@bibtex, @@cite_style)
+      end
+
+      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)
+      end
+
+      def citation_entry(key)
+        bibtex[key].convert_latex.to_citeproc
+      end
+
+      def citation_formatted(entry)
+        CiteProc.process(entry, :style => cite_style, :format => cite_format)
+      end
+
+      def citation(key)
+        entry = citation_entry(key)
+        citation_formatted(entry)
+      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
-        results.sort! {|x,y| y.year.to_i-x.year.to_i}
-        results.map {|x| x.key}
       end
+
     end
   end
 end

data/lib/middleman-citation/citations.rb

@@ -0,0 +1,33 @@
+
+require "bibtex"
+require "citeproc"
+require "csl/styles"
+
+module Citations
+  class InvalidKeyError < StandardError
+  end
+
+  class InvalidStyleError < StandardError
+  end
+
+  def self.cite_full(key, bib, style, format='text')
+    cp = CiteProc::Processor.new style: style, format: format
+    cp.import bib.to_citeproc
+    # need to convert latex special characters, like {\"o} to unicode
+    #bib[key].convert_latex
+    #puts bib[key]
+    #CiteProc.process(bib[key].to_citeproc, :style => style)
+    begin
+      cp.render(:bibliography, id: key).join("\n")
+    rescue TypeError => e
+      raise InvalidKeyError, "citation key '#{key}' not found"
+    rescue CSL::ParseError => e
+      raise InvalidStyleError, "citation style '#{style}' not found"
+    end
+  end
+
+  def self.cite_inline(key, bib, style)
+    "&nbsp;<span class='inline-citation'><span class='citation'>#{cite_full(key, bib, style,'html')}</span></span>"
+  end
+
+end

data/lib/middleman-citation/version.rb

@@ -1,7 +1,7 @@
 
 module Middleman
   module Citation
-    VERSION = "0.0.1"
+    VERSION = "0.3.0"
   end
 end
 

data/lib/middleman_extension.rb

@@ -0,0 +1 @@
+require 'middleman-citation'

data/middleman-citation.gemspec

@@ -22,9 +22,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_runtime_dependency "bibtex-ruby"
-  spec.add_runtime_dependency "citeproc-ruby", ["~> 0.0.6"]
+  spec.add_runtime_dependency "citeproc-ruby"
+  spec.add_runtime_dependency "csl-styles"
   spec.add_runtime_dependency "middleman-core", ["~> 3"]
-
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
 end

data/spec/cite_spec.rb

@@ -0,0 +1,47 @@
+require 'middleman-citation/citations'
+
+RSpec.describe Citations, "citations" do
+  require 'bibtex'
+  bib = BibTeX.open('fixtures/test.bib', :filter => :latex)
+
+  turkay_chi = "Turkay, Cagatay, J. Parulek, N. Reuter, and Helwig Hauser. 2011. “Interactive Visual Analysis of Temporal Cluster Structures.” Computer Graphics Forum 30 (3). Wiley-Blackwell: 711–20. doi:10.1111/j.1467-8659.2011.01920.x. http://dx.doi.org/10.1111/j.1467-8659.2011.01920.x."
+  turkay_ieee = "C. Turkay, J. Parulek, N. Reuter, and H. Hauser, “Interactive Visual Analysis of Temporal Cluster Structures,” Computer Graphics Forum, vol. 30, no. 3, pp. 711–720, Jun. 2011."
+  tw_chi = "Torsney-Weir, Thomas, Ahmed Saad, Torsten Möller, Britta Weber, Hans-Christian Hege, Jean-Marc Verbavatz, and Steven Bergner. 2011. “Tuner: Principled Parameter Finding for Image Segmentation Algorithms Using Visual Response Surface Exploration.” IEEE Transactions on Visualization and Computer Graphics 17 (12): 1892–1901."
+
+  context "long-form citation" do
+    it "gives a nice error for a bad style" do
+      expect {Citations::cite_full('Turkay:2011a', bib, 'crazyformat')}.to \
+        raise_error(Citations::InvalidStyleError, /crazyformat/)
+    end
+
+    it "gives a nice error for a bad key" do
+      expect {Citations::cite_full('notthere', bib, 'chicago-author-date')}.to \
+        raise_error(Citations::InvalidKeyError, /notthere/)
+    end
+
+    it "generates a proper chicago-style citation" do
+      full_cite = Citations::cite_full('Turkay:2011a', bib, 'chicago-author-date')
+      expect(full_cite).to eq(turkay_chi)
+    end
+
+    it "generates a proper ieee-style citation" do
+      full_cite = Citations::cite_full('Turkay:2011a', bib, 'ieee')
+      expect(full_cite).to eq(turkay_ieee)
+    end
+
+    it "properly handles accented characters" do
+      full_cite = Citations::cite_full('Torsney-Weir:2011', bib, 'chicago-author-date')
+      expect(full_cite).to eq(tw_chi)
+    end
+  end
+
+  context "short-form inline citation" do
+    it "generates a proper chicago-style citation" do
+      inline_cite = Citations::cite_inline('Turkay:2011a', bib, 'chicago-author-date')
+      expect(inline_cite).to have_tag("span", :with => {:class => 'inline-citation'}) do
+        with_tag('span', :text => turkay_chi, :with => {:class => 'citation'})
+      end
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,100 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-html-matchers
+  require 'rspec-html-matchers'
+  config.include RSpecHtmlMatchers
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: middleman-citation
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Thomas Torsney-Weir
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-22 00:00:00.000000000 Z
+date: 2015-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bibtex-ruby
@@ -28,58 +28,44 @@ dependencies:
   name: citeproc-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 0.0.6
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 0.0.6
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: middleman-core
+  name: csl-styles
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: middleman-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.3'
-  type: :development
+        version: '3'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.3'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: '3'
 description: |2
                          A middleman extension that gives helpers for
                          creating citations using citeproc
@@ -90,14 +76,23 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
+- .yardopts
 - Gemfile
 - Gemfile.lock
+- Guardfile
 - LICENSE
 - README.md
 - Rakefile
+- features/support/env.rb
+- fixtures/test.bib
 - lib/middleman-citation.rb
+- lib/middleman-citation/citations.rb
 - lib/middleman-citation/version.rb
+- lib/middleman_extension.rb
 - middleman-citation.gemspec
+- spec/cite_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/gabysbrain/middleman-citation
 licenses:
 - MIT
@@ -122,4 +117,8 @@ rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: Middleman extension for citeproc
-test_files: []
+test_files:
+- features/support/env.rb
+- spec/cite_spec.rb
+- spec/spec_helper.rb
+has_rdoc: