-
Notifications
You must be signed in to change notification settings - Fork 1.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[#432][#403][#433][#422] Fix checking for column cache until db connects #438
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,41 +1,69 @@ | ||
module ActsAsTaggableOn::Taggable | ||
module Cache | ||
def self.included(base) | ||
# Skip adding caching capabilities if table not exists or no cache columns exist | ||
return unless base.connected? && base.table_exists? && base.tag_types.any? { |context| base.column_names.include?("cached_#{context.to_s.singularize}_list") } | ||
|
||
base.send :include, ActsAsTaggableOn::Taggable::Cache::InstanceMethods | ||
base.extend ActsAsTaggableOn::Taggable::Cache::ClassMethods | ||
|
||
base.class_eval do | ||
before_save :save_cached_tag_list | ||
# When included, conditionally adds tag caching methods when the model | ||
# has any "cached_#{tag_type}_list" column | ||
base.instance_eval do | ||
# @private | ||
def _has_acts_as_taggable_on_cache_columns?(db_columns) | ||
db_column_names = db_columns.map(&:name) | ||
tag_types.any? {|context| | ||
db_column_names.include?("cached_#{context.to_s.singularize}_list") | ||
} | ||
end | ||
|
||
# @private | ||
def _add_acts_as_taggable_on_caching_methods | ||
send :include, ActsAsTaggableOn::Taggable::Cache::InstanceMethods | ||
extend ActsAsTaggableOn::Taggable::Cache::ClassMethods | ||
|
||
before_save :save_cached_tag_list | ||
|
||
initialize_acts_as_taggable_on_cache | ||
end | ||
|
||
# ActiveRecord::Base.columns makes a database connection and caches the calculated | ||
# columns hash for the record as @columns. Since we don't want to add caching | ||
# methods until we confirm the presence of a caching column, and we don't | ||
# want to force opening a database connection when the class is loaded, | ||
# here we intercept and cache the call to :columns as @acts_as_taggable_on_columns | ||
# to mimic the underlying behavior. While processing this first call to columns, | ||
# we do the caching column check and dynamically add the class and instance methods | ||
def columns | ||
@acts_as_taggable_on_columns ||= begin | ||
db_columns = super | ||
if _has_acts_as_taggable_on_cache_columns?(db_columns) | ||
_add_acts_as_taggable_on_caching_methods | ||
end | ||
db_columns | ||
end | ||
end | ||
|
||
end | ||
|
||
base.initialize_acts_as_taggable_on_cache | ||
end | ||
|
||
module ClassMethods | ||
def initialize_acts_as_taggable_on_cache | ||
def initialize_acts_as_taggable_on_cache | ||
tag_types.map(&:to_s).each do |tag_type| | ||
class_eval <<-RUBY, __FILE__, __LINE__ + 1 | ||
def self.caching_#{tag_type.singularize}_list? | ||
caching_tag_list_on?("#{tag_type}") | ||
end | ||
end | ||
RUBY | ||
end | ||
end | ||
end | ||
|
||
def acts_as_taggable_on(*args) | ||
super(*args) | ||
initialize_acts_as_taggable_on_cache | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Hmm, looks like we're calling this method twice.. but that's existing behavior |
||
end | ||
|
||
def caching_tag_list_on?(context) | ||
column_names.include?("cached_#{context.to_s.singularize}_list") | ||
end | ||
end | ||
module InstanceMethods | ||
|
||
module InstanceMethods | ||
def save_cached_tag_list | ||
tag_types.map(&:to_s).each do |tag_type| | ||
if self.class.send("caching_#{tag_type.singularize}_list?") | ||
|
@@ -45,9 +73,10 @@ def save_cached_tag_list | |
end | ||
end | ||
end | ||
|
||
true | ||
end | ||
end | ||
|
||
end | ||
end |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The check for
table_exists?
should not be necessary here