asciidoctor-bibliography 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ee3b6315f9a710c52dd9b90d032bd6ea5f23c69c
-  data.tar.gz: c4cb88fc6f415e11bf87306ee0cb54f6011ef2c3
+  metadata.gz: 6160a0148bcc81aa588bd2c333b4cb209ffc1ec7
+  data.tar.gz: fff771f653fb8dd39bc581326748afe767c884c4
 SHA512:
-  metadata.gz: 8027a65944c8da37afa92525556f0a6e651d4a63a262ed68ce4e195ea88d54c5377f89a52b792834bd0493357d3d2e72883f6b601a64986cf6f9fe719eb02777
-  data.tar.gz: 0a3373d5c62e52d8badc699bf122fc46bad03b8a10938e9cca9f1eae89197a4d44b771ddbb2311ad726898e144468e070f7ac603e8e3805aee56a36f69424dfe
+  metadata.gz: 252da4287ea790422111c8628686675672c5dd8422daf89c721d118a94a935b221d1f1ceb3ce3ce140d57863ff13c0489ab6424cc3e22ba04b4ff14977d9e4ef
+  data.tar.gz: 3be21ac1c4ed50b01f6cda42b898c2af9e0cead327bc17c854b32b8a6c342220a1d5736bffb084bbeb3abbc0ceee5599bf18aeb84e4e61b9062a3887bc7ad120

data/README.adoc

@@ -131,6 +131,16 @@ To `prefix` and `suffix` citations with arbitrary strings you can use the relati
 cite:[Aa2017, prefix="see ", suffix=" if you will"]
 ----
 
+You can replace the rendered citation with arbitrary `text` or interpolate it directly:
+
+[source,asciidoc]
+----
+cite:[Aa2017, text="replacement text"]
+// the next two lines are equivalent:
+cite:[Aa2017, prefix="see ", suffix=" if you will"]
+cite:[Aa2017, text="see {cite} if you will"]
+----
+
 To cite multiple resources you concatenate them as follows:
 
 [source,asciidoc]

data/lib/asciidoctor-bibliography/citation.rb

@@ -71,6 +71,7 @@ module AsciidoctorBibliography
       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
 
@@ -80,9 +81,20 @@ module AsciidoctorBibliography
       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
+          (citation_item.text || "{cite}").
+            sub("{cite}", Regexp.last_match[:citation])
+        end
+      end
+    end
+
     def prepare_items(bibliographer, formatter, tex: false)
       # NOTE: when we're using our custom TeX CSL styles prefix/suffix are used as
-      #   varieables for metadata instead of as parameters for citations.
+      #   variables for metadata instead of as parameters for citations.
       cites_with_local_attributes = citation_items.map { |cite| prepare_metadata bibliographer, cite, affix: tex }
       formatter.import cites_with_local_attributes
       formatter.force_sort!(mode: :citation)
@@ -104,6 +116,7 @@ module AsciidoctorBibliography
       ci = citation_items.detect { |c| c.key == item.id }
       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?
       item.label, item.locator = ci.locator
     end

data/lib/asciidoctor-bibliography/citation_item.rb

@@ -18,6 +18,10 @@ module AsciidoctorBibliography
       named_attributes["suffix"]
     end
 
+    def text
+      named_attributes["text"]
+    end
+
     def locators
       named_attributes.select { |key, _| LOCATORS.include? key }
     end

data/lib/asciidoctor-bibliography/version.rb

@@ -1,3 +1,3 @@
 module AsciidoctorBibliography
-  VERSION = "0.6.0".freeze
+  VERSION = "0.7.0".freeze
 end

data/lib/csl/styles/rfc-v3.csl

@@ -12,7 +12,7 @@
   </macro>
   <citation>
     <layout>
-      <group delimiter=" " prefix="&lt;relref " suffix="/&gt;">
+      <group delimiter=" " prefix="&lt;xref " suffix="/&gt;">
         <text variable="citation-label" prefix="target=&quot;" suffix="&quot;"/>
         <text variable="locator" prefix="section=&quot;" suffix="&quot;"/>
       </group>

data/spec/citation_item_spec.rb

@@ -95,4 +95,18 @@ describe AsciidoctorBibliography::CitationItem do
       expect(subject.suffix).to be_nil
     end
   end
+
+  describe "#text" do
+    subject { described_class.new }
+
+    it "returns the text if it exist" do
+      subject.parse_attribute_list("foo, text='prefix {ref} suffix'")
+      expect(subject.text).to eq("prefix {ref} suffix")
+    end
+
+    it "returns nil if no text exists" do
+      subject.parse_attribute_list("foo, bar, zod=quz")
+      expect(subject.text).to be_nil
+    end
+  end
 end

data/spec/csl/styles/rfc_v3_spec.rb

@@ -7,12 +7,12 @@ describe "cite macro with rfc-v3 style" do
 
   it "formats a single citation" do
     expect(formatted_citation("cite:[RFC2119]", options: options)).
-      to eq '+++<relref target="RFC2119"/>+++'
+      to eq '+++<xref target="RFC2119"/>+++'
   end
 
   it "formats a single citation with locator" do
     expect(formatted_citation("cite:[RFC2119, section=1.2.3]", options: options)).
-      to eq '+++<relref target="RFC2119" section="1.2.3"/>+++'
+      to eq '+++<xref target="RFC2119" section="1.2.3"/>+++'
   end
 
   it "formats a single bibliography entry" do

data/spec/macros_spec.rb

@@ -13,6 +13,16 @@ describe "cite macro with apa style" do
   end
 end
 
+describe "cite macro with arbitrary interpolated text" do
+  it "formats a complex citation" do
+    expect(formatted_citation("cite:[Erdos65, text=foo {cite} bar]",
+                              options: { "bibliography-style" => "apa",
+                                         "bibliography-database" => "database.bib",
+                                         "bibliography-hyperlinks" => "true" })).
+      to eq "(xref:bibliography-default-Erdos65[foo Erdős, Heyting, & Brouwer, 1965 bar])"
+  end
+end
+
 describe "fullcite macro with apa style" do
   it "formats a complex citation" do
     expect(formatted_citation("fullcite:[Erdos65]",

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-bibliography
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-14 00:00:00.000000000 Z
+date: 2017-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor