asciidoctor-bibtex 0.4.1 → 0.5.0

data/lib/asciidoctor-bibtex/citation.rb

@@ -1,25 +0,0 @@
-# citation class
-#
-# Copyright (c) Peter Lane, 2012.
-# Released under Open Works License, 0.9.2
-
-module AsciidoctorBibtex
-  # Class to hold information about a single citation:
-  # its reference and any page numbers
-  class Citation
-    attr_reader :ref, :pages
-
-    def initialize ref, pages
-      @ref = ref
-      @pages = pages
-      # clean up pages
-      @pages = '' unless @pages
-      @pages = @pages.gsub("--","-")
-    end
-
-    def to_s
-      "#{@ref}:#{@pages}"
-    end
-  end
-end
-

data/lib/asciidoctor-bibtex/citationdata.rb

@@ -1,23 +0,0 @@
-# citationdata class
-#
-# Copyright (c) Peter Lane, 2013.
-# Released under Open Works License, 0.9.2
-
-module AsciidoctorBibtex
-  # Class to hold information about a citation in text:
-  # the text forming the citation, its type, pretext, and enclosed cites
-  class CitationData 
-    attr_reader :original, :type, :pretext, :cites 
-
-    def initialize original, type, pretext, cites
-      @original = original
-      @type = type
-      @pretext = if pretext.nil?
-                   ''
-                 else
-                   pretext
-                 end
-      @cites = cites
-    end
-  end
-end

data/lib/asciidoctor-bibtex/citations.rb

@@ -1,45 +0,0 @@
-#
-# Class to hold and manage citations
-#
-# Copyright (c) Peter Lane, 2013.
-# Released under Open Works License, 0.9.2
-
-module AsciidoctorBibtex
-  # Class to store list of citations used in document
-  class Citations
-    include CitationUtils
-
-    attr_reader :cites_used
-
-    def initialize
-      @cites_used = []
-    end
-
-    # Given a line of text, extract any citations and include new citation references in current list
-    def add_from_line line
-      retrieve_citations(line).each do |citation|
-        @cites_used += citation.cites.collect {|cite| cite.ref}
-      end
-      @cites_used.uniq! {|item| item.to_s} # only keep each reference once
-    end
-
-    # Return a list of citation references in document, sorted into order
-    def sorted_cites biblio
-      @cites_used.sort_by do |ref|
-        bibitem = biblio[ref]
-
-        unless bibitem.nil?
-          # extract the reference, and uppercase.
-          # Remove { } from grouped names for sorting.
-          author = bibitem.author
-          if author.nil?
-            author = bibitem.editor
-          end
-          author_chicago(author).collect {|s| s.upcase.gsub("{","").gsub("}","")} + [bibitem.year]
-        else
-          [ref]
-        end
-      end
-    end
-  end
-end

data/lib/asciidoctor-bibtex/citationutils.rb

