active_record_encryption 0.2.1 → 1.0.0.alpha

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 585c87bfd8ce7dc5dd9aa303a89f23b5f7f7060e53401538465214e717f4cf4e
-  data.tar.gz: adf27af387edb8ff6cac34ea735c8189e26889a59c22b8f0eb19fe190cc8f27f
+  metadata.gz: 14bd2384751a5ab2042b14864f2f873e666d78f5a01c8bdce9d8c2190284f514
+  data.tar.gz: 7a086e0bdccd0e140a444fd92688302c60a36355a93c73eef2e869f1a4962dc5
 SHA512:
-  metadata.gz: '09cf19da814c601fafc4e5e05c64ac2eb6926f540e2116e2536c0eef1ef72529f1d2865403f2a7475ddd53b8de0ef5f1d42cfa8408b42fc48b0552ef74e8a569'
-  data.tar.gz: 9a6602b13e6ced26450cee8ed43feab631ecd1a2cb009ed26d7a0f0df9a3a482f34b2cc7f63dc52316574c7274680b8296be1c749df83c4387d8287da7e5f178
+  metadata.gz: 20a722cb97287bb1f792f0f887ce8b1bcf1a229ecac56d141e205cd1cae3d4930ebbace743c279ff19cb2c2d8fd55605430a86a43ec13c2833942dacde7caab3
+  data.tar.gz: 0df865d7401f019eef15ecad0e78094e11b624eacced1bbe318f357e016d04ea8570f179a7c1a8d1af1eb54f96d731850702a0bfa4925d8423ec5c0a48d02545

data/CHANGELOG.md

@@ -1,3 +1,19 @@
+## 1.0.0.alpha
+
+- EOL Ruby and Rails no longer supported #29
+  - Requires Ruby 3.0.0 or newer.
+  - Requires Rails 6.1.0 or newer.
+- Support rails 7.0.0 #25
+- Support rails 7.1.0 #31
+- Migrate CI from travis.ci to GitHub Action. #27
+  - In Rails 7.0, `ActiveRecordEncryption` do not change encoding for backward compatibility.
+
+## 0.3.0
+
+- Support rails 6.1.0 #22
+- Ensure casting only when Rails less than 6.0 #21
+- Fix Ruby 2.7 keyword arguments warnings #20
+
 ## 0.2.1
 
 - Fixes #13 Add `:cipher` option to `active_support` encryptor to change cipher.

data/README.md

@@ -49,7 +49,7 @@ class PointLog < ActiveRecord::Base
   encrypted_attribute(:serialized_address, :string)
 
   # Change encryptor
-  encrypted_attribute(:name, :field, encryption: { encryptor: :active_support, key: ENV['ENCRYPTION_KEY'], salt: ['ENCRYPTION_SALT'] })
+  encrypted_attribute(:name, :field, encryption: { encryptor: :active_support, key: ENV['ENCRYPTION_KEY'], salt: ENV['ENCRYPTION_SALT'] })
 end
 ```
 
@@ -118,9 +118,8 @@ end
 
 ```bash
 bundle exec appraisal install
