bibmarkdown 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c99bc98d84bf0eed3fb8dd4d7d44a4868c91962f
-  data.tar.gz: b552385ae4b3e037c9c94001c83f144d483a5731
+  metadata.gz: b3643b4d21d60997b979670eec92eefe6832ead5
+  data.tar.gz: 6aef6c803413b1799ebf2d9080f509341b0ded80
 SHA512:
-  metadata.gz: 6b99bff193aca4ffa06785821aac9a3a70d2a0d83481bfb17db5464e51396d6bcfcad221c14e47f3fc019c03313edcb2a08845cd23cdffdcd345c322a5e6bc14
-  data.tar.gz: ed909c79a985e26eecb4f87f136b5df0fc0df836edec2c3148fbfbbff0f57de72f32e2f019fa7fc5d0fe39de12b4e1c2ee54b2b50941f94c74fd176243accade
+  metadata.gz: 9f78597db7000e0f29338641c4934a7aec2e1249265ab1120a4a9cbb8b5aab54eca6455bf525c8b3d2b3a8c14970e004ee1c59e73553349f9d1c5517bb551a5a
+  data.tar.gz: 26196bcaebd8f607bfa0ec327d4d9533d2872556c9a540c7765aa7e49f7e93ff761189153e3fa0a24acea92060593dbb0271425ae7831faab8a47d7393caf838

data/VERSION

@@ -1 +1 @@
-1.2.1
+1.3.0

data/bibmarkdown.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Juwelier::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: bibmarkdown 1.2.1 ruby lib
+# stub: bibmarkdown 1.3.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "bibmarkdown".freeze
-  s.version = "1.2.1"
+  s.version = "1.3.0"
 
   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 = "2017-08-21"
+  s.date = "2017-12-31"
   s.email = "ruben@verborgh.org".freeze
   s.extra_rdoc_files = [
     "LICENSE.md",

data/lib/bibmarkdown/document.rb

@@ -22,16 +22,24 @@ module BibMarkdown
         raise "Missing reference key in #{match}" if refs.empty?
         reflinks = refs.map{|r| r[:link]}.join ''
 
-        # If the link text is empty, output links to the references
+        # If the anchor text is empty, output reference links
         if text.empty?
           reflinks
-        # If there is no URL, output the text followed by links to the references
+        # If the reference has no URL, output the anchor text and append reference links
         elsif refs.first[:url].empty?
           "#{text} #{reflinks}"
-        # Otherwise, output the linked text and the references
+        # Otherwise, link the anchor text to the first reference URL and append reference links
         else
-          property = 'http://purl.org/spar/cito/' + rel
-          "#{create_link text, refs.first[:url], property: property} #{reflinks}"
+          property = 'schema:citation http://purl.org/spar/cito/' + rel
+          # Link to the first reference
+          first = refs.first
+          if first[:id] == first[:url]
+            "#{create_element :a, text, property: property, href: first[:url]} #{reflinks}"
+          # If the reference's ID is different from its URL, surround with an extra span
+          else
+            link = create_element :a, text, href: first[:url]
+            "#{create_element :span, link, property: property, resource: first[:id]} #{reflinks}"
+          end
         end
       end
 
@@ -40,29 +48,32 @@ module BibMarkdown
     end
 
     protected
+    def find_entry key
+      raise "Reference '#{key}' does not exist." unless @entries.key?(key)
+      @entries[key]
+    end
+
     def create_reference key
       return @references[key] if @references.has_key? key
 
       # Look up citation and its URL
-      entry = @entries[key]
-      raise "Failed to generate references: entry '#{key}' does not exist." unless entry
+      entry = find_entry key
       url = entry[:url] || ''
 
-      # Assign an ID and create a link to the reference
-      id = @references.length + 1
-      link = create_link "\\[#{id}\\]", "#ref-#{id}", class: 'reference'
+      # Assign a reference number and create a link to the reference
+      number = @references.length + 1
+      link = create_element :a, "\\[#{number}\\]", href: "#ref-#{number}", class: 'reference'
 
-      @references[key] = { id: id, url: url, link: link }
+      @references[key] = { id: reference_id(key), number: number, url: url, link: link }
     end
 
     def h text
       CGI::escapeHTML(text || '')
     end
 
-    def create_link html, url, attrs = {}
-      attrs[:href] = url
+    def create_element tag, html, attrs = {}
       attrs = attrs.map { |attr, value| %Q{#{attr}="#{h value}"} }
-      %Q{<a #{attrs.join ' '}>#{html}</a>}
+      %Q{<#{tag} #{attrs.join ' '}>#{html}</#{tag}>}
     end
 
     def references_html
@@ -72,13 +83,36 @@ module BibMarkdown
         html =  %Q{<h2 id="references">References</h2>\n}
         html += %Q{<dl class="references">\n}
         @references.each do |key, ref|
-          html += %Q{  <dt id="ref-#{ref[:id]}">\[#{ref[:id]}\]</dt>\n}
-          html += %Q{  <dd>#{reference_html key}</dd>\n}
+          html += %Q{  <dt id="ref-#{ref[:number]}">\[#{ref[:number]}\]</dt>\n}
+          html += %Q{  <dd resource="#{reference_id key}" typeof="#{reference_type key}">#{reference_html key}</dd>\n}
         end
         html += %Q{</dl>\n}
       end
     end
 
+    def reference_id key
+      entry = find_entry key
+      entry[:id] ||
+        entry[:doi] && "https://dx.doi.org/#{entry[:doi]}" ||
+        entry[:url] ||
+        "##{key}"
+    end
+
+    def reference_type key
+      case find_entry(key).type
+      when :article, :inproceedings
+        'schema:Article'
+      when :book
+        'schema:Book'
+      when :incollection
+        'schema:Chapter'
+      when :mastersthesis, :phdthesis
+        'schema:Thesis'
+      else
+        'schema:CreativeWork'
+      end
+    end
+
     def reference_html key
       # Render reference
       processor = CiteProc::Processor.new style: @style, format: 'html'
@@ -88,7 +122,7 @@ module BibMarkdown
 
       # Replace URLs by links
       citation.gsub %r{https?://[^ ]+[^ .]} do |match|
-        create_link h(match), match
+        create_element :a, h(match), href: match
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bibmarkdown
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Ruben Verborgh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-21 00:00:00.000000000 Z
+date: 2017-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: citeproc-ruby