zizia 4.0.2.alpha.01 → 4.0.3.alpha.01

data/lib/zizia/validator.rb

@@ -1,106 +0,0 @@
-# frozen_string_literal: true
-
-module Zizia
-  ##
-  # @abstract A null validator; always returns an empty error collection
-  #
-  # Validators are used to ensure the correctness of input to a parser. Each
-  # validator must respond to `#validate` and return a collection of errors
-  # found during validation. If the input is valid, this collection must be
-  # empty. Otherwise, it contains any number of `Validator::Error` structs
-  # which should be logged to Rails.logger by the validator.
-  #
-  # The validation process accepts an entire `Parser` and is free to inspect
-  # the input `#file` content, or view its individual `#records`.
-  #
-  # The base class provides infrastructure for the key behavior, relying on a
-  # private `#run_validation` method to provide the core behavior. In most cases
-  # implementers will want to simply override this method.
-  #
-  # @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>
-  #
-  # @example Implementing a custom Validator and using it in a Parser
-  #   # Validator checks that the title, when downcased is equal to `moomin`
-  #   class TitleIsMoominValidator
-  #     def run_validation(parser:)
-  #       parser.records.each_with_object([]) do |record, errors|
-  #         errors << Error.new(self, :title_is_not_moomin) unless
-  #           title_is_moomin?(record)
-  #       end
-  #     end
-  #
-  #     def title_is_moomin?(record)
-  #       return false unless record.respond_to?(:title)
-  #       return true if record.title.downcase == 'moomin
-  #       true
-  #     end
-  #   end
-  #
-  #   parser = MyParser.new(some_content)
-  #   parser.validations << TitleIsMoominvalidator.new
-  #   parser.validate
-  #   parser.valid? # => false (unless all the records match the title)
-  #
-  # @see Parser#validate
-  class Validator
-    ##
-    # A representation of an error encountered in validation.
-    Error = Struct.new(:validator, :name, :description, :lineno) do
-      ##
-      # @!attribute [rw] validator
-      #   @return [#to_s] the validator that generated this error
-      # @!attribute [rw] name
-      #   @return [#to_s] a short descriptive name for the given error
-      # @!attribute [rw] description
-      #   @return [#to_s] a long form description or message
-      # @!attribute [rw] lineno
-      #   @return [#to_s] the line number, or other indication of the location
-      #     where the error was encountered
-
-      ##
-      # @return [Boolean]
-      def validator_error?
-        true
-      end
-
-      ##
-      # @return [String]
-      def to_s
-        "#{name}: #{description} (#{validator})"
-      end
-    end
-
-    ##
-    # @param parser [Parser]
-    #
-    # @return [Enumerator<Error>] a collection of errors found in validation
-    def validate(parser:)
-      run_validation(parser: parser).tap do |errors|
-        errors.map { |error| Rails.logger.error "[zizia] #{error}" }
-      end
-    end
-
-    private
-
-      # rubocop:disable Lint/UnusedMethodArgument
-
-      ##
-      # @return [Enumerator<Error>]
-      #
-      def run_validation(parser:)
-        [].to_enum
-      end
-
-    # rubocop:enable Lint/UnusedMethodArgument
-  end
-end

data/lib/zizia/validators/csv_format_validator.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-module Zizia
-  ##
-  # 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
-    ##
-    # @private
-    #
-    # @see Validator#validate
-    def run_validation(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/zizia/validators/title_validator.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-module Zizia
-  class TitleValidator < Validator
-    ##
-    # @private
-    #
-    # @see Validator#validate
-    def run_validation(parser:, **)
-      parser.records.each_with_object([]) do |record, errors|
-        titles = record.respond_to?(:title) ? record.title : []
-
-        errors << error_for(record: record) if Array(titles).empty?
-      end
-    end
-
-    protected
-
-      ##
-      # @private
-      # @param record [InputRecord]
-      #
-      # @return [Error]
-      def error_for(record:)
-        Error.new(self,
-                  :missing_title,
-                  "Title is required; got #{record.mapper.metadata}")
-      end
-  end
-end

data/lib/zizia/version.rb

@@ -1,5 +0,0 @@
-# frozen_string_literal: true
-
-module Zizia
-  VERSION = '4.0.2.alpha.01'
-end

data/lib/zizia.rb

@@ -1,66 +0,0 @@
-# frozen_string_literal: true
-
-require "zizia/engine"
-
-##
-# Bulk object import for Samvera.
-#
-# == Importers
-#
-# {Importer} is the core class for importing records using {Zizia}.
-# Importers accept a {Parser} and (optionally) a custom {RecordImporter}, and
-# process each record in the given parser (see: {Parser#records}).
-#
-# @example Importing in bulk from a file
-#   parser = Zizia::Parser.for(file: File.new('path/to/file.ext'))
-#
-#   Zizia::Importer.new(parser: parser).import if parser.validate
-#
-# @example A basic configuration
-#   Zizia.config do |config|
-#   end
-#
-module Zizia
-  ##
-  # @yield the current configuration
-  # @yieldparam config [Zizia::Configuration]
-  #
-  # @return [Zizia::Configuration] the current configuration
-  def config
-    yield @configuration if block_given?
-    @configuration
-  end
-  module_function :config
-
-  require 'zizia/version'
-  require 'zizia/metadata_mapper'
-  require 'zizia/hash_mapper'
-  require 'zizia/hyrax/hyrax_basic_metadata_mapper'
-  require 'zizia/importer'
-  require 'zizia/record_importer'
-  require 'zizia/hyrax/hyrax_record_importer'
-  require 'zizia/input_record'
-  require 'zizia/validator'
-  require 'zizia/validators/csv_format_validator'
-  require 'zizia/validators/title_validator'
-  require 'zizia/parser'
-  require 'zizia/csv_template'
-
-  ##
-  # Module-wide options for `Zizia`.
-  class Configuration
-    attr_accessor :metadata_mapper_class
-
-    def initialize
-      self.metadata_mapper_class = Zizia::HyraxBasicMetadataMapper
-    end
-  end
-
-  @configuration = Configuration.new
-
-  require 'zizia/parsers/csv_parser'
-  require 'zizia/hyrax/metadata_only_stack'
-  require 'zizia/hyrax/hyrax_metadata_only_updater'
-  require 'zizia/hyrax/hyrax_default_updater'
-  require 'zizia/hyrax/hyrax_delete_files_updater'
-end