asciidoc-bib 2.4.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 28a9a41d86ee2820dd4eae638d5b30eb367a01b6fba84db47f860725a7fecb8c
+  data.tar.gz: 9e59a842758e91db5c751bdffd4a25d60d079de9f791fdc20f9ea2c0aa3b5028
+SHA512:
+  metadata.gz: cfa817faad29f0fa5264cdbc8a750594a10c00ed76365aa266be98c8e38bbd3aa4d69f4f745a2eab524f5a14e233b921717d9c991cd77d425a575571fa1e47e6
+  data.tar.gz: 69a5837ccd61d00e2414b227484a57098c45de36c1eeba54f289fb1dbefae6c6555f7b39652072a0ad46482ef63553ce3ab47364008c46832ba044c2d32e5053

data/LICENSE.txt

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2019-20, Peter Lane
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

data/README.rdoc

@@ -0,0 +1,102 @@
+= asciidoc-bib 
+
+== Description
+
+Adds references from a bibtex file to an asciidoc[http://asciidoc.org] file.
+
+Features:
+
+- simple syntax for adding a citation within text and placing bibliography
+- formatting of references and reference list according to range of styles supported by citeproc-ruby
+- supports some styling of citation text (page numbers, bracket placement, and pretext)
+- multiple references within a single citation
+- groups consecutive numeric references, e.g. [1,2,3] -> [1-3]
+- transforms source text to include references and full reference list
+
+(Note: for asciidoctor[https://asciidoctor.org], prefer 
+asciidoctor-bibtex[https://github.com/asciidoctor/asciidoctor-bibtex/].)
+
+
+== Use 
+
+'asciidoc-bib' works by transforming an asciidoc document containing syntax 
+to include citations and a bibliography. The transformed document will 
+contain a complete reference and bibliography list where indicated, and 
+can then be processed further by asciidoc's toolchain to produce a completed 
+document.
+
+Styles must be one of those supported by CSL[https://github.com/citation-style-language/styles].
+
+=== Include a citation
+
+Syntax for inserting a citation is [cite|citenp:(pretext:)ref(,pages)] 
+where 'pretext' and 'pages' are optional.  The ref and optional pages may 
+be repeated multiple times, separated by ';'.  A citation _must_ be 
+complete on a single line of text.
+
+Examples of +chicago-author-date+ style:
+
+[[cite:Lane12]] becomes "(Lane 2012)"
+
+[[citenp:Lane12]] becomes "Lane (2012)"
+
+[[cite:Lane12,59]] becomes "(Lane 2012, 59)"
+
+[[cite:See:Lane12,59]] becomes "(See Lane 2012, 59)"
+
+[[cite:See:Lane12,59;Lane11]] becomes "(See Lane 2012, 59; Lane 2011)"
+
+For +apa+ (Harvard-like) style:
+
+[[cite:Lane12]] becomes "(Lane, 2012)"
+
+[[citenp:Lane12]] becomes "Lane (2012)"
+
+[[cite:Lane12,59]] becomes "(Lane, 2012, p.59)"
+
+For +ieee+, a numeric style:
+
+[[cite:Lane12;Lane11]] becomes "[1, 2]"
+
+[[cite:See:Lane12,59;Lane11]] becomes "See [1 p.59, 2]"
+
+=== Place bibliography in text
+
+[[bibliography]] on a line by itself.
+
+=== Processing text
+
+ > asciidoc-bib filename.txt
+
+Looks for a bib file in current folder and in ~/Documents.
+
+Outputs a new file: filename-ref.txt
+which includes your references.  
+
+Check the new file, and process in the usual way with asciidoc.
+
+Command-line options:
+
+  > asciidoc-bib -h
+  Usage: asciidoc-bib filename
+      -h, --help                       help message
+      -b, --bibfile FILE               location of bib file
+      -n, --no-links                   do not add internal links
+          --numeric-alphabetic-order
+                                       sort numeric styles in alphabetical order (DEFAULT)
+          --numeric-appearance-order
+                                       sort numeric styles in order of appearance
+      -s, --style STYLE                reference style
+      -v, --version                    show version
+
+  All styles available through CSL are supported.
+  The default style is 'apa'.
+
+
+== Notes 
+
+If you make a Bibliography/Reference heading, a2x interprets this specially,
+and will fail to make a pdf. To prevent a2x treating a heading specially, place
+a section template name, [sect1], before it. 
+
+

data/bin/asciidoc-bib

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+# Executable for asciidoc-bib
+#
+# Provides some command line options for adding reference material 
+# to asciidoc files, generating revised files for processing by 
+# asciidoc.
+#
+
+unless $:.include?(libdir = File.expand_path('../lib', File.dirname(__FILE__)))
+  $:.unshift libdir
+end
+require 'asciidoc-bib'
+
+options = AsciidocBib::Options.new
+AsciidocBib::Processor.run options

data/changes.txt

@@ -0,0 +1,39 @@
+= Changes to asciidoc-bib
+
+== version 2.4.4
+
+- confirm works with ruby 3.0-preview
+
+== version 2.4.3
+
+- update tests to support minitest 5.13
+- confirm works with ruby 2.7
+- updated documentation to most classes
+
+== version 2.4.2
+
+- updated documentation
+- removed all OWL license references
+- removed all asciidoctor references
+
+== version 2.4.1
+
+- changed license to MIT
+
+== version 2.4.0
+
+- removed asciidoctor references
+
+== github version
+
+- accepted dash inside citation keys
+
+== version 2.3.1
+
+- now works with asciidoctor 1.5 api
+
+== version 2.3.0
+
+- added switch for order of numeric citations in bibliography, with choice of 
+  order of appearance or alphabetical order
+

data/lib/asciidoc-bib/citation.rb

@@ -0,0 +1,25 @@
+module AsciidocBib
+
+  # Holds information about a single citation:
+  # its reference and any page numbers
+  class Citation
+    # Reference for a citation
+    attr_reader :ref
+    # Page numbers
+    attr_reader :pages
+
+    # Construct instance of citation, from a reference and definition of page numbers.
+    def initialize ref, pages
+      @ref = ref
+      @pages = pages
+      # clean up pages
+      @pages = '' unless @pages
+      @pages.gsub!("--","-")
+    end
+
+    def to_s
+      "#{@ref}:#{@pages}"
+    end
+  end
+end
+

data/lib/asciidoc-bib/citationdata.rb

@@ -0,0 +1,33 @@
+module AsciidocBib
+  
+  # Holds information about a citation in text:
+  # the text forming the citation, its type, pretext, and enclosed cites.
+  #
+  # For example, the citation: "[cite:See:Lane12,59;Lane11]"
+  # * original: "[cite:See:Lane12,59;Lane11]"
+  # * type: "cite"
+  # * pretext: "See"
+  # * cites: [Citation{ref="Lane12",pages="59"}, Citation{ref="Lane11",pages=""} ]
+  #
+  class CitationData 
+    # Original text defining this set of citations.
+    attr_reader :original
+    # The type of citation (e.g. 'cite', 'citenp').
+    attr_reader :type
+    # Any pretext given for the citation (e.g. 'See').
+    attr_reader :pretext
+    # List of Citation instances, defining each cite.
+    attr_reader :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/asciidoc-bib/citations.rb

@@ -0,0 +1,43 @@
+module AsciidocBib
+
+  # Stores list of citations used in document.
+  #
+  class Citations
+    include CitationUtils
+
+    # List of citations.
+    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/asciidoc-bib/citationutils.rb

@@ -0,0 +1,54 @@
+module AsciidocBib
+
+  # 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], md[3], []
+        cm = CITATION.match md[4]
+        while cm
+          data.cites << Citation.new(cm[1], cm[3])
+          # look for next ref within citation
+          cm = CITATION.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 single ref with optional pages
+    CITATION = /([\w\-]+)(,([\w\.\- ]+))?/
+    # matches complete citation with multiple references
+    CITATION_FULL = /\[(cite|citenp):(([\w\-\;\!\? ]+):)?(#{CITATION}(;#{CITATION})*)\]/
+  end
+end

data/lib/asciidoc-bib/extensions.rb

@@ -0,0 +1,51 @@
+# Two methods are added to extend the Array class.
+#
+class Array
+
+  # 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 comma_and_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
+
+
+# Two methods are added to extend the String class.
+class String
+
+  # Converts html output produced by citeproc to asciidoc markup.
+  def html_to_asciidoc
+    r = self.gsub(/<\/?i>/, '_')
+    r = r.gsub(/<\/?b>/, '*')
+    r = r.gsub(/<\/?span.*?>/, '')
+    r = r.gsub(/\{|\}/, '')
+    r
+  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
+  def is_i?
+    !!(self =~ /^[-+]?[0-9]+$/)
+  end
+end
+

data/lib/asciidoc-bib/filehandlers.rb

@@ -0,0 +1,33 @@
+module AsciidocBib
+
+  #
+  # Utility methods for working with the files.
+  #
+  module FileHandlers
+
+    # Locate a bibliography file (*.bib) to read in given _directory_.
+    # Returns "" if any error or no file found.
+    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 given _filename_, 
+    # returning full path of new 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/asciidoc-bib/options.rb

@@ -0,0 +1,105 @@
+require 'optparse'
+
+module AsciidocBib
+
+  # Class to read in asciidoc-bib options from command-line, and 
+  # store results in an accessible form.
+  #
+  class Options
+    # Location of bib file to read references from.
+    attr_reader :bibfile
+    # Location of file to process.
+    attr_reader :filename
+    # Flag to indicate if links should be included.
+    attr_reader :links
+    # Name of style to use for displaying citations and references.
+    attr_reader :style
+
+    # Sets up options for the program, including:
+    # * location of bib file
+    # * whether internal links should be added
+    # * sorting of references
+    # * style of references
+    # * name of file to process
+    #
+    def initialize(program_name = 'asciidoc-bib')
+      @bibfile = ''
+      @links = true
+      @numeric_order = :alphabetical
+      @style = AsciidocBib::Styles.default_style
+
+      options = OptionParser.new do |opts|
+        opts.banner = "Usage: #{program_name} filename"
+        opts.on("-h", "--help", "help message") do |v|
+          puts "#{program_name} #{AsciidocBib::VERSION}"
+          puts
+          puts options
+          puts
+          puts "All styles available through CSL are supported."
+          puts "The default style is 'apa'."
+          exit!
+        end
+        opts.on("-b", "--bibfile FILE", "location of bib file") do |v|
+          @bibfile = v
+        end
+        opts.on("-n", "--no-links", "do not add internal links") do |v|
+          @links = false
+        end
+        opts.on('', '--numeric-alphabetic-order', 'sort numeric styles in alphabetical order (DEFAULT)') do |v|
+          @numeric_order = :alphabetical
+        end
+        opts.on('', '--numeric-appearance-order', 'sort numeric styles in order of appearance') do |v|
+          @numeric_order = :appearance
+        end
+        opts.on("-s", "--style STYLE", "reference style") do |v|
+          @style = v
+        end
+        opts.on("-v", "--version", "show version") do |v|
+          puts "#{program_name} version #{AsciidocBib::VERSION}"
+          exit!
+        end
+      end
+
+      begin
+        options.parse!
+      rescue 
+        puts options
+        exit!
+      end
+
+      # unless specified by caller, try to find the bibliography
+      if @bibfile.empty?
+        @bibfile = AsciidocBib::FileHandlers.find_bibliography "."
+        if @bibfile.empty?
+          @bibfile = AsciidocBib::FileHandlers.find_bibliography "#{ENV['HOME']}/Documents"
+        end
+      end
+      if @bibfile.empty?
+        puts "Error: could not find a bibliography file"
+        exit
+      end
+      unless AsciidocBib::Styles.valid? @style
+        puts "Error: style #{@style} was not one of the available styles"
+        exit
+      end
+
+      if ARGV.length == 1
+        @filename = ARGV[0]
+      else
+        puts "Error: a single file to convert must be given"
+        exit
+      end
+
+      puts "Reading biblio: #{@bibfile}"
+      puts "Reference style: #{@style}"
+    end
+
+    # Convenience method to check @numeric_order.
+    # This is used in place of making the @numeric_order field visible
+    # to external classes.
+    def numeric_in_appearance_order?
+      @numeric_order == :appearance
+    end
+  end
+end
+

data/lib/asciidoc-bib/processor.rb

@@ -0,0 +1,279 @@
+module AsciidocBib
+
+  # 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
+
+    # Top-level method to include citations in given asciidoc file.
+    def Processor.run options
+      processor = Processor.new BibTeX.open(options.bibfile), options.links, options.style, options.numeric_in_appearance_order?
+      processor.read_filenames options.filename
+      processor.read_citations 
+      processor.add_citations
+    end
+
+    # The BibTeX instance based on the provided .bib file.
+    attr_reader :biblio
+    # Flag to indicate if links should be included, as set in options.
+    attr_reader :links
+    # Citation style, as set in options.
+    attr_reader :style
+    # List of citations as read in from the file.
+    attr_reader :citations
+
+    def initialize biblio, links, style, numeric_in_appearance_order = false
+      @biblio = biblio
+      @links = links
+      @numeric_in_appearance_order = numeric_in_appearance_order
+      @style = style
+      @citations = Citations.new
+      @filenames = Set.new
+
+      @citeproc = CiteProc::Processor.new style: @style, format: :html
+      @citeproc.import @biblio.to_citeproc
+    end
+
+    # Given an asciidoc filename, reads in all dependent files based on 'include::' statements
+    # Leaving a list of files in @filenames
+    def read_filenames filename
+      puts "Reading file: #{filename}"
+      files_to_process = [filename]
+
+      begin
+        @filenames.add files_to_process.first
+        File.new(files_to_process.shift).each_line do |line|
+          if line.include?("include::")
+            line.split("include::").drop(1).each do |filetxt|
+              file = File.expand_path(filetxt.partition(/\s|\[/).first)
+              files_to_process << file unless @filenames.include?(file)
+            end
+          end
+        end
+      end until files_to_process.empty?
+    end
+
+    # Scans each filename and extracts citations
+    def read_citations 
+      @filenames.each do |file|
+        IO.foreach(file) do |line|
+          @citations.add_from_line line
+        end
+      end 
+    end
+
+    # Read given text to add cites and biblio to a new file
+    # Order is always decided by author surname first with year.
+    # If no author present, then use editor field.
+    # Links indicates if internal links to be added.
+    # Assumes @filenames has been set to list of filenames to process.
+    def add_citations 
+      @filenames.each do |curr_file|
+        ref_filename = FileHandlers.add_ref(curr_file)
+        puts "Writing file:	#{ref_filename}"
+        output = File.new(ref_filename, "w")
+
+        IO.foreach(curr_file) do |line|
+          begin # catch any errors, and ensure the lines of text are written
+            case 
+            when line.include?('include::')
+              output_include_line output, line
+            when line.include?('[bibliography]')
+              output_bibliography output
+            else
+              output_cite_completed_line output, line
+            end
+          rescue # Any errors, just output the line
+            output.puts line
+          end
+        end
+
+        output.close
+      end 
+    end
+
+    # Output bibliography to given output stream.
+    def output_bibliography output
+      cites = if Styles.is_numeric?(@style) and @numeric_in_appearance_order
+                @citations.cites_used 
+              else 
+                sorted_cites 
+              end
+      cites.each do |ref|
+        output.puts get_reference(ref)
+        output.puts
+      end
+    end
+
+    # Handles a line of text which includes another file.
+    # The included file must be redirected to reference the -ref version,
+    # the one which includes any expanded citations.
+    def output_include_line output, line
+      line.split("include::").drop(1).each do |filetxt|
+        ifile = filetxt.partition(/\s|\[/).first
+        file = File.expand_path ifile 
+        # make sure included file points to the -ref version
+        line.gsub!("include::#{ifile}", "include::#{FileHandlers.add_ref(file)}")
+      end
+      output.puts line
+    end
+
+    # For each citation in given line, expand into complete citation text
+    # before outputting the line
+    def output_cite_completed_line output, line
+      @citations.retrieve_citations(line).each do |citation|
+        line.gsub!(citation.original, complete_citation(citation))
+      end
+      output.puts line
+    end
+
+    # Return the complete citation text for given cite_data.
+    def complete_citation cite_data
+      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
+
+      include_pretext result, cite_data, ob, cb
+    end
+
+    # Retrieve text for reference in given style.
+    # ref:: 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 #{id}: #{e}"
+      end
+      result << "[[#{ref}]]" if @links
+      if cptext.nil?
+        return result+ref
+      else
+        result << cptext.first
+      end
+
+      return result.html_to_asciidoc
+    end
+
+    # Return the appropriate separator, depending on the current style.
+    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
+
+    # The pretext is the message such as "See" given in the original citation.
+    # This method includes the pretext as appropriate, depending on the 
+    # style and citation type.
+    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 = cite_text[0,1]
+        lc = cite_text[-1,1]
+        cite_text = cite_text[1..-2]
+      end
+
+      if Styles.is_numeric? @style
+        cite_text << "#{page_str(cite)}"
+      elsif cite_data.type == "citenp"
+        cite_text.gsub!(item.year, "#{fc}#{item.year}#{page_str(cite)}#{lc}")
+        cite_text.gsub!(", #{fc}", " #{fc}")
+      else 
+        cite_text << page_str(cite)
+      end
+
+      cite_text.gsub!(",", "&#44;") if @links # replace comma
+
+      return cite_text, fc, lc
+    end
+
+    # Return the list of sorted citations.
+    def sorted_cites
+      @citations.sorted_cites @biblio
+    end
+  end
+end
+
+

data/lib/asciidoc-bib/processorutils.rb

@@ -0,0 +1,39 @@
+module AsciidocBib
+
+  module ProcessorUtils
+
+    # Used with numeric styles to combine consecutive numbers into ranges
+    #
+    #   combine_consecutive_numbers("1,2,3")            # -> "1-3"
+    #   combine_consecutive_numbers("1,2,3,6,7,8,9,12") # -> "1-3,6-9,12"
+    #
+    # Leaves 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/asciidoc-bib/styles.rb

@@ -0,0 +1,30 @@
+module AsciidocBib
+
+  #
+  # Simple checks on available styles through CSL
+  #
+  module Styles
+
+    # Returns a list of available styles.
+    def Styles.available
+      CSL::Style.ls
+    end
+
+    # Retrieves a default style, here set to 'apa'.
+    def Styles.default_style
+      'apa'
+    end
+
+    # Checks if a given style (as input by user) is available in CSL.
+    def Styles.valid? style
+      Styles.available.include? style
+    end
+
+    # Checks if given style is a numeric style, 
+    # i.e. one that uses numeric references.
+    def Styles.is_numeric? style
+      CSL::Style.load(style).citation_format == :numeric
+    end
+  end
+end
+

data/lib/asciidoc-bib/version.rb

@@ -0,0 +1,4 @@
+module AsciidocBib
+  # Version number of project.
+  VERSION = '2.4.5'
+end

data/lib/asciidoc-bib.rb

@@ -0,0 +1,19 @@
+#  asciidoc-bib.rb
+#
+
+require 'bibtex'
+require 'citeproc'
+require 'csl/styles'
+require 'set'
+
+require 'asciidoc-bib/citation'
+require 'asciidoc-bib/citationdata'
+require 'asciidoc-bib/citationutils'
+require 'asciidoc-bib/citations'
+require 'asciidoc-bib/extensions'
+require 'asciidoc-bib/filehandlers'
+require 'asciidoc-bib/options'
+require 'asciidoc-bib/processorutils'
+require 'asciidoc-bib/processor'
+require 'asciidoc-bib/styles'
+require 'asciidoc-bib/version'

data/samples/biblio.bib

@@ -0,0 +1,31 @@
+@book{Lane12a,
+	author = {P. Lane},
+	title =	 {Book title},
+	publisher = {Publisher},
+	year =	 {2000}
+}
+
+@book{Lane12b,
+	author = {P. Lane and D. Smith},
+	title =	 {Book title},
+	publisher = {Publisher},
+	year =	 {2000}
+}
+
+@book{Anderson98,
+	editor = {J. R. Anderson and C. Lebiere},
+	title = {The Atomic Components of Thought},
+	publisher = {Lawrence Erlbaum},
+        address = {Mahwah, NJ},
+	year = {1998}
+}
+
+@article{Anderson04,
+	author = {J. R. Anderson and D. Bothell and M. D. Byrne and S. Douglass and C. Lebiere and Y. L. Qin},
+	title = {An integrated theory of the mind},
+	journal = {Psychological Review},
+	volume = {111},
+	number = {4},
+	pages = {1036--1060},
+	year = {2004}
+}

data/samples/sample-1.txt

@@ -0,0 +1,23 @@
+= Sample of using asciidoc-bib =
+
+The bibliography is searched in the folder of the document, and then 
+in ~/Documents.
+
+Author-year references can use different styles such as: [cite:Lane12a] or
+[citenp:Lane12a].
+
+Page numbers can be added: [cite:Lane12a,89] or [citenp:Lane12a,89-93].
+
+A bit of pretext can be included too: [cite:See:Lane12a,89]
+
+We can include other files, which are also processed:
+
+include::sample-2.txt[]
+
+To include the reference list, use the section template before
+title, to prevent problems with a2x.
+
+[sect2] 
+== Bibliography ==
+
+[bibliography]

data/samples/sample-2.txt

@@ -0,0 +1,18 @@
+== Sample file 2: multiple authors ==
+
+Author-year references can use different styles such as: [cite:Lane12b] or
+[citenp:Lane12b].
+
+Page numbers can be added: [cite:Lane12b,89] or [citenp:Lane12b,89-93].
+
+A bit of pretext can be included too: [cite:See:Lane12b,89]
+
+=== multiple refs ===
+
+One citation can include several references, such as [cite:Lane12a;Lane12b].
+
+These can include pages and be in-text: [citenp:Lane12a,78;Lane12b,89-93].
+
+And include pretext: [cite:See:Lane12a;Lane12b,89-93]
+
+Note: citations cannot be split over lines; each citation must be on one line.

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: asciidoc-bib
+version: !ruby/object:Gem::Version
+  version: 2.4.5
+platform: ruby
+authors:
+- Peter Lane
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-04-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bibtex-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.4
+- !ruby/object:Gem::Dependency
+  name: citeproc-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.5
+- !ruby/object:Gem::Dependency
+  name: csl-styles
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1.6
+description: "asciidoc-bib generates in-text references and a reference list from
+  an asciidoc\nfile, using a bibtex file as a source of citation information.  The
+  syntax for\nan in-text reference is simply [cite:bibref], and a line containing\n[bibliography]
+  inserts a complete reference list.  See the README for more\nexamples and further
+  options.  The references are formatted using styles provided \nby CSL.\n"
+email: peterlane@gmx.com
+executables:
+- asciidoc-bib
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+- LICENSE.txt
+files:
+- LICENSE.txt
+- README.rdoc
+- bin/asciidoc-bib
+- changes.txt
+- lib/asciidoc-bib.rb
+- lib/asciidoc-bib/citation.rb
+- lib/asciidoc-bib/citationdata.rb
+- lib/asciidoc-bib/citations.rb
+- lib/asciidoc-bib/citationutils.rb
+- lib/asciidoc-bib/extensions.rb
+- lib/asciidoc-bib/filehandlers.rb
+- lib/asciidoc-bib/options.rb
+- lib/asciidoc-bib/processor.rb
+- lib/asciidoc-bib/processorutils.rb
+- lib/asciidoc-bib/styles.rb
+- lib/asciidoc-bib/version.rb
+- samples/biblio.bib
+- samples/sample-1.txt
+- samples/sample-2.txt
+homepage:
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options:
+- "-m"
+- README.rdoc
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: asciidoc-bib adds references from a bibtex file to an asciidoc file.
+test_files: []