debian-mirror-gitlab/lib/gitlab/utils/strong_memoize.rb

121 lines
3.2 KiB
Ruby
Raw Normal View History

2019-02-15 15:39:39 +05:30
# frozen_string_literal: true
2018-03-17 18:26:18 +05:30
module Gitlab
module Utils
module StrongMemoize
# Instead of writing patterns like this:
#
# def trigger_from_token
# return @trigger if defined?(@trigger)
#
# @trigger = Ci::Trigger.find_by_token(params[:token].to_s)
# end
#
# We could write it like:
#
# include Gitlab::Utils::StrongMemoize
#
# def trigger_from_token
# strong_memoize(:trigger) do
# Ci::Trigger.find_by_token(params[:token].to_s)
# end
# end
#
2022-08-27 11:52:29 +05:30
# Or like:
#
# include Gitlab::Utils::StrongMemoize
#
# def trigger_from_token
# Ci::Trigger.find_by_token(params[:token].to_s)
# end
# strong_memoize_attr :trigger_from_token
#
# def enabled?
# Feature.enabled?(:some_feature)
# end
2023-01-13 00:05:48 +05:30
# strong_memoize_attr :enabled?, :enabled
2022-08-27 11:52:29 +05:30
#
2018-03-17 18:26:18 +05:30
def strong_memoize(name)
2022-05-07 20:08:51 +05:30
key = ivar(name)
if instance_variable_defined?(key)
instance_variable_get(key)
2018-03-17 18:26:18 +05:30
else
2022-05-07 20:08:51 +05:30
instance_variable_set(key, yield)
2018-03-17 18:26:18 +05:30
end
end
2023-01-13 00:05:48 +05:30
def strong_memoize_with(name, *args)
container = strong_memoize(name) { {} }
if container.key?(args)
container[args]
else
container[args] = yield
end
end
2019-12-04 20:38:33 +05:30
def strong_memoized?(name)
instance_variable_defined?(ivar(name))
end
2018-03-17 18:26:18 +05:30
def clear_memoization(name)
2022-05-07 20:08:51 +05:30
key = ivar(name)
remove_instance_variable(key) if instance_variable_defined?(key)
2018-03-17 18:26:18 +05:30
end
2022-08-27 11:52:29 +05:30
module StrongMemoizeClassMethods
def strong_memoize_attr(method_name, member_name = nil)
member_name ||= method_name
2023-01-13 00:05:48 +05:30
StrongMemoize.send( # rubocop:disable GitlabSecurity/PublicSend
:do_strong_memoize, self, method_name, member_name)
2022-08-27 11:52:29 +05:30
end
end
def self.included(base)
base.singleton_class.prepend(StrongMemoizeClassMethods)
end
2018-03-17 18:26:18 +05:30
private
2022-05-07 20:08:51 +05:30
# Convert `"name"`/`:name` into `:@name`
#
# Depending on a type ensure that there's a single memory allocation
2018-03-17 18:26:18 +05:30
def ivar(name)
2023-01-13 00:05:48 +05:30
case name
when Symbol
2022-05-07 20:08:51 +05:30
name.to_s.prepend("@").to_sym
2023-01-13 00:05:48 +05:30
when String
2022-05-07 20:08:51 +05:30
:"@#{name}"
else
raise ArgumentError, "Invalid type of '#{name}'"
end
2018-03-17 18:26:18 +05:30
end
2022-08-27 11:52:29 +05:30
class <<self
private
def do_strong_memoize(klass, method_name, member_name)
method = klass.instance_method(method_name)
# Methods defined within a class method are already public by default, so we don't need to
# explicitly make them public.
scope = %i[private protected].find do |scope|
klass.send("#{scope}_instance_methods") # rubocop:disable GitlabSecurity/PublicSend
.include? method_name
end
klass.define_method(method_name) do |*args, &block|
strong_memoize(member_name) do
method.bind_call(self, *args, &block)
end
end
klass.send(scope, method_name) if scope # rubocop:disable GitlabSecurity/PublicSend
end
end
2018-03-17 18:26:18 +05:30
end
end
end