Class: ActivityNotification::Config

Inherits:

Object

Object
ActivityNotification::Config

show all

Defined in:: lib/activity_notification/config.rb

Overview

Class used to initialize configuration object.

Instance Attribute Summary collapse

#email_enabled ⇒ Object
#enabled ⇒ Object
#mailer ⇒ Object
#mailer_sender ⇒ Object
#mailer_templates_dir ⇒ Object
#notification_table_name ⇒ Object
#opened_index_limit ⇒ Object
# ⇒ Boolean

Returns ORM name for ActivityNotification (:active_record or :mongoid).
#parent_controller ⇒ Object
#parent_mailer ⇒ Object
#subscribe_as_default ⇒ Object
#subscription_enabled ⇒ Object
#subscription_table_name ⇒ Object
#table_name ⇒ Object deprecated Deprecated.

as of 1.1.0

Instance Method Summary collapse

#initialize ⇒ Config constructor

Initialize configuration for ActivityNotification.

Constructor Details

#initialize ⇒ `Config`

Initialize configuration for ActivityNotification. These configuration can be overriden in initializer.

# File 'lib/activity_notification/config.rb', line 130

def initialize
  @enabled                 = true
  @notification_table_name = 'notifications'
  @subscription_table_name = 'subscriptions'
  @email_enabled           = false
  @subscription_enabled    = false
  @subscribe_as_default    = true
  @mailer_sender           = nil
  @mailer                  = 'ActivityNotification::Mailer'
  @parent_mailer           = 'ActionMailer::Base'
  @parent_controller       = 'ApplicationController'
  @mailer_templates_dir    = 'activity_notification/mailer'
  @opened_index_limit      = 10
  @orm                     = :active_record
end

Instance Attribute Details

#email_enabled ⇒ `Boolean` #email_enabled=(value) ⇒ `Boolean`

Overloads:

#email_enabled ⇒ Boolean

Returns whether activity_notification sends notification email
Returns:
- (Boolean) —
  
  Whether activity_notification sends notification email.
#email_enabled=(value) ⇒ Boolean

Sets whether activity_notification sends notification email
Parameters:
- email_enabled (Boolean) —
  
  The new email_enabled
Returns:
- (Boolean) —
  
  Whether activity_notification sends notification email.



48
49
50

# File 'lib/activity_notification/config.rb', line 48

def email_enabled
  @email_enabled
end

#enabled ⇒ `Boolean` #enabled=(value) ⇒ `Boolean`

Overloads:

#enabled ⇒ Boolean

Returns whether ActivityNotification is enabled
Returns:
- (Boolean) —
  
  Whether ActivityNotification is enabled.
#enabled=(value) ⇒ Boolean

Sets whether ActivityNotification is enabled
Parameters:
- enabled (Boolean) —
  
  The new enabled
Returns:
- (Boolean) —
  
  Whether ActivityNotification is enabled.



11
12
13

# File 'lib/activity_notification/config.rb', line 11

def enabled
  @enabled
end

#mailer ⇒ `String` #mailer=(value) ⇒ `String`

Overloads:

#mailer ⇒ String

Returns mailer class for email notification
Returns:
- (String) —
  
  Mailer class for email notification.
#mailer=(value) ⇒ String

Sets mailer class for email notification
Parameters:
- mailer (String) —
  
  The new mailer
Returns:
- (String) —
  
  Mailer class for email notification.



84
85
86

# File 'lib/activity_notification/config.rb', line 84

def mailer
  @mailer
end

#mailer_sender ⇒ `String` #mailer_sender=(value) ⇒ `String`

Overloads:

#mailer_sender ⇒ String

Returns email address as sender of notification email
Returns:
- (String) —
  
  Email address as sender of notification email.
#mailer_sender=(value) ⇒ String

Sets email address as sender of notification email
Parameters:
- mailer_sender (String) —
  
  The new mailer_sender
Returns:
- (String) —
  
  Email address as sender of notification email.



75
76
77

# File 'lib/activity_notification/config.rb', line 75

def mailer_sender
  @mailer_sender
end

#mailer_templates_dir ⇒ `String` #mailer_templates_dir=(value) ⇒ `String`

