RubyGems - asciidoctor-bibliography - Versions diffs - 0.2.1 → 0.3.0 - Mend

asciidoctor-bibliography 0.2.1 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (48) hide show

checksums.yaml +4 -4
data/.codeclimate.yml +5 -0
data/.gitignore +8 -2
data/.hound.yml +3 -0
data/.oss-guides.rubocop.yml +1076 -0
data/.rubocop.yml +4 -10
data/.travis.yml +2 -1
data/Gemfile +1 -1
data/README.adoc +224 -24
data/Rakefile +2 -2
data/asciidoctor-bibliography.gemspec +23 -23
data/lib/asciidoctor-bibliography.rb +2 -2
data/lib/asciidoctor-bibliography/asciidoctor.rb +4 -4
data/lib/asciidoctor-bibliography/asciidoctor/bibliographer_preprocessor.rb +9 -56
data/lib/asciidoctor-bibliography/bibliographer.rb +6 -7
data/lib/asciidoctor-bibliography/citation.rb +56 -53
data/lib/asciidoctor-bibliography/citation_item.rb +19 -10
data/lib/asciidoctor-bibliography/database.rb +18 -6
data/lib/asciidoctor-bibliography/databases/bibtex.rb +10 -10
data/lib/asciidoctor-bibliography/errors.rb +16 -0
data/lib/asciidoctor-bibliography/formatters/csl.rb +13 -2
data/lib/asciidoctor-bibliography/formatters/tex.rb +42 -44
data/lib/asciidoctor-bibliography/helpers.rb +9 -9
data/lib/asciidoctor-bibliography/index.rb +17 -13
data/lib/asciidoctor-bibliography/options.rb +97 -0
data/lib/asciidoctor-bibliography/version.rb +1 -1
data/samples/latex_macros_in_bibtex/sample.adoc +1 -1
data/samples/standard/sample-default.adoc +3 -3
data/samples/standard/sample-default.html +9 -8
data/samples/standard/sample-din.adoc +1 -1
data/samples/standard/sample-din.html +4 -3
data/samples/standard/sample-ieee.adoc +1 -1
data/samples/standard/sample-ieee.html +4 -3
data/samples/tex/sample-authoryear.adoc +7 -17
data/samples/tex/sample-authoryear.html +10 -32
data/samples/tex/sample-numbers.adoc +7 -18
data/samples/tex/sample-numbers.html +7 -29
data/samples/tex/{sample-ordering.adoc → sample-sort.adoc} +6 -4
data/spec/citation_item_spec.rb +67 -19
data/spec/database_spec.rb +21 -16
data/spec/helpers_spec.rb +46 -44
data/spec/options_spec.rb +43 -0
data/spec/spec_helper.rb +53 -55
metadata +9 -7
data/lib/asciidoctor-bibliography/exceptions.rb +0 -5
data/samples/tex/sample-din.adoc +0 -74
data/samples/tex/sample-din.html +0 -556
data/samples/tex/sample-ordering.html +0 -467

data/samples/tex/sample-numbers.adoc CHANGED Viewed

@@ -1,26 +1,11 @@
 = Sample usage of asciidoctor-bibliography
 :bibliography-database: biblio.bib
-:bibliography-order: appearance
-:bibliography-citation-style: numbers
-:bibliography-reference-style: ieee
+:bibliography-tex-style: numbers
+:bibliography-style: ieee
-## Standard
-cite:[Anderson04]
+## Citations
-cite:[Anderson04, page=10]
-cite:[Anderson04, chapter=10]
-cite:[Anderson04, page=10, chapter=12]
-cite:[Lane12a]+[Lane12b]
-cite:[Lane12b]+[Lane12a]
-## TeX-compatible
-fullcite:[Anderson04] (fullcite, single)
 citet:[Anderson04] (citet, single)
@@ -70,7 +55,11 @@ citeyearpar:[Anderson04] (citeyearpar, single)
 citeyearpar:[Lane12a]+[Lane12b] (citeyearpar, multiple)
+fullcite:[Anderson04] (fullcite)
 ## Bibliography
 bibliography::[]

data/samples/tex/sample-numbers.html CHANGED Viewed

@@ -5,7 +5,7 @@
 <!--[if IE]><meta http-equiv="X-UA-Compatible" content="IE=edge"><![endif]-->
 <meta name="viewport" content="width=device-width, initial-scale=1.0">
 <meta name="generator" content="Asciidoctor 1.5.6.1">
