docparser 0.2.3 → 0.3.0

data/lib/docparser/output/nil_output.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DocParser
   # This Output is used for testing purposes.
 
@@ -8,13 +10,10 @@ module DocParser
       @rowcount = 0
     end
 
-    def close
-    end
+    def close; end
 
-    def write_row(*)
-    end
+    def write_row(*); end
 
-    def add_row(*)
-    end
+    def add_row(*); end
   end
 end

data/lib/docparser/output/xlsx_output.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'axlsx'
 module DocParser
   # The XLSXOutput class generates Microsoft Excel compatible .xlsx files

data/lib/docparser/output/yaml_output.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'yaml'
 module DocParser
   # The YAMLOutput class generates a YAML file containing all rows as seperate
@@ -6,7 +8,8 @@ module DocParser
   class YAMLOutput < Output
     # @!visibility private
     def write_row(row)
-      fail MissingHeaderException if @header.nil? || @header.length == 0
+      raise MissingHeaderException if @header.nil? || @header.empty?
+
       @doc ||= {}
 
       0.upto(@header.length - 1) do |counter|

data/lib/docparser/parser.rb

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
+
 require 'rubygems'
 require 'bundler/setup'
 require 'parallel'
+require 'logger'
 require 'set'
-require 'log4r'
-require 'log4r/formatter/patternformatter'
 require 'docparser/version'
 require 'docparser/output'
 require 'docparser/document'
@@ -15,13 +16,6 @@ require 'docparser/output/json_output.rb'
 require 'docparser/output/multi_output.rb'
 require 'docparser/output/nil_output.rb'
 
-Log4r.define_levels(*Log4r::Log4rConfig::LogLevels)
-logger = Log4r::Logger.new('docparser')
-output = Log4r::StdoutOutputter.new('docparser')
-output.formatter = Log4r::PatternFormatter.new(pattern: '[%l %C] %d :: %m')
-logger.outputters = output
-logger.level = Log4r::INFO
-
 # The DocParser namespace
 # See README.md for information on using DocParser
 module DocParser
@@ -48,11 +42,11 @@ module DocParser
       @files = range ? files[range] : files
       @encoding = encoding
 
-      Log4r::Logger['docparser'].level = quiet ? Log4r::ERROR : Log4r::INFO
+      @logger = Logger.new(STDERR)
+      @logger.level = quiet ? Logger::ERROR : Logger::INFO
 
       initialize_outputs output
 
-      @logger =  Log4r::Logger.new('docparser::parser')
       @logger.info "DocParser v#{VERSION} loaded"
     end
 
@@ -88,7 +82,7 @@ module DocParser
       elsif output.is_a?(Array) && output.all? { |o| o.is_a? Output }
         @outputs = output
       elsif output
-        fail ArgumentError, 'Invalid outputs specified'
+        raise ArgumentError, 'Invalid outputs specified'
       end
 
       @resultsets = Array.new(@outputs.length) { Set.new }
@@ -102,9 +96,11 @@ module DocParser
         parse_doc(file, &block)
         # :nocov: #
       end.each do |result|
+        next unless @outputs
+
         result.each_with_index do |set, index|
           @resultsets[index].merge(set)
-        end if @outputs
+        end
       end
     end
 

data/lib/docparser/version.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 # DocParser
 # See README.md for information on using DocParser
 module DocParser
   # The current version of DocParser
-  VERSION = '0.2.3'
+  VERSION = '0.3.0'
 end

data/test/.rubocop.yml

@@ -1,3 +1,7 @@
+inherit_from:
+  - ../.rubocop.yml
+  - .rubocop_todo.yml
+
 # Do not introduce global variables.
-GlobalVars:
-  Enabled: false
+Style/GlobalVars:
+  Enabled: false

data/test/.rubocop_todo.yml

