bibmarkdown 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 397abd2bd0e065e1c3402a3103e0febb7054df63
+  data.tar.gz: 4110f6df3c21c0bfca0f0da0fe9ba5b41f281d36
+SHA512:
+  metadata.gz: 2d6daf22e4101cf9738839346c0085280971b955e3606cf7530fdbfac7644e185bef23bbe59203c727421eb29b4bd2593465433e9a5070d0760f84ac5e76ab48
+  data.tar.gz: e599d213d2ee38aea9a4890267c443d838df048bb9fa1907374808cb217295881c9af62b23335cc24c796e324e7fc705b4befe635b28be926d28cbf2203b77c6

data/Gemfile

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+
+gem "citeproc-ruby"
+gem "csl-styles"
+
+group :development do
+  gem "bundler", "~> 1.0"
+  gem "juwelier", "~> 2.1.0"
+end

data/LICENSE.md

@@ -0,0 +1,9 @@
+# License
+The MIT License (MIT)
+Copyright ©2016 Ruben Verborgh
+
+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,72 @@
+## BibMarkown
+BibMarkdown is a Ruby pre-processor for Markdown,
+adding support for citations
+realized by a BibTex back-end.
+
+## Syntax and result
+This Markdown snippet
+```markdown
+The way _clients_ and _servers_ exchange information on the Web
+is modeled by the [REST architectural style](cite:citesAsAuthority REST).
+```
+will be processed into the following Markdown snippet:
+```markdown
+The way _clients_ and _servers_ exchange information on the Web
+is modeled by the <a rel="http://purl.org/spar/cito/citesAsAuthority" href="http://www.ics.uci.edu/~fielding/pubs/dissertation/top.htm">REST architectural style</a> <a class="reference" href="#ref-1">[1]</a>.
+```
+
+This Markdown snippet
+```markdown
+The way _clients_ and _servers_ exchange information on the Web
+is modeled by the REST architectural style [](cite:citesAsAuthority REST).
+```
+will be processed into the following Markdown snippet:
+```markdown
+The way _clients_ and _servers_ exchange information on the Web
+is modeled by the REST architectural style <a class="reference" href="#ref-1">[1]</a>.
+```
+
+Furthermore, at the end of the Markdown document,
+a _References_ section will be added:
+```html
+<h2 id="references">References</h2>
+<dl class="references">
+  <dt id="ref-1">[1]</dt>
+  <dd>Fielding, R.T., 2000. Architectural Styles and the Design of Network-based Software Architectures (PhD thesis). University of California.</dd>
+</dl>
+```
+
+## Usage
+```ruby
+require 'bibmarkdown'
+require 'bibtex'
+require 'csl/styles'
+
+content = <<-md
+The way _clients_ and _servers_ exchange information on the Web
+is modeled by the [REST architectural style](cite:citesAsAuthority REST).
+md
+
+bibliography = <<-bib
+@phdthesis{REST,
+  author = {Roy Thomas Fielding},
+  title = {Architectural Styles and the Design of Network-based Software Architectures},
+  school = {University of California},
+  year = 2000,
+  url = {http://www.ics.uci.edu/~fielding/pubs/dissertation/top.htm},
+}
+bib
+
+entries = BibTeX.parse(bibliography).entries
+document = BibMarkdown::Document.new content,
+             entries: entries, style: 'elsevier-harvard'
+puts document.to_markdown
+```
+
+## Related work
+This library was inspired by [Pieter Colpaert](http://pieter.pm/)'s
+[jekyll-refs](https://github.com/pietercolpaert/jekyll-refs),
+which has some nice [CSS suggestions](https://github.com/pietercolpaert/jekyll-refs#using-css-styles-to-mark-up-the-citations) as well.
+
+## License
+Copyright ©2016 Ruben Verborgh – MIT License

data/Rakefile

@@ -0,0 +1,23 @@
+# 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 'juwelier'
+Juwelier::Tasks.new do |gem|
+  gem.name = "bibmarkdown"
+  gem.homepage = "http://github.com/RubenVerborgh/bibmarkdown"
+  gem.license = "MIT"
+  gem.summary = "Markdown with BibTeX citations."
+  gem.email = "ruben@verborgh.org"
+  gem.authors = ["Ruben Verborgh"]
+end
+Juwelier::RubygemsDotOrgTasks.new

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/lib/bibmarkdown/document.rb

@@ -0,0 +1,89 @@
+require 'cgi'
+require 'citeproc'
+require 'csl/styles'
+
+module BibMarkdown
+  class Document
+    def initialize(source, options)
+      @source = source
+      @entries = options[:entries]
+      @style = options[:style]
+    end
+
+    def to_markdown
+      reference_ids = {}
+
+      # Replace all citations by links
+      markdown = @source.gsub %r{\[([^\]]*)\]\(cite:(\w+)\s+([^\)]+)\)} do |match|
+        html = $1; rel = $2; key = $3
+
+        # Look up or assign reference ID
+        if reference_ids.has_key? key
+          reference_id = reference_ids[key]
+        else
+          reference_id = reference_ids[key] = reference_ids.length + 1
+        end
+
+        # Look up citation and its URL
+        entry = @entries[key]
+        raise "Failed to generate references: entry '#{key}' does not exist." unless entry
+        url = entry[:url] || ''
+
+        # Create the reference
+        reflink = create_link "[#{reference_id}]", "#ref-#{reference_id}", class: 'reference'
+
+        # If the text is empty, just output the reference
+        if html.empty?
+          reflink
+        # If there is no URL, just output the text with the reference
+        elsif url.empty?
+          "#{html} #{reflink}"
+        # Otherwise, output the link and the reference
+        else
+          "#{create_link html, url, rel: 'http://purl.org/spar/cito/' + rel} #{reflink}"
+        end
+      end
+
+      # Append the reference list to the text
+      "#{markdown}\n\n#{references_html reference_ids}".rstrip
+    end
+
+    protected
+    def h text
+      CGI::escapeHTML(text || '')
+    end
+
+    def create_link html, url, attrs = {}
+      attrs[:href] = url
+      attrs = attrs.map { |attr, value| %Q{#{attr}="#{h value}"} }
+      %Q{<a #{attrs.join ' '}>#{html}</a>}
+    end
+
+    def references_html reference_ids
+      if reference_ids.empty?
+        ''
+      else
+        html =  %Q{<h2 id="references">References</h2>\n}
+        html += %Q{<dl class="references">\n}
+        reference_ids.each do |key, id|
+          html += %Q{  <dt id="ref-#{id}">[#{id}]</dt>\n}
+          html += %Q{  <dd>#{reference_html key}</dd>\n}
+        end
+        html += %Q{</dl>\n}
+      end
+    end
+
+    def reference_html key
+      # Render reference
+      processor = CiteProc::Processor.new style: @style, format: 'html'
+      processor << @entries[key].to_citeproc
+      citations = processor.render :bibliography, id: key
+      citation = citations.first
+
+      # Replace URLs by links
+      citation.gsub %r{https?://[^ ]+[^ .]} do |match|
+        create_link h(match), match
+      end
+    end
+  end
+end

data/lib/bibmarkdown.rb

@@ -0,0 +1 @@
+require 'bibmarkdown/document'

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: bibmarkdown
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Ruben Verborgh
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-11-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: citeproc-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: csl-styles
+  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: 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: juwelier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+description: 
+email: ruben@verborgh.org
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.md
+- README.md
+files:
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- VERSION
+- lib/bibmarkdown.rb
+- lib/bibmarkdown/document.rb
+homepage: http://github.com/RubenVerborgh/bibmarkdown
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Markdown with BibTeX citations.
+test_files: []