asciidoctor-bibliography 0.9.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 712c0be34cc869f4b848ce77298e3244b9a82e13be4c7a9706c51644e58995b9
-  data.tar.gz: 8f4feb1dd4a372b1e160b8f0a1f265f09f4aca817a8b1bb9a467c71c8d36cba1
+  metadata.gz: e5f4c3c1adb3bab1871b0aca0401e8b2400389952ac1aa6879982d37759e0309
+  data.tar.gz: 4eb784aa9204c2bd4b34784511f1e549d3ab7f94e1079f27ff9898e3baa2a55a
 SHA512:
-  metadata.gz: 8342d233009659444f05076f35c226e61d246d05a9853c993ac73554f47ffb8ebe51ff7984cd53af6188dee2787096e3b1aed13275b2a64a57bc153a5dd7dd2b
-  data.tar.gz: 5bbe71d2c51f89f10aaa2de9a3bde81fb2c7a03ce286eca99b976f25fe9294e04c5b92541214beb4effffedc1010ffacbfbff65d4527e55fa97cc9820809b933
+  metadata.gz: 905cd2e676a6a66d893163c8f9f01cc60f7a4798536a9976ec9bf1d8e130257f05adcbc7de155a74a2dbe9a074302180ceb2cfe80b2b0daa409ab8aeda32c910
+  data.tar.gz: 2b45d610368bd5ac57f83a47d5d517756844f3b6387e06c9bd2a45feaca4d8e51bfad15296701281da3388c0fbb63dafcfc3608c2645779d80a769ed7b16b8fd

data/.oss-guides.rubocop.yml

@@ -124,7 +124,6 @@ Style/IfUnlessModifier:
   Description: Favor modifier if/unless usage when you have a single-line body.
   StyleGuide: https://github.com/bbatsov/ruby-style-guide#if-as-a-modifier
   Enabled: false
-  MaxLineLength: 80
 Style/LambdaCall:
   Description: Use lambda.call(...) instead of lambda.(...).
   StyleGuide: https://github.com/bbatsov/ruby-style-guide#proc-call
@@ -276,14 +275,22 @@ Style/SymbolProc:
   Enabled: true
   IgnoredMethods:
   - respond_to
-Style/TrailingCommaInLiteral:
-  Description: Checks for trailing comma in parameter lists and literals.
+Style/TrailingCommaInArrayLiteral:
+  Description: Checks for trailing comma in parameter lists.
   StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-trailing-array-commas
   Enabled: true
   EnforcedStyleForMultiline: comma
   SupportedStylesForMultiline:
   - comma
   - no_comma
+Style/TrailingCommaInHashLiteral:
+  Description: Checks for trailing comma in parameter hashes.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-trailing-array-commas
+  Enabled: true
+  EnforcedStyleForMultiline: no_comma
+  SupportedStylesForMultiline:
+  - comma
+  - no_comma
 Style/TrailingCommaInArguments:
   Description: Checks for trailing comma in parameter lists and literals.
   StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-trailing-array-commas
@@ -329,7 +336,6 @@ Style/WhileUntilModifier:
   Description: Favor modifier while/until usage when you have a single-line body.
   StyleGuide: https://github.com/bbatsov/ruby-style-guide#while-as-a-modifier
   Enabled: false
-  MaxLineLength: 80
 Style/WordArray:
   Description: Use %w or %W for arrays of words.
   StyleGuide: https://github.com/bbatsov/ruby-style-guide#percent-w
@@ -392,14 +398,14 @@ Lint/AssignmentInCondition:
   StyleGuide: https://github.com/bbatsov/ruby-style-guide#safe-assignment-in-condition
   Enabled: false
   AllowSafeAssignment: true
-Lint/EndAlignment:
+Layout/EndAlignment:
   Description: Align ends correctly.
   Enabled: true
   EnforcedStyleAlignWith: keyword
   SupportedStylesAlignWith:
   - keyword
   - variable
-Lint/DefEndAlignment:
+Layout/DefEndAlignment:
   Description: Align ends corresponding to defs correctly.
   Enabled: true
   EnforcedStyleAlignWith: start_of_line
@@ -956,10 +962,10 @@ Lint/AmbiguousRegexpLiteral:
   Description: Checks for ambiguous regexp literals in the first argument of a method
     invocation without parenthesis.
   Enabled: false
-Lint/BlockAlignment:
+Layout/BlockAlignment:
   Description: Align block ends correctly.
   Enabled: true
