asciidoctor-bibtex 0.6.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bccdd37cd3c92456c39f42cb27ea3b0605a03d72d465252993997e97d5c22550
-  data.tar.gz: 172ad52204430a2672cbb19d0c4206bd12127ab8aae7eb52a1110b7aa245734e
+  metadata.gz: e39be76ce5e649e7075b470a56950f64c91ab7f084b902676356b6672012a9d1
+  data.tar.gz: 467a9b62f3f9c51ec8778d41dd8a29bc3d2f06b7b5b88ff55f41b4fded73b66a
 SHA512:
-  metadata.gz: 43c2d4492d39072ec712873f0414f5ba988f864a7fc7e9883decefba673357f650667a37d410506335d66c3d7524ebcb2d6686c2d4b3e24a8e2eced503432e61
-  data.tar.gz: 8a14439358c611b4535942882978581f9957faf43519616c760a4f9a2b3307e923a3d59fa8550d7ecde37c0598dd51d658d444dee8b340506ab939c47e13dfc5
+  metadata.gz: 983ff27cc0f7899411b3bba18f0afa0e54aa9aa4fa8ca82c48e4f61de3cbe4ea4a6e4c0dfc78539b54c8c2ae5ba3b7c5816bac88dc1550905f1356d1e163e69a
+  data.tar.gz: a6bbc812e04a8f59a6f8499cf750bfc938fc73b5675d6b72d6f749f6c29e056dfc5bff83f0002180f9a076225c94972ef8b8f733d762f9c98595595bc67417e3

data/README.adoc

@@ -9,6 +9,7 @@ ifdef::env-github,env-browser[]
 endif::[]
 ifdef::env-github[]
 :!toc-title:
+:status:
 endif::[]
 // URLs:
 :url-asciidoctor: http://asciidoctor.org
@@ -16,12 +17,16 @@ endif::[]
 :url-asciidoctor-pdf: https://github.com/asciidoctor/asciidoctor-pdf
 :url-asciidoctor-latex: https://github.com/asciidoctor/asciidoctor-latex
 :url-asciidoc-bib: https://github.com/petercrlane/asciidoc-bib
+:url-gem: https://rubygems.org/gems/asciidoctor-bibtex
 
-asciidoctor-bibtex adds bibtex integration to AsciiDoc documents by introducing two new macros: `cite:[KEY]` and `bibliography::[]`.
-Citations are parsed and replaced with formatted inline texts, and reference lists are automatically generated and inserted into where `bibliography::[]` is placed. 
+ifdef::status[]
+image:https://img.shields.io/travis/asciidoctor/asciidoctor-bibtex/master.svg[Build Status (Travis CI),link=https://travis-ci.org/asciidoctor/asciidoctor-bibtex]
+image:https://img.shields.io/gem/v/asciidoctor-bibtex.svg[Latest Release, link=https://rubygems.org/gems/asciidoctor-bibtex]
+endif::[]
+
+asciidoctor-bibtex adds bibtex integration to AsciiDoc documents by introducing three new macros: `cite:[KEY]`, `bibitem:[KEY]` and `bibliography::[]`. Citations are parsed and replaced with formatted inline texts, and reference lists are automatically generated and inserted into where `bibliography::[]` is placed. `bibitem:[KEY]` will insert a rendered bibliography item directly into the text.
 
-asciidoctor-bibtex is designed to be used as an extension to {url-asciidoctor}[Asciidoctor].
-Thus this extension can be used together with other asciidoctor extensions such as {url-asciidoctor-mathematical}[asciidoctor-mathematical] and {url-asciidoctor-pdf}[asciidoctor-pdf] to enrich your AsciiDoc experience.
+asciidoctor-bibtex is designed to be used as an extension to {url-asciidoctor}[Asciidoctor]. Thus this extension can be used together with other asciidoctor extensions such as {url-asciidoctor-mathematical}[asciidoctor-mathematical] and {url-asciidoctor-pdf}[asciidoctor-pdf] to enrich your AsciiDoc experience.
 
 NOTE: asciidoctor-bibtex no longer supports AsciiDoc-to-AsciiDoc conversion.
 
@@ -45,7 +50,7 @@ asciidoctor-bibtex depends on https://github.com/inukshuk/bibtex-ruby[bibtex-rub
 Ensure the `ruby-dev` and `libxslt1-dev` packages are installed on your machine so the dependencies will compile properly.
 
 {url-asciidoctor}[Asciidoctor] must also be installed for 'asciidoctor-bibtex' to work.
