Sha256: d599eb666943a80bd5cd32fc95be5f12483c75c0c6a6c665cad4e55ace728751

Contents?: true

Size: 1.17 KB

Versions: 31

Compression:

Stored size: 1.17 KB

Contents

# encoding: utf-8
module Mongoid
  module Relations

    # This module contains the validating logic for options passed to relation
    # macros.
    module Options
      extend self

      # These options are available to all relations.
      COMMON = [
        :class_name,
        :counter_cache,
        :extend,
        :inverse_class_name,
        :inverse_of,
        :name,
        :relation,
        :validate
      ]

      # Determine if the provided options are valid for the relation.
      #
      # @example Check the options.
      #   Options.validate!(:name => :comments)
      #
      # @param [ Hash ] options The options to check.
      #
      # @raise [ ArgumentError ] If the options are invalid.
      #
      # @return [ true, false ] If the options are valid.
      #
      # @since 2.1.0
      def validate!(options)
        valid_options = options[:relation].valid_options.concat(COMMON)
        options.keys.each do |key|
          if !valid_options.include?(key)
            raise Errors::InvalidOptions.new(
              options[:name],
              key,
              valid_options
            )
          end
        end
        true
      end
    end
  end
end

Version data entries

31 entries across 28 versions & 3 rubygems

Version Path
mongoid-5.4.1 lib/mongoid/relations/options.rb
mongoid-5.4.0 lib/mongoid/relations/options.rb
mongoid-5.2.1 lib/mongoid/relations/options.rb
mongoid-5.2.0 lib/mongoid/relations/options.rb
mongoid-5.2.0.rc0 lib/mongoid/relations/options.rb
mongoid-5.1.6 lib/mongoid/relations/options.rb
mongoid-5.1.5 lib/mongoid/relations/options.rb
mongoid-5.1.4 lib/mongoid/relations/options.rb
ish_lib_manager-0.0.1 test/dummy/vendor/bundle/ruby/2.3.0/gems/mongoid-4.0.2/lib/mongoid/relations/options.rb
ish_lib_manager-0.0.1 test/dummy/vendor/bundle/ruby/2.3.0/gems/mongoid-5.1.3/lib/mongoid/relations/options.rb
mongoid-5.1.3 lib/mongoid/relations/options.rb
mongoid-5.1.2 lib/mongoid/relations/options.rb
mongoid-5.1.1 lib/mongoid/relations/options.rb
mongoid-5.1.0 lib/mongoid/relations/options.rb
tdiary-4.2.1 vendor/bundle/ruby/2.2.0/gems/mongoid-5.0.1/lib/mongoid/relations/options.rb
tdiary-4.2.1 vendor/bundle/ruby/2.3.0/gems/mongoid-5.0.2/lib/mongoid/relations/options.rb
tdiary-4.2.1 vendor/bundle/ruby/2.2.0/gems/mongoid-5.0.2/lib/mongoid/relations/options.rb
mongoid-5.0.2 lib/mongoid/relations/options.rb
mongoid-5.0.1 lib/mongoid/relations/options.rb
mongoid-5.0.0 lib/mongoid/relations/options.rb