asciidoctor-bibliography 0.4.4 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 5a347f15409faab328c514fa0f6e63e3f583af11
-  data.tar.gz: 0b6b7cba4b713bb56415d847f3d4ef385d0bb85e
+SHA256:
+  metadata.gz: 61e7b49f2a7f0748b403572c395888484d08fbd839c2b1936cd1b481b5ea6e55
+  data.tar.gz: 4082bfb58062751ae7f51da843513a941d7f1ed156c77cc31fffe42257c6ba03
 SHA512:
-  metadata.gz: 19c0a0935001b19eccf5b76e9b0453e9ac81888e27fbdfffc47929bde2d0580ae7cd80b4ec19a7e8c82ec62c06261d694371fe5f30ec9c4c47dc1b9d86e2848a
-  data.tar.gz: 1c6f3ca017bd84ffd4ac2a649717a57abab9882c3aa1995e743563988c3c350a511e794d2941b6b155cf6859bb77b9ee69d889c56c3de405d1b5de99d454c19e
+  metadata.gz: c998f87e682d397e64da720491651556eb320bd7227162827fb3297b352635a5ecc874f33f62373939f9eae440d263bf565013f2b534a5ad61c60f7387573410
+  data.tar.gz: 139fe43a494d4cbbe0b2c616a9d89342169f03241c422dc0bc7d965418277ff0d712b90a0a26858b645ef94ff03a26df8856971de2473cb92c62041eeb6457ba

data/README.adoc

@@ -150,6 +150,29 @@ To render the bibliography you simply use the following block macro:
 bibliography::[]
 ----
 
+You can handle multiple bibliographies by providing a target parameter to
+citation macros:
+
+[source,asciidoc]
+----
+cite:foo[Aa2017]+bar[Bb2017]
+----
+
+You can then render all citations targeting a specific bibliography
+by using the target parameter again:
+
+[source,asciidoc]
+----
+## Index of Foos
+
+bibliography::foo[]
+
+## Index of Bars
+
+bibliography::bar[]
+----
+
+Giving no target is equivalent to using `default` as a target.
 
 === Databases
 

data/lib/asciidoctor-bibliography/bibliographer.rb

@@ -11,16 +11,19 @@ module AsciidoctorBibliography
       @citations = []
       @indices = []
       @database = nil
-      @occurring_keys = []
+      @occurring_keys = Hash.new([])
     end
 
     def add_citation(citation)
       citations << citation
-      @occurring_keys.concat(citation.citation_items.map(&:key)).uniq!
+      citation.citation_items.group_by(&:target).each do |target, citation_items|
+        @occurring_keys[target] ||= []
+        @occurring_keys[target].concat(citation_items.map(&:key)).uniq!
+      end
     end
 
-    def appearance_index_of(id)
-      @occurring_keys.index(id) + 1
+    def appearance_index_of(target, id)
+      @occurring_keys[target].index(id) + 1
     end
   end
 end

data/lib/asciidoctor-bibliography/citation.rb

@@ -21,9 +21,9 @@ module AsciidoctorBibliography
       @macro = macro
       @citation_items = []
       # rubocop:disable Performance/HashEachMethods
-      target_and_attributes_list_pairs.compact.each_slice(2).each do |_target, attribute_list|
+      target_and_attributes_list_pairs.compact.each_slice(2).each do |target, attribute_list|
         @citation_items << CitationItem.new do |cite|
-          # NOTE: we're not doing anything with targets right now.
+          cite.target = target.to_s.empty? ? "default" : target
           cite.parse_attribute_list attribute_list
         end
       end
@@ -81,7 +81,7 @@ module AsciidoctorBibliography
 
     def prepare_metadata(bibliographer, cite, affix: false)
       bibliographer.database.find_entry_by_id(cite.key).
-        merge 'citation-number': bibliographer.appearance_index_of(cite.key),
+        merge 'citation-number': bibliographer.appearance_index_of(cite.target, cite.key),
               'citation-label': cite.key, # TODO: smart label generators
               'locator': cite.locator.nil? ? nil : " ",
               'prefix': affix ? cite.prefix : nil,
@@ -93,7 +93,8 @@ module AsciidoctorBibliography
       # TODO: hyperlink, suppress_author and only_author options
       ci = citation_items.detect { |c| c.key == item.id }
       wrap_item item, ci.prefix, ci.suffix if affix
-      wrap_item item, "xref:#{xref_id(item.id)}{{{", "}}}" if options.hyperlinks?
+      id = xref_id "bibliography", ci.target, item.id
+      wrap_item item, "xref:#{id}{{{", "}}}" if options.hyperlinks?
       item.label, item.locator = ci.locator
     end
 
