Class: Determinator::Control

Inherits:
Object
  • Object
show all
Defined in:
lib/determinator/control.rb

Defined Under Namespace

Classes: Indicators

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(retrieval:) ⇒ Control

Returns a new instance of Control.



9
10
11
 
# File 'lib/determinator/control.rb', line 9

def initialize(retrieval:)
  @retrieval = retrieval
end

Instance Attribute Details

#retrieval ⇒ Object (readonly)

Returns the value of attribute retrieval.



7
8
9
 
# File 'lib/determinator/control.rb', line 7

def retrieval
  @retrieval
end

Instance Method Details

#feature_flag_on?(name, id: nil, guid: nil, properties: {}) ⇒ true, false

Determines whether a specific feature is on or off for the given actor

Parameters:

  • name (#to_s) —

    The name of the feature flag being checked

  • :id (#to_s) —

    The id of the actor being determinated for

  • :guid (#to_s) —

    The Anonymous id of the actor being determinated for

  • :properties (Hash<Symbol,String>) —

    The properties of this actor which will be used for including this actor or not

Returns:

  • (true, false) —

    Whether the feature is on (true) or off (false) for this actor

Raises:

  • (ArgumentError) —

    When the arguments given to this method aren't ever going to produce a useful response



33
34
35
36
37
 
# File 'lib/determinator/control.rb', line 33

def feature_flag_on?(name, id: nil, guid: nil, properties: {})
  determinate_and_notice(name, id: id, guid: guid, properties: properties) do |feature|
    feature.feature_flag?
  end
end

#for_actor(id: nil, guid: nil, default_properties: {}) ⇒ ActorControl

Creates a new determinator instance which assumes the actor id, guid and properties given are always specified. This is useful for within a before filter in a webserver, for example, so that the determinator instance made available has the logged-in user's credentials prefilled.

Parameters:

  • :id (#to_s) —

    The ID of the actor being specified

  • :guid (#to_s) —

    The Anonymous ID of the actor being specified

  • :default_properties (Hash<Symbol,String>) —

    The default properties for the determinator being created

Returns:

  • (ActorControl) —

    A helper object removing the need to know id and guid everywhere



21
22
23
 
# File 'lib/determinator/control.rb', line 21

def for_actor(id: nil, guid: nil, default_properties: {})
  ActorControl.new(self, id: id, guid: guid, default_properties: default_properties)
end

#inspect ⇒ Object 



53
54
55
 
# File 'lib/determinator/control.rb', line 53

def inspect
  '#<Determinator::Control>'
end

#which_variant(name, id: nil, guid: nil, properties: {}) ⇒ false, String

Determines what an actor should see for a specific experiment

Parameters:

  • name (#to_s) —

    The name of the experiment being checked

  • :id (#to_s) —

    The id of the actor being determinated for

  • :guid (#to_s) —

    The Anonymous id of the actor being determinated for

  • :properties (Hash<Symbol,String>) —

    The properties of this actor which will be used for including this actor or not

Returns:

  • (false, String) —

    Returns false, if the actor is not in this experiment, or otherwise the variant name.

Raises:

  • (ArgumentError) —

    When the arguments given to this method aren't ever going to produce a useful response



47
48
49
50
51
 
# File 'lib/determinator/control.rb', line 47

def which_variant(name, id: nil, guid: nil, properties: {})
  determinate_and_notice(name, id: id, guid: guid, properties: properties) do |feature|
    feature.experiment?
  end
end