Sha256: ebdfeee1f4a3f4a0ce576923a7ae68eff48eb9a728d8e9d3258e22f043f52ecc

Contents?: true

Size: 1.13 KB

Versions: 24

Compression:

Stored size: 1.13 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,
        :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
      end
    end
  end
end

Version data entries

24 entries across 24 versions & 2 rubygems

Version Path
mongoid-3.0.23 lib/mongoid/relations/options.rb
mongoid-3.0.22 lib/mongoid/relations/options.rb
mongoid-3.0.21 lib/mongoid/relations/options.rb
mongoid-3.0.20 lib/mongoid/relations/options.rb
mongoid-3.0.19 lib/mongoid/relations/options.rb
mongoid-3.0.18 lib/mongoid/relations/options.rb
mongoid-3.0.17 lib/mongoid/relations/options.rb
sunrise-cms-0.5.0.rc1 vendor/bundle/ruby/1.9.1/gems/mongoid-3.0.16/lib/mongoid/relations/options.rb
mongoid-3.0.16 lib/mongoid/relations/options.rb
mongoid-3.0.15 lib/mongoid/relations/options.rb
mongoid-3.0.14 lib/mongoid/relations/options.rb
mongoid-3.0.13 lib/mongoid/relations/options.rb
mongoid-3.0.12 lib/mongoid/relations/options.rb
mongoid-3.0.11 lib/mongoid/relations/options.rb
mongoid-3.0.10 lib/mongoid/relations/options.rb
mongoid-3.0.9 lib/mongoid/relations/options.rb
mongoid-3.0.6 lib/mongoid/relations/options.rb
mongoid-3.0.5 lib/mongoid/relations/options.rb
mongoid-3.0.4 lib/mongoid/relations/options.rb
mongoid-3.0.3 lib/mongoid/relations/options.rb