asciidoctor-bibliography 0.0.1.dev

data/lib/asciidoctor-bibliography/database.rb

@@ -0,0 +1,20 @@
+require_relative 'databases/bibtex'
+
+module AsciidoctorBibliography
+  class Database < Array
+    # This is an array of citeproc entries.
+
+    def initialize(filename)
+      self.concat self.load(filename)
+    end
+
+    def load(filename)
+      if ['.bib', '.bibtex'].include? File.extname(filename)
+        Databases::BibTeX.load(filename)
+      else
+        raise StandardError, "Unknown bibliographic database format."
+      end
+    end
+  end
+end
+

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

@@ -0,0 +1,43 @@
+require 'bibtex'
+require 'bibtex/filters'
+require 'latex/decode/base'
+require 'latex/decode/maths'
+require 'latex/decode/accents'
+require 'latex/decode/diacritics'
+require 'latex/decode/punctuation'
+require 'latex/decode/symbols'
+require 'latex/decode/greek'
+
+module AsciidoctorBibliography
+  module Databases
+    module BibTeX
+      def self.load(filename)
+        ::BibTeX.open(filename, filter: [LatexFilter]).to_citeproc
+      end
+
+      # This filter extends the original latex filter in bibtex-ruby to handle
+      # unknown latex macros more gracefully. We could have used latex-decode
+      # gem together with our custom replacement rules, but latex-decode eats up
+      # all braces after it finishes all decoding. So we hack over the
+      # LaTeX.decode function and insert our rules before `strip_braces`.
+      class LatexFilter < ::BibTeX::Filter
+        def apply(value)
+          text = value.to_s
+          LaTeX::Decode::Base.normalize(text)
+          LaTeX::Decode::Maths.decode!(text)
+          LaTeX::Decode::Accents.decode!(text)
+          LaTeX::Decode::Diacritics.decode!(text)
+          LaTeX::Decode::Punctuation.decode!(text)
+          LaTeX::Decode::Symbols.decode!(text)
+          LaTeX::Decode::Greek.decode!(text)
+          text.gsub!(/\\url\{(.+?)\}/, " \\1 ")
+          text.gsub!(/\\\w+(?=\s+\w)/, "")
+          text.gsub!(/\\\w+(?:\[.+?\])?\s*\{(.+?)\}/, "\\1")
+          LaTeX::Decode::Base.strip_braces(text)
+          LaTeX.normalize_C(text)
+        end
+      end
+    end
+  end
+end
+

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

@@ -0,0 +1,12 @@
+require 'citeproc'
+require 'csl/styles'
+
+module AsciidoctorBibliography
+  module Formatters
+    class CSL < ::CiteProc::Processor
+      def initialize(style)
+        super style: style, format: :html
+      end
+    end
+  end
+end

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

@@ -0,0 +1,164 @@
+module AsciidoctorBibliography
+  module Formatters
+    # This formatter emulates the behaviour of traditional Bib(La)TeX/NatBib citations.
+    class TeX
+      MACROS = {
+        # NOTE: cite = citet
+        'cite'        => { type: :textual,       bracketed: true,  authors: :abbreviated },
+        '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 }
+      }
+
+      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(citation)
+        macro_options = MACROS[citation.macro]
+        output = []
+        case macro_options[:type]
+        when :full
+        # NOTE: deliberately repetitive to improve redability.
+        when :textual
+          citation.cites.each do |cite|
+            authors = authors(macro_options[:authors], cite)
+            if @style == 'n'
+              year = cite.occurrence_index + 1
+            else
+              year = 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.cites.each do |cite|
+            if @style == 'n'
+              authors = nil
+              year = cite.occurrence_index + 1
+            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.cites.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.cites.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 year(cite)
+        issued = @database.find{ |h| h['id'] == cite.key }['issued']['date-parts']
+        return "" if issued.nil?
+        return "" if issued.first.nil?
+        issued.first.first
+      end
+
+      def extra(cite)
+        na = cite.named_attributes
+        extra = []
+        return extra if na.nil?
+        # TODO: should this be configurable?
+        extra << "Chapter #{na['chapter']}" unless na['chapter'].nil?
+        extra << "Page #{na['page']}" unless na['page'].nil?
+        extra
+      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)
+        authors = @database.find{ |h| h['id'] == cite.key }['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

@@ -0,0 +1,40 @@
+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(/<\/?i>/, '_')
+        .gsub(/<\/?b>/, '*')
+        .gsub(/<\/?span.*?>/, '')
+        .gsub(/\{|\}/, '')
+    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

data/lib/asciidoctor-bibliography/index.rb

@@ -0,0 +1,43 @@
+require 'asciidoctor/attribute_list'
+
+require_relative 'helpers'
+
+module AsciidoctorBibliography
+  class Index
+    REGEXP = /^(bibliography)::(\S+)?\[(|.*?[^\\])\]$/
+
+    attr_reader :macro, :target, :attributes
+
+    def initialize(macro, target, attributes)
+      @macro = macro
+      @target = target
+      @attributes = ::Asciidoctor::AttributeList.new(attributes).parse
+    end
+
+    def render(bibliographer)
+      lines = []
+      bibliographer.occurring_keys.each_with_index do |target, index|
+        line = '{empty}'
+        line << "[#{index + 1}] " if bibliographer.options['citation-style'] == 'numbers'
+        line << render_entry(target, bibliographer.index_formatter)
+        lines << line
+      end
+
+      # Intersperse the lines with empty ones to render as paragraphs.
+      lines.join("\n\n").lines.map(&:strip)
+    end
+
+    def render_entry_id(target)
+      ['bibliography', target].compact.join('-')
+    end
+
+    def render_entry_label(target, formatter)
+      Helpers.html_to_asciidoc formatter.render(:bibliography, id: target).join
+    end
+
+    def render_entry(target, formatter)
+      "anchor:#{render_entry_id(target)}[]#{render_entry_label(target, formatter)}"
+    end
+  end
+end
+

data/lib/asciidoctor-bibliography/version.rb

@@ -0,0 +1,3 @@
+module AsciidoctorBibliography
+  VERSION = '0.0.1.dev'
+end

data/samples/.byebug_history

@@ -0,0 +1,245 @@
+c
+q
+puts processed_lines
+q
+puts processed_lines
+processed_lines
+q
+puts processed_lines.lines.map(&:chomp)
+processed_lines.lines.map(&:chomp)
+processed_lines.lines
+processed_lines
+q
+Helpers.html_to_asciidoc form
+form
+q
+document.bibliographer.options
+q
+Hash[document_attributes]
+ENV
+document_attributes
+document_attributes.to_hash
+document_attributes.to_h
+document_attributes
+q
+cites.first.key
+cites.first
+cites
+q
+self.macro
+self
+q
+output
+q
+@closing_bracket
+q
+bibpunct.scan(/{.*?}/)
+bibpunct.scan(/{*.?}/)
+puts bibpunct
+          bibpunct = '{[}{\\]}{,}{n}{,}{,}'
+bibpunct.length
+          bibpunct = '{[}{]}{,}{n}{,}{,}'
+bibpunct.length
+          bibpunct = '{[}{\\]}{,}{n}{,}{,}'
+bibpunct.scan(/{*.?}/)
+          bibpunct = '{[}{\\]}{,}{n}{,}{,}'
+'\'
+          bibpunct = '{[}{\]}{,}{n}{,}{,}'
+bibpunct.scan(/{*.?}/)
+          bibpunct = '{[}{\\]}{,}{n}{,}{,}'
+bibpunct.scan(/{*.?}/)
+          bibpunct = '{[}{\]}{,}{n}{,}{,}'
+bibpunct.scan(/{*.?}/)
+bibpunct.scan(/{*.?}/).map { |s| s[1..-2] }
+@closing_bracket
+q
+@closing_bracket
+@opening_bracket
+bracket "wot asd"
+bracket "wot"
+bracket(cetera)
+label
+citation.xref(cite.key, label)
+output
+q
+y
+rend
+q
+rend
+q
+rend
+q
+rend
+q
+rend
+q
+document.bibliographer.citations.last.cites.last.occurrence_index
+document.bibliographer.citations.last.cites.last
+document.bibliographer.citations.last.cites
+document.bibliographer.citations.last
+document.bibliographer.citations
+document.bibliographer
+q
+citations.first.cites.first
+citations.first.cites.first.target = "FOO"
+citations.first.cites.first.target
+citations.first.cites.first
+citations.first.cites
+citations.first
+citations
+q
+document.bibliographer.citations.first.uuid
+document.bibliographer.citations.first
+document.bibliographer.citations
+reader.lines.join("\n").lines.map(&:chomp)
+reader.lines.join("\n").lines
+reader.lines.join("\n")
+reader.lines
+reader
+reader.lines
+reader
+q
+reader.processed_lines
+reader.lines
+reader
+processed_lines.join("\n").lines
+processed_lines.join('\n').lines
+processed_lines.join('\n')
+processed_lines.join('"\n')
+processed_lines.join
+q
+processed_lines
+q
+bibliographer.cited_keys.index(cite.key)q
+bibliographer.cited_keys.index(cite.key)
+bibliographer.cited_keys
+bibliographer
+q
+document
+cite
+q
+cite.named_attributes || {}
+cite.named_attributes
+extra(cite)
+c
+cetera
+c
+cetera
+c
+cetera
+n
+c
+[year(cite)].concat(extra(cite)).join(@years_separator + ' ')
+[year(cite)].concat(extra(cite))
+q
+extra
+extr
+q
+cite.named_attributes['page']
+cite.named_attributes
+cite
+q
+y
+cq
+c
+q
+ct.key
+ct
+q
+ct
+n
+ct
+q
+ct[:attributes][:named]['pagea']
+ct[:attributes][:named]['page']
+ct[:attributes][:named]['page]
+ct[:attributes][:named]
+ct[:named]
+ct[:named]['page']
+ct
+q
+ct[:key]
+ct.key
+ct
+cite
+ct
+q
+document.bibliographer.citations
+q
+TeXFormatter::DEFAULTS
+TeXFormatter
+q
+@opening_bracket
+bibpunct
+q
+Citation::DEFAULTS[cite.macro][:type]
+q
+Citation::DEFAULTS['citet'][:type]
+Citation::DEFAULTS['citet'][:tyep]
+Citation::DEFAULTS['citet']
+Citation::DEFAULTS[cite.macro]
+Citation::DEFAULTS[cite.macro][:type]
+q
+continue
+Citation::DEFAULTS['citet']
+Citation::DEFAULTS[:cite]
+Citation::DEFAULTS['cite']
+Citation::DEFAULTS
+Citation
+cite.macro
+cite
+q
+c
+q
+[].empty?
+[].blank?
+[].any?
+@database.find{ |h| h['id'] == ct[:key] }['issued']['date-parts'].first.first
+@database.find{ |h| h['id'] == ct[:key] }['issued']['date-parts'].first
+@database.find{ |h| h['id'] == ct[:key] }['issued']['date-parts']
+@database.find{ |h| h['id'] == ct[:key] }['issued']
+@database.find{ |h| h['id'] == ct[:key] }
+ct
+q
+continue
+c
+q
+cite
+q
+Helpers.to_sentence(authors_family_names)
+n
+Helpers.to_sentence(authors_family_names)
+q
+Helpers.to_sentence(authors_family_names)
+n
+c
+ci.key
+ci
+c
+cite.cites
+cite
+c
+@database.find{ |h| h['id'] == 'asd' }
+@database.find{ |h| h['id'] == c.key }
+@database.find{ |h| h['id'] == c.key }['author']
+q
+cite.cites.first[:key]
+cite.cites.first['key']
+cite.cites
+cite.cites.key
+cite
+@database.find { |h| h['id'] == 'Anderson04' }['author'].map { |h| h['family'] }.compact
+@database.find { |h| h['id'] == 'Anderson04' }['author'].map { |h| h['family'] }
+@database.find { |h| h['id'] == 'Anderson04' }['author']
+@database.find { |h| h['id'] == 'Anderson04' }
+self.find { |h| h['id'] == 'Anderson04' }
+@database.
+cite
+q
+c
+q
+self.find { |h| h['id'] == 'Lane12a' }
+self.find(id: 'Lane12a').first
+self.find(id: 'Lane12a')
+self.find
+self