@@ -0,0 +1,23 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2020-04-13 17:56:31 +0200 using RuboCop version 0.81.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 9
+# Configuration parameters: CountComments, ExcludedMethods.
+# ExcludedMethods: refine
+Metrics/BlockLength:
+  Max: 173
+
+# Offense count: 14
+Security/Open:
+  Exclude:
+    - 'lib/docparser/document_test.rb'
+    - 'lib/docparser/output/csv_output_test.rb'
+    - 'lib/docparser/output/html_output_test.rb'
+    - 'lib/docparser/output/json_output_test.rb'
+    - 'lib/docparser/output/multi_output_test.rb'
+    - 'lib/docparser/output/yaml_output_test.rb'

data/test/lib/docparser/blackbox_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../../test_helper'
 require 'open3'
 require 'shellwords'
@@ -14,15 +16,14 @@ describe DocParser do
     Dir.mktmpdir do |dir|
       Dir.chdir(dir)
       example_file = Shellwords.escape(File.join($ROOT_DIR, 'example.rb'))
-      out, err = cmd_to_sys '/usr/bin/env ruby ' + example_file
-      err.must_be_empty
-      rows = out.scan(/(\d+) rows/).flatten
+      _, err = cmd_to_sys '/usr/bin/env ruby ' + example_file
+      rows = err.scan(/(\d+) rows/).flatten
       rows.length.must_equal 5
       row_lengths = rows.group_by(&:to_i)
       row_lengths.length.must_equal 1
       # HaD: 40 pages of 7 articles
       row_lengths.keys.first.must_equal(7 * 40)
-      out.must_match(/Done processing/)
+      err.must_match(/Done processing/)
     end
     Dir.chdir(curwd)
   end

data/test/lib/docparser/document_test.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 require_relative '../../test_helper'
+
 describe DocParser::Document do
   before do
-    Log4r::Logger['docparser'].level = Log4r::INFO
     $output = DocParser::NilOutput.new
     @parser = Class.new do
       define_method(:outputs) { [$output] }
@@ -54,15 +56,15 @@ describe DocParser::Document do
   it 'should be possible to use css queries' do
     css = 'article > h1 + p'
     css_content = @test_doc.css_content(css)
-    css_element = @test_doc.css(css)
+    css_element = @test_doc.elements(css)
     css_content.must_equal('Great article it is')
     css_content.must_equal(css_element.first.content)
   end
 
   it 'should be possible to use xpath queries' do
     xpath = '//li/ancestor::article/h1'
-    xpath_content = @test_doc.xpath_content(xpath)
-    xpath_element = @test_doc.xpath(xpath)
+    xpath_content = @test_doc.element_content(xpath)
+    xpath_element = @test_doc.elements(xpath)
     xpath_content.must_equal('This is an article')
     xpath_content.must_equal(xpath_element.first.content)
   end
@@ -83,6 +85,11 @@ describe DocParser::Document do
       array2 << element.content
     end
     array2.must_equal(array)
+    array2 = []
+    @test_doc.each_element('//p') do |element|
+      array2 << element.content
+    end
+    array2.must_equal(array)
   end
 
   it 'should warn when providing an empty file' do
@@ -91,20 +98,19 @@ describe DocParser::Document do
     file.close
 
     open(file.path).read.empty?.must_equal true
-    _, err = capture_io do
-      # Switch to hijacked IO
-      Log4r::Outputter['docparser'].instance_variable_set(:@out, $stderr)
-      DocParser::Document.new(filename: file.path, parser: @parser)
-    end
-    # Restore IO
-    Log4r::Outputter['docparser'].instance_variable_set(:@out, $stderr)
-    err.must_include "#{file.path} is empty"
+    err = StringIO.new
+
+    DocParser::Document.new(filename: file.path,
+                            parser: @parser,
+                            logger: Logger.new(err))
+
+    err.string.must_include "#{file.path} is empty"
   end
 
   it 'should add the row to the results' do
     @test_doc.add_row ['test']
     @test_doc.add_row 'test', 'test2'
-    @test_doc.results.must_equal [[%w(test), %w(test test2)]]
+    @test_doc.results.must_equal [[%w[test], %w[test test2]]]
   end
 
   it 'should be possible to not use outputs' do
