adaptive_alias 0.0.3 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 24cc5b94c147a0fdb9dd7a92598bfbb6c76c9bdc59dc23f827f57b3cc22098c0
-  data.tar.gz: 73c1f0a540da8acebaae0cb98a372ee0d8b162e77d574e01dab81a25f002760a
+  metadata.gz: 0375ca9867e41c41fe18b38cb1f37ff2a0067367304f6481250cd573c5dc5be4
+  data.tar.gz: bc0ebb4c4d63ea36e203b94f5c3ea0411c4fab408e93ea6c9dc0de5354c2db8c
 SHA512:
-  metadata.gz: fd166ed45adb2164fc4c6061908a8056b659dbd1fa744e28085ecf132efd7004056f32ac68b654fee7525707c971ca9f45233dffad4b67241f97e33bd9b62c4c
-  data.tar.gz: 0b6ae8bd8b5dce5468e2ef51c607e74a9971be52378d08f27c3f7717993eded6ada7d0a676c8f0127c051a09f8f590eb64e1ea0271600f296745e96528fc9238
+  metadata.gz: f0d5f519ab910bcf93c982f2ea6ca9c3e944ea0e90a07d6e938668b4575d450d6d019a60b62dd2020c373434e8ece4f7c1d9ea148ca269a4823718b80f8a8c07
+  data.tar.gz: 9a699915af111f6e01aa6fac45a888583a629b1f6eb0d75c84a15188f329e3f34401a330a6ee33040453b4e9f2d6a018bca61626e0784944004832c3db6d6bc3

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,5 +1,22 @@
 ## Change Log
 
