middleman-citation 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f55657e35c57b39ea3cf99d18502348145e533fc
+  data.tar.gz: de38334ee3122e3becfae88985479d610d016b57
+SHA512:
+  metadata.gz: 0748e82b0a09b4dd9378beb55fb924bc5b142b76260dab2ed53230ea13541399fb41a6961f57255d6824343e554bee272a198dcc9bb06bdf1f8b916dee456e1e
+  data.tar.gz: 72347790ff25cbecd205dc9eadddd17d6bf8fbab77585a9b5a7b2afd60c1a688a07b46d4b5b27eae2986f61adb65edc1d2c1c6f212220de1b4f9f5dead80c548

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,86 @@
+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)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  middleman-citation!
+  rake

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,56 @@
+# 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 |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
+    end
+
+## Usage
+
+This adds the following helper methods you can use in your Middleman
+templates.
+
+
+
+* `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`.
+
+## 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-citation/version.rb

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

data/lib/middleman-citation.rb

@@ -0,0 +1,51 @@
+require "middleman-citation/version"
+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"
+  
+    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
+    end
+  
+    helpers do
+      # Given a BibTeX citation return a formatted string according to
+      # how the setting of the style option
+      # 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)
+      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+.
+      # 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
+        end
+        results.sort! {|x,y| y.year.to_i-x.year.to_i}
+        results.map {|x| x.key}
+      end
+    end
+  end
+end
+
+::Middleman::Extensions.register(:citation, Middleman::CitationExtension)
+

data/middleman-citation.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'middleman-citation/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "middleman-citation"
+  spec.version       = Middleman::Citation::VERSION
+  spec.authors       = ["Thomas Torsney-Weir"]
+  spec.email         = ["torsneyt@gmail.com"]
+  spec.description   = <<-EOF 
+                       A middleman extension that gives helpers for
+                       creating citations using citeproc
+                       EOF
+  spec.summary       = %q{Middleman extension for citeproc}
+  spec.homepage      = "https://github.com/gabysbrain/middleman-citation"
+  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"
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: middleman-citation
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Thomas Torsney-Weir
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-22 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'
+description: |2
+                         A middleman extension that gives helpers for
+                         creating citations using citeproc
+email:
+- torsneyt@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/middleman-citation.rb
+- lib/middleman-citation/version.rb
+- middleman-citation.gemspec
+homepage: https://github.com/gabysbrain/middleman-citation
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Middleman extension for citeproc
+test_files: []