asciidoctor-bibtex 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3d66291de5bde00c8773c279133b29d5c2a70735
+  data.tar.gz: a86cb9606d51b1ce9110d2a93c64fa0aa19c92c4
+SHA512:
+  metadata.gz: e7c0a804b7ce6f69df4a80bccb8ad22f62a1b946ca5eeba9840b93563311f5efe5ba3c32d236e829b0ce98d685a3e070ca677fbec92b46ecf9fbd3f5c1083b5b
+  data.tar.gz: 76e579bd5924ed9c38d6c0142b9bfa4ca4b29b36bf5a573817d72de911ebe430d009d182b9878dd51911b3290cdd425f05a574a98c73b4b50d90b6e8edd32f41

data/LICENSE.txt

@@ -0,0 +1,24 @@
+# Open Works License
+
+This is version 0.9.2 of the Open Works License
+
+## Terms
+
+Permission is hereby granted by the copyright holder(s), author(s), and
+contributor(s) of this work, to any person who obtains a copy of this work in
+any form, to reproduce, modify, distribute, publish, sell, use, or otherwise
+deal in the licensed material without restriction, provided the following
+conditions are met:
+
+Redistributions, modified or unmodified, in whole or in part, must retain
+applicable copyright notices, the above license notice, these conditions, and
+the following disclaimer.
+
+NO WARRANTY OF ANY KIND IS IMPLIED BY, OR SHOULD BE INFERRED FROM, THIS LICENSE
+OR THE ACT OF DISTRIBUTION UNDER THE TERMS OF THIS LICENSE, 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
+WORK, OR THE USE OF OR OTHER DEALINGS IN THE WORK.
+

data/README.rdoc