@@ -133,5 +139,4 @@ describe DocParser::Document do
     test_doc.add_row ['b'], output: 0
     test_doc.results.must_equal [[['b']], [['a']]]
   end
-
 end

data/test/lib/docparser/output/csv_output_test.rb

@@ -1,13 +1,8 @@
+# frozen_string_literal: true
+
 require_relative '../../../test_helper'
 
 describe DocParser::CSVOutput do
-  before do
-    Log4r::Logger['docparser'].level = Log4r::ERROR
-  end
-  after do
-    Log4r::Logger['docparser'].level = Log4r::INFO
-  end
-
   it 'must create a file' do
     Dir.mktmpdir do |dir|
       filename = File.join(dir, 'test.csv')
@@ -30,7 +25,7 @@ describe DocParser::CSVOutput do
     Dir.mktmpdir do |dir|
       filename = File.join(dir, 'test.csv')
       output = DocParser::CSVOutput.new(filename: filename)
-      output.add_row %w(aap noot mies)
+      output.add_row %w[aap noot mies]
       output.add_row ['aap', 'noot', 'mies;']
       output.close
       open(filename).read.must_equal "aap;noot;mies\naap;noot;\"mies;\"\n"
@@ -43,8 +38,8 @@ describe DocParser::CSVOutput do
       output = DocParser::CSVOutput.new(filename: filename)
       output.header = 'test', 'the', 'header'
       output.rowcount.must_equal 0
-      output.add_row %w(aap noot mies)
-      output.add_row %w(aap noot mies)
+      output.add_row %w[aap noot mies]
+      output.add_row %w[aap noot mies]
       output.rowcount.must_equal 2
     end
   end

data/test/lib/docparser/output/html_output_test.rb

@@ -1,13 +1,8 @@
+# frozen_string_literal: true
+
 require_relative '../../../test_helper'
 
 describe DocParser::HTMLOutput do
-  before do
-    Log4r::Logger['docparser'].level = Log4r::ERROR
-  end
-  after do
-    Log4r::Logger['docparser'].level = Log4r::INFO
-  end
-
   it 'must create a file' do
     Dir.mktmpdir do |dir|
       filename = File.join(dir, 'test.html')
@@ -31,7 +26,7 @@ describe DocParser::HTMLOutput do
     Dir.mktmpdir do |dir|
       filename = File.join(dir, 'test.html')
       output = DocParser::HTMLOutput.new(filename: filename)
-      output.add_row %w(aap noot mies)
+      output.add_row %w[aap noot mies]
       output.add_row ['aap', 'noot', 'mies;']
       output.close
       html = open(filename).read
@@ -47,8 +42,8 @@ describe DocParser::HTMLOutput do
       output = DocParser::HTMLOutput.new(filename: filename)
       output.header = 'test', 'the', 'header'
       output.rowcount.must_equal 0
-      output.add_row %w(aap noot mies)
-      output.add_row %w(aap noot mies)
+      output.add_row %w[aap noot mies]
+      output.add_row %w[aap noot mies]
       output.rowcount.must_equal 2
       output.close
       open(filename).read.must_include('<p>2 rows</p>')

data/test/lib/docparser/output/json_output_test.rb

@@ -1,13 +1,8 @@
+# frozen_string_literal: true
+
 require_relative '../../../test_helper'
 
 describe DocParser::JSONOutput do
-  before do
-    Log4r::Logger['docparser'].level = Log4r::ERROR
-  end
-  after do
-    Log4r::Logger['docparser'].level = Log4r::INFO
-  end
-
   it 'must create a file' do
     Dir.mktmpdir do |dir|
       filename = File.join(dir, 'test.json')
@@ -31,7 +26,7 @@ describe DocParser::JSONOutput do
       filename = File.join(dir, 'test.json')
       output = DocParser::JSONOutput.new(filename: filename)
       lambda do
-        output.add_row %w(aap noot mies)
+        output.add_row %w[aap noot mies]
       end.must_raise(DocParser::MissingHeaderException)
     end
   end
