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

data/lib/zizia/hyrax/metadata_only_stack.rb

@@ -1,70 +0,0 @@
-# frozen_string_literal: true
-
-module Zizia
-  class MetadataOnlyStack
-    def self.build_stack
-      ActionDispatch::MiddlewareStack.new.tap do |middleware|
-        # Wrap everything in a database transaction, if the save of the resource
-        # fails then roll back any database AdminSetChangeSet
-        middleware.use Hyrax::Actors::TransactionalRequest
-
-        # Ensure you are mutating the most recent version
-        # middleware.use Hyrax::Actors::OptimisticLockValidator
-
-        # Attach files from a URI (for BrowseEverything)
-        # middleware.use Hyrax::Actors::CreateWithRemoteFilesActor
-
-        # Attach files uploaded in the form to the UploadsController
-        # In Californica, for command line import,
-        # we are using the CreateWithFilesActor to attach
-        # local files with a file:// url, not via the UploadsController,
-        # so we never use the CreateWithFilesActor
-        # middleware.use Hyrax::Actors::CreateWithFilesActor
-
-        # Add/remove the resource to/from a collection
-        middleware.use Hyrax::Actors::CollectionsMembershipActor
-
-        # Add/remove to parent work
-        # middleware.use Hyrax::Actors::AddToWorkActor
-
-        # Add/remove children (works or file_sets)
-        # middleware.use Hyrax::Actors::AttachMembersActor
-
-        # Set the order of the children (works or file_sets)
-        # middleware.use Hyrax::Actors::ApplyOrderActor
-
-        # Sets the default admin set if they didn't supply one
-        # middleware.use Hyrax::Actors::DefaultAdminSetActor
-
-        # Decode the private/public/institution on the form into permisisons on
-        # the model
-        # We aren't using this in Californica, we're just setting the visibility
-        # at import time
-        # middleware.use Hyrax::Actors::InterpretVisibilityActor
-
-        # Handles transfering ownership of works from one user to another
-        # We aren't using this in Californica
-        # middleware.use Hyrax::Actors::TransferRequestActor
-
-        # Copies default permissions from the PermissionTemplate to the work
-        # middleware.use Hyrax::Actors::ApplyPermissionTemplateActor
-
-        # Remove attached FileSets when destroying a work
-        # middleware.use Hyrax::Actors::CleanupFileSetsActor
-
-        # Destroys the trophies in the database when the work is destroyed
-        # middleware.use Hyrax::Actors::CleanupTrophiesActor
-
-        # Destroys the feature tag in the database when the work is destroyed
-        # middleware.use Hyrax::Actors::FeaturedWorkActor
-
-        # Persist the metadata changes on the resource
-        middleware.use Hyrax::Actors::ModelActor
-
-        # Start the workflow for this work
-        # middleware.use Hyrax::Actors::InitializeWorkflowActor
-      end
-    end
-    # rubocop:enable Metrics/MethodLength
-  end
-end

data/lib/zizia/importer.rb

@@ -1,58 +0,0 @@
-# frozen_string_literal: true
-
-module Zizia
-  ##
-  # The chief entry point for bulk import of records. `Importer` accepts a
-  # {Parser} on initialization and iterates through its {Parser#records}, importing
-  # each using a given {RecordImporter}.
-  #
-  # @example Importing in bulk from a CSV file
-  #   parser = Zizia::Parser.for(file: File.new('path/to/import.csv'))
-  #
-  #   Zizia::Importer.new(parser: parser).import if parser.validate
-  #
-  class Importer
-    extend Forwardable
-
-    ##
-    # @!attribute [rw] parser
-    #   @return [Parser]
-    # @!attribute [rw] record_importer
-    #   @return [RecordImporter]
-    attr_accessor :parser, :record_importer
-
-    ##
-    # @!method records()
-    #   @see Parser#records
-    def_delegator :parser, :records, :records
-
-    ##
-    # @param parser          [Parser] The parser to use as the source for import
-    #   records.
-    # @param record_importer [RecordImporter] An object to handle import of
-    #   each record
-    def initialize(parser:, record_importer: RecordImporter.new)
-      self.parser          = parser
-      self.record_importer = record_importer
-    end
-
-    # Do not attempt to run an import if there are no records. Instead, just write to the log.
-    def no_records_message
-      Rails.logger.error "[zizia] event: empty_import, batch_id: #{record_importer.batch_id}"
-    end
-
-    ##
-    # Import each record in {#records}.
-    #
-    # @return [void]
-    def import
-      no_records_message && return unless records.count.positive?
-      start_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)
-      Rails.logger.info "[zizia] event: start_import, batch_id: #{record_importer.batch_id}, expecting to import #{records.count} records."
-      records.each { |record| record_importer.import(record: record) }
-      end_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)
-      elapsed_time = end_time - start_time
-      Rails.logger.info "[zizia] event: finish_import, batch_id: #{record_importer.batch_id}, successful_record_count: #{record_importer.success_count}, failed_record_count: #{record_importer.failure_count}, elapsed_time: #{elapsed_time}, elapsed_time_per_record: #{elapsed_time / records.count}"
-    end
-  end
-end

