Merge pull request #233 from nebulab/elia/fix-the-standard-generator

Fix the standard generator alias and remove interactivity from seeds

Author: kennyadsl

.circleci/config.yml

@@ -16,8 +16,8 @@ jobs:
       name: solidusio_extensions/postgres
       ruby_version: '3.1'
     steps:
-      - browser-tools/install-browser-tools
       - checkout
+      - browser-tools/install-chrome
       - solidusio_extensions/run-tests-solidus-master
       - solidusio_extensions/store-test-results
 
@@ -26,8 +26,8 @@ jobs:
       name: solidusio_extensions/mysql
       ruby_version: '3.0'
     steps:
-      - browser-tools/install-browser-tools
       - checkout
+      - browser-tools/install-chrome
       - solidusio_extensions/run-tests-solidus-current
       - solidusio_extensions/store-test-results
 
@@ -36,15 +36,14 @@ jobs:
       name: solidusio_extensions/sqlite
       ruby_version: '2.7'
     steps:
-      - browser-tools/install-browser-tools
       - checkout
+      - browser-tools/install-chrome
       - solidusio_extensions/run-tests-solidus-older
       - solidusio_extensions/store-test-results
 
   lint-code:
-    executor: solidusio_extensions/sqlite-memory
+    executor: solidusio_extensions/sqlite
     steps:
-      - browser-tools/install-browser-tools
       - solidusio_extensions/lint-code
 
 workflows:

Gemfile

@@ -25,13 +25,13 @@ if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('3')
   # the 'async' gem that relies on the latest ruby, since RubyGems doesn't
   # resolve gems based on the required ruby version.
   gem 'async', '< 3', require: false
-
-  # 'net/smtp' is required by 'mail', see:
-  # - https://github.com/ruby/net-protocol/issues/10
-  # - https://stackoverflow.com/a/72474475
-  gem 'net-smtp', require: false
 end
 
+# 'net/smtp' is required by 'mail', see:
+# - https://github.com/ruby/net-protocol/issues/10
+# - https://stackoverflow.com/a/72474475
+gem 'net-smtp', require: false
+
 gemspec
 
 # Use a local Gemfile to include development dependencies that might not be

bin/rails

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-if %w[g generate].include? ARGV.first
+if %w[g generate].include?(ARGV.first) && ARGV[1] !~ /^(solidus:auth:|solidus_auth_devise:)/
   exec "#{__dir__}/rails-engine", *ARGV
 else
   exec "#{__dir__}/rails-sandbox", *ARGV

bin/sandbox

@@ -71,6 +71,7 @@ cat <<RUBY >> Gemfile
 gem 'solidus', github: 'solidusio/solidus', branch: '$BRANCH'
 gem 'rails-i18n'
 gem 'solidus_i18n'
+gem 'net-smtp', require: false
 
 gem '$extension_name', path: '..'
 

db/default/users.rb

@@ -1,78 +1,38 @@
 # frozen_string_literal: true
 
-# see last line where we create an admin if there is none, asking for email and password
-def prompt_for_admin_password
-  if ENV['ADMIN_PASSWORD']
-    password = ENV['ADMIN_PASSWORD'].dup
-    puts "Admin Password #{password}"
-  else
-    print "Password [test123]: "
-    password = STDIN.gets.strip
-    password = 'test123' if password.blank?
-  end
+admin_role = Spree::Role.find_or_create_by(name: 'admin')
 
-  password
+if Spree::User.admin.any?
+  puts 'No admin user created.'
+  return
 end
 
-def prompt_for_admin_email
-  if ENV['ADMIN_EMAIL']
-    email = ENV['ADMIN_EMAIL'].dup
-    puts "Admin User #{email}"
-  else
-    print "Email [admin@example.com]: "
-    email = STDIN.gets.strip
-    email = 'admin@example.com' if email.blank?
-  end
+email = ENV['ADMIN_EMAIL'] || 'admin@example.com'
+password = ENV['ADMIN_PASSWORD'] || 'test123'
 
-  email
-end
-
-def create_admin_user
-  if ENV['AUTO_ACCEPT']
-    password = 'test123'
-    email = 'admin@example.com'
-  else
-    puts 'Create the admin user (press enter for defaults).'
-    # name = prompt_for_admin_name unless name
-    email = prompt_for_admin_email
-    password = prompt_for_admin_password
-  end
-  attributes = {
-    password: password,
-    password_confirmation: password,
-    email: email,
-    login: email
-  }
-
-  load 'spree/user.rb'
+puts "Creating admin user with:"
+puts "  - email: #{email}"
+puts "  - password: #{password}"
+puts "(please use the ADMIN_EMAIL and ADMIN_PASSWORD environment variables to control how the default admin user is created)"
 
