asciidoctor-bibliography 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 568b3aeefaaaf19618322048145162faeb1b9d41
-  data.tar.gz: d87637a8e50c389f004fefa1022ad95d5a2eb405
+SHA256:
+  metadata.gz: 712c0be34cc869f4b848ce77298e3244b9a82e13be4c7a9706c51644e58995b9
+  data.tar.gz: 8f4feb1dd4a372b1e160b8f0a1f265f09f4aca817a8b1bb9a467c71c8d36cba1
 SHA512:
-  metadata.gz: fc4c7d5c15773821a9a0dded3dcda41d34072e3b7f645a683f7bef429dace26e5ec5009f4baceaa7e47d49051127dd9a683b38823efdb33f2beb8c3abbf0f40a
-  data.tar.gz: 77b89168013c0a5d62a84f1a7a47b49741dc82cab82f740e76ba1665b0b0f6589480d59f2a37f54cc991f3de092950a5fac0e716d3e3d2f8c7e29f360609b1de
+  metadata.gz: 8342d233009659444f05076f35c226e61d246d05a9853c993ac73554f47ffb8ebe51ff7984cd53af6188dee2787096e3b1aed13275b2a64a57bc153a5dd7dd2b
+  data.tar.gz: 5bbe71d2c51f89f10aaa2de9a3bde81fb2c7a03ce286eca99b976f25fe9294e04c5b92541214beb4effffedc1010ffacbfbff65d4527e55fa97cc9820809b933

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

@@ -15,7 +15,8 @@ module AsciidoctorBibliography
         document.bibliographer.database =
           ::AsciidoctorBibliography::Database.new *expand_db_globs(document)
 
-        processed_lines = process_lines reader.read_lines, document.bibliographer
+        lines = remove_comments(reader.read_lines)
+        processed_lines = process_lines lines, document.bibliographer
         reader.unshift_lines processed_lines
         reader
       end
@@ -31,6 +32,14 @@ module AsciidoctorBibliography
         render_indices lines, bibliographer
       end
 
+      def remove_comments(lines)
+        # Remove block comments
+        ls = lines.join("\n").split(/^\/\/\/\/\n/).
+          select.with_index { |_, i| i.even? }.join
+        # Remove line comments
+        ls.split("\n").reject { |line| line.start_with?("//") }
+      end
+
       def fetch_citations(lines, bibliographer)
         lines.join("\n").gsub(Citation::REGEXP) do
           citation = Citation.new(*Regexp.last_match.captures)

data/lib/asciidoctor-bibliography/bibliographer.rb

@@ -16,6 +16,11 @@ module AsciidoctorBibliography
 
     def add_citation(citation)
       citations << citation
+
+      # NOTE: Since we're rendering the whole (possibly composite) citation as missing - even if
+      # NOTE: a single key is nil - we add none of them to the occurring keys to be rendered in indices.
+      return if citation.any_missing_id?(self)
+
       citation.citation_items.group_by(&:target).each do |target, citation_items|
         @occurring_keys[target] ||= []
         @occurring_keys[target].concat(citation_items.map(&:key)).uniq!

data/lib/asciidoctor-bibliography/citation.rb

@@ -14,6 +14,8 @@ module AsciidoctorBibliography
     REGEXP = /\\?(#{MACRO_NAME_REGEXP}):(?:(\S*?)?\[(|.*?[^\\])\])(?:\+(\S*?)?\[(|.*?[^\\])\])*/
     REF_ATTRIBUTES = %i[chapter page section clause].freeze
 
+    MISSING_ID_MARK = "*??*".freeze
+
     attr_reader :macro, :citation_items
 
     def initialize(macro, *target_and_attributes_list_pairs)
@@ -29,19 +31,41 @@ module AsciidoctorBibliography
       # rubocop:enable Performance/HashEachMethods
     end
 
+    def missing_ids(bibliographer)
+      m_ids = (@citation_items.map(&:key) - bibliographer.database.map { |entry| entry["id"] })
+      m_ids.map! { |id| id.nil? ? "" : id }
+    end
+
+    def any_missing_id?(bibliographer)
+      # NOTE: do not use :any? since it ignores nil
+      not missing_ids(bibliographer).empty?
+    end
+
     def render(bibliographer)
-      formatted_citation =
-        case macro
-        when "cite"
-          render_citation_with_csl(bibliographer)
-        when "fullcite"
-          render_fullcite_with_csl(bibliographer)
-        when *TEX_MACROS
-          render_texmacro_with_csl(bibliographer)
-        end
+      # NOTE: If there is any blank key we must render the entire (possibly composite)
+      # NOTE: citation as missing, as we don't have that kind of control over CSL styles.
+      if any_missing_id?(bibliographer)
+        warn "Warning: I didn't find a database entry for #{missing_ids(bibliographer)}."
+        # TODO: It would be cool to have the title attribute show the missing keys
+        # TODO: as a popup above *??* but it does not work on inline quoted text.
+        return MISSING_ID_MARK
+      end
+
+      formatted_citation = render_with_csl(bibliographer)
       wrap_up_citation citation: formatted_citation, bibliographer: bibliographer
     end
 
+    def render_with_csl(bibliographer)
+      case macro
+      when "cite"
+        render_citation_with_csl(bibliographer)
+      when "fullcite"
+        render_fullcite_with_csl(bibliographer)
+      when *TEX_MACROS
+        render_texmacro_with_csl(bibliographer)
+      end
+    end
+
     def wrap_up_citation(citation:, bibliographer:)
       text = citation.dup
       # TODO: handle hyperlinks here, maybe?

data/lib/asciidoctor-bibliography/index.rb

@@ -49,9 +49,12 @@ module AsciidoctorBibliography
     end
 
     def prepare_filtered_db(bibliographer)
-      bibliographer.occurring_keys[target].
-        map { |id| bibliographer.database.find_entry_by_id(id) }.
-        map { |entry| prepare_entry_metadata bibliographer, entry }
+      if bibliographer.occurring_keys.include? target
+        bibliographer.occurring_keys[target].
+          map { |id| bibliographer.database.find_entry_by_id(id) }.
+          map { |entry| prepare_entry_metadata bibliographer, entry }
+      else {}
+      end
     end
 
     def prepare_entry_metadata(bibliographer, entry)

data/lib/asciidoctor-bibliography/version.rb

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

data/spec/index_spec.rb

@@ -0,0 +1,15 @@
+# coding: utf-8
+
+require_relative "citation_helper"
+
+describe AsciidoctorBibliography::Index do
+    describe ".render" do
+        subject { described_class.new([], "default", "") }
+
+        it "does not fail when no citations occur in the document" do
+            options = { "bibliography-style" => "ieee", "bibliography-database" => "database.bibtex", "bibliography-passthrough" => "true", "bibliography-prepend-empty" => "false" }
+            bibliographer = init_bibliographer options: options
+            expect { subject.render bibliographer}.to_not raise_exception
+        end
+    end
+end

data/spec/macros_spec.rb

@@ -31,3 +31,13 @@ describe "fullcite macro with apa style" do
       to eq "Erdős, P., Heyting, A., & Brouwer, L. E. (1965). Some very hard sums. _Difficult Maths Today_, 30."
   end
 end
+
+describe "cite macro using an unknown key" do
+  it "formats bold question marks" do
+    expect(formatted_citation("cite:[Erdos65]+[foobar]",
+                              options: { "bibliography-style" => "apa",
+                                         "bibliography-database" => "database.bib",
+                                         "bibliography-hyperlinks" => "true" })).
+      to eq "*??*"
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-bibliography
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-07 00:00:00.000000000 Z
+date: 2019-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -302,6 +302,7 @@ files:
 - spec/fixtures/database.bibtex
 - spec/fixtures/database.rfc.xml
 - spec/fixtures/database.unk
+- spec/index_spec.rb
 - spec/macros_spec.rb
 - spec/options_spec.rb
 - spec/sanity_spec.rb
@@ -326,8 +327,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Citations and bibliography the "asciidoctor-way"