data/lib/zizia/input_record.rb

@@ -1,65 +0,0 @@
-# frozen_string_literal: true
-
-module Zizia
-  ##
-  # @example Building an importer with the factory
-  #   record = InputRecord.from({some: :metadata}, mapper: MyMapper.new)
-  #   record.some # => :metadata
-  #
-  class InputRecord
-    ##
-    # @!attribute [rw] mapper
-    #   @return [#map_fields]
-    attr_accessor :mapper
-
-    ##
-    # @param mapper [#map_fields]
-    def initialize(mapper: Zizia.config.metadata_mapper_class.new)
-      self.mapper = mapper
-    end
-
-    class << self
-      ##
-      # @param metadata [Object]
-      # @param mapper  [#map_fields]
-      #
-      # @return [InputRecord] an input record mapping metadata with the given
-      #   mapper
-      def from(metadata:, mapper: Zizia.config.metadata_mapper_class.new)
-        mapper.metadata = metadata
-        new(mapper: mapper)
-      end
-    end
-
-    ##
-    # @return [Hash<Symbol, Object>]
-    def attributes
-      mapper.fields.each_with_object({}) do |field, attrs|
-        attrs[field] = public_send(field)
-      end
-    end
-
-    ##
-    # @return [String, nil] an identifier for the representative file; nil if
-    #   none is given.
-    def representative_file
-      return mapper.representative_file if
-        mapper.respond_to?(:representative_file)
-
-      nil
-    end
-
-    ##
-    # Respond to methods matching mapper fields
-    def method_missing(method_name, *args, &block)
-      return super unless mapper.field?(method_name)
-      mapper.public_send(method_name)
-    end
-
-    ##
-    # @see #method_missing
-    def respond_to_missing?(method_name, include_private = false)
-      mapper.field?(method_name) || super
-    end
-  end
-end

data/lib/zizia/metadata_mapper.rb

@@ -1,83 +0,0 @@
-# frozen_string_literal: true
-
-module Zizia
-  ##
-  # A null/base mapper that maps no fields.
-  #
-  # Real mapper implementations need to provide `#fields`, enumerating over
-  # `Symbols` that represent the fields on the target object (e.g. an
-  # `ActiveFedora::Base`/`Hyrax::WorkBehavior`) that the mapper can handle.
-  # For each field in `#fields`, the mapper must respond to a matching method
-  # (i.e. `:title` => `#title`), and return the value(s) that should be set to
-  # the target's attributes upon mapping.
-  #
-  # To ease the implementation of field methods, this base class provides
-  # a `#method_missing` that forwards missing method names to a `#map_field`
-  # method. `#map_field` can be implemented to provide a generalized field
-  # mapping when a common pattern will be used for many methods. Callers should
-  # avoid relying on this protected method directly, since mappers may implement
-  # individual field methods in any other way (e.g. `def title; end`) to route
-  # around `#map_field`. Implementations are also free to override
-  # `#method_missing` if desired.
-  #
-  # Mappers generally operate over some input `#metadata`. Example metadata
-  # types that mappers could be implemented over include `Hash`, `CSV`, `XML`,
-  # `RDF::Graph`, etc...; mappers are free to interpret or ignore the contents
-  # of their underlying metadata data structures at their leisure. Values for
-  # fields are /usually/ derived from the `#metadata`, but can also be generated
-  # from complex logic or even hard-coded.
-  #
-  # @example Using a MetadataMapper
-  #   mapper = MyMapper.new
-  #   mapper.metadata = some_metadata_object
-  #   mapper.fields # => [:title, :author, :description]
-  #
-  #   mapper.title # => 'Some Title'
-  #
-  #   mapper.fields.map { |field| mapper.send(field) }
-  #
-  # @see ImportRecord#attributes for the canonical usage of a `MetadataMapper`.
-  # @see HashMapper for an example implementation with dynamically generated
-  #   fields
-  class MetadataMapper
-    ##
-    # @!attribute [rw] metadata
-    #   @return [Object]
-    attr_accessor :metadata
-
-    ##
-    # @param name [Symbol]
-    #
-    # @return [Boolean]
-    def field?(name)
-      fields.include?(name)
-    end
-
-    ##
-    # @return [Enumerable<Symbol>] The fields the mapper can process
-    def fields
-      []
-    end
-
-    def method_missing(method_name, *args, &block)
-      return map_field(method_name) if fields.include?(method_name)
-      super
-    end
-
-    def respond_to_missing?(method_name, include_private = false)
-      field?(method_name) || super
-    end
-
-    protected
-
-      ##
-      # @private
-      #
-      # @param name [Symbol]
-      #
-      # @return [Object]
-      def map_field(_name)
-        raise NotImplementedError
-      end
-  end
-end

