lockbox 0.6.3 → 0.6.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fbcd16c017fd2282888d124ab9d82029b92405bdaca39034ab4e52ee5eb92010
-  data.tar.gz: a54398f0e0acbd1543be296b4ca0214a3b6ca120dc5d89a5f488ac160309ea6b
+  metadata.gz: 2b85dd2a91e0fbb6e687dc63a36915c3b67552320f417fe4caed9f27c5b8fbfc
+  data.tar.gz: 807037af47e0ee9fae9ed93d95ad0253b68bd6c6ab13ee53ce2cc8de0536e926
 SHA512:
-  metadata.gz: c1487a899e37749915555456b59ddb23b75bdc95ce8d8598750e13873c1226de7b7183d3306cfef3e3190ec52275ad452c25ac7c1aab7585a05630c1d312268c
-  data.tar.gz: 4686137e29c935e5f7f141c8239332f89d14764a94a70ee6160f138aa29cc1ce496a0fe384965c0d77ba795700fb58a4ed86feabf5318e25434b86ee0df47153
+  metadata.gz: 429401bd5b38388d43a07bfbc8cbe4acdac73718e05c5043276092ac0d992f439721beeb2d36320a84b69cd24687838edd9a59f28a39ac7f7797502911bd708a
+  data.tar.gz: 412a3eacac1489f931ea1cae22f628fe73eeb9a1d01b568c385f37ede3281f657235ed16b831c2c9c46348d23bb1e6d62a4e5ea857a2e619d0087f4e4e4b89ce

data/CHANGELOG.md

@@ -1,3 +1,21 @@
+## 0.6.7 (2022-01-25)
+
+- Added warning for attributes with `default` option
+- Removing warning for Active Record 5.0 (still supported)
+
+## 0.6.6 (2021-09-27)
+
+- Fixed `attribute?` method for `boolean` and `integer` types
+
+## 0.6.5 (2021-07-07)
+
+- Fixed issue with `pluck` extension not loading in some cases
+
+## 0.6.4 (2021-04-05)
+
+- Fixed in place changes in callbacks
+- Fixed `[]` method for encrypted attributes
+
 ## 0.6.3 (2021-03-30)
 
 - Fixed empty arrays and hashes
@@ -12,6 +30,7 @@
 ## 0.6.1 (2020-12-03)
 
 - Added integration with Rails credentials