+### [v0.2.0](https://github.com/khiav223577/adaptive_alias/compare/v0.1.0...v0.2.0) 2022/08/05
+- [#11](https://github.com/khiav223577/adaptive_alias/pull/11) [Feature] Support polymorphic (@khiav223577)
+- [#10](https://github.com/khiav223577/adaptive_alias/pull/10) [Enhance] Prevent adding methods directly in class / module (@khiav223577)
+- [#9](https://github.com/khiav223577/adaptive_alias/pull/9) [Enhance] Prevent changing original order of where conditions (@khiav223577)
+- [#8](https://github.com/khiav223577/adaptive_alias/pull/8) [Test] Make sure we are reset to use original patch when some test cases fail (@khiav223577)
+- [#7](https://github.com/khiav223577/adaptive_alias/pull/7) [Test] Add test cases to test destroy (@khiav223577)
+
+### [v0.1.0](https://github.com/khiav223577/adaptive_alias/compare/v0.0.3...v0.1.0) 2022/08/01
+- [#6](https://github.com/khiav223577/adaptive_alias/pull/6) [Feature] Deal with creating records (@khiav223577)
+- [#5](https://github.com/khiav223577/adaptive_alias/pull/5) [Enhance] Prevent infinite loop if something went wrong (@khiav223577)
+- [#4](https://github.com/khiav223577/adaptive_alias/pull/4) [Fix] Attributes writer method should be defined after schema changes (@khiav223577)
+
+### [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)
-- [#1](https://github.com/khiav223577/adaptive_alias/pull/1) Implement adaptive_alias features (@khiav223577)
+- [#2](https://github.com/khiav223577/adaptive_alias/pull/2) [Enhance] Doesn't need rails_compatibility in runtime (@khiav223577)
+
+### v0.0.1 2022/07/22
+- [#1](https://github.com/khiav223577/adaptive_alias/pull/1) [Feature] Implement adaptive_alias features (@khiav223577)

data/lib/adaptive_alias/active_model_patches/apply_scope.rb

@@ -0,0 +1,17 @@
+require 'active_record'
+
+module AdaptiveAlias
+  module ActiveModelPatches
+    module ApplyScope
+      def apply_scope(scope, table, key, value)
+        klass = table.instance_variable_get(:@klass) || table.send(:type_caster).send(:types)
+        key = klass.attribute_aliases[key] || key
+        super(scope, table, key, value)
+      end
+    end
+  end
+end
+
+class ActiveRecord::Associations::AssociationScope
+  prepend AdaptiveAlias::ActiveModelPatches::ApplyScope
+end

data/lib/adaptive_alias/active_model_patches/read_attribute.rb

@@ -1,20 +1,31 @@
 require 'active_record'
 
-module ActiveRecord::AttributeMethods::Read
-  def read_attribute(attr_name, &block) # :nodoc:
-    name = attr_name.to_s
-    name = self.class.attribute_aliases[name] || name
+module AdaptiveAlias
+  module ActiveModelPatches
+    module ReadAttribute
+      def read_attribute(attr_name, &block) # :nodoc:
+        name = attr_name.to_s
+        name = self.class.attribute_aliases[name] || name
 
-    name = @primary_key if name == 'id' && @primary_key
-    _read_attribute(name, &block)
-  end
+        name = @primary_key if name == 'id' && @primary_key
+        _read_attribute(name, &block)
+      end
 
-  def _read_attribute(attr_name, &block) # :nodoc:
-    name = attr_name.to_s
-    name = self.class.attribute_aliases[name] || name
+      # 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? and AdaptiveAlias.missing_value?(@attributes, self.class, name)
-    return @attributes.fetch_value(name, &block)
+        sync_with_transaction_state if @transaction_state&.finalized?
+        return yield(name) if block_given? and AdaptiveAlias.missing_value?(@attributes, self.class, name)
+        return @attributes.fetch_value(name, &block)
+      end
+    end
   end
 end
+
+# Nested module include is not supported until ruby 3.0
+class ActiveRecord::Base
+  prepend AdaptiveAlias::ActiveModelPatches::ReadAttribute
+end

data/lib/adaptive_alias/active_model_patches/remove_alias_attribute.rb

@@ -1,27 +1,31 @@
 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
-    end
+module AdaptiveAlias
+  module ActiveModelPatches
+    module RemoveAliasAttribute
+      def remove_proxy_call(mod, name)
+        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)
+      def remove_alias_attribute(new_name)
+        self.attribute_aliases = attribute_aliases.except(new_name.to_s)
 
-      attribute_method_matchers.each do |matcher|
-        matcher_new = matcher.method_name(new_name).to_s
-        remove_proxy_call self, matcher_new
+        attribute_method_matchers.each do |matcher|
+          matcher_new = matcher.method_name(new_name).to_s
+          remove_proxy_call self, matcher_new
+        end
       end
     end
   end
 end
+
+# Nested module include is not supported until ruby 3.0
+if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('3')
+  AdaptiveAlias::ActiveModelPatches::RemoveAliasAttribute.instance_methods.each do |method|
+    ActiveModel::AttributeMethods::ClassMethods.define_method(method, AdaptiveAlias::ActiveModelPatches::RemoveAliasAttribute.instance_method(method))
+  end
+else
+  module ActiveModel::AttributeMethods::ClassMethods
+    include AdaptiveAlias::ActiveModelPatches::RemoveAliasAttribute
+  end
+end

data/lib/adaptive_alias/active_model_patches/write_attribute.rb

@@ -0,0 +1,25 @@
+require 'active_record'
+
+module AdaptiveAlias
+  module ActiveModelPatches
+    module WriteAttribute
+      def write_attribute(attr_name, value)
+        name = attr_name.to_s
+        name = self.class.attribute_aliases[name] || name
+        super(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
+        super(name, value)
+      end
+    end
+  end
+end
+
+class ActiveRecord::Base
+  prepend AdaptiveAlias::ActiveModelPatches::WriteAttribute
+end

data/lib/adaptive_alias/hooks/association.rb

@@ -2,7 +2,11 @@ module AdaptiveAlias
   module Hooks
     module Association
       def find_target(*)
-        AdaptiveAlias.rescue_statement_invalid(nil){ super }
+        AdaptiveAlias.rescue_statement_invalid(nil, reflection){ super }
+      end
+
+      def create!(attributes = {}, &block)
+        AdaptiveAlias.rescue_statement_invalid(association_scope, reflection){ super }
       end
     end
   end

data/lib/adaptive_alias/hooks/association_scope.rb

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

data/lib/adaptive_alias/hooks/relation.rb

@@ -2,15 +2,15 @@ module AdaptiveAlias
   module Hooks
     module Relation
       def pluck(*)
-        AdaptiveAlias.rescue_statement_invalid(self){ super }
+        AdaptiveAlias.rescue_statement_invalid(self, nil){ super }
       end
 
       def select_all(*)
-        AdaptiveAlias.rescue_statement_invalid(self){ super }
+        AdaptiveAlias.rescue_statement_invalid(self, nil){ super }
       end
 
       def exec_queries(*)
-        AdaptiveAlias.rescue_statement_invalid(self){ super }
+        AdaptiveAlias.rescue_statement_invalid(self, nil){ super }
       end
     end
   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/backward_patch.rb

@@ -14,7 +14,10 @@ module AdaptiveAlias
       def remove!
         super
         @klass.remove_alias_attribute(@old_column)
-        ForwardPatch.new(@klass, @old_column, @new_column).apply!
+        @klass.define_attribute_method(@old_column)
+        new_patch = ForwardPatch.new(@klass, @old_column, @new_column)
+        new_patch.apply!
+        return new_patch
       end
     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,49 +16,79 @@ 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
+
+        expected_attribute_err_msgs = [
+          "can't write unknown attribute `#{current_column}`".freeze,
+          "missing attribute: #{current_column}".freeze,
+        ].freeze
 
-        @fix_missing_attribute = proc do
+        @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
+        @fix_association = proc do |relation, reflection, error|
+          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)
-            target.instance_variable_set(:@arel, nil)
-            target.unscope!(:where).where!(hash)
+          if relation
+            relation.where_clause.send(:predicates).each do |node|
+              next if node.left.name != current_column.to_s
+              next if klass.table_name != node.left.relation.name
+
+              node.left = node.left.clone
+              node.left.name = alias_column.to_s
+            end
           end
 
+          reflection.clear_association_scope_cache if reflection
+
           next true
         end
       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 +96,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,10 @@ module AdaptiveAlias
       def remove!
         super
         @klass.remove_alias_attribute(@new_column)
-        BackwardPatch.new(@klass, @old_column, @new_column).apply!
+        @klass.define_attribute_method(@new_column)
+        new_patch = BackwardPatch.new(@klass, @old_column, @new_column)
+        new_patch.apply!
+        return new_patch
       end
     end
   end

data/lib/adaptive_alias/version.rb

@@ -1,3 +1,3 @@
 module AdaptiveAlias
-  VERSION = '0.0.3'
+  VERSION = '0.2.1'
 end

data/lib/adaptive_alias.rb

@@ -2,7 +2,9 @@
 
 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/active_model_patches/apply_scope'
 require 'adaptive_alias/patches/backward_patch'
 require 'adaptive_alias/patches/forward_patch'
 
@@ -31,27 +33,31 @@ module AdaptiveAlias
         extend ActiveSupport::Concern
 
         included do
-          if column_names.include?(new_column)
-            Patches::BackwardPatch.new(self, old_column, new_column).apply!
-          else
-            Patches::ForwardPatch.new(self, old_column, new_column).apply!
-          end
+          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)
+    def rescue_statement_invalid(relation, reflection, &block)
       yield
     rescue ActiveRecord::StatementInvalid => error
-      raise error if AdaptiveAlias.current_patches.all?{|_key, patch| !patch.fix_association.call(relation, error) }
-      retry
+      raise error if AdaptiveAlias.current_patches.all?{|_key, patch| !patch.fix_association.call(relation, reflection, error) }
+
+      result = rescue_statement_invalid(relation, reflection, &block)
+      AdaptiveAlias.current_patches.each_value(&:mark_removable)
+      return result
     end
 
-    def rescue_missing_attribute
+    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 }
-      retry
+      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)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: adaptive_alias
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.2.1
 platform: ruby
 authors:
 - khiav reoy
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-07-27 00:00:00.000000000 Z
+date: 2022-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -123,8 +123,10 @@ files:
 - gemfiles/6.1.gemfile
 - gemfiles/7.0.gemfile
 - lib/adaptive_alias.rb
+- lib/adaptive_alias/active_model_patches/apply_scope.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