alchemy-solidus 2.5.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 78297e4bf371b6cfc4d26faa46417dbcbf165650a64d484f60dac52feae1ebde
-  data.tar.gz: 9d985945b0d70a693cef42837edf97791ac4c7b3b38b5df5e5e5c79e21382642
+  metadata.gz: a20516abea7d38b47f1a022998b93c48dddadff27a75e82bf511b0d4bde77792
+  data.tar.gz: c991f9f52ce9c98a87adc6b8ca880564c8f8bfc2802aff44b17b808e252543b2
 SHA512:
-  metadata.gz: 0c1f70ee1697b9dc3aa3fdca9ab58e532a5adbf81c0ed5ddc7f3c1e07033c77717b43815920ca47f9d1a0731792fe69e7185402289a9cb5a4aa99bb4a6ae5d53
-  data.tar.gz: 7e5923735790b534b8e780f71a51b3cb4e07c34692a7977bf0accf9abb949406eee23cd4166c839b6d40df62c374832367e2dedef16f11ac4163e84041ec6c50
+  metadata.gz: fb405c8a49ba7ce079fe81a94577447673c1c0f6b22b8161153097dec0f6f9e65af98bfb91be37ba26ca3bf0f71ef1e336e34968b70154a71ae5ac440dea3510
+  data.tar.gz: 959ff15ccbba0ab90a0a170bd9cc5fcffe099b89f388fb2066b220c0e45d9636782fe4c4e4a76cfb92e2a177801b520b499954493de84f31890663cb292acd37

data/README.md

@@ -41,6 +41,8 @@ $ bundle install
 
 ## Automated setup
 
+**Recommended**
+
 We ship a Rails generator that helps you to install this gem into your existing application.
 
 ```bash
@@ -61,9 +63,11 @@ To upgrade update the Gemfile and run the install generator again
 $ bin/rails g alchemy:solidus:install
 ```
 
-## Manual setup
+**NOTE** Please make sure to remove the `Alchemy::Modules.register_module` part from your `config/initializer/alchemy.rb` file if upgrading from 2.5.
+
+## Manual setup (for advanced users)
 
-If you want to have full control over the integration you can also set this up manually.
+For regular setups we recommend the [automated installer](#automated-setup) mentioned above. But if you know what you are doing and want to have full control over the integration you can also set this up manually.
 
 ### Authentication system installation
 
@@ -178,26 +182,30 @@ and follow the on screen instructions.
 
 ### Render Alchemy Content in Solidus Layout
 
-If you plan to render the Alchemy site in the Solidus layout add the following
-to your initializer:
+~~If you plan to render the Alchemy site in the Solidus layout add the following
+to your initializer:~~
 
 ```ruby
 # config/initializers/alchemy.rb
 require 'alchemy/solidus/use_solidus_layout'
 ```
 
+**NOTE:** Since v2.5.2 this is done automatically for you. If you upgraded from an older version you can safely remove this from your initializers.
+
 ### Render Alchemy Content in Solidus views
 
-If you plan to render Alchemy content in your Solidus views (ie. a global header
+~~If you plan to render Alchemy content in your Solidus views (ie. a global header
 or footer section), you need to include the Alchemy view helpers and language
 store in your Solidus controllers with the following addition to your
-initializer:
+initializer:~~
 
 ```ruby
 # config/initializers/alchemy.rb
 require 'alchemy/solidus/alchemy_in_solidus'
 ```
 
+**NOTE:** Since v2.5.2 this is done automatically for you. If you upgraded from an older version you can safely remove this from your initializers.
+
 ### Routing
 
 For routing you have a few options.

data/Rakefile

@@ -20,7 +20,7 @@ task :test_setup do
     system <<-SETUP.strip_heredoc
       export RAILS_ENV=test && \
       bin/rake db:environment:set db:drop && \
-      bin/rails g spree:install --force --quiet --auto-accept --no-seed --no-sample && \
+      bin/rails g spree:install --force --auto-accept --no-seed --no-sample && \
       bin/rails g alchemy:solidus:install --auto-accept --force
     SETUP
     exit($?.exitstatus) unless $?.success?

data/config/initializers/alchemy.rb

@@ -42,6 +42,14 @@ if defined?(Spree::Auth::Engine)
       name: 'Users'
     }
   )
+  Alchemy.user_class_name = 'Spree::User'
+  Alchemy.current_user_method = :spree_current_user
+
+  if Alchemy.respond_to?(:logout_method)
+    Rails.application.config.after_initialize do
+      Alchemy.logout_method = Devise.sign_out_via
+    end
+  end
 end
 
 Alchemy::Modules.register_module(alchemy_module)

data/lib/alchemy/solidus/alchemy_in_solidus.rb

