asciidoctor-bibliography 0.7.0 → 0.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6160a0148bcc81aa588bd2c333b4cb209ffc1ec7
-  data.tar.gz: fff771f653fb8dd39bc581326748afe767c884c4
+  metadata.gz: 241505801324d38d708ac52fdf8c24755dd16ef5
+  data.tar.gz: 0a7ac064f2d07b664df8ad1405a00dc6613e5533
 SHA512:
-  metadata.gz: 252da4287ea790422111c8628686675672c5dd8422daf89c721d118a94a935b221d1f1ceb3ce3ce140d57863ff13c0489ab6424cc3e22ba04b4ff14977d9e4ef
-  data.tar.gz: 3be21ac1c4ed50b01f6cda42b898c2af9e0cead327bc17c854b32b8a6c342220a1d5736bffb084bbeb3abbc0ceee5599bf18aeb84e4e61b9062a3887bc7ad120
+  metadata.gz: c2f0719e9e1219b3d09073d430d498b142472dff3dda41543f8df80c6293ff65739c9c260ba95a92464d39c1d4a6ce5a140120009cdaef41fd15e422173a9855
+  data.tar.gz: e33ccc4676b4d5087e1ac4b38573ff3d1f7cad8b5a0ed799e5060ff968795989b965c4c9087ac4769aea48f6c77fce7ab856c15a92c652711f73e67a3d48f869

data/README.adoc

@@ -1,7 +1,7 @@
 = Citations and Bibliography the "asciidoctor-way"
 
 asciidoctor-bibliography lets you handle citations and bibliography the
-"http://asciidoctor.org/[asciidoctor]-way"!
+http://asciidoctor.org/[asciidoctor]-way!
 
 image:https://img.shields.io/gem/v/asciidoctor-bibliography.svg["Gem Version", link="https://rubygems.org/gems/asciidoctor-bibliography"]
 image:https://img.shields.io/travis/riboseinc/asciidoctor-bibliography/master.svg["Build Status", link="https://travis-ci.org/riboseinc/asciidoctor-bibliography"]
@@ -193,7 +193,11 @@ Specifying a database file is mandatory and it can be done in the header with it
 :bibliography-database: my_database.bib
 ----
 
-Currently only the `BibTeX` format is supported; more will come soon.
+Currently only the `BibTeX` format is supported, with `.bib` or `.bibtex` extensions.
+
+`BibLaTeX` databases can be used too, but only the subset of features belonging to `BibTeX`
+are safe to use: unknown attributes will be silently ignored. If the file has `.biblatex`
+extension the you will receive a warning on compilation.
 
 
 === Styling
