asciidoctor-bibliography 0.0.1.dev

data/deprecated/asciidoctor-bibliography/asciidoctor/citation_processor.rb

@@ -0,0 +1,144 @@
+require 'asciidoctor'
+require 'asciidoctor/extensions'
+require 'asciidoctor/reader'
+require 'asciidoctor/parser'
+# 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'
+# require_relative 'styles'
+# require_relative 'filehandlers'
+
+module AsciidoctorBibliography
+  module Asciidoctor
+
+    # 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
+
+    # This processor scans the document, generates a list of citations,
+    # replace each citation with correct text and the reference block macro
+    # placeholder with the final reference list. It relys on the block macro
+    # processor to generate the place holder.
+    class CitationProcessor < ::Asciidoctor::Extensions::Treeprocessor
+
+      def process document
+        puts self
+        # byebug
+        # bibtex_file = (document.attr 'bibtex-file').to_s
+        # bibtex_style = ((document.attr 'bibtex-style') || 'ieee').to_s
+        # bibtex_order = ((document.attr 'bibtex-order') || 'appearance').to_sym
+        # bibtex_format = ((document.attr 'bibtex-format') || 'asciidoc').to_sym
+
+        # if bibtex_file.empty?
+        #   bibtex_file = AsciidoctorBibliography::FileHandlers.find_bibliography "."
+        # end
+        # if bibtex_file.empty?
+        #   bibtex_file = AsciidoctorBibliography::FileHandlers.find_bibliography "#{ENV['HOME']}/Documents"
+        # end
+        # if bibtex_file.empty?
+        #   puts "Error: bibtex-file is not set and automatic search failed"
+        #   exit
+        # end
+
+        # bibtex = BibTeX.open bibtex_file, :filter => [LatexFilter]
+        # processor = Processor.new bibtex, true, bibtex_style, bibtex_order == :appearance, bibtex_format
+
+        # prose_blocks = document.find_by {|b| b.content_model == :simple or b.context == :list_item}
+        # prose_blocks.each do |block|
+        #   if block.context == :list_item
+        #     line = block.instance_variable_get :@text
+        #     processor.citations.add_from_line line
+        #   else
+        #     block.lines.each do |line|
+        #       processor.citations.add_from_line line
+        #     end
+        #   end
+        # end
+
+        # prose_blocks.each do |block|
+        #   if block.context == :list_item
+        #     line = block.instance_variable_get :@text
+        #     processor.citations.retrieve_citations(line).each do |citation|
+        #       line.gsub!(citation.original, processor.complete_citation(citation))
+        #     end
+        #     block.instance_variable_set :@text, line
+        #   else
+        #     block.lines.each do |line|
+        #       processor.citations.retrieve_citations(line).each do |citation|
+        #         line.gsub!(citation.original, processor.complete_citation(citation))
+        #       end
+        #     end
+        #   end
+        # end
+
+        # references_asciidoc = []
+        # if bibtex_format == :latex
+        #   references_asciidoc << %(+++\\bibliography{#{bibtex_file}}{}+++)
+        #   references_asciidoc << %(+++\\bibliographystyle{#{bibtex_style}}+++)
+        # else
+        #   processor.cites.each do |ref|
+        #     references_asciidoc << processor.get_reference(ref)
+        #     references_asciidoc << ''
+        #   end
+        # end
+
+        # biblio_blocks = document.find_by do |b|
+        #   # for fast search (since most searches shall fail)
+        #   b.content_model == :simple and b.lines.size == 1 \
+        #     and b.lines[0] == BibliographyBlockMacroPlaceholder
+        # end
+        # biblio_blocks.each do |block|
+        #   block_index = block.parent.blocks.index do |b|
+        #     b == block
+        #   end
+        #   reference_blocks = parse_asciidoc block.parent, references_asciidoc
+        #   reference_blocks.reverse.each do |b|
+        #     block.parent.blocks.insert block_index, b
+        #   end
+        #   block.parent.blocks.delete_at block_index + reference_blocks.size
+        # end
+
+        # nil
+      end
+
+      # This is an adapted version of Asciidoctor::Extension::parse_content,
+      # where resultant blocks are returned as a list instead of attached to
+      # the parent.
+      def parse_asciidoc parent, content, attributes = {}
+        result = []
+        reader = ::Asciidoctor::Reader.new content
+        while reader.has_more_lines?
+          block = ::Asciidoctor::Parser.next_block reader, parent, attributes
+          result << block if block
+        end
+        result
+      end
+
+    end
+
+  end
+end

data/deprecated/asciidoctor-bibliography/asciidoctor/cite_inline_macro.rb

@@ -0,0 +1,30 @@
+require 'asciidoctor'
+require 'asciidoctor/extensions'
+
+require 'securerandom'
+
+module AsciidoctorBibliography
+  module Asciidoctor
+
+    class CiteInlineMacro < ::Asciidoctor::Extensions::InlineMacroProcessor
+      use_dsl
+
+      named :cite
+      # name_positional_attributes 'volnum'
+
+      def process parent, target, attrs
+        puts self
+
+        citation = AsciidoctorBibliography::Citation.new parent, target, attrs, SecureRandom.uuid
+        parent.document.bibliographer.citations << citation
+
+        # text = target # TODO: typeset
+        # target = "#bibliography-#{target}"
+        # parent.document.register :links, target
+        # (create_anchor parent, text, type: :link, target: target).render
+
+        citation.placeholder
+      end
+    end
+  end
+end

data/deprecated/asciidoctor-bibliography/citationdata.rb

@@ -0,0 +1,23 @@
+# citationdata class
+#
+# Copyright (c) Peter Lane, 2013.
+# Released under Open Works License, 0.9.2
+
+module AsciidoctorBibliography
+  # 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/deprecated/asciidoctor-bibliography/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 AsciidoctorBibliography
+  # 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/deprecated/asciidoctor-bibliography/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 AsciidoctorBibliography
+  # 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|fullcite/
+    # 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/deprecated/asciidoctor-bibliography/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 AsciidoctorBibliographyArrayExtensions
+
+  # 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 AsciidoctorBibliographyArrayExtensions
+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/deprecated/asciidoctor-bibliography/filehandlers.rb

@@ -0,0 +1,32 @@
+#
+# filehandlers.rb
+# Contains top-level file utility methods
+#
+
+module AsciidoctorBibliography
+
+  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/deprecated/asciidoctor-bibliography/index.rb

@@ -0,0 +1,31 @@
+module AsciidoctorBibliography
+  class Index
+    attr_reader :parent, :target, :attrs, :uuid
+
+    def initialize(parent, target, attrs, uuid)
+      @parent = parent
+      @target = target
+      @attrs = attrs
+      @uuid = uuid
+    end
+
+    def placeholder
+      "{#{uuid}}"
+    end
+
+    # 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
+