module AttrEncrypted::Adapters::ActiveRecord
Public Instance Methods
assign_attributes(*args)
click to toggle source
# File lib/attr_encrypted/adapters/active_record.rb, line 37 def assign_attributes(*args) perform_attribute_assignment :assign_attributes_without_attr_encrypted, *args end
attributes=(*args)
click to toggle source
# File lib/attr_encrypted/adapters/active_record.rb, line 43 def attributes=(*args) perform_attribute_assignment :attributes_without_attr_encrypted=, *args end
perform_attribute_assignment(method, new_attributes, *args)
click to toggle source
# File lib/attr_encrypted/adapters/active_record.rb, line 27 def perform_attribute_assignment(method, new_attributes, *args) return if new_attributes.blank? send method, new_attributes.reject { |k, _| self.class.encrypted_attributes.key?(k.to_sym) }, *args send method, new_attributes.reject { |k, _| !self.class.encrypted_attributes.key?(k.to_sym) }, *args end
reload(*args, &block)
click to toggle source
# File lib/attr_encrypted/adapters/active_record.rb, line 12 def reload(*args, &block) result = reload_without_attr_encrypted(*args, &block) self.class.encrypted_attributes.keys.each do |attribute_name| instance_variable_set("@#{attribute_name}", nil) end result end
Protected Instance Methods
attr_encrypted(*attrs)
click to toggle source
attr_encrypted
method
Calls superclass method
# File lib/attr_encrypted/adapters/active_record.rb, line 52 def attr_encrypted(*attrs) super options = attrs.extract_options! attr = attrs.pop attribute attr if ::ActiveRecord::VERSION::STRING >= "5.1.0" options.merge! encrypted_attributes[attr] define_method("#{attr}_was") do attribute_was(attr) end if ::ActiveRecord::VERSION::STRING >= "4.1" define_method("#{attr}_changed?") do |options = {}| attribute_changed?(attr, options) end else define_method("#{attr}_changed?") do attribute_changed?(attr) end end define_method("#{attr}_change") do attribute_change(attr) end define_method("#{attr}_with_dirtiness=") do |value| ## # In ActiveRecord 5.2+, due to changes to the way virtual # attributes are handled, @attributes[attr].value is nil which # breaks attribute_was. Setting it here returns us to the expected # behavior. if ::ActiveRecord::VERSION::STRING >= "5.2" # This is needed support attribute_was before a record has # been saved set_attribute_was(attr, __send__(attr)) if value != __send__(attr) # This is needed to support attribute_was after a record has # been saved @attributes.write_from_user(attr.to_s, value) if value != __send__(attr) end ## attribute_will_change!(attr) if value != __send__(attr) __send__("#{attr}_without_dirtiness=", value) end alias_method "#{attr}_without_dirtiness=", "#{attr}=" alias_method "#{attr}=", "#{attr}_with_dirtiness=" alias_method "#{attr}_before_type_cast", attr end
attribute_instance_methods_as_symbols()
click to toggle source
Calls superclass method
# File lib/attr_encrypted/adapters/active_record.rb, line 102 def attribute_instance_methods_as_symbols # We add accessor methods of the db columns to the list of instance # methods returned to let ActiveRecord define the accessor methods # for the db columns if connected? && table_exists? columns_hash.keys.inject(super) {|instance_methods, column_name| instance_methods.concat [column_name.to_sym, :"#{column_name}="]} else super end end
attribute_instance_methods_as_symbols_available?()
click to toggle source
# File lib/attr_encrypted/adapters/active_record.rb, line 114 def attribute_instance_methods_as_symbols_available? connected? && table_exists? end
method_missing_with_attr_encrypted(method, *args, &block)
click to toggle source
Allows you to use dynamic methods like find_by_email
or scoped_by_email
for encrypted attributes
NOTE: This only works when the :key
option is specified as a string (see the README)
This is useful for encrypting fields like email addresses. Your user's email addresses are encrypted in the database, but you can still look up a user by email for logging in
Example
class User < ActiveRecord::Base attr_encrypted :email, key: 'secret key' end User.find_by_email_and_password('test@example.com', 'testing') # results in a call to User.find_by_encrypted_email_and_password('the_encrypted_version_of_test@example.com', 'testing')
# File lib/attr_encrypted/adapters/active_record.rb, line 135 def method_missing_with_attr_encrypted(method, *args, &block) if match = /^(find|scoped)_(all_by|by)_([_a-zA-Z]\w*)$/.match(method.to_s) attribute_names = match.captures.last.split('_and_') attribute_names.each_with_index do |attribute, index| if attr_encrypted?(attribute) && encrypted_attributes[attribute.to_sym][:mode] == :single_iv_and_salt args[index] = send("encrypt_#{attribute}", args[index]) warn "DEPRECATION WARNING: This feature will be removed in the next major release." attribute_names[index] = encrypted_attributes[attribute.to_sym][:attribute] end end method = "#{match.captures[0]}_#{match.captures[1]}_#{attribute_names.join('_and_')}".to_sym end method_missing_without_attr_encrypted(method, *args, &block) end