@@ -41,9 +36,9 @@ describe DocParser::JSONOutput do
       filename = File.join(dir, 'test.json')
       output = DocParser::JSONOutput.new(filename: filename)
       output.header = 'test', 'the', 'header'
-      output.add_row %w(a b c)
-      output.add_row %w(aap noot mies")
-      output.add_row %w(aap noot) # testing empty column
+      output.add_row %w[a b c]
+      output.add_row %w[aap noot mies"]
+      output.add_row %w[aap noot] # testing empty column
       output.close
       expected = '[{"test":"a","the":"b","header":"c"},
         {"test":"aap","the":"noot","header":"mies\""},
@@ -58,8 +53,8 @@ describe DocParser::JSONOutput do
       output = DocParser::JSONOutput.new(filename: filename)
       output.header = 'test', 'the', 'header'
       output.rowcount.must_equal 0
-      output.add_row %w(aap noot mies)
-      output.add_row %w(aap noot mies)
+      output.add_row %w[aap noot mies]
+      output.add_row %w[aap noot mies]
       output.rowcount.must_equal 2
     end
   end

data/test/lib/docparser/output/multi_output_test.rb

@@ -1,13 +1,8 @@
+# frozen_string_literal: true
+
 require_relative '../../../test_helper'
 
 describe DocParser::MultiOutput do
-  before do
-    Log4r::Logger['docparser'].level = Log4r::ERROR
-  end
-  after do
-    Log4r::Logger['docparser'].level = Log4r::INFO
-  end
-
   it 'must create files' do
     Dir.mktmpdir do |dir|
       filename = File.join(dir, 'test')
@@ -36,7 +31,7 @@ describe DocParser::MultiOutput do
       filename = File.join(dir, 'test')
       output = DocParser::MultiOutput.new(filename: filename)
       lambda do
-        output.add_row %w(aap noot mies)
+        output.add_row %w[aap noot mies]
       end.must_raise(DocParser::MissingHeaderException)
     end
   end
@@ -47,8 +42,8 @@ describe DocParser::MultiOutput do
       output = DocParser::MultiOutput.new(filename: filename)
       output.header = 'test', 'the', 'header'
       output.rowcount.must_equal 0
-      output.add_row %w(aap noot mies)
-      output.add_row %w(aap noot mies)
+      output.add_row %w[aap noot mies]
+      output.add_row %w[aap noot mies]
       output.rowcount.must_equal 2
     end
   end
@@ -57,7 +52,7 @@ describe DocParser::MultiOutput do
     Dir.mktmpdir do |dir|
       filename = File.join(dir, 'test')
       output = DocParser::MultiOutput.new(filename: filename)
-      methods = %i(add_row header= close)
+      methods = %i[add_row header= close]
       outputs = output.instance_variable_get(:@outputs)
       outputs.map! do |o|
         SimpleMock.new o
@@ -76,5 +71,4 @@ describe DocParser::MultiOutput do
       end
     end
   end
-
 end

data/test/lib/docparser/output/nil_output_test.rb

@@ -1,13 +1,8 @@
+# frozen_string_literal: true
+
 require_relative '../../../test_helper'
 
 describe DocParser::NilOutput do
-  before do
-    Log4r::Logger['docparser'].level = Log4r::ERROR
-  end
-  after do
-    Log4r::Logger['docparser'].level = Log4r::INFO
-  end
-
   it 'should not create a file' do
     Dir.mktmpdir do |dir|
       filename = File.join(dir, '*')
@@ -20,8 +15,8 @@ describe DocParser::NilOutput do
     output = DocParser::NilOutput.new
     output.header = 'test', 'the', 'header'
     output.rowcount.must_equal 0
-    output.add_row %w(aap noot mies)
-    output.add_row %w(aap noot mies)
+    output.add_row %w[aap noot mies]
+    output.add_row %w[aap noot mies]
     output.rowcount.must_equal 0
   end
 end