asciidoctor-bibliography 0.4.3 → 0.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a54dc9ae017f2210a577ed1f065f62fb012ac6d8
-  data.tar.gz: 5e382f6eaf3989f42feb0a8b90f1dcf1d1289d08
+  metadata.gz: 5a347f15409faab328c514fa0f6e63e3f583af11
+  data.tar.gz: 0b6b7cba4b713bb56415d847f3d4ef385d0bb85e
 SHA512:
-  metadata.gz: dcaaba5e5312d238298156007f7d73180f63c45903eba25079e491779265bcf84f4c95ad23bbc00e4808c97e72e3b0a92c15efec44590b0b2b3b41cd4ee4634f
-  data.tar.gz: '0089c34a2ffd99fdf2838a87cd58b99fd85c279932960f0f7ec3e46b7fa6e97e819803cbd3499aab666cb1bac77d73224d3ad7e14ab50d122b51aef74901e04d'
+  metadata.gz: 19c0a0935001b19eccf5b76e9b0453e9ac81888e27fbdfffc47929bde2d0580ae7cd80b4ec19a7e8c82ec62c06261d694371fe5f30ec9c4c47dc1b9d86e2848a
+  data.tar.gz: 1c6f3ca017bd84ffd4ac2a649717a57abab9882c3aa1995e743563988c3c350a511e794d2941b6b155cf6859bb77b9ee69d889c56c3de405d1b5de99d454c19e

data/.oss-guides.rubocop.yml

@@ -78,7 +78,7 @@ Style/Encoding:
   SupportedStyles:
   - when_needed
   - always
-Style/FileName:
+Naming/FileName:
   Description: Use snake_case for source file names.
   StyleGuide: https://github.com/bbatsov/ruby-style-guide#snake-case-files
   Enabled: false
@@ -159,7 +159,7 @@ Style/MethodDefParentheses:
   SupportedStyles:
   - require_parentheses
   - require_no_parentheses
-Style/MethodName:
+Naming/MethodName:
   Description: Use the configured style when naming methods.
   StyleGuide: https://github.com/bbatsov/ruby-style-guide#snake-case-symbols-methods-vars
   Enabled: true
@@ -200,7 +200,7 @@ Style/PercentQLiterals:
   SupportedStyles:
   - lower_case_q
   - upper_case_q
-Style/PredicateName:
+Naming/PredicateName:
   Description: Check the names of predicate methods.
   StyleGuide: https://github.com/bbatsov/ruby-style-guide#bool-methods-qmark
   Enabled: true
@@ -321,7 +321,7 @@ Style/TrivialAccessors:
   - to_str
   - to_s
   - to_sym
-Style/VariableName:
+Naming/VariableName:
   Description: Use the configured style when naming variables.
   StyleGuide: https://github.com/bbatsov/ruby-style-guide#snake-case-symbols-methods-vars
   Enabled: true
@@ -460,7 +460,7 @@ Style/SymbolArray:
   Description: Use %i or %I for arrays of symbols.
   StyleGuide: https://github.com/bbatsov/ruby-style-guide#percent-i
   Enabled: false
-Style/AccessorMethodName:
+Naming/AccessorMethodName:
   Description: Check the naming of accessor methods for get_/set_.
   Enabled: false
 Style/Alias:
@@ -475,7 +475,7 @@ Style/AsciiComments:
   Description: Use only ascii symbols in comments.
   StyleGuide: https://github.com/bbatsov/ruby-style-guide#english-comments
   Enabled: false
-Style/AsciiIdentifiers:
+Naming/AsciiIdentifiers:
   Description: Use only ascii symbols in identifiers.
   StyleGuide: https://github.com/bbatsov/ruby-style-guide#english-identifiers
   Enabled: false
@@ -504,7 +504,7 @@ Style/CharacterLiteral:
   Description: Checks for uses of character literals.
   StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-character-literals
   Enabled: false
-Style/ClassAndModuleCamelCase:
+Naming/ClassAndModuleCamelCase:
   Description: Use CamelCase for classes and modules.
   StyleGuide: https://github.com/bbatsov/ruby-style-guide#camelcase-classes
   Enabled: true
@@ -520,7 +520,7 @@ Style/ColonMethodCall:
   Description: 'Do not use :: for method call.'
   StyleGuide: https://github.com/bbatsov/ruby-style-guide#double-colons
   Enabled: false
-Style/ConstantName:
+Naming/ConstantName:
   Description: Constants should use SCREAMING_SNAKE_CASE.
   StyleGuide: https://github.com/bbatsov/ruby-style-guide#screaming-snake-case
   Enabled: true
