Module: Familia

Extended by:
Connection, Logging, Settings, Utils
Defined in:
lib/familia.rb,
lib/familia/base.rb,
lib/familia/utils.rb,
lib/familia/errors.rb,
lib/familia/horreum.rb,
lib/familia/logging.rb,
lib/familia/version.rb,
lib/familia/features.rb,
lib/familia/settings.rb,
lib/familia/redistype.rb,
lib/familia/connection.rb,
lib/familia/types/list.rb,
lib/familia/types/string.rb,
lib/familia/horreum/utils.rb,
lib/familia/types/hashkey.rb,
lib/familia/horreum/commands.rb,
lib/familia/horreum/settings.rb,
lib/familia/types/sorted_set.rb,
lib/familia/types/unsorted_set.rb,
lib/familia/horreum/class_methods.rb,
lib/familia/horreum/serialization.rb,
lib/familia/horreum/relations_management.rb

Overview

rubocop:disable all

Defined Under Namespace

Modules: Base, Connection, Features, Logging, Settings, Utils, VERSION Classes: HashKey, HighRiskFactor, Horreum, List, NoIdentifier, NonUniqueKey, NotConnected, Problem, RedisType, Set, SortedSet, String

Constant Summary collapse

DIGEST_CLASS = 
Digest::SHA256

Class Attribute Summary collapse

Attributes included from Logging

#logger

Attributes included from Connection

#enable_redis_counter, #enable_redis_logging, #redis_clients, #uri

Attributes included from Settings

#db, #delim, #prefix, #suffix, #ttl

Class Method Summary collapse

Methods included from Logging

info, ld, le, trace, warn

Methods included from Connection

connect, redis

Methods included from Settings

default_suffix

Methods included from Utils

debug?, distinguisher, generate_id, generate_sha_hash, join, now, qnow, qstamp, rediskey, redisuri, split

Class Attribute Details

.debug ⇒ Object

Returns the value of attribute debug.



38
39
40
 
# File 'lib/familia.rb', line 38

def debug
  @debug
end

.members ⇒ Object (readonly)

Returns the value of attribute members.



39
40
41
 
# File 'lib/familia.rb', line 39

def members
  @members
end

Class Method Details

.configure {|_self| ... } ⇒ Object

A convenience pattern for configuring Familia.

Examples:

Familia.configure do |config|
  config.debug = true
  config.enable_redis_logging = true
end

Yields:

  • (_self)

Yield Parameters:

  • _self (Familia) —

    the object that the method was called on



54
55
56
 
# File 'lib/familia.rb', line 54

def configure
  yield self
end

.included(member) ⇒ Object

Raises:



41
42
43
 
# File 'lib/familia.rb', line 41

def included(member)
  raise Problem, "#{member} should subclass Familia::Horreum"
end