Module: Maily

Defined in:
lib/maily.rb,
lib/maily/email.rb,
lib/maily/engine.rb,
lib/maily/mailer.rb,
lib/maily/version.rb,
lib/maily/generator.rb,
app/helpers/maily/emails_helper.rb,
app/helpers/maily/application_helper.rb,
lib/generators/maily/install_generator.rb,
app/controllers/maily/emails_controller.rb,
app/controllers/maily/application_controller.rb

Defined Under Namespace

Modules: ApplicationHelper, EmailsHelper, Generator, Generators Classes: ApplicationController, Email, EmailsController, Engine, Mailer

Constant Summary collapse

VERSION = 
"0.8.1"

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.allow_delivery ⇒ Object

Returns the value of attribute allow_delivery.



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

def allow_delivery
  @allow_delivery
end

.allow_edition ⇒ Object

Returns the value of attribute allow_edition.



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

def allow_edition
  @allow_edition
end

.available_locales ⇒ Object

Returns the value of attribute available_locales.



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

def available_locales
  @available_locales
end

.base_controller ⇒ Object

Returns the value of attribute base_controller.



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

def base_controller
  @base_controller
end

.enabled ⇒ Object

Returns the value of attribute enabled.



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

def enabled
  @enabled
end

.hooks_path ⇒ Object

Returns the value of attribute hooks_path.



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

def hooks_path
  @hooks_path
end

.http_authorization ⇒ Object

Returns the value of attribute http_authorization.



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

def http_authorization
  @http_authorization
end

.welcome_message ⇒ Object

Returns the value of attribute welcome_message.



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

def welcome_message
  @welcome_message
end

Class Method Details

.allowed_action?(action) ⇒ Boolean

Returns:

  • (Boolean) 


47
48
49
50
51
52
53
54
55
56
 
# File 'lib/maily.rb', line 47

def allowed_action?(action)
  case action.to_sym
  when :edit
    allow_edition
  when :update
    allow_edition && !Rails.env.production?
  when :deliver
    allow_delivery
  end
end

.hooks_for(mailer_name) {|mailer| ... } ⇒ Object

Yields:

  • (mailer) 


35
36
37
38
39
40
 
# File 'lib/maily.rb', line 35

def hooks_for(mailer_name)
  mailer = Maily::Mailer.find(mailer_name.underscore)
  return unless mailer

  yield(mailer) if block_given?
end

.init! ⇒ Object 



12
13
14
15
16
17
18
19
20
21
 
# File 'lib/maily.rb', line 12

def init!
  self.enabled            = Rails.env.production? ? false : true
  self.allow_edition      = Rails.env.production? ? false : true
  self.allow_delivery     = Rails.env.production? ? false : true
  self.available_locales  = Rails.application.config.i18n.available_locales || I18n.available_locales
  self.base_controller    = 'ActionController::Base'
  self.http_authorization = nil
  self.hooks_path         = "lib/maily_hooks.rb"
  self.welcome_message    = "Use the menu on the left hand side of the screen to navigate through the different email templates."
end

.load_emails_and_hooks ⇒ Object 



23
24
25
26
27
28
29
30
31
32
33
 
# File 'lib/maily.rb', line 23

def load_emails_and_hooks
  # Load emails from file system
  Dir[Rails.root + 'app/mailers/*.rb'].each do |mailer|
    klass_name = File.basename(mailer, '.rb')
    Maily::Mailer.new(klass_name)
  end

  # Load hooks
  hooks_file_path = File.join(Rails.root, hooks_path)
  require hooks_file_path if File.exist?(hooks_file_path)
end

.setup {|_self| ... } ⇒ Object

Yields:

  • (_self)

Yield Parameters:

  • _self (Maily) —

    the object that the method was called on



42
43
44
45
 
# File 'lib/maily.rb', line 42

def setup
  init!
  yield(self) if block_given?
end