adaptive_alias 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6f96c867d9849406b6dc38c2d535e6ecf1e62d4de7793d79e78e474588467fc6
-  data.tar.gz: f1b3ff5b3be19513a263212e98c80423f40955af50f744d7f4958202dfaf8659
+  metadata.gz: 81757ab8f4098990940d499ee2286c8c831fdac6462dfcafcd59b868ff596ec2
+  data.tar.gz: b88816e4745352dc63fb29a4d102a52935538bd0f5ef5591f8ce56e9057dc9d5
 SHA512:
-  metadata.gz: 3f8f92726071ac5e064dadc6c9aeb96dc72ed3d99c98fe982988405ce1336cf7978a9720dff958e9555464f9edd791370056ce4dec6190d707f06d77c349c686
-  data.tar.gz: 4d70ffe7088a940742a5c0cd12b0ee6f0249abe6c9cd75c162f0e277cf1066ca086ad8e28d4a6253c2cb103bc9e512e068be498d11305ea1b0563818a8100f30
+  metadata.gz: 60cb4e6e2f31787f93f6edf5415bd3fbe283999c50d0fba89d9e48e055a5c06ca7479ee8a158ec4618453352bc8034a18e9acbafae5905f4e4f2a7a0ee8ba54f
+  data.tar.gz: e80d6cdd3e41254d07e70e4440bc120b6940bfddb31f54709e97becafc18dd4eef2341832fc049d750e247e002a8097f4d9128697de0f657c8fdd1b47310d103

data/.rubocop.yml

@@ -222,9 +222,9 @@ Metrics/CyclomaticComplexity:
   Enabled: true
 
 Layout/LineLength:
-  Description: 'Limit lines to 120 characters.'
+  Description: 'Limit lines to 160 characters.'
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#80-character-limits'
-  Max: 120
+  Max: 160
   Enabled: true
   Exclude:
     - 'config/locales/**'

data/CHANGELOG.md