data/lib/zizia/parser.rb

@@ -1,132 +0,0 @@
-# frozen_string_literal: true
-
-module Zizia
-  ##
-  # A generic parser.
-  #
-  # `Parser` implementations provide a stream of `InputRecord`s, derived from an
-  # input object (`file`), through `Parser#records`. This method should be
-  # implemented efficiently for repeated access, generating records lazily if
-  # possible, and caching if appropriate.
-  #
-  # Input validation is handled by an array of `#validators`, which are run in
-  # sequence when `#validate` (or `#validate!`) is called. Errors caught in
-  # validation are accessible via `#errors`, and inputs generating errors result
-  # in `#valid? # => false`.
-  #
-  # A factory method `.for` is provided, and each implementation should
-  # provides a `.match?(**)` which returns `true` if the options passed
-  # indicate the parser can handle the given input. Parsers are checked for
-  # `#match?` in the reverse of load order (i.e. the most recently loaded
-  # `Parser` classes are given precedence).
-  #
-  # @example Getting a parser for a file input
-  #   file = File.open('path/to/import/manifest.csv')
-  #
-  #   Parser.for(file: file).records
-  #
-  # @example Validating a parser
-  #   parser = Parser.for(file: invalid_input)
-  #
-  #   parser.valid?   # => true (always true before validation)
-  #   parser.validate # => false
-  #   parser.valid?   # => false
-  #   parser.errors   # => an array of Validation::Error-like structs
-  #
-  #   parser.validate! # ValidationError
-  #
-  # rubocop:disable Style/ClassVars
-  class Parser
-    DEFAULT_VALIDATORS = [].freeze
-    @@subclasses = [] # @private
-
-    ##
-    # @!attribute [rw] file
-    #   @return [File]
-    # @!attribute [rw] validators
-    #   @return [Array<Validator>]
-    # @!attribute [r] errors
-    #   @return [Array]
-    attr_accessor :file, :validators
-    attr_reader   :errors
-
-    ##
-    # @param file [File]
-    def initialize(file:, **_opts)
-      self.file     = file
-      @errors       = []
-      @validators ||= self.class::DEFAULT_VALIDATORS
-
-      yield self if block_given?
-    end
-
-    class << self
-      ##
-      # @param file [Object]
-      #
-      # @return [Zizia::Parser] a parser instance appropriate for
-      #   the arguments
-      #
-      # @raise [NoParserError]
-      def for(file:)
-        klass =
-          @@subclasses.find { |k| k.match?(file: file) } ||
-          raise(NoParserError)
-
-        klass.new(file: file)
-      end
-
-      ##
-      # @abstract
-      # @return [Boolean]
-      def match?(**_opts); end
-
-      private
-
-      ##
-      # @private Register a new class when inherited
-      def inherited(subclass)
-        @@subclasses.unshift subclass
-        super
-      end
-    end
-
-    ##
-    # @abstract
-    #
-    # @yield [record] gives each record in the file to the block
-    # @yieldparam record [ImportRecord]
-    #
-    # @return [Enumerable<ImportRecord>]
-    def records
-      raise NotImplementedError
-    end
-
-    ##
-    # @return [Boolean] true if the file input is valid
-    def valid?
-      errors.empty?
-    end
-
-    ##
-    # @return [Boolean] true if the file input is valid
-    def validate
-      validators.each_with_object(errors) do |validator, errs|
-        errs.concat(validator.validate(parser: self))
-      end
-
-      valid?
-    end
-
-    ##
-    # @return [true] always true, unless an error is raised.
-    #
-    # @raise [ValidationError] if the file to parse is invalid
-    def validate!
-      validate || raise(ValidationError)
-    end
-
-    class NoParserError < TypeError; end
-    class ValidationError < RuntimeError; end
-  end # rubocop:enable Style/ClassVars
-end

