middleman-bibtex 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4a9852d3435be7ec344a056458e76090c209c3f1
+  data.tar.gz: dfb09c8bf2546af9632b9cce6699e678726d6dcd
+SHA512:
+  metadata.gz: 0b261ab3a1434fb3c38ec78a023635a9aaa5037424a721ae67289edca4558dfc16e9afe24f0a07ca195cfa326282162bbbfb4ca3b254aa2a0e2b4c821e7b4dad
+  data.tar.gz: 44075978702c11c7a54a8cb3d599bbc62e38793a51f5573bd16cb056502d9128ba574b815ef87cc83873f17a5753f39415f8cfb4830e58a1594ef46695f40533

data/.gitignore

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

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,88 @@
+PATH
+  remote: .
+  specs:
+    middleman-citation (0.0.1)
+      bibtex-ruby
+      citeproc-ruby (~> 0.0.6)
+      middleman-core (~> 3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.1.5)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    bibtex-ruby (4.0.3)
+      latex-decode (~> 0.0)
+    celluloid (0.15.2)
+      timers (~> 1.1.0)
+    citeproc-ruby (0.0.6)
+      logging (~> 1.5)
+      nokogiri (~> 1.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)
+      unicode (~> 0.4)
+    listen (2.7.9)
+      celluloid (>= 0.15.2)
+      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)
+      bundler (~> 1.1)
+      erubis
+      hooks (~> 0.3)
+      i18n (~> 0.6.9)
+      listen (>= 2.7.9, < 3.0)
+      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)
+      i18n (~> 0.6, >= 0.6.7)
+      padrino-support (= 0.12.3)
+      tilt (~> 1.4.1)
+    padrino-support (0.12.3)
+      activesupport (>= 3.1)
+    rack (1.5.2)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rake (10.3.2)
+    rb-fsevent (0.9.4)
+    rb-inotify (0.9.5)
+      ffi (>= 0.5.0)
+    thor (0.19.1)
+    thread_safe (0.3.4)
+    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)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  middleman-citation!
+  rake
+  yard

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Tom Torsney-Weir
+
+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,81 @@
+# Middleman-citation
+
+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 example of a Middleman template using this plugin is available at
+<https://github.com/gabysbrain/website/blob/master/source/cv.html.slim>.
+
+## Installation
+
+Add this line to your Gemfile:
+
+    gem 'middleman-citation'
+
+And then execute:
+
+    $ bundle install
+
+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 |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
+
+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.
+
+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
+
+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

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/middleman-bibtex/version.rb

@@ -0,0 +1,5 @@
+module Middleman
+  module Bibtex
+    VERSION = '0.1.0'
+  end
+end

data/lib/middleman-bibtex.rb

@@ -0,0 +1,62 @@
+require 'middleman-bibtex/version'
+require 'middleman-core'
+require 'bibtex'
+require 'citeproc'
+
+module Middleman
+
+  class BibtexExtension < Middleman::Extension
+
+    option :bibtex, nil, 'Path to the bibtex file'
+    option :style, 'chicago-author-date', 'BibTeX style'
+    option :format, 'html', 'Bibliography format'
+
+    def initialize(app, options_hash={}, &block)
+      super
+      app.set(:bibtex,      BibTeX.open(options.bibtex))
+      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)
+      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
+      end
+
+    end
+  end
+end
+
+::Middleman::Extensions.register(:bibtex, Middleman::BibtexExtension)

data/middleman-bibtex.gemspec

@@ -0,0 +1,31 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'middleman-bibtex/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'middleman-bibtex'
+  spec.version       = Middleman::Bibtex::VERSION
+  spec.authors       = ['J. J. Green']
+  spec.email         = ['j.j.green@gmx.co.uk']
+  spec.description   = <<-EOF
+                       A middleman extension that gives helpers for
+                       creating bibtex citation, a fork from the
+                       middleman-citation extension.
+                       EOF
+  spec.summary       = %q{Middleman extension for bibtex bibliographies}
+  spec.homepage      = 'https://github.com/jjgreen/middleman-bibtex'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'bibtex-ruby'
+  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 'rake'
+  spec.add_development_dependency 'yard'
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: middleman-bibtex
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- J. J. Green
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bibtex-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: citeproc-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.6
+- !ruby/object:Gem::Dependency
+  name: middleman-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  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'
+- !ruby/object:Gem::Dependency
+  name: yard
+  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'
+description: |2
+                         A middleman extension that gives helpers for
+                         creating bibtex citation, a fork from the
+                         middleman-citation extension.
+email:
+- j.j.green@gmx.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/middleman-bibtex.rb
+- lib/middleman-bibtex/version.rb
+- middleman-bibtex.gemspec
+homepage: https://github.com/jjgreen/middleman-bibtex
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Middleman extension for bibtex bibliographies
+test_files: []