Class: ConvenientService::Support::Cache::Entities::Caches::Base Private

Inherits:

Object

Object
ConvenientService::Support::Cache::Entities::Caches::Base

show all

Includes:: AbstractMethod

Defined in:: lib/convenient_service/support/cache/entities/caches/base.rb

Overview

This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.

Since:

1.0.0

Direct Known Subclasses

Array, Hash

Instance Attribute Summary collapse

#default ⇒ Object readonly private
#key ⇒ Object readonly private
#parent ⇒ Object readonly private
#store ⇒ Object readonly private

Class Method Summary collapse

.keygen ⇒ ConvenientService::Support::Cache::Entities::Key private

Instance Method Summary collapse

#==(other) ⇒ Boolean^? private
#[] ⇒ Object private

Can be any type.
#[]= ⇒ Object private

Can be any type.
#clear ⇒ ConvenientService::Support::Cache::Enitities::Caches::Base private
#default ⇒ Object readonly private

Can be any type.
#delete ⇒ Object^? private

Can be any type.
#empty? ⇒ Boolean private
#exist? ⇒ Boolean private
#fetch ⇒ Object private

Can be any type.
#get ⇒ Object private

Can be any type.
#initialize(store: nil, default: nil, parent: nil, key: nil) ⇒ void constructor private
#keygen ⇒ ConvenientService::Support::Cache::Entities::Key private
#read ⇒ Object private

Can be any type.
#scope ⇒ ConvenientService::Support::Cache::Enitities::Caches::Base private
#scope! ⇒ ConvenientService::Support::Cache::Enitities::Caches::Base private
#set ⇒ Object private

Can be any type.
#write ⇒ Object private

Can be any type.

Methods included from ConvenientService::Support::Concern

included

Constructor Details

#initialize(store: nil, default: nil, parent: nil, key: nil) ⇒ `void`

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

store (Object) (defaults to: nil) —

Can be any type.
default (Object) (defaults to: nil) —

Can be any type.
parent (ConvenientService::Support::Cache::Entities::Caches::Base, nil) (defaults to: nil)
key (ConvenientService::Support::Cache::Entities::Key, Object) (defaults to: nil)

Since:

1.0.0

# File 'lib/convenient_service/support/cache/entities/caches/base.rb', line 110

def initialize(store: nil, default: nil, parent: nil, key: nil)
  @store = store
  @default = default
  @parent = parent
  @key = key
end

Instance Attribute Details

#default ⇒ `Object` (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Since:

1.0.0



35
36
37

# File 'lib/convenient_service/support/cache/entities/caches/base.rb', line 35

def default
  @default
end

#key ⇒ `Object` (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Note:

‘key` is only present when cache is scoped.

Since:

1.0.0



51
52
53

# File 'lib/convenient_service/support/cache/entities/caches/base.rb', line 51

def key
  @key
end

#parent ⇒ `Object` (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Note:

‘parent` is only present when cache is scoped.

Since:

1.0.0



43
44
45

# File 'lib/convenient_service/support/cache/entities/caches/base.rb', line 43

def parent
  @parent
end

#store ⇒ `Object` (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Since:

1.0.0



29
30
31

# File 'lib/convenient_service/support/cache/entities/caches/base.rb', line 29

def store
  @store
end

Class Method Details

.keygen ⇒ `ConvenientService::Support::Cache::Entities::Key`

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

(ConvenientService::Support::Cache::Entities::Key)

Since:

1.0.0



20
21
22

# File 'lib/convenient_service/support/cache/entities/caches/base.rb', line 20

def keygen(...)
  Entities::Key.new(...)
end

Instance Method Details

#==(other) ⇒ `Boolean`^?

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

other (Object) —

Can be any type.

Returns:

(Boolean, nil)

Since:

1.0.0

# File 'lib/convenient_service/support/cache/entities/caches/base.rb', line 168

def ==(other)
  return unless other.instance_of?(self.class)

  return false if store != other.store

  true
end

#[] ⇒ `Object`

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns Can be any type.

Returns:

(Object) —

Can be any type.

Since:

1.0.0



130
131
132

# File 'lib/convenient_service/support/cache/entities/caches/base.rb', line 130

def [](...)
  read(...)
end

#[]= ⇒ `Object`

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns Can be any type.

Returns:

(Object) —

Can be any type.

Since:

1.0.0



150
151
152

# File 'lib/convenient_service/support/cache/entities/caches/base.rb', line 150

def []=(...)
  write(...)
end

#clear ⇒ `ConvenientService::Support::Cache::Enitities::Caches::Base`

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

(ConvenientService::Support::Cache::Enitities::Caches::Base)

Since:

1.0.0

86	# File 'lib/convenient_service/support/cache/entities/caches/base.rb', line 86 abstract_method :clear

#default= ⇒ `Object` (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns Can be any type.

Returns:

(Object) —

Can be any type.

Since:

1.0.0

101	# File 'lib/convenient_service/support/cache/entities/caches/base.rb', line 101 abstract_method :default=

#delete ⇒ `Object`^?

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns Can be any type.

Returns:

(Object, nil) —

