yattr_encrypted 0.1.4 → 0.1.5

data/README.mdown

@@ -1,6 +1,6 @@
 # YattrEncrypted #
 
-Version: 0.1.4  (but you should check lib/yattr_encrypted/version.rb to be sure)
+Version: 0.1.5  (but you should check lib/yattr_encrypted/version.rb to be sure)
 
 ## Applicability ##
 
@@ -139,9 +139,26 @@ Special processing for attribute values can be implemented by using the `:read_f
 A `:read_filter` is a proc (or lambda) which accepts a single argument. It is called on the
 value of the *attribute* immediately before being returned by the clear text attribute accessor.
 
+**NOTE:** The read filter is called every time the *attribute* is read via the attribute
+reader. It should be idempotent in the sense that read_filter(attribute) == read_filter(read_filter(attribute)).
+
+**NOTE:** The read filter result is reflected in the instance variable which supports the
+plain text version of the *attribute*, so it can be used to set the *attribute* to a default
+value - such as an empty Hash.
+
+    yattr_encrypted :bag, :read_filter => lambda { |val| val.is_a?(Hash) ? val : {} }
+
 A `:write_filter` is a proc (or lambda) which accepts a single argument. It is called
 on the value passed to the *attribute* writer prior to any other action in the writer.
 
+**NOTE:** the write filter is called on every value which is assigned to the *attribute*.
+
+You can use a `:write_filter` to do some standard preprocessing on values. For example,
+if you want to normalize some string of text to lower case, with uniform whitespace, you might
+do something like:
+
+    yattr_encrypted :str_value, :write_filter => lambda { |val| val.to_s.sub(/\s+/, ' ').downcase.strip }
+
 ### Encription Initial Values ###
 
 As stated everywhere - random initial values are automatically generated for all fields.

data/lib/yattr_encrypted.rb

@@ -76,7 +76,6 @@ module YattrEncrypted
 
         # iterate through attributes and create accessors, verify encryped accessors exist
         attributes.map { |x| x.to_sym }.each do |attribute|
-puts "yate_encrypted: #{attribute}"
           encrypted_attribute_name = [options[:prefix], attribute, options[:suffix]].join.to_sym
 
           # barf if reader and write doesn't exist for encrypted attribute
@@ -88,14 +87,17 @@ puts "yate_encrypted: #{attribute}"
           tmp =<<-XXX
           def #{attribute}
             options = yate_encrypted_attributes[:#{attribute}]
-            unless @#{attribute} && !@#{attribute}.empty?
+            if @#{attribute}.nil? || @#{attribute}.empty?
               @#{attribute} = #{encrypted_attribute_name} ? \
                   yate_decrypt(#{encrypted_attribute_name}, options[:key]) : \
                   ''
+              @#{attribute} = options[:read_filter].call(@#{attribute}) if options[:read_filter]
               self.yate_checksums[:#{attribute}] = yate_attribute_hash_value(:#{attribute})
               self.yate_dirty[:#{attribute}] = true
+            elsif options[:read_filter]
+              @#{attribute} = options[:read_filter].call(@#{attribute})
             end
-            options[:read_filter] ? options[:read_filter].call(@#{attribute}) : @#{attribute}
+            @#{attribute}
           end
           XXX
           class_eval(tmp)

data/lib/yattr_encrypted/version.rb

@@ -1,3 +1,3 @@
 module YattrEncrypted
-  VERSION = '0.1.4'
+  VERSION = '0.1.5'
 end

data/test/yattr_encrypted_test.rb

@@ -40,7 +40,7 @@ class SomeClass < ActiveRecord::Base
   yattr_encrypted :special_reader, :key => 'a honkin big key: honk honk honk honk honk',
     :read_filter => lambda { |val| val.strip }
   yattr_encrypted :special_writer, :key => 'a honkin big key: honk honk honk honk honk',
-    :write_filter => lambda { |val| puts val; val.upcase }
+    :write_filter => lambda { |val| val.upcase }
 end
 
 class TestYattrEncrypted < MiniTest::Unit::TestCase

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yattr_encrypted
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-03-19 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
-  requirement: &2151769420 !ruby/object:Gem::Requirement
+  requirement: &2151769620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2151769420
+  version_requirements: *2151769620
 description: Generates yattr_accessors that encrypt and decrypt attributes transparently.
   Based on attr_encrypted by Sean Huber [https://github.com/shuber]
 email: mike@clove.com
@@ -56,7 +56,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2285454077099666257
+      hash: 677455391031981630
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: