Module: AbstractFeatureBranch

Extended by:
Forwardable
Defined in:
lib/abstract_feature_branch.rb,
lib/abstract_feature_branch/configuration.rb,
lib/generators/abstract_feature_branch/context_generator.rb,
lib/generators/abstract_feature_branch/install_generator.rb,
lib/abstract_feature_branch/redis/connection_pool_to_redis_adapter.rb

Defined Under Namespace

Modules: FileBeautifier, Generators, Redis Classes: Configuration

Constant Summary collapse

ENV_FEATURE_PREFIX = 
"abstract_feature_branch_"
REDIS_HKEY = 
"abstract_feature_branch"
VALUE_SCOPED = 
'scoped'
SCOPED_SPECIAL_VALUES = 
[VALUE_SCOPED, 'per_user', 'per-user', 'per user']

Class Method Summary collapse

Class Method Details

.application_features ⇒ Object 



116
117
118
119
 
# File 'lib/abstract_feature_branch.rb', line 116

def application_features
  unload_application_features unless cacheable?
  environment_features(application_environment)
end

.cacheable? ⇒ Boolean

Returns:

  • (Boolean) 


137
138
139
140
141
 
# File 'lib/abstract_feature_branch.rb', line 137

def cacheable?
  value = downcase_keys(cacheable)[application_environment]
  value = (application_environment != 'development') if value.nil?
  value
end

.clear_store_features ⇒ Object

Gets features array (all features) from storage (e.g. Redis client)



185
186
187
188
189
190
 
# File 'lib/abstract_feature_branch.rb', line 185

def clear_store_features
  raise 'Feature storage (e.g. Redis) is not setup!' if feature_store.nil?
  feature_store.hkeys(REDIS_HKEY).each do |feature|
    feature_store.hdel(REDIS_HKEY, feature)
  end
end

.configuration ⇒ Object 



33
34
35
 
# File 'lib/abstract_feature_branch.rb', line 33

def configuration
  @configuration ||= Configuration.new
end

.delete_store_feature(feature) ⇒ Object

Gets feature value (true or false) from storage (e.g. Redis client)



172
173
174
175
176
 
# File 'lib/abstract_feature_branch.rb', line 172

def delete_store_feature(feature)
  raise 'Feature storage (e.g. Redis) is not setup!' if feature_store.nil?
  feature = feature.to_s
  feature_store.hdel(REDIS_HKEY, feature)
end

.environment_features(environment) ⇒ Object

performance optimization via caching of feature values resolved through environment variable overrides and local features



77
78
79
80
 
# File 'lib/abstract_feature_branch.rb', line 77

def environment_features(environment)
  @environment_features ||= {}
  @environment_features[environment] ||= load_environment_features(environment)
end

.environment_variable_overrides ⇒ Object 



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

def environment_variable_overrides
  @environment_variable_overrides ||= load_environment_variable_overrides
end

.features ⇒ Object 



68
69
70
 
# File 'lib/abstract_feature_branch.rb', line 68

def features
  @features ||= load_features
end

.get_store_feature(feature) ⇒ Object

Gets feature value (true or false) from storage (e.g. Redis client)



158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/abstract_feature_branch.rb', line 158

def get_store_feature(feature)
  raise 'Feature storage (e.g. Redis) is not setup!' if feature_store.nil?
  feature = feature.to_s
  value = feature_store.hget(REDIS_HKEY, feature)
  if value.nil?
    matching_feature = get_store_features.find { |store_feature| store_feature.downcase == feature.downcase }
    value = feature_store.hget(REDIS_HKEY, matching_feature) if matching_feature
  end
  return nil if value.nil?
  return VALUE_SCOPED if scoped_value?(value)
  value.to_s.downcase == 'true'
end

.get_store_features ⇒ Object

Gets features array (all features) from storage (e.g. Redis client)



179
180
181
182
 
# File 'lib/abstract_feature_branch.rb', line 179

def get_store_features
  raise 'Feature storage (e.g. Redis) is not setup!' if feature_store.nil?
  feature_store.hkeys(REDIS_HKEY)
end

.load_application_features ⇒ Object 



120
121
122
123
124
125
126
127
 
# File 'lib/abstract_feature_branch.rb', line 120

def load_application_features
  AbstractFeatureBranch.load_redis_overrides
  AbstractFeatureBranch.load_environment_variable_overrides
  AbstractFeatureBranch.load_features
  AbstractFeatureBranch.load_local_features
  AbstractFeatureBranch.load_environment_features(application_environment)
  AbstractFeatureBranch.load_redis_scoped_features
end

.load_environment_features(environment) ⇒ Object 



81
82
83
84
85
86
87
88
89
 
# File 'lib/abstract_feature_branch.rb', line 81

def load_environment_features(environment)
  @environment_features ||= {}
  features[environment] ||= {}
  local_features[environment] ||= {}
  @environment_features[environment] = features[environment].
    merge(local_features[environment]).
    merge(environment_variable_overrides).
    merge(redis_overrides)
end

.load_environment_variable_overrides ⇒ Object 



56
57
58
 
# File 'lib/abstract_feature_branch.rb', line 56

def load_environment_variable_overrides
  @environment_variable_overrides = featureize_keys(downcase_keys(booleanize_values(select_feature_keys(ENV))))
end

