alchemy-solidus 2.5.1 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 902f1162c27c48166435b147674f8b9da9fd5c0fa9d3d95b60acb4cc62cf900c
-  data.tar.gz: acd5cabe30ca1080ef6790ad7f3e47b553b02b7eb3ff8fe68c82ca7bb6c8c178
+  metadata.gz: 7702f9a029e49150f896e95ed265edcb1a3008fbe138f180eba53ed3d69f47b2
+  data.tar.gz: 118c3f1109a630ea2dabdd89d480fa4043db9e61ab3211f0bcce9cd27934e18a
 SHA512:
-  metadata.gz: a8b2ce4bcf0f1ef9a8e1e1461c6843f404c7ff7397a7cef4f71dc8d3efbe8cd5a31979b83d29cb2a42279afd7f0f10261064c52e9ee31ef04e8826f4c60718f6
-  data.tar.gz: 2b479960fe66bbe12d2168ca95eedf62c798a00e790647d80fa6dc1ac7c6aadc453a6d6b2e7ec28405aec2e534b1ad5a675884df4481f3bc0adea83b9e8faf08
+  metadata.gz: a3d80d75fc3bebb74a73fb62ad2d35a407a0a41d7292c3f33edbb36043504e273d67a20fa9edf5f883fa26ee66f82f8d8272ae97bbd75b8eaf2555d1d338359c
+  data.tar.gz: ed3bc37a2c74ebaa376fa1d41928d755e9bc672313019b8515542aa2153e8030d97a78446bb77819c1997f99ed14a7bf9470b82439dadb200b8c4f7fa427df76

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/config/initializers/alchemy.rb

@@ -42,6 +42,8 @@ if defined?(Spree::Auth::Engine)
       name: 'Users'
     }
   )
+  Alchemy.user_class_name = 'Spree::User'
+  Alchemy.current_user_method = :spree_current_user
 end
 
 Alchemy::Modules.register_module(alchemy_module)

data/lib/alchemy/solidus/alchemy_in_solidus.rb

@@ -1,16 +1,15 @@
-# Make sure we have everything loaded before patching classes
-Rails.application.config.to_prepare do
-  # Allows to render Alchemy content within Solidus' controller views
-  Spree::BaseController.include Alchemy::ControllerActions
-  Spree::BaseController.include Alchemy::ConfigurationMethods
+# 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
+# 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
 
 # Do not prefix element view partials with `spree` namespace.

data/lib/alchemy/solidus/engine.rb

@@ -27,6 +27,14 @@ 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}
@@ -38,7 +46,7 @@ module Alchemy
           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/use_solidus_layout.rb

@@ -1,18 +1,19 @@
-# Make sure we have everything loaded before patching classes
-Rails.application.config.to_prepare do
-  # Allows to use Solidus helpers within Alchemys controller views
-  Alchemy::BaseHelper.include Spree::BaseHelper
-  Alchemy::BaseHelper.include Spree::CheckoutHelper
-  Alchemy::BaseHelper.include Spree::ProductsHelper
-  Alchemy::BaseHelper.include Spree::StoreHelper
-  Alchemy::BaseHelper.include Spree::TaxonsHelper
+# Allows to use Solidus helpers within Alchemys controller views
+Alchemy::BaseHelper.include(
+  Spree::BaseHelper,
+  Spree::CheckoutHelper,
+  Spree::ProductsHelper,
+  Spree::StoreHelper,
+  Spree::TaxonsHelper
+)
 
-  Alchemy::BaseController.include Spree::Core::ControllerHelpers::Auth
-  Alchemy::BaseController.include Spree::Core::ControllerHelpers::Common
-  Alchemy::BaseController.include Spree::Core::ControllerHelpers::Order
-  Alchemy::BaseController.include Spree::Core::ControllerHelpers::PaymentParameters
-  Alchemy::BaseController.include Spree::Core::ControllerHelpers::Pricing
-  Alchemy::BaseController.include Spree::Core::ControllerHelpers::Search
-  Alchemy::BaseController.include Spree::Core::ControllerHelpers::Store
-  Alchemy::BaseController.include Spree::Core::ControllerHelpers::StrongParameters
-end
+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.1"
+    VERSION = "3.0.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

@@ -25,38 +25,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 +73,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')
@@ -114,21 +112,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 +130,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.1
+  version: 3.0.0
 platform: ruby
 authors:
 - Thomas von Deyen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-13 00:00:00.000000000 Z
+date: 2019-12-17 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 -%>
-    ]
-  }
-})