nanoc-bibtex 0.0.3 → 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: acde29f2f7793c1d99c26f544d6b3bcd614c773d
+  data.tar.gz: ca204dc9ad0ce0f9d74fc61a8fdc65799139b5ce
+SHA512:
+  metadata.gz: 0f943035bf64f32d484ff448c0f803cf50c2285e64878b90b5767f5be08b01d9581f49604c4a773250f1bf47e81c6a5ec59c6270d8f6143a4669ed2c249fdab0
+  data.tar.gz: d2cdbdbd726dbeacec1ddb17de309e3a1daff1f9613b2dd7861a237ea4d831fe8eb5e95b3985ca3f5672ae730a25d46554c8fc5ed03e6afa6e843fa275328a7c

data/Gemfile

@@ -0,0 +1,10 @@
+source 'http://rubygems.org'
+
+gem 'nanoc',        '~> 4.0'
+gem 'bibtex-ruby',  '~> 4.1'
+gem 'latex-decode', '~> 0.2'
+
+group :development do
+  gem 'bundler',    '~> 1.0'
+  gem 'jeweler',    '~> 2.0'
+end

data/Gemfile.lock

@@ -0,0 +1,70 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.4.0)
+    bibtex-ruby (4.1.0)
+      latex-decode (~> 0.0)
+    builder (3.2.2)
+    colored (1.2)
+    cri (2.7.0)
+      colored (~> 1.2)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    faraday (0.9.2)
+      multipart-post (>= 1.2, < 3)
+    git (1.2.9.1)
+    github_api (0.13.1)
+      addressable (~> 2.4.0)
+      descendants_tracker (~> 0.0.4)
+      faraday (~> 0.8, < 0.10)
+      hashie (>= 3.4)
+      multi_json (>= 1.7.5, < 2.0)
+      oauth2
+    hashie (3.4.3)
+    highline (1.7.8)
+    jeweler (2.0.1)
+      builder
+      bundler (>= 1.0)
+      git (>= 1.2.5)
+      github_api
+      highline (>= 1.6.15)
+      nokogiri (>= 1.5.10)
+      rake
+      rdoc
+    json (1.8.3)
+    jwt (1.5.2)
+    latex-decode (0.2.2)
+      unicode (~> 0.4)
+    mini_portile2 (2.0.0)
+    multi_json (1.11.2)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    nanoc (4.1.0)
+      cri (~> 2.3)
+    nokogiri (1.6.7.1)
+      mini_portile2 (~> 2.0.0.rc2)
+    oauth2 (1.0.0)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 1.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    rack (1.6.4)
+    rake (10.4.2)
+    rdoc (4.2.1)
+      json (~> 1.4)
+    thread_safe (0.3.5)
+    unicode (0.4.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bibtex-ruby (~> 4.1)
+  bundler (~> 1.0)
+  jeweler (~> 2.0)
+  latex-decode (~> 0.2)
+  nanoc (~> 4.0)
+
+BUNDLED WITH
+   1.11.2

data/README.md

@@ -0,0 +1,39 @@
+## About
+Thanks to this gem,
+you can use [BibTeX](http://www.bibtex.org/Format/) files
+as a data source for the static site compiler [nanoc](https://github.com/ddfreyne/nanoc).
+
+## Installation
+First, install the `nanoc-bibtex` gem:
+```bash
+$ gem install nanoc-bibtex
+```
+
+Then, load the data source on start by including this line in `lib/default.rb`:
+```ruby
+require 'nanoc/data_sources/bibtex_data_source'
+```
+
+## Usage
+Modify your `config.yaml` to include your data source:
+```yaml
+data_sources:
+  -
+    type: filesystem_unified
+    items_root: /
+    layouts_root: /
+  -
+    type: bibtex
+    items_root: /publications
+    config:
+      path: assets/publications/
+      exclude:
+        - abstract
+```
+The above example configures your site with an additional `bibtex` data source.
+It will load the entries of each BibTeX file in the folder `assets/publications`
+as items whose path will be `/publications/{citation_key}`.
+
+The fields of each item will contain the values of the corresponding BibTeX entry.
+The raw contents of this item will be the BibTeX entry,
+excluding the `abstract` field. 

data/Rakefile

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  gem.name = "nanoc-bibtex"
+  gem.homepage = "http://github.com/RubenVerborgh/nanoc-bibtex"
+  gem.license = "MIT"
+  gem.summary = %Q{BibTeX data source for nanoc.}
+  gem.description = gem.summary
+  gem.email = "ruben@verborgh.org"
+  gem.authors = ["Ruben Verborgh"]
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+desc "Code coverage detail"
+task :simplecov do
+  ENV['COVERAGE'] = "true"
+  Rake::Task['test'].execute
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "nanoc-bibtex #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/nanoc/data_sources/bibtex_data_source.rb

@@ -1,25 +1,25 @@
 require 'bibtex'
 
-class BibtexDataSource < Nanoc3::DataSource
+class BibtexDataSource < Nanoc::DataSource
   identifier :bibtex
-  
+
   def up
     @files = Dir[@config[:path].sub(/\/?$/, '/*.bib')];
     @exclude = {}
     (@config[:exclude] || []).each { |value| @exclude[value] = true }
   end
-  
+
   def items
     @files.map do |file|
       entries = BibTeX.open(file)
       entries.map do |entry|
-        Nanoc3::Item.new to_bibtex(entry), extract_attributes(entry), entry.key
+        new_item to_bibtex(entry), extract_attributes(entry), "/#{entry.key}"
       end
     end.flatten!
   end
 
   def to_bibtex entry
-    contents = [ "@#{entry.type}{#{entry.key}," ]
+    contents = ["@#{entry.type}{#{entry.key},"]
     entry.each do |key, value|
       unless @exclude[key.to_s]
         if value =~ /^\d+$/ or (key == :month and value =~ /^[a-z]{1,3}$/)
@@ -32,10 +32,15 @@ class BibtexDataSource < Nanoc3::DataSource
     contents.push "}"
     contents.join "\n"
   end
-  
+
   def extract_attributes entry
-    attributes = { :key => entry.key }
-    entry.each { |key, value| attributes[key] = value.convert(:latex) }
+    entry = entry.convert :latex
+    attributes = {
+      :bibtex => entry,
+      :key    => entry.key,
+      :type   => entry.type,
+    }
+    entry.each { |key, value| attributes[key] = value }
     attributes
   end
 end

data/nanoc-bibtex.gemspec

@@ -0,0 +1,58 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: nanoc-bibtex 0.1.0 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "nanoc-bibtex"
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib"]
+  s.authors = ["Ruben Verborgh"]
+  s.date = "2015-12-29"
+  s.description = "BibTeX data source for nanoc."
+  s.email = "ruben@verborgh.org"
+  s.extra_rdoc_files = [
+    "README.md"
+  ]
+  s.files = [
+    "Gemfile",
+    "Gemfile.lock",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "lib/nanoc/data_sources/bibtex_data_source.rb",
+    "nanoc-bibtex.gemspec"
+  ]
+  s.homepage = "http://github.com/RubenVerborgh/nanoc-bibtex"
+  s.licenses = ["MIT"]
+  s.rubygems_version = "2.4.5.1"
+  s.summary = "BibTeX data source for nanoc."
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<nanoc>, ["~> 4.0"])
+      s.add_runtime_dependency(%q<bibtex-ruby>, ["~> 4.1"])
+      s.add_runtime_dependency(%q<latex-decode>, ["~> 0.2"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 2.0"])
+    else
+      s.add_dependency(%q<nanoc>, ["~> 4.0"])
+      s.add_dependency(%q<bibtex-ruby>, ["~> 4.1"])
+      s.add_dependency(%q<latex-decode>, ["~> 0.2"])
+      s.add_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_dependency(%q<jeweler>, ["~> 2.0"])
+    end
+  else
+    s.add_dependency(%q<nanoc>, ["~> 4.0"])
+    s.add_dependency(%q<bibtex-ruby>, ["~> 4.1"])
+    s.add_dependency(%q<latex-decode>, ["~> 0.2"])
+    s.add_dependency(%q<bundler>, ["~> 1.0"])
+    s.add_dependency(%q<jeweler>, ["~> 2.0"])
+  end
+end
+

metadata

@@ -1,95 +1,121 @@
 --- !ruby/object:Gem::Specification
 name: nanoc-bibtex
 version: !ruby/object:Gem::Version
-  version: 0.0.3
-  prerelease: 
+  version: 0.1.0
 platform: ruby
 authors:
 - Ruben Verborgh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-17 00:00:00.000000000 Z
+date: 2015-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nanoc
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: bibtex-ruby
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: '4.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: '4.1'
 - !ruby/object:Gem::Dependency
   name: latex-decode
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.12
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.12
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 description: BibTeX data source for nanoc.
-email:
-- ruben.verborgh@gmail.com
+email: ruben@verborgh.org
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
 files:
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- VERSION
 - lib/nanoc/data_sources/bibtex_data_source.rb
-homepage: http://rubygems.org/gems/nanoc-bibtex
-licenses: []
+- nanoc-bibtex.gemspec
+homepage: http://github.com/RubenVerborgh/nanoc-bibtex
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.4.5.1
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: BibTeX data source for nanoc.
 test_files: []
-has_rdoc: