asciidoctor-bibliography 0.3.0 → 0.4.0

metadata

@@ -1,85 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-bibliography
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-21 00:00:00.000000000 Z
+date: 2017-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.5.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.5.6
 - !ruby/object:Gem::Dependency
   name: citeproc-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.1.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.1.7
 - !ruby/object:Gem::Dependency
   name: csl-styles
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: 1.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: 1.0.1
 - !ruby/object:Gem::Dependency
   name: latex-decode
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: 0.2.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: 0.2.2
 - !ruby/object:Gem::Dependency
   name: bibtex-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.4.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.4.4
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -186,11 +186,11 @@ description: |
   * contextual cite `cite[key, page=3]`;
   * multiple cites `cite:[key1]+[key2]`;
   * full cite `fullcite:[key]`; and
-  * TeX-compatible macros including `citep:[key]`, `citet:[]key` and friends.
+  * TeX-compatible macros including `citep:[key]`, `citet:[key]` and friends.
 
   Citation output styles are fully bridged to the CSL library, supporting formats such as IEEE, APA, Chicago, DIN and ISO 690.
 
-  The `bibliography:[]` command generates a full reference list that adheres to your configured citation style.
+  The `bibliography::[]` command generates a full reference list that adheres to your configured citation style.
 email:
 - open.source@ribose.com
 executables: []
@@ -220,12 +220,35 @@ files:
 - lib/asciidoctor-bibliography/database.rb
 - lib/asciidoctor-bibliography/databases/bibtex.rb
 - lib/asciidoctor-bibliography/errors.rb
-- lib/asciidoctor-bibliography/formatters/csl.rb
-- lib/asciidoctor-bibliography/formatters/tex.rb
-- lib/asciidoctor-bibliography/helpers.rb
+- lib/asciidoctor-bibliography/formatter.rb
 - lib/asciidoctor-bibliography/index.rb
 - lib/asciidoctor-bibliography/options.rb
 - lib/asciidoctor-bibliography/version.rb
+- lib/citeproc/ruby/formats/adoc.rb
+- lib/csl/styles/tex-citealp-authoryear.csl
+- lib/csl/styles/tex-citealp-numeric.csl
+- lib/csl/styles/tex-citealps-authoryear.csl
+- lib/csl/styles/tex-citealps-numeric.csl
+- lib/csl/styles/tex-citealt-authoryear.csl
+- lib/csl/styles/tex-citealt-numeric.csl
+- lib/csl/styles/tex-citealts-authoryear.csl
+- lib/csl/styles/tex-citealts-numeric.csl
+- lib/csl/styles/tex-citeauthor-authoryear.csl
+- lib/csl/styles/tex-citeauthor-numeric.csl
+- lib/csl/styles/tex-citeauthors-authoryear.csl
+- lib/csl/styles/tex-citeauthors-numeric.csl
+- lib/csl/styles/tex-citep-authoryear.csl
+- lib/csl/styles/tex-citep-numeric.csl
+- lib/csl/styles/tex-citeps-authoryear.csl
+- lib/csl/styles/tex-citeps-numeric.csl
+- lib/csl/styles/tex-citet-authoryear.csl
+- lib/csl/styles/tex-citet-numeric.csl
+- lib/csl/styles/tex-citets-authoryear.csl
+- lib/csl/styles/tex-citets-numeric.csl
+- lib/csl/styles/tex-citeyear-authoryear.csl
+- lib/csl/styles/tex-citeyear-numeric.csl
+- lib/csl/styles/tex-citeyearpar-authoryear.csl
+- lib/csl/styles/tex-citeyearpar-numeric.csl
 - samples/latex_macros_in_bibtex/reference.bib
 - samples/latex_macros_in_bibtex/sample.adoc
 - samples/standard/biblio.bib
@@ -241,12 +264,37 @@ files:
 - samples/tex/sample-numbers.adoc
 - samples/tex/sample-numbers.html
 - samples/tex/sample-sort.adoc
+- spec/citation_helper.rb
 - spec/citation_item_spec.rb
+- spec/csl/styles/tex_citealp_authoryear_spec.rb
+- spec/csl/styles/tex_citealp_numeric_spec.rb
+- spec/csl/styles/tex_citealps_authoryear_spec.rb
+- spec/csl/styles/tex_citealps_numeric_spec.rb
+- spec/csl/styles/tex_citealt_authoryear_spec.rb
+- spec/csl/styles/tex_citealt_numeric_spec.rb
+- spec/csl/styles/tex_citealts_authoryear_spec.rb
+- spec/csl/styles/tex_citealts_numeric_spec.rb
+- spec/csl/styles/tex_citeauthor_authoryear_spec.rb
+- spec/csl/styles/tex_citeauthor_numeric_spec.rb
+- spec/csl/styles/tex_citeauthors_authoryear_spec.rb
+- spec/csl/styles/tex_citeauthors_numeric_spec.rb
+- spec/csl/styles/tex_citep_authoryear_spec.rb
+- spec/csl/styles/tex_citep_numeric_spec.rb
+- spec/csl/styles/tex_citeps_authoryear_spec.rb
+- spec/csl/styles/tex_citeps_numeric_spec.rb
+- spec/csl/styles/tex_citet_authoryear_spec.rb
+- spec/csl/styles/tex_citet_numeric_spec.rb
+- spec/csl/styles/tex_citets_authoryear_spec.rb
+- spec/csl/styles/tex_citets_numeric_spec.rb
+- spec/csl/styles/tex_citeyear_authoryear_spec.rb
+- spec/csl/styles/tex_citeyear_numeric_spec.rb
+- spec/csl/styles/tex_citeyearpar_authoryear_spec.rb
+- spec/csl/styles/tex_citeyearpar_numeric_spec.rb
 - spec/database_spec.rb
 - spec/fixtures/database.bib
 - spec/fixtures/database.bibtex
 - spec/fixtures/database.unk
-- spec/helpers_spec.rb
+- spec/macros_spec.rb
 - spec/options_spec.rb
 - spec/spec_helper.rb
 - spec/throwaway_spec.rb

data/lib/asciidoctor-bibliography/formatters/csl.rb

@@ -1,28 +0,0 @@
-require "citeproc"
-require "csl/styles"
-require "yaml"
-
-module AsciidoctorBibliography
-  module Formatters
-    class CSL < ::CiteProc::Processor
-      def initialize(style)
-        super style: style, format: :html
-      end
-
-      def replace_bibliography_sort(array)
-        new_keys = array.map(&::CSL::Style::Sort::Key.method(:new))
-        new_sort = ::CSL::Style::Sort.new.add_children(*new_keys)
-
-        bibliography = engine.style.find_child("bibliography")
-        bibliography.find_child("sort")&.unlink
-
-        bibliography.add_child new_sort
-      end
-
-      def sort(mode:)
-        # Valid modes are :citation and :bibliography
-        engine.sort! data, engine.style.send(mode).sort_keys if engine.style.send(mode).sort?
-      end
-    end
-  end
-end

data/lib/asciidoctor-bibliography/formatters/tex.rb

