darlingtonia 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a2fc4e8abdff2180e2ef7ff1303661e806c4c304
-  data.tar.gz: 7d0f74053c870263e63ff9b84dc72f77c3f923eb
+  metadata.gz: 3f8a94f2f8efae78fd25e95e947a1290759dc552
+  data.tar.gz: b2c3f7bdbb8f1047620b1d2a12fda977c76c5242
 SHA512:
-  metadata.gz: 752c341d5200f4bdb1c9a59a3f0188a31522558d20ea6e0d2c7f01eec36e4581aea4e6b6ffbc73c6fbc3dbce81db17e0af80a1c29ddf54bc7b0d453567f36351
-  data.tar.gz: 2ebc1641f150f1e34316a4a60f6fbb16d8fd6cf13a3a5a624f9b0d92707817662df32cdf8ff20512c4efb4ce9924f6c16fde9cef9f674174c6ab3f6483109771
+  metadata.gz: c33bd4225faab6259e72e4cd74cbb24bca5a7c8592fe61c2ea290bfd03922f2a3b80cead1c3db1f89fc033fee04868130459f841e2a2669a174ecc28f76a532a
+  data.tar.gz: ad7b5de36a1dafdfde876647713fc582218a3f9e7eca49385375751572785e0200209ca502425769d3cb88adcff134e1c56a8876a77c44432dc13bceedadf4f9

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+0.1.1 - Fri Jan 12, 2018
+------------------------
+
+Bugfix for nested class inheritance.
+
+- Fix CI by requiring manually 'tempfile' in specs that use it
+- Add a CSV format validator at `CsvFormatValidator`
+- Fix `Parser` subclass registration and reorder parser class `#match`
+  priority.
+
+0.1.0 - Thu Jan 11, 2018
+------------------------
+
+Inital release.

data/lib/darlingtonia/parser.rb

@@ -9,8 +9,10 @@ module Darlingtonia
   #
   #   Parser.for(file: file).records
   #
+  # rubocop:disable Style/ClassVars
   class Parser
-    @subclasses = [] # @private
+    DEFAULT_VALIDATORS = [].freeze
+    @@subclasses = [] # @private
 
     ##
     # @!attribute [rw] file
@@ -42,7 +44,7 @@ module Darlingtonia
       # @raise [NoParserError]
       def for(file:)
         klass =
-          @subclasses.find { |k| k.match?(file: file) } ||
+          @@subclasses.find { |k| k.match?(file: file) } ||
           raise(NoParserError)
 
         klass.new(file: file)
@@ -58,7 +60,7 @@ module Darlingtonia
       ##
       # @private Register a new class when inherited
       def inherited(subclass)
-        @subclasses << subclass
+        @@subclasses.unshift subclass
         super
       end
     end
@@ -99,5 +101,5 @@ module Darlingtonia
 
     class NoParserError < TypeError; end
     class ValidationError < RuntimeError; end
-  end
+  end # rubocop:enable Style/ClassVars
 end

data/lib/darlingtonia/validator.rb

@@ -3,6 +3,19 @@
 module Darlingtonia
   ##
   # @abstract A null validator; always returns an empty error collection
+  #
+  # @example validating a parser
+  #   validator = MyValidator.new
+  #   validator.validate(parser: myParser)
+  #
+  # @example validating an invalid parser
+  #   validator = MyValidator.new
+  #   validator.validate(parser: invalidParser)
+  #   # => Error<#... validator: MyValidator,
+  #                   name: 'An Error Name',
+  #                   description: '...'
+  #                   lineno: 37>
+  #
   class Validator
     Error = Struct.new(:validator, :name, :description, :lineno)
 

data/lib/darlingtonia/validators/csv_format_validator.rb

@@ -2,7 +2,23 @@
 
 module Darlingtonia
   ##
-  # A validator for correctly formatted CSV
+  # A validator for correctly formatted CSV.
+  #
+  # @example
+  #   parser = Parser.new(file: File.open('path/to/my.csv'))
+  #
+  #   CsvFormatValidator.new.validate(parser: parser)
+  #
+  # @see http://ruby-doc.org/stdlib-2.0.0/libdoc/csv/rdoc/CSV/MalformedCSVError.html
   class CsvFormatValidator < Validator
+    ##
+    # @see Validator#validate
+    def validate(parser:, **)
+      return [] if CSV.parse(parser.file.read)
+    rescue CSV::MalformedCSVError => e
+      [Error.new(self.class, e.class, e.message)]
+    ensure
+      parser.file.rewind
+    end
   end
 end

data/lib/darlingtonia/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Darlingtonia
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

data/spec/darlingtonia/csv_format_validator_spec.rb

@@ -3,5 +3,36 @@
 require 'spec_helper'
 
 describe Darlingtonia::CsvFormatValidator do
-  it_behaves_like 'a Darlingtonia::Validator'
+  subject(:validator)  { described_class.new }
+  let(:invalid_parser) { Darlingtonia::CsvParser.new(file: invalid_file) }
+  let(:invalid_file)   { File.open('spec/fixtures/bad_example.csv') }
+
+  it_behaves_like 'a Darlingtonia::Validator' do
+    let(:valid_parser)   { Darlingtonia::CsvParser.new(file: valid_file) }
+    let(:valid_file)     { File.open('spec/fixtures/example.csv') }
+  end
+
+  define :a_validator_error do
+    match do |error|
+      return false unless error.respond_to?(:validator)
+
+      if fields
+        return false if fields[:validator] && error.validator != fields[:validator]
+        return false if fields[:name]      && error.name      != fields[:name]
+      end
+
+      true
+    end
+
+    chain :with, :fields
+  end
+
+  describe '#validate' do
+    it 'returns a Validator::Error' do
+      expect(validator.validate(parser: invalid_parser))
+        .to contain_exactly a_validator_error
+        .with(validator: validator.class,
+              name:      CSV::MalformedCSVError)
+    end
+  end
 end

data/spec/darlingtonia/csv_parser_spec.rb

@@ -2,6 +2,7 @@
 # frozen_string_literal: true
 
 require 'spec_helper'
+require 'tempfile'
 
 describe Darlingtonia::CsvParser do
   subject(:parser) { described_class.new(file: file) }

data/spec/darlingtonia/parser_spec.rb

@@ -24,12 +24,17 @@ describe Darlingtonia::Parser do
             end
           end
         end
+
+        class NestedParser < FakeParser; end
       end
 
-      after(:context) { Object.send(:remove_const, :FakeParser) }
+      after(:context) do
+        Object.send(:remove_const, :FakeParser)
+        Object.send(:remove_const, :NestedParser)
+      end
 
       it 'returns an importer instance' do
-        expect(described_class.for(file: file)).to be_a FakeParser
+        expect(described_class.for(file: file)).to be_a NestedParser
       end
     end
   end

data/spec/fixtures/bad_example.csv

@@ -0,0 +1,2 @@
+title,description
+fake title, "fake description--quote wrap after delimiter then space is invalid"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: darlingtonia
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Tom Johnson
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-11 00:00:00.000000000 Z
+date: 2018-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active-fedora
@@ -138,6 +138,7 @@ files:
 - ".gitignore"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - README.md
 - Rakefile
@@ -161,6 +162,7 @@ files:
 - spec/darlingtonia/parser_spec.rb
 - spec/darlingtonia/validator_spec.rb
 - spec/darlingtonia/version_spec.rb
+- spec/fixtures/bad_example.csv
 - spec/fixtures/example.csv
 - spec/integration/import_csv_spec.rb
 - spec/spec_helper.rb