-<title>Standard</title>
+<title>Sample usage of asciidoctor-bibliography</title>
 <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700">
 <style>
 /* Asciidoctor default stylesheet | MIT License | http://asciidoctor.org */
@@ -427,38 +427,13 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
 </head>
 <body class="article">
 <div id="header">
+<h1>Sample usage of asciidoctor-bibliography</h1>
 </div>
 <div id="content">
 <div class="sect1">
-<h2 id="_standard">Standard</h2>
+<h2 id="_citations">Citations</h2>
 <div class="sectionbody">
 <div class="paragraph">
-<p><a href="#bibliography-Anderson04">[1]</a></p>
-</div>
-<div class="paragraph">
-<p><a href="#bibliography-Anderson04">[1, P. 10]</a></p>
-</div>
-<div class="paragraph">
-<p><a href="#bibliography-Anderson04">[1, Ch. 10]</a></p>
-</div>
-<div class="paragraph">
-<p><a href="#bibliography-Anderson04">[1, Ch. 12]</a></p>
-</div>
-<div class="paragraph">
-<p><a href="#bibliography-Lane12a">[2]</a>, <a href="#bibliography-Lane12b">[3]</a></p>
-</div>
-<div class="paragraph">
-<p><a href="#bibliography-Lane12a">[2]</a>, <a href="#bibliography-Lane12b">[3]</a></p>
-</div>
-</div>
-</div>
-<div class="sect1">
-<h2 id="_tex_compatible">TeX-compatible</h2>
-<div class="sectionbody">
-<div class="paragraph">
-<p>J. R. Anderson, D. Bothell, M. D. Byrne, S. Douglass, C. Lebiere, and Y. L. Qin, “An integrated theory of the mind,” <em>Psychological Review</em>, vol. 111, no. 4, pp. 1036–1060, 2004. (fullcite, single)</p>
-</div>
-<div class="paragraph">
 <p><a href="#bibliography-Anderson04">Anderson et al. [1]</a> (citet, single)</p>
 </div>
 <div class="paragraph">
@@ -530,6 +505,9 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
 <div class="paragraph">
 <p>[<a href="#bibliography-Lane12a">2000</a>, <a href="#bibliography-Lane12b">2000</a>] (citeyearpar, multiple)</p>
 </div>
+<div class="paragraph">
+<p>J. R. Anderson, D. Bothell, M. D. Byrne, S. Douglass, C. Lebiere, and Y. L. Qin, “An integrated theory of the mind,” <em>Psychological Review</em>, vol. 111, no. 4, pp. 1036–1060, 2004. (fullcite)</p>
+</div>
 </div>
 </div>
 <div class="sect1">
@@ -549,7 +527,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2017-09-09 20:55:40 CEST
+Last updated 2017-09-17 18:31:26 CEST
 </div>
 </div>
 </body>

data/samples/tex/{sample-ordering.adoc → sample-sort.adoc} RENAMED Viewed

@@ -1,10 +1,11 @@
 = Sample usage of asciidoctor-bibliography
 :bibliography-database: biblio.bib
-:bibliography-order: alphabetical
-:bibliography-citation-style: numbers
-:bibliography-reference-style: ieee
+:bibliography-tex-style: numbers
+:bibliography-style: ieee
+:bibliography-sort: { macro: author, sort: descending }
-## Standard
+## Citations
 cite:[Lane12a]
@@ -16,5 +17,6 @@ cite:[Anderson04]
 ## Bibliography
 bibliography::[]

data/spec/citation_item_spec.rb CHANGED Viewed

@@ -1,52 +1,100 @@
-require 'asciidoctor-bibliography/helpers'
+require "asciidoctor-bibliography/helpers"
 describe AsciidoctorBibliography::CitationItem do
-  describe '.new' do
-    it 'can be mutely initialized' do
+  describe ".new" do
+    it "can be mutely initialized" do
       expect { described_class.new }.to_not raise_exception
     end
-    it 'can be initialized with a block operating on itself' do
+    it "can be initialized with a block operating on itself" do
       itself = nil
       expect(described_class.new { |ci| itself = ci }).to be(itself)
     end
   end
-  describe '#parse_attribute_list' do
+  describe "#parse_attribute_list" do
     subject { described_class.new }
     before do
-      subject.parse_attribute_list 'foo, lol=bar, baz, qux, zod=13'
+      subject.parse_attribute_list "foo, lol=bar, baz, qux, zod=13"
     end
-    it 'treats the first positional attribute as the id' do
-      expect(subject.key).to eq 'foo'
+    it "treats the first positional attribute as the id" do
+      expect(subject.key).to eq "foo"
     end