-Asciidoctor version 1.5.2 or higher is required.
+Asciidoctor version 2.0.0 or higher is required.
 
 == Usage
 
@@ -78,6 +83,21 @@ For *ieee*, a numeric style:
 
 To add a list of formatted references, place `bibliography::[]` on a line by itself.
 
+One can use `bibitem:[Lane12]` to insert a rendered bibliography item inline, maybe to generate a cv. For example:
+
+[source, asciidoc]
+----
+= My CV
+
+== Publications
+
+=== 2019
+
+- bibitem:[Me2019a]
+- bibitem:[Me2019b]
+- bibitem:[Me2019c]
+----
+
 === Configuration
 
 Configuration is applied in the form of AsciiDoc document attributes, which must be defined in the document header.
@@ -109,6 +129,11 @@ Configuration is applied in the form of AsciiDoc document attributes, which must
 | Throw an error on unknown references
 | `true` or `false`
 | `false`
+
+| bibtex-citation-template
+| Custom citation template for numeric style
+| Any string matching `/(.+?)\$id(.+)/`
+| `[$id]`
 |===
 
 === Commandline

data/lib/asciidoctor-bibtex/bibitem_macro.rb

@@ -0,0 +1,53 @@
+#
+# BibitemMacro.rb
+#
+# Copyright (c) Zhang Yang, 2020.
+#
+# Released under Open Works License, 0.9.2
+#
+
+module AsciidoctorBibtex
+  # BibitemMacro
+  #
+  # Class to hold information about a bibitem macro.  A bibtem macro has
+  # only text and key
+  #
+  # This class also provides a class method to extract macros from a line of
+  # text.
+  #
+  class BibitemMacro
+    #
+    # Grammar for the bibitem macro: bibitem:[key]
+    #
+
+    # matches a bibitem key
+    BIBITEM_KEY = /[^\s\]]+/.freeze
+    # matches the full macro
+    BIBITEM_MACRO = /bibitem:\[(#{BIBITEM_KEY})\]/.freeze
+
+    # Given a line, return a list of BibitemMacro instances
+    def self.extract_macros(line)
+      result = []
+      full = BIBITEM_MACRO.match line
+      while full
+        text = full[0]
+        key = full[1]
+        result << BibitemMacro.new(text, key)
+        # look for next citation on line
+        full = BIBITEM_MACRO.match full.post_match
+      end
+      result
+    end
+
+    attr_reader :text, :key
+
+    # Create a BibitemMacro object
+    #
+    # text: the full macro text matched by BIBITEM_MACRO
+    # key: bibitem key
+    def initialize(text, key)
+      @text = text
+      @key = key
+    end
+  end
+end

data/lib/asciidoctor-bibtex/citation_macro.rb

@@ -54,7 +54,7 @@ module AsciidoctorBibtex
 
     # Given a line, return a list of CitationData instances
     # containing information on each set of citation information
-    def self.extract_citations(line)
+    def self.extract_macros(line)
       result = []
       full = CITATION_MACRO.match line
       while full

data/lib/asciidoctor-bibtex/extensions.rb

@@ -67,6 +67,7 @@ module AsciidoctorBibtex
         bibtex_order = ((document.attr 'bibtex-order') || 'appearance').to_sym
         bibtex_format = ((document.attr 'bibtex-format') || 'asciidoc').to_sym
         bibtex_throw = ((document.attr 'bibtex-throw') || 'false').to_s.downcase
+        bibtex_citation_template = ((document.attr 'bibtex-citation-template') || '[$id]').to_s
 
         # Fild bibtex file automatically if not supplied.
         if bibtex_file.empty?
@@ -84,23 +85,29 @@ module AsciidoctorBibtex
         prose_blocks = document.find_by do |b|
           (b.content_model == :simple) ||
             (b.context == :list_item) ||
-            (b.context == :table_cell)
+            (b.context == :table_cell) ||
+            (b.title?)
         end
         return nil if prose_blocks.nil?
 
         processor = Processor.new bibtex_file, true, bibtex_style, bibtex_locale,
                                   bibtex_order == :appearance, bibtex_format,
-                                  bibtex_throw == 'true'
+                                  bibtex_throw == 'true', custom_citation_template: bibtex_citation_template
 
         # First pass: extract all citations.
         prose_blocks.each do |block|
           if block.context == :list_item || block.context == :table_cell
             line = block.text
-            processor.process_citation_macros line
-          else
+            unless line.nil? || line.empty?
+              processor.process_citation_macros line
+            end
+          elsif block.content_model == :simple
             block.lines.each do |line|
               processor.process_citation_macros line
             end
+          else
+            line = block.title
+            processor.process_citation_macros line
           end
         end
         # Make processor finalize macro processing as required.
@@ -111,15 +118,23 @@ module AsciidoctorBibtex
           if block.context == :list_item || block.context == :table_cell
             # NOTE: we access the instance variable @text for raw text.
             line = block.instance_variable_get(:@text)
-            if !line.empty?
+            unless line.nil? or line.empty?
               line = processor.replace_citation_macros(line)
+              line = processor.replace_bibitem_macros(line)
               block.text = line
             end
-          else
+          elsif block.content_model == :simple
             block.lines.each_with_index do |line, index|
               line = processor.replace_citation_macros(line)
+              line = processor.replace_bibitem_macros(line)
               block.lines[index] = line
             end
+          else
+            # NOTE: we access the instance variable @text for raw text.
+            line = block.instance_variable_get(:@title)
+            line = processor.replace_citation_macros(line)
+            # line = processor.replace_bibitem_macros(line)
+            block.title = line
           end
         end
 

data/lib/asciidoctor-bibtex/processor.rb

@@ -18,6 +18,7 @@ require 'set'
 
 require_relative 'citation_macro'
 require_relative 'citation_utils'
+require_relative 'bibitem_macro'
 require_relative 'string_utils'
 require_relative 'style_utils'
 
@@ -49,7 +50,7 @@ module AsciidoctorBibtex
   class Processor
     def initialize(bibfile, links = false, style = 'ieee', locale = 'en-US',
                    numeric_in_appearance_order = false, output = :asciidoc,
-                   throw_on_unknown = false)
+                   throw_on_unknown = false, custom_citation_template: '[$id]')
       raise "File '#{bibfile}' is not found" unless FileTest.file? bibfile
 
       bibtex = BibTeX.open bibfile, filter: [LatexFilter]
@@ -62,6 +63,13 @@ module AsciidoctorBibtex
       @filenames = Set.new
       @output = output
       @throw_on_unknown = throw_on_unknown
+      @bibtex_ob = '['
+      @bibtex_cb = ']'
+      match = custom_citation_template.match(/^(.+?)\$id(.+)$/)
+      unless match.nil?
+        @bibtex_ob = match[1]
+        @bibtex_cb = match[2]
+      end
 
       if (output != :latex) && (output != :bibtex) && (output != :biblatex)
         @citeproc = CiteProc::Processor.new style: @style, format: :html, locale: @locale
@@ -75,7 +83,7 @@ module AsciidoctorBibtex
     # processor will build a list of all citation keys in the same order as they
     # appear in the original document.
     def process_citation_macros(line)
-      CitationMacro.extract_citations(line).each do |citation|
+      CitationMacro.extract_macros(line).each do |citation|
         @citations += citation.items.collect(&:key)
       end
     end
@@ -110,19 +118,29 @@ module AsciidoctorBibtex
     #
     # Return new text with all macros replaced.
     def replace_citation_macros(line)
-      CitationMacro.extract_citations(line).each do |citation|
+      CitationMacro.extract_macros(line).each do |citation|
         line = line.gsub(citation.text, build_citation_text(citation))
       end
       line
     end
 
+    # Replace bibitem macros with rendered bibitem.
+    #
+    # Return new text with all macros replaced.
+    def replace_bibitem_macros(line)
+      BibitemMacro.extract_macros(line).each do |item|
+        line = line.gsub(item.text, build_bibitem_text(item.key))
+      end
+      line
+    end
+
     # Build the bibliography list just as bibtex.
     #
     # Return an array of texts representing an asciidoc list.
     def build_bibliography_list
       result = []
-      @citations.each do |ref|
-        result << build_bibliography_item(ref)
+      @citations.each_with_index do |ref, index|
+        result << build_bibliography_item(ref, index)
         result << ''
       end
       result
@@ -132,17 +150,42 @@ module AsciidoctorBibtex
     # Internal functions
     #
 
+    # Build the asciidoc text for a single bibliography item
+    def build_bibitem_text(key)
+      begin
+        if @biblio[key].nil?
+          puts "Unknown reference: #{key}"
+          cptext = key
+        else
+          cptext = @citeproc.render :bibliography, id: key
+          cptext = cptext.first
+        end
+      rescue Exception => e
+        puts "Failed to render #{key}: #{e}"
+        cptext = key
+      end
+      StringUtils.html_to_asciidoc(cptext)
+    end
+
     # Build bibliography text for a given reference
-    def build_bibliography_item(key)
+    def build_bibliography_item(key, index = 0)
+      index += 1
       result = ''
-      result << '. ' if StyleUtils.is_numeric? @style
 
       begin
-        cptext = @citeproc.render :bibliography, id: key
+        cptext = if @biblio[key].nil?
+                   nil
+                 else
+                   @citeproc.render :bibliography, id: key
+                 end
       rescue Exception => e
         puts "Failed to render #{key}: #{e}"
       end
+
       result << "[[#{key}]]" if @links
+      if StyleUtils.is_numeric? @style
+        result << "#{@bibtex_ob}#{index}#{@bibtex_cb} "
+      end
       if cptext.nil?
         return result + key
       else
@@ -177,8 +220,8 @@ module AsciidoctorBibtex
       else
         result = ''
         if StyleUtils.is_numeric? @style
-          ob = '+[+'
-          cb = '+]+'
+          ob = "+#{@bibtex_ob}+"
+          cb = "+#{@bibtex_cb}+"
           separator = ','
         elsif macro.type == 'cite'
           ob = '('
@@ -200,14 +243,14 @@ module AsciidoctorBibtex
           # if found, insert reference information
           if @biblio[cite.key].nil?
             if @throw_on_unknown
-              raise "Unknown reference: #{cite.ref}"
+              raise "Unknown reference: #{cite.key}"
             else
-              puts "Unknown reference: #{cite.ref}"
-              cite_text = cite.ref.to_s
+              puts "Unknown reference: #{cite.key}"
+              cite_text = cite.key.to_s
             end
           else
             cite_text = citation_text(macro, cite)
-           end
+          end
 
           result << StringUtils.html_to_asciidoc(cite_text)
           result << '>>' if @links
@@ -229,13 +272,13 @@ module AsciidoctorBibtex
         result << ' '
         # use p.x for single numerical page and pp.x for all others. This will
         # produce pp. 1 seq for complex locators, which is the correct behavior.
-        if @style.include? 'chicago'
-          result << cite.locator
-        elsif /^\d+$/ =~ cite.locator
-          result << "p.&#160;#{cite.locator}"
-        else
-          result << "pp.&#160;#{cite.locator}"
-        end
+        result << if @style.include? 'chicago'
+                    cite.locator
+                  elsif /^\d+$/ =~ cite.locator
+                    "p.&#160;#{cite.locator}"
+                  else
+                    "pp.&#160;#{cite.locator}"
+                  end
       end
 
       result
@@ -266,7 +309,7 @@ module AsciidoctorBibtex
         cite_text = @citeproc.render :citation, id: cite.key
         cite_text = cite_text.gsub('(', '')
         cite_text = cite_text.gsub(')', '')
-        cite_text = cite_text + format_locator(cite)
+        cite_text += format_locator(cite)
         year = @biblio[cite.key].year
         if !year.nil? && macro.type == 'citenp'
           segs = cite_text.partition(year.to_s)

data/lib/asciidoctor-bibtex/version.rb

@@ -1,3 +1,3 @@
 module AsciidoctorBibtex
-  VERSION = '0.6.0'
+  VERSION = '0.7.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-bibtex
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.1
 platform: ruby
 authors:
 - Zhang YANG
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-04 00:00:00.000000000 Z
+date: 2020-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -122,6 +122,7 @@ files:
 - LICENSE.txt
 - README.adoc
 - lib/asciidoctor-bibtex.rb
+- lib/asciidoctor-bibtex/bibitem_macro.rb
 - lib/asciidoctor-bibtex/citation_macro.rb
 - lib/asciidoctor-bibtex/citation_utils.rb
 - lib/asciidoctor-bibtex/extensions.rb
@@ -149,7 +150,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: An Asciidoctor extension that adds bibtex integration to AsciiDoc