Overloads:

#mailer_templates_dir ⇒ String

Returns custom mailer templates directory
Returns:
- (String) —
  
  Custom mailer templates directory.
#mailer_templates_dir=(value) ⇒ String

Sets custom mailer templates directory
Parameters:
- mailer_templates_dir (String) —
  
  The new custom mailer templates directory
Returns:
- (String) —
  
  Custom mailer templates directory.



111
112
113

# File 'lib/activity_notification/config.rb', line 111

def mailer_templates_dir
  @mailer_templates_dir
end

#notification_table_name ⇒ `String` #notification_table_name=(value) ⇒ `String`

Overloads:

#notification_table_name ⇒ String

Returns table name to store notifications
Returns:
- (String) —
  
  Table name to store notifications.
#notification_table_name=(value) ⇒ String

Sets table name to store notifications
Parameters:
- notification_table_name (String) —
  
  The new notification_table_name
Returns:
- (String) —
  
  Table name to store notifications.



30
31
32

# File 'lib/activity_notification/config.rb', line 30

def notification_table_name
  @notification_table_name
end

#opened_index_limit ⇒ `Integer` #opened_index_limit=(value) ⇒ `Integer`

Overloads:

#opened_index_limit ⇒ Integer

Returns default limit to query for opened notifications
Returns:
- (Integer) —
  
  Default limit to query for opened notifications.
#opened_index_limit=(value) ⇒ Integer

Sets default limit to query for opened notifications
Parameters:
- opened_index_limit (Integer) —
  
  The new opened_index_limit
Returns:
- (Integer) —
  
  Default limit to query for opened notifications.



120
121
122

# File 'lib/activity_notification/config.rb', line 120

def opened_index_limit
  @opened_index_limit
end

# ⇒ `Boolean`

Returns ORM name for ActivityNotification (:active_record or :mongoid)

Returns:

(Boolean) —

ORM name for ActivityNotification (:active_record or :mongoid).



125
126
127

# File 'lib/activity_notification/config.rb', line 125

def orm
  @orm
end

#parent_controller ⇒ `String` #parent_controller=(value) ⇒ `String`

Overloads:

#parent_controller ⇒ String

Returns base controller class for notifications_controller
Returns:
- (String) —
  
  Base controller class for notifications_controller.
#parent_controller=(value) ⇒ String

Sets base controller class for notifications_controller
Parameters:
- parent_controller (String) —
  
  The new parent_controller
Returns:
- (String) —
  
  Base controller class for notifications_controller.



102
103
104

# File 'lib/activity_notification/config.rb', line 102

def parent_controller
  @parent_controller
end

#parent_mailer ⇒ `String` #parent_mailer=(value) ⇒ `String`

Overloads:

#parent_mailer ⇒ String

Returns base mailer class for email notification
Returns:
- (String) —
  
  Base mailer class for email notification.
#parent_mailer=(value) ⇒ String

Sets base mailer class for email notification
Parameters:
- parent_mailer (String) —
  
  The new parent_mailer
Returns:
- (String) —
  
  Base mailer class for email notification.



93
94
95

# File 'lib/activity_notification/config.rb', line 93

def parent_mailer
  @parent_mailer
end

#subscribe_as_default ⇒ `Boolean` #default_subscription=(value) ⇒ `Boolean`

Overloads:

#subscribe_as_default ⇒ Boolean

Returns default subscription value to use when the subscription record does not configured
Returns:
- (Boolean) —
  
  Default subscription value to use when the subscription record does not configured.
#default_subscription=(value) ⇒ Boolean

Sets default subscription value to use when the subscription record does not configured
Parameters:
- subscribe_as_default (Boolean) —
  
  The new subscribe_as_default
Returns:
- (Boolean) —
  
  Default subscription value to use when the subscription record does not configured.



66
67
68

# File 'lib/activity_notification/config.rb', line 66

def subscribe_as_default
  @subscribe_as_default
end

#subscription_enabled ⇒ `Boolean` #subscription_enabled=(value) ⇒ `Boolean`

Overloads:

#subscription_enabled ⇒ Boolean

