alchemy-solidus 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5df79cbf96a886200a6dc90ed749a92e3b10db90
-  data.tar.gz: ed76a4ccf6ca300da5d06a2a5ffc68d6f4b10581
+  metadata.gz: 89fc2d82897ec63ccd01a0b9739985407a869999
+  data.tar.gz: 5d448d85de69dc282a0838c5b267a74d9a5a3e0a
 SHA512:
-  metadata.gz: a13760c47272faa5dc452879ac36e614600ff153eb5832a732c30ca0c9607370561ea7612bce44aca4a202ed294784fb0697f83b878645e89ec3d2368335cc54
-  data.tar.gz: bb155668e332b5adb205ed991f39663a672b2bb9c0fce3b2947820cc86225e44405bb6ea838e177b614404a9a7ec6acd71c324d3822477fed4e25567c53c4037
+  metadata.gz: 816557248ccabb25bb7c28186a6f8a71a64361573319f671d751aa520606b747c2ba93a600943c8b28de6b2796ccc1d4920ae6021f10c2a80cb55fb7e41e3f96
+  data.tar.gz: c707e4f69c3da52fac89f21d17ab3d6ec52c7df27ff5765f3dada0df0419ad83c93fcc559f3283b07adbb129d2d6e5ab581593f0e5bcae7aec92d76d4f3b72ee

data/README.md

@@ -50,19 +50,17 @@ To use Solidus Auth Devise, instruct Alchemy to use the `Spree::User` class:
 
 ```ruby
 # config/initializers/alchemy.rb
-
-# Tell Alchemy to use the Spree::User class
 Alchemy.user_class_name = 'Spree::User'
 Alchemy.current_user_method = :spree_current_user
+```
 
-# Load the Spree.user_class decorator for Alchemy roles
-require 'alchemy/solidus/spree_user_decorator'
+If you put Spree in it's own routing namespace (see below) you will want to
+let Alchemy know these paths:
 
-# Include the Spree controller helpers to render the
-# alchemy pages within the default Spree layout
-Alchemy::BaseHelper.send :include, Spree::BaseHelper
-Alchemy::BaseController.send :include, Spree::Core::ControllerHelpers::Common
-Alchemy::BaseController.send :include, Spree::Core::ControllerHelpers::Store
+```ruby
+# config/initializers/alchemy.rb
+Alchemy.login_path = '/store/login'
+Alchemy.logout_path = '/store/logout'
 ```
 
 #### 2. Option: Use [Alchemy Devise](https://github.com/AlchemyCMS/alchemy-devise)
@@ -105,7 +103,6 @@ Now you'll need to instruct Solidus to use the Alchemy User class:
 # config/initializers/spree.rb
 ...
 Spree.user_class = "Alchemy::User"
-require 'alchemy/solidus/alchemy_user_decorator'
 ...
 ```
 
@@ -148,28 +145,68 @@ $ bundle exec rake alchemy:install
 
 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:
+
+```ruby
+# config/initializers/alchemy.rb
+require 'alchemy/solidus/use_solidus_layout'
+```
+
 ### Render Alchemy Content in Solidus views
 
-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.
+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:
 
 ```ruby
-# config/initializers/solidus.rb
-...
-Spree::BaseController.class_eval do
-  include Alchemy::ControllerActions
-end
+# config/initializers/alchemy.rb
+require 'alchemy/solidus/alchemy_in_solidus'
 ```
 
-#### With Solidus::Auth::Devise
+## Routing
 
-If you also use the `Spree::User` class you need to additionally tell the Solidus user sessions controller to include the Alchemy related helpers and methods.
+For routing you have a few options.
+
+### Place both engines in their own namespace:
 
 ```ruby