@@ -0,0 +1,166 @@
+= asciidoctor-bibtex: add bibtex functionality to asciidoc
+
+asciidoctor-bibtex is a fork of
+{asciidoc-bib}[https://github.com/petercrlane/asciidoc-bib] It generates in-text
+references and a reference list for an asciidoc file, using a bibtex file as a
+source of citation information. However, asciidoctor-bibtex proposes a
+different citation and reference grammar, which resembles the bibtex grammar
+in LaTeX. The grammar follows asciidoc inline and block macro semantics.
+
+== Why a fork
+
+When I began switching from latex/word to asciidoc, I searched for an easy way
+to integrate bibtex like references into asciidoc. Then I came across
+asciidoc-bib, which nearly meet my needs. I can insert citations, generate
+automatically a complete reference list. But there are aspects in asciidoc-bib
+that are not pleasing to work with.
+
+The first is the overriding of `[bibliography]`. Asciidoctor introduces
+`[xxx]` as an mechanism to customize block styles, roles, etc.
+`[bibliography]` is reserved for the bibliography section style. asciidoc-bib
+breaks it and there is no apparent way to fix it.
+
+The second is the grammar inconsistency with the rest of asciidoc. The
+`[cite:xxx]` is actually an inline macro but it does not follow the grammar of
+inline macros. This makes asciidoc-bib not that confortable to write with
+since it breaks the semantic memory.
+
+The last is asciidoc-bib does not support asciidoctor arguments and
+extensions. So I can not use asciidoctor-pdf with it.
+
+To accommodate the above problems, I create this fork. This fork tries to be
+as consistent with asciidoctor as possible. 
+
+== Features
+
+- bibtex-like 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)
+- can be used as an asciidoctor extension
+
+== Install
+
+ > gem install asciidoctor-bibtex
+
+Installs two executable programs:
+
+- 'asciidoc-bibtex' for transforming source text into asciidoc 
+- 'asciidoctor-bibtex' uses asciidoctor extension for single-pass output
+
+asciidoctor-bibtex depends on bibtex-ruby[http://github.com/inukshuk/bibtex-ruby],
+citeproc-ruby[http://github.com/inukshuk/citeproc-ruby] and
+csl-styles[http://github.com/inukshuk/csl-styles].
+(Ensure 'ruby-dev' and 'libxslt1-dev' are installed, so the dependencies will 
+compile.)
+
+asciidoctor[https://github.com/asciidoctor/asciidoctor] must also be installed
+for 'asciidoctor-bibtex' to work. asciidoctor version 1.5.2 or higher is
+required.
+
+== Use 
+
+There are three ways of using asciidoctor-bibtex.
+
+The first is required if using _asciidoc_.
+'asciidoc-bibtex' 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.
+
+The second is to use 'asciidoctor-bibtex' to transform your bibtex-enabled
+documents directly to any backend format supported by asciidoctor. It uses the
+asciidoctor extension mechanism to hook in the asciidoctor preprocessing
+process. It support all asciidoctor command-line options.
+
+The third is to use asciidoctor-bibtex as an asciidoctor extension. It works
+the same way as the second approach. In addition, one can use other extensions
+together to provides even richer functionality. 
+
+Styles must be one of those supported by CSL: https://github.com/citation-style-language/styles
+
+=== Citation syntax
+
+Syntax for inserting a citation is the following inline macro:
+
+    cite|citenp:[ref(pages)]
+
+where '(pages)' is 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)"
+
+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]"
+
+=== Place bibliography in text
+
+[bibliography::[]] on a line by itself.
+
+=== Processing Text: Asciidoctor
+
+  > asciidoctor-bibtex [OPTIONS] filename
+
+Looks for a bib file in current folder and in ~/Documents.
+
+Outputs an html file, including all citations and references.
+
+asciidoctor-bibtex support all command-line options of asciidoctor, for
+example, use the follow command to output docbook file:
+
+  asciidoctor-bibtex -b docbook filename
+
+One may also use as an asciidoctor extension, for example:
+
+  asciidoctor -r asciidoctor-bibtex -r asciidoctor-pdf -b pdf filename
+
+Options are set through the command-line using the asciidoctor attributes
+setting syntax:
+
+  > asciidoctor-bibtex -h
+
+  ...
+  AsciidoctorBibtex related options:
+
+      -a bib-file=FILENAME    Set BibTex filename (default: auto-find)
+      -a bib-style=STYLE      Set BibTex items style (default: apa)
+      -a bib-numeric-order=<alphabetical|appearance>
+                            Set citation order scheme (default: alphabetical)
+      -a bib-no-links=1       Do not use links (default: use links)
+
+=== Processing text: Asciidoc
+
+ > asciidoc-bibtex filename.txt
+
+Looks for a bib file in current folder and in ~/Documents.
+
+Outputs a new file: filename-ref.txt
+which includes your references.  
+
+asciidoc-bibtex supports the same command-line options as asciidoc-bib. The
+only difference is the citation and bibliography syntex.
+
+== License
+
+The files within this project may be distributed under the terms of 
+the Open Works License: http://owl.apotheon.org
+
+== Links
+
+See [https://github.com/petercrlane/asciidoc-bib] for the original asciidoc-bib.

data/bin/asciidoc-bibtex

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+
+# Executable for asciidoc-bibtex
+#
+# Provides some command line options for adding reference material 
+# to asciidoc files, generating revised files for processing by 
+# asciidoc.
+#
+# Copyright (c) Peter Lane, 2012-13.
+# Released under Open Works License, 0.9.2
+
+unless $:.include?(libdir = File.expand_path('../lib', File.dirname(__FILE__)))
+  $:.unshift libdir
+end
+require 'asciidoctor-bibtex'
+
+options = AsciidoctorBibtex::Options.new
+options.parse!
+AsciidoctorBibtex::Processor.run options

data/bin/asciidoctor-bibtex

@@ -0,0 +1,58 @@
+#!/usr/bin/env ruby
+
+# Executable asciidoctor-bib
+#
+# Uses asciidoctor preprocessor extension to include citations and bibliography
+# in a single pass.
+#
+# Copyright (c) Peter Lane, 2013.
+# Released under Open Works License, 0.9.2
+
+unless $:.include?(libdir = File.expand_path('../lib', File.dirname(__FILE__)))
+  $:.unshift libdir
+end
+require 'asciidoctor-bibtex'
+require 'asciidoctor/cli'
+
+# Treat '--version' specially, like that in asciidoctor-pdf
+options = Asciidoctor::Cli::Options.new
+unless (ARGV & ['-V', '--version']).empty?
+  $stdout.write %(Asciidoctor Bib #{AsciidoctorBibtex::VERSION} using )
+  # NOTE the print_version method was added in Asciidoctor 1.5.2
+  if options.respond_to? :print_version
+    options.print_version
+  else
+    puts %(Asciidoctor #{::Asciidoctor::VERSION} [http://asciidoctor.org])
+  end
+  exit 0
+end
+
+# Add help information on how to set bibtex related values via asciidoctor
+# commandline. This is the usual CLI attributes definition.
+if not (ARGV & ['-h', '--help']).empty?
+  # parse argument with asciidoctor to print asciidoctor's helps
+  options.parse! ARGV
+  puts ""
+  puts "AsciidoctorBibtex related options:"
+  puts ""
+  puts "    -a bib-file=FILENAME    Set BibTex filename (default: auto-find)"
+  puts "    -a bib-style=STYLE      Set BibTex items style (default: apa)"
+  puts "    -a bib-numeric-order=<alphabetical|appearance>"
+  puts "                            Set citation order scheme (default: alphabetical)"
+  puts "    -a bib-no-links=1       Do not use links (default: use links)"
+  puts ""
+  exit 0
+end
+
+# Use standard asciidoctor CLI mechanism to call asciidoctor, so we can accept
+# all asciidoctor options. Note that we only accept asciidoctor options here.
+# This code is stolen shamlessly from asciidoctor-pdf
+case (result = options.parse! ARGV)
+when Integer
+  exit result
+else
+  invoker = Asciidoctor::Cli::Invoker.new options
+  GC.start
+  invoker.invoke!
+  exit invoker.code
+end

data/lib/asciidoctor-bibtex.rb

@@ -0,0 +1,25 @@
+#  asciidoctor-bibtex.rb
+#
+# Copyright (c) Peter Lane, 2012-13.
+# Released under Open Works License, 0.9.2
+
+require 'bibtex'
+require 'citeproc'
+require 'csl/styles'
+require 'set'
+
+# Only require asciidoctor file if asciidoctor gem is installed
+unless Gem::Specification.find_all_by_name('asciidoctor').empty?
+  require_relative 'asciidoctor-bibtex/asciidoctor'
+end
+require_relative 'asciidoctor-bibtex/citation'
+require_relative 'asciidoctor-bibtex/citationdata'
+require_relative 'asciidoctor-bibtex/citationutils'
+require_relative 'asciidoctor-bibtex/citations'
+require_relative 'asciidoctor-bibtex/extensions'
+require_relative 'asciidoctor-bibtex/filehandlers'
+require_relative 'asciidoctor-bibtex/options'
+require_relative 'asciidoctor-bibtex/processorutils'
+require_relative 'asciidoctor-bibtex/processor'
+require_relative 'asciidoctor-bibtex/styles'
+require_relative 'asciidoctor-bibtex/version'

data/lib/asciidoctor-bibtex/asciidoctor.rb

@@ -0,0 +1,6 @@
+require 'asciidoctor/extensions'
+require_relative 'bibextension'
+
+Asciidoctor::Extensions.register do
+  preprocessor AsciidoctorBibtex::Asciidoctor::AsciidoctorBibtexExtension
+end

data/lib/asciidoctor-bibtex/bibextension.rb

@@ -0,0 +1,66 @@
+# Uses Asciidoctor extension mechanism to insert asciidoc-bib processing
+# as a preprocessor step.  This provides single-pass compilation of 
+# documents, including citations and references.
+#
+# Copyright (c) Peter Lane, 2013.
+# Released under Open Works License, 0.9.2
+
+require 'asciidoctor'
+require 'asciidoctor/extensions'
+require 'asciidoctor/cli'
+require_relative 'options'
+
+module AsciidoctorBibtex
+  module Asciidoctor
+
+    class AsciidoctorBibtexExtension < ::Asciidoctor::Extensions::Preprocessor
+
+      def process document, reader
+        return reader if reader.eof?
+
+        options = Options.new
+        options.parse_attributes document.attributes
+
+        # -- read in all lines from reader, processing the lines
+
+        lines = reader.readlines
+        biblio = BibTeX.open options.bibfile
+
+        processor = Processor.new biblio, options.links, options.style
+        lines.each do |line|
+          processor.citations.add_from_line line
+        end
+
+        # -- replace cites with correct text
+
+        lines.each do |line|
+          processor.citations.retrieve_citations(line).each do |citation|
+            line.gsub!(citation.original, processor.complete_citation(citation))
+          end
+        end
+
+        # -- add in bibliography
+
+        biblio_index = lines.index do |line|
+          # find bibliography macro on line by itself, with or without newline
+          (line =~ BIBMACRO_FULL) != nil
+        end
+        unless biblio_index.nil?
+          lines.delete_at biblio_index
+          processor.sorted_cites.reverse.each do |ref|
+            lines.insert biblio_index, "\n"
+            lines.insert biblio_index, processor.get_reference(ref)
+            lines.insert biblio_index, "[normal]\n" # ? needed to force paragraph breaks
+          end
+        end
+
+        reader.unshift_lines lines
+
+        return reader
+      end
+
+      BIBMACRO_FULL = /bibliography::(.*?)\[(\w+)?\]/
+    end
+
+  end
+end

data/lib/asciidoctor-bibtex/citation.rb

@@ -0,0 +1,25 @@
+# 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.gsub!("--","-")
+    end
+
+    def to_s
+      "#{@ref}:#{@pages}"
+    end
+  end
+end
+

data/lib/asciidoctor-bibtex/citationdata.rb

@@ -0,0 +1,23 @@
+# 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

@@ -0,0 +1,45 @@
+#
+# 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

@@ -0,0 +1,67 @@
+# 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 = /(\w+)(\(\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/extensions.rb

@@ -0,0 +1,64 @@
+# Some extension and helper methods. 
+#
+# Copyright (c) Peter Lane, 2012-13.
+# Released under Open Works License, 0.9.2
+
+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 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
+
+# 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
+

data/lib/asciidoctor-bibtex/filehandlers.rb

@@ -0,0 +1,32 @@
+#
+# 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/options.rb

@@ -0,0 +1,141 @@
+# Class to read in asciidoc-bibtex options from command-line, and 
+# store results in an accessible form.
+#
+# Copyright (c) Peter Lane, 2013.
+# Released under Open Works License, 0.9.2
+
+require 'optparse'
+
+module AsciidoctorBibtex
+  class Options
+    attr_reader :bibfile, :filename, :links, :style
+
+    def initialize(program_name = 'asciidoc-bibtex')
+      @bibfile = ''
+      @links = true
+      @numeric_order = :alphabetical
+      @style = AsciidoctorBibtex::Styles.default_style
+      @program_name = program_name
+    end
+
+    # Public: Parse options from commandline.
+    # This function is used by asciidoc-bib command.
+    def parse!(args = ARGV)
+      options = OptionParser.new do |opts|
+        opts.banner = "Usage: #{@program_name} filename"
+        opts.on("-h", "--help", "help message") do |v|
+          puts "#{@program_name} #{AsciidoctorBibtex::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 #{AsciidoctorBibtex::VERSION}"
+          exit!
+        end
+      end
+
+      begin
+        options.parse! args
+      rescue 
+        puts options
+        exit!
+      end
+
+      # unless specified by caller, try to find the bibliography
+      if @bibfile.empty?
+        @bibfile = AsciidoctorBibtex::FileHandlers.find_bibliography "."
+        if @bibfile.empty?
+          @bibfile = AsciidoctorBibtex::FileHandlers.find_bibliography "#{ENV['HOME']}/Documents"
+        end
+      end
+      if @bibfile.empty?
+        puts "Error: could not find a bibliography file"
+        exit
+      end
+      unless AsciidoctorBibtex::Styles.valid? @style
+        puts "Error: style #{@style} was not one of the available styles"
+        exit
+      end
+
+      if args.length == 1
+        @filename = args[0]
+      else
+        puts "Error: a single file to convert must be given"
+        exit
+      end
+
+      puts "Reading biblio: #{@bibfile}"
+      puts "Reference style: #{@style}"
+      puts "Numerical order: #{@numeric_order}"
+    end
+    
+    # Public: Parse values given `attrs`
+    # This function is used by asciidoctor preprocessor to determine options
+    # from document attributes.
+    def parse_attributes(attrs)
+      if attrs['bib-style']
+        @style = attrs['bib-style']
+      end
+      if attrs['bib-file']
+        @bibfile = attrs['bib-file']
+      end
+      if attrs['bib-numeric-order']
+        order = attrs['bib-numeric-order']
+        if order == "appearance"
+          @numeric_order = :appearance
+        elsif order == "alphabetical"
+          @numeric_order = :alphabetical
+        else
+          raise RuntimeError.new "Unknown numeric order: #{order}"
+        end
+      end
+      if attrs['bib-no-links']
+        @links = false
+      end
+
+      # unless specified by caller, try to find the bibliography
+      if @bibfile.empty?
+        @bibfile = AsciidoctorBibtex::FileHandlers.find_bibliography "."
+        if @bibfile.empty?
+          @bibfile = AsciidoctorBibtex::FileHandlers.find_bibliography "#{ENV['HOME']}/Documents"
+        end
+      end
+      if @bibfile.empty?
+        puts "Error: could not find a bibliography file"
+        exit
+      end
+      unless AsciidoctorBibtex::Styles.valid? @style
+        puts "Error: style #{@style} was not one of the available styles"
+        exit
+      end
+
+      puts "Reading biblio: #{@bibfile}"
+      puts "Reference style: #{@style}"
+      puts "Numerical order: #{@numeric_order}"
+    end
+
+    def numeric_in_appearance_order?
+      @numeric_order == :appearance
+    end
+  end
+end
+

data/lib/asciidoctor-bibtex/processor.rb

@@ -0,0 +1,270 @@
+#
+# 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
+
+    # 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
+
+    attr_reader :biblio, :links, :style, :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 =~ BIBMACRO_FULL) != nil
+              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
+    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
+
+    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 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 = 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
+
+    def sorted_cites
+      @citations.sorted_cites @biblio
+    end
+
+    BIBMACRO_FULL = /bibliography::(.*?)\[(\w+)?\]/
+  end
+end
+
+

data/lib/asciidoctor-bibtex/processorutils.rb

@@ -0,0 +1,34 @@
+
+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/asciidoctor-bibtex/styles.rb

@@ -0,0 +1,27 @@
+#
+# styles.rb
+# Simple checks on available styles through CSL
+#
+
+module AsciidoctorBibtex
+
+  module Styles
+
+    def Styles.available
+      CSL::Style.ls
+    end
+
+    def Styles.default_style
+      'apa'
+    end
+
+    def Styles.valid? style
+      Styles.available.include? style
+    end
+
+    def Styles.is_numeric? style
+      CSL::Style.load(style).citation_format == :numeric
+    end
+  end
+end
+

data/lib/asciidoctor-bibtex/version.rb

@@ -0,0 +1,3 @@
+module AsciidoctorBibtex
+  VERSION = '0.1.0'
+end

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: See cite:[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: See cite:[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: See cite:[Lane12a, Lane12b(89-93)]
+
+Note: citations cannot be split over lines; each citation must be on one line.

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: asciidoctor-bibtex
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Zhang YANG
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-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: '4.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.11
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.11
+- !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: |
+  asciidoctor-bibtex is a fork of asciidoc-bib. It generates in-text references
+  and a reference list for an asciidoc file, using a bibtex file as a source of
+  citation information. The citation syntax tries to assemble asciidoc inline
+  macros and block macros, with `cite:[bibref]` for in-text citation and
+  `bibliography::[]` for reference list. It can be used standalone or as an
+  asciidoctor extension. See the README for more examples and further options.
+  The references are formatted using styles provided by CSL.
+email: zyangmath@gmail.com
+executables:
+- asciidoctor-bibtex
+- asciidoc-bibtex
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+files:
+- LICENSE.txt
+- README.rdoc
+- bin/asciidoc-bibtex
+- bin/asciidoctor-bibtex
+- lib/asciidoctor-bibtex.rb
+- lib/asciidoctor-bibtex/asciidoctor.rb
+- lib/asciidoctor-bibtex/bibextension.rb
+- lib/asciidoctor-bibtex/citation.rb
+- lib/asciidoctor-bibtex/citationdata.rb
+- lib/asciidoctor-bibtex/citations.rb
+- lib/asciidoctor-bibtex/citationutils.rb
+- lib/asciidoctor-bibtex/extensions.rb
+- lib/asciidoctor-bibtex/filehandlers.rb
+- lib/asciidoctor-bibtex/options.rb
+- lib/asciidoctor-bibtex/processor.rb
+- lib/asciidoctor-bibtex/processorutils.rb
+- lib/asciidoctor-bibtex/styles.rb
+- lib/asciidoctor-bibtex/version.rb
+- samples/biblio.bib
+- samples/sample-1.txt
+- samples/sample-2.txt
+homepage: https://github.com/ProgramFan/asciidoctor-bibtex
+licenses:
+- OWL
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: asciidoctor-bibtex adds bibtex references to an asciidoc file.
+test_files: []