@@ -106,12 +107,8 @@ module AsciidoctorBibliography
       ":#{@uuid}:"
     end
 
-    def xref_id(key)
-      ["bibliography", key].compact.join("-")
-    end
-
-    def xref(key, label)
-      "xref:#{xref_id(key)}[#{label.gsub(']', '\]')}]"
+    def xref_id(*fragments)
+      fragments.compact.join("-")
     end
   end
 end

data/lib/asciidoctor-bibliography/index.rb

@@ -9,7 +9,7 @@ module AsciidoctorBibliography
 
     def initialize(macro, target, attributes)
       @macro = macro
-      @target = target
+      @target = target.to_s.empty? ? "default" : target
       @attributes = ::Asciidoctor::AttributeList.new(attributes).parse
     end
 
@@ -19,7 +19,8 @@ module AsciidoctorBibliography
       lines = []
       formatter.bibliography.each_with_index do |reference, index|
         line = "{empty}"
-        line << "anchor:#{anchor_id(formatter.data[index].id)}[]"
+        id = anchor_id "bibliography", target, formatter.data[index].id
+        line << "anchor:#{id}[]"
         line << reference
         lines << line
       end
@@ -43,27 +44,19 @@ module AsciidoctorBibliography
     end
 
     def prepare_filtered_db(bibliographer)
-      bibliographer.occurring_keys.
+      bibliographer.occurring_keys[target].
         map { |id| bibliographer.database.find_entry_by_id(id) }.
         map { |entry| prepare_entry_metadata bibliographer, entry }
     end
 
     def prepare_entry_metadata(bibliographer, entry)
       entry.
-        merge('citation-number': bibliographer.appearance_index_of(entry["id"])).
+        merge('citation-number': bibliographer.appearance_index_of(target, entry["id"])).
         merge('citation-label': entry["id"]) # TODO: smart label generators
     end
 
-    def anchor_id(target)
-      ["bibliography", target].compact.join("-")
-    end
-
-    def render_entry_label(target, formatter)
-      formatter.render(:bibliography, id: target).join
-    end
-
-    def render_entry(target, formatter)
-      "anchor:#{anchor_id(target)}[]#{render_entry_label(target, formatter)}"
+    def anchor_id(*fragments)
+      fragments.compact.join("-")
     end
   end
 end

data/lib/asciidoctor-bibliography/version.rb

@@ -1,3 +1,3 @@
 module AsciidoctorBibliography
-  VERSION = "0.4.4".freeze
+  VERSION = "0.5.0".freeze
 end

data/samples/standard/sample-targets.adoc

@@ -0,0 +1,25 @@
+= Sample usage of asciidoctor-bibliography
+:bibliography-database: biblio.bib
+:bibliography-hyperlinks: true
+
+## Standard
+
+cite:[Lane12a]
+
+cite:foo[Anderson04]
+
+cite:bar[Lane12a]+foo[Lane12b]
+
+## Bibliographies
+
+### Default
+
+bibliography::default[]
+
+### Foo
+
+bibliography::foo[]
+
+### Bar
+
+bibliography::bar[]

data/spec/macros_spec.rb

@@ -7,8 +7,8 @@ describe "cite macro with apa style" do
     expect(formatted_citation("cite:[Erdos65, prefix=see]+[Einstein35, page=41-43]",
                               options: { "bibliography-style" => "apa",
                                          "bibliography-hyperlinks" => "true" })).
-      to eq "(xref:bibliography-Einstein35[Einstein, Podolsky, & Rosen, 1935, pp. 41-43]; " +
-      "xref:bibliography-Erdos65[seeErdős, Heyting, & Brouwer, 1965])"
+      to eq "(xref:bibliography-default-Einstein35[Einstein, Podolsky, & Rosen, 1935, pp. 41-43]; " +
+      "xref:bibliography-default-Erdos65[seeErdős, Heyting, & Brouwer, 1965])"
   end
 end
 

data/spec/sanity_spec.rb

@@ -42,6 +42,13 @@ describe "asciidoctor integration" do
       publisher = {Publisher},
       year = {2000}
     }
+
+    @article{Qux00,
+      author = {Qux Zot},
+      title =	{Title},
+      publisher = {Publisher},
+      year = {3000}
+    }
   BIBTEX
 
   describe "testing procedure" do
@@ -75,10 +82,10 @@ describe "asciidoctor integration" do
       expect(File.read(output_path)).to include <<~'BODY'
         <div id="content">
         <div class="paragraph">
-        <p>Hello World. (<a href="#bibliography-Foo00">Bar, 2000</a>)</p>
+        <p>Hello World. (<a href="#bibliography-default-Foo00">Bar, 2000</a>)</p>
         </div>
         <div class="paragraph">
