Class: Binda::InstallGenerator

Inherits:
Rails::Generators::Base
  • Object
show all
Defined in:
lib/generators/binda/install/install_generator.rb

Instance Method Summary collapse

Instance Method Details

#add_route ⇒ Object 



53
54
55
56
57
 
# File 'lib/generators/binda/install/install_generator.rb', line 53

def add_route
  return if Rails.application.routes.routes.detect { |route| route.app.app == Binda::Engine }
  puts "2) Add Binda routes"
  route "mount Binda::Engine => '/admin_panel'"
end

#check_if_production ⇒ Object 



7
8
9
10
11
12
 
# File 'lib/generators/binda/install/install_generator.rb', line 7

def check_if_production
  if Rails.env.production?
    warn "Sorry Binda can only be installed in development mode"
    exit
  end
end

#check_previous_install ⇒ Object 



14
15
16
17
18
19
20
21
 
# File 'lib/generators/binda/install/install_generator.rb', line 14

def check_previous_install
  # Ensure Binda is not installed
  if ActiveRecord::Base.connection.data_source_exists? 'binda_components'
    warn "Binda has already been installed on this database."
    warn "Please ensure Binda is completely removed from the database before trying to install it again."
    exit
  end
end

#run_migrations ⇒ Object 



23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/generators/binda/install/install_generator.rb', line 23

def run_migrations
  puts ""
  puts "==============================================================================="
  puts "                             BINDA INSTALLATION"
  puts "==============================================================================="
  puts ""
  puts "1) Install migrations"
  # Check if there is any previous Binda migration
  previous_binda_migrations = Dir.glob( Rails.root.join('db', 'migrate', '*.binda.rb' ))
  previous_migrations = Dir.glob( Rails.root.join('db', 'migrate', '*.rb' ))

  # If it's the first time you run the installation
  unless previous_binda_migrations.any?
    rake 'binda:install:migrations'
  else
    # If there is any previous Binda migration
    if previous_migrations.size != previous_binda_migrations.size
      warn "You have several migrations, please manually delete Binda's ones then run 'rails g binda:install' again."
      warn "Keep in mind that Binda will place the new migration after the existing ones."
      exit
    else
      # Remove previous Binda migrations
      FileUtils.rm_rf( previous_binda_migrations )
      # Install Binda migrations
      rake 'binda:install:migrations'
    end
  end
  rake 'db:migrate'
end

#setup_carrierwave ⇒ Object

Setup Carrierwave

It generates this carrierwave



115
116
117
118
119
120
 
# File 'lib/generators/binda/install/install_generator.rb', line 115

def setup_carrierwave
  return if File.exist?( Rails.root.join('config', 'initializers', 'carrierwave.rb' ))
  puts "4) Setup Carrierwave"
  template 'config/initializers/carrierwave.rb'
  puts "==============================================================================="
end

#setup_default_helpers ⇒ Object

Setup default helpers

This operation creates a class called ‘B` from which is possible to call any

Binda helper contained in Binda::DefaultHelpers. This is possible by inheriting the
`Binda::B` class.



127
128
129
130
131
132
 
# File 'lib/generators/binda/install/install_generator.rb', line 127

def setup_default_helpers
  puts "5) Setting up default helpers"
  generate "model", "B --no-migration --parent=::Binda::B"
  puts "Default helpers has been set up."
  puts 
end

#setup_devise ⇒ Object

Setup Devise initializer

It append the snippet below to ‘config/initializers/devise.rb` of your application:

“‘ruby

# PLEASE UPDATE THIS WITH THE FINAL URL OF YOUR DOMAIN
# for setup see https://rubyonrailshelp.wordpress.com/2014/01/02/setting-up-mailer-using-devise-for-forgot-password/
config.action_mailer.default_url_options = { host: 'yourdomain.com' }
config.action_mailer.delivery_method = :smtp
config.action_mailer.perform_deliveries = true
config.action_mailer.raise_delivery_errors = false
config.action_mailer.default :charset => 'utf-8'
config.action_mailer.smtp_settings = {
  address: 'smtp.gmail.com',
  port: 587,
  domain: ENV['MAIL_DOMAIN'],
  authentication: 'plain',
  enable_starttls_auto: true,
  user_name: ENV['MAIL_USERNAME'],
  password: ENV['MAIL_PASSWORD']
}
```



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/generators/binda/install/install_generator.rb', line 82

def setup_devise
  puts "4) Setup Devise"
  # Check if devise is already setup and if so, create a backup before overwrite it
  initializers_path = Rails.root.join('config', 'initializers' )
  if File.exist?( "#{ initializers_path }/devise.rb" )
    puts "Binda has detected a configuration file for Devise: config/initializers/devise.rb"
    puts "In order to avoid any conflict that file has been renamed"
    File.rename( "#{ initializers_path }/devise.rb" , "#{ initializers_path }/devise_backup_#{ Time.now.strftime('%Y%m%d-%H%M%S-%3N') }.rb" )
  end
  
  # Copy the initilializer on the application folder
  template 'config/initializers/devise.rb'

  # Add secret key
  inject_into_file 'config/initializers/devise.rb', after: "# binda.hook.1" do 
    "\n  config.secret_key = '#{ SecureRandom.hex(64) }'"
  end
  # Add pepper
  inject_into_file 'config/initializers/devise.rb', after: "# binda.hook.2" do 
    "\n  config.pepper = '#{ SecureRandom.hex(64) }'"
  end

  application( nil, env: [ "development", "test" ] ) do
    "\n  config.action_mailer.default_url_options = { host: 'localhost:3000' }\n  config.action_mailer.raise_delivery_errors = true\n"
  end
  application( nil, env: "production" ) do
    "\n  # PLEASE UPDATE THIS WITH THE FINAL URL OF YOUR DOMAIN\n  # config.action_mailer.default_url_options = { host: 'yourdomain.com' }\n  # config.action_mailer.delivery_method = :smtp\n  # config.action_mailer.perform_deliveries = true\n  # config.action_mailer.raise_delivery_errors = false\n  # config.action_mailer.default :charset => 'utf-8'\n  # config.action_mailer.smtp_settings = {\n  #   address: 'smtp.gmail.com',\n  #   port: 587,\n  #   domain: ENV['MAIL_DOMAIN'],\n  #   authentication: 'plain',\n  #   enable_starttls_auto: true,\n  #   user_name: ENV['MAIL_USERNAME'],\n  #   password: ENV['MAIL_PASSWORD']\n  # }"
  end
end

#setup_settings ⇒ Object 



134
135
136
 
# File 'lib/generators/binda/install/install_generator.rb', line 134

def setup_settings
  exec 'rails generate binda:maintenance && rails generate binda:setup'
end