Module: Legion::Cache::Settings

Extended by:
Logging::Helper
Defined in:
lib/legion/cache/settings.rb

Constant Summary collapse

DEFAULT_PORTS = 
{ 'dalli' => 11_211, 'redis' => 6379 }.freeze

Class Method Summary collapse

Class Method Details

.default ⇒ Object 



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
 
# File 'lib/legion/cache/settings.rb', line 20

def self.default
  {
    driver:                driver,
    servers:               [],
    connected:             false,
    enabled:               true,
    namespace:             'legion',
    compress:              false,
    failover:              true,
    threadsafe:            true,
    expires_in:            0,
    cache_nils:            false,
    pool_size:             10,
    timeout:               5,
    pool_checkout_timeout: 5,
    default_ttl:           3600,
    failback_to_local:     true,
    serializer:            Legion::JSON,
    cluster:               nil,
    replica:               false,
    fixed_hostname:        nil,
    username:              nil,
    password:              nil,
    db:                    nil,
    reconnect_attempts:    [0, 0.5, 1].freeze,
    async:                 {
      pool_size:        4,
      queue_size:       1000,
      shutdown_timeout: 5
    }.freeze,
    reconnect:             {
      initial_delay: 1,
      max_delay:     60,
      enabled:       true
    }.freeze
  }
end

.driver(prefer = 'dalli') ⇒ Object 



129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/legion/cache/settings.rb', line 129

def self.driver(prefer = 'dalli')
  secondary = prefer == 'dalli' ? 'redis' : 'dalli'
  if Gem::Specification.find_all_by_name(prefer).any?
    log.debug "Legion::Cache::Settings selected driver=#{prefer}"
    prefer
  elsif Gem::Specification.find_all_by_name(secondary).any?
    log.info "Legion::Cache::Settings falling back driver=#{secondary} preferred=#{prefer}"
    secondary
  else
    error = NameError.new('Legion::Cache.driver is nil')
    handle_exception(error, level: :error, handled: false, operation: :cache_settings_driver, preferred: prefer)
    raise error
  end
end

.format_server(host, port) ⇒ Object 



149
150
151
152
153
 
# File 'lib/legion/cache/settings.rb', line 149

def self.format_server(host, port)
  return "[#{host}]:#{port}" if ipv6_literal?(host)

  "#{host}:#{port}"
end

.ipv6_literal?(value) ⇒ Boolean

Returns:

  • (Boolean) 


155
156
157
158
159
 
# File 'lib/legion/cache/settings.rb', line 155

def self.ipv6_literal?(value)
  IPAddr.new(value).ipv6?
rescue IPAddr::InvalidAddressError
  false
end

.local ⇒ Object 



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/legion/cache/settings.rb', line 58

def self.local
  {
    driver:                driver,
    servers:               [],
    connected:             false,
    enabled:               true,
    namespace:             'legion_local',
    compress:              false,
    failover:              true,
    threadsafe:            true,
    expires_in:            0,
    cache_nils:            false,
    pool_size:             5,
    timeout:               3,
    pool_checkout_timeout: 5,
    default_ttl:           21_600,
    serializer:            Legion::JSON,
    username:              nil,
    password:              nil,
    db:                    nil,
    reconnect_attempts:    [0, 0.25, 0.5].freeze
  }
end

.normalize_driver(name) ⇒ Object 



121
122
123
124
125
126
127
 
# File 'lib/legion/cache/settings.rb', line 121

def self.normalize_driver(name)
  case name.to_s
  when 'redis' then 'redis'
  when 'memcached', 'dalli' then 'dalli'
  else name.to_s
  end
end

.normalize_server(server, port:) ⇒ Object 



144
145
146
147
 
# File 'lib/legion/cache/settings.rb', line 144

def self.normalize_server(server, port:)
  host, resolved_port = parse_server_address(server, default_port: port)
  format_server(host, resolved_port)
end

.parse_server_address(server, default_port:) ⇒ Object 



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/legion/cache/settings.rb', line 97

def self.parse_server_address(server, default_port:)
  raw = server.to_s.strip
  return ['127.0.0.1', default_port] if raw.empty?

  bracketed = raw.match(/\A\[(?<host>[^\]]+)\](?::(?<port>\d+))?\z/)
  return [bracketed[:host], (bracketed[:port] || default_port).to_i] if bracketed

  return [raw, default_port] if ipv6_literal?(raw)

  host, explicit_port = raw.split(':', 2)
  if explicit_port&.match?(/\A\d+\z/)
    [host, explicit_port.to_i]
  else
    [raw, default_port]
  end
end

.register_defaults! ⇒ Object 



114
115
116
117
118
119
 
# File 'lib/legion/cache/settings.rb', line 114

def self.register_defaults!
  return unless defined?(Legion::Settings) && Legion::Settings.respond_to?(:merge_settings)

  Legion::Settings.merge_settings(:cache, default)
  Legion::Settings.merge_settings(:cache_local, local)
end

.resolve_servers(driver:, server: nil, servers: [], port: nil) ⇒ Object 



84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/legion/cache/settings.rb', line 84

def self.resolve_servers(driver:, server: nil, servers: [], port: nil)
  gem_driver = normalize_driver(driver)
  port ||= DEFAULT_PORTS.fetch(gem_driver, 11_211)

  all = Array(servers) + Array(server)
  all = ["127.0.0.1:#{port}"] if all.empty?

  all.map! { |s| normalize_server(s, port: port) }
  resolved = all.uniq
  log.debug "Legion::Cache::Settings resolved driver=#{gem_driver} servers=#{resolved.join(', ')}"
  resolved
end