@@ -300,9 +304,11 @@ As for the `sort` option, the valid values are `ascending` (default) and `descen
 
 === TeX-mode
 
-While the `cite` macro is reserved for CSL styling, all traditional Bib(La)TeX macros are accessible through the same syntax with their usual names:
+While the `cite` macro is reserved for CSL styling and works with thousands of styles,
+the traditional Bib(La)TeX macros are also implemented with their usual names
+and can be used with a few styles:
 
-* `citet`
+* `citet` (in `LaTeX` world `\citet` is equivalent to `\cite`)
 * `citet*`
 * `citealt`
 * `citealt*`
@@ -315,8 +321,6 @@ While the `cite` macro is reserved for CSL styling, all traditional Bib(La)TeX m
 * `citeyear`
 * `citeyearpar`
 
-NOTE: no macros are missing since `\cite` is equivalent to `\citet`!
-
 To cite multiple items you can concatenate them just like with `cite`.
 
 All macros accept standard locators, `locator`, `suffix` and `prefix`.
@@ -332,7 +336,13 @@ You can set their style in the header:
 
 Accepted values are `authoryear` (default) and `numeric`.
 
-Furthermore, `fullcite` is also available and accepts no parameters except a single reference key.
+IMPORTANT: The `cite` macro and the `cite...` macros described in this section are completely
+independent mechanisms. The former is styled with `:bibliography-style:` (thousands of styles available)
+while the latter is styled with with `:bibliography-tex-style:` (much more limited, only has the
+styles listed above).
+
+The macro `fullcite` is also available and accepts no parameters except a single reference key.
+Unlike its siblings, it is able to render CSL styles and is configured using `:bibliography-style:`.
 
 ==== Advanced options
 
@@ -350,6 +360,17 @@ Sometimes it is desirable to wrap the rendered citations in a passthrough. Using
 :bibliography-passthrough: false
 ----
 
+==== CLI usage
+
+All header attributes described above can also be passed through the commandline as is customary. E.g.:
+
+[source,console]
+----
+$ asciidoctor -r asciidoctor-bibliography -a bibliography-style=ieee my_first_document.adoc
+----
+
+Values given in such way will take highest priority.
+
 == Development
 
 We follow Sandi Metz's Rules for this gem, you can read the

data/lib/asciidoctor-bibliography/asciidoctor/bibliographer_preprocessor.rb

@@ -10,7 +10,7 @@ module AsciidoctorBibliography
     class BibliographerPreprocessor < ::Asciidoctor::Extensions::Preprocessor
       def process(document, reader)
         document.bibliographer.options =
-          ::AsciidoctorBibliography::Options.new_from_reader reader
+          ::AsciidoctorBibliography::Options.build document, reader
 
         database_filepath =
           File.expand_path document.bibliographer.options.database,

data/lib/asciidoctor-bibliography/databases/bibtex.rb

@@ -11,9 +11,13 @@ require "latex/decode/greek"
 module AsciidoctorBibliography
   module Databases
     module BibTeX
-      EXTENSIONS = %w[.bib .bibtex].freeze
+      EXTENSIONS = %w[.bib .bibtex .biblatex].freeze
 
       def self.load(filename)
+        # TODO: detect BibLaTeX code w/ other extensions
+        warn <<~MESSAGE if File.extname(filename) == '.biblatex'
+          WARNING: you are requiring a BibLaTeX database; only features compatible with BibTeX are guaranteed to work.
+        MESSAGE
         ::BibTeX.open(filename, filter: [LatexFilter]).to_citeproc
       end
 

data/lib/asciidoctor-bibliography/options.rb

@@ -22,10 +22,11 @@ module AsciidoctorBibliography
       merge DEFAULTS
     end
 
-    def self.new_from_reader(reader)
+    def self.build(document, reader)
       header_attributes = get_header_attributes_hash reader
       header_attributes.select! { |key, _| DEFAULTS.keys.include? key }
-      new.merge header_attributes
+      cli_attributes = document.attributes.select { |key, _| DEFAULTS.keys.include? key }
+      new.merge!(header_attributes).merge!(cli_attributes)
     end
 
     def self.get_header_attributes_hash(reader)

data/lib/asciidoctor-bibliography/version.rb

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

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

@@ -1,27 +1,20 @@
 <?xml version="1.0" encoding="utf-8"?>
 <style xmlns="http://purl.org/net/xbiblio/csl" class="in-text" version="1.0" demote-non-dropping-particle="never">
   <info>
-    <title>RFC v2 style</title>
-    <id>rfc-v2</id>
-    <updated>2017-11-04T15:15:55+00:00</updated>
+    <title>RFC v3 style</title>
+    <id>rfc-v3</id>
+    <updated>2017-11-04T16:30:44+00:00</updated>
   </info>
   <macro name="citation-locator">
     <group>
       <label variable="locator" text-case="capitalize-first"/>
-      <text variable="locator" prefix=" "/>
     </group>
   </macro>
   <citation>
     <layout>
-      <group>
-        <group prefix="&lt;xref" suffix="&gt;">
-          <text variable="citation-label" prefix=" target=&quot;" suffix="&quot;"/>
-        </group>
-        <group delimiter=", ">
-          <text variable="citation-label" prefix="[" suffix="]"/>
-          <text macro="citation-locator"/>
-        </group>
-        <text value="&lt;/xref&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>
     </layout>
   </citation>

data/spec/csl/styles/rfc_v2_spec.rb

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

data/spec/options_spec.rb

@@ -160,9 +160,16 @@ describe AsciidoctorBibliography::Options do
     end
   end
 
-  describe ".new_from_reader" do
+  describe ".build" do
+    let(:document) do
+      ::Asciidoctor::Document.new.tap do |doc|
+        # NOTE: these attributes would come from CLI
+        doc.attributes.merge! "bibliography-database" => "high_priority"
+      end
+    end
+
     let(:reader) do
-      ::Asciidoctor::PreprocessorReader.new(::Asciidoctor::Document.new, <<~SOURCE.lines)
+      ::Asciidoctor::PreprocessorReader.new(document, <<~SOURCE.lines)
         = This is the document title
         :bibliography-database: foo
         :bibliography-locale: bar
@@ -175,10 +182,10 @@ describe AsciidoctorBibliography::Options do
       SOURCE
     end
 
-    subject { described_class.new_from_reader reader }
+    subject { described_class.build document, reader }
 
-    it "extracts all bibliography options ignoring others" do
-      expect(subject).to eq("bibliography-database" => "foo",
+    it "extracts all bibliography options ignoring others and includes CLI attributes" do
+      expect(subject).to eq("bibliography-database" => "high_priority",
                             "bibliography-locale" => "bar",
                             "bibliography-style" => "baz",
                             "bibliography-hyperlinks" => "quz",

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-bibliography
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.2
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-22 00:00:00.000000000 Z
+date: 2018-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -341,7 +341,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Citations and bibliography the "asciidoctor-way"