-  if Spree::User.find_by(email: email)
-    puts "\nWARNING: There is already a user with the email: #{email}, so no account changes were made.  If you wish to create an additional admin user, please run rake spree_auth:admin:create again with a different email.\n\n"
-  else
-    admin = Spree::User.new(attributes)
-    if admin.save
-      role = Spree::Role.find_or_create_by(name: 'admin')
-      admin.spree_roles << role
-      admin.save
-      admin.generate_spree_api_key!
-      puts "Done!"
-    else
-      puts "There were some problems with persisting a new admin user:"
-      admin.errors.full_messages.each do |error|
-        puts error
-      end
-    end
-  end
+if Spree::User.find_by(email: email)
+  warn "WARNING: There is already a user with the email: #{email}, so no account changes were made."
+  return
 end
 
-if Spree::User.admin.empty?
-  create_admin_user
+admin = Spree::User.new(
+  password: password,
+  password_confirmation: password,
+  email: email,
+  login: email,
+)
+
+if admin.save
+  admin.spree_roles << admin_role
+  admin.save
+  admin.generate_spree_api_key!
 else
-  puts 'Admin user has already been created.'
-  puts 'Would you like to create a new admin user? (yes/no)'
-  if ["yes", "y"].include? STDIN.gets.strip.downcase
-    create_admin_user
-  else
-    puts 'No admin user created.'
-  end
+  warn "There were some problems while creating the admin user:"
+  warn(admin.errors.full_messages.map { |m| "- #{m}" })
+  warn "(attributes: #{admin.attributes.inspect})"
 end

lib/generators/solidus/auth/install/install_generator.rb

@@ -4,31 +4,38 @@ module Solidus
   module Auth
     module Generators
       class InstallGenerator < Rails::Generators::Base
-        class_option :auto_run_migrations, type: :boolean, default: false
-        class_option :skip_migrations, type: :boolean, default: false
+        class_option :auto_run_migrations, type: :boolean, desc: "Run migrations automatically"
+        class_option :skip_migrations, type: :boolean, desc: "Skip migrations"
 
-        def self.source_paths
-          paths = superclass.source_paths
-          paths << File.expand_path('templates', __dir__)
-          paths.flatten
-        end
+        class_option :interactive, type: :boolean, default: false, desc: "Enable interactive mode"
+        class_option :admin_email, type: :string
+        class_option :admin_password, type: :string
+
+        source_root "#{__dir__}/templates"
 
         def generate_devise_key
           template 'config/initializers/devise.rb', 'config/initializers/devise.rb', skip: true
         end
 
         def add_migrations
-          run 'bundle exec rake railties:install:migrations FROM=solidus_auth'
+          admin_email = options[:admin_email] || (options[:interactive] && ask("Email:", default: 'admin@example.com'))
+          admin_password = options[:admin_password] || (options[:interactive] && ask("Password:", default: 'test123'))
+
+          options = []
+          options << "ADMIN_EMAIL=#{admin_email}" if admin_email
+          options << "ADMIN_PASSWORD=#{admin_password}" if admin_password
+
+          rake "railties:install:migrations FROM=solidus_auth #{options.shelljoin}"
         end
 
         def run_migrations
-          return if options[:skip_migrations]
+          if options[:skip_migrations] ||
+            options[:auto_run_migrations] == false || # exclude nil
+            options[:interactive] && no?('Would you like to run the migrations now?')
 
-          run_migrations = options[:auto_run_migrations] || ['', 'y', 'Y'].include?(ask('Would you like to run the migrations now? [Y/n]'))
-          if run_migrations
-            run 'bundle exec rake db:migrate'
+            say_status :skip, 'Skipping rake db:migrate, don\'t forget to run it!', :yellow
           else
-            puts 'Skipping rake db:migrate, don\'t forget to run it!' # rubocop:disable Rails/Output
+            rake 'db:migrate'
           end
         end
       end

lib/generators/solidus_auth_devise/install/install_generator.rb

@@ -1,8 +1,18 @@
 # frozen_string_literal: true
 
 require_relative '../../solidus/auth/install/install_generator'
+
 module SolidusAuthDevise
   module Generators
-    InstallGenerator = ::Solidus::Auth::Generators::InstallGenerator
+    class InstallGenerator < Rails::Generators::Base
+      # Copy over any class option from the legacy install generator
+      Solidus::Auth::Generators::InstallGenerator.class_options.each do |name, option|
+        class_options[name] ||= option.dup
+      end
+
+      def forward_to_spree_auth_install
+        generate 'solidus:auth:install', *ARGV
+      end
+    end
   end
 end

lib/solidus_auth_devise/engine.rb

@@ -1,7 +1,3 @@
 # frozen_string_literal: true
 
 require 'spree/auth/engine'
-
-module SolidusAuthDevise
-  Engine = ::Spree::Auth::Engine
-end

lib/spree/auth/engine.rb

@@ -95,3 +95,5 @@ def self.prepare_frontend
     end
   end
 end
+
+SolidusAuthDevise::Engine = Spree::Auth::Engine