Module: Redmine::SafeAttributes

Included in:
Issue, Project, User
Defined in:
lib/redmine/safe_attributes.rb

Defined Under Namespace

Modules: ClassMethods

Class Method Summary (collapse)

Instance Method Summary (collapse)

Class Method Details

+ (Object) included(base)



20
21
22
# File 'lib/redmine/safe_attributes.rb', line 20

def self.included(base)
  base.extend(ClassMethods)
end

Instance Method Details

- (Object) delete_unsafe_attributes(attrs, user = User.current)

Returns a hash with unsafe attributes removed from the given attrs hash

Example:

book.delete_unsafe_attributes({'title' => 'My book', 'foo' => 'bar'})
# => {'title' => 'My book'}


63
64
65
66
# File 'lib/redmine/safe_attributes.rb', line 63

def delete_unsafe_attributes(attrs, user=User.current)
  safe = safe_attribute_names(user)
  attrs.dup.delete_if {|k,v| !safe.include?(k)}
end

- (Object) safe_attribute_names(user = User.current)

Returns an array that can be safely set by user or current user

Example:

book.safe_attributes # => ['title', 'pages']
book.safe_attributes(book.author) # => ['title', 'pages', 'isbn']


47
48
49
50
51
52
53
54
55
# File 'lib/redmine/safe_attributes.rb', line 47

def safe_attribute_names(user=User.current)
  names = []
  self.class.safe_attributes.collect do |attrs, options|
    if options[:if].nil? || options[:if].call(self, user)
      names += attrs.collect(&:to_s)
    end
  end
  names.uniq
end

- (Object) safe_attributes=(attrs, user = User.current)

Sets attributes from attrs that are safe attrs is a Hash with string keys



70
71
72
73
# File 'lib/redmine/safe_attributes.rb', line 70

def safe_attributes=(attrs, user=User.current)
  return unless attrs.is_a?(Hash)
  self.attributes = delete_unsafe_attributes(attrs, user)
end