asciidoctor-bibliography 0.2.1 → 0.3.0

data/lib/asciidoctor-bibliography/helpers.rb

@@ -9,26 +9,26 @@ module AsciidoctorBibliography
     end
 
     def self.html_to_asciidoc(string)
-      string
-        .gsub(%r{<\/?i>}, '_')
-        .gsub(%r{<\/?b>}, '*')
-        .gsub(%r{<\/?span.*?>}, '')
-        .gsub(/\{|\}/, '')
+      string.
+        gsub(%r{<\/?i>}, "_").
+        gsub(%r{<\/?b>}, "*").
+        gsub(%r{<\/?span.*?>}, "").
+        gsub(/\{|\}/, "")
       # TODO: bracket dropping is inappropriate here.
     end
 
     # NOTE: mostly stolen from ActiveSupport.
     def self.to_sentence(array, options = {})
       default_connectors = {
-        :words_connector     => ', ',
-        :two_words_connector => ' and ',
-        :last_word_connector => ', and '
+        words_connector: ", ",
+        two_words_connector: " and ",
+        last_word_connector: ", and ",
       }
       options = default_connectors.merge!(options)
 
       case array.length
       when 0
-        ''
+        ""
       when 1
         array[0].to_s.dup
       when 2

data/lib/asciidoctor-bibliography/index.rb

@@ -1,7 +1,7 @@
-require 'asciidoctor/attribute_list'
-require_relative 'formatters/csl'
+require "asciidoctor/attribute_list"
+require_relative "formatters/csl"
 
-require_relative 'helpers'
+require_relative "helpers"
 
 module AsciidoctorBibliography
   class Index
@@ -16,16 +16,21 @@ module AsciidoctorBibliography
     end
 
     def render(bibliographer)
-      formatter = Formatters::CSL.new(bibliographer.options['reference-style'])
-      filtered_db = bibliographer.occurring_keys
-                                 .map { |id| bibliographer.database.find { |h| h['id'] == id } }
-                                 .map { |entry| prepare_entry_metadata bibliographer, entry }
+      formatter = Formatters::CSL.new(bibliographer.options.style)
+
+      unless bibliographer.options.sort.nil?
+        formatter.replace_bibliography_sort bibliographer.options.sort
+      end
+
+      filtered_db = bibliographer.occurring_keys.
+        map { |id| bibliographer.database.find_entry_by_id(id) }.
+        map { |entry| prepare_entry_metadata bibliographer, entry }
       formatter.import filtered_db
       formatter.sort(mode: :bibliography)
 
       lines = []
       formatter.bibliography.each_with_index do |reference, index|
-        line = '{empty}'
+        line = "{empty}"
         line << "anchor:#{anchor_id(formatter.data[index].id)}[]"
         line << Helpers.html_to_asciidoc(reference)
         lines << line
@@ -36,13 +41,13 @@ module AsciidoctorBibliography
     end
 
     def prepare_entry_metadata(bibliographer, entry)
-      entry
-        .merge('citation-number': bibliographer.appearance_index_of(entry['id']))
-        .merge('citation-label': entry['id']) # TODO: smart label generators
+      entry.
+        merge('citation-number': bibliographer.appearance_index_of(entry["id"])).
+        merge('citation-label': entry["id"]) # TODO: smart label generators
     end
 
     def anchor_id(target)
-      ['bibliography', target].compact.join('-')
+      ["bibliography", target].compact.join("-")
     end
 
     def render_entry_label(target, formatter)
@@ -54,4 +59,3 @@ module AsciidoctorBibliography
     end
   end
 end
-

data/lib/asciidoctor-bibliography/options.rb