.load_features ⇒ Object 



71
72
73
74
 
# File 'lib/abstract_feature_branch.rb', line 71

def load_features
  @features = {}
  load_specific_features(@features, '.yml')
end

.load_local_features ⇒ Object 



63
64
65
66
 
# File 'lib/abstract_feature_branch.rb', line 63

def load_local_features
  @local_features = {}
  load_specific_features(@local_features, '.local.yml')
end

.load_redis_overrides ⇒ Object 



40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/abstract_feature_branch.rb', line 40

def load_redis_overrides
  return (@redis_overrides = {}) if feature_store.nil?
  
  redis_feature_hash = get_store_features.inject({}) do |output, feature|
    output.merge(feature => get_store_feature(feature))
  end
  
  @redis_overrides = downcase_keys(redis_feature_hash)
rescue Exception => error
  AbstractFeatureBranch.logger.error "AbstractFeatureBranch encounter an error in loading Redis Overrides!\n\nError:#{error.full_message}\n\n"
  @redis_overrides = {}
end

.load_redis_scoped_features ⇒ Object 



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/abstract_feature_branch.rb', line 94

def load_redis_scoped_features
  @redis_scoped_features = {}
  return @redis_scoped_features if AbstractFeatureBranch.configuration.feature_store_live_fetching?
  
  @environment_features.each do |environment, features|
    features.each do |feature, value|
      if SCOPED_SPECIAL_VALUES.include?(value.to_s.downcase)
        normalized_feature_name = feature.to_s.downcase
        @redis_scoped_features[normalized_feature_name] ||= []
        begin
          @redis_scoped_features[normalized_feature_name] += scopes_for_feature(normalized_feature_name)
        rescue Exception => error
          AbstractFeatureBranch.logger.error "AbstractFeatureBranch encountered an error in retrieving Per-User values for feature \"#{normalized_feature_name}\"! Defaulting to no values...\n\nError: #{error.full_message}\n\n"
          nil
        end
      end
    end
  end
  
  @redis_scoped_features
end

.local_features ⇒ Object 



60
61
62
 
# File 'lib/abstract_feature_branch.rb', line 60

def local_features
  @local_features ||= load_local_features
end

.redis_overrides ⇒ Object 



37
38
39
 
# File 'lib/abstract_feature_branch.rb', line 37

def redis_overrides
  @redis_overrides ||= load_redis_overrides
end

.redis_scoped_features ⇒ Object 



91
92
93
 
# File 'lib/abstract_feature_branch.rb', line 91

def redis_scoped_features
  @redis_scoped_features ||= load_redis_scoped_features
end

.scoped_value?(value) ⇒ Boolean

Returns:

  • (Boolean) 


143
144
145
 
# File 'lib/abstract_feature_branch.rb', line 143

def scoped_value?(value)
  SCOPED_SPECIAL_VALUES.include?(value.to_s.downcase)
end

.scopes_for_feature(feature) ⇒ Object 



213
214
215
216
217
218
 
# File 'lib/abstract_feature_branch.rb', line 213

def scopes_for_feature(feature)
  normalized_feature_name = feature.to_s.downcase
  AbstractFeatureBranch.
    feature_store.
    smembers("#{AbstractFeatureBranch::ENV_FEATURE_PREFIX}#{normalized_feature_name}")
end

.set_store_feature(feature, value) ⇒ Object

Sets feature value (true or false) in storage (e.g. Redis client)



148
149
150
151
152
153
154
155
 
# File 'lib/abstract_feature_branch.rb', line 148

def set_store_feature(feature, value)
  raise 'Feature storage (e.g. Redis) is not setup!' if feature_store.nil?
  feature = feature.to_s
  return delete_store_feature(feature) if value.nil?
  value = 'true' if value == true
  value = 'false' if value == false
  feature_store.hset(REDIS_HKEY, feature, value)
end

.toggle_features_for_scope(scope, features) ⇒ Object Also known as: toggle_features_for_user 



192
193
194
195
196
197
198
199
200
 
# File 'lib/abstract_feature_branch.rb', line 192

def toggle_features_for_scope(scope, features)
  features.each do |name, value|
    if value
      feature_store.sadd("#{ENV_FEATURE_PREFIX}#{name.to_s.downcase}", scope)
    else
      feature_store.srem("#{ENV_FEATURE_PREFIX}#{name.to_s.downcase}", scope)
    end
  end
end

.toggled_features_for_scope(scope) ⇒ Object 



203
204
205
206
207
208
209
210
211
 
# File 'lib/abstract_feature_branch.rb', line 203

def toggled_features_for_scope(scope)
  AbstractFeatureBranch.feature_store.keys.select do |key|
    key.start_with?(AbstractFeatureBranch::ENV_FEATURE_PREFIX)
  end.map do |key|
    feature = key.sub(AbstractFeatureBranch::ENV_FEATURE_PREFIX, '')
  end.select do |feature|
    scopes_for_feature(feature).include?(scope.to_s)
  end
end

.unload_application_features ⇒ Object 



128
129
130
131
132
133
134
135
 
# File 'lib/abstract_feature_branch.rb', line 128

def unload_application_features
  @redis_overrides = nil
  @environment_variable_overrides = nil
  @features = nil
  @local_features = nil
  @environment_features = nil
  @redis_scoped_features = nil
end