dblpbib 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 7b3810efcf6713bb0758cd8ac3c4c690bbb2c9da
4
+ data.tar.gz: c25c316ddb0acd1be78fe5ad897a43ea475c5b8a
5
+ SHA512:
6
+ metadata.gz: 6774a385b121321264f009dc9585fee7624bab25b0e21634aa9ca58bac6bbe8788fa0a5d6cded650eba6ee72b8adfd6d111ffd5b5bf4edb7caff0346fc665e3a
7
+ data.tar.gz: db38a89cf9a1b90880ef4137a1c01bf033d393b0ab84d58e40296bb1abfa404861d7d6cbab5c0714f608a37191ea284a8e6e6e5c6727e0d72454ef88ddedf088
data/.gitignore ADDED
@@ -0,0 +1,10 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
10
+ .idea
data/.idea/vcs.xml ADDED
@@ -0,0 +1,6 @@
1
+ <?xml version="1.0" encoding="UTF-8"?>
2
+ <project version="4">
3
+ <component name="VcsDirectoryMappings">
4
+ <mapping directory="$PROJECT_DIR$" vcs="Git" />
5
+ </component>
6
+ </project>
data/.rspec ADDED
@@ -0,0 +1,2 @@
1
+ --format documentation
2
+ --color
data/.travis.yml ADDED
@@ -0,0 +1,5 @@
1
+ sudo: false
2
+ language: ruby
3
+ rvm:
4
+ - 2.3.1
5
+ before_install: gem install bundler -v 1.13.6
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in dblpbib.gemspec
4
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2016 PJK
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,37 @@
1
+ # DBLPBib
2
+
3
+ Automatically create bibliographies for BibTeX [DBLP](http://dblp2.uni-trier.de/) references. Pretty much like [this](https://github.com/grundprinzip/dblp), but actually works and is as sane as LaTeX permits.
4
+
5
+ This utility enables me (and possibly you, no promises) to use DBLP references (e.g. `\cite{DBLP:books/sp/Gratzer16}`) without having to download the BibTeX entries. Just use them as usual and run `dblpbib p_np_proof.tex`, `dblp.bib` will be created in the directory.
6
+
7
+ ## Installation
8
+
9
+ $ gem install dblpbib
10
+
11
+ ## Usage
12
+
13
+ $ dblpbib -h
14
+
15
+ ## `latexmk` integration
16
+
17
+ Stick this in your `.latexmkrc`:
18
+
19
+ ```perl
20
+ $pdflatex = "dblpbib %S && pdflatex -synctex=1 -halt-on-error %O %S";
21
+ ```
22
+
23
+ ## Development
24
+
25
+ After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
26
+
27
+ To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
28
+
29
+ ## Contributing
30
+
31
+ Bug reports and pull requests are welcome on GitHub at https://github.com/PJK/dblpbib.
32
+
33
+
34
+ ## License
35
+
36
+ The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
37
+
data/Rakefile ADDED
@@ -0,0 +1,6 @@
1
+ require "bundler/gem_tasks"
2
+ require "rspec/core/rake_task"
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+
6
+ task :default => :spec
data/bin/console ADDED
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "dblpbib"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start
data/bin/setup ADDED
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
data/dblpbib.gemspec ADDED
@@ -0,0 +1,29 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'dblpbib/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "dblpbib"
8
+ spec.version = Dblpbib::VERSION
9
+ spec.authors = ["PJK"]
10
+ spec.email = ["me@pavelkalvoda.com"]
11
+
12
+ spec.summary = Dblpbib::DESCRIPTION
13
+ spec.description = %q{Automatically create bibliographies for BibTeX DBLP references. This utility is meant to be invoked during LaTeX build. It scans the documents for DBLP references and compiles a cached .bib file. Correctly handles crosslinking. Entries can be overridden. Other bibliography sources can still be included.}
14
+ spec.homepage = "https://github.com/PJK/dblpbib"
15
+ spec.license = "MIT"
16
+
17
+ spec.files = `git ls-files -z`.split("\x0").reject do |f|
18
+ f.match(%r{^(test|spec|features)/})
19
+ end
20
+ spec.bindir = "exe"
21
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
22
+ spec.require_paths = ["lib"]
23
+
24
+ spec.add_development_dependency "bundler", "~> 1.13"
25
+ spec.add_development_dependency "rake", "~> 10.0"
26
+ spec.add_development_dependency "rspec", "~> 3.0"
27
+
28
+ spec.add_dependency "commander"
29
+ end
data/exe/dblpbib ADDED
@@ -0,0 +1,77 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require 'rubygems'
4
+
5
+ require 'commander'
6
+ require 'fileutils'
7
+ require 'open-uri'
8
+
9
+ require 'dblpbib/version'
10
+
11
+ class DBLPCLI
12
+ include Commander::Methods
13
+
14
+ def shared_options(command)
15
+ command.option '--cache CACHE_DIR', String, 'Cache directory. Single .bib entries are stored here'
16
+ command.option '--output OUTPUT.bib', String, 'Output bibliography. "dblp.bib" by default'
17
+ end
18
+
19
+ def default_options(options)
20
+ options.default cache: '.dblp'
21
+ options.default output: 'dblp.bib'
22
+ end
23
+
24
+ def get_keys(file)
25
+ IO.read(file).scan(/\\cite\{DBLP:([^}]+)\}/).map(&:pop)
26
+ end
27
+
28
+ def bib_path(cache, key)
29
+ File.join(cache, key + '.bib')
30
+ end
31
+
32
+ def run
33
+ program :name, 'DBLP BibTeX utility'
34
+ program :description, Dblpbib::DESCRIPTION
35
+ program :version, Dblpbib::VERSION
36
+
37
+ command :build do |command|
38
+ command.syntax = 'INPUT.tex'
39
+ command.description = 'Fetches references to cache and compiles them'
40
+ shared_options(command)
41
+
42
+ command.action do |args, options|
43
+ default_options(options)
44
+ FileUtils.mkdir_p(options.cache)
45
+
46
+ keys = get_keys(args[0])
47
+
48
+ keys.each do |key|
49
+ path = bib_path(options.cache, key)
50
+
51
+ unless File.exist?(path)
52
+ puts "Fetching #{key}"
53
+
54
+ FileUtils.mkdir_p(File.dirname(path))
55
+ File.write(path, open("http://dblp.uni-trier.de/rec/bib1/#{key}.bib").read)
56
+
57
+ # TODO: crossrefs! When I got here I actually realized the 'standard' output is perfectly OK for most situations...
58
+ end
59
+ end
60
+
61
+ File.open(options.output, 'w') do |output|
62
+ output.truncate(0)
63
+
64
+ keys.each do |key|
65
+ output.write(File.read(bib_path(options.cache, key)))
66
+ end
67
+ end
68
+ end
69
+ end
70
+
71
+ default_command :build
72
+
73
+ run!
74
+ end
75
+ end
76
+
77
+ DBLPCLI.new.run
@@ -0,0 +1,4 @@
1
+ module Dblpbib
2
+ VERSION = "0.1.0"
3
+ DESCRIPTION = %q{Automatically create bibliographies for BibTeX DBLP references.}
4
+ end
data/lib/dblpbib.rb ADDED
@@ -0,0 +1,5 @@
1
+ require "dblpbib/version"
2
+
3
+ module Dblpbib
4
+ # Your code goes here...
5
+ end
metadata ADDED
@@ -0,0 +1,118 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: dblpbib
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - PJK
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2016-11-01 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: bundler
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '1.13'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.13'
27
+ - !ruby/object:Gem::Dependency
28
+ name: rake
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '10.0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '10.0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rspec
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '3.0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '3.0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: commander
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - ">="
60
+ - !ruby/object:Gem::Version
61
+ version: '0'
62
+ type: :runtime
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - ">="
67
+ - !ruby/object:Gem::Version
68
+ version: '0'
69
+ description: Automatically create bibliographies for BibTeX DBLP references. This
70
+ utility is meant to be invoked during LaTeX build. It scans the documents for DBLP
71
+ references and compiles a cached .bib file. Correctly handles crosslinking. Entries
72
+ can be overridden. Other bibliography sources can still be included.
73
+ email:
74
+ - me@pavelkalvoda.com
75
+ executables:
76
+ - dblpbib
77
+ extensions: []
78
+ extra_rdoc_files: []
79
+ files:
80
+ - ".gitignore"
81
+ - ".idea/vcs.xml"
82
+ - ".rspec"
83
+ - ".travis.yml"
84
+ - Gemfile
85
+ - LICENSE.txt
86
+ - README.md
87
+ - Rakefile
88
+ - bin/console
89
+ - bin/setup
90
+ - dblpbib.gemspec
91
+ - exe/dblpbib
92
+ - lib/dblpbib.rb
93
+ - lib/dblpbib/version.rb
94
+ homepage: https://github.com/PJK/dblpbib
95
+ licenses:
96
+ - MIT
97
+ metadata: {}
98
+ post_install_message:
99
+ rdoc_options: []
100
+ require_paths:
101
+ - lib
102
+ required_ruby_version: !ruby/object:Gem::Requirement
103
+ requirements:
104
+ - - ">="
105
+ - !ruby/object:Gem::Version
106
+ version: '0'
107
+ required_rubygems_version: !ruby/object:Gem::Requirement
108
+ requirements:
109
+ - - ">="
110
+ - !ruby/object:Gem::Version
111
+ version: '0'
112
+ requirements: []
113
+ rubyforge_project:
114
+ rubygems_version: 2.5.1
115
+ signing_key:
116
+ specification_version: 4
117
+ summary: Automatically create bibliographies for BibTeX DBLP references.
118
+ test_files: []