-        <p><a id="bibliography-Foo00"></a>Bar, F. (2000). Title.</p>
+        <p><a id="bibliography-default-Foo00"></a>Bar, F. (2000). Title.</p>
         </div>
         </div>
       BODY
@@ -105,13 +112,101 @@ describe "asciidoctor integration" do
       expect(File.read(output_path)).to include <<~'BODY'
         <div id="content">
         <div class="paragraph">
-        <p>Hello World. (<a href="#bibliography-Foo00">Bar, 2000</a>)</p>
+        <p>Hello World. (<a href="#bibliography-default-Foo00">Bar, 2000</a>)</p>
         </div>
         <div class="paragraph">
-        <p>This is content from a nested file. (<a href="#bibliography-Foo00">Bar, 2000</a>)</p>
+        <p>This is content from a nested file. (<a href="#bibliography-default-Foo00">Bar, 2000</a>)</p>
         </div>
         <div class="paragraph">
-        <p><a id="bibliography-Foo00"></a>Bar, F. (2000). Title.</p>
+        <p><a id="bibliography-default-Foo00"></a>Bar, F. (2000). Title.</p>
+        </div>
+        </div>
+      BODY
+    end
+  end
+
+  describe "multiple bibliographies usage" do
+    it "works with a single file and multiple bibliographies" do
+      setup_file tmpdir, "nested.adoc", <<~ADOC
+        This is content from a nested file. cite:[Foo00]
+
+        bibliography::[]
+      ADOC
+
+      input_path, output_path = setup_main_document tmpdir, <<~ADOC
+        :bibliography-database: #{bibliography_path}
+
+        ## Citations
+
+        cite:[Foo00]
+
+        cite:first[Qux00]
+
+        cite:first[Foo00]+last[Qux00]
+
+        ## Bibliographies
+
+        ### Default
+
+        bibliography::[]
+
+        ### First
+
+        bibliography::first[]
+
+        ### Last
+
+        bibliography::last[]
+      ADOC
+
+      expect { `asciidoctor -r asciidoctor-bibliography #{input_path} --trace` }.to_not raise_exception
+      expect(File.read(output_path)).to include <<~'BODY'
+        <div id="content">
+        <div class="sect1">
+        <h2 id="_citations">Citations</h2>
+        <div class="sectionbody">
+        <div class="paragraph">
+        <p>(<a href="#bibliography-default-Foo00">Bar, 2000</a>)</p>
+        </div>
+        <div class="paragraph">
+        <p>(<a href="#bibliography-first-Qux00">Zot, 3000</a>)</p>
+        </div>
+        <div class="paragraph">
+        <p>(<a href="#bibliography-first-Foo00">Bar, 2000</a>; <a href="#bibliography-last-Qux00">Zot, 3000</a>)</p>
+        </div>
+        </div>
+        </div>
+        <div class="sect1">
+        <h2 id="_bibliographies">Bibliographies</h2>
+        <div class="sectionbody">
+        <div class="sect2">
+        <h3 id="_default">Default</h3>
+        <div class="paragraph">
+        <p><a id="bibliography-default-Foo00"></a>Bar, F. (2000). Title.</p>
+        </div>
+        <div class="paragraph">
+        <p><a id="bibliography-default-Qux00"></a>Zot, Q. (3000). Title.</p>
+        </div>
+        </div>
+        <div class="sect2">
+        <h3 id="_first">First</h3>
+        <div class="paragraph">
+        <p><a id="bibliography-first-Foo00"></a>Bar, F. (2000). Title.</p>
+        </div>
+        <div class="paragraph">
+        <p><a id="bibliography-first-Qux00"></a>Zot, Q. (3000). Title.</p>
+        </div>
+        </div>
+        <div class="sect2">
+        <h3 id="_last">Last</h3>
+        <div class="paragraph">
+        <p><a id="bibliography-last-Foo00"></a>Bar, F. (2000). Title.</p>
+        </div>
+        <div class="paragraph">
+        <p><a id="bibliography-last-Qux00"></a>Zot, Q. (3000). Title.</p>
+        </div>
+        </div>
+        </div>
         </div>
         </div>
       BODY

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-bibliography
 version: !ruby/object:Gem::Version
-  version: 0.4.4
+  version: 0.5.0
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-01 00:00:00.000000000 Z
+date: 2019-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -258,6 +258,7 @@ files:
 - samples/standard/sample-din.html
 - samples/standard/sample-ieee.adoc
 - samples/standard/sample-ieee.html
+- samples/standard/sample-targets.adoc
 - samples/tex/biblio.bib
 - samples/tex/sample-authoryear.adoc
 - samples/tex/sample-authoryear.html
@@ -319,8 +320,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Citations and bibliography the "asciidoctor-way"