README.rdoc in attr_encrypted-1.1.2 vs README.rdoc in attr_encrypted-1.2.0

- old
+ new

@@ -10,11 +10,10 @@ gem install attr_encrypted == Usage - === Basic Encrypting attributes has never been easier: class User @@ -36,11 +35,11 @@ @user.save @user = User.load @user.ssn # decrypts :encrypted_ssn and returns '123-45-6789' -The <tt>attr_encrypted</tt> method is also aliased as <tt>attr_encryptor</tt> to conform to Ruby's <tt>attr_</tt> naming conventions. I know that I should have called this project <tt>attr_encryptor</tt> but it was too late when I realized it ='(. +The <tt>attr_encrypted</tt> method is also aliased as <tt>attr_encryptor</tt> to conform to Ruby's <tt>attr_</tt> naming conventions. I should have called this project <tt>attr_encryptor</tt> but it was too late when I realized it ='(. === Specifying the encrypted attribute name By default, the encrypted attribute name is <tt>encrypted_#{attribute}</tt> (e.g. <tt>attr_encrypted :email</tt> would create an attribute named <tt>encrypted_email</tt>). So, if you're storing the encrypted attribute in the database, you need to make sure the <tt>encrypted_#{attribute}</tt> field exists in your table. You have a couple of options if you want to name your attribute something else. @@ -244,11 +243,13 @@ class User attr_encrypted :credentials, :key => 'some secret key', :marshal => true end +You may also optionally specify <tt>:marshaler</tt>, <tt>:dump_method</tt>, and <tt>:load_method</tt> if you want to use something other than the default <tt>Marshal</tt> object. + === Encrypt/decrypt attribute methods If you use the same key to encrypt every record (per attribute) like this: class User @@ -295,14 +296,7 @@ * Fork the project. * Make your feature addition or bug fix. * Add tests for it. This is important so I don't break it in a future version unintentionally. -* Commit, do not mess with rakefile, version, or history. - (if you want to have your own version, that is fine but - bump version in a commit by itself I can ignore when I pull) -* Send me a pull request. Bonus points for topic branches. - - -== Contact - -Problems, comments, and suggestions all welcome: shuber@huberry.com +* Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull) +* Send me a pull request. Bonus points for topic branches. \ No newline at end of file