asciidoctor-bibliography 0.3.0 → 0.4.0

data/spec/csl/styles/tex_citet_numeric_spec.rb

@@ -0,0 +1,42 @@
+# coding: utf-8
+
+require_relative "../../citation_helper"
+
+describe "citet macro with numeric style" do
+  let(:options) { { "bibliography-tex-style" => "numeric" } }
+
+  it "formats a single citation" do
+    expect(formatted_citation("citet:[Erdos65]", options: options)).
+      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]"
+  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]"
+  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]"
+  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]"
+  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]"
+  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]"
+  end
+end

data/spec/csl/styles/tex_citets_authoryear_spec.rb

@@ -0,0 +1,42 @@
+# coding: utf-8
+
+require_relative "../../citation_helper"
+
+describe "citet* macro with authoryear style" do
+  let(:options) { { "bibliography-tex-style" => "authoryear" } }
+
+  it "formats a single citation" do
+    expect(formatted_citation("citet*:[Erdos65]", options: options)).
+      to eq "Erdős, Heyting, and Brouwer (1965)"
+  end
+
+  it "formats a grouped citation" do
+    expect(formatted_citation("citet*:[Erdos65]+[Einstein35]", options: options)).
+      to eq "Erdős, Heyting, and Brouwer (1965); Einstein, Podolsky, and Rosen (1935)"
+  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 1965)"
+  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 (1965, 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 1965, 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 (1965, 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 (1965, somewhere)"
+  end
+end

data/spec/csl/styles/tex_citets_numeric_spec.rb

@@ -0,0 +1,42 @@
+# coding: utf-8
+
+require_relative "../../citation_helper"
+
+describe "citet* macro with numeric style" do
+  let(:options) { { "bibliography-tex-style" => "numeric" } }
+
+  it "formats a single citation" do
+    expect(formatted_citation("citet*:[Erdos65]", options: options)).
+      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]"
+  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]"
+  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]"
+  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]"
+  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]"
+  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]"
+  end
+end

data/spec/csl/styles/tex_citeyear_authoryear_spec.rb

@@ -0,0 +1,42 @@
+# coding: utf-8
+
+require_relative "../../citation_helper"
+
+describe "citeyear macro with authoryear style" do
+  let(:options) { { "bibliography-tex-style" => "authoryear" } }
+
+  it "formats a single citation" do
+    expect(formatted_citation("citeyear:[Erdos65]", options: options)).
+      to eq "1965"
+  end
+
+  it "formats a grouped citation" do
+    expect(formatted_citation("citeyear:[Erdos65]+[Einstein35]", options: options)).
+      to eq "1965; 1935"
+  end
+
+  it "formats a single citation with a prefix" do
+    expect(formatted_citation("citeyear:[Erdos65, prefix=see]", options: options)).
+      to eq "see 1965"
+  end
+
+  it "formats a single citation with a suffix" do
+    expect(formatted_citation("citeyear:[Erdos65, suffix=new edition]", options: options)).
+      to eq "1965, new edition"
+  end
+
+  it "formats a single citation with both a prefix and a suffix" do
+    expect(formatted_citation("citeyear:[Erdos65, prefix=see, suffix=new edition]", options: options)).
+      to eq "see 1965, new edition"
+  end
+
+  it "formats a single citation with a standard locator" do
+    expect(formatted_citation("citeyear:[Erdos65, page=41-43]", options: options)).
+      to eq "1965, pp. 41-43"
+  end
+
+  it "formats a single citation with a custom locator" do
+    expect(formatted_citation("citeyear:[Erdos65, locator=somewhere]", options: options)).
+      to eq "1965, somewhere"
+  end
+end

data/spec/csl/styles/tex_citeyear_numeric_spec.rb

@@ -0,0 +1,42 @@
+# coding: utf-8
+
+require_relative "../../citation_helper"
+
+describe "citeyear macro with numeric style" do
+  let(:options) { { "bibliography-tex-style" => "numeric" } }
+
+  it "formats a single citation" do
+    expect(formatted_citation("citeyear:[Erdos65]", options: options)).
+      to eq "1965"
+  end
+
+  it "formats a grouped citation" do
+    expect(formatted_citation("citeyear:[Erdos65]+[Einstein35]", options: options)).
+      to eq "1965, 1935"
+  end
+
+  it "formats a single citation with a prefix" do
+    expect(formatted_citation("citeyear:[Erdos65, prefix=see]", options: options)).
+      to eq "see 1965"
+  end
+
+  it "formats a single citation with a suffix" do
+    expect(formatted_citation("citeyear:[Erdos65, suffix=new edition]", options: options)).
+      to eq "1965, new edition"
+  end
+
+  it "formats a single citation with both a prefix and a suffix" do
+    expect(formatted_citation("citeyear:[Erdos65, prefix=see, suffix=new edition]", options: options)).
+      to eq "see 1965, new edition"
+  end
+
+  it "formats a single citation with a standard locator" do
+    expect(formatted_citation("citeyear:[Erdos65, page=41-43]", options: options)).
+      to eq "1965, pp. 41-43"
+  end
+
+  it "formats a single citation with a custom locator" do
+    expect(formatted_citation("citeyear:[Erdos65, locator=somewhere]", options: options)).
+      to eq "1965, somewhere"
+  end
+end