@@ -1,14 +1,17 @@
-##
-# If there is the Devise Constant loaded, we can assume that we use it as the authentication method
-# then we set the ParentController of device as the Spree::BaseController
-# https://github.com/AlchemyCMS/alchemy-solidus/issues/10
-if Object.const_defined?("Devise")
-  Devise.setup do |config|
-    config.parent_controller = "Spree::BaseController"
-  end
+# Allows to render Alchemy content within Solidus' controller views
+Spree::StoreController.include(
+  Alchemy::ControllerActions,
+  Alchemy::ConfigurationMethods
+)
+
+# Hook into SolidusAuthDevise controllers if present
+if defined? Spree::Auth::Engine
+  Spree::UserPasswordsController.include Alchemy::ControllerActions
+  Spree::UserConfirmationsController.include Alchemy::ControllerActions
+  Spree::UserRegistrationsController.include Alchemy::ControllerActions
+  Spree::UserSessionsController.include Alchemy::ControllerActions
 end
 
-# Allow Alchemy content within Solidus views
-Spree::BaseController.send :include, Alchemy::ControllerActions
-Spree::UserSessionsController.send :include, Alchemy::ControllerActions if defined? Spree::UserSessionsController
-Spree::BaseController.send :include, Alchemy::ConfigurationMethods
+# Do not prefix element view partials with `spree` namespace.
+# See https://github.com/AlchemyCMS/alchemy_cms/issues/1626
+ActionView::Base.prefix_partial_path_with_controller_namespace = false

data/lib/alchemy/solidus/engine.rb

@@ -12,12 +12,12 @@ module Alchemy
         Alchemy.register_ability ::Spree::Ability
         ::Spree::Ability.register_ability ::Alchemy::Permissions
 
-        if Alchemy.user_class_name == 'Spree::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'
+        if Alchemy.user_class.name == 'Alchemy::User'
           require 'alchemy/solidus/alchemy_user_extension'
           Alchemy::User.include Alchemy::Solidus::AlchemyUserExtension
           require 'alchemy/solidus/spree_admin_unauthorized_redirect'
@@ -27,18 +27,26 @@ module Alchemy
           require 'alchemy/solidus/spree_custom_user_generator_fix'
           require 'alchemy/solidus/spree_install_generator_fix'
         end
+
+        if SolidusSupport.frontend_available?
+          # Allows to render Alchemy content within Solidus' controller views
+          require_dependency 'alchemy/solidus/alchemy_in_solidus'
+        end
+
+        # Allows to use Solidus helpers within Alchemys controller views
+        require_dependency 'alchemy/solidus/use_solidus_layout'
       end
 
       # Fix for +belongs_to :bill_address+ in {Spree::UserAddressBook}
       # Solidus has this set to +false+ in {Spree::Base}, but {Alchemy::User} does not inherit from it.
       initializer 'alchemy_solidus.belongs_bill_address_fix' do
-        if Alchemy.user_class_name == 'Alchemy::User'
+        if Alchemy.user_class.name == 'Alchemy::User'
           ActiveSupport.on_load(:active_record) do
             Alchemy::User.belongs_to_required_by_default = false
           end
         end
       end
-      
+
       # In versions of Solidus prior to 2.8, we override the tabs partial
       # to pass a match_path value to each tab. (Version 2.8 is already
       # passing this option.) This option is used to configure the paths

data/lib/alchemy/solidus/spree_admin_unauthorized_redirect.rb

@@ -4,6 +4,6 @@ Spree::Admin::BaseController.unauthorized_redirect = -> do
     redirect_to spree.root_path
   else
     store_location
-    redirect_to alchemy.login_path
+    redirect_to Alchemy.login_path
   end
 end

data/lib/alchemy/solidus/use_solidus_layout.rb

@@ -1,16 +1,19 @@
-# Include this to make Alchemy render within the Solidus layout
+# Allows to use Solidus helpers within Alchemys controller views
+Alchemy::BaseHelper.include(
+  Spree::BaseHelper,
+  Spree::CheckoutHelper,
+  Spree::ProductsHelper,
+  Spree::StoreHelper,
+  Spree::TaxonsHelper
+)
 
