asciidoctor-bibliography 0.1 → 0.2.0

data/spec/citation_item_spec.rb

@@ -0,0 +1,52 @@
+require 'asciidoctor-bibliography/helpers'
+
+describe AsciidoctorBibliography::CitationItem do
+  describe '.new' do
+    it 'can be mutely initialized' do
+      expect { described_class.new }.to_not raise_exception
+    end
+
+    it 'can be initialized with a block operating on itself' do
+      itself = nil
+      expect(described_class.new { |ci| itself = ci }).to be(itself)
+    end
+  end
+
+  describe '#parse_attribute_list' do
+    subject { described_class.new }
+
+    before do
+      subject.parse_attribute_list 'foo, lol=bar, baz, qux, zod=13'
+    end
+
+    it 'treats the first positional attribute as the id' do
+      expect(subject.key).to eq 'foo'
+    end
+
+    it 'extracts the positional attributes in order, except the first one' do
+      expect(subject.positional_attributes).to eq ['baz', 'qux']
+    end
+
+    it 'extracts all named attributes' do
+      expect(subject.named_attributes).to eq({'lol' => 'bar', 'zod' => '13'})
+    end
+  end
+
+  describe '#locators' do
+    subject { described_class.new }
+
+    it 'returns no locators if none are present' do
+      subject.parse_attribute_list 'foo, lol=bar, baz, qux, zod=13'
+      expect(subject.locators).to eq ({})
+    end
+
+    it 'recognizes all CSL locators' do
+      locators = %w[book chapter column figure folio issue line note opus page paragraph part section sub-verbo verse volume]
+      locators_hash = locators.map { |l| [l, rand(10).to_s] }.to_h
+      locators_string = locators_hash.to_a.map { |a| a.join '=' }.join(', ')
+
+      subject.parse_attribute_list "foo, #{locators_string}"
+      expect(subject.locators).to eq locators_hash
+    end
+  end
+end

data/spec/database_spec.rb

@@ -0,0 +1,39 @@
+require 'asciidoctor-bibliography/helpers'
+
+describe AsciidoctorBibliography::Database do
+  describe '.new' do
+    it 'is by default an empty array' do
+      expect(described_class.new).to eq([])
+    end
+
+    it 'can be initialized with a single database' do
+      expect(described_class.new("spec/fixtures/database.bib")).to_not eq([])
+    end
+
+    it 'can be initialized with a list of databases' do
+      expect(described_class.new("spec/fixtures/database.bib", "spec/fixtures/database.bibtex")).to_not eq([])
+    end
+  end
+
+  describe '#append' do
+    let(:db) { described_class.new }
+
+    it 'can load and concatenate databases after initialization' do
+      expect(db.length).to eq(0)
+      expect { db.append("spec/fixtures/database.bib") }.to change { db.length }
+      expect { db.append("spec/fixtures/database.bibtex") }.to change { db.length }
+    end
+  end
+
+  describe '.load' do
+    it 'raises error if given unknown format' do
+      expect { described_class.load 'spec/fixtures/database.unk' }
+        .to raise_exception AsciidoctorBibliography::Exceptions::DatabaseFormatNotSupported
+    end
+
+    it 'recognizes Bib(La)Tex databases' do
+      expect { described_class.load 'spec/fixtures/database.bib' }.to_not raise_exception
+      expect { described_class.load 'spec/fixtures/database.bibtex' }.to_not raise_exception
+    end
+  end
+end

data/spec/fixtures/database.bib

