Module: Net::IMAP::Config::AttrTypeCoercion

Do not use. This module is for internal use only.

Relationships & Source Files
Namespace Children
Modules: `Macros`
Extension / Inclusion / Inheritance Descendants
Included In: `::Net::IMAP::Config`
Defined in:	lib/net/imap/config/attr_type_coercion.rb

Overview

NOTE: This module is an internal implementation detail, with no guarantee of backward compatibility.

Adds a type keyword parameter to .attr_accessor, to enforce that config attributes have valid types, for example: boolean, numeric, enumeration, non-nullable, etc.

Class Method Details

.attr_accessor(attr, type: nil)

[ GitHub ]

# File 'lib/net/imap/config/attr_type_coercion.rb', line 29

def self.attr_accessor(attr, type: nil)
  return unless type
  if    :boolean == type then boolean attr
  elsif Integer  == type then integer attr
  elsif Array   === type then enum    attr, type
  else raise ArgumentError, "unknown type coercion %p" % [type]
  end
end

.boolean(attr)

[ GitHub ]

# File 'lib/net/imap/config/attr_type_coercion.rb', line 38

def self.boolean(attr)
  define_method :"#{attr}=" do |val| super !!val end
  define_method :"#{attr}?" do send attr end
end

.enum(attr, enum)

[ GitHub ]

# File 'lib/net/imap/config/attr_type_coercion.rb', line 47

def self.enum(attr, enum)
  enum = enum.dup.freeze
  expected = -"one of #{enum.map(&:inspect).join(", ")}"
  define_method :"#{attr}=" do |val|
    unless enum.include?(val)
      raise ArgumentError, "expected %s, got %p" % [expected, val]
    end
    super val
  end
end

.included(mod) (private)

[ GitHub ]

# File 'lib/net/imap/config/attr_type_coercion.rb', line 24

def self.included(mod)
  mod.extend Macros
end

.integer(attr)

[ GitHub ]

# File 'lib/net/imap/config/attr_type_coercion.rb', line 43

def self.integer(attr)
  define_method :"#{attr}=" do |val| super Integer val end
end