-    it 'extracts the positional attributes in order, except the first one' do
-      expect(subject.positional_attributes).to eq ['baz', 'qux']
+    it "extracts the positional attributes in order, except the first one" do
+      expect(subject.positional_attributes).to eq ["baz", "qux"]
     end
-    it 'extracts all named attributes' do
-      expect(subject.named_attributes).to eq({'lol' => 'bar', 'zod' => '13'})
+    it "extracts all named attributes" do
+      expect(subject.named_attributes).to eq("lol" => "bar", "zod" => "13")
     end
   end
-  describe '#locators' do
+  describe "#locators" do
     subject { described_class.new }
-    it 'returns no locators if none are present' do
-      subject.parse_attribute_list 'foo, lol=bar, baz, qux, zod=13'
-      expect(subject.locators).to eq ({})
+    it "returns no locator if none are present" do
+      subject.parse_attribute_list "foo, lol=bar, baz, qux, zod=42"
+      expect(subject.locator).to be_nil
     end
-    it 'recognizes all CSL locators' do
-      locators = %w[book chapter column figure folio issue line note opus page paragraph part section sub-verbo verse volume]
+    it "recognizes all CSL locators" do
+      locators = %w[book chapter column figure folio issue line note opus
+                    page paragraph part section sub-verbo verse volume]
       locators_hash = locators.map { |l| [l, rand(10).to_s] }.to_h
-      locators_string = locators_hash.to_a.map { |a| a.join '=' }.join(', ')
+      locators_string = locators_hash.to_a.map { |a| a.join "=" }.join(", ")
       subject.parse_attribute_list "foo, #{locators_string}"
       expect(subject.locators).to eq locators_hash
     end
+    it "recognizes non standard locator" do
+      subject.parse_attribute_list "foo, locator=' somewhere'"
+      expect(subject.locators).to eq("locator" => " somewhere")
+    end
+  end
+  describe "#locator" do
+    subject { described_class.new }
+    it "returns the first locator if existing" do
+      subject.parse_attribute_list("foo, page=42, locator=bar, chapter=24")
+      expect(subject.locator).to eq(%w[page 42])
+    end
+    it "returns nil if no loctor exist" do
+      subject.parse_attribute_list("foo, bar, zod=quz")
+      expect(subject.locator).to be_nil
+    end
+  end
+  describe "#prefix" do
+    subject { described_class.new }
+    it "returns the prefix if it exist" do
+      subject.parse_attribute_list("foo, prefix=bar")
+      expect(subject.prefix).to eq("bar")
+    end
+    it "returns nil if no prefix exists" do
+      subject.parse_attribute_list("foo, bar, zod=quz")
+      expect(subject.prefix).to be_nil
+    end
+  end
+  describe "#suffix" do
+    subject { described_class.new }
+    it "returns the suffix if it exist" do
+      subject.parse_attribute_list("foo, suffix=bar")
+      expect(subject.suffix).to eq("bar")
+    end
+    it "returns nil if no suffix exists" do
+      subject.parse_attribute_list("foo, bar, zod=quz")
+      expect(subject.suffix).to be_nil
+    end
   end
 end

data/spec/database_spec.rb CHANGED Viewed

@@ -1,39 +1,44 @@
-require 'asciidoctor-bibliography/helpers'
+require "asciidoctor-bibliography/helpers"
 describe AsciidoctorBibliography::Database do
-  describe '.new' do
-    it 'is by default an empty array' do
+  describe ".new" do
+    it "is by default an empty array" do
       expect(described_class.new).to eq([])
     end
-    it 'can be initialized with a single database' do
+    it "can be initialized with a single database" do
       expect(described_class.new("spec/fixtures/database.bib")).to_not eq([])
     end
-    it 'can be initialized with a list of databases' do
+    it "can be initialized with a list of databases" do
       expect(described_class.new("spec/fixtures/database.bib", "spec/fixtures/database.bibtex")).to_not eq([])
     end
   end
-  describe '#append' do
+  describe "#append" do
     let(:db) { described_class.new }
-    it 'can load and concatenate databases after initialization' do
+    it "can load and concatenate databases after initialization" do
       expect(db.length).to eq(0)
-      expect { db.append("spec/fixtures/database.bib") }.to change { db.length }
-      expect { db.append("spec/fixtures/database.bibtex") }.to change { db.length }
+      expect { db.append("spec/fixtures/database.bib") }.to(change { db.length })
+      expect { db.append("spec/fixtures/database.bibtex") }.to(change { db.length })
     end
   end
