adaptive_alias 0.0.1

data/CHANGELOG.md

@@ -0,0 +1 @@
+## Change Log

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at mrtmrt15xn@yahoo.com.tw. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Rumble Huang
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,46 @@
+# adaptive_alias
+
+[![Gem Version](https://img.shields.io/gem/v/adaptive_alias.svg?style=flat)](http://rubygems.org/gems/adaptive_alias)
+[![Build Status](https://github.com/khiav223577/adaptive_alias/workflows/Ruby/badge.svg)](https://github.com/khiav223577/adaptive_alias/actions)
+[![RubyGems](http://img.shields.io/gem/dt/adaptive_alias.svg?style=flat)](http://rubygems.org/gems/adaptive_alias)
+[![Code Climate](https://codeclimate.com/github/khiav223577/adaptive_alias/badges/gpa.svg)](https://codeclimate.com/github/khiav223577/adaptive_alias)
+[![Test Coverage](https://codeclimate.com/github/khiav223577/adaptive_alias/badges/coverage.svg)](https://codeclimate.com/github/khiav223577/adaptive_alias/coverage)
+
+Extend attribute_alias and make it be adaptive with realtime database schema.
+
+## Supports
+- Ruby 2.6 ~ 2.7, 3.0 ~ 3.1
+- Rails 6.0, 6.1, 7.0
+
+## Installation
+
+```ruby
+gem 'adaptive_alias'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install adaptive_alias
+
+## Usage
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/khiav223577/adaptive_alias. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/adaptive_alias.gemspec

@@ -0,0 +1,45 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'adaptive_alias/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'adaptive_alias'
+  spec.version       = AdaptiveAlias::VERSION
+  spec.authors       = ['khiav reoy']
+  spec.email         = ['mrtmrt15xn@yahoo.com.tw']
+
+  spec.summary       = 'Extend attribute_alias and make it be adaptive with realtime database schema'
+  spec.description   = 'Extend attribute_alias and make it be adaptive with realtime database schema'
+  spec.homepage      = 'https://github.com/khiav223577/adaptive_alias'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  # if spec.respond_to?(:metadata)
+  #  spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #  raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject{|f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}){|f| File.basename(f) }
+  spec.require_paths = ['lib']
+  spec.metadata      = {
+    'homepage_uri'      => 'https://github.com/khiav223577/adaptive_alias',
+    'changelog_uri'     => 'https://github.com/khiav223577/adaptive_alias/blob/master/CHANGELOG.md',
+    'source_code_uri'   => 'https://github.com/khiav223577/adaptive_alias',
+    'documentation_uri' => 'https://www.rubydoc.info/gems/adaptive_alias',
+    'bug_tracker_uri'   => 'https://github.com/khiav223577/adaptive_alias/issues',
+  }
+
+  spec.add_development_dependency 'bundler', '>= 1.17', '< 3.x'
+  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_dependency 'activerecord', '>= 3'
+  spec.add_dependency 'rails_compatibility', '>= 0.0.8'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'adaptive_alias'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install --gemfile=gemfiles/4.2.gemfile
+
+# Do any other automated setup that you need to do here

data/gemfiles/6.0.gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+gem 'activerecord', '~> 6.0.0'
+
+group :test do
+  gem 'simplecov', '< 0.18'
+  gem 'mysql2', '0.5.3'
+end
+
+gemspec path: '../'

data/gemfiles/6.1.gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+gem 'activerecord', '~> 6.1.3'
+
+group :test do
+  gem 'simplecov', '< 0.18'
+  gem 'mysql2', '0.5.3'
+end
+
+gemspec path: '../'

data/gemfiles/7.0.gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+gem 'zeitwerk'
+gem 'activerecord', '~> 7.0.0'
+
+group :test do
+  gem 'simplecov', '< 0.18'
+  gem 'mysql2', '0.5.3'
+end
+
+gemspec path: '../'

data/lib/adaptive_alias/active_model_patches/read_attribute.rb

@@ -0,0 +1,20 @@
+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
+
+    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
+
+    sync_with_transaction_state if @transaction_state&.finalized?
+    return yield if block_given? && !@attributes.key?(name)
+    @attributes.fetch_value(name, &block)
+  end
+end

data/lib/adaptive_alias/active_model_patches/remove_alias_attribute.rb

@@ -0,0 +1,27 @@
+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
+
+    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|
+        matcher_new = matcher.method_name(new_name).to_s
+        remove_proxy_call self, matcher_new
+      end
+    end
+  end
+end

data/lib/adaptive_alias/hooks/association.rb

@@ -0,0 +1,13 @@
+module AdaptiveAlias
+  module Hooks
+    module Association
+      def find_target(*)
+        AdaptiveAlias.rescue_statement_invalid(nil){ super }
+      end
+    end
+  end
+end
+
+class ActiveRecord::Associations::Association
+  prepend AdaptiveAlias::Hooks::Association
+end

data/lib/adaptive_alias/hooks/association_scope.rb

@@ -0,0 +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

data/lib/adaptive_alias/hooks/relation.rb

@@ -0,0 +1,21 @@
+module AdaptiveAlias
+  module Hooks
+    module Relation
+      def pluck(*)
+        AdaptiveAlias.rescue_statement_invalid(self){ super }
+      end
+
+      def select_all(*)
+        AdaptiveAlias.rescue_statement_invalid(self){ super }
+      end
+
+      def exec_queries(*)
+        AdaptiveAlias.rescue_statement_invalid(self){ super }
+      end
+    end
+  end
+end
+
+class ActiveRecord::Relation
+  prepend AdaptiveAlias::Hooks::Relation
+end

data/lib/adaptive_alias/hooks/singular_association.rb

@@ -0,0 +1,13 @@
+module AdaptiveAlias
+  module Hooks
+    module SingularAssociation
+      def reader(*)
+        AdaptiveAlias.rescue_missing_attribute{ super }
+      end
+    end
+  end
+end
+
+class ActiveRecord::Associations::SingularAssociation
+  prepend AdaptiveAlias::Hooks::SingularAssociation
+end

data/lib/adaptive_alias/patches/back_patch.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'adaptive_alias/patches/base'
+
+module AdaptiveAlias
+  module Patches
+    class BackPatch < Base
+      def apply!
+        AdaptiveAlias.current_patches[[@klass, @old_column, @new_column]] = self
+        @klass.alias_attribute(@old_column, @new_column)
+        add_hooks!(current_column: @new_column, alias_column: @old_column, log_warning: true)
+      end
+
+      def remove!
+        super
+        @klass.remove_alias_attribute(@old_column)
+        ForwardPatch.new(@klass, @old_column, @new_column).apply!
+      end
+    end
+  end
+end

data/lib/adaptive_alias/patches/base.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module AdaptiveAlias
+  module Patches
+    class Base
+      attr_reader :fix_association
+      attr_reader :fix_missing_attribute
+      attr_reader :removed
+
+      def initialize(klass, old_column, new_column)
+        @klass = klass
+        @old_column = old_column
+        @new_column = new_column
+      end
+
+      def add_hooks!(current_column:, alias_column:, log_warning: false)
+        patch = self
+        old_column = @old_column
+        new_column = @new_column
+
+        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] }
+          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] }
+          end
+        end
+
+        expected_error_message = "Mysql2::Error: Unknown column '#{@klass.table_name}.#{current_column}' in 'where clause'".freeze
+
+        @fix_missing_attribute = proc do
+          next false if patch.removed
+
+          patch.remove!
+          next true
+        end
+
+        @fix_association = proc do |target, error|
+          next false if patch.removed || error.message != expected_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)
+          end
+
+          next true
+        end
+      end
+
+      def log_warning
+        if @prev_warning_time == nil || @prev_warning_time < AdaptiveAlias.log_interval.ago
+          @prev_warning_time = Time.now
+          AdaptiveAlias.unexpected_old_column_proc&.call
+        end
+      end
+
+      def remove!
+        @removed = true
+        @klass.send(:reload_schema_from_cache)
+        @klass.initialize_find_by_cache
+        @fix_association = nil
+        @fix_missing_attribute = nil
+      end
+    end
+  end
+end

data/lib/adaptive_alias/patches/forward_patch.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'adaptive_alias/patches/base'
+
+module AdaptiveAlias
+  module Patches
+    class ForwardPatch < Base
+      def apply!
+        AdaptiveAlias.current_patches[[@klass, @old_column, @new_column]] = self
+        @klass.alias_attribute(@new_column, @old_column)
+        add_hooks!(current_column: @old_column, alias_column: @new_column)
+      end
+
+      def remove!
+        super
+        @klass.remove_alias_attribute(@new_column)
+        BackPatch.new(@klass, @old_column, @new_column).apply!
+      end
+    end
+  end
+end

data/lib/adaptive_alias/version.rb

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

data/lib/adaptive_alias.rb

@@ -0,0 +1,65 @@
+# 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