Merge pull request #654 from notch8/add-controlled-vocab-validator

🎁 Add controlled vocab validator

Author: kirkkwang

app/models/hyrax/change_set_decorator.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+# OVERRIDE Hyrax v5.2.0 to add validation of controlled vocabularies
+#   can be removed when it is in core Hyrax https://github.com/samvera/hyrax/pull/7423
+
+module Hyrax
+  module ChangeSetDecorator
+    extend ActiveSupport::Concern
+
+    prepended do
+      validates_with Hyrax::ControlledVocabularyValidator
+    end
+  end
+end
+
+Hyrax::ChangeSet.prepend(Hyrax::ChangeSetDecorator)

app/validators/hyrax/controlled_vocabulary_validator.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+module Hyrax
+  ##
+  # Validates that controlled vocabulary properties contain only active
+  # terms from their corresponding local QA authority.
+  #
+  # Properties are matched to authorities dynamically via
+  # +Qa::Authorities::Local.subauthorities+, using the singularized
+  # authority name to match property names on the change set.
+  #
+  # Only covers local authorities (file-based and table-based).
+  # Remote authorities (e.g. Geonames) are out of scope.
+  class ControlledVocabularyValidator < ActiveModel::Validator
+    def validate(record)
+      return unless Flipflop.validate_local_controlled_vocabulary?
+
+      active_terms_by_property(record).each do |property, terms|
+        values = Array.wrap(record.public_send(property)).reject(&:blank?)
+        next if values.empty?
+
+        invalid = values.reject { |v| terms.include?(v) }
+        invalid.each do |v|
+          record.errors.add(property, "#{property.to_s.humanize} contains unrecognized value: #{v}")
+        end
+      end
+    end
+
+    private
+
+    ##
+    # @example
+    #   # { "license" => ["http://creativecommons.org/licenses/by/4.0/", ...],
+    #   #   "resource_type" => ["Article", "Book", ...] }
+    #
+    # @return [Hash{String => Array<String>}]
+    def active_terms_by_property(record)
+      authorities = Qa::Authorities::Local.subauthorities
+
+      # { "license" => "licenses", "resource_type" => "resource_types", ... }
+      property_to_authority = {}.tap do |hash|
+        authorities.each { |name| hash[name.singularize] = name }
+      end
+
+      properties = record.fields.keys.map(&:to_s)
+
+      {}.tap do |result|
+        (properties & property_to_authority.keys).each do |property|
+          authority = Qa::Authorities::Local.subauthority_for(property_to_authority[property])
+          terms = authority.all
+          next if terms.empty?
+
+          result[property] = terms.filter_map { |term| term[:id] if active?(term) }
+        end
+      end
+    end
+
+    ##
+    # Terms without an +active+ field (e.g. resource_types) are
+    # treated as active, matching QA's +FileBasedAuthority#all+ behavior.
+    def active?(term)
+      term.fetch(:active, true) != false
+    end
+  end
+end

config/features.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+Flipflop.configure do
+  feature :validate_local_controlled_vocabulary,
+          default: false,
+          description: "Validate local controlled vocabulary."
+end

lib/hyku_knapsack/engine.rb

@@ -10,6 +10,10 @@ class Engine < ::Rails::Engine
       end
     end
 
+    initializer 'hyku_knapsack.flipflop' do
+      Flipflop::FeatureLoader.current.append(self)
+    end
+
     def self.load_translations!
       HykuKnapsack::Engine.root.glob("config/locales/**/*.yml").each do |path|
         I18n.load_path << path.to_s