-bundle exec appraisal 5.0-stable rspec
-bundle exec appraisal 5.1-stable rspec
-bundle exec appraisal 5.2-stable rspec
+bundle exec appraisal 6.1-stable rspec
+bundle exec appraisal 7.0-stable rspec
 ```
 
 ## Contributing

data/lib/active_record_encryption/encrypted_attribute.rb

@@ -6,7 +6,7 @@ module ActiveRecordEncryption
 
     module ClassMethods
       def encrypted_attribute(name, subtype, **options)
-        attribute(name, :encryption, options.merge(subtype: subtype))
+        attribute(name, :encryption, **options, subtype: subtype)
       end
     end
   end

data/lib/active_record_encryption/encryptor/base.rb

@@ -4,7 +4,7 @@ module ActiveRecordEncryption
   module Encryptor
     # Abstract interface of encryptor
     class Base
-      def initialize(*); end
+      def initialize(*, **); end
 
       def encrypt(value)
         value

data/lib/active_record_encryption/encryptor/registry.rb

@@ -2,32 +2,15 @@
 
 module ActiveRecordEncryption
   module Encryptor
-    class Registry
-      def initialize
-        @registrations = []
-      end
-
-      def register(encryptor_name, klass = nil, **options, &block)
-        block ||= proc { |_, *args| klass.new(*args) }
-        registrations << Registration.new(encryptor_name, block, **options)
-      end
-
-      def lookup(symbol, *args)
-        registration = find_registration(symbol, *args)
-
-        if registration
-          registration.call(self, symbol, *args)
-        else
-          raise ArgumentError, "Unknown encryptor #{symbol.inspect}"
-        end
-      end
-
+    class Registry < ActiveModel::Type::Registry
       private
 
-      attr_reader :registrations
+      def registration_klass
+        Registration
+      end
 
-      def find_registration(symbol, *args)
-        registrations.find { |registration| registration.matches?(symbol, *args) }
+      def find_registration(symbol, *args, **kwargs)
+        registrations.find { |r| r.matches?(symbol, *args, **kwargs) }
       end
     end
 

data/lib/active_record_encryption/quoter.rb

@@ -18,12 +18,27 @@ module ActiveRecordEncryption
       'f'
     end
 
+    if ActiveRecord::VERSION::MAJOR >= 7
+      # Cast value to string
+      def type_cast(value)
+        return value.to_s if value.is_a?(Numeric)
+        super(value)
+      end
+    end
+
+    # @return [Symbol]
+    def default_timezone
+      ActiveRecord::Base.connection.default_timezone
+    end
+
     private
 
-    # Cast value to string
-    def _type_cast(value)
-      return value.to_s if value.is_a?(Numeric)
-      super(value)
+    if ActiveRecord::VERSION::MAJOR < 7
+      # Cast value to string
+      def _type_cast(value)
+        return value.to_s if value.is_a?(Numeric)
+        super(value)
+      end
     end
   end
 end

data/lib/active_record_encryption/type/binary.rb

@@ -0,0 +1,30 @@
+module ActiveRecordEncryption
+  class Type
+    class Binary < ActiveModel::Type::Binary
+      def cast(value)
+        return super if ActiveRecord::VERSION::STRING < '7.0.0'
+
+        if value.is_a?(Data)
+          value.to_s
+        else
+          value = cast_value(value) unless value.nil?
+          # NOTE: Don't convert string to binary for backward compatibility.
+          # value = value.b if ::String === value && value.encoding != Encoding::BINARY
+          value
+        end
+      end
+
+      def serialize(value)
+        return if value.nil?
+        Data.new(value)
+      end
+
+      class Data < ActiveModel::Type::Binary::Data
+        # NOTE: Don't convert string to binary for backward compatibility.
+        def initialize(value)
+          @value = value.to_s
+        end
+      end
+    end
+  end
+end

data/lib/active_record_encryption/type.rb

@@ -1,23 +1,18 @@
 # frozen_string_literal: true
 
-require 'active_record_encryption/serializer_with_cast'
-
 module ActiveRecordEncryption
   class Type < ActiveRecord::Type::Value
-    using(ActiveRecordEncryption::SerializerWithCast)
-
     delegate :type, :cast, to: :subtype
     delegate :user_input_in_time_zone, to: :subtype # for ActiveRecord::AttributeMethods::TimeZoneConversion::TimeZoneConverter
 
     def initialize(
-      subtype: default_value,
+      subtype: ActiveRecord::Type.default_value,
       encryption: ActiveRecordEncryption.default_encryption.clone,
       **options
     )
-
       # Lookup encryptor from options[:encryption]
       @encryptor = build_encryptor(encryption)
-      @binary = ActiveRecord::Type.lookup(:binary)
+      @binary = ActiveRecord::Type.lookup(:encryption_binary)
 
       subtype = ActiveRecord::Type.lookup(subtype, **options) if subtype.is_a?(Symbol)
       @subtype = subtype
@@ -42,22 +37,13 @@ module ActiveRecordEncryption
 
     attr_reader :subtype, :binary, :encryptor
 
-    # NOTE: `ActiveRecord::Type.default_value` is not defined in Rails 5.0
-    def default_value
-      if ActiveRecord.gem_version < Gem::Version.create('5.1.0')
-        ActiveRecord::Type::Value.new
-      else
-        ActiveRecord::Type.default_value
-      end
-    end
-
     def build_encryptor(options)
       encryptor = options.delete(:encryptor)
 
       if encryptor.is_a?(Symbol)
         ActiveRecordEncryption::Encryptor.lookup(encryptor, **options)
       elsif encryptor.is_a?(Class)
-        encryptor.new(options)
+        encryptor.new(**options)
       else
         encryptor
       end

data/lib/active_record_encryption/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActiveRecordEncryption
-  VERSION = '0.2.1'
+  VERSION = '1.0.0.alpha'
 end

data/lib/active_record_encryption.rb

@@ -13,6 +13,7 @@ end
 
 ActiveSupport.on_load(:active_record) do
   require 'active_record_encryption/type'
+  require 'active_record_encryption/type/binary'
   require 'active_record_encryption/encryptor'
   require 'active_record_encryption/encrypted_attribute'
   require 'active_record_encryption/binary'
@@ -20,6 +21,7 @@ ActiveSupport.on_load(:active_record) do
 
   # Register `:encryption` type
   ActiveRecord::Type.register(:encryption, ActiveRecordEncryption::Type)
+  ActiveRecord::Type.register(:encryption_binary, ActiveRecordEncryption::Type::Binary)
 
   # Define `.encrypted_attribute`
   ActiveRecord::Base.include(ActiveRecordEncryption::EncryptedAttribute)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_record_encryption
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 1.0.0.alpha
 platform: ruby
 authors:
 - alpaca-tc
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-12-18 00:00:00.000000000 Z
+date: 2023-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -38,20 +38,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.16'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.16'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -98,16 +84,16 @@ dependencies:
   name: mysql2
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -201,14 +187,14 @@ files:
 - lib/active_record_encryption/encryptor/registry.rb
 - lib/active_record_encryption/exceptions.rb
 - lib/active_record_encryption/quoter.rb
-- lib/active_record_encryption/serializer_with_cast.rb
 - lib/active_record_encryption/type.rb
+- lib/active_record_encryption/type/binary.rb
 - lib/active_record_encryption/version.rb
 homepage: https://github.com/alpaca-tc/active_record_encryption
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -216,16 +202,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.3
-signing_key: 
+rubygems_version: 3.4.6
+signing_key:
 specification_version: 4
 summary: Transparent ActiveRecord encryption
 test_files: []

data/lib/active_record_encryption/serializer_with_cast.rb

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-module ActiveRecordEncryption
-  module SerializerWithCast
-    # Unfortunately, current Rails doesn't serialize value from user input with `#cast`.
-    # IMO, it is expected that serialized value from user input should be equal same result.
-    #
-    # Example:
-    #   # Current
-    #   User.attribute(:id, :boolean)
-    #   User.where(id: 'string').to_sql #=> SELECT `users`.* FROM `users` WHERE `users`.`id` = 'string'
-    #   User.where(id: true).to_sql     #=> SELECT `users`.* FROM `users` WHERE `users`.`id` = TRUE
-    #
-    #   # Expected
-    #   User.attribute(:id, :boolean)
-    #   User.where(id: 'string').to_sql #=> SELECT `users`.* FROM `users` WHERE `users`.`id` = TRUE
-    #   User.where(id: true).to_sql     #=> SELECT `users`.* FROM `users` WHERE `users`.`id` = TRUE
-    refine ActiveModel::Type::Decimal do
-      def serialize(value)
-        cast(value)
-      end
-    end
-
-    refine ActiveModel::Type::Boolean do
-      def serialize(value)
-        cast(value)
-      end
-    end
-
-    # Backport Rails5.2
-    if ActiveRecord.gem_version < Gem::Version.create('5.2')
-      refine ActiveModel::Type::DateTime do
-        def serialize(value)
-          super(cast(value))
-        end
-      end
-    end
-  end
-end