asciidoctor-bibliography 0.9.1 → 0.9.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e5f4c3c1adb3bab1871b0aca0401e8b2400389952ac1aa6879982d37759e0309
-  data.tar.gz: 4eb784aa9204c2bd4b34784511f1e549d3ab7f94e1079f27ff9898e3baa2a55a
+  metadata.gz: ba310499dfc5790d5e46801371c1c061471695851dae7d30a33ca13d007fc1a5
+  data.tar.gz: 35133fcdbb5d12518dd71eac4a9fe57093620b098bdfe1579897cfb87521b62a
 SHA512:
-  metadata.gz: 905cd2e676a6a66d893163c8f9f01cc60f7a4798536a9976ec9bf1d8e130257f05adcbc7de155a74a2dbe9a074302180ceb2cfe80b2b0daa409ab8aeda32c910
-  data.tar.gz: 2b45d610368bd5ac57f83a47d5d517756844f3b6387e06c9bd2a45feaca4d8e51bfad15296701281da3388c0fbb63dafcfc3608c2645779d80a769ed7b16b8fd
+  metadata.gz: e61cd53c537606051c6ecd3e6ca2bb9c827647befd0368674358b203f4ede939ebb1cc21ba8b7b6fadf2265cd8b83b484241e2e489e7fc5ad0e990d6a6a06154
+  data.tar.gz: 77d251ea74096dc841b0f3663315b5dd4553a4e5b44ed329f6301def28a66f48c3d6a28250ecd92b1a745d0f1c8df6c13eaf1130685bc158e097c2921e21cdc7

data/README.adoc

@@ -150,6 +150,7 @@ cite:[Aa2017]+[Bb2017]+[Cc2017]
 
 You can apply a different locator to each one.
 
+IMPORTANT: when using a `prefix`, `suffix` or `text` containing `]` (the right square bracket character) remember to escape it as the corresponding HTML sequence `]`. E.g.: `cite:[Foo2019, text="see {cite} or [this] perhaps"]`.
 
 === Bibliographies
 

data/lib/asciidoctor-bibliography/citation.rb

@@ -111,24 +111,18 @@ module AsciidoctorBibliography
       formatter = Formatter.new(style, locale: bibliographer.options.locale)
       items = prepare_items bibliographer, formatter, tex: tex
       formatted_citation = formatter.engine.renderer.render(items, formatter.engine.style.citation)
-      escape_brackets_inside_xref! formatted_citation
       interpolate_formatted_citation! formatted_citation
       formatted_citation
     end
 