@@ -1,187 +0,0 @@
-module AsciidoctorBibliography
-  module Formatters
-    # This formatter emulates the behaviour of traditional Bib(La)TeX/NatBib citations.
-    class TeX
-      MACROS = {
-        # NOTE: \citet is equivalent to \cite, so we reserve the latter for CSL styling.
-        "citet"       => { type: :textual,       bracketed: true,  authors: :abbreviated },
-        "citet*"      => { type: :textual,       bracketed: true,  authors: :full },
-        "citealt"     => { type: :textual,       bracketed: false, authors: :abbreviated },
-        "citealt*"    => { type: :textual,       bracketed: false, authors: :full },
-        "citep"       => { type: :parenthetical, bracketed: true,  authors: :abbreviated },
-        "citep*"      => { type: :parenthetical, bracketed: true,  authors: :full },
-        "citealp"     => { type: :parenthetical, bracketed: false, authors: :abbreviated },
-        "citealp*"    => { type: :parenthetical, bracketed: false, authors: :full },
-        "citeauthor"  => { type: :authors_only,  bracketed: false, authors: :abbreviated },
-        "citeauthor*" => { type: :authors_only,  bracketed: false, authors: :full },
-        "citeyear"    => { type: :years_only,    bracketed: false },
-        "citeyearpar" => { type: :years_only,    bracketed: true },
-      }.freeze
-
-      attr_accessor :opening_bracket,
-                    :closing_bracket,
-                    :cites_separator,
-                    :style,
-                    :author_year_separator,
-                    :years_separator
-
-      def initialize(format)
-        if format == "numbers"
-          bibpunct = "{[}{]}{,}{n}{,}{,}"
-        elsif format == "authoryear"
-          bibpunct = "{(}{)}{;}{a}{,}{,}"
-        else
-          raise StandardError, "Unknown TeX citation format: #{format}"
-        end
-        @opening_bracket,
-        @closing_bracket,
-        @cites_separator,
-        @style,
-        @author_year_separator,
-        @years_separator = bibpunct.scan(/{.*?}/).map { |s| s[1..-2] }
-      end
-
-      def import(database)
-        @database = database
-      end
-
-      def render(bibliographer, citation)
-        macro_options = MACROS[citation.macro]
-        output = []
-        case macro_options[:type]
-        # NOTE: deliberately repetitive to improve redability.
-        when :textual
-          citation.citation_items.each do |cite|
-            authors = authors(macro_options[:authors], cite)
-            year = if @style == "n"
-                     bibliographer.appearance_index_of(cite.key)
-                   else
-                     year(cite)
-                   end
-            cetera = Helpers.join_nonempty([year].concat(extra(cite)), @years_separator + " ")
-            cetera = bracket(cetera) if macro_options[:bracketed]
-            label = Helpers.join_nonempty([authors, cetera], " ")
-            output << citation.xref(cite.key, label)
-          end
-          output = output.join(@cites_separator + " ")
-        when :parenthetical
-          citation.citation_items.each do |cite|
-            if @style == "n"
-              authors = nil
-              year = bibliographer.appearance_index_of(cite.key)
-            else
-              authors = authors(macro_options[:authors], cite)
-              year = year(cite)
-            end
-            cetera = Helpers.join_nonempty([year].concat(extra(cite)), @years_separator + " ")
-            label = Helpers.join_nonempty([authors, cetera], @author_year_separator + " ")
-            output << citation.xref(cite.key, label)
-          end
-          output = output.join(@cites_separator + " ")
-          output = bracket(output) if macro_options[:bracketed]
-        when :authors_only
-          citation.citation_items.each do |cite|
-            authors = authors(macro_options[:authors], cite)
-            year = nil
-            cetera = Helpers.join_nonempty([year].concat(extra(cite)), @years_separator + " ")
-            label = Helpers.join_nonempty([authors, cetera], @author_year_separator + " ")
-            output << citation.xref(cite.key, label)
-          end
-          output = output.join(@cites_separator + " ")
-          output = bracket(output) if macro_options[:bracketed]
-        when :years_only
-          citation.citation_items.each do |cite|
-            authors = nil
-            year = year(cite)
-            cetera = Helpers.join_nonempty([year].concat(extra(cite)), @years_separator + " ")
-            label = Helpers.join_nonempty([authors, cetera], @author_year_separator + " ")
-            output << citation.xref(cite.key, label)
-          end
-          output = output.join(@cites_separator + " ")
-          output = bracket(output) if macro_options[:bracketed]
-        else
-          raise StandardError, "Unknown TeX citation macro type: #{macro_options[:type]}"
-        end
-
-        output
-      end
-
-      private
-
-      def bracket(string)
-        [@opening_bracket, string, @closing_bracket].compact.join
-      end
-
-      def find_entry(key)
-        entry = @database.detect { |h| h["id"] == key }
-        raise StandardError, "Can't find entry: #{key}" if entry.nil?
-        entry
-      end
-
-      def year(cite)
-        entry = find_entry(cite.key)
-        issued = entry["issued"]
-
-        if issued.nil?
-          warn "asciidoctor-bibliography: citation (#{cite.key}) has no 'issued' information"
-          return ""
-        end
-
-        date_parts = issued["date-parts"]
-        return "" if date_parts.nil?
-
-        return "" if date_parts.first.nil?
-        date_parts.first.first
-      end
-
-      def extra(cite)
-        na = cite.named_attributes
-        extra = []
-        return extra if na.nil?
-
-        Citation::REF_ATTRIBUTES.each do |sym|
-          next if na[sym.to_s].nil?
-          extra << ref_content(sym, na[sym.to_s])
-        end
-
-        extra
-      end
-
-      # TODO: should this be configurable?
-      # TODO RT: Yes, and i18n!
-      def ref_content(sym, content)
-        "#{sym.to_s.capitalize} #{content}"
-      end
-
-      def authors(mode, cite)
-        case mode
-        when :full
-          authors_full(cite)
-        when :abbreviated
-          authors_abbreviated(cite)
-        else
-          raise StandardError, "Unknown TeX citation authors mode: #{mode}"
-        end
-      end
-
-      def authors_list(cite)
-        entry = find_entry(cite.key)
-        authors = entry["author"]
-        return [] if authors.nil?
-        authors.map { |h| h["family"] }.compact
-      end
-
-      def authors_abbreviated(cite)
-        authors = authors_list(cite)
-        return "" if authors.empty?
-        authors.length > 1 ? "#{authors.first} et al." : authors.first
-      end
-
-      def authors_full(cite)
-        authors = authors_list(cite)
-        return "" if authors.empty?
-        Helpers.to_sentence authors
-      end
-    end
-  end
-end

data/lib/asciidoctor-bibliography/helpers.rb

@@ -1,41 +0,0 @@
-module AsciidoctorBibliography
-  module Helpers
-    def self.slice(hash, *array_of_keys)
-      Hash[[array_of_keys, hash.values_at(*array_of_keys)].transpose]
-    end
-
-    def self.join_nonempty(array, separator)
-      array.compact.map(&:to_s).reject(&:empty?).join(separator)
-    end
-
-    def self.html_to_asciidoc(string)
-      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 ",
-      }
-      options = default_connectors.merge!(options)
-
-      case array.length
-      when 0
-        ""
-      when 1
-        array[0].to_s.dup
-      when 2
-        "#{array[0]}#{options[:two_words_connector]}#{array[1]}"
-      else
-        "#{array[0...-1].join(options[:words_connector])}#{options[:last_word_connector]}#{array[-1]}"
-      end
-    end
-  end
-end