Class: Prefab::Options

Inherits:
Object
  • Object
show all
Defined in:
lib/prefab/options.rb

Overview

This class contains all the options that can be passed to the Prefab client.

Defined Under Namespace

Modules: DATASOURCES, ON_INITIALIZATION_FAILURE, ON_NO_DEFAULT

Constant Summary collapse

DEFAULT_MAX_PATHS = 
1_000
DEFAULT_MAX_KEYS = 
100_000
DEFAULT_MAX_EXAMPLE_CONTEXTS = 
100_000
DEFAULT_MAX_EVAL_SUMMARIES = 
100_000

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ Options

Returns a new instance of Options.



107
108
109
 
# File 'lib/prefab/options.rb', line 107

def initialize(options = {})
  init(**options)
end

Instance Attribute Details

#api_key ⇒ Object (readonly)

Returns the value of attribute api_key.



6
7
8
 
# File 'lib/prefab/options.rb', line 6

def api_key
  @api_key
end

#collect_sync_interval ⇒ Object (readonly)

Returns the value of attribute collect_sync_interval.



15
16
17
 
# File 'lib/prefab/options.rb', line 15

def collect_sync_interval
  @collect_sync_interval
end

#datafile ⇒ Object (readonly)

Returns the value of attribute datafile.



17
18
19
 
# File 'lib/prefab/options.rb', line 17

def datafile
  @datafile
end

#global_context ⇒ Object (readonly)

Returns the value of attribute global_context.



18
19
20
 
# File 'lib/prefab/options.rb', line 18

def global_context
  @global_context
end

#initialization_timeout_sec ⇒ Object (readonly)

Returns the value of attribute initialization_timeout_sec.



10
11
12
 
# File 'lib/prefab/options.rb', line 10

def initialization_timeout_sec
  @initialization_timeout_sec
end

#is_fork ⇒ Object

Returns the value of attribute is_fork.



19
20
21
 
# File 'lib/prefab/options.rb', line 19

def is_fork
  @is_fork
end

#namespace ⇒ Object (readonly)

Returns the value of attribute namespace.



7
8
9
 
# File 'lib/prefab/options.rb', line 7

def namespace
  @namespace
end

#on_init_failure ⇒ Object (readonly)

Returns the value of attribute on_init_failure.



11
12
13
 
# File 'lib/prefab/options.rb', line 11

def on_init_failure
  @on_init_failure
end

#on_no_default ⇒ Object (readonly)

Returns the value of attribute on_no_default.



9
10
11
 
# File 'lib/prefab/options.rb', line 9

def on_no_default
  @on_no_default
end

#prefab_api_url ⇒ Object (readonly)

Returns the value of attribute prefab_api_url.



8
9
10
 
# File 'lib/prefab/options.rb', line 8

def prefab_api_url
  @prefab_api_url
end

#prefab_config_classpath_dir ⇒ Object (readonly)

Returns the value of attribute prefab_config_classpath_dir.



13
14
15
 
# File 'lib/prefab/options.rb', line 13

def prefab_config_classpath_dir
  @prefab_config_classpath_dir
end

#prefab_config_override_dir ⇒ Object (readonly)

Returns the value of attribute prefab_config_override_dir.



12
13
14
 
# File 'lib/prefab/options.rb', line 12

def prefab_config_override_dir
  @prefab_config_override_dir
end

#prefab_envs ⇒ Object (readonly)

Returns the value of attribute prefab_envs.



14
15
16
 
# File 'lib/prefab/options.rb', line 14

def prefab_envs
  @prefab_envs
end

#use_local_cache ⇒ Object (readonly)

Returns the value of attribute use_local_cache.



16
17
18
 
# File 'lib/prefab/options.rb', line 16

def use_local_cache
  @use_local_cache
end

Instance Method Details

#api_key_id ⇒ Object 



148
149
150
 
# File 'lib/prefab/options.rb', line 148

def api_key_id
  @api_key&.split("-")&.first
end

#collect_max_evaluation_summaries ⇒ Object 



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

def collect_max_evaluation_summaries
  return 0 unless telemetry_allowed?(@collect_evaluation_summaries)

  @collect_max_evaluation_summaries
end

#collect_max_example_contexts ⇒ Object 



131
132
133
134
135
 
# File 'lib/prefab/options.rb', line 131

def collect_max_example_contexts
  return 0 unless telemetry_allowed?(@collect_example_contexts)

  @collect_max_example_contexts
end

#collect_max_paths ⇒ Object 



119
120
121
122
123
 
# File 'lib/prefab/options.rb', line 119

def collect_max_paths
  return 0 unless telemetry_allowed?(@collect_logger_counts)

  @collect_max_paths
end

#collect_max_shapes ⇒ Object 



125
126
127
128
129
 
# File 'lib/prefab/options.rb', line 125

def collect_max_shapes
  return 0 unless telemetry_allowed?(@collect_shapes)

  @collect_max_shapes
end

#datafile? ⇒ Boolean

Returns:

  • (Boolean) 


115
116
117
 
# File 'lib/prefab/options.rb', line 115

def datafile?
  !@datafile.nil?
end

#for_fork ⇒ Object 



152
153
154
155
156
 
# File 'lib/prefab/options.rb', line 152

def for_fork
  clone = self.clone
  clone.is_fork = true
  clone
end

#local_only? ⇒ Boolean

Returns:

  • (Boolean) 


111
112
113
 
# File 'lib/prefab/options.rb', line 111

def local_only?
  @prefab_datasources == DATASOURCES::LOCAL_ONLY
end

#url_for_api_cdn ⇒ Object

api.prefab.cloud -> api-prefab-cloud.global.ssl.fastly.net



144
145
146
 
# File 'lib/prefab/options.rb', line 144

def url_for_api_cdn
  ENV['PREFAB_CDN_URL'] || "#{@prefab_api_url.gsub(/\./, '-')}.global.ssl.fastly.net"
end