-Alchemy::BaseHelper.send :include, Spree::BaseHelper
-Alchemy::BaseHelper.send :include, Spree::CheckoutHelper
-Alchemy::BaseHelper.send :include, Spree::ProductsHelper
-Alchemy::BaseHelper.send :include, Spree::StoreHelper
-Alchemy::BaseHelper.send :include, Spree::TaxonsHelper
-
-Alchemy::BaseController.send :include, Spree::Core::ControllerHelpers::Auth
-Alchemy::BaseController.send :include, Spree::Core::ControllerHelpers::Common
-Alchemy::BaseController.send :include, Spree::Core::ControllerHelpers::Order
-Alchemy::BaseController.send :include, Spree::Core::ControllerHelpers::PaymentParameters
-Alchemy::BaseController.send :include, Spree::Core::ControllerHelpers::Pricing
-Alchemy::BaseController.send :include, Spree::Core::ControllerHelpers::Search
-Alchemy::BaseController.send :include, Spree::Core::ControllerHelpers::Store
-Alchemy::BaseController.send :include, Spree::Core::ControllerHelpers::StrongParameters
+Alchemy::BaseController.include(
+  Spree::Core::ControllerHelpers::Auth,
+  Spree::Core::ControllerHelpers::Common,
+  Spree::Core::ControllerHelpers::Order,
+  Spree::Core::ControllerHelpers::PaymentParameters,
+  Spree::Core::ControllerHelpers::Pricing,
+  Spree::Core::ControllerHelpers::Search,
+  Spree::Core::ControllerHelpers::Store,
+  Spree::Core::ControllerHelpers::StrongParameters
+)

data/lib/alchemy/solidus/version.rb

@@ -1,5 +1,5 @@
 module Alchemy
   module Solidus
-    VERSION = "2.5.0"
+    VERSION = "3.1.0"
   end
 end

data/lib/generators/alchemy/solidus/install/files/db/seeds/alchemy/pages.yml

@@ -0,0 +1,3 @@
+- name: Home
+  page_layout: index
+  public_on: 1970-01-01

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

@@ -1,5 +1,12 @@
 require 'rails/generators'
-require 'rails/generators/alchemy/install/install_generator'
+require 'alchemy/version'
+
+if Alchemy.gem_version >= Gem::Version.new("5.0.0.a")
+  require 'generators/alchemy/install/install_generator'
+else
+  require 'rails/generators/alchemy/install/install_generator'
+end
+
 require 'generators/spree/custom_user/custom_user_generator'
 require 'solidus_support'
 
@@ -25,38 +32,36 @@ module Alchemy
       class_option :auto_accept, default: false, type: :boolean,
         desc: 'Set true if run from a automated script (ie. on a CI)'
 
-      source_root File.expand_path('templates', __dir__)
+      source_root File.expand_path('files', __dir__)
 
       def run_alchemy_installer
         unless options[:skip_alchemy_installer]
           arguments = options[:auto_accept] ? ['--skip-demo-files', '--force'] : []
           Alchemy::Generators::InstallGenerator.start(arguments)
+          rake('railties:install:migrations', abort_on_failure: true)
+          rake('db:migrate', abort_on_failure: true)
         end
       end
 
       def run_alchemy_devise_installer
-        if Kernel.const_defined?('Alchemy::Devise') && !options[:skip_alchemy_devise_installer]
+        if alchemy_devise_present? && !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]
+        if alchemy_devise_present? && !options[:skip_spree_custom_user_generator]
           arguments = options[:auto_accept] ? ['Alchemy::User', '--force'] : ['Alchemy::User']
           Spree::CustomUserGenerator.start(arguments)
           gsub_file 'lib/spree/authentication_helpers.rb', /main_app\./, 'Alchemy.'
           if SolidusSupport.solidus_gem_version < Gem::Version.new('2.5.0')
             gsub_file 'config/initializers/spree.rb', /Spree\.user_class.?=.?.+$/, 'Spree.user_class = "Alchemy::User"'
           end
-          rake 'db:migrate'
+          rake('db:migrate', abort_on_failure: true)
         end
       end
 
-      def copy_alchemy_initializer
-        template "alchemy.rb.tt", "config/initializers/alchemy.rb"
-      end
-
       def inject_admin_tab
         inject_into_file 'config/initializers/spree.rb', {after: "Spree::Backend::Config.configure do |config|\n"} do
           <<~ADMIN_TAB
@@ -75,7 +80,7 @@ module Alchemy
       end
 
       def create_admin_user
-        if Kernel.const_defined?('Alchemy::Devise') && !options[:skip_alchemy_user_generator] && Alchemy::User.count.zero?
+        if alchemy_devise_present? && !options[:skip_alchemy_user_generator] && Alchemy::User.count.zero?
           login = ENV.fetch('ALCHEMY_ADMIN_USER_LOGIN', 'admin')
           email = ENV.fetch('ALCHEMY_ADMIN_USER_EMAIL', 'admin@example.com')
           password = ENV.fetch('ALCHEMY_ADMIN_USER_PASSWORD', 'test1234')
@@ -85,14 +90,17 @@ module Alchemy
             password = ask("Enter the password for the admin user", default: password)
           end
 