+- Added warning for unsupported versions of Active Record
 - Fixed in place changes for Active Record 6.1
 - Fixed error with `content_type` method for CarrierWave < 2
 

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2018-2021 Andrew Kane
+Copyright (c) 2018-2022 Andrew Kane
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -16,7 +16,7 @@ Learn [the principles behind it](https://ankane.org/modern-encryption-rails), [h
 Add this line to your application’s Gemfile:
 
 ```ruby
-gem 'lockbox'
+gem "lockbox"
 ```
 
 ## Key Generation
@@ -87,6 +87,8 @@ class User < ApplicationRecord
 end
 ```
 
+**Note:** With Rails 7, use `lockbox_encrypts` instead of `encrypts`
+
 You can use `email` just like any other attribute.
 
 ```ruby
@@ -336,9 +338,9 @@ def license
 end
 ```
 
-#### Migrating Existing Files [experimental]
+Use `filename` to specify a filename or `disposition: "inline"` to show inline.
 
-**Note:** This feature is experimental. Please try it in a non-production environment and [share](https://github.com/ankane/lockbox/issues/44) how it goes.
+#### Migrating Existing Files
 
 Lockbox makes it easy to encrypt existing files without downtime.
 
@@ -403,6 +405,8 @@ def license
 end
 ```
 
+Use `filename` to specify a filename or `disposition: "inline"` to show inline.
+
 #### Migrating Existing Files
 
 Encrypt existing files without downtime. Create a new encrypted uploader:
@@ -478,6 +482,8 @@ def license
 end
 ```
 
+Use `filename` to specify a filename or `disposition: "inline"` to show inline.
+
 #### Non-Models
 
 Generate a key
@@ -713,7 +719,7 @@ brew install libsodium
 And add to your Gemfile:
 
 ```ruby
-gem 'rbnacl'
+gem "rbnacl"
 ```
 
 Then add to your model:

data/lib/lockbox/model.rb

@@ -1,6 +1,6 @@
 module Lockbox
   module Model
-    def encrypts(*attributes, **options)
+    def lockbox_encrypts(*attributes, **options)
       # support objects
       # case options[:type]
       # when Date
@@ -149,16 +149,38 @@ module Lockbox
               # needed for in-place modifications
               # assigned attributes are encrypted on assignment
               # and then again here
-              before_save do
+              def lockbox_sync_attributes
                 self.class.lockbox_attributes.each do |_, lockbox_attribute|
                   attribute = lockbox_attribute[:attribute]
 
-                  if attribute_changed_in_place?(attribute)
+                  if attribute_changed_in_place?(attribute) || (send("#{attribute}_changed?") && !send("#{lockbox_attribute[:encrypted_attribute]}_changed?"))
                     send("#{attribute}=", send(attribute))
                   end
                 end
               end
 
+              # safety check
+              [:_create_record, :_update_record].each do |method_name|
+                unless private_method_defined?(method_name) || method_defined?(method_name)
+                  raise Lockbox::Error, "Expected #{method_name} to be defined. Please report an issue."
+                end
+              end
+
+              def _create_record(*)
+                lockbox_sync_attributes
+                super
+              end
+
+              def _update_record(*)
+                lockbox_sync_attributes
+                super
+              end
+
+              def [](attr_name)
+                send(attr_name) if self.class.lockbox_attributes.any? { |_, la| la[:attribute] == attr_name.to_s }
+                super
+              end
+
               def update_columns(attributes)
                 return super unless attributes.is_a?(Hash)
 
@@ -287,6 +309,21 @@ module Lockbox
                 super()
               end
             end
+
+            define_method("#{name}?") do
+              # uses public_send, so we don't need to preload attribute
+              query_attribute(name)
+            end
+
+            user_provided_default =
+              if ActiveRecord::VERSION::STRING >= "5.2"
+                ActiveModel::Attribute::UserProvidedDefault
+              else
+                ActiveRecord::Attribute::UserProvidedDefault
+              end
+            if _default_attributes[name.to_s].is_a?(user_provided_default)
+              warn "[lockbox] WARNING: attributes with `:default` option are not supported. Use `after_initialize` instead."
+            end
           else
             # keep this module dead simple
             # Mongoid uses changed_attributes to calculate keys to update
@@ -326,10 +363,10 @@ module Lockbox
               send("reset_#{encrypted_attribute}_to_default!")
               send(name)
             end
-          end
 
-          define_method("#{name}?") do
-            send("#{encrypted_attribute}?")
+            define_method("#{name}?") do
+              send("#{encrypted_attribute}?")
+            end
           end
 
           define_method("#{name}=") do |message|

data/lib/lockbox/version.rb

@@ -1,3 +1,3 @@
 module Lockbox
-  VERSION = "0.6.3"
+  VERSION = "0.6.7"
 end

data/lib/lockbox.rb

@@ -28,17 +28,21 @@ end
 if defined?(ActiveSupport.on_load)
   ActiveSupport.on_load(:active_record) do
     # TODO raise error in 0.7.0
-    if ActiveRecord::VERSION::STRING.to_f <= 5.0
+    if ActiveRecord::VERSION::STRING.to_f < 5.0
       warn "Active Record version (#{ActiveRecord::VERSION::STRING}) not supported in this version of Lockbox (#{Lockbox::VERSION})"
     end
 
     extend Lockbox::Model
     extend Lockbox::Model::Attached
-    ActiveRecord::Calculations.prepend Lockbox::Calculations
+    # alias_method is private in Ruby < 2.5
+    singleton_class.send(:alias_method, :encrypts, :lockbox_encrypts) if ActiveRecord::VERSION::MAJOR < 7
+    ActiveRecord::Relation.prepend Lockbox::Calculations
   end
 
   ActiveSupport.on_load(:mongoid) do
     Mongoid::Document::ClassMethods.include(Lockbox::Model)
+    # alias_method is private in Ruby < 2.5
+    Mongoid::Document::ClassMethods.send(:alias_method, :encrypts, :lockbox_encrypts)
   end
 end
 
@@ -106,7 +110,7 @@ module Lockbox
 
   def self.encrypts_action_text_body(**options)
     ActiveSupport.on_load(:action_text_rich_text) do
-      ActionText::RichText.encrypts :body, **options
+      ActionText::RichText.lockbox_encrypts :body, **options
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lockbox
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: 0.6.7
 platform: ruby
 authors:
 - Andrew Kane
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-31 00:00:00.000000000 Z
+date: 2022-01-25 00:00:00.000000000 Z
 dependencies: []
 description:
 email: andrew@ankane.org
@@ -58,7 +58,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
 summary: Modern encryption for Ruby and Rails