data/lib/zizia/parsers/csv_parser.rb

@@ -1,45 +0,0 @@
-# frozen_string_literal: true
-
-require 'csv'
-
-module Zizia
-  ##
-  # A parser for CSV files. A single `InputRecord` is returned for each row
-  # parsed from the input.
-  #
-  # Validates the format of the CSV, generating a single error the file is
-  # malformed. This error gives the line number and a message for the first
-  # badly formatted row.
-  #
-  # @see CsvFormatValidator
-  class CsvParser < Parser
-    DEFAULT_VALIDATORS = [CsvFormatValidator.new].freeze
-    EXTENSION = '.csv'
-
-    class << self
-      ##
-      # Matches all '.csv' filenames.
-      def match?(file:, **_opts)
-        File.extname(file) == EXTENSION
-      rescue TypeError
-        false
-      end
-    end
-
-    ##
-    # Gives a record for each line in the .csv
-    #
-    # @see Parser#records
-    def records
-      return enum_for(:records) unless block_given?
-
-      file.rewind
-
-      CSV.parse(file.read, headers: true).each do |row|
-        yield InputRecord.from(metadata: row)
-      end
-    rescue CSV::MalformedCSVError => e
-      Rails.logger.error "[zizia] The file #{file} could not be parsed as CSV: #{e}"
-    end
-  end
-end

data/lib/zizia/record_importer.rb

@@ -1,44 +0,0 @@
-# frozen_string_literal: true
-
-module Zizia
-  class RecordImporter
-    ##
-    # @!attribute [rw] batch_id
-    #   @return [String] an optional batch id for this import run
-    # @!attribute [rw] success_count
-    #   @return [Integer] a count of the records that were successfully created
-    # @!attribute [rw] failure_count
-    #   @return [Integer] a count of the records that failed import
-    attr_accessor :batch_id, :success_count, :failure_count
-
-    ##
-    # @param record [ImportRecord]
-    #
-    # @return [void]
-    def import(record:)
-      create_for(record: record)
-    rescue Faraday::ConnectionFailed, Ldp::HttpError => e
-      Rails.logger.error "[zizia] #{e}"
-    rescue RuntimeError => e
-      Rails.logger.error "[zizia] #{e}"
-      raise e
-    end
-
-    def import_type
-      raise 'No curation_concern found for import' unless
-        defined?(Hyrax) && Hyrax&.config&.curation_concerns&.any?
-
-      Hyrax.config.curation_concerns.first
-    end
-
-    private
-
-      def create_for(record:)
-        Rails.logger.info "[zizia] Creating record: #{record.respond_to?(:title) ? record.title : record}."
-
-        created = import_type.create(record.attributes)
-
-        Rails.logger.info "[zizia] Record created at: #{created.id}"
-      end
-  end
-end

data/lib/zizia/spec/fakes/fake_parser.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-class FakeParser < Zizia::Parser
-  METADATA = [{ 'title' => '1' }, { 'title' => '2' }, { 'title' => '3' }].freeze
-
-  def initialize(file: METADATA)
-    super
-  end
-
-  def records
-    return enum_for(:records) unless block_given?
-
-    file.each { |hsh| yield Zizia::InputRecord.from(metadata: hsh) }
-  end
-end
-
-describe FakeParser do
-  it_behaves_like 'a Zizia::Parser' do
-    subject(:parser)   { described_class.new }
-    let(:record_count) { 3 }
-  end
-end

