exwiw 0.9.7 → 0.9.9

data/lib/exwiw/strict_keys.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module Exwiw
+  # Raised when a schema config JSON carries a key that no declared attribute
+  # accepts. A subclass of ArgumentError so existing "invalid config" handling
+  # (and specs) that rescue ArgumentError keep working.
+  UnknownConfigKeyError = Class.new(ArgumentError)
+
+  # Strict key validation for the schema config JSON.
+  #
+  # Serdes deserialization is lenient: a key that matches no declared attribute
+  # is silently dropped. For hand-maintained schema configs that turns a typo
+  # (`reverse_scop`) — or a key another adapter supports but this one does not
+  # (`raw_sql` on a MongoDB field) — into a silent no-op: the config loads, the
+  # dump runs, and the requested masking/scoping simply never happens.
+  # {TableConfig.from} / {MongodbCollectionConfig.from} therefore validate the
+  # raw hash against the declared attributes before deserializing, recursing
+  # into nested config objects (belongs_tos, columns/fields, reverse_scope,
+  # embedded_in, replace_with_fake_data).
+  #
+  # Free-form annotations do not need an escape hatch: `comment` is a declared
+  # (documentation-only) attribute on the table/collection configs and their
+  # belongs_to/column/field entries, so it always passes.
+  module StrictKeys
+    module_function
+
+    # Validate `hash` (a raw config hash, string- or symbol-keyed) against the
+    # attributes declared on the Serdes class `klass`, recursing into nested
+    # Serdes-typed attributes. `owner` names the config for the error message
+    # (e.g. "table 'users'"); `path` locates a nested entry within it (e.g.
+    # "belongs_tos[0]"). No-op for non-Hash input — Serdes' own type errors
+    # cover malformed values.
+    def validate!(klass, hash, owner:, path: nil)
+      return unless hash.is_a?(Hash)
+
+      attributes = klass.__send__(:_serde_attrs)
+      rename_strategy = klass.__send__(:_serde_rename_strategy)
+      allowed = attributes.each_value.to_h { |attr| [attr.serialized_name(rename_strategy), attr] }
+
+      unknown = hash.keys.map(&:to_s) - allowed.keys
+      unless unknown.empty?
+        location = path ? " (in #{path})" : ""
+        raise UnknownConfigKeyError,
+              "Unknown key#{'s' if unknown.size > 1} #{unknown.map { |key| "'#{key}'" }.join(', ')} " \
+              "in #{owner}#{location}. Allowed keys: #{allowed.keys.sort.join(', ')}. " \
+              "Unknown keys are rejected because they would otherwise be silently ignored " \
+              "(hiding typos and keys this adapter does not support); remove or rename the key, " \
+              "or use `comment` for free-form notes."
+      end
+
+      allowed.each do |key, attr|
+        nested_klass = serdes_class(attr.attr_type)
+        next if nested_klass.nil?
+
+        value = hash.key?(key) ? hash[key] : hash[key.to_sym]
+        nested_path = path ? "#{path}.#{key}" : key
+        case value
+        when Hash
+          validate!(nested_klass, value, owner: owner, path: nested_path)
+        when Array
+          value.each_with_index do |element, index|
+            validate!(nested_klass, element, owner: owner, path: "#{nested_path}[#{index}]") if element.is_a?(Hash)
+          end
+        end
+      end
+    end
+
+    # The Serdes-including class a (possibly optional/array-wrapped) attribute
+    # type deserializes into, or nil for scalar types.
+    def serdes_class(type)
+      case type
+      when Serdes::OptionalType then serdes_class(type.base_type)
+      when Serdes::ArrayType then serdes_class(type.element_type)
+      when Serdes::ConcreteType then serdes_class(type.exact_type)
+      when Class then type if type.include?(Serdes)
+      end
+    end
+  end
+end

data/lib/exwiw/table_config.rb

@@ -48,6 +48,15 @@ module Exwiw
     attribute :reverse_scope, Serdes::OptionalType.new(ReverseScope), skip_serializing_if_nil: true
 
     def self.from(hash)
+      # Reject unknown keys before deserializing: Serdes silently drops them,
+      # which would turn a typo'd or unsupported key into a silent no-op (see
+      # Exwiw::StrictKeys). `comment` is a declared attribute here and on the
+      # nested belongs_to/column entries, so free-form notes stay accepted.
+      if hash.is_a?(Hash)
+        table_name = hash["name"] || hash[:name]
+        StrictKeys.validate!(self, hash, owner: "table '#{table_name}'")
+      end
+
       config = super
       config.send(:validate_after_load!)
       config
@@ -244,10 +253,11 @@ module Exwiw
       fake_data = column.replace_with_fake_data
       return unless fake_data
 
-      unless RowTransformer::FAKE_TYPES.key?(fake_data.type)
+      supported_types = RowTransformer::PERSON_TYPES.keys + RowTransformer::FAKE_TYPES.keys
+      unless supported_types.include?(fake_data.type)
         raise ArgumentError,
               "Table '#{name}' column '#{column.name}': unknown replace_with_fake_data type '#{fake_data.type}' " \
-              "(supported: #{RowTransformer::FAKE_TYPES.keys.join(', ')})."
+              "(supported: #{supported_types.join(', ')})."
       end
 
       seed_column = fake_data.seed.delete_prefix("#{name}.")

data/lib/exwiw/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Exwiw
-  VERSION = "0.9.7"
+  VERSION = "0.9.9"
 end

data/lib/exwiw.rb

@@ -7,6 +7,7 @@ require "serdes"
 
 require_relative "exwiw/ext_json"
 require_relative "exwiw/config_file"
+require_relative "exwiw/strict_keys"
 require_relative "exwiw/belongs_to"
 require_relative "exwiw/fake_data"
 require_relative "exwiw/table_column"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: exwiw
 version: !ruby/object:Gem::Version
-  version: 0.9.7
+  version: 0.9.9
 platform: ruby
 authors:
 - Shia
@@ -71,6 +71,7 @@ files:
 - lib/exwiw/explain_runner.rb
 - lib/exwiw/ext_json.rb
 - lib/exwiw/fake_data.rb
+- lib/exwiw/japanese_names.rb
 - lib/exwiw/mongo_query.rb
 - lib/exwiw/mongodb_collection_config.rb
 - lib/exwiw/mongodb_field.rb
@@ -84,6 +85,7 @@ files:
 - lib/exwiw/row_transformer.rb
 - lib/exwiw/runner.rb
 - lib/exwiw/schema_generator.rb
+- lib/exwiw/strict_keys.rb
 - lib/exwiw/table_column.rb
 - lib/exwiw/table_config.rb
 - lib/exwiw/version.rb