Class: Solidus::InstallGenerator

Inherits:

Rails::Generators::Base

• Object
• Rails::Generators::Base
• Solidus::InstallGenerator

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

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

• .source_paths ⇒ Object

Instance Method Summary

• #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_frontend ⇒ 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

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

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

# File 'lib/generators/solidus/install/install_generator.rb', line 69

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

#additional_tweaks ⇒ Object

# File 'lib/generators/solidus/install/install_generator.rb', line 83

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

# File 'lib/generators/solidus/install/install_generator.rb', line 272

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

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

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

# File 'lib/generators/solidus/install/install_generator.rb', line 181

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

#create_overrides_directory ⇒ Object

# File 'lib/generators/solidus/install/install_generator.rb', line 113

def create_overrides_directory
  empty_directory "app/overrides"
end

#include_seed_data ⇒ Object

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

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

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

def install_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)"))

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

#install_file_attachment ⇒ Object

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

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

# File 'lib/generators/solidus/install/install_generator.rb', line 186

def install_frontend
  return if options[:frontend] == 'none'

  bundler_context = BundlerContext.new

  frontend = detect_frontend_to_install(bundler_context)

  support_solidus_frontend_extraction(bundler_context) unless frontend == LEGACY_FRONTEND

  say_status :installing, frontend

  InstallFrontend
    .new(bundler_context: bundler_context, generator_context: self)
    .call(frontend)
end

#install_migrations ⇒ Object

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

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

#install_payment_method ⇒ Object

# File 'lib/generators/solidus/install/install_generator.rb', line 148

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

  name = options[:payment_method]
  name ||= PAYMENT_METHODS.keys.first if options[:auto_accept]
  name ||= 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)

  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

# File 'lib/generators/solidus/install/install_generator.rb', line 248

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

# File 'lib/generators/solidus/install/install_generator.rb', line 239

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

# 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

# File 'lib/generators/solidus/install/install_generator.rb', line 225

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

# File 'lib/generators/solidus/install/install_generator.rb', line 58

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

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

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

  BundlerContext.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

# File 'lib/generators/solidus/install/install_generator.rb', line 215

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

# File 'lib/generators/solidus/install/install_generator.rb', line 98

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