-  describe '.load' do
-    it 'raises error if given unknown format' do
-      expect { described_class.load 'spec/fixtures/database.unk' }
-        .to raise_exception AsciidoctorBibliography::Exceptions::DatabaseFormatNotSupported
+  describe ".load" do
+    it "raises error if given non existing file" do
+      expect { described_class.load "spec/fixtures/database.xxx" }.
+        to raise_exception AsciidoctorBibliography::Errors::Database::FileNotFound
     end
-    it 'recognizes Bib(La)Tex databases' do
-      expect { described_class.load 'spec/fixtures/database.bib' }.to_not raise_exception
-      expect { described_class.load 'spec/fixtures/database.bibtex' }.to_not raise_exception
+    it "raises error if given unknown format" do
+      expect { described_class.load "spec/fixtures/database.unk" }.
+        to raise_exception AsciidoctorBibliography::Errors::Database::UnsupportedFormat
+    end
+    it "recognizes Bib(La)Tex databases" do
+      expect { described_class.load "spec/fixtures/database.bib" }.to_not raise_exception
+      expect { described_class.load "spec/fixtures/database.bibtex" }.to_not raise_exception
     end
   end
 end

data/spec/helpers_spec.rb CHANGED Viewed

@@ -1,71 +1,73 @@
-require 'asciidoctor-bibliography/helpers'
+require "asciidoctor-bibliography/helpers"
 describe AsciidoctorBibliography::Helpers do
-  describe '.slice' do
-    it 'finds one or more existing keys' do
-      expect(subject.slice({ foo: 'bar', baz: 'qux' }, :foo)).to eq({ foo: 'bar' })
-      expect(subject.slice({ foo: 'bar', baz: 'qux' }, :foo, :baz)).to eq({ foo: 'bar', baz: 'qux' })
+  describe ".slice" do
+    it "finds one or more existing keys" do
+      expect(subject.slice({ foo: "bar", baz: "qux" }, :foo)).to eq(foo: "bar")
+      expect(subject.slice({ foo: "bar", baz: "qux" }, :foo, :baz)).to eq(foo: "bar", baz: "qux")
     end
-    it 'returns nil for missing keys' do
-      expect(subject.slice({}, :foo)).to eq({ foo: nil })
-      expect(subject.slice({ foo: 'bar' }, :bar)).to eq({ bar: nil })
-      expect(subject.slice({ foo: 'bar' }, :foo, :baz)).to eq({ foo: 'bar', baz: nil })
+    it "returns nil for missing keys" do
+      expect(subject.slice({}, :foo)).to eq(foo: nil)
+      expect(subject.slice({ foo: "bar" }, :bar)).to eq(bar: nil)
+      expect(subject.slice({ foo: "bar" }, :foo, :baz)).to eq(foo: "bar", baz: nil)
     end
   end
-  describe '.join_nonempty' do
-    it 'ignores nils' do
-      expect(subject.join_nonempty([nil], '-')).to eq('')
-      expect(subject.join_nonempty(['foo', nil], '-')).to eq('foo')
-      expect(subject.join_nonempty([nil, 'bar'], '-')).to eq('bar')
-      expect(subject.join_nonempty(['foo', nil, 'bar'], '-')).to eq('foo-bar')
+  describe ".join_nonempty" do
+    it "ignores nils" do
+      expect(subject.join_nonempty([nil], "-")).to eq("")
+      expect(subject.join_nonempty(["foo", nil], "-")).to eq("foo")
+      expect(subject.join_nonempty([nil, "bar"], "-")).to eq("bar")
+      expect(subject.join_nonempty(["foo", nil, "bar"], "-")).to eq("foo-bar")
     end
-    it 'ignores empty strings' do
-      expect(subject.join_nonempty([''], '-')).to eq('')
-      expect(subject.join_nonempty(['foo', ''], '-')).to eq('foo')
-      expect(subject.join_nonempty(['', 'bar'], '-')).to eq('bar')
-      expect(subject.join_nonempty(['foo', '', 'bar'], '-')).to eq('foo-bar')
+    it "ignores empty strings" do
+      expect(subject.join_nonempty([""], "-")).to eq("")
+      expect(subject.join_nonempty(["foo", ""], "-")).to eq("foo")
+      expect(subject.join_nonempty(["", "bar"], "-")).to eq("bar")
+      expect(subject.join_nonempty(["foo", "", "bar"], "-")).to eq("foo-bar")
     end
   end
