asciidoctor-bibliography 0.3.0 → 0.4.0

data/lib/asciidoctor-bibliography/options.rb

@@ -8,6 +8,7 @@ module AsciidoctorBibliography
 
     DEFAULTS = {
       "bibliography-database" => nil,
+      "bibliography-locale" => "en-US",
       "bibliography-style" => "apa",
       "bibliography-hyperlinks" => "true",
       "bibliography-order" => "alphabetical", # TODO: deprecate
@@ -19,16 +20,47 @@ module AsciidoctorBibliography
       merge DEFAULTS
     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
+
     def style
       # Error throwing delegated to CSL library. Seems to have nice messages.
       self["bibliography-style"] || DEFAULTS["bibliography-style"]
     end
 
+    def locale
+      value = self["bibliography-locale"] || DEFAULTS["bibliography-locale"]
+      unless CSL::Locale.list.include? value
+        raise Errors::Options::Invalid, <<~MESSAGE
+          Option :bibliography-locale: has an invalid value (#{value}).
+          Allowed values are #{CSL::Locale.list.inspect}.
+        MESSAGE
+      end
+
+      value
+    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
+        raise Errors::Options::Invalid, <<~MESSAGE
+          Option :bibliography-hyperlinks: has an invalid value (#{value}).
+          Allowed values are 'true' and 'false'.
+        MESSAGE
       end
 
       value == "true"
@@ -37,8 +69,10 @@ module AsciidoctorBibliography
     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
+        raise Errors::Options::Missing, <<~MESSAGE
+          Option :bibliography-database: is mandatory.
+          A bibliographic database is required.
+        MESSAGE
       end
 
       value
@@ -48,50 +82,49 @@ module AsciidoctorBibliography
       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
+        raise Errors::Options::Invalid, <<~MESSAGE
+          Option :bibliography-sort: is not a valid YAML string: \"#{psych_error}\".
+        MESSAGE
       end
 
-      value = self.class.validate_parsed_sort_type! value
-      value = self.class.validate_parsed_sort_contents! value unless value.nil?
+      value = validate_parsed_sort_type! value
+      value = validate_parsed_sort_contents! value unless value.nil?
       value
     end
 
     def tex_style
-      self["bibliography-tex-style"] || DEFAULTS["bibliography-tex-style"]
+      value = self["bibliography-tex-style"] || DEFAULTS["bibliography-tex-style"]
+      unless %w[authoryear numeric].include? value
+        raise Errors::Options::Invalid, <<~MESSAGE
+          Option :bibliography-tex-style: has an invalid value (#{value}).
+          Allowed values are 'authoryear' (default) and 'numeric'.
+        MESSAGE
+      end
+
+      value
     end
 
-    def self.validate_parsed_sort_type!(value)
+    private
+
+    def 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
+      raise Errors::Options::Invalid, <<~MESSAGE
+        Option :bibliography-sort: has an invalid value (#{value}).
+        Please refer to manual for more info.
+      MESSAGE
     end
 
-    def self.validate_parsed_sort_contents!(array)
+    def 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
+      raise Errors::Options::Invalid, <<~MESSAGE
+        Option :bibliography-sort: has a value containing invalid keys (#{array}).
+        Allowed keys are #{allowed_keys.inspect}.
+        Please refer to manual for more info.
+      MESSAGE
     end
   end
 end

data/lib/asciidoctor-bibliography/version.rb

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

data/lib/citeproc/ruby/formats/adoc.rb

@@ -0,0 +1,36 @@
+require "citeproc/ruby/format"
+
+module CiteProc
+  module Ruby
+    module Formats
+      class Adoc < Format
+        # TODO
+        # def bibliography(bibliography)
+        # end
+
+        def apply_font_style
+          output.replace "_#{output}_" if options[:'font-style'] == "italic"
+        end
+
+        # TODO
+        # def apply_font_variant
+        #   output.replace "*#{output}*" if options[:'font-variant'] == 'small-caps'
+        # end
+
+        def apply_font_weight
+          output.replace "*#{output}*" if options[:'font-weight'] == "bold"
+        end
+
+        # TODO
+        # def apply_text_decoration
+        #   output.replace "*#{output}*" if options[:'text-decoration'] == 'underline'
+        # end
+
+        def apply_vertical_align
+          output.replace "^#{output}^" if options[:vertical_align] == "sup"
+          output.replace "~#{output}~" if options[:vertical_align] == "sub"
+        end
+      end
+    end
+  end
+end

data/lib/csl/styles/tex-citealp-authoryear.csl

@@ -0,0 +1,117 @@
+<?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>TeX style for macro citealp with authoryear style</title>
+    <id>tex-citealp-authoryear</id>
+  </info>
+  <macro name="author-long">
+    <names variable="author">
+      <name form="short" and="text" initialize="false" sort-separator=""/>
+    </names>
+  </macro>
+  <macro name="author-short">
+    <names variable="author">
+      <name form="short" and="text" et-al-min="2" et-al-use-first="1" et-al-subsequent-min="2" et-al-subsequent-use-first="1"/>
+    </names>
+  </macro>
+  <macro name="locators">
+    <choose>
+      <if type="article-journal article-magazine" match="any">
+        <group prefix=", " delimiter=", ">
+          <group>
+            <text variable="volume" font-style="italic"/>
+            <text variable="issue" prefix="(" suffix=")"/>
+          </group>
+          <text variable="page"/>
+        </group>
+        <choose>
+          <if variable="issued">
+            <choose>
+              <if variable="page issue" match="none">
+                <text variable="status" prefix=". "/>
+              </if>
+            </choose>
+          </if>
+        </choose>
+      </if>
+      <else-if type="article-newspaper">
+        <group delimiter=" " prefix=", ">
+          <label variable="page" form="short"/>
+          <text variable="page"/>
+        </group>
+      </else-if>
+      <else-if type="book graphic motion_picture report song chapter paper-conference entry-encyclopedia entry-dictionary" match="any">
+        <group prefix=" (" suffix=")" delimiter=", ">
+          <choose>
+            <if type="report" match="none">
+              <text macro="edition"/>
+            </if>
+          </choose>
+          <choose>
+            <if variable="volume" match="any">
+              <group>
+                <text term="volume" form="short" text-case="capitalize-first" suffix=" "/>
+                <number variable="volume" form="numeric"/>
+              </group>
+            </if>
+            <else>
+              <group>
+                <text term="volume" form="short" plural="true" text-case="capitalize-first" suffix=" "/>
+                <number variable="number-of-volumes" form="numeric" prefix="1–"/>
+              </group>
+            </else>
+          </choose>
+          <group>
+            <label variable="page" form="short" suffix=" "/>
+            <text variable="page"/>
+          </group>
+        </group>
+      </else-if>
+      <else-if type="legal_case">
+        <group prefix=" (" suffix=")" delimiter=" ">
+          <text variable="authority"/>
+          <choose>
+            <if variable="container-title" match="any">
+              <date variable="issued" form="numeric" date-parts="year"/>
+            </if>
+            <else>
+              <date variable="issued" form="text"/>
+            </else>
+          </choose>
+        </group>
+      </else-if>
+      <else-if type="bill legislation" match="any">
+        <date variable="issued" prefix=" (" suffix=")">
+          <date-part name="year"/>
+        </date>
+      </else-if>
+    </choose>
+  </macro>
+  <macro name="citation-locator">
+    <group>
+      <choose>
+        <if locator="chapter">
+          <label variable="locator" form="long" text-case="capitalize-first"/>
+        </if>
+        <else>
+          <label variable="locator" form="short"/>
+        </else>
+      </choose>
+      <text variable="locator" prefix=" "/>
+    </group>
+  </macro>
+  <citation>
+    <layout delimiter="; ">
+      <group>
+        <text variable="prefix" suffix=" "/>
+        <group delimiter=", ">
+          <text macro="author-short"/>
+          <date date-parts="year" form="numeric" variable="issued"/>
+          <text macro="citation-locator"/>
+        </group>
+        <text variable="suffix" prefix=", "/>
+      </group>
+    </layout>
+  </citation>
+  <bibliography/>
+</style>

data/lib/csl/styles/tex-citealp-numeric.csl

@@ -0,0 +1,116 @@
+<?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>TeX style for macro citealp with numeric style</title>
+    <id>tex-citealp-numeric</id>
+  </info>
+  <macro name="author-long">
+    <names variable="author">
+      <name form="short" and="text" initialize="false" sort-separator=""/>
+    </names>
+  </macro>
+  <macro name="author-short">
+    <names variable="author">
+      <name form="short" and="text" et-al-min="2" et-al-use-first="1" et-al-subsequent-min="2" et-al-subsequent-use-first="1"/>
+    </names>
+  </macro>
+  <macro name="locators">
+    <choose>
+      <if type="article-journal article-magazine" match="any">
+        <group prefix=", " delimiter=", ">
+          <group>
+            <text variable="volume" font-style="italic"/>
+            <text variable="issue" prefix="(" suffix=")"/>
+          </group>
+          <text variable="page"/>
+        </group>
+        <choose>
+          <if variable="issued">
+            <choose>
+              <if variable="page issue" match="none">
+                <text variable="status" prefix=". "/>
+              </if>
+            </choose>
+          </if>
+        </choose>
+      </if>
+      <else-if type="article-newspaper">
+        <group delimiter=" " prefix=", ">
+          <label variable="page" form="short"/>
+          <text variable="page"/>
+        </group>
+      </else-if>
+      <else-if type="book graphic motion_picture report song chapter paper-conference entry-encyclopedia entry-dictionary" match="any">
+        <group prefix=" (" suffix=")" delimiter=", ">
+          <choose>
+            <if type="report" match="none">
+              <text macro="edition"/>
+            </if>
+          </choose>
+          <choose>
+            <if variable="volume" match="any">
+              <group>
+                <text term="volume" form="short" text-case="capitalize-first" suffix=" "/>
+                <number variable="volume" form="numeric"/>
+              </group>
+            </if>
+            <else>
+              <group>
+                <text term="volume" form="short" plural="true" text-case="capitalize-first" suffix=" "/>
+                <number variable="number-of-volumes" form="numeric" prefix="1–"/>
+              </group>
+            </else>
+          </choose>
+          <group>
+            <label variable="page" form="short" suffix=" "/>
+            <text variable="page"/>
+          </group>
+        </group>
+      </else-if>
+      <else-if type="legal_case">
+        <group prefix=" (" suffix=")" delimiter=" ">
+          <text variable="authority"/>
+          <choose>
+            <if variable="container-title" match="any">
+              <date variable="issued" form="numeric" date-parts="year"/>
+            </if>
+            <else>
+              <date variable="issued" form="text"/>
+            </else>
+          </choose>
+        </group>
+      </else-if>
+      <else-if type="bill legislation" match="any">
+        <date variable="issued" prefix=" (" suffix=")">
+          <date-part name="year"/>
+        </date>
+      </else-if>
+    </choose>
+  </macro>
+  <macro name="citation-locator">
+    <group>
+      <choose>
+        <if locator="chapter">
+          <label variable="locator" form="long" text-case="capitalize-first"/>
+        </if>
+        <else>
+          <label variable="locator" form="short"/>
+        </else>
+      </choose>
+      <text variable="locator" prefix=" "/>
+    </group>
+  </macro>
+  <citation>
+    <layout delimiter=", ">
+      <group>
+        <text variable="prefix" suffix=" "/>
+        <group delimiter=", ">
+          <text variable="citation-number"/>
+          <text macro="citation-locator"/>
+        </group>
+        <text variable="suffix" prefix=", "/>
+      </group>
+    </layout>
+  </citation>
+  <bibliography/>
+</style>

data/lib/csl/styles/tex-citealps-authoryear.csl

@@ -0,0 +1,117 @@
+<?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>TeX style for macro citealp* with authoryear style</title>
+    <id>tex-citealps-authoryear</id>
+  </info>
+  <macro name="author-long">
+    <names variable="author">
+      <name form="short" and="text" initialize="false" sort-separator=""/>
+    </names>
+  </macro>
+  <macro name="author-short">
+    <names variable="author">
+      <name form="short" and="text" et-al-min="2" et-al-use-first="1" et-al-subsequent-min="2" et-al-subsequent-use-first="1"/>
+    </names>
+  </macro>
+  <macro name="locators">
+    <choose>
+      <if type="article-journal article-magazine" match="any">
+        <group prefix=", " delimiter=", ">
+          <group>
+            <text variable="volume" font-style="italic"/>
+            <text variable="issue" prefix="(" suffix=")"/>
+          </group>
+          <text variable="page"/>
+        </group>
+        <choose>
+          <if variable="issued">
+            <choose>
+              <if variable="page issue" match="none">
+                <text variable="status" prefix=". "/>
+              </if>
+            </choose>
+          </if>
+        </choose>
+      </if>
+      <else-if type="article-newspaper">
+        <group delimiter=" " prefix=", ">
+          <label variable="page" form="short"/>
+          <text variable="page"/>
+        </group>
+      </else-if>
+      <else-if type="book graphic motion_picture report song chapter paper-conference entry-encyclopedia entry-dictionary" match="any">
+        <group prefix=" (" suffix=")" delimiter=", ">
+          <choose>
+            <if type="report" match="none">
+              <text macro="edition"/>
+            </if>
+          </choose>
+          <choose>
+            <if variable="volume" match="any">
+              <group>
+                <text term="volume" form="short" text-case="capitalize-first" suffix=" "/>
+                <number variable="volume" form="numeric"/>
+              </group>
+            </if>
+            <else>
+              <group>
+                <text term="volume" form="short" plural="true" text-case="capitalize-first" suffix=" "/>
+                <number variable="number-of-volumes" form="numeric" prefix="1–"/>
+              </group>
+            </else>
+          </choose>
+          <group>
+            <label variable="page" form="short" suffix=" "/>
+            <text variable="page"/>
+          </group>
+        </group>
+      </else-if>
+      <else-if type="legal_case">
+        <group prefix=" (" suffix=")" delimiter=" ">
+          <text variable="authority"/>
+          <choose>
+            <if variable="container-title" match="any">
+              <date variable="issued" form="numeric" date-parts="year"/>
+            </if>
+            <else>
+              <date variable="issued" form="text"/>
+            </else>
+          </choose>
+        </group>
+      </else-if>
+      <else-if type="bill legislation" match="any">
+        <date variable="issued" prefix=" (" suffix=")">
+          <date-part name="year"/>
+        </date>
+      </else-if>
+    </choose>
+  </macro>
+  <macro name="citation-locator">
+    <group>
+      <choose>
+        <if locator="chapter">
+          <label variable="locator" form="long" text-case="capitalize-first"/>
+        </if>
+        <else>
+          <label variable="locator" form="short"/>
+        </else>
+      </choose>
+      <text variable="locator" prefix=" "/>
+    </group>
+  </macro>
+  <citation>
+    <layout delimiter="; ">
+      <group>
+        <text variable="prefix" suffix=" "/>
+        <group delimiter=", ">
+          <text macro="author-long"/>
+          <date date-parts="year" form="numeric" variable="issued"/>
+          <text macro="citation-locator"/>
+        </group>
+        <text variable="suffix" prefix=", "/>
+      </group>
+    </layout>
+  </citation>
+  <bibliography/>
+</style>