data/spec/csl/styles/tex_citeyearpar_authoryear_spec.rb

@@ -0,0 +1,42 @@
+# coding: utf-8
+
+require_relative "../../citation_helper"
+
+describe "citeyearpar macro with authoryear style" do
+  let(:options) { { "bibliography-tex-style" => "authoryear" } }
+
+  it "formats a single citation" do
+    expect(formatted_citation("citeyearpar:[Erdos65]", options: options)).
+      to eq "(1965)"
+  end
+
+  it "formats a grouped citation" do
+    expect(formatted_citation("citeyearpar:[Erdos65]+[Einstein35]", options: options)).
+      to eq "(1965; 1935)"
+  end
+
+  it "formats a single citation with a prefix" do
+    expect(formatted_citation("citeyearpar:[Erdos65, prefix=see]", options: options)).
+      to eq "(see 1965)"
+  end
+
+  it "formats a single citation with a suffix" do
+    expect(formatted_citation("citeyearpar:[Erdos65, suffix=new edition]", options: options)).
+      to eq "(1965, new edition)"
+  end
+
+  it "formats a single citation with both a prefix and a suffix" do
+    expect(formatted_citation("citeyearpar:[Erdos65, prefix=see, suffix=new edition]", options: options)).
+      to eq "(see 1965, new edition)"
+  end
+
+  it "formats a single citation with a standard locator" do
+    expect(formatted_citation("citeyearpar:[Erdos65, page=41-43]", options: options)).
+      to eq "(1965, pp. 41-43)"
+  end
+
+  it "formats a single citation with a custom locator" do
+    expect(formatted_citation("citeyearpar:[Erdos65, locator=somewhere]", options: options)).
+      to eq "(1965, somewhere)"
+  end
+end

data/spec/csl/styles/tex_citeyearpar_numeric_spec.rb

@@ -0,0 +1,42 @@
+# coding: utf-8
+
+require_relative "../../citation_helper"
+
+describe "citeyearpar macro with numeric style" do
+  let(:options) { { "bibliography-tex-style" => "numeric" } }
+
+  it "formats a single citation" do
+    expect(formatted_citation("citeyearpar:[Erdos65]", options: options)).
+      to eq "[1965]"
+  end
+
+  it "formats a grouped citation" do
+    expect(formatted_citation("citeyearpar:[Erdos65]+[Einstein35]", options: options)).
+      to eq "[1965, 1935]"
+  end
+
+  it "formats a single citation with a prefix" do
+    expect(formatted_citation("citeyearpar:[Erdos65, prefix=see]", options: options)).
+      to eq "[see 1965]"
+  end
+
+  it "formats a single citation with a suffix" do
+    expect(formatted_citation("citeyearpar:[Erdos65, suffix=new edition]", options: options)).
+      to eq "[1965, new edition]"
+  end
+
+  it "formats a single citation with both a prefix and a suffix" do
+    expect(formatted_citation("citeyearpar:[Erdos65, prefix=see, suffix=new edition]", options: options)).
+      to eq "[see 1965, new edition]"
+  end
+
+  it "formats a single citation with a standard locator" do
+    expect(formatted_citation("citeyearpar:[Erdos65, page=41-43]", options: options)).
+      to eq "[1965, pp. 41-43]"
+  end
+
+  it "formats a single citation with a custom locator" do
+    expect(formatted_citation("citeyearpar:[Erdos65, locator=somewhere]", options: options)).
+      to eq "[1965, somewhere]"
+  end
+end

data/spec/database_spec.rb

@@ -1,4 +1,4 @@
-require "asciidoctor-bibliography/helpers"
+# coding: utf-8
 
 describe AsciidoctorBibliography::Database do
   describe ".new" do
@@ -15,6 +15,25 @@ describe AsciidoctorBibliography::Database do
     end
   end
 
+  describe "#find_entry_by_id" do
+    subject { described_class.new("spec/fixtures/database.bib") }
+
+    it "finds an existing id" do
+      expect { subject.find_entry_by_id("foo") }.
+        to raise_exception AsciidoctorBibliography::Errors::Database::IdNotFound
+    end
+
+    it "raises error if asked to retrieve unexisting id" do
+      expect(subject.find_entry_by_id("Lane12a")).
+        to eq("author" => [{ "family" => "Lane", "given" => "P." }],
+              "title" => "Book title",
+              "publisher" => "Publisher",
+              "id" => "Lane12a",
+              "issued" => { "date-parts" => [[2000]] },
+              "type" => "book")
+    end
+  end
+
   describe "#append" do
     let(:db) { described_class.new }
 

data/spec/macros_spec.rb