@@ -1,67 +0,0 @@
-# Utility functions for citations class
-#
-# Copyright (c) Peter Lane, 2013.
-# Released under Open Works License, 0.9.2
-
-module AsciidoctorBibtex
-  # Some utility functions used in Citations class
-  module CitationUtils
-
-    # Given a line, return a list of CitationData instances
-    # containing information on each set of citation information
-    def retrieve_citations line
-      result = []
-      md = CITATION_FULL.match line
-      while md
-        data = CitationData.new md[0], md[1], nil, []
-        cm = CITATION_KEY.match md[2]
-        while cm
-          pages = nil
-          if cm[2]
-            pages = cm[2][1...-1]
-          end
-          data.cites << Citation.new(cm[1], pages)
-          # look for next ref within citation
-          cm = CITATION_KEY.match cm.post_match 
-        end
-        result << data
-        # look for next citation on line
-        md = CITATION_FULL.match md.post_match 
-      end
-
-      return result
-    end
-
-    # arrange author string, flag for order of surname/initials
-    def arrange_authors authors, surname_first 
-      return [] if authors.nil?
-      authors.split(/\band\b/).collect do |name|
-        if name.include?(", ")
-          parts = name.strip.rpartition(", ")
-          if surname_first
-            "#{parts.first}, #{parts.third}"
-          else
-            "#{parts.third} #{parts.first}"
-          end
-        else
-          name
-        end
-      end
-    end
-
-    # Arrange given author string into Chicago format
-    def author_chicago authors 
-      arrange_authors authors, true 
-    end
-
-    # matches a citation key, such as 'Dan2012(99-100)'
-    CITATION_KEY = /([^\s,()\[\]]+)(\(\d+(-\d+)*\))?/
-    # matches a citation type
-    CITATION_TYPE = /cite|citenp/
-    # matches a citation list
-    CITATION_LIST_TAIL = /(\s*,\s*#{CITATION_KEY})*/
-    CITATION_LIST = /(?:#{CITATION_KEY}#{CITATION_LIST_TAIL})/
-    # matches the whole citation
-    CITATION_FULL = /(#{CITATION_TYPE}):\[(#{CITATION_LIST})\]/
-  end
-end

data/lib/asciidoctor-bibtex/filehandlers.rb

@@ -1,32 +0,0 @@
-#
-# filehandlers.rb
-# Contains top-level file utility methods
-#
-
-module AsciidoctorBibtex
-
-  module FileHandlers
-    # Locate a bibliography file to read in given dir
-    def FileHandlers.find_bibliography dir
-      begin
-        candidates = Dir.glob("#{dir}/*.bib")
-        if candidates.empty?
-          return ""
-        else
-          return candidates.first
-        end
-      rescue # catch all errors, and return empty string
-        return ""
-      end
-    end
-
-    # Add '-ref' before the extension of a filename
-    def FileHandlers.add_ref filename
-      file_dir = File.dirname(File.expand_path(filename))
-      file_base = File.basename(filename, ".*")
-      file_ext = File.extname(filename)
-      return "#{file_dir}#{File::SEPARATOR}#{file_base}-ref#{file_ext}"
-    end
-  end
-end
-

data/lib/asciidoctor-bibtex/processor.rb

@@ -1,206 +0,0 @@
-#
-# Manage the current set of citations, the document settings,
-# and main operations.
-#
-
-module AsciidoctorBibtex
-
-  # Class used through utility method to hold data about citations for
-  # current document, and run the different steps to add the citations
-  # and bibliography
-  class Processor
-    include ProcessorUtils
-
-    attr_reader :biblio, :links, :style, :citations
-
-    def initialize biblio, links, style, locale, numeric_in_appearance_order = false, output = :asciidoc, bibfile = ""
-      @biblio = biblio
-      @links = links
-      @numeric_in_appearance_order = numeric_in_appearance_order
-      @style = style
-      @locale = locale
-      @citations = Citations.new
-      @filenames = Set.new
-      @output = output
-      @bibfile = bibfile
-
-      if output != :latex and output != :bibtex and output != :biblatex
-        @citeproc = CiteProc::Processor.new style: @style, format: :html, locale: @locale
-        @citeproc.import @biblio.to_citeproc
-      end
-    end
-
-    # Return the complete citation text for given cite_data
-    def complete_citation cite_data
-
-      if @output == :latex or @output == :bibtex or @output == :biblatex
-        result = '+++'
-        cite_data.cites.each do |cite|
-          # NOTE: xelatex does not support "\citenp", so we output all
-          # references as "cite" here unless we're using biblatex.
-          if @output == :biblatex
-            if cite_data.type == "citenp"
-              result << "\\" << 'textcite'
-            else
-              result << "\\" << 'parencite'
-            end
-          else
-            result << "\\" << 'cite'
-          end
-          if cite.pages != ''
-            result << "[p. " << cite.pages << "]"
-          end
-          result << "{" << "#{cite.ref}" << "},"
-        end
-        if result[-1] == ','
-          result = result[0..-2]
-        end
-        result << "+++"
-        return result
-      else
-        result = ''
-        ob, cb = '(', ')'
-
-        cite_data.cites.each_with_index do |cite, index|
-          # before all items apart from the first, insert appropriate separator
-          result << "#{separator} " unless index.zero?
-
-          # @links requires adding hyperlink to reference
-          result << "<<#{cite.ref}," if @links
-
-          # if found, insert reference information
-          unless biblio[cite.ref].nil?
-            item = biblio[cite.ref].clone
-            cite_text, ob, cb = make_citation item, cite.ref, cite_data, cite
-          else
-            puts "Unknown reference: #{cite.ref}"
-            cite_text = "#{cite.ref}"
-          end
-
-          result << cite_text.html_to_asciidoc
-          # @links requires finish hyperlink
-          result << ">>" if @links
-        end
-
-        unless @links
-          # combine numeric ranges
-          if Styles.is_numeric? @style
-            result = combine_consecutive_numbers result
-          end
-        end
-
-        return include_pretext result, cite_data, ob, cb
-      end
-    end
-
-    # Retrieve text for reference in given style
-    # - ref is reference for item to give reference for
-    def get_reference ref
-      result = ""
-      result << ". " if Styles.is_numeric? @style
-
-      begin
-        cptext = @citeproc.render :bibliography, id: ref
-      rescue Exception => e
-        puts "Failed to render #{ref}: #{e}"
-      end
-      result << "[[#{ref}]]" if @links
-      if cptext.nil?
-        return result+ref
-      else
-        result << cptext.first
-      end
-
-      return result.html_to_asciidoc
-    end
-
-    def separator
-      if Styles.is_numeric? @style
-        ','
-      else
-        ';'
-      end
-    end
-
-    # Format pages with pp/p as appropriate
-    def with_pp pages
-      return '' if pages.empty?
-
-      if @style.include? "chicago"
-        pages
-      elsif pages.include? '-'
-        "pp.&#160;#{pages}"
-      else
-        "p.&#160;#{pages}"
-      end
-    end
-
-    # Return page string for given cite
-    def page_str cite
-      result = ''
-      unless cite.pages.empty?
-        result << "," unless Styles.is_numeric? @style
-        result << " #{with_pp(cite.pages)}"
-      end
-
-      return result
-    end
-
-    def include_pretext result, cite_data, ob, cb
-      pretext = cite_data.pretext
-      pretext += ' ' unless pretext.empty? # add space after any content
-
-      if Styles.is_numeric? @style
-        "#{pretext}#{ob}#{result}#{cb}"
-      elsif cite_data.type == "cite"
-        "#{ob}#{pretext}#{result}#{cb}"
-      else
-        "#{pretext}#{result}"
-      end
-    end
-
-    # Numeric citations are handled by computing the position of the reference
-    # in the list of used citations.
-    # Other citations are formatted by citeproc.
-    def make_citation item, ref, cite_data, cite
-      if Styles.is_numeric? @style
-        cite_text = if @numeric_in_appearance_order
-                      "#{@citations.cites_used.index(cite.ref) + 1}"
-                    else
-                      "#{sorted_cites.index(cite.ref) + 1}"
-                    end
-        fc = '['
-        lc = ']'
-      else
-        cite_text = @citeproc.process id: ref, mode: :citation
-        fc = ''
-        lc = ''
-      end
-
-      if Styles.is_numeric? @style
-        cite_text << "#{page_str(cite)}"
-      elsif cite_data.type == "citenp"
-        cite_text = cite_text.gsub(item.year, "#{fc}#{item.year}#{page_str(cite)}#{lc}").gsub(", #{fc}", " #{fc}")
-      else
-        cite_text << page_str(cite)
-      end
-
-      cite_text = cite_text.gsub(",", "&#44;") if @links # replace comma
-
-      return cite_text, fc, lc
-    end
-
-    def sorted_cites
-      @citations.sorted_cites @biblio
-    end
-
-    def cites
-      if Styles.is_numeric?(@style) and @numeric_in_appearance_order
-        @citations.cites_used
-      else
-        sorted_cites
-      end
-    end
-
-  end
-end

data/lib/asciidoctor-bibtex/processorutils.rb

@@ -1,34 +0,0 @@
-
-module AsciidoctorBibtex
-  module ProcessorUtils
-    # Used with numeric styles to combine consecutive numbers into ranges
-    # e.g. 1,2,3 -> 1-3, or 1,2,3,6,7,8,9,12 -> 1-3,6-9,12
-    # leave references with page numbers alone
-    def combine_consecutive_numbers str
-      nums = str.split(",").collect(&:strip)
-      res = ""
-      # Loop through ranges
-      start_range = 0
-      while start_range < nums.length do
-        end_range = start_range
-        while (end_range < nums.length-1 and
-               nums[end_range].is_i? and
-               nums[end_range+1].is_i? and
-               nums[end_range+1].to_i == nums[end_range].to_i + 1) do
-          end_range += 1
-        end
-        if end_range - start_range >= 2
-          res += "#{nums[start_range]}-#{nums[end_range]}, "
-        else
-          start_range.upto(end_range) do |i|
-            res += "#{nums[i]}, "
-          end
-        end
-        start_range = end_range + 1
-      end
-      # finish by removing last comma
-      res.gsub(/, $/, '')
-    end
-  end
-end
-

data/lib/utils.rb

@@ -1,111 +0,0 @@
-# Some extension and helper methods. 
-#
-# Copyright (c) Peter Lane, 2012-13.
-# Copyright (c) Zhang YANG, 2016-09.
-# Released under Open Works License, 0.9.2
-
-module AsciidoctorBibtex
-  module Utils
-
-    def find_bibtex_database dir
-      begin
-        candidates = Dir.glob("#{dir}/*.bib")
-        if candidates.empty?
-          return ""
-        else
-          return candidates.first
-        end
-      rescue # catch all errors, and return empty string
-        return ""
-      end
-    end
-
-    # Used with numeric styles to combine consecutive numbers into ranges
-    # e.g. 1,2,3 -> 1-3, or 1,2,3,6,7,8,9,12 -> 1-3,6-9,12
-    # leave references with page numbers alone
-    def combine_consecutive_numbers str
-      nums = str.split(",").collect(&:strip)
-      res = ""
-      # Loop through ranges
-      start_range = 0
-      while start_range < nums.length do
-        end_range = start_range
-        while (end_range < nums.length-1 and
-               nums[end_range].is_i? and
-               nums[end_range+1].is_i? and
-               nums[end_range+1].to_i == nums[end_range].to_i + 1) do
-          end_range += 1
-        end
-        if end_range - start_range >= 2
-          res += "#{nums[start_range]}-#{nums[end_range]}, "
-        else
-          start_range.upto(end_range) do |i|
-            res += "#{nums[i]}, "
-          end
-        end
-        start_range = end_range + 1
-      end
-      # finish by removing last comma
-      res.gsub(/, $/, '')
-    end
-  end
-end
-
-module AsciidoctorBibtexArrayExtensions
-
-  # Retrieve the third item of an array
-  # Note: no checks for validity
-  def third
-    self[2]
-  end
-
-  # Join items in array using commas and 'and' on last item
-  def semantic_join
-    if size < 2
-      return self.join("")
-    end
-    result = ""
-    self.each_with_index do |item, index|
-      if index.zero?
-        result << item
-      elsif index == size-1
-        result << " and #{item}"
-      else
-        result << ", #{item}"
-      end
-    end
-
-    return result
-  end
-end
-
-# monkey patch the extension methods to Array
-class Array
-  include AsciidoctorBibtexArrayExtensions
-end
-
-# Converts html output produced by citeproc to asciidoc markup
-module StringHtmlToAsciiDoc
-  def html_to_asciidoc
-    r = self.gsub(/<\/?i>/, '_')
-    r = r.gsub(/<\/?b>/, '*')
-    r = r.gsub(/<\/?span.*?>/, '')
-    r = r.gsub(/\{|\}/, '')
-    r
-  end
-end
-
-# Provides a check that a string is in integer
-# Taken from:
-# http://stackoverflow.com/questions/1235863/test-if-a-string-is-basically-an-integer-in-quotes-using-ruby
-module IntegerCheck
-  def is_i?
-    !!(self =~ /^[-+]?[0-9]+$/)
-  end
-end
-
-# monkey patch the extension methods into String
-class String
-  include StringHtmlToAsciiDoc
-  include IntegerCheck
-end