Can be any type.

Since:

1.0.0

81	# File 'lib/convenient_service/support/cache/entities/caches/base.rb', line 81 abstract_method :delete

#empty? ⇒ `Boolean`

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

(Boolean)

Since:

1.0.0

56	# File 'lib/convenient_service/support/cache/entities/caches/base.rb', line 56 abstract_method :empty?

#exist? ⇒ `Boolean`

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

(Boolean)

Since:

1.0.0

61	# File 'lib/convenient_service/support/cache/entities/caches/base.rb', line 61 abstract_method :exist?

#fetch ⇒ `Object`

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns Can be any type.

Returns:

(Object) —

Can be any type.

Since:

1.0.0

76	# File 'lib/convenient_service/support/cache/entities/caches/base.rb', line 76 abstract_method :fetch

#get ⇒ `Object`

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns Can be any type.

Returns:

(Object) —

Can be any type.

Since:

1.0.0



140
141
142

# File 'lib/convenient_service/support/cache/entities/caches/base.rb', line 140

def get(...)
  read(...)
end

#keygen ⇒ `ConvenientService::Support::Cache::Entities::Key`

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

(ConvenientService::Support::Cache::Entities::Key)

Since:

1.0.0



120
121
122

# File 'lib/convenient_service/support/cache/entities/caches/base.rb', line 120

def keygen(...)
  self.class.keygen(...)
end

#read ⇒ `Object`

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns Can be any type.

Returns:

(Object) —

Can be any type.

Since:

1.0.0

66	# File 'lib/convenient_service/support/cache/entities/caches/base.rb', line 66 abstract_method :read

#scope ⇒ `ConvenientService::Support::Cache::Enitities::Caches::Base`

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

(ConvenientService::Support::Cache::Enitities::Caches::Base)

Since:

1.0.0

91	# File 'lib/convenient_service/support/cache/entities/caches/base.rb', line 91 abstract_method :scope

#scope! ⇒ `ConvenientService::Support::Cache::Enitities::Caches::Base`

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

(ConvenientService::Support::Cache::Enitities::Caches::Base)

Since:

1.0.0

96	# File 'lib/convenient_service/support/cache/entities/caches/base.rb', line 96 abstract_method :scope!

#set ⇒ `Object`

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns Can be any type.

Returns:

(Object) —

Can be any type.

Since:

1.0.0



160
161
162

# File 'lib/convenient_service/support/cache/entities/caches/base.rb', line 160

def set(...)
  write(...)
end

#write ⇒ `Object`

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns Can be any type.

Returns:

(Object) —

Can be any type.

Since:

1.0.0

71	# File 'lib/convenient_service/support/cache/entities/caches/base.rb', line 71 abstract_method :write

Class: ConvenientService::Support::Cache::Entities::Caches::Base Private

Overview

Direct Known Subclasses

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from ConvenientService::Support::Concern

Constructor Details

#initialize(store: nil, default: nil, parent: nil, key: nil) ⇒ void

Instance Attribute Details

#default ⇒ Object (readonly)

#key ⇒ Object (readonly)

#parent ⇒ Object (readonly)

#store ⇒ Object (readonly)

Class Method Details

.keygen ⇒ ConvenientService::Support::Cache::Entities::Key

Instance Method Details

#==(other) ⇒ Boolean?

#[] ⇒ Object

#[]= ⇒ Object

#clear ⇒ ConvenientService::Support::Cache::Enitities::Caches::Base

#default= ⇒ Object (readonly)

#delete ⇒ Object?

#empty? ⇒ Boolean

#exist? ⇒ Boolean

#fetch ⇒ Object

#get ⇒ Object

#keygen ⇒ ConvenientService::Support::Cache::Entities::Key

#read ⇒ Object

#scope ⇒ ConvenientService::Support::Cache::Enitities::Caches::Base

#scope! ⇒ ConvenientService::Support::Cache::Enitities::Caches::Base

#set ⇒ Object

#write ⇒ Object

#initialize(store: nil, default: nil, parent: nil, key: nil) ⇒ `void`

#default ⇒ `Object` (readonly)

#key ⇒ `Object` (readonly)

#parent ⇒ `Object` (readonly)

#store ⇒ `Object` (readonly)

.keygen ⇒ `ConvenientService::Support::Cache::Entities::Key`

#==(other) ⇒ `Boolean`^?

#[] ⇒ `Object`

#[]= ⇒ `Object`

#clear ⇒ `ConvenientService::Support::Cache::Enitities::Caches::Base`

#default= ⇒ `Object` (readonly)

#delete ⇒ `Object`^?

#empty? ⇒ `Boolean`

#exist? ⇒ `Boolean`

#fetch ⇒ `Object`

#get ⇒ `Object`

#keygen ⇒ `ConvenientService::Support::Cache::Entities::Key`

#read ⇒ `Object`

#scope ⇒ `ConvenientService::Support::Cache::Enitities::Caches::Base`

#scope! ⇒ `ConvenientService::Support::Cache::Enitities::Caches::Base`

#set ⇒ `Object`

#write ⇒ `Object`