Class: Intro::Configuration

Inherits:
Object
  • Object
show all
Defined in:
lib/intro/configuration.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Configuration

Returns a new instance of Configuration.



42
43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/intro/configuration.rb', line 42

def initialize
  @enable = true

  @user_class = 'User'

  @current_user_method = 'current_user'

  @max_touch_count = 1

  @carrierwave_storage = :file

  @custom_assets = false
end

Instance Attribute Details

#admin_authenticate_account ⇒ Object

admin_authenticate_account will override authenticate_account process for backstage, it should return boolean



21
22
23
 
# File 'lib/intro/configuration.rb', line 21

def 
  @admin_authenticate_account
end

#admin_password ⇒ Object

admin account for accessing backstage



18
19
20
 
# File 'lib/intro/configuration.rb', line 18

def admin_password
  @admin_password
end

#admin_username ⇒ Object

admin account for accessing backstage



18
19
20
 
# File 'lib/intro/configuration.rb', line 18

def admin_username
  @admin_username
end

#cache ⇒ Object

cache tours status to reduce requests, default: false use ‘Rails.cache` to store tours status, change `config.cache_store` for different strategies



34
35
36
 
# File 'lib/intro/configuration.rb', line 34

def cache
  @cache
end

#carrierwave_storage ⇒ Object

the storage of carrierwave, default: :file



30
31
32
 
# File 'lib/intro/configuration.rb', line 30

def carrierwave_storage
  @carrierwave_storage
end

#current_user_method ⇒ Object

current_user method name in your controller, default: ‘current_user’



12
13
14
 
# File 'lib/intro/configuration.rb', line 12

def current_user_method
  @current_user_method
end

#custom_assets ⇒ Object

override intro tour styles, default: false



40
41
42
 
# File 'lib/intro/configuration.rb', line 40

def custom_assets
  @custom_assets
end

#enable ⇒ Object

switch intro status. all tours don’t display if intro is disable. default: true



6
7
8
 
# File 'lib/intro/configuration.rb', line 6

def enable
  @enable
end

#max_touch_count ⇒ Object

after user touches a tour more than max count, the tour doesn’t display. default: 1



15
16
17
 
# File 'lib/intro/configuration.rb', line 15

def max_touch_count
  @max_touch_count
end

#sign_out_admin_path ⇒ Object

the path for sign out an admin, default: ‘/intro/admin/sign_out’



27
28
29
 
# File 'lib/intro/configuration.rb', line 27

def sign_out_admin_path
  @sign_out_admin_path
end

#unauthenticated_admin_path ⇒ Object

redirect to unauthenticated_admin_path if user is failed to authenticated, default: ‘/intro/admin/sessions/new’



24
25
26
 
# File 'lib/intro/configuration.rb', line 24

def unauthenticated_admin_path
  @unauthenticated_admin_path
end

#user_class ⇒ Object

class name of your User Modal, default: ‘User’



9
10
11
 
# File 'lib/intro/configuration.rb', line 9

def user_class
  @user_class
end

#visible_without_signing_in ⇒ Object

display tour without signing in, default: false



37
38
39
 
# File 'lib/intro/configuration.rb', line 37

def visible_without_signing_in
  @visible_without_signing_in
end

Instance Method Details

#admin_username_digest ⇒ Object 



56
57
58
 
# File 'lib/intro/configuration.rb', line 56

def admin_username_digest
  @admin_username_digest ||= Digest::SHA1.hexdigest(admin_username.to_s)
end

#custom_assets_with_default ⇒ Object 



60
61
62
63
 
# File 'lib/intro/configuration.rb', line 60

def custom_assets_with_default
  return unless custom_assets
  custom_assets.is_a?(String) ? custom_assets : 'intro/custom'
end