@@ -0,0 +1,21 @@
+# coding: utf-8
+
+require_relative "citation_helper"
+
+describe "cite macro with apa style" do
+  it "formats a complex citation" 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])"
+  end
+end
+
+describe "fullcite macro with apa style" do
+  it "formats a complex citation" do
+    expect(formatted_citation("fullcite:[Erdos65]",
+                              options: { "bibliography-style" => "apa" })).
+      to eq "Erdős, P., Heyting, A., & Brouwer, L. E. (1965). Some very hard sums. _Difficult Maths Today_, 30."
+  end
+end

data/spec/options_spec.rb

@@ -1,4 +1,4 @@
-require "asciidoctor-bibliography/helpers"
+require "asciidoctor"
 
 describe AsciidoctorBibliography::Options do
   describe "#database" do
@@ -31,6 +31,36 @@ describe AsciidoctorBibliography::Options do
     end
   end
 
+  describe "#locale" do
+    it "defaults to en-US" do
+      expect(described_class.new.locale).to eq "en-US"
+    end
+
+    it "returns the provided option when set" do
+      expect(described_class.new.merge("bibliography-locale" => "it-IT").locale).to eq "it-IT"
+    end
+
+    it "raises an error when provided option is invalid" do
+      expect { described_class.new.merge("bibliography-locale" => "foo").locale }.
+        to raise_exception AsciidoctorBibliography::Errors::Options::Invalid
+    end
+  end
+
+  describe "#tex_style" do
+    it "defaults to en-US" do
+      expect(described_class.new.tex_style).to eq "authoryear"
+    end
+
+    it "returns the provided option when set" do
+      expect(described_class.new.merge("bibliography-tex-style" => "numeric").tex_style).to eq "numeric"
+    end
+
+    it "raises an error when provided option is invalid" do
+      expect { described_class.new.merge("bibliography-tex-style" => "foo").tex_style }.
+        to raise_exception AsciidoctorBibliography::Errors::Options::Invalid
+    end
+  end
+
   describe "#style" do
     it "defaults to apa" do
       expect(described_class.new.style).to eq "apa"
@@ -40,4 +70,78 @@ describe AsciidoctorBibliography::Options do
       expect(described_class.new.merge("bibliography-style" => "foobar").style).to eq("foobar")
     end
   end
+
+  describe "#sort" do
+    it "defaults to nil" do
+      expect(described_class.new.sort).to be nil
+    end
+
+    it "parses and returns an empty array" do
+      expect(described_class.new.merge("bibliography-sort" => "[]").sort).
+        to eq([])
+    end
+
+    it "parses and returns a naked hash" do
+      expect(described_class.new.merge("bibliography-sort" => "macro: author").sort).
+        to eq([{ "macro" => "author" }])
+    end
+
+    it "parses and returns a hash" do
+      expect(described_class.new.merge("bibliography-sort" => "{macro: author, sort: descending}").sort).
+        to eq([{ "macro" => "author", "sort" => "descending" }])
+    end
+
+    it "parses and returns multiple hashes" do
+      expect(described_class.new.merge("bibliography-sort" => "[{macro: author}, {variable: issued}]").sort).
+        to eq([{ "macro" => "author" }, { "variable" => "issued" }])
+    end
+
+    it "raises an error when provided option is invalid (type)" do
+      expect { described_class.new.merge("bibliography-sort" => "foo").sort }.
+        to raise_exception AsciidoctorBibliography::Errors::Options::Invalid
+    end
+
+    it "raises an error when provided option is invalid (key)" do
+      expect { described_class.new.merge("bibliography-sort" => "[{something: wrong}]").sort }.
+        to raise_exception AsciidoctorBibliography::Errors::Options::Invalid
+    end
+
+    it "raises an error when provided option is invalid (syntax)" do
+      expect { described_class.new.merge("bibliography-sort" => "foo: bar:").sort }.
+        to raise_exception AsciidoctorBibliography::Errors::Options::Invalid
+    end
+  end
+
+  describe ".new_from_reader" do
+    let(:reader) do
+      ::Asciidoctor::PreprocessorReader.new(::Asciidoctor::Document.new, <<~SOURCE.lines)
+        = This is the document title
+        :bibliography-database: foo
+        :bibliography-locale: bar
+        :bibliography-style: baz
+        :bibliography-hyperlinks: quz
+        :bibliography-order: zod
+        :bibliography-tex-style: lep
+        :bibliography-sort: kan
+        :bibliography-bogus: pow
+      SOURCE
+    end
+
+    subject { described_class.new_from_reader reader }
+
+    it "extracts all bibliography options ignoring others" do
+      expect(subject).to eq("bibliography-database" => "foo",
+                            "bibliography-locale" => "bar",
+                            "bibliography-style" => "baz",
+                            "bibliography-hyperlinks" => "quz",
+                            "bibliography-order" => "zod",
+                            "bibliography-tex-style" => "lep",
+                            "bibliography-sort" => "kan")
+    end
+
+    it "acts non-destructively on reader" do
+      expect { subject }.to_not(change { reader.lines })
+      expect { subject }.to_not(change { reader.cursor.lineno })
+    end
+  end
 end