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 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374
|
require 'flipper/errors'
require 'flipper/type'
require 'flipper/gate'
require 'flipper/feature_check_context'
require 'flipper/gate_values'
require 'flipper/instrumenters/noop'
module Flipper
# rubocop:disable Metrics/ClassLength
class Feature
# Private: The name of feature instrumentation events.
InstrumentationName = "feature_operation.#{InstrumentationNamespace}".freeze
# Public: The name of the feature.
attr_reader :name
# Public: Name converted to value safe for adapter.
attr_reader :key
# Private: The adapter this feature should use.
attr_reader :adapter
# Private: What is being used to instrument all the things.
attr_reader :instrumenter
# Internal: Initializes a new feature instance.
#
# name - The Symbol or String name of the feature.
# adapter - The adapter that will be used to store details about this feature.
#
# options - The Hash of options.
# :instrumenter - What to use to instrument all the things.
#
def initialize(name, adapter, options = {})
@name = name
@key = name.to_s
@instrumenter = options.fetch(:instrumenter, Instrumenters::Noop)
@adapter = adapter
end
# Public: Enable this feature for something.
#
# Returns the result of Adapter#enable.
def enable(thing = true)
instrument(:enable) do |payload|
adapter.add self
gate = gate_for(thing)
wrapped_thing = gate.wrap(thing)
payload[:gate_name] = gate.name
payload[:thing] = wrapped_thing
adapter.enable self, gate, wrapped_thing
end
end
# Public: Disable this feature for something.
#
# Returns the result of Adapter#disable.
def disable(thing = false)
instrument(:disable) do |payload|
adapter.add self
gate = gate_for(thing)
wrapped_thing = gate.wrap(thing)
payload[:gate_name] = gate.name
payload[:thing] = wrapped_thing
adapter.disable self, gate, wrapped_thing
end
end
# Public: Adds this feature.
#
# Returns the result of Adapter#add.
def add
instrument(:add) { adapter.add(self) }
end
# Public: Removes this feature.
#
# Returns the result of Adapter#remove.
def remove
instrument(:remove) { adapter.remove(self) }
end
# Public: Clears all gate values for this feature.
#
# Returns the result of Adapter#clear.
def clear
instrument(:clear) { adapter.clear(self) }
end
# Public: Check if a feature is enabled for a thing.
#
# Returns true if enabled, false if not.
def enabled?(thing = nil)
instrument(:enabled?) do |payload|
values = gate_values
thing = gate(:actor).wrap(thing) unless thing.nil?
payload[:thing] = thing
context = FeatureCheckContext.new(
feature_name: @name,
values: values,
thing: thing
)
if open_gate = gates.detect { |gate| gate.open?(context) }
payload[:gate_name] = open_gate.name
true
else
false
end
end
end
# Public: Enables a feature for an actor.
#
# actor - a Flipper::Types::Actor instance or an object that responds
# to flipper_id.
#
# Returns result of enable.
def enable_actor(actor)
enable Types::Actor.wrap(actor)
end
# Public: Enables a feature for a group.
#
# group - a Flipper::Types::Group instance or a String or Symbol name of a
# registered group.
#
# Returns result of enable.
def enable_group(group)
enable Types::Group.wrap(group)
end
# Public: Enables a feature a percentage of time.
#
# percentage - a Flipper::Types::PercentageOfTime instance or an object that
# responds to to_i.
#
# Returns result of enable.
def enable_percentage_of_time(percentage)
enable Types::PercentageOfTime.wrap(percentage)
end
# Public: Enables a feature for a percentage of actors.
#
# percentage - a Flipper::Types::PercentageOfTime instance or an object that
# responds to to_i.
#
# Returns result of enable.
def enable_percentage_of_actors(percentage)
enable Types::PercentageOfActors.wrap(percentage)
end
# Public: Disables a feature for an actor.
#
# actor - a Flipper::Types::Actor instance or an object that responds
# to flipper_id.
#
# Returns result of disable.
def disable_actor(actor)
disable Types::Actor.wrap(actor)
end
# Public: Disables a feature for a group.
#
# group - a Flipper::Types::Group instance or a String or Symbol name of a
# registered group.
#
# Returns result of disable.
def disable_group(group)
disable Types::Group.wrap(group)
end
# Public: Disables a feature a percentage of time.
#
# percentage - a Flipper::Types::PercentageOfTime instance or an object that
# responds to to_i.
#
# Returns result of disable.
def disable_percentage_of_time
disable Types::PercentageOfTime.new(0)
end
# Public: Disables a feature for a percentage of actors.
#
# percentage - a Flipper::Types::PercentageOfTime instance or an object that
# responds to to_i.
#
# Returns result of disable.
def disable_percentage_of_actors
disable Types::PercentageOfActors.new(0)
end
# Public: Returns state for feature (:on, :off, or :conditional).
def state
values = gate_values
boolean = gate(:boolean)
non_boolean_gates = gates - [boolean]
if values.boolean || values.percentage_of_actors == 100 || values.percentage_of_time == 100
:on
elsif non_boolean_gates.detect { |gate| gate.enabled?(values[gate.key]) }
:conditional
else
:off
end
end
# Public: Is the feature fully enabled.
def on?
state == :on
end
# Public: Is the feature fully disabled.
def off?
state == :off
end
# Public: Is the feature conditionally enabled for a given actor, group,
# percentage of actors or percentage of the time.
def conditional?
state == :conditional
end
# Public: Returns the raw gate values stored by the adapter.
def gate_values
GateValues.new(adapter.get(self))
end
# Public: Get groups enabled for this feature.
#
# Returns Set of Flipper::Types::Group instances.
def enabled_groups
groups_value.map { |name| Flipper.group(name) }.to_set
end
alias_method :groups, :enabled_groups
# Public: Get groups not enabled for this feature.
#
# Returns Set of Flipper::Types::Group instances.
def disabled_groups
Flipper.groups - enabled_groups
end
# Public: Get the adapter value for the groups gate.
#
# Returns Set of String group names.
def groups_value
gate_values.groups
end
# Public: Get the adapter value for the actors gate.
#
# Returns Set of String flipper_id's.
def actors_value
gate_values.actors
end
# Public: Get the adapter value for the boolean gate.
#
# Returns true or false.
def boolean_value
gate_values.boolean
end
# Public: Get the adapter value for the percentage of actors gate.
#
# Returns Integer greater than or equal to 0 and less than or equal to 100.
def percentage_of_actors_value
gate_values.percentage_of_actors
end
# Public: Get the adapter value for the percentage of time gate.
#
# Returns Integer greater than or equal to 0 and less than or equal to 100.
def percentage_of_time_value
gate_values.percentage_of_time
end
# Public: Get the gates that have been enabled for the feature.
#
# Returns an Array of Flipper::Gate instances.
def enabled_gates
values = gate_values
gates.select { |gate| gate.enabled?(values[gate.key]) }
end
# Public: Get the names of the enabled gates.
#
# Returns an Array of gate names.
def enabled_gate_names
enabled_gates.map(&:name)
end
# Public: Get the gates that have not been enabled for the feature.
#
# Returns an Array of Flipper::Gate instances.
def disabled_gates
gates - enabled_gates
end
# Public: Get the names of the disabled gates.
#
# Returns an Array of gate names.
def disabled_gate_names
disabled_gates.map(&:name)
end
# Public: Returns the string representation of the feature.
def to_s
name.to_s
end
# Public: Identifier to be used in the url (a rails-ism).
def to_param
to_s
end
# Public: Pretty string version for debugging.
def inspect
attributes = [
"name=#{name.inspect}",
"state=#{state.inspect}",
"enabled_gate_names=#{enabled_gate_names.inspect}",
"adapter=#{adapter.name.inspect}",
]
"#<#{self.class.name}:#{object_id} #{attributes.join(', ')}>"
end
# Public: Get all the gates used to determine enabled/disabled for the feature.
#
# Returns an array of gates
def gates
@gates ||= [
Gates::Boolean.new,
Gates::Group.new,
Gates::Actor.new,
Gates::PercentageOfActors.new,
Gates::PercentageOfTime.new,
]
end
# Public: Find a gate by name.
#
# Returns a Flipper::Gate if found, nil if not.
def gate(name)
gates.detect { |gate| gate.name == name.to_sym }
end
# Public: Find the gate that protects a thing.
#
# thing - The object for which you would like to find a gate
#
# Returns a Flipper::Gate.
# Raises Flipper::GateNotFound if no gate found for thing
def gate_for(thing)
gates.detect { |gate| gate.protects?(thing) } || raise(GateNotFound, thing)
end
private
# Private: Instrument a feature operation.
def instrument(operation)
@instrumenter.instrument(InstrumentationName) do |payload|
payload[:feature_name] = name
payload[:operation] = operation
payload[:result] = yield(payload) if block_given?
end
end
end
end
|