Update dependencies to Solidus 2.0 and Alchemy 4.0

.gitignore

@@ -1,7 +1,5 @@
 .bundle/
 log/*.log
 pkg/
-test/dummy/db/*.sqlite3
-test/dummy/log/*.log
-test/dummy/tmp/
-Gemfile.lock
+/spec/dummy/
+Gemfile.lock

.rspec

@@ -0,0 +1 @@
+--require spec_helper

Gemfile

@@ -5,3 +5,4 @@ gemspec
 
 gem 'sqlite3'
 gem 'alchemy-devise'
+gem 'pry-rails'

README.md

@@ -34,6 +34,22 @@ Install the gem with:
 $ bundle install
 ```
 
+## Automated setup
+
+We ship a Rails generator that helps you to install this gem into your existing Rails app.
+
+```
+$ bin/rails g alchemy:solidus:install
+```
+
+There are several options available, please check them by:
+
+```
+$ bin/rails g alchemy:solidus:install --help
+```
+
+## Manual setup
+
 ### Authentication system installation
 
 Both Alchemy and Solidus come without an authentication system in place. You will need to choose an authentication system yourself. There are 3 available options. Whichever you choose, you need to instruct Solidus & Alchemy about your choice of authentication system.

Rakefile

@@ -4,20 +4,24 @@ begin
 rescue LoadError
   puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
 end
-begin
-  require 'rdoc/task'
-rescue LoadError
-  require 'rdoc/rdoc'
-  require 'rake/rdoctask'
-  RDoc::Task = Rake::RDocTask
-end
+Bundler::GemHelper.install_tasks
 
-RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'AlchemySolidus'
-  rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('README.rdoc')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
 
-Bundler::GemHelper.install_tasks
+task default: [:test_setup, :spec]
+
+require 'active_support/core_ext/string'
+
+desc 'Setup test app'
+task :test_setup do
+  Dir.chdir('spec/dummy') do
+    system <<-SETUP.strip_heredoc
+      export RAILS_ENV=test && \
+      bin/rake db:drop db:create && \
+      bin/rails g spree:install --force --quiet --auto-accept --no-seed --no-sample && \
+      bin/rails g alchemy:solidus:install --auto-accept
+    SETUP
+  end
+end

alchemy-solidus.gemspec

@@ -15,7 +15,14 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = Alchemy::Solidus::VERSION
 
-  gem.add_dependency('alchemy_cms', ['~> 3.2'])
-  gem.add_dependency('solidus', ['~> 1.0'])
+  gem.add_dependency('alchemy_cms', ['>= 4.0.0.beta', '< 5.0'])
+  gem.add_dependency('solidus_core', ['~> 2.0'])
+  gem.add_dependency('solidus_backend', ['~> 2.0'])
   gem.add_dependency('deface', ['~> 1.0'])
+
+  gem.add_development_dependency('rspec-rails', ['~> 3.7'])
+  gem.add_development_dependency('capybara', ['~> 2.15'])
+  gem.add_development_dependency('capybara-screenshot', ['~> 1.0'])
+  gem.add_development_dependency('factory_bot', ['~> 4.8'])
+  gem.add_development_dependency('ffaker', ['~> 2.7'])
 end

bin/rails

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails gems
+# installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/alchemy/solidus/engine', __FILE__)
+APP_PATH = File.expand_path('../../spec/dummy/config/application', __FILE__)
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+
+require 'rails/all'
+require 'rails/engine/commands'

db/migrate/20120229160509_create_alchemy_essence_spree_products.rb

@@ -1,4 +1,4 @@
-class CreateAlchemyEssenceSpreeProducts < ActiveRecord::Migration
+class CreateAlchemyEssenceSpreeProducts < ActiveRecord::Migration[4.2]
 	def change
 		create_table 'alchemy_essence_spree_products' do |t|
 			t.integer :spree_product_id

db/migrate/20131030140218_create_alchemy_essence_spree_taxons.rb

@@ -1,4 +1,4 @@
-class CreateAlchemyEssenceSpreeTaxons < ActiveRecord::Migration
+class CreateAlchemyEssenceSpreeTaxons < ActiveRecord::Migration[4.2]
   def change
     create_table :alchemy_essence_spree_taxons do |t|
       t.references :taxon

lib/alchemy-solidus.rb

@@ -1,3 +1 @@
-require "alchemy_cms"
-require "solidus"
 require "alchemy/solidus/engine"

lib/alchemy/solidus/alchemy_user_extension.rb

@@ -1,9 +1,17 @@
-module Alchemy::SpreeUserExtension
-  def spree_roles
-    if admin?
-      ::Spree::Role.where(name: 'admin')
-    else
-      ::Spree::Role.none
+module Alchemy
+  module Solidus
+    module AlchemyUserExtension
+      def self.included(klass)
+        klass.include Spree::UserMethods
+      end
+
+      def spree_roles
+        if admin?
+          ::Spree::Role.where(name: 'admin')
+        else
+          ::Spree::Role.none
+        end
+      end
     end
   end
 end

lib/alchemy/solidus/engine.rb

@@ -1,5 +1,8 @@
 require 'alchemy/solidus/alchemy_user_extension'
 require 'alchemy/solidus/spree_user_extension'
+require 'alchemy_cms'
+require 'solidus_core'
+require 'solidus_backend'
 
 module Alchemy
   module Solidus
@@ -15,8 +18,16 @@ class Engine < ::Rails::Engine
       config.to_prepare do
         Alchemy.register_ability ::Spree::Ability
         ::Spree::Ability.register_ability ::Alchemy::Permissions
-        Spree::User.include Spree::AlchemyUserExtension if Alchemy.user_class_name == 'Spree::User'
-        Alchemy::User.include Alchemy::SpreeUserExtension if Alchemy.user_class_name == 'Alchemy::User'
+
+        if Alchemy.user_class_name == 'Spree::User'
+          require 'alchemy/solidus/spree_user_extension'
+          Spree::User.include Alchemy::Solidus::SpreeUserExtension
+        end
+
+        if Alchemy.user_class_name == 'Alchemy::User'
+          require 'alchemy/solidus/alchemy_user_extension'
+          Alchemy::User.include Alchemy::Solidus::AlchemyUserExtension
+        end
       end
     end
   end

lib/alchemy/solidus/spree_user_extension.rb

@@ -1,9 +1,13 @@
-module Spree::AlchemyUserExtension
-  def alchemy_roles
-    if has_spree_role?(:admin)
-      %w(admin)
-    else
-      []
+module Alchemy
+  module Solidus
+    module SpreeUserExtension
+      def alchemy_roles
+        if has_spree_role?(:admin)
+          %w(admin)
+        else
+          []
+        end
+      end
     end
   end
 end

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

@@ -0,0 +1,69 @@
+require 'rails/generators'
+require 'rails/generators/alchemy/install/install_generator'
+require 'generators/spree/custom_user/custom_user_generator'
+
+begin
+  require 'generators/alchemy/devise/install/install_generator'
+rescue
+end
+
+module Alchemy
+  module Solidus
+    class InstallGenerator < Rails::Generators::Base
+      SPREE_MOUNT_REGEXP = /mount\sSpree::Core::Engine.*$/
+      desc "Installs Alchemy Solidus into your App."
+
+      class_option :skip_alchemy_installer, default: false, type: :boolean,
+        desc: "Set true if you don't want to run the Alchemy installer"
+      class_option :skip_alchemy_devise_installer, default: false, type: :boolean,
+        desc: "Set true if you don't want to run the Alchemy Devise installer. NOTE: Automatically skipped if Alchemy::Devise is not available."
+      class_option :skip_spree_custom_user_generator, default: false, type: :boolean,
+        desc: "Set true if you don't want to run the Solidus custom user generator. NOTE: Automatically skipped if Alchemy::Devise is not available."
+      class_option :auto_accept, default: false, type: :boolean,
+        desc: 'Set true if run from a automated script (ie. on a CI)'
+
+      def run_alchemy_installer
+        unless options[:skip_alchemy_installer]
+          arguments = options[:auto_accept] ? ['--skip-demo-files', '--force'] : []
+          Alchemy::Generators::InstallGenerator.start(arguments)
+        end
+      end
+
+      def run_alchemy_devise_installer
+        if Kernel.const_defined?('Alchemy::Devise') && !options[:skip_alchemy_devise_installer]
+          arguments = options[:auto_accept] ? ['--force'] : []
+          Alchemy::Devise::Generators::InstallGenerator.start(arguments)
+        end
+      end
+
+      def run_spree_custom_user_generator
+        if Kernel.const_defined?('Alchemy::Devise') && !options[:skip_spree_custom_user_generator]
+          arguments = options[:auto_accept] ? ['Alchemy::User', '--force'] : ['Alchemy::User']
+          Spree::CustomUserGenerator.start(arguments)
+          spree_initializer_file = Rails.root.join('config', 'initializers', 'spree.rb')
+          file_action = File.exist?(spree_initializer_file) ? :append_file : :create_file
+          public_send(file_action, spree_initializer_file) do
+            %{\nSpree.user_class = "Alchemy::User"\n}
+          end
+          rake 'db:migrate'
+        end
+      end
+
+      def inject_routes
+        routes_file_path = Rails.root.join('config', 'routes.rb')
+        mountpoint = '/'
+        unless options[:auto_accept]
+          mountpoint = ask("\nAt which path do you want to mount AlchemyCMS at?", default: mountpoint)
+        end
+        if File.read(routes_file_path).match SPREE_MOUNT_REGEXP
+          sentinel = SPREE_MOUNT_REGEXP
+        else
+          sentinel = "Rails.application.routes.draw do\n"
+        end
+        inject_into_file routes_file_path, {after: sentinel} do
+          "\n  mount Alchemy::Engine, at: '/#{mountpoint.chomp('/')}'\n"
+        end
+      end
+    end
+  end
+end

spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require_relative 'config/application'
+
+Rails.application.load_tasks

spec/dummy/app/assets/config/manifest.js

@@ -0,0 +1,5 @@
+
+//= link_tree ../images
+//= link_directory ../javascripts .js
+//= link_directory ../stylesheets .css
+//= link rails5_engine_manifest.js

spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery with: :exception
+end

spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

spec/dummy/app/models/application_record.rb

@@ -0,0 +1,3 @@
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+end

spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Dummy</title>
+    <%= csrf_meta_tags %>
+
+    <%= stylesheet_link_tag    'application', media: 'all' %>
+    <%= javascript_include_tag 'application' %>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

spec/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

spec/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../config/application', __dir__)
+require_relative '../config/boot'
+require 'rails/commands'

spec/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

spec/dummy/bin/setup

@@ -0,0 +1,38 @@
+#!/usr/bin/env ruby
+require 'pathname'
+require 'fileutils'
+include FileUtils
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../', __FILE__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+chdir APP_ROOT do
+  # This script is a starting point to setup your application.
+  # Add necessary setup steps to this file.
+
+  puts '== Installing dependencies =='
+  system! 'gem install bundler --conservative'
+  system('bundle check') || system!('bundle install')
+
+  # Install JavaScript dependencies if using Yarn
+  # system('bin/yarn')
+
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?('config/database.yml')
+  #   cp 'config/database.yml.sample', 'config/database.yml'
+  # end
+
+  puts "\n== Preparing database =="
+  system! 'bin/rails db:setup'
+
+  puts "\n== Removing old logs and tempfiles =="
+  system! 'bin/rails log:clear tmp:clear'
+
+  puts "\n== Restarting application server =="
+  system! 'bin/rails restart'
+end