@@ -613,10 +613,6 @@ Style/OneLineConditional:
   Description: Favor the ternary operator(?:) over if/then/else/end constructs.
   StyleGuide: https://github.com/bbatsov/ruby-style-guide#ternary-operator
   Enabled: false
-Style/OpMethod:
-  Description: When defining binary operators, name the argument other.
-  StyleGuide: https://github.com/bbatsov/ruby-style-guide#other-arg
-  Enabled: false
 Style/PerlBackrefs:
   Description: Avoid Perl-style regex back references.
   StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-perl-regexp-last-matchers

data/.travis.yml

@@ -2,3 +2,11 @@ sudo: false
 language: ruby
 rvm:
   -  2.3.0
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+script:
+  - bundle exec rspec
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/asciidoctor-bibliography.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec| # rubocop:disable Metrics/BlockLength
   spec.email         = ["open.source@ribose.com"]
 
   spec.summary       = 'Citations and bibliography the "asciidoctor-way"'
-  spec.description   = <<~END
+  spec.description   = <<~SPEC
     asciidoctor-bibliography lets you handle citations and bibliography the "asciidoctor-way"!
 
     Its syntax is designed to be native-asciidoctor:
@@ -24,7 +24,8 @@ Gem::Specification.new do |spec| # rubocop:disable Metrics/BlockLength
     Citation output styles are fully bridged to the CSL library, supporting formats such as IEEE, APA, Chicago, DIN and ISO 690.
 
     The `bibliography::[]` command generates a full reference list that adheres to your configured citation style.
-END
+  SPEC
+
   spec.homepage      = "https://github.com/riboseinc/asciidoctor-bibliography"
   spec.license       = "MIT"
 

data/lib/asciidoctor-bibliography/asciidoctor/bibliographer_preprocessor.rb

@@ -12,8 +12,12 @@ module AsciidoctorBibliography
         document.bibliographer.options =
           ::AsciidoctorBibliography::Options.new_from_reader reader
 
+        database_filepath =
+          File.expand_path document.bibliographer.options.database,
+                           document.base_dir
+
         document.bibliographer.database =
-          ::AsciidoctorBibliography::Database.new document.bibliographer.options.database
+          ::AsciidoctorBibliography::Database.new database_filepath
 
         processed_lines = process_lines reader.read_lines, document.bibliographer
         reader.unshift_lines processed_lines

data/lib/asciidoctor-bibliography/citation.rb

@@ -20,13 +20,14 @@ module AsciidoctorBibliography
       @uuid = SecureRandom.uuid
       @macro = macro
       @citation_items = []
+      # rubocop:disable Performance/HashEachMethods
       target_and_attributes_list_pairs.compact.each_slice(2).each do |_target, attribute_list|
         @citation_items << CitationItem.new do |cite|
           # NOTE: we're not doing anything with targets right now.
-          # cite.target = _target
           cite.parse_attribute_list attribute_list
         end
       end
+      # rubocop:enable Performance/HashEachMethods
     end
 
     def render(bibliographer)

data/lib/asciidoctor-bibliography/citation_item.rb

@@ -4,7 +4,7 @@ module AsciidoctorBibliography
   class CitationItem
     LOCATORS = CiteProc::CitationItem.labels.map(&:to_s).push("locator").freeze
 
-    attr_accessor :key, :target, :positional_attributes, :named_attributes, :locators
+    attr_accessor :key, :target, :positional_attributes, :named_attributes
 
     def initialize
       yield self if block_given?

data/lib/asciidoctor-bibliography/database.rb

@@ -4,14 +4,14 @@ require_relative "errors"
 module AsciidoctorBibliography
   # This is an array of citeproc entries.
   class Database < Array
-    def initialize(*filenames)
-      filenames.each do |filename|
-        append filename
+    def initialize(*filepaths)
+      filepaths.each do |filepath|
+        append filepath
       end
     end
 
-    def append(filename)
-      concat Database.load(filename)
+    def append(filepath)
+      concat Database.load(filepath)
     end
 
     def find_entry_by_id(id)
@@ -23,8 +23,7 @@ module AsciidoctorBibliography
       result
     end
 
-    def self.load(filename)
-      filepath = File.expand_path filename
+    def self.load(filepath)
       raise Errors::Database::FileNotFound, filepath unless File.exist?(filepath)
 
       fileext = File.extname filepath

data/lib/asciidoctor-bibliography/version.rb