-  describe '.html_to_asciidoc' do
-    it 'converts italic' do
-      expect(subject.html_to_asciidoc('This is <i>italic</i>.')).to eq('This is _italic_.')
+  describe ".html_to_asciidoc" do
+    it "converts italic" do
+      expect(subject.html_to_asciidoc("This is <i>italic</i>.")).to eq("This is _italic_.")
     end
-    it 'converts bold' do
-      expect(subject.html_to_asciidoc('This is <b>bold</b>.')).to eq('This is *bold*.')
+    it "converts bold" do
+      expect(subject.html_to_asciidoc("This is <b>bold</b>.")).to eq("This is *bold*.")
     end
-    it 'drops spans' do
-      expect(subject.html_to_asciidoc('This is a <span attribute="value">span</span>.'))
-        .to eq('This is a span.')
+    it "drops spans" do
+      expect(subject.html_to_asciidoc('This is a <span attribute="value">span</span>.')).
+        to eq("This is a span.")
     end
-    it 'drops curly brackets' do
-      expect(subject.html_to_asciidoc('This is {bracketed}.'))
-        .to eq('This is bracketed.')
+    it "drops curly brackets" do
+      expect(subject.html_to_asciidoc("This is {bracketed}.")).
+        to eq("This is bracketed.")
     end
   end
-  describe '.to_sentence' do
-    let(:new_options) { { words_connector:     '1',
-                          two_words_connector: '2',
-                          last_word_connector: '3' } }
+  describe ".to_sentence" do
+    let(:new_options) do
+      { words_connector:     "1",
+        two_words_connector: "2",
+        last_word_connector: "3" }
+    end
-    it 'concatenates arbitrary arrays' do
-      expect(subject.to_sentence([])).to eq('')
-      expect(subject.to_sentence(['foo'])).to eq('foo')
-      expect(subject.to_sentence(['foo', 'bar'])).to eq('foo and bar')
-      expect(subject.to_sentence(['foo', 'bar', 'baz'])).to eq('foo, bar, and baz')
-      expect(subject.to_sentence(['foo', 'bar', 'baz', 'qux'])).to eq('foo, bar, baz, and qux')
+    it "concatenates arbitrary arrays" do
+      expect(subject.to_sentence([])).to eq("")
+      expect(subject.to_sentence(["foo"])).to eq("foo")
+      expect(subject.to_sentence(["foo", "bar"])).to eq("foo and bar")
+      expect(subject.to_sentence(["foo", "bar", "baz"])).to eq("foo, bar, and baz")
+      expect(subject.to_sentence(["foo", "bar", "baz", "qux"])).to eq("foo, bar, baz, and qux")
     end
-    it 'accepts custom separators' do
-      expect(subject.to_sentence(['foo', 'bar'], new_options)).to eq('foo2bar')
-      expect(subject.to_sentence(['foo', 'bar', 'baz'], new_options)).to eq('foo1bar3baz')
+    it "accepts custom separators" do
+      expect(subject.to_sentence(["foo", "bar"], new_options)).to eq("foo2bar")
+      expect(subject.to_sentence(["foo", "bar", "baz"], new_options)).to eq("foo1bar3baz")
     end
   end
 end

data/spec/options_spec.rb ADDED Viewed

@@ -0,0 +1,43 @@
+require "asciidoctor-bibliography/helpers"
+describe AsciidoctorBibliography::Options do
+  describe "#database" do
+    it "has no default" do
+      expect { described_class.new.database }.
+        to raise_exception AsciidoctorBibliography::Errors::Options::Missing
+    end
+    it "returns the provided database name" do
+      expect(described_class.new.merge("bibliography-database" => "foobar").database).to eq("foobar")
+    end
+  end
+  describe "#hyperlinks?" do
+    it "defaults to true" do
+      expect(described_class.new.hyperlinks?).to be true
+    end
+    it "returns true when provided option is true" do
+      expect(described_class.new.merge("bibliography-hyperlinks" => "false").hyperlinks?).to be false
+    end
+    it "returns true when provided option is true" do
+      expect(described_class.new.merge("bibliography-hyperlinks" => "true").hyperlinks?).to be true
+    end
+    it "raises an error when provided option is invalid" do
+      expect { described_class.new.merge("bibliography-hyperlinks" => "foo").hyperlinks? }.
+        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"
+    end
+    it "returns the provided style name" do
+      expect(described_class.new.merge("bibliography-style" => "foobar").style).to eq("foobar")
+    end
+  end
+end