Class: Solidus::InstallGenerator

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

Constant Summary collapse

CORE_MOUNT_ROUTE = 
"mount Spree::Core::Engine"
PAYMENT_METHODS = 
{
  'paypal' => 'solidus_paypal_commerce_platform',
  'none' => nil,
}

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.source_paths ⇒ Object 



32
33
34
35
36
37
38
 
# File 'lib/generators/solidus/install/install_generator.rb', line 32

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 



51
52
53
 
# File 'lib/generators/solidus/install/install_generator.rb', line 51

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

#additional_tweaks ⇒ Object 



65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/generators/solidus/install/install_generator.rb', line 65

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 



249
250
251
252
253
254
255
256
 
# File 'lib/generators/solidus/install/install_generator.rb', line 249

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 



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/generators/solidus/install/install_generator.rb', line 105

def configure_application
  application <<-RUBY
# Load application's model / class decorators
initializer 'spree.decorators' do |app|
  config.to_prepare do
    Dir.glob(Rails.root.join('app/**/*_decorator*.rb')) do |path|
      require_dependency(path)
    end
  end
end
  RUBY

  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 



174
175
176
177
 
# File 'lib/generators/solidus/install/install_generator.rb', line 174

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

#create_overrides_directory ⇒ Object 



101
102
103
 
# File 'lib/generators/solidus/install/install_generator.rb', line 101

def create_overrides_directory
  empty_directory "app/overrides"
end

#include_seed_data ⇒ Object 



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

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_auth_plugin ⇒ Object 



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

def install_auth_plugin
  if options[: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.

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

    @plugins_to_be_installed << 'solidus_auth_devise'
    @plugin_generators_to_run << 'solidus:auth:install'
  end
end

#install_file_attachment ⇒ Object 



55
56
57
58
59
60
61
62
63
 
# File 'lib/generators/solidus/install/install_generator.rb', line 55

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_migrations ⇒ Object 



169
170
171
172
 
# File 'lib/generators/solidus/install/install_generator.rb', line 169

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

#install_payment_method ⇒ Object 



142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/generators/solidus/install/install_generator.rb', line 142

def install_payment_method
  name = options[:payment_method]

  unless options[:auto_accept]
    available_names = PAYMENT_METHODS.keys

    name = ask("
  You can select a payment method to be included in the installation process.
  Please select a payment method name:", limited_to: available_names, default: available_names.first)
  end

  gem_name = PAYMENT_METHODS.fetch(name)

  if gem_name
    @plugins_to_be_installed << gem_name
    @plugin_generators_to_run << "#{gem_name}:install"
  end
end

#install_routes ⇒ Object 



225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/generators/solidus/install/install_generator.rb', line 225

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 



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

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

#plugin_install_preparation ⇒ Object 



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

def plugin_install_preparation
  @plugins_to_be_installed = []
  @plugin_generators_to_run = []
end

#populate_seed_data ⇒ Object 



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

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 



40
41
42
43
44
45
46
47
48
49
 
# File 'lib/generators/solidus/install/install_generator.rb', line 40

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_bundle_install_if_needed_by_plugins ⇒ Object 



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

def run_bundle_install_if_needed_by_plugins
  @plugins_to_be_installed.each do |plugin_name|
    gem plugin_name
  end

  bundle_cleanly{ run "bundle install" } if @plugins_to_be_installed.any?
  run "spring stop" if defined?(Spring)

  @plugin_generators_to_run.each do |plugin_generator_name|
    generate "#{plugin_generator_name} --skip_migrations=true"
  end
end

#run_migrations ⇒ Object 



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

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

#setup_assets ⇒ Object 



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

def setup_assets
  @lib_name = 'spree'

  empty_directory 'app/assets/images'

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

  if defined? Spree::Frontend || Rails.env.test?
    template "vendor/assets/javascripts/spree/frontend/all.js"
    template "vendor/assets/stylesheets/spree/frontend/all.css"
  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