@@ -1,3 +1,3 @@
 module AsciidoctorBibliography
-  VERSION = "0.4.3".freeze
+  VERSION = "0.4.4".freeze
 end

data/spec/sanity_spec.rb

@@ -0,0 +1,120 @@
+require "asciidoctor"
+
+def setup_tmpdir(method_name = :tmpdir)
+  let(method_name) { File.join Dir.tmpdir, "asciidoctor-bibliography_tests" }
+
+  around(:each) do |example|
+    FileUtils.rm_rf method(method_name).call
+    FileUtils.mkdir_p method(method_name).call
+    example.run
+    FileUtils.rm_rf method(method_name).call
+  end
+end
+
+def setup_main_document(_path, content)
+  input_path = File.join(tmpdir, "main.adoc")
+  output_path = File.join(tmpdir, "main.html")
+  File.open(input_path, "w") { |file| file.write content }
+  [input_path, output_path]
+end
+
+def setup_file(_path, name, content)
+  File.open(File.join(tmpdir, name), "w") { |file| file.write content }
+end
+
+def setup_bibliography(content)
+  let(:bibliography_path) do
+    File.join(tmpdir, "bibliography.bibtex")
+  end
+
+  before do
+    File.open(bibliography_path, "w") { |file| file.write content }
+  end
+end
+
+describe "asciidoctor integration" do
+  setup_tmpdir
+
+  setup_bibliography <<~BIBTEX
+    @article{Foo00,
+      author = {Foo Bar},
+      title =	{Title},
+      publisher = {Publisher},
+      year = {2000}
+    }
+  BIBTEX
+
+  describe "testing procedure" do
+    it "works in the trivial case" do
+      input_path, output_path = setup_main_document tmpdir, <<~'ADOC'
+        Hello World.
+      ADOC
+
+      expect { `asciidoctor #{input_path}` }.to_not raise_exception
+      expect(File.read(output_path)).to match <<~'BODY'
+        <div id="content">
+        <div class="paragraph">
+        <p>Hello World.</p>
+        </div>
+        </div>
+      BODY
+    end
+  end
+
+  describe "single file usage" do
+    it "works with a single file, a citation and the bibliography" do
+      input_path, output_path = setup_main_document tmpdir, <<~ADOC
+        :bibliography-database: #{bibliography_path}
+
+        Hello World. cite:[Foo00]
+
+        bibliography::[]
+      ADOC
+
+      expect { `asciidoctor -r asciidoctor-bibliography #{input_path} --trace` }.to_not raise_exception
+      expect(File.read(output_path)).to include <<~'BODY'
+        <div id="content">
+        <div class="paragraph">
+        <p>Hello World. (<a href="#bibliography-Foo00">Bar, 2000</a>)</p>
+        </div>
+        <div class="paragraph">
+        <p><a id="bibliography-Foo00"></a>Bar, F. (2000). Title.</p>
+        </div>
+        </div>
+      BODY
+    end
+  end
+
+  describe "nested files usage" do
+    it "works with a single file, a citation and the bibliography" do
+      setup_file tmpdir, "nested.adoc", <<~ADOC
+        This is content from a nested file. cite:[Foo00]
+
+        bibliography::[]
+      ADOC
+
+      input_path, output_path = setup_main_document tmpdir, <<~ADOC
+        :bibliography-database: #{bibliography_path}
+
+        Hello World. cite:[Foo00]
+
+        include::nested.adoc[]
+      ADOC
+
+      expect { `asciidoctor -r asciidoctor-bibliography #{input_path} --trace` }.to_not raise_exception
+      expect(File.read(output_path)).to include <<~'BODY'
+        <div id="content">
+        <div class="paragraph">
+        <p>Hello World. (<a href="#bibliography-Foo00">Bar, 2000</a>)</p>
+        </div>
+        <div class="paragraph">
+        <p>This is content from a nested file. (<a href="#bibliography-Foo00">Bar, 2000</a>)</p>
+        </div>
+        <div class="paragraph">
+        <p><a id="bibliography-Foo00"></a>Bar, F. (2000). Title.</p>
+        </div>
+        </div>
+      BODY
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-bibliography
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.4.4
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-30 00:00:00.000000000 Z
+date: 2017-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -297,6 +297,7 @@ files:
 - spec/fixtures/database.unk
 - spec/macros_spec.rb
 - spec/options_spec.rb
+- spec/sanity_spec.rb
 - spec/spec_helper.rb
 - spec/throwaway_spec.rb
 homepage: https://github.com/riboseinc/asciidoctor-bibliography