@@ -0,0 +1,97 @@
+require "asciidoctor"
+require_relative "errors"
+require "csl/styles"
+
+module AsciidoctorBibliography
+  class Options < Hash
+    PREFIX = "bibliography-".freeze
+
+    DEFAULTS = {
+      "bibliography-database" => nil,
+      "bibliography-style" => "apa",
+      "bibliography-hyperlinks" => "true",
+      "bibliography-order" => "alphabetical", # TODO: deprecate
+      "bibliography-tex-style" => "authoryear",
+      "bibliography-sort" => nil,
+    }.freeze
+
+    def initialize
+      merge DEFAULTS
+    end
+
+    def style
+      # Error throwing delegated to CSL library. Seems to have nice messages.
+      self["bibliography-style"] || DEFAULTS["bibliography-style"]
+    end
+
+    def hyperlinks?
+      value = self["bibliography-hyperlinks"] || DEFAULTS["bibliography-hyperlinks"]
+      unless %w[true false].include? value
+        message = "Option :bibliography-hyperlinks: has an invalid value (#{value}). Allowed values are 'true' and 'false'."
+        raise Errors::Options::Invalid, message
+      end
+
+      value == "true"
+    end
+
+    def database
+      value = self["bibliography-database"] || DEFAULTS["bibliography-database"]
+      if value.nil?
+        message = "Option :bibliography-database: is mandatory. A bibliographic database is required."
+        raise Errors::Options::Missing, message
+      end
+
+      value
+    end
+
+    def sort
+      begin
+        value = YAML.safe_load self["bibliography-sort"].to_s
+      rescue Psych::SyntaxError => psych_error
+        message = "Option :bibliography-sort: is not a valid YAML string: \"#{psych_error}\"."
+        raise Errors::Options::Invalid, message
+      end
+
+      value = self.class.validate_parsed_sort_type! value
+      value = self.class.validate_parsed_sort_contents! value unless value.nil?
+      value
+    end
+
+    def tex_style
+      self["bibliography-tex-style"] || DEFAULTS["bibliography-tex-style"]
+    end
+
+    def self.validate_parsed_sort_type!(value)
+      return value if value.nil?
+      return value if value.is_a?(Array) && value.all? { |v| v.is_a? Hash }
+      return [value] if value.is_a? Hash
+      message = "Option :bibliography-sort: has an invalid value (#{value}). Please refer to manual for more info."
+      raise Errors::Options::Invalid, message
+    end
+
+    def self.validate_parsed_sort_contents!(array)
+      # TODO: should we restrict these? Double check the CSL spec.
+      allowed_keys = %w[variable macro sort names-min names-use-first names-use-last]
+      return array unless array.any? { |hash| (hash.keys - allowed_keys).any? }
+      message = "Option :bibliography-sort: has a value containing invalid keys (#{array}). Allowed keys are #{allowed_keys.inspect}. Please refer to manual for more info."
+      raise Errors::Options::Invalid, message
+    end
+
+    def self.new_from_reader(reader)
+      header_attributes = get_header_attributes_hash reader
+      header_attributes.select! { |key, _| DEFAULTS.keys.include? key }
+      new.merge header_attributes
+    end
+
+    def self.get_header_attributes_hash(reader)
+      # We peek at the document attributes we need, without perturbing the parsing flow.
+      # NOTE: we'll use this in a preprocessor and they haven't been parsed yet, there.
+      tmp_document = ::Asciidoctor::Document.new
+      tmp_reader = ::Asciidoctor::PreprocessorReader.new(tmp_document, reader.source_lines)
+
+      ::Asciidoctor::Parser.
+        parse(tmp_reader, tmp_document, header_only: true).
+        attributes
+    end
+  end
+end

data/lib/asciidoctor-bibliography/version.rb

@@ -1,3 +1,3 @@
 module AsciidoctorBibliography
-  VERSION = '0.2.1'
+  VERSION = "0.3.0".freeze
 end

data/samples/latex_macros_in_bibtex/sample.adoc

@@ -1,6 +1,6 @@
 = Latex Macros In Bibtex Items
 :bibliography-database: reference.bib
-:bibliography-reference-style: ieee
+:bibliography-style: ieee
 
 == Contents
 

data/samples/standard/sample-default.adoc

@@ -1,9 +1,11 @@
 = Sample usage of asciidoctor-bibliography
 :bibliography-database: biblio.bib
-:bibliography-hyperlinks: false
+:bibliography-hyperlinks: true
 
 ## Standard
 
+cite:[Lane12a]+[Lane12b]
+
 cite:[Anderson04]
 
 cite:[Anderson04, page=10]
@@ -12,8 +14,6 @@ cite:[Anderson04, chapter=10]
 
 cite:[Anderson04, page=10, chapter=12]
 
-cite:[Lane12a]+[Lane12b]
-
 cite:[Lane12a, page=42]+[Lane12b, opus=12]
 
 ## Bibliography

data/samples/standard/sample-default.html