-Lint/ConditionPosition:
+Layout/ConditionPosition:
   Description: Checks for condition placed in a confusing position relative to the
     keyword.
   StyleGuide: https://github.com/bbatsov/ruby-style-guide#same-line-condition

data/README.adoc

@@ -344,7 +344,7 @@ You can set their style in the header:
 Accepted values are `authoryear` (default) and `numeric`.
 
 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)
+independent mechanisms. The former, along with the bibliography, 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).
 
@@ -381,7 +381,7 @@ Values given in such way will take highest priority.
 == Development
 
 We follow Sandi Metz's Rules for this gem, you can read the
-http://robots.thoughtbot.com/post/50655960596/sandi-metz-rules-for-developers[description of the rules here].
+https://thoughtbot.com/blog/sandi-metz-rules-for-developers[description of the rules here].
 All new code should follow these rules. If you make
 changes in a file that already violates these rules, you should fix the
 violations as part of your contribution.

data/bin/rspec

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path(
+  "../../Gemfile", Pathname.new(__FILE__).realpath
+)
+
+bundle_binstub = File.expand_path("bundle", __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

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

@@ -42,7 +42,9 @@ module AsciidoctorBibliography
 
       def fetch_citations(lines, bibliographer)
         lines.join("\n").gsub(Citation::REGEXP) do
-          citation = Citation.new(*Regexp.last_match.captures)
+          macro_name, macro_pars = Regexp.last_match.captures
+          target_and_attributes_list_pairs = macro_pars.scan(Citation::MACRO_PARAMETERS_REGEXP)
+          citation = Citation.new(macro_name, *target_and_attributes_list_pairs)
           bibliographer.add_citation(citation)
           citation.uuid
         end.lines.map(&:chomp)

data/lib/asciidoctor-bibliography/citation.rb

@@ -11,7 +11,24 @@ module AsciidoctorBibliography
 
     MACRO_NAME_REGEXP = TEX_MACROS.dup.concat(%w[cite fullcite]).
       map { |s| Regexp.escape s }.join("|").freeze
-    REGEXP = /\\?(#{MACRO_NAME_REGEXP}):(?:(\S*?)?\[(|.*?[^\\])\])(?:\+(\S*?)?\[(|.*?[^\\])\])*/
+
+    REGEXP = /
+      \\?  (#{MACRO_NAME_REGEXP})                # macro name
+      (
+        (?:   :  (?:\S*?)  \[(?:|.*?[^\\])\]  )  # first target with attributes list
+        (?:  \+  (?:\S*?)  \[(?:|.*?[^\\])\]  )* # other targets with wttributes lists
+      )
+    /x
+
+    MACRO_PARAMETERS_REGEXP = /
+      \G                # restart metching from here
+      (?:
+        [:+]            # separator
+        (\S*?)          # optional target
+        \[(|.*?[^\\])\] # attributes list
+      )
+    /x
+
     REF_ATTRIBUTES = %i[chapter page section clause].freeze
 
     MISSING_ID_MARK = "*??*".freeze
@@ -22,7 +39,7 @@ module AsciidoctorBibliography
       @uuid = SecureRandom.uuid
       @macro = macro
       @citation_items = []
-      target_and_attributes_list_pairs.compact.each_slice(2).each do |target, attribute_list|
+      target_and_attributes_list_pairs.each do |target, attribute_list|
         @citation_items << CitationItem.new do |cite|
           cite.target = target.to_s.empty? ? "default" : target
           cite.parse_attribute_list attribute_list

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

@@ -22,10 +22,10 @@ module AsciidoctorBibliography
           "author" => get_author_list(reference_tag),
           "title" => reference_tag.xpath("//title").first&.text&.strip,
           "issued" => {
-            "date-parts" => get_date_parts(reference_tag),
+            "date-parts" => get_date_parts(reference_tag)
           },
           # NOTE: we keep the original XML to re-render it when needed
-          "note" => reference_tag.to_xml,
+          "note" => reference_tag.to_xml
         }
       end
 
@@ -43,7 +43,7 @@ module AsciidoctorBibliography
         author_tags.map do |author_tag|
           {
             "family" => author_tag&.attr("surname"),
-            "given" => author_tag&.attr("initials"),
+            "given" => author_tag&.attr("initials")
           }
         end
       end

data/lib/asciidoctor-bibliography/options.rb

@@ -15,7 +15,7 @@ module AsciidoctorBibliography
       "bibliography-tex-style" => "authoryear",
       "bibliography-sort" => nil,
       "bibliography-prepend-empty" => "true",
-      "bibliography-passthrough" => "false",
+      "bibliography-passthrough" => "false"
     }.freeze
 
     def initialize

data/lib/asciidoctor-bibliography/version.rb

@@ -1,3 +1,3 @@
 module AsciidoctorBibliography
-  VERSION = "0.9.0".freeze
+  VERSION = "0.9.1".freeze
 end

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

@@ -35,8 +35,12 @@ module CiteProc
         private
 
         def aligned_first_field?
-          return false unless node.root.bibliography["second-field-align"]
-          node.root.bibliography.layout.children.first == node
+          return node.root.bibliography.layout.children.first == node if aligned_first_accessible?
+          false
+        end
+
+        def aligned_first_accessible?
+          !(node.root.is_a? CSL::Locale) && node.root.bibliography["second-field-align"]
         end
       end
     end

data/spec/citation_helper.rb

@@ -24,7 +24,9 @@ def formatted_citation(macro, options: {})
   bibliographer = init_bibliographer options: options
 
   macro.gsub(AsciidoctorBibliography::Citation::REGEXP) do
-    citation = AsciidoctorBibliography::Citation.new(*Regexp.last_match.captures)
+    macro_name, macro_pars = Regexp.last_match.captures
+    target_and_attributes_list_pairs = macro_pars.scan(AsciidoctorBibliography::Citation::MACRO_PARAMETERS_REGEXP)
+    citation = AsciidoctorBibliography::Citation.new(macro_name, *target_and_attributes_list_pairs)
     bibliographer.add_citation(citation)
     citation.render bibliographer
   end
@@ -33,7 +35,9 @@ end
 def formatted_bibliography(macro, options: {})
   bibliographer = init_bibliographer options: options
   macro.gsub(AsciidoctorBibliography::Citation::REGEXP) do
-    citation = AsciidoctorBibliography::Citation.new(*Regexp.last_match.captures)
+    macro_name, macro_pars = Regexp.last_match.captures
+    target_and_attributes_list_pairs = macro_pars.scan(AsciidoctorBibliography::Citation::MACRO_PARAMETERS_REGEXP)
+    citation = AsciidoctorBibliography::Citation.new(macro_name, *target_and_attributes_list_pairs)
     bibliographer.add_citation(citation)
     # citation.render bibliographer
     index = AsciidoctorBibliography::Index.new("bibliography", "", "")

data/spec/citeproc/ruby/formats/adoc_spec.rb

@@ -3,7 +3,6 @@
 require "asciidoctor-bibliography"
 require_relative "../../../citation_helper"
 
-
 describe CiteProc::Ruby::Formats::Adoc do
   before { processor.import(BibTeX.open("spec/fixtures/database.bib").to_citeproc) }
 

data/spec/end_to_end_spec.rb

@@ -0,0 +1,58 @@
+# coding: utf-8
+
+require "asciidoctor-bibliography"
+require "asciidoctor-bibliography/asciidoctor/bibliographer_preprocessor"
+
+describe "an asciidoctor document with bibliography usage" do
+  let(:document) do
+    input = <<~'ASCIIDOC'
+      = This is the document title
+      :doctype: book
+      :bibliography-database: ./spec/fixtures/database-issue84.bib
+      :bibliography-style: university-of-york-mla
+      == Section 1
+      The Advanced Research Projects Agency Network (ARPANET),
+      an early network connecting many major universities and
+      research institutions in the USA,
+      was first demonstrated publicly in October 1972
+      cite:[roberts_arpanet_1986, page=3].
+      It was initially funded by the United States
+      Department of Defense during the cold war as a part of
+      "the command and control assignment" of the ARPA program
+      cite:[lukasik_why_2011, page=10].
+      The ((ARPANET)) was designed to be "as distributed as possible,"
+      because its routing algorithm was adapted from an article by Paul Baran,
+      written at the time he was at the RAND Corporation researching
+      on highly survivable communication networks "in the thermonuclear era"
+      cite:[baran_distributed_1964, page=18].
+      With the support of the US National Science Foundation, ARPANET gradually
+      "evolved into a commercial, worldwide open network" -- the Internet
+      cite:[dommering_internet:_2015, page=13].
+      [bibliography]
+      == Bibliography
+      bibliography::[]
+    ASCIIDOC
+    document = ::Asciidoctor::Document.new(input)
+    document.parse
+    document
+  end
+
+  it "creates a valid internal bibliographer state" do
+    expect(document.bibliographer.occurring_keys["default"]).
+      to eq ["roberts_arpanet_1986",
+             "lukasik_why_2011",
+             "baran_distributed_1964",
+             "dommering_internet:_2015"]
+  end
+
+  it "generates the correct mla bibliography" do
+    expect(document.catalog[:refs]["_bibliography"].blocks[0].lines[0]).
+      to include("Baran, Paul.")
+    expect(document.catalog[:refs]["_bibliography"].blocks[1].lines[0]).
+      to include("Dommering, E., et al.")
+    expect(document.catalog[:refs]["_bibliography"].blocks[2].lines[0]).
+      to include("Lukasik, Stephen.")
+    expect(document.catalog[:refs]["_bibliography"].blocks[3].lines[0]).
+      to include("Roberts, Larry.")
+  end
+end

data/spec/fixtures/database-issue84.bib

@@ -0,0 +1,50 @@
+
+@article{baran_distributed_1964,
+	title = {On distributed communications networks},
+	volume = {12},
+	issn = {0096-1965},
+	number = {1},
+	journal = {IEEE transactions on Communications Systems},
+	author = {Baran, Paul},
+	year = {1964},
+	pages = {1--9},
+	file = {Bar64.pdf:https://www.rand.org/pubs/papers/P2626.html:text/html}
+}
+
+@article{lukasik_why_2011,
+	title = {Why the {Arpanet} {Was} {Built}},
+	volume = {33},
+	issn = {1058-6180},
+	url = {http://ieeexplore.ieee.org/document/5432117/},
+	doi = {10.1109/MAHC.2010.11},
+	language = {en},
+	number = {3},
+	urldate = {2019-02-20},
+	journal = {IEEE Annals of the History of Computing},
+	author = {Lukasik, Stephen},
+	month = mar,
+	year = {2011},
+	pages = {4--21},
+	file = {Lukasik - 2011 - Why the Arpanet Was Built.pdf:application/pdf}
+}
+
+@inproceedings{roberts_arpanet_1986,
+	title = {The {Arpanet} and computer networks},
+	isbn = {0-89791-176-8},
+	publisher = {ACM},
+	author = {Roberts, Larry},
+	year = {1986},
+	pages = {51--58},
+	file = {p51-roberts.pdf:application/pdf}
+}
+
+@article{dommering_internet:_2015,
+	title = {The {Internet}: a global free space with limited state control},
+	shorttitle = {The {Internet}},
+	url = {https://dare.uva.nl/search?identifier=8672fb24-0825-4bdb-98ac-989e370446ae},
+	language = {en},
+	urldate = {2019-02-20},
+	author = {Dommering, E. and van Ginkel, B. and de Goede, M. and Koops, B. J. and Plooij-van Gorsel, E. and Verrijn Stuart, H. and Smallenbroek, J.},
+	year = {2015},
+	file = {THE INTERNET A GLOBAL FREE SPACE WITH LIMITED STAT.pdf:application/pdf}
+}

data/spec/macros_spec.rb

@@ -41,3 +41,13 @@ describe "cite macro using an unknown key" do
       to eq "*??*"
   end
 end
+
+describe "cite macro using more than two keys" do
+  it "formats all cited keys" do
+    expect(formatted_citation("cite:[Lane12a]+[Lane12b]+[Erdos65]+[Einstein35]",
+                              options: { "bibliography-style" => "apa",
+                                         "bibliography-database" => "database.bib",
+                                         "bibliography-hyperlinks" => "true" })).
+      to eq "(xref:bibliography-default-Einstein35[Einstein, Podolsky, & Rosen, 1935]; xref:bibliography-default-Erdos65[Erdős, Heyting, & Brouwer, 1965]; xref:bibliography-default-Lane12a[Lane, 2000]; xref:bibliography-default-Lane12b[Mane & Smith, 2000])"
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-bibliography
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.1
 platform: ruby
 authors:
 - Ribose Inc.
@@ -210,6 +210,8 @@ files:
 - Rakefile
 - SYNTAX.adoc
 - asciidoctor-bibliography.gemspec
+- bin/rspec
+- bin/setup
 - lib/asciidoctor-bibliography.rb
 - lib/asciidoctor-bibliography/asciidoctor.rb
 - lib/asciidoctor-bibliography/asciidoctor/bibliographer_preprocessor.rb
@@ -298,6 +300,8 @@ files:
 - spec/csl/styles/tex_citeyearpar_authoryear_spec.rb
 - spec/csl/styles/tex_citeyearpar_numeric_spec.rb
 - spec/database_spec.rb
+- spec/end_to_end_spec.rb
+- spec/fixtures/database-issue84.bib
 - spec/fixtures/database.bib
 - spec/fixtures/database.bibtex
 - spec/fixtures/database.rfc.xml