Class: Solidus::InstallGenerator

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

Constant Summary collapse

CORE_MOUNT_ROUTE = 
"mount Spree::Core::Engine"
FRONTENDS = 
[
  { name: 'starter', description: 'Generate all necessary controllers and views directly in your Rails app', default: true },
  { name: 'none', description: 'Skip installing a frontend' }
]
AUTHENTICATIONS = 
[
  { name: 'devise', description: 'Install and configure the standard `devise` integration', default: true },
  { name: 'existing', description: 'Integrate and configure an existing `devise` setup' },
  { name: 'custom', description: 'A starter configuration for rolling your own authentication system' },
  { name: 'none', description: 'Don\'t add any configuration for authentication' }
]
PAYMENT_METHODS = 
[
  { name: 'paypal', description: 'Install `solidus_paypal_commerce_platform`', default: true },
  { name: 'stripe', description: 'Install `solidus_stripe`', default: false },
  { name: 'braintree', description: 'Install `solidus_braintree`', default: false },
  { name: 'none', description: 'Skip installing a payment method', default: false }
]

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.exit_on_failure? ⇒ Boolean

Returns:

  • (Boolean) 


48
49
50
 
# File 'lib/generators/solidus/install/install_generator.rb', line 48

def self.exit_on_failure?
  true
end

Instance Method Details

#add_files ⇒ Object 



89
90
91
 
# File 'lib/generators/solidus/install/install_generator.rb', line 89

def add_files
  template 'config/initializers/spree.rb.tt', 'config/initializers/spree.rb'
end

#complete ⇒ Object 



190
191
192
 
# File 'lib/generators/solidus/install/install_generator.rb', line 190

def complete
  say_status :complete, "Solidus has been installed successfully. Enjoy!"
end

#create_database ⇒ Object 



131
132
133
134
 
# File 'lib/generators/solidus/install/install_generator.rb', line 131

def create_database
  say_status :creating, "database"
  rake 'db:create'
end

#create_overrides_directory ⇒ Object 



116
117
118
 
# File 'lib/generators/solidus/install/install_generator.rb', line 116

def create_overrides_directory
  empty_directory "app/overrides"
end

#include_seed_data ⇒ Object 



120
121
122
123
124
 
# File 'lib/generators/solidus/install/install_generator.rb', line 120

def include_seed_data
  append_file "db/seeds.rb", <<~RUBY
    Spree::Core::Engine.load_seed
  RUBY
end

#install_file_attachment ⇒ Object 



93
94
95
96
97
98
99
100
101
 
# File 'lib/generators/solidus/install/install_generator.rb', line 93

def install_file_attachment
  if options[:active_storage]
    say_status :assets, "Active Storage", :green
    rake 'active_storage:install'
  else
    say_status :assets, "Paperclip", :green
    gsub_file 'config/initializers/spree.rb', "ActiveStorageAttachment", "PaperclipAttachment"
  end
end

#install_migrations ⇒ Object 



126
127
128
129
 
# File 'lib/generators/solidus/install/install_generator.rb', line 126

def install_migrations
  say_status :copying, "migrations"
  rake 'railties:install:migrations'
end

#install_routes ⇒ Object 



136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/generators/solidus/install/install_generator.rb', line 136

def install_routes
  if Pathname(app_path).join('config', 'routes.rb').read.include? CORE_MOUNT_ROUTE
    say_status :route_exist, CORE_MOUNT_ROUTE, :blue
  else
    route <<~RUBY
      # This line mounts Solidus's routes at the root of your application.
      # This means, any requests to URLs such as /products, will go to Spree::ProductsController.
      # If you would like to change where this engine is mounted, simply change the :at option to something different.
      #
      # We ask that you don't use the :as option here, as Solidus relies on it being the default of "spree"
      #{CORE_MOUNT_ROUTE}, at: '/'
    RUBY
  end
end

#install_subcomponents ⇒ Object 



161
162
163
164
165
 
# File 'lib/generators/solidus/install/install_generator.rb', line 161

def install_subcomponents
  apply_template_for :authentication, @selected_authentication
  apply_template_for :frontend, @selected_frontend
  apply_template_for :payment_method, @selected_payment_method
end

#load_sample_data ⇒ Object 



181
182
183
184
185
186
187
188
 
# File 'lib/generators/solidus/install/install_generator.rb', line 181

def load_sample_data
  if @load_sample_data
    say_status :loading, "sample data"
    rake 'spree_sample:load'
  else
    say_status :skipping, "sample data (you can always run rake spree_sample:load)"
  end
end

#populate_seed_data ⇒ Object 



167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/generators/solidus/install/install_generator.rb', line 167

def populate_seed_data
  if @load_seed_data
    say_status :loading, "seed data"
    rake_options = []
    rake_options << "AUTO_ACCEPT=1" if options[:auto_accept]
    rake_options << "ADMIN_EMAIL=#{options[:admin_email]}" if options[:admin_email]
    rake_options << "ADMIN_PASSWORD=#{options[:admin_password]}" if options[:admin_password]

    rake("db:seed #{rake_options.join(' ')}")
  else
    say_status :skipping, "seed data (you can always run rake db:seed)"
  end
end

#prepare_options ⇒ Object 



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/generators/solidus/install/install_generator.rb', line 52

def prepare_options
  @run_migrations = options[:migrate]
  @load_seed_data = options[:seed] && @run_migrations
  @load_sample_data = options[:sample] && @run_migrations && @load_seed_data

  @selected_frontend = selected_option_for(
    'frontend',
    selected: ENV['FRONTEND'] || options[:frontend],
    available_options: FRONTENDS,
  )

  @selected_authentication = selected_option_for(
    'authentication',
    selected:
      ('devise' if @selected_frontend == 'starter') ||
      ('devise' if has_gem?('solidus_auth_devise')) ||
      ENV['AUTHENTICATION'] || options[:authentication],
    available_options: AUTHENTICATIONS,
  )

  @selected_payment_method = selected_option_for(
    'payment method',
    selected:
      ('paypal' if has_gem?('solidus_paypal_commerce_platform')) ||
      ('stripe' if has_gem?('solidus_stripe')) ||
      ('bolt' if has_gem?('solidus_bolt')) ||
      ENV['PAYMENT_METHOD'] || options[:payment_method],
    available_options: PAYMENT_METHODS,
  )

  # Silence verbose output (e.g. Rails migrations will rely on this environment variable)
  ENV['VERBOSE'] = 'false'

  # No reason to check for their presence if we're about to install them
  ENV['SOLIDUS_SKIP_MIGRATIONS_CHECK'] = 'true'
end

#run_migrations ⇒ Object 



151
152
153
154
155
156
157
158
159
 
# File 'lib/generators/solidus/install/install_generator.rb', line 151

def run_migrations
  if @run_migrations
    say_status :running, "migrations"

    rake 'db:migrate'
  else
    say_status :skipping, "migrations (don't forget to run rake db:migrate)"
  end
end

#setup_assets ⇒ Object 



103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/generators/solidus/install/install_generator.rb', line 103

def setup_assets
  empty_directory 'app/assets/images'

  %w{javascripts stylesheets images}.each do |path|
    empty_directory "vendor/assets/#{path}/spree/backend" if defined?(Spree::Backend) || Rails.env.test?
  end

  if defined?(Spree::Backend) || Rails.env.test?
    template "vendor/assets/javascripts/spree/backend/all.js"
    template "vendor/assets/stylesheets/spree/backend/all.css"
  end
end