@@ -1 +1,10 @@
-## Change Log
+## Change Log
+
+### [v0.0.3](https://github.com/khiav223577/adaptive_alias/compare/v0.0.2...v0.0.3) 2022/07/27
+- [#3](https://github.com/khiav223577/adaptive_alias/pull/3) Fix: prevent calling custom column names from raising missing attributes (@khiav223577)
+
+### [v0.0.2](https://github.com/khiav223577/adaptive_alias/compare/v0.0.1...v0.0.2) 2022/07/26
+- [#2](https://github.com/khiav223577/adaptive_alias/pull/2) Doesn't need rails_compatibility in runtime (@khiav223577)
+
+### v0.0.1 2022/07/22
+- [#1](https://github.com/khiav223577/adaptive_alias/pull/1) Implement adaptive_alias features (@khiav223577)

data/README.md

@@ -8,6 +8,27 @@
 
 Extend attribute_alias and make it be adaptive with realtime database schema.
 
+When we are going to rename a column, we may want to add a forward-patch so that we can use new column name before migration. And after migration, we may want to add a backward-patch so that those where are still using old column name will not be broken.
+Ideally, we switch from forward-patch to backward-patch right after migration:
+```rb
+                   ForwardPatch           migrate            BackwardPatch
+    |----------------------------------------|----------------------------------------|
+    
+``` 
+
+But in reality, it will take times to deploy and restart server to switch patch. There is a gap between migration and restart. So what will happen when db is migrated but server is not restarted?
+We need a way to automatically adjust the patch to adapt current schema.
+
+```rb
+                   ForwardPatch           migrate   restart     BackwardPatch
+    |----------------------------------------|---@-----|-------------------------------| 
+                          
+```
+
+This is what this gem wants to achieve. We don't want to do complex migrations, take care of backward-compatibiliy, and have any downtime.
+Just rely on this gem.
+
+
 ## Supports
 - Ruby 2.6 ~ 2.7, 3.0 ~ 3.1
 - Rails 6.0, 6.1, 7.0

data/adaptive_alias.gemspec

@@ -38,8 +38,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 12.0'
   spec.add_development_dependency 'sqlite3', '~> 1.3'
   spec.add_development_dependency 'minitest', '~> 5.0'
-  spec.add_development_dependency 'backports', '~> 3.15.0'
+  spec.add_development_dependency 'rails_compatibility', '>= 0.0.8'
 
   spec.add_dependency 'activerecord', '>= 3'
-  spec.add_dependency 'rails_compatibility', '>= 0.0.8'
 end

data/gemfiles/6.0.gemfile

@@ -5,6 +5,7 @@ gem 'activerecord', '~> 6.0.0'
 group :test do
   gem 'simplecov', '< 0.18'
   gem 'mysql2', '0.5.3'
+  gem 'acts-as-taggable-on', '~> 7.0.0'
 end
 
 gemspec path: '../'

data/gemfiles/6.1.gemfile

@@ -5,6 +5,7 @@ gem 'activerecord', '~> 6.1.3'
 group :test do
   gem 'simplecov', '< 0.18'
   gem 'mysql2', '0.5.3'
+  gem 'acts-as-taggable-on', '~> 7.0.0'
 end
 
 gemspec path: '../'

data/gemfiles/7.0.gemfile

@@ -6,6 +6,7 @@ gem 'activerecord', '~> 7.0.0'
 group :test do
   gem 'simplecov', '< 0.18'
   gem 'mysql2', '0.5.3'
+  gem 'acts-as-taggable-on', '~> 9.0.0'
 end
 
 gemspec path: '../'

data/lib/adaptive_alias/active_model_patches/read_attribute.rb

@@ -9,12 +9,14 @@ module ActiveRecord::AttributeMethods::Read
     _read_attribute(name, &block)
   end
 
+  # This method exists to avoid the expensive primary_key check internally, without
+  # breaking compatibility with the write_attribute API
   def _read_attribute(attr_name, &block) # :nodoc:
     name = attr_name.to_s
     name = self.class.attribute_aliases[name] || name
 
     sync_with_transaction_state if @transaction_state&.finalized?
-    return yield if block_given? && !@attributes.key?(name)
-    @attributes.fetch_value(name, &block)
+    return yield(name) if block_given? and AdaptiveAlias.missing_value?(@attributes, self.class, name)
+    return @attributes.fetch_value(name, &block)
   end
 end

data/lib/adaptive_alias/active_model_patches/remove_alias_attribute.rb

@@ -3,19 +3,10 @@ require 'active_model'
 module ActiveModel::AttributeMethods
   module ClassMethods
     def remove_proxy_call(mod, name)
-      defn = if NAME_COMPILABLE_REGEXP.match?(name)
-               "undef #{name}"
-             else
-               "remove_method(:'#{name}')"
-             end
-
-      mod.module_eval defn, __FILE__, __LINE__ + 1
+      mod.module_eval "remove_method(:'#{name}')", __FILE__, __LINE__ + 1
     end
 
     def remove_alias_attribute(new_name)
-      # association_scope -> add_constraints -> last_chain_scope -> where!(key => model[foreign_key])
-      # self[attr_name] -> read_attribute(attr_name) -> attribute_aliases
-      # where! -> where_clause_factory.build -> attributes = predicate_builder.resolve_column_aliases(opts) -> attribute_aliases
       self.attribute_aliases = attribute_aliases.except(new_name.to_s)
 
       attribute_method_matchers.each do |matcher|

data/lib/adaptive_alias/active_model_patches/write_attribute.rb

@@ -0,0 +1,22 @@
+require 'active_record'
+
+module ActiveRecord::AttributeMethods::Write
+  def write_attribute(attr_name, value)
+    name = attr_name.to_s
+    name = self.class.attribute_aliases[name] || name
+
+    name = @primary_key if name == 'id' && @primary_key
+    _write_attribute(name, value)
+  end
+
+  # This method exists to avoid the expensive primary_key check internally, without
+  # breaking compatibility with the write_attribute API
+  def _write_attribute(attr_name, value) # :nodoc:
+    name = attr_name.to_s
+    name = self.class.attribute_aliases[name] || name
+
+    sync_with_transaction_state if @transaction_state&.finalized?
+    @attributes.write_from_user(name, value)
+    value
+  end
+end

data/lib/adaptive_alias/hooks/association.rb

@@ -4,6 +4,10 @@ module AdaptiveAlias
       def find_target(*)
         AdaptiveAlias.rescue_statement_invalid(nil){ super }
       end
+
+      def create!(attributes = {}, &block)
+        AdaptiveAlias.rescue_statement_invalid(association_scope){ super }
+      end
     end
   end
 end

data/lib/adaptive_alias/hooks/association_scope.rb

@@ -1,13 +1,13 @@
-module AdaptiveAlias
-  module Hooks
-    module AssociationScope
-      def last_chain_scope(*)
-        AdaptiveAlias.rescue_missing_attribute{ super }
-      end
-    end
-  end
-end
-
-class ActiveRecord::Associations::AssociationScope
-  prepend AdaptiveAlias::Hooks::AssociationScope
-end
+module AdaptiveAlias
+  module Hooks
+    module AssociationScope
+      def last_chain_scope(_scope, reflection, owner)
+        AdaptiveAlias.rescue_missing_attribute(owner.class){ super }
+      end
+    end
+  end
+end
+
+class ActiveRecord::Associations::AssociationScope
+  prepend AdaptiveAlias::Hooks::AssociationScope
+end

data/lib/adaptive_alias/hooks/singular_association.rb

@@ -2,7 +2,7 @@ module AdaptiveAlias
   module Hooks
     module SingularAssociation
       def reader(*)
-        AdaptiveAlias.rescue_missing_attribute{ super }
+        AdaptiveAlias.rescue_missing_attribute(owner.class){ super }
       end
     end
   end

data/lib/adaptive_alias/patches/{back_patch.rb → backward_patch.rb}

@@ -4,7 +4,7 @@ require 'adaptive_alias/patches/base'
 
 module AdaptiveAlias
   module Patches
-    class BackPatch < Base
+    class BackwardPatch < Base
       def apply!
         AdaptiveAlias.current_patches[[@klass, @old_column, @new_column]] = self
         @klass.alias_attribute(@old_column, @new_column)
@@ -14,6 +14,7 @@ module AdaptiveAlias
       def remove!
         super
         @klass.remove_alias_attribute(@old_column)
+        @klass.define_attribute_method(@old_column)
         ForwardPatch.new(@klass, @old_column, @new_column).apply!
       end
     end

data/lib/adaptive_alias/patches/base.rb

@@ -6,6 +6,7 @@ module AdaptiveAlias
       attr_reader :fix_association
       attr_reader :fix_missing_attribute
       attr_reader :removed
+      attr_reader :removable
 
       def initialize(klass, old_column, new_column)
         @klass = klass
@@ -15,39 +16,65 @@ module AdaptiveAlias
 
       def add_hooks!(current_column:, alias_column:, log_warning: false)
         patch = self
+        klass = @klass
         old_column = @old_column
         new_column = @new_column
 
-        AdaptiveAlias.get_or_create_model_module(@klass).instance_exec do
+        AdaptiveAlias.get_or_create_model_module(klass).instance_exec do
           remove_method(new_column) if method_defined?(new_column)
           define_method(new_column) do
-            AdaptiveAlias.rescue_missing_attribute{ self[new_column] }
+            AdaptiveAlias.rescue_missing_attribute(klass){ self[new_column] }
+          end
+
+          remove_method("#{new_column}=") if method_defined?("#{new_column}=")
+          define_method("#{new_column}=") do |*args|
+            AdaptiveAlias.rescue_missing_attribute(klass){ super(*args) }
           end
 
           remove_method(old_column) if method_defined?(old_column)
           define_method(old_column) do
             patch.log_warning if log_warning
-            AdaptiveAlias.rescue_missing_attribute{ self[old_column] }
+            AdaptiveAlias.rescue_missing_attribute(klass){ self[old_column] }
+          end
+
+          remove_method("#{old_column}=") if method_defined?("#{old_column}=")
+          define_method("#{old_column}=") do |*args|
+            patch.log_warning if log_warning
+            AdaptiveAlias.rescue_missing_attribute(klass){ super(*args) }
           end
         end
 
-        expected_error_message = "Mysql2::Error: Unknown column '#{@klass.table_name}.#{current_column}' in 'where clause'".freeze
+        expected_association_err_msgs = [
+          "Mysql2::Error: Unknown column '#{klass.table_name}.#{current_column}' in 'where clause'".freeze,
+          "Mysql2::Error: Unknown column '#{current_column}' in 'field list'".freeze,
+        ].freeze
 
-        @fix_missing_attribute = proc do
+        expected_attribute_err_msgs = [
+          "can't write unknown attribute `#{current_column}`".freeze,
+          "missing attribute: #{current_column}".freeze,
+        ].freeze
+
+        @fix_missing_attribute = proc do |error_klass, error|
+          next false if not patch.removable
           next false if patch.removed
+          next false if klass != error_klass
+          next false if not expected_attribute_err_msgs.include?(error.message)
 
           patch.remove!
           next true
         end
 
         @fix_association = proc do |target, error|
-          next false if patch.removed || error.message != expected_error_message
+          next false if not patch.removable
+          next false if patch.removed
+          next false if not expected_association_err_msgs.include?(error.message)
 
           patch.remove!
 
           if target
             hash = target.where_values_hash
             hash[alias_column] = hash.delete(current_column) if hash.key?(current_column)
+            hash[alias_column.to_s] = hash.delete(current_column.to_s) if hash.key?(current_column.to_s)
             target.instance_variable_set(:@arel, nil)
             target.unscope!(:where).where!(hash)
           end
@@ -57,7 +84,7 @@ module AdaptiveAlias
       end
 
       def log_warning
-        if @prev_warning_time == nil || @prev_warning_time < AdaptiveAlias.log_interval.ago
+        if @prev_warning_time == nil || @prev_warning_time < Time.now - AdaptiveAlias.log_interval
           @prev_warning_time = Time.now
           AdaptiveAlias.unexpected_old_column_proc&.call
         end
@@ -65,11 +92,15 @@ module AdaptiveAlias
 
       def remove!
         @removed = true
-        @klass.send(:reload_schema_from_cache)
-        @klass.initialize_find_by_cache
+        @klass.reset_column_information
+        @klass.columns_hash
         @fix_association = nil
         @fix_missing_attribute = nil
       end
+
+      def mark_removable
+        @removable = true
+      end
     end
   end
 end

data/lib/adaptive_alias/patches/forward_patch.rb

@@ -14,7 +14,8 @@ module AdaptiveAlias
       def remove!
         super
         @klass.remove_alias_attribute(@new_column)
-        BackPatch.new(@klass, @old_column, @new_column).apply!
+        @klass.define_attribute_method(@new_column)
+        BackwardPatch.new(@klass, @old_column, @new_column).apply!
       end
     end
   end

data/lib/adaptive_alias/version.rb

@@ -1,3 +1,3 @@
 module AdaptiveAlias
-  VERSION = '0.0.1'
+  VERSION = '0.1.0'
 end

data/lib/adaptive_alias.rb

@@ -1,65 +1,78 @@
-# frozen_string_literal: true
-
-require 'adaptive_alias/version'
-require 'adaptive_alias/active_model_patches/read_attribute'
-require 'adaptive_alias/active_model_patches/remove_alias_attribute'
-require 'adaptive_alias/patches/back_patch'
-require 'adaptive_alias/patches/forward_patch'
-
-require 'adaptive_alias/hooks/association'
-require 'adaptive_alias/hooks/association_scope'
-require 'adaptive_alias/hooks/singular_association'
-require 'adaptive_alias/hooks/relation'
-
-module AdaptiveAlias
-  @log_interval = 10 * 60
-  @current_patches = {}
-  @model_modules ||= {}
-
-  class << self
-    attr_accessor :unexpected_old_column_proc
-    attr_accessor :log_interval
-    attr_accessor :current_patches
-  end
-
-  class << self
-    def [](old_column, new_column)
-      old_column = old_column.to_sym
-      new_column = new_column.to_sym
-
-      Module.new do
-        extend ActiveSupport::Concern
-
-        included do
-          if column_names.include?(new_column)
-            Patches::BackPatch.new(self, old_column, new_column).apply!
-          else
-            Patches::ForwardPatch.new(self, old_column, new_column).apply!
-          end
-        end
-      end
-    end
-
-    def rescue_statement_invalid(relation)
-      yield
-    rescue ActiveRecord::StatementInvalid => error
-      raise error if AdaptiveAlias.current_patches.all?{|_key, patch| !patch.fix_association.call(relation, error) }
-      retry
-    end
-
-    def rescue_missing_attribute
-      yield
-    rescue ActiveModel::MissingAttributeError => error
-      raise error if AdaptiveAlias.current_patches.all?{|_key, patch| !patch.fix_missing_attribute.call }
-      retry
-    end
-
-    def get_or_create_model_module(klass)
-      return @model_modules[klass] if @model_modules[klass]
-
-      @model_modules[klass] = Module.new
-      klass.prepend(@model_modules[klass])
-      return @model_modules[klass]
-    end
-  end
-end
+# frozen_string_literal: true
+
+require 'adaptive_alias/version'
+require 'adaptive_alias/active_model_patches/read_attribute'
+require 'adaptive_alias/active_model_patches/write_attribute'
+require 'adaptive_alias/active_model_patches/remove_alias_attribute'
+require 'adaptive_alias/patches/backward_patch'
+require 'adaptive_alias/patches/forward_patch'
+
+require 'adaptive_alias/hooks/association'
+require 'adaptive_alias/hooks/association_scope'
+require 'adaptive_alias/hooks/singular_association'
+require 'adaptive_alias/hooks/relation'
+
+module AdaptiveAlias
+  @log_interval = 10 * 60
+  @current_patches = {}
+  @model_modules ||= {}
+
+  class << self
+    attr_accessor :unexpected_old_column_proc
+    attr_accessor :log_interval
+    attr_accessor :current_patches
+  end
+
+  class << self
+    def [](old_column, new_column)
+      old_column = old_column.to_sym
+      new_column = new_column.to_sym
+
+      Module.new do
+        extend ActiveSupport::Concern
+
+        included do
+          patch = (column_names.include?(new_column) ? Patches::BackwardPatch : Patches::ForwardPatch).new(self, old_column, new_column)
+          patch.apply!
+          patch.mark_removable
+        end
+      end
+    end
+
+    def rescue_statement_invalid(relation, &block)
+      yield
+    rescue ActiveRecord::StatementInvalid => error
+      raise error if AdaptiveAlias.current_patches.all?{|_key, patch| !patch.fix_association.call(relation, error) }
+
+      result = rescue_statement_invalid(relation, &block)
+      AdaptiveAlias.current_patches.each_value(&:mark_removable)
+      return result
+    end
+
+    def rescue_missing_attribute(klass, &block)
+      yield
+    rescue ActiveModel::MissingAttributeError => error
+      raise error if AdaptiveAlias.current_patches.all?{|_key, patch| !patch.fix_missing_attribute.call(klass, error) }
+
+      result = rescue_missing_attribute(klass, &block)
+      AdaptiveAlias.current_patches.each_value(&:mark_removable)
+      return result
+    end
+
+    def get_or_create_model_module(klass)
+      return @model_modules[klass] if @model_modules[klass]
+
+      @model_modules[klass] = Module.new
+      klass.prepend(@model_modules[klass])
+      return @model_modules[klass]
+    end
+
+    def missing_value?(attributes, klass, name)
+      return false if attributes.key?(name)
+
+      old_name = klass.attribute_aliases.key(name)
+      return false if old_name == nil
+      return !!AdaptiveAlias.current_patches[[klass, old_name.to_sym, name.to_sym]]
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: adaptive_alias
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - khiav reoy
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-07-22 00:00:00.000000000 Z
+date: 2022-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -73,19 +73,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: backports
+  name: rails_compatibility
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.15.0
+        version: 0.0.8
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.15.0
+        version: 0.0.8
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -100,20 +100,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3'
-- !ruby/object:Gem::Dependency
-  name: rails_compatibility
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.0.8
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.0.8
 description: Extend attribute_alias and make it be adaptive with realtime database
   schema
 email:
@@ -139,11 +125,12 @@ files:
 - lib/adaptive_alias.rb
 - lib/adaptive_alias/active_model_patches/read_attribute.rb
 - lib/adaptive_alias/active_model_patches/remove_alias_attribute.rb
+- lib/adaptive_alias/active_model_patches/write_attribute.rb
 - lib/adaptive_alias/hooks/association.rb
 - lib/adaptive_alias/hooks/association_scope.rb
 - lib/adaptive_alias/hooks/relation.rb
 - lib/adaptive_alias/hooks/singular_association.rb
-- lib/adaptive_alias/patches/back_patch.rb
+- lib/adaptive_alias/patches/backward_patch.rb
 - lib/adaptive_alias/patches/base.rb
 - lib/adaptive_alias/patches/forward_patch.rb
 - lib/adaptive_alias/version.rb