nanoc-bibtex 0.0.1 → 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3164093bb8b8ed49e89af0dfb4b8a87a57465155c69dd4207acd3e85431f2397
+  data.tar.gz: a0e0dc8ea0b71c8eeae388c3c55848aa1480f03ce9f6f6684c0db2beda8367d1
+SHA512:
+  metadata.gz: 1c017733e93674292a547bc5cd54cbd9ad77c2ef8a43418aa5611c5534a1ca96e609df4e0d15e1679fe81aded49a46b9b944822e9e77759a7b06166a34c894cd
+  data.tar.gz: 34a34a2d03940ef9c45465d92d300c0c3f75051a8a23ba5aee1ce4c2b37a8f94af320c51fff3e87ec3574a52b88e1a7f14c7be2126ebd11a5333f86509b24ed1

data/Gemfile

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

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 @@
+1.0.1

data/lib/nanoc/data_sources/bibtex_data_source.rb

@@ -1,28 +1,31 @@
 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|
+      stat = File.stat file
+      file_checksum = stat.size.to_s + '-' + stat.mtime.to_i.to_s
       entries = BibTeX.open(file)
       entries.map do |entry|
-        Nanoc3::Item.new to_bibtex(entry), extract_attributes(entry), entry.key
+        new_item lambda { to_bibtex entry }, lambda { extract_attributes entry },
+                 '/' + entry.key, checksum_data: file_checksum
       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]
-        unless value =~ /\s|\{|\}|"|,|:/
+        if value =~ /^\d+$/ or (key == :month and value =~ /^[a-z]{1,3}$/)
           contents.push "  #{key} = #{value},"
         else
           contents.push "  #{key} = {#{value}},"
@@ -32,10 +35,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) { |key| key != :url }
+    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,51 @@
+# 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 1.0.1 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "nanoc-bibtex".freeze
+  s.version = "1.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib".freeze]
+  s.authors = ["Ruben Verborgh".freeze]
+  s.date = "2020-09-17"
+  s.description = "BibTeX data source for nanoc.".freeze
+  s.email = "ruben@verborgh.org".freeze
+  s.extra_rdoc_files = [
+    "README.md"
+  ]
+  s.files = [
+    "Gemfile",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "lib/nanoc/data_sources/bibtex_data_source.rb",
+    "nanoc-bibtex.gemspec"
+  ]
+  s.homepage = "http://github.com/RubenVerborgh/nanoc-bibtex".freeze
+  s.licenses = ["MIT".freeze]
+  s.rubygems_version = "3.1.2".freeze
+  s.summary = "BibTeX data source for nanoc.".freeze
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+  end
+
+  if s.respond_to? :add_runtime_dependency then
+    s.add_runtime_dependency(%q<nanoc>.freeze, ["~> 4.2"])
+    s.add_runtime_dependency(%q<bibtex-ruby>.freeze, ["~> 5.1"])
+    s.add_runtime_dependency(%q<latex-decode>.freeze, ["~> 0.2"])
+    s.add_development_dependency(%q<bundler>.freeze, ["~> 2.0"])
+    s.add_development_dependency(%q<jeweler>.freeze, ["~> 2.0"])
+  else
+    s.add_dependency(%q<nanoc>.freeze, ["~> 4.2"])
+    s.add_dependency(%q<bibtex-ruby>.freeze, ["~> 5.1"])
+    s.add_dependency(%q<latex-decode>.freeze, ["~> 0.2"])
+    s.add_dependency(%q<bundler>.freeze, ["~> 2.0"])
+    s.add_dependency(%q<jeweler>.freeze, ["~> 2.0"])
+  end
+end
+

metadata

@@ -1,79 +1,119 @@
 --- !ruby/object:Gem::Specification
 name: nanoc-bibtex
 version: !ruby/object:Gem::Version
-  version: 0.0.1
-  prerelease: 
+  version: 1.0.1
 platform: ruby
 authors:
 - Ruben Verborgh
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2012-06-20 00:00:00.000000000Z
+date: 2020-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nanoc
-  requirement: &2161614120 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '4.2'
   type: :runtime
   prerelease: false
-  version_requirements: *2161614120
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
 - !ruby/object:Gem::Dependency
   name: bibtex-ruby
-  requirement: &2161608060 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: '5.1'
   type: :runtime
   prerelease: false
-  version_requirements: *2161608060
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
 - !ruby/object:Gem::Dependency
   name: latex-decode
-  requirement: &2161607100 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.12
+        version: '0.2'
   type: :runtime
   prerelease: false
-  version_requirements: *2161607100
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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'
+- !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
+- README.md
+- Rakefile
+- VERSION
 - lib/nanoc/data_sources/bibtex_data_source.rb
-homepage: http://rubygems.org/gems/nanoc-bibtex
-licenses: []
-post_install_message: 
+- 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.10
-signing_key: 
-specification_version: 3
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
 summary: BibTeX data source for nanoc.
 test_files: []