+          # This is a bit strange, but without the double save this fails with a failed validation.
           Alchemy::User.create!(
             login: login,
             email: email,
             password: password,
             password_confirmation: password,
-            alchemy_roles: 'admin',
-            spree_roles: [Spree::Role.find_or_create_by!(name: 'admin')]
-          )
+            alchemy_roles: 'admin'
+          ).tap do |user|
+            user.spree_roles = [Spree::Role.find_or_create_by!(name: 'admin')]
+            user.save!
+          end
         end
       end
 
@@ -114,21 +122,17 @@ module Alchemy
 
       def set_root_route
         routes_file_path = Rails.root.join('config', 'routes.rb')
-        if options[:auto_accept] || ask("\nDo you want Alchemy to handle the root route ('/')?", default: true)
-          if File.read(routes_file_path).match SPREE_MOUNT_REGEXP
-            sentinel = SPREE_MOUNT_REGEXP
-          else
-            sentinel = "Rails.application.routes.draw do\n"
-          end
+        if options[:auto_accept] || yes?("\nDo you want Alchemy to handle the root route '/'? (y/n)")
+          sentinel = "Rails.application.routes.draw do\n"
           inject_into_file routes_file_path, {after: sentinel} do
             <<~ROOT_ROUTE
-              \n
               \  # Let AlchemyCMS handle the root route
-              \  Spree::Core::Engine.routes.draw do
-              \    root to: '/alchemy/pages#index'
-              \  end
+              \  root to: 'alchemy/pages#index'
             ROOT_ROUTE
           end
+          copy_file('db/seeds/alchemy/pages.yml')
+          append_file(Rails.root.join('db', 'seeds.rb'), "Alchemy::Seeder.seed!\n")
+          rake('alchemy:db:seed', abort_on_failure: true)
         end
       end
 
@@ -136,6 +140,12 @@ module Alchemy
         append_file "vendor/assets/javascripts/alchemy/admin/all.js",
           "//= require alchemy/solidus/admin.js"
       end
+
+      private
+
+      def alchemy_devise_present?
+        defined?(Alchemy::Devise::Engine)
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alchemy-solidus
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Thomas von Deyen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-12 00:00:00.000000000 Z
+date: 2020-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: alchemy_cms
@@ -239,8 +239,8 @@ files:
 - lib/alchemy/solidus/spree_user_extension.rb
 - lib/alchemy/solidus/use_solidus_layout.rb
 - lib/alchemy/solidus/version.rb
+- lib/generators/alchemy/solidus/install/files/db/seeds/alchemy/pages.yml
 - lib/generators/alchemy/solidus/install/install_generator.rb
-- lib/generators/alchemy/solidus/install/templates/alchemy.rb.tt
 - lib/views/spree/admin/shared/_tabs.html.erb
 homepage: https://github.com/AlchemyCMS/alchemy-solidus
 licenses:

data/lib/generators/alchemy/solidus/install/templates/alchemy.rb.tt

@@ -1,44 +0,0 @@
-Alchemy::Modules.register_module({
-  engine_name: 'spree',
-  name: 'solidus',
-  navigation: {
-    controller: 'spree/admin/orders',
-    action: 'index',
-    name: 'Store',
-    inline_image: '<svg version="1.1" width="24px" height="24px" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg" style="vertical-align: middle">
-      <path d="M 6.687 21.839 L 17.314 21.839 L 17.314 2.162 L 6.687 2.162 Z M 19.476 24 L 4.525 24 L 4.525 0 L 19.476 0 Z M 13.89 17 C 13.307 16.662 13.078 16.287 13.05 15.313 L 13.05 8.574 C 13.05 6.554 12.05 5.814 9.911 4.794 L 8.99 6.434 L 10.111 7.074 C 10.693 7.412 10.923 7.786 10.951 8.761 L 10.951 15.5 C 10.951 17.52 11.951 18.26 14.09 19.279 L 15.01 17.64 Z" fill="currentColor"/>
-    </svg>',
-    data: { turbolinks: false },
-    sub_navigation: [
-      {
-        controller: 'spree/admin/orders',
-        action: 'index',
-        name: 'Orders'
-      },
-      {
-        controller: 'spree/admin/products',
-        action: 'index',
-        name: 'Products'
-      },
-      {
-        controller: 'spree/admin/promotions',
-        action: 'index',
-        name: 'Promotions'
-      },
-      {
-        controller: 'spree/admin/stock_items',
-        action: 'index',
-        name: 'Stock'
-      <%- if defined?(Spree::Auth::Engine) -%>
-      },
-      {
-        controller: 'spree/admin/users',
-        action: 'index',
-        name: 'Users'
-      }
-      <%- else -%>
-      }
-      <%- end -%>
-    ]
-  }
-})