Class: Tram::Policy

Inherits:
Object
  • Object
show all
Extended by:
Dry::Initializer, DSL
Defined in:
lib/tram/policy.rb,
lib/tram/policy/dsl.rb,
lib/tram/policy/error.rb,
lib/tram/policy/errors.rb,
lib/tram/policy/generator.rb,
lib/tram/policy/inflector.rb,
lib/tram/policy/validator.rb,
lib/tram/policy/validation_error.rb

Overview

Base class for policy objects with composable validation errors

Defined Under Namespace

Modules: DSL, Inflector Classes: Error, Errors, Generator, ValidationError, Validator

Instance Method Summary collapse

Methods included from DSL

[], local_validators, scope, validate, validators

Instance Method Details

#errors ⇒ Tram::Policy::Errors

Collection of validation errors

Returns:



33
34
35
 
# File 'lib/tram/policy.rb', line 33

def errors
  @errors ||= Errors.new(self)
end

#inspect ⇒ String

Human-readable representation of the policy

Examples:

Displays policy name and its attributes

UserPolicy[name: "Andy"].inspect
# => #<UserPolicy["name" => "Andy"]>

Returns:

  • (String) 


73
74
75
 
# File 'lib/tram/policy.rb', line 73

def inspect
  "#<#{self.class.name}[#{__attributes__}]>"
end

#invalid?(&filter) ⇒ Boolean

Checks whether the policy is invalid

Parameters:

  • filter (Proc, nil) —

    Block describing **the only errors to count**

Returns:

  • (Boolean) 


51
52
53
 
# File 'lib/tram/policy.rb', line 51

def invalid?(&filter)
  filter ? errors.any?(&filter) : errors.any?
end

#t(message, **options) ⇒ String

Translates a message in the scope of current policy

Parameters:

  • message (#to_s)
  • options (Hash<Symbol, Object>)

Returns:

  • (String) 


24
25
26
27
 
# File 'lib/tram/policy.rb', line 24

def t(message, **options)
  return message.to_s unless message.is_a? Symbol
  I18n.t message, scope: self.class.send(:scope), **options
end

#valid?(&filter) ⇒ Boolean

Checks whether the policy is valid

Parameters:

  • filter (Proc, nil) —

    Block describing **errors to be skipped**

Returns:

  • (Boolean) 


42
43
44
 
# File 'lib/tram/policy.rb', line 42

def valid?(&filter)
  filter ? errors.reject(&filter).empty? : errors.empty?
end

#validate!(&filter) ⇒ nil

Raises exception if the policy is not valid

Parameters:

  • filter (Proc, nil) —

    Block describing **errors to be skipped**

Returns:

  • (nil) —

    if the policy is valid

Raises:



61
62
63
 
# File 'lib/tram/policy.rb', line 61

def validate!(&filter)
  raise ValidationError.new(self, filter) unless valid?(&filter)
end