@@ -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,28 +427,29 @@ 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>
 <div class="sectionbody">
 <div class="paragraph">
-<p>(Anderson et al., 2004)</p>
+<p>(<a href="#bibliography-Lane12a">Lane, 2000</a>; <a href="#bibliography-Lane12b">Mane &amp; Smith, 2000</a>)</p>
 </div>
 <div class="paragraph">
-<p>(Anderson et al., 2004, p. 10)</p>
+<p>(<a href="#bibliography-Anderson04">Anderson et al., 2004</a>)</p>
 </div>
 <div class="paragraph">
-<p>(Anderson et al., 2004, chap. 10)</p>
+<p>(<a href="#bibliography-Anderson04">Anderson et al., 2004, p. 10</a>)</p>
 </div>
 <div class="paragraph">
-<p>(Anderson et al., 2004, chap. 12)</p>
+<p>(<a href="#bibliography-Anderson04">Anderson et al., 2004, chap. 10</a>)</p>
 </div>
 <div class="paragraph">
-<p>(Lane, 2000; Mane &amp; Smith, 2000)</p>
+<p>(<a href="#bibliography-Anderson04">Anderson et al., 2004, p. 10</a>)</p>
 </div>
 <div class="paragraph">
-<p>(Lane, 2000, p. 42; Mane &amp; Smith, 2000, op. 12)</p>
+<p>(<a href="#bibliography-Lane12a">Lane, 2000, p. 42</a>; <a href="#bibliography-Lane12b">Mane &amp; Smith, 2000, op. 12</a>)</p>
 </div>
 </div>
 </div>
@@ -469,7 +470,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-10 19:07:47 CEST
+Last updated 2017-09-17 18:42:29 CEST
 </div>
 </div>
 </body>

data/samples/standard/sample-din.adoc

@@ -1,6 +1,6 @@
 = Sample usage of asciidoctor-bibliography
 :bibliography-database: biblio.bib
-:bibliography-reference-style: din-1505-2-alphanumeric
+:bibliography-style: din-1505-2-alphanumeric
 
 ## Standard
 

data/samples/standard/sample-din.html

@@ -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,6 +427,7 @@ 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">
@@ -442,7 +443,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
 <p>[<a href="#bibliography-Anderson04">Anderson04, chap.10</a>]</p>
 </div>
 <div class="paragraph">
-<p>[<a href="#bibliography-Anderson04">Anderson04, chap.12</a>]</p>
+<p>[<a href="#bibliography-Anderson04">Anderson04, p.10</a>]</p>
 </div>
 <div class="paragraph">
 <p>[<a href="#bibliography-Lane12a">Lane12a</a>; <a href="#bibliography-Lane12b">Lane12b</a>]</p>
@@ -469,7 +470,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 23:17:49 CEST
+Last updated 2017-09-16 21:33:46 CEST
 </div>
 </div>
 </body>

data/samples/standard/sample-ieee.adoc

@@ -1,6 +1,6 @@
 = Sample usage of asciidoctor-bibliography
 :bibliography-database: biblio.bib
-:bibliography-reference-style: ieee
+:bibliography-style: ieee
 
 ## Standard
 

data/samples/standard/sample-ieee.html

@@ -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,6 +427,7 @@ 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">
@@ -442,7 +443,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
 <p><a href="#bibliography-Anderson04">[1, Ch. 10]</a></p>
 </div>
 <div class="paragraph">
-<p><a href="#bibliography-Anderson04">[1, Ch. 12]</a></p>
+<p><a href="#bibliography-Anderson04">[1, P. 10]</a></p>
 </div>
 <div class="paragraph">
 <p><a href="#bibliography-Lane12a">[2]</a>, <a href="#bibliography-Lane12b">[3]</a></p>
@@ -469,7 +470,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 23:17:57 CEST
+Last updated 2017-09-16 21:33:46 CEST
 </div>
 </div>
 </body>

data/samples/tex/sample-authoryear.adoc

@@ -1,23 +1,9 @@
 = Sample usage of asciidoctor-bibliography
 :bibliography-database: biblio.bib
+:bibliography-tex-style: authoryear
+:bibliography-style: apa
 
