Class: Solidus::InstallGenerator

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

Defined Under Namespace

Classes: BundlerContext, InstallFrontend, SupportSolidusFrontendExtraction

Constant Summary collapse

CORE_MOUNT_ROUTE = 
"mount Spree::Core::Engine"
LEGACY_FRONTEND = 
'solidus_frontend'
DEFAULT_FRONTEND = 
'solidus_starter_frontend'
FRONTENDS = 
[
  DEFAULT_FRONTEND,
  LEGACY_FRONTEND,
  'none'
].freeze
PAYMENT_METHODS = 
{
  'paypal' => 'solidus_paypal_commerce_platform',
  'bolt' => 'solidus_bolt',
  'none' => nil,
}

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.source_paths ⇒ Object 



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

def self.source_paths
  paths = superclass.source_paths
  paths << File.expand_path('../templates', "../../#{__FILE__}")
  paths << File.expand_path('../templates', "../#{__FILE__}")
  paths << File.expand_path('templates', __dir__)
  paths.flatten
end

Instance Method Details

#add_files ⇒ Object 



72
73
74
 
# File 'lib/generators/solidus/install/install_generator.rb', line 72

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

#additional_tweaks ⇒ Object 



86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/generators/solidus/install/install_generator.rb', line 86

def additional_tweaks
  return unless File.exist? 'public/robots.txt'

  append_file "public/robots.txt", <<-ROBOTS.strip_heredoc
    User-agent: *
    Disallow: /checkout
    Disallow: /cart
    Disallow: /orders
    Disallow: /user
    Disallow: /account
    Disallow: /api
    Disallow: /password
  ROBOTS
end

#complete ⇒ Object 



261
262
263
264
265
266
267
268
 
# File 'lib/generators/solidus/install/install_generator.rb', line 261

def complete
  unless options[:quiet]
    puts "*" * 50
    puts "Solidus has been installed successfully. You're all ready to go!"
    puts " "
    puts "Enjoy!"
  end
end

#configure_application ⇒ Object 



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

def configure_application
  if !options[:enforce_available_locales].nil?
    application <<-RUBY
# Prevent this deprecation message: https://github.com/svenfuchs/i18n/commit/3b6e56e
I18n.enforce_available_locales = #{options[:enforce_available_locales]}
    RUBY
  end
end

#create_database ⇒ Object 



167
168
169
170
 
# File 'lib/generators/solidus/install/install_generator.rb', line 167

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 



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

def include_seed_data
  append_file "db/seeds.rb", <<-RUBY.strip_heredoc

    Spree::Core::Engine.load_seed if defined?(Spree::Core)
    Spree::Auth::Engine.load_seed if defined?(Spree::Auth)
  RUBY
end

#install_authentication_plugin ⇒ Object 



194
195
196
197
198
 
# File 'lib/generators/solidus/install/install_generator.rb', line 194

def install_authentication_plugin
  return unless @with_authentication

  install_plugin(plugin_name: 'solidus_auth_devise', plugin_generator_name: 'solidus:auth:install')
end

#install_file_attachment ⇒ Object 



76
77
78
79
80
81
82
83
84
 
# File 'lib/generators/solidus/install/install_generator.rb', line 76

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

#install_frontend ⇒ Object 



172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/generators/solidus/install/install_generator.rb', line 172

def install_frontend
  @selected_frontend = detect_frontend_to_install

  if @selected_frontend == 'none'
    support_solidus_frontend_extraction
  else
    support_solidus_frontend_extraction unless @selected_frontend == LEGACY_FRONTEND

    say_status :installing, @selected_frontend

    InstallFrontend
      .new(bundler_context: bundler_context, generator_context: self)
      .call(@selected_frontend)

    # The DEFAULT_FRONTEND installation makes changes to the
    # bundle without updating the bundler context. As such, we need to
    # reset the bundler context to get the latest dependencies from the
    # context.
    reset_bundler_context if @selected_frontend == DEFAULT_FRONTEND
  end
end

#install_migrations ⇒ Object 



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

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

#install_payment_method ⇒ Object 



200
201
202
 
# File 'lib/generators/solidus/install/install_generator.rb', line 200

def install_payment_method
  apply_template_for :payment_method, @selected_payment_method
end

#install_routes ⇒ Object 



237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/generators/solidus/install/install_generator.rb', line 237

def install_routes
  routes_file_path = File.join('config', 'routes.rb')
  unless File.read(routes_file_path).include? CORE_MOUNT_ROUTE
    insert_into_file routes_file_path, after: "Rails.application.routes.draw do\n" do
      <<-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

  unless options[:quiet]
    puts "*" * 50
    puts "We added the following line to your application's config/routes.rb file:"
    puts " "
    puts "    #{CORE_MOUNT_ROUTE}, at: '/'"
  end
end

#load_sample_data ⇒ Object 



228
229
230
231
232
233
234
235
 
# File 'lib/generators/solidus/install/install_generator.rb', line 228

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 



214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/generators/solidus/install/install_generator.rb', line 214

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 



61
62
63
64
65
66
67
68
69
70
 
# File 'lib/generators/solidus/install/install_generator.rb', line 61

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

  unless @run_migrations
     @load_seed_data = false
     @load_sample_data = false
  end
end

#run_migrations ⇒ Object 



204
205
206
207
208
209
210
211
212
 
# File 'lib/generators/solidus/install/install_generator.rb', line 204

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

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

#select_auth_plugin ⇒ Object 



129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/generators/solidus/install/install_generator.rb', line 129

def select_auth_plugin
  @with_authentication = options[:with_authentication]
  @with_authentication.nil? and @with_authentication = (options[:auto_accept] || !no?("
    Solidus has a default authentication extension that uses Devise.
    You can find more info at https://github.com/solidusio/solidus_auth_devise.

    Regardless of what you answer here, it'll be installed if you choose
    solidus_starter_frontend as your storefront in a later step.

    Would you like to install it? (Y/n)"))
end

#select_payment_method ⇒ Object 



141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/generators/solidus/install/install_generator.rb', line 141

def select_payment_method
  say_status :warning, set_color(
    "Selecting a payment along with `solidus_starter_frontend` might require manual integration.",
    :yellow
  ), :yellow

  @selected_payment_method = options[:payment_method]
  @selected_payment_method ||= PAYMENT_METHODS.keys.first if options[:auto_accept]
  @selected_payment_method ||= ask("
  You can select a payment method to be included in the installation process.
  Please select a payment method name:", limited_to: PAYMENT_METHODS.keys, default: PAYMENT_METHODS.keys.first)
end

#setup_assets ⇒ Object 



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

def setup_assets
  @lib_name = 'spree'

  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