Class: Solidus::InstallGenerator
- Inherits:
-
Rails::Generators::Base
- Object
- Rails::Generators::Base
- Solidus::InstallGenerator
- 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
- #add_files ⇒ Object
- #additional_tweaks ⇒ Object
- #complete ⇒ Object
- #configure_application ⇒ Object
- #create_database ⇒ Object
- #create_overrides_directory ⇒ Object
- #include_seed_data ⇒ Object
- #install_auth_plugin ⇒ Object
- #install_file_attachment ⇒ Object
- #install_migrations ⇒ Object
- #install_payment_method ⇒ Object
- #install_routes ⇒ Object
- #load_sample_data ⇒ Object
- #plugin_install_preparation ⇒ Object
- #populate_seed_data ⇒ Object
- #prepare_options ⇒ Object
- #run_bundle_install_if_needed_by_plugins ⇒ Object
- #run_migrations ⇒ Object
- #setup_assets ⇒ Object
Class Method Details
.source_paths ⇒ Object
33 34 35 36 37 38 39 |
# File 'lib/generators/solidus/install/install_generator.rb', line 33 def self.source_paths paths = superclass.source_paths paths << File.('../templates', "../../#{__FILE__}") paths << File.('../templates', "../#{__FILE__}") paths << File.('templates', __dir__) paths.flatten end |
Instance Method Details
#add_files ⇒ Object
52 53 54 |
# File 'lib/generators/solidus/install/install_generator.rb', line 52 def add_files template 'config/initializers/spree.rb.tt', 'config/initializers/spree.rb' end |
#additional_tweaks ⇒ Object
66 67 68 69 70 71 72 73 74 75 76 77 78 79 |
# File 'lib/generators/solidus/install/install_generator.rb', line 66 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
250 251 252 253 254 255 256 257 |
# File 'lib/generators/solidus/install/install_generator.rb', line 250 def complete unless [:quiet] puts "*" * 50 puts "Solidus has been installed successfully. You're all ready to go!" puts " " puts "Enjoy!" end end |
#configure_application ⇒ Object
106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 |
# File 'lib/generators/solidus/install/install_generator.rb', line 106 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 ![:enforce_available_locales].nil? application <<-RUBY # Prevent this deprecation message: https://github.com/svenfuchs/i18n/commit/3b6e56e I18n.enforce_available_locales = #{[:enforce_available_locales]} RUBY end end |
#create_database ⇒ Object
175 176 177 178 |
# File 'lib/generators/solidus/install/install_generator.rb', line 175 def create_database say_status :creating, "database" rake 'db:create' end |
#create_overrides_directory ⇒ Object
102 103 104 |
# File 'lib/generators/solidus/install/install_generator.rb', line 102 def create_overrides_directory empty_directory "app/overrides" end |
#include_seed_data ⇒ Object
162 163 164 165 166 167 168 |
# File 'lib/generators/solidus/install/install_generator.rb', line 162 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
131 132 133 134 135 136 137 138 139 140 141 |
# File 'lib/generators/solidus/install/install_generator.rb', line 131 def install_auth_plugin if [:with_authentication] && ([: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
56 57 58 59 60 61 62 63 64 |
# File 'lib/generators/solidus/install/install_generator.rb', line 56 def if [: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
170 171 172 173 |
# File 'lib/generators/solidus/install/install_generator.rb', line 170 def install_migrations say_status :copying, "migrations" `rake railties:install:migrations` end |
#install_payment_method ⇒ Object
143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 |
# File 'lib/generators/solidus/install/install_generator.rb', line 143 def install_payment_method name = [:payment_method] unless [: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
226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 |
# File 'lib/generators/solidus/install/install_generator.rb', line 226 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 [: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
217 218 219 220 221 222 223 224 |
# File 'lib/generators/solidus/install/install_generator.rb', line 217 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
126 127 128 129 |
# File 'lib/generators/solidus/install/install_generator.rb', line 126 def plugin_install_preparation @plugins_to_be_installed = [] @plugin_generators_to_run = [] end |
#populate_seed_data ⇒ Object
203 204 205 206 207 208 209 210 211 212 213 214 215 |
# File 'lib/generators/solidus/install/install_generator.rb', line 203 def populate_seed_data if @load_seed_data say_status :loading, "seed data" = [] << "AUTO_ACCEPT=1" if [:auto_accept] << "ADMIN_EMAIL=#{[:admin_email]}" if [:admin_email] << "ADMIN_PASSWORD=#{[:admin_password]}" if [:admin_password] rake("db:seed #{.join(' ')}") else say_status :skipping, "seed data (you can always run rake db:seed)" end end |
#prepare_options ⇒ Object
41 42 43 44 45 46 47 48 49 50 |
# File 'lib/generators/solidus/install/install_generator.rb', line 41 def @run_migrations = [:migrate] @load_seed_data = [:seed] @load_sample_data = [:sample] unless @run_migrations @load_seed_data = false @load_sample_data = false end end |
#run_bundle_install_if_needed_by_plugins ⇒ Object
180 181 182 183 184 185 186 187 188 189 190 191 |
# File 'lib/generators/solidus/install/install_generator.rb', line 180 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
193 194 195 196 197 198 199 200 201 |
# File 'lib/generators/solidus/install/install_generator.rb', line 193 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
81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 |
# File 'lib/generators/solidus/install/install_generator.rb', line 81 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 |