-# config/initializers/spree.rb
-...
-Spree::UserSessionsController.class_eval do
-  include Alchemy::ControllerActions
-end
+# config/routes.rb
+mount Spree::Core::Engine => '/store'
+mount Alchemy::Engine => '/pages'
+```
+
+### Put Solidus at the root level and Alchemy in its own namespace:
+
+```ruby
+# config/routes.rb
+mount Alchemy::Engine => '/pages'
+mount Spree::Core::Engine => '/'
+```
+
+### Put Alchemy at the root level and Solidus in its own namespace:
+
+```ruby
+# config/routes.rb
+mount Spree::Core::Engine => '/store'
+mount Alchemy::Engine => '/'
+```
+
+### Put both engines in the root level
+
+```ruby
+# config/routes.rb
+
+# Make Alchemy's root page have higher priority than Spree's root page
+root to: 'alchemy/pages#show'
+
+mount Spree::Core::Engine => '/'
+
+# Must be last so it's catch-all route can render undefined paths
+mount Alchemy::Engine => '/'
 ```
 
 ## Usage

data/config/locales/alchemy_solidus_en.yml

@@ -0,0 +1,5 @@
+en:
+  spree:
+    admin:
+      tab:
+        cms: CMS

data/config/locales/alchemy_solidus_it.yml

@@ -0,0 +1,5 @@
+it:
+  spree:
+    admin:
+      tab:
+        cms: CMS

data/lib/alchemy/solidus/alchemy_in_solidus.rb

@@ -0,0 +1,14 @@
+##
+# 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
+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

data/lib/alchemy/solidus/{alchemy_user_decorator.rb → alchemy_user_extension.rb}

@@ -1,5 +1,4 @@
-Alchemy::User.class_eval do
-
+module Alchemy::SpreeUserExtension
   def spree_roles
     if admin?
       ::Spree::Role.where(name: 'admin')

data/lib/alchemy/solidus/engine.rb

@@ -1,13 +1,23 @@
+require 'alchemy/solidus/alchemy_user_extension'
+require 'alchemy/solidus/spree_user_extension'
+
 module Alchemy
   module Solidus
     class Engine < ::Rails::Engine
       engine_name 'alchemy_solidus'
 
-      def self.activate
-        Alchemy.register_ability(::Spree::Ability)
+      initializer 'alchemy_solidus.assets' do |app|
+        app.config.assets.precompile += [
+          'alchemy/solidus/alchemy_module_icon.png'
+        ]
       end
 
-      config.to_prepare &method(:activate).to_proc
+      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'
+      end
     end
   end
 end

data/lib/alchemy/solidus/{spree_user_decorator.rb → spree_user_extension.rb}

@@ -1,5 +1,4 @@
-Spree::User.class_eval do
-
+module Spree::AlchemyUserExtension
   def alchemy_roles
     if has_spree_role?(:admin)
       %w(admin)

data/lib/alchemy/solidus/use_solidus_layout.rb

@@ -0,0 +1,5 @@
+# Include this to make Alchemy render within the Solidus layout
+Alchemy::BaseHelper.send :include, Spree::BaseHelper
+Alchemy::BaseHelper.send :include, Spree::StoreHelper
+Alchemy::BaseController.send :include, Spree::Core::ControllerHelpers::Common
+Alchemy::BaseController.send :include, Spree::Core::ControllerHelpers::Store

data/lib/alchemy/solidus/version.rb

@@ -1,5 +1,5 @@
 module Alchemy
   module Solidus
-    VERSION = "1.0.0"
+    VERSION = "1.1.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alchemy-solidus
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Thomas von Deyen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-09 00:00:00.000000000 Z
+date: 2017-12-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: alchemy_cms
@@ -75,12 +75,16 @@ files:
 - app/views/alchemy/essences/_essence_spree_taxon_editor.html.erb
 - app/views/alchemy/essences/_essence_spree_taxon_view.html.erb
 - config/initializers/alchemy.rb
+- config/locales/alchemy_solidus_en.yml
+- config/locales/alchemy_solidus_it.yml
 - db/migrate/20120229160509_create_alchemy_essence_spree_products.rb
 - db/migrate/20131030140218_create_alchemy_essence_spree_taxons.rb
 - lib/alchemy-solidus.rb
-- lib/alchemy/solidus/alchemy_user_decorator.rb
+- lib/alchemy/solidus/alchemy_in_solidus.rb
+- lib/alchemy/solidus/alchemy_user_extension.rb
 - lib/alchemy/solidus/engine.rb
-- lib/alchemy/solidus/spree_user_decorator.rb
+- lib/alchemy/solidus/spree_user_extension.rb
+- lib/alchemy/solidus/use_solidus_layout.rb
 - lib/alchemy/solidus/version.rb
 homepage: https://github.com/AlchemyCMS/alchemy-solidus
 licenses:
@@ -102,7 +106,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: The World's Most Flexible E-Commerce Platform meets The World's Most Flexible