middleman-bibtex 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 199ce7be117cd42b0280729cb23677e30b125fd8
-  data.tar.gz: 4bd445d96f1a1797a95d2a513f143144c2a1fe93
+  metadata.gz: b4b5e1fa54ee27f412ca9b43dc3800a1c37dcb6c
+  data.tar.gz: e8a92352f7159a6c57745ce1f546fcf9e6b88a72
 SHA512:
-  metadata.gz: 7c0559a190ea39f4aac5f3268af9d94dcbe1cc6c9e0598a91f365aa497d1a4b876827d55fee801176b29c5b67c407e65b036f2789785d6eb34c72888b2cdb3eb
-  data.tar.gz: 68bdf0aaa51d4f699b0e9a6181fd118939ef686e3d409a5a2caba4a2b3f5f8cc3c8fa69c4a4fd2eb7f9337b8ac6ef42b6a049dc81672007e77888a4de1f8ee1c
+  metadata.gz: ff1fbe4be96c40e143794bd755e0115548653f2c0d85df77eac7c6c5cef9b29c2f76a7fc2d1a61d1c6e2dca2e6fd8163e07ae50fb4c7e5fd8c9cac9c12b67b44
+  data.tar.gz: 4861efc22d8392e9e1901195f23eedf6c5389e9d7d7702fa804e5877f8a65562d4fa79385b9231328967323b6f993a0dc5530590b291e69f96e709843188a63b

data/README.md

@@ -1,39 +1,44 @@
 # Middleman-bibtex
 
 An extension for the [Middleman](http://middlemanapp.com/) static
-site generator for formating BibTeX bibliographies.  This is a fork
-of the extension
+site generator for formating BibTeX bibliographies.  This is a fork of
 [middleman-citation](https://github.com/gabysbrain/middleman-citation)
 which offers similar functionailty.
 
-An example of a Middleman template using this plugin is available at
+An example of a Middleman site using this plugin can be found at
 <http://soliton.vm.bytemark.co.uk/pub/jjg/en/mathematics/papers/>.
 
 ## Installation
 
-Add this line to your Gemfile:
+If using version 4 or higher Middleman then add
 
-    gem 'middleman-bibtex'
+	gem 'middleman-bibtex'
 
-And then execute:
+to your Gemfile; for Middleman versions 3.* then instead use
 
-    $ bundle install
+	gem 'middleman-bibtex', '< 0.3'
+
+then execute
+
+    bundle install
 
 Or install it yourself as:
 
-    $ gem install middleman-bibtex
+    gem install middleman-bibtex
 
 ## Configuration
 
 In your `config.rb` file for your site add:
 
-    require 'middleman-bibtex'
+```ruby
+require 'middleman-bibtex'
 
-    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
+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
 
@@ -49,6 +54,18 @@ templates.
   `citations_search`, return a formatted string the citation according to
   how the `style` and `format` options were set.
 
+Typical template:
+
+```html+erb
+<ul>
+  <% citations_search(nil).each do |key|  %>
+  <li id="<%= key %>">
+    <%= citation(key) %>
+  </li>
+  <% end %>
+</ul>
+```
+
 For extra control on the output, one can use:
 
 * `citation_entry(key)`: Return the unformatted entry (a hash)
@@ -58,20 +75,25 @@ For extra control on the output, one can use:
 
 In fact the `citation` method is implemented using these:
 
-    def citation(key)
-      citation_formatted(citation_entry(key))
-    end
+```ruby
+def citation(key)
+  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_html = citation_formatted(entry)
-    unless (doi_url = entry['URL']).nil? then
-      doi_link = format('(%s)', link_to('doi', doi_url))
-    end
-    [entry_html, doi_link].compact.join(' ')
+```ruby
+entry = citation_entry(key)
+entry_html = citation_formatted(entry)
+unless (doi_url = entry['URL']).nil? then
+  doi_link = format('(%s)', link_to('doi', doi_url))
+end
+[entry_html, doi_link].compact.join(' ')
+```
 
 [![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)
+[![Dependency Status](https://dependencyci.com/github/jjgreen/middleman-bibtex/badge)](https://dependencyci.com/github/jjgreen/middleman-bibtex)

data/lib/middleman-bibtex/version.rb

@@ -1,6 +1,6 @@
 module Middleman
   module Bibtex
-    VERSION = '0.3.0'
+    VERSION = '0.3.1'
     class KeyNotFound < RuntimeError ; end
   end
 end

data/middleman-bibtex.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
                        a fork of the middleman-citation extension.
                        EOF
   spec.summary       = %q{Middleman extension for BibTeX bibliographies}
-  spec.homepage      = 'https://github.com/jjgreen/middleman-bibtex'
+  spec.homepage      = 'https://gitlab.com/jjg/middleman-bibtex'
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files`.split($/)
@@ -27,5 +27,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'capybara'
   spec.add_development_dependency 'middleman', ['~> 4.0']
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: middleman-bibtex
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - J. J. Green
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-09 00:00:00.000000000 Z
+date: 2018-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bibtex-ruby
@@ -94,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  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'
 - !ruby/object:Gem::Dependency
   name: middleman
   requirement: !ruby/object:Gem::Requirement
@@ -133,7 +147,7 @@ files:
 - spec/fixtures/test.bib
 - spec/integration_spec.rb
 - spec/spec_helper.rb
-homepage: https://github.com/jjgreen/middleman-bibtex
+homepage: https://gitlab.com/jjg/middleman-bibtex
 licenses:
 - MIT
 metadata: {}
@@ -153,7 +167,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.5.2.1
 signing_key: 
 specification_version: 4
 summary: Middleman extension for BibTeX bibliographies