Returns whether activity_notification manages subscriptions
Returns:
- (Boolean) —
  
  Whether activity_notification manages subscriptions.
#subscription_enabled=(value) ⇒ Boolean

Sets whether activity_notification manages subscriptions
Parameters:
- subscription_enabled (Boolean) —
  
  The new subscription_enabled
Returns:
- (Boolean) —
  
  Whether activity_notification manages subscriptions.



57
58
59

# File 'lib/activity_notification/config.rb', line 57

def subscription_enabled
  @subscription_enabled
end

#subscription_table_name ⇒ `String` #subscription_table_name=(value) ⇒ `String`

Overloads:

#subscription_table_name ⇒ String

Returns table name to store subscriptions
Returns:
- (String) —
  
  Table name to store subscriptions.
#subscription_table_name=(value) ⇒ String

Sets table name to store subscriptions
Parameters:
- notification_table_name (String) —
  
  The new subscription_table_name
Returns:
- (String) —
  
  Table name to store subscriptions.



39
40
41

# File 'lib/activity_notification/config.rb', line 39

def subscription_table_name
  @subscription_table_name
end

#table_name ⇒ `String` #table_name=(value) ⇒ `String`

Deprecated.

as of 1.1.0

Overloads:

#table_name ⇒ String

Returns table name to store notifications
Returns:
- (String) —
  
  Table name to store notifications.
#table_name=(value) ⇒ String

Sets table name to store notifications
Parameters:
- table_name (String) —
  
  The new notification_table_name
Returns:
- (String) —
  
  Table name to store notifications.



21
22
23

# File 'lib/activity_notification/config.rb', line 21

def table_name
  @table_name
end

Class: ActivityNotification::Config

Overview

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Config

Instance Attribute Details

#email_enabled ⇒ Boolean #email_enabled=(value) ⇒ Boolean

#enabled ⇒ Boolean #enabled=(value) ⇒ Boolean

#mailer ⇒ String #mailer=(value) ⇒ String

#mailer_sender ⇒ String #mailer_sender=(value) ⇒ String

#mailer_templates_dir ⇒ String #mailer_templates_dir=(value) ⇒ String

#notification_table_name ⇒ String #notification_table_name=(value) ⇒ String

#opened_index_limit ⇒ Integer #opened_index_limit=(value) ⇒ Integer

# ⇒ Boolean

#parent_controller ⇒ String #parent_controller=(value) ⇒ String

#parent_mailer ⇒ String #parent_mailer=(value) ⇒ String

#subscribe_as_default ⇒ Boolean #default_subscription=(value) ⇒ Boolean

#subscription_enabled ⇒ Boolean #subscription_enabled=(value) ⇒ Boolean

#subscription_table_name ⇒ String #subscription_table_name=(value) ⇒ String

#table_name ⇒ String #table_name=(value) ⇒ String

#initialize ⇒ `Config`

#email_enabled ⇒ `Boolean` #email_enabled=(value) ⇒ `Boolean`

#enabled ⇒ `Boolean` #enabled=(value) ⇒ `Boolean`

#mailer ⇒ `String` #mailer=(value) ⇒ `String`

#mailer_sender ⇒ `String` #mailer_sender=(value) ⇒ `String`

#mailer_templates_dir ⇒ `String` #mailer_templates_dir=(value) ⇒ `String`

#notification_table_name ⇒ `String` #notification_table_name=(value) ⇒ `String`

#opened_index_limit ⇒ `Integer` #opened_index_limit=(value) ⇒ `Integer`

# ⇒ `Boolean`

#parent_controller ⇒ `String` #parent_controller=(value) ⇒ `String`

#parent_mailer ⇒ `String` #parent_mailer=(value) ⇒ `String`

#subscribe_as_default ⇒ `Boolean` #default_subscription=(value) ⇒ `Boolean`

#subscription_enabled ⇒ `Boolean` #subscription_enabled=(value) ⇒ `Boolean`

#subscription_table_name ⇒ `String` #subscription_table_name=(value) ⇒ `String`

#table_name ⇒ `String` #table_name=(value) ⇒ `String`