1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217
|
require 'set'
require 'flipper'
require 'active_record'
module Flipper
module Adapters
class ActiveRecord
include ::Flipper::Adapter
# Private: Do not use outside of this adapter.
class Feature < ::ActiveRecord::Base
self.table_name = [
::ActiveRecord::Base.table_name_prefix,
"flipper_features",
::ActiveRecord::Base.table_name_suffix,
].join
end
# Private: Do not use outside of this adapter.
class Gate < ::ActiveRecord::Base
self.table_name = [
::ActiveRecord::Base.table_name_prefix,
"flipper_gates",
::ActiveRecord::Base.table_name_suffix,
].join
end
# Public: The name of the adapter.
attr_reader :name
# Public: Initialize a new ActiveRecord adapter instance.
#
# name - The Symbol name for this adapter. Optional (default :active_record)
# feature_class - The AR class responsible for the features table.
# gate_class - The AR class responsible for the gates table.
#
# Allowing the overriding of name is so you can differentiate multiple
# instances of this adapter from each other, if, for some reason, that is
# a thing you do.
#
# Allowing the overriding of the default feature/gate classes means you
# can roll your own tables and what not, if you so desire.
def initialize(options = {})
@name = options.fetch(:name, :active_record)
@feature_class = options.fetch(:feature_class) { Feature }
@gate_class = options.fetch(:gate_class) { Gate }
end
# Public: The set of known features.
def features
@feature_class.all.map(&:key).to_set
end
# Public: Adds a feature to the set of known features.
def add(feature)
# race condition, but add is only used by enable/disable which happen
# super rarely, so it shouldn't matter in practice
@feature_class.transaction do
unless @feature_class.where(key: feature.key).first
begin
@feature_class.create! { |f| f.key = feature.key }
rescue ActiveRecord::RecordNotUnique
end
end
end
true
end
# Public: Removes a feature from the set of known features.
def remove(feature)
@feature_class.transaction do
@feature_class.where(key: feature.key).destroy_all
clear(feature)
end
true
end
# Public: Clears the gate values for a feature.
def clear(feature)
@gate_class.where(feature_key: feature.key).destroy_all
true
end
# Public: Gets the values for all gates for a given feature.
#
# Returns a Hash of Flipper::Gate#key => value.
def get(feature)
db_gates = @gate_class.where(feature_key: feature.key)
result_for_feature(feature, db_gates)
end
def get_multi(features)
db_gates = @gate_class.where(feature_key: features.map(&:key))
grouped_db_gates = db_gates.group_by(&:feature_key)
result = {}
features.each do |feature|
result[feature.key] = result_for_feature(feature, grouped_db_gates[feature.key])
end
result
end
def get_all
rows = ::ActiveRecord::Base.connection.select_all <<-SQL.tr("\n", ' ')
SELECT ff.key AS feature_key, fg.key, fg.value
FROM #{@feature_class.table_name} ff
LEFT JOIN #{@gate_class.table_name} fg ON ff.key = fg.feature_key
SQL
db_gates = rows.map { |row| Gate.new(row) }
grouped_db_gates = db_gates.group_by(&:feature_key)
result = Hash.new { |hash, key| hash[key] = default_config }
features = grouped_db_gates.keys.map { |key| Flipper::Feature.new(key, self) }
features.each do |feature|
result[feature.key] = result_for_feature(feature, grouped_db_gates[feature.key])
end
result
end
# Public: Enables a gate for a given thing.
#
# feature - The Flipper::Feature for the gate.
# gate - The Flipper::Gate to disable.
# thing - The Flipper::Type being enabled for the gate.
#
# Returns true.
def enable(feature, gate, thing)
case gate.data_type
when :boolean, :integer
set(feature, gate, thing)
when :set
enable_multi(feature, gate, thing)
else
unsupported_data_type gate.data_type
end
true
end
# Public: Disables a gate for a given thing.
#
# feature - The Flipper::Feature for the gate.
# gate - The Flipper::Gate to disable.
# thing - The Flipper::Type being disabled for the gate.
#
# Returns true.
def disable(feature, gate, thing)
case gate.data_type
when :boolean
clear(feature)
when :integer
set(feature, gate, thing)
when :set
@gate_class.where(feature_key: feature.key, key: gate.key, value: thing.value).destroy_all
else
unsupported_data_type gate.data_type
end
true
end
# Private
def unsupported_data_type(data_type)
raise "#{data_type} is not supported by this adapter"
end
private
def set(feature, gate, thing)
@gate_class.transaction do
@gate_class.where(feature_key: feature.key, key: gate.key).destroy_all
@gate_class.create! do |g|
g.feature_key = feature.key
g.key = gate.key
g.value = thing.value.to_s
end
end
nil
end
def enable_multi(feature, gate, thing)
@gate_class.create! do |g|
g.feature_key = feature.key
g.key = gate.key
g.value = thing.value.to_s
end
nil
rescue ::ActiveRecord::RecordNotUnique
# already added so no need move on with life
end
def result_for_feature(feature, db_gates)
db_gates ||= []
result = {}
feature.gates.each do |gate|
result[gate.key] =
case gate.data_type
when :boolean
if detected_db_gate = db_gates.detect { |db_gate| db_gate.key == gate.key.to_s }
detected_db_gate.value
end
when :integer
if detected_db_gate = db_gates.detect { |db_gate| db_gate.key == gate.key.to_s }
detected_db_gate.value
end
when :set
db_gates.select { |db_gate| db_gate.key == gate.key.to_s }.map(&:value).to_set
else
unsupported_data_type gate.data_type
end
end
result
end
end
end
end
|