data/lib/zizia/spec/shared_examples/a_mapper.rb

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-
-shared_examples 'a Zizia::Mapper' do
-  subject(:mapper) { described_class.new }
-
-  before { mapper.metadata = metadata }
-
-  describe '#metadata' do
-    it 'can be set' do
-      expect { mapper.metadata = nil }
-        .to change { mapper.metadata }
-    end
-  end
-
-  describe '#field?' do
-    it 'does not have bogus fields' do
-      expect(mapper.field?(:NOT_A_REAL_FIELD)).to be_falsey
-    end
-
-    it 'has fields that are expected' do
-      if defined?(expected_fields)
-        expected_fields.each do |field|
-          expect(mapper.field?(field)).to be_truthy
-        end
-      end
-    end
-  end
-
-  describe '#fields' do
-    it { expect(mapper.fields).to contain_exactly(*expected_fields) }
-  end
-end

data/lib/zizia/spec/shared_examples/a_parser.rb

@@ -1,73 +0,0 @@
-# frozen_string_literal: true
-
-require 'zizia/always_invalid_validator'
-
-shared_examples 'a Zizia::Parser' do
-  describe '#file' do
-    it 'is an accessor' do
-      expect { parser.file = :a_new_file }
-        .to change { parser.file }
-        .to(:a_new_file)
-    end
-  end
-
-  describe '#records' do
-    it 'yields records' do
-      unless described_class == Zizia::Parser
-        expect { |b| parser.records(&b) }
-          .to yield_control.exactly(record_count).times
-      end
-    end
-  end
-
-  describe '#valid?' do
-    it 'is valid' do
-      expect(parser).to be_valid
-    end
-
-    context 'when not valid' do
-      before do
-        parser.validators = [Zizia::AlwaysInvalidValidator.new]
-      end
-
-      it 'is invalid' do
-        expect { parser.validate }
-          .to change { parser.valid? }
-          .to be_falsey
-      end
-    end
-  end
-
-  describe '#validate' do
-    it 'is true when valid' do
-      expect(parser.validate).to be_truthy
-    end
-
-    context 'when not valid' do
-      before do
-        parser.validators = [Zizia::AlwaysInvalidValidator.new]
-      end
-
-      it 'is invalid' do
-        expect(parser.validate).to be_falsey
-      end
-    end
-  end
-
-  describe '#validate!' do
-    it 'is true when valid' do
-      expect(parser.validate).to be_truthy
-    end
-
-    context 'when not valid' do
-      before do
-        parser.validators = [Zizia::AlwaysInvalidValidator.new]
-      end
-
-      it 'raises a ValidationError' do
-        expect { parser.validate! }
-          .to raise_error Zizia::Parser::ValidationError
-      end
-    end
-  end
-end

data/lib/zizia/spec/shared_examples/a_validator.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-shared_examples 'a Zizia::Validator' do
-  subject(:validator) { described_class.new }
-
-  define :be_a_validator_error do # |expected|
-    match { false } # { |actual| some_condition }
-  end
-
-  describe '#validate' do
-    context 'without a parser' do
-      it 'raises ArgumentError' do
-        expect { validator.validate }.to raise_error ArgumentError
-      end
-    end
-
-    it 'gives an empty error collection for a valid parser' do
-      expect(validator.validate(parser: valid_parser)).not_to be_any if
-        defined?(valid_parser)
-    end
-
-    context 'for an invalid parser' do
-      it 'gives an non-empty error collection' do
-        expect(validator.validate(parser: invalid_parser)).to be_any if
-          defined?(invalid_parser)
-      end
-    end
-  end
-end

data/lib/zizia/spec.rb

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-module Zizia
-  ##
-  # RSpec test support for {Zizia} importers.
-  #
-  # @see https://relishapp.com/rspec/rspec-core/docs/
-  module Spec
-    require 'zizia/spec/shared_examples/a_mapper'
-    require 'zizia/spec/shared_examples/a_parser'
-    require 'zizia/spec/shared_examples/a_validator'
-    require 'zizia/spec/fakes/fake_parser'
-  end
-end