-## Standard
-
-cite:[Lane12a]+[Lane12b]
-
-cite:[Anderson04]
-
-cite:[Anderson04, page=10]
-
-cite:[Anderson04, chapter=10]
-
-cite:[Anderson04, page=10, chapter=12]
-
-## TeX-compatible
-
-fullcite:[Anderson04] (fullcite, single)
-
-fullcite:[Anderson04, page=123] (fullcite, single)
+## Citations
 
 citet:[Anderson04] (citet, single)
 
@@ -67,7 +53,11 @@ citeyearpar:[Anderson04] (citeyearpar, single)
        
 citeyearpar:[Lane12a]+[Lane12b] (citeyearpar, multiple)
 
+fullcite:[Anderson04] (fullcite)
+
+
 ## Bibliography
 
+
 bibliography::[]
 

data/samples/tex/sample-authoryear.html

@@ -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-Lane12a">Lane 2000</a>; <a href="#bibliography-Lane12b">Mane and Smith 2000</a>)</p>
-</div>
-<div class="paragraph">
-<p>(<a href="#bibliography-Anderson04">Anderson et al. 2004</a>)</p>
-</div>
-<div class="paragraph">
-<p>(<a href="#bibliography-Anderson04">Anderson et al. 2004, p. 10</a>)</p>
-</div>
-<div class="paragraph">
-<p>(<a href="#bibliography-Anderson04">Anderson et al. 2004, chap. 10</a>)</p>
-</div>
-<div class="paragraph">
-<p>(<a href="#bibliography-Anderson04">Anderson et al. 2004, chap. 12</a>)</p>
-</div>
-</div>
-</div>
-<div class="sect1">
-<h2 id="_tex_compatible">TeX-compatible</h2>
-<div class="sectionbody">
-<div class="paragraph">
-<p>Anderson, J. R., D. Bothell, M. D. Byrne, S. Douglass, C. Lebiere, and Y. L. Qin. 2004. “An Integrated Theory of the Mind.” <em>Psychological Review</em> 111 (4): 1036–60. (fullcite, single)</p>
-</div>
-<div class="paragraph">
-<p>Anderson, J. R., D. Bothell, M. D. Byrne, S. Douglass, C. Lebiere, and Y. L. Qin. 2004. “An Integrated Theory of the Mind.” <em>Psychological Review</em> 111 (4): 123. (fullcite, single)</p>
-</div>
-<div class="paragraph">
 <p><a href="#bibliography-Anderson04">Anderson et al. (2004)</a> (citet, single)</p>
 </div>
 <div class="paragraph">
@@ -530,26 +505,29 @@ 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>Anderson, J. R., Bothell, D., Byrne, M. D., Douglass, S., Lebiere, C., &amp; Qin, Y. L. (2004). An integrated theory of the mind. <em>Psychological Review</em>, <em>111</em>(4), 1036–1060. (fullcite)</p>
+</div>
 </div>
 </div>
 <div class="sect1">
 <h2 id="_bibliography">Bibliography</h2>
 <div class="sectionbody">
 <div class="paragraph">
-<p><a id="bibliography-Anderson04"></a>Anderson, J. R., D. Bothell, M. D. Byrne, S. Douglass, C. Lebiere, and Y. L. Qin. 2004. “An Integrated Theory of the Mind.” <em>Psychological Review</em> 111 (4): 123.</p>
+<p><a id="bibliography-Anderson04"></a>Anderson, J. R., Bothell, D., Byrne, M. D., Douglass, S., Lebiere, C., &amp; Qin, Y. L. (2004). An integrated theory of the mind. <em>Psychological Review</em>, <em>111</em>(4), 1036–1060.</p>
 </div>
 <div class="paragraph">
-<p><a id="bibliography-Lane12a"></a>Lane, P. 2000. <em>Book Title</em>. Publisher.</p>
+<p><a id="bibliography-Lane12a"></a>Lane, P. (2000). <em>Book title</em>. Publisher.</p>
 </div>
 <div class="paragraph">
-<p><a id="bibliography-Lane12b"></a>Mane, K., and D. Smith. 2000. <em>Book Title</em>. Publisher.</p>
+<p><a id="bibliography-Lane12b"></a>Mane, K., &amp; Smith, D. (2000). <em>Book title</em>. Publisher.</p>
 </div>
 </div>
 </div>
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2017-09-09 20:46:27 CEST
+Last updated 2017-09-17 18:31:37 CEST
 </div>
 </div>
 </body>