-    def escape_brackets_inside_xref!(string)
-      string.gsub!(/{{{(?<xref_label>.*?)}}}/) do
-        ["[", Regexp.last_match[:xref_label].gsub("]", '\]'), "]"].join
-      end
-    end
-
     def interpolate_formatted_citation!(formatted_citation)
       citation_items.each do |citation_item|
         key = Regexp.escape citation_item.key
         formatted_citation.gsub!(/___#{key}___(?<citation>.*?)___\/#{key}___/) do
-          # NOTE: this is slight overkill but easy to extend
+          # NOTE: this handles custom citation text (slight overkill but easy to extend)
+          # NOTE: escaping ] is necessary to safely nest macros (e.g. citing in a footnote)
           (citation_item.text || "{cite}").
-            sub("{cite}", Regexp.last_match[:citation])
+            sub("{cite}", Regexp.last_match[:citation].gsub("]", "&rsqb;"))
         end
       end
     end
@@ -158,7 +152,7 @@ module AsciidoctorBibliography
       wrap_item item, ci.prefix, ci.suffix if affix
       id = xref_id "bibliography", ci.target, item.id
       wrap_item item, "___#{item.id}___", "___/#{item.id}___"
-      wrap_item item, "xref:#{id}{{{", "}}}" if options.hyperlinks?
+      wrap_item item, "<<#{id},", ">>" if options.hyperlinks?
       item.label, item.locator = ci.locator
     end
 

data/lib/asciidoctor-bibliography/version.rb

@@ -1,3 +1,3 @@
 module AsciidoctorBibliography
-  VERSION = "0.9.1".freeze
+  VERSION = "0.9.2".freeze
 end

data/spec/csl/styles/tex_citet_numeric_spec.rb

@@ -7,36 +7,36 @@ describe "citet macro with numeric style" do
 
   it "formats a single citation" do
     expect(formatted_citation("citet:[Erdos65]", options: options)).
-      to eq "Erdős et al. [1]"
+      to eq "Erdős et al. [1]"
   end
 
   it "formats a grouped citation" do
     expect(formatted_citation("citet:[Erdos65]+[Einstein35]", options: options)).
-      to eq "Erdős et al. [1], Einstein et al. [2]"
+      to eq "Erdős et al. [1], Einstein et al. [2]"
   end
 
   it "formats a single citation with a prefix" do
     expect(formatted_citation("citet:[Erdos65, prefix=see]", options: options)).
-      to eq "Erdős et al. [see 1]"
+      to eq "Erdős et al. [see 1]"
   end
 
   it "formats a single citation with a suffix" do
     expect(formatted_citation("citet:[Erdos65, suffix=new edition]", options: options)).
-      to eq "Erdős et al. [1, new edition]"
+      to eq "Erdős et al. [1, new edition]"
   end
 
   it "formats a single citation with both a prefix and a suffix" do
     expect(formatted_citation("citet:[Erdos65, prefix=see, suffix=new edition]", options: options)).
-      to eq "Erdős et al. [see 1, new edition]"
+      to eq "Erdős et al. [see 1, new edition]"
   end
 
   it "formats a single citation with a standard locator" do
     expect(formatted_citation("citet:[Erdos65, page=41-43]", options: options)).
-      to eq "Erdős et al. [1, pp. 41-43]"
+      to eq "Erdős et al. [1, pp. 41-43]"
   end
 
   it "formats a single citation with a custom locator" do
     expect(formatted_citation("citet:[Erdos65, locator=somewhere]", options: options)).
-      to eq "Erdős et al. [1, somewhere]"
+      to eq "Erdős et al. [1, somewhere]"
   end
 end

data/spec/csl/styles/tex_citets_numeric_spec.rb

@@ -7,36 +7,36 @@ describe "citet* macro with numeric style" do
 
   it "formats a single citation" do
     expect(formatted_citation("citet*:[Erdos65]", options: options)).
-      to eq "Erdős, Heyting, and Brouwer [1]"
+      to eq "Erdős, Heyting, and Brouwer [1]"
   end
 
   it "formats a grouped citation" do
     expect(formatted_citation("citet*:[Erdos65]+[Einstein35]", options: options)).
-      to eq "Erdős, Heyting, and Brouwer [1], Einstein, Podolsky, and Rosen [2]"
+      to eq "Erdős, Heyting, and Brouwer [1], Einstein, Podolsky, and Rosen [2]"
   end
 
   it "formats a single citation with a prefix" do
     expect(formatted_citation("citet*:[Erdos65, prefix=see]", options: options)).
-      to eq "Erdős, Heyting, and Brouwer [see 1]"
+      to eq "Erdős, Heyting, and Brouwer [see 1]"
   end
 
   it "formats a single citation with a suffix" do
     expect(formatted_citation("citet*:[Erdos65, suffix=new edition]", options: options)).
-      to eq "Erdős, Heyting, and Brouwer [1, new edition]"
+      to eq "Erdős, Heyting, and Brouwer [1, new edition]"
   end
 
   it "formats a single citation with both a prefix and a suffix" do
     expect(formatted_citation("citet*:[Erdos65, prefix=see, suffix=new edition]", options: options)).
-      to eq "Erdős, Heyting, and Brouwer [see 1, new edition]"
+      to eq "Erdős, Heyting, and Brouwer [see 1, new edition]"
   end
 
   it "formats a single citation with a standard locator" do
     expect(formatted_citation("citet*:[Erdos65, page=41-43]", options: options)).
-      to eq "Erdős, Heyting, and Brouwer [1, pp. 41-43]"
+      to eq "Erdős, Heyting, and Brouwer [1, pp. 41-43]"
   end
 
   it "formats a single citation with a custom locator" do
     expect(formatted_citation("citet*:[Erdos65, locator=somewhere]", options: options)).
-      to eq "Erdős, Heyting, and Brouwer [1, somewhere]"
+      to eq "Erdős, Heyting, and Brouwer [1, somewhere]"
   end
 end

data/spec/macros_spec.rb

@@ -8,8 +8,8 @@ describe "cite macro with apa style" do
                               options: { "bibliography-style" => "apa",
                                          "bibliography-database" => "database.bib",
                                          "bibliography-hyperlinks" => "true" })).
-      to eq "(xref:bibliography-default-Einstein35[Einstein, Podolsky, & Rosen, 1935, pp. 41-43]; " +
-      "xref:bibliography-default-Erdos65[seeErdős, Heyting, & Brouwer, 1965])"
+      to eq "(<<bibliography-default-Einstein35,Einstein, Podolsky, & Rosen, 1935, pp. 41-43>>; " +
+      "<<bibliography-default-Erdos65,seeErdős, Heyting, & Brouwer, 1965>>)"
   end
 end
 
@@ -19,7 +19,7 @@ describe "cite macro with arbitrary interpolated text" do
                               options: { "bibliography-style" => "apa",
                                          "bibliography-database" => "database.bib",
                                          "bibliography-hyperlinks" => "true" })).
-      to eq "(xref:bibliography-default-Erdos65[foo Erdős, Heyting, & Brouwer, 1965 bar])"
+      to eq "(<<bibliography-default-Erdos65,foo Erdős, Heyting, & Brouwer, 1965 bar>>)"
   end
 end
 
@@ -48,6 +48,6 @@ describe "cite macro using more than two keys" do
                               options: { "bibliography-style" => "apa",
                                          "bibliography-database" => "database.bib",
                                          "bibliography-hyperlinks" => "true" })).
-      to eq "(xref:bibliography-default-Einstein35[Einstein, Podolsky, & Rosen, 1935]; xref:bibliography-default-Erdos65[Erdős, Heyting, & Brouwer, 1965]; xref:bibliography-default-Lane12a[Lane, 2000]; xref:bibliography-default-Lane12b[Mane & Smith, 2000])"
+      to eq "(<<bibliography-default-Einstein35,Einstein, Podolsky, & Rosen, 1935>>; <<bibliography-default-Erdos65,Erdős, Heyting, & Brouwer, 1965>>; <<bibliography-default-Lane12a,Lane, 2000>>; <<bibliography-default-Lane12b,Mane & Smith, 2000>>)"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-bibliography
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.9.2
 platform: ruby
 authors:
 - Ribose Inc.