@@ -0,0 +1,31 @@
+@book{Lane12a,
+	author = {P. Lane},
+	title =	 {Book title},
+	publisher = {Publisher},
+	year =	 {2000}
+}
+
+@book{Lane12b,
+	author = {K. Mane and D. Smith},
+	title =	 {Book title},
+	publisher = {Publisher},
+	year =	 {2000}
+}
+
+@book{Anderson98,
+	editor = {J. R. Anderson and C. Lebiere},
+	title = {The Atomic Components of {2\sum} 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/spec/fixtures/database.bibtex

@@ -0,0 +1,6 @@
+@article{Bar10,
+	author = {F. Bar},
+	title =	 {Article title},
+	publisher = {Publisher},
+	year =	 {2010}
+}

data/spec/throwaway_spec.rb

@@ -0,0 +1,6 @@
+describe :throwaway do
+  # This just covers a couple of trivial lines to better track coverage.
+  # To be deleted when coverage is satisfactory.
+  document = Asciidoctor::Document.new
+  document.bibliographer
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-bibliography
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: 0.2.0
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-24 00:00:00.000000000 Z
+date: 2017-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -84,16 +84,16 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
@@ -150,6 +150,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: |
   asciidoctor-bibliography adds bibliography support for asciidoc documents by introducing
   two new macros: `cite:[KEY]` and `bibliography::[]`. Citations are parsed and
@@ -164,6 +192,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt
@@ -171,40 +200,47 @@ files:
 - Rakefile
 - SYNTAX.adoc
 - asciidoctor-bibliography.gemspec
-- deprecated/asciidoctor-bibliography/asciidoctor/bibliographer_postprocessor.rb
-- deprecated/asciidoctor-bibliography/asciidoctor/bibliography_block_macro.rb
-- deprecated/asciidoctor-bibliography/asciidoctor/citation_processor.rb
-- deprecated/asciidoctor-bibliography/asciidoctor/cite_inline_macro.rb
-- deprecated/asciidoctor-bibliography/citationdata.rb
-- deprecated/asciidoctor-bibliography/citations.rb
-- deprecated/asciidoctor-bibliography/citationutils.rb
-- deprecated/asciidoctor-bibliography/extensions.rb
-- deprecated/asciidoctor-bibliography/filehandlers.rb
-- deprecated/asciidoctor-bibliography/index.rb
-- deprecated/asciidoctor-bibliography/processor.rb
-- deprecated/asciidoctor-bibliography/processorutils.rb
-- deprecated/asciidoctor-bibliography/styles.rb
 - lib/asciidoctor-bibliography.rb
 - lib/asciidoctor-bibliography/asciidoctor.rb
 - lib/asciidoctor-bibliography/asciidoctor/bibliographer_preprocessor.rb
+- lib/asciidoctor-bibliography/asciidoctor/document_ext.rb
 - lib/asciidoctor-bibliography/bibliographer.rb
 - lib/asciidoctor-bibliography/citation.rb
+- lib/asciidoctor-bibliography/citation_item.rb
 - lib/asciidoctor-bibliography/database.rb
 - lib/asciidoctor-bibliography/databases/bibtex.rb
+- lib/asciidoctor-bibliography/exceptions.rb
 - lib/asciidoctor-bibliography/formatters/csl.rb
 - lib/asciidoctor-bibliography/formatters/tex.rb
 - lib/asciidoctor-bibliography/helpers.rb
 - lib/asciidoctor-bibliography/index.rb
 - lib/asciidoctor-bibliography/version.rb
-- samples/biblio.bib
 - samples/latex_macros_in_bibtex/reference.bib
 - samples/latex_macros_in_bibtex/sample.adoc
-- samples/sample-authoryear.adoc
-- samples/sample-authoryear.html
-- samples/sample-numbers.adoc
-- samples/sample-numbers.html
+- samples/standard/biblio.bib
+- samples/standard/sample-default.adoc
+- samples/standard/sample-default.html
+- samples/standard/sample-din.adoc
+- samples/standard/sample-din.html
+- samples/standard/sample-ieee.adoc
+- samples/standard/sample-ieee.html
+- samples/tex/biblio.bib
+- samples/tex/sample-authoryear.adoc
+- samples/tex/sample-authoryear.html
+- samples/tex/sample-din.adoc
+- samples/tex/sample-din.html
+- samples/tex/sample-numbers.adoc
+- samples/tex/sample-numbers.html
+- samples/tex/sample-ordering.adoc
+- samples/tex/sample-ordering.html
+- spec/citation_item_spec.rb
+- spec/database_spec.rb
+- spec/fixtures/database.bib
+- spec/fixtures/database.bibtex
+- spec/fixtures/database.unk
 - spec/helpers_spec.rb
 - spec/spec_helper.rb
+- spec/throwaway_spec.rb
 homepage: https://github.com/riboseinc/asciidoctor-bibliography
 licenses:
 - MIT
@@ -217,7 +253,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

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

@@ -1,23 +0,0 @@
-require 'asciidoctor'
-require 'asciidoctor/extensions'
-
-module AsciidoctorBibliography
-  module Asciidoctor
-
-    class BibliographerPostprocessor < ::Asciidoctor::Extensions::Postprocessor
-      def process document, output
-        puts self
-        # byebug
-        # content = (document.attr 'copyright') || 'Copyright Acme, Inc.'
-        # if document.basebackend? 'html'
-        #   replacement = %(<div id="footer-text">\\1<br>\n#{content}\n</div>)
-        #   output = output.sub(/<div id="footer-text">(.*?)<\/div>/m, replacement)
-        # elsif document.basebackend? 'docbook'
-        #   replacement = %(<simpara>#{content}</simpara>\n\\1)
-        #   output = output.sub(/(<\/(?:article|book)>)/, replacement)
-        # end
-        output
-      end
-    end
-  end
-end

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

@@ -1,77 +0,0 @@
-require 'bibtex'
-
-require 'asciidoctor'
-require 'asciidoctor/extensions'
-require 'asciidoctor/reader'
-require 'asciidoctor/parser'
-# require 'bibliography/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'
-
-require 'byebug'
-
-module AsciidoctorBibliography
-  module Asciidoctor
-    class BibliographyBlockMacro < ::Asciidoctor::Extensions::BlockMacroProcessor
-      use_dsl
-      named :bibliography
-      # positional_attributes :style
-
-      def process parent, target, attrs
-        puts self
-
-        # List of targets to render
-        keys = parent.document.bibliographer.occurrences.map { |o| o[:target] }.uniq
-
-
-        # NOTE: bibliography-file and bibliography-reference-style set by this macro
-        #   shall be overridable by document attributes and commandline arguments.
-        #   So we respect the convention here.
-
-        # if target and not parent.document.attr? 'bibliography-file'
-        #   parent.document.set_attribute 'bibliography-file', target
-        # end
-
-        if parent.document.attr? 'bibliography-database'
-          parent.document.bibliographer.load_database parent.document.attributes['bibliography-database']
-        end
-
-        # if attrs.key? :style and not parent.document.attr? 'bibliography-reference-style'
-        #   parent.document.set_attribute 'bibliography-reference-style', attrs[:style]
-        # end
-
-        # index = AsciidoctorBibliography::Index.new parent, target, attrs, SecureRandom.uuid
-        # parent.document.bibliographer.indices << index
-
-        # html = index.placeholder
-        # attrs = {}
-
-        # create_pass_block parent, html, attrs#, subs: nil
-
-        # parent.document.register :links, target
-        # create_anchor parent, text, type: :link, target: target
-
-        # byebug
-
-        # keys.each do |key|
-        #   create_paragraph parent, key, {}
-        # end
-
-        # index_block = create_block parent, a
-        create_paragraph index_block, keys.first, {}
-
-        # Asciidoctor::Block.new(parent, :paragraph, :source => '_This_ is a <test>')
-
-        # TODO: unordered list
-      end
-    end
-
-  end
-end

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

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