alchemy-solidus 2.3.2 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: de5c64f8172aa48e4baf9a5f2d98b575a15d67f1cbee342e696602ad5e622d2e
-  data.tar.gz: 90da86131495bac7078a39f3854dbc2cc37f290f2cb462e5bc58048ca364f7ea
+  metadata.gz: b6e92c70519b42d1b2ddd77907a413ee2ac8657b8bf180987d28c9beb12b93d9
+  data.tar.gz: 8dc7e00168b554f7efb2fbe01e884f269a7112d6feeaa7a63aa62c614271cf1d
 SHA512:
-  metadata.gz: ebf23bca2c312fcb51bfa7ed97edd560bc1543c8b7b9f1a0df477daa418741453021f30df69b29b9b18048de697035925b07dfe8d7a7f601c94d3303bba4e8fc
-  data.tar.gz: ee0997b1e2b7d43f032f5f5f12c637a2df0b2ce07afd2ac1363fdca6407862659d97bac6289373278ead07ebc621b9746920cae396a0b7638843be955403da31
+  metadata.gz: 45edca46563a2713b35b39ddd58e743909b0a72219532087264b6d4eb66aebe1199bd466d5d0833b80a04265106ebfcdc866510ecedc25f272f5a54c25701740
+  data.tar.gz: 78f94fce34c3689cd843da7a451bbe34e83100bd31c1f85b1f3ea0c761dba578b6b292cd340622917a08d39a8c8e74fed755a9a51ce278f7d1976c30a831dc70

data/README.md

@@ -1,57 +1,69 @@
 [![Build Status](https://travis-ci.org/AlchemyCMS/alchemy-solidus.svg?branch=master)](https://travis-ci.org/AlchemyCMS/alchemy-solidus)
 
-# AlchemyCMS Solidus Integration
+# Alchemy-Solidus
 
-The World's Most Flexible E-Commerce Platform meets The World's Most Flexible Content Management System!
-
-This gem is a [AlchemyCMS](https://github.com/AlchemyCMS/alchemy_cms) and [Solidus](https://github.com/solidusio/solidus) connector.
-
-### For now it does this:
+This is a [AlchemyCMS](https://alchemy-cms.com) and [Solidus](https://solidus.io) integration gem.
 
 1. It provides tabs in Alchemy and Solidus menus to easily switch between both backends
 2. It offers two new Essences for Alchemy called `EssenceSpreeProduct` and `EssenceSpreeTaxon` that you can use to place Spree products and/or Taxons on your pages.
 3. Shares admin sessions and user abilities between Alchemy and Solidus.
 
-### Compatibility
+## Compatibility
+
+### Solidus
 
-## Solidus
+This version runs with Solidus 2.6 and above.
 
-This version runs with Solidus 2.0 and above. For a Solidus 1 compatible version please use the `1.0-stable` branch or 1.1.0 gem version.
+- For a Solidus < 2.6 compatible version please use the `2.3-stable` branch or `2.3.2` gem version.
+- For a Solidus 1.x compatible version please use the `1.0-stable` branch or `1.1.0` gem version.
 
-## Alchemy
+### Alchemy
 
-This version runs with Alchemy 4.0 and above. For a Alchemy 3 compatible version please use the `1.0-stable` branch or 1.1.0 gem version.
+This version runs with Alchemy 4.1 and above.
+
+- For a Alchemy 4.0 compatible version please use the `2.3-stable` branch or `2.3.2` gem version.
+- For a Alchemy 3.x compatible version please use the `1.0-stable` branch or `1.1.0` gem version.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add this line to your applications `Gemfile`:
 
 ```ruby
-gem 'alchemy-solidus', github: 'AlchemyCMS/alchemy-solidus', branch: 'master'
+gem 'alchemy-solidus', '~> 2.4.0'
 ```
 
 Install the gem with:
 
-```shell
+```bash
 $ bundle install
 ```
 
 ## Automated setup
 
-We ship a Rails generator that helps you to install this gem into your existing Rails app.
+We ship a Rails generator that helps you to install this gem into your existing application.
 
-```
+```bash
 $ bin/rails g alchemy:solidus:install
 ```
 
-There are several options available, please check them by:
+There are several options available, please check them with
 
-```
+```bash
 $ bin/rails g alchemy:solidus:install --help
 ```
 
+## Upgrading
+
+To upgrade update the Gemfile and run the install generator again
+
+```bash
+$ bin/rails g alchemy:solidus:install
+```
+
 ## Manual setup
 
+If you want to have full control over the integration you can also set this up manually.
+
 ### 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.
@@ -96,7 +108,7 @@ gem 'alchemy-devise', '~> 4.1'
 
 and install it:
 
-```shell
+```bash
 $ bundle install
 $ bundle exec rails g alchemy:devise:install
 ```
@@ -105,13 +117,13 @@ Run the Solidus installer:
 
 *NOTE*: Skip this if you already have a running Solidus installation.
 
-```shell
+```bash
 $ bundle exec rails g spree:install
 ```
 
 Then run the solidus custom user generator:
 
-```shell
+```bash
 $ bundle exec rails g spree:custom_user Alchemy::User
 ```
 
@@ -143,21 +155,21 @@ and tell Solidus about Alchemy's path helpers:
     ...
 ```
 
-#### 3. Option: Build their own authentication
+#### 3. Option: Build your own authentication
 
-Please follow the [spree custom authentication](https://guides.spreecommerce.com/developer/authentication.html) and the [Alchemy custom authentication](http://guides.alchemy-cms.com/edge/custom_authentication.html) guides in order to integrate your custom user with Solidus and Alchemy.
+Please follow the [Solidus custom authentication](https://guides.solidus.io/developers/users/custom-authentication.html) and the [Alchemy custom authentication](https://guides.alchemy-cms.com/custom_authentication.html) guides in order to integrate your custom user with Solidus and Alchemy.
 
-#### In either case
+### In either case
 
 Install the migrations
 
-```shell
+```bash
 $ bundle exec rake alchemy_solidus:install:migrations
 ```
 
 Run the installer of Alchemy
 
-```shell
+```bash
 $ bundle exec rake alchemy:install
 ```
 
@@ -185,11 +197,11 @@ initializer:
 require 'alchemy/solidus/alchemy_in_solidus'
 ```
 
-## Routing
+### Routing
 
 For routing you have a few options.
 
-### Place both engines in their own namespace:
+#### Place both engines in their own namespace:
 
 ```ruby
 # config/routes.rb
@@ -197,7 +209,7 @@ mount Spree::Core::Engine => '/store'
 mount Alchemy::Engine => '/pages'
 ```
 
-### Put Solidus at the root level and Alchemy in its own namespace:
+#### Put Solidus at the root level and Alchemy in its own namespace:
 
 ```ruby
 # config/routes.rb
@@ -205,7 +217,7 @@ mount Alchemy::Engine => '/pages'
 mount Spree::Core::Engine => '/'
 ```
 
-### Put Alchemy at the root level and Solidus in its own namespace:
+#### Put Alchemy at the root level and Solidus in its own namespace:
 
 ```ruby
 # config/routes.rb
@@ -213,7 +225,7 @@ mount Spree::Core::Engine => '/store'
 mount Alchemy::Engine => '/'
 ```
 
-### Put both engines in the root level
+#### Put both engines in the root level
 
 ```ruby
 # config/routes.rb
@@ -229,6 +241,8 @@ mount Alchemy::Engine => '/'
 
 ## Usage
 
+Please make yourself familiar with AlchemyCMS by [reading the guidelines](https://guides.alchemy-cms.com)
+
 ### Create a new Element for Alchemy
 
 ```yaml
@@ -260,14 +274,38 @@ $ rails g alchemy:elements --skip
   elements: [product_category]
 ```
 
-### You can haz Solidus product and taxons!
+### Access the Solidus product or taxon in your element views
+
+You can mix Alchemy and Solidus content in the same view.
 
 ```erb
-# app/views/alchemy/elements/_product_view.html.erb
-<%= element.ingredient('spree_product') %>
+<!-- app/views/alchemy/elements/_product_view.html.erb -->
+<% cache element do %>
+  <%= element_view_for element do |el| %>
+    <% product = el.ingredient(:spree_product) %>
+    <h1><%= product.name %></h1>
+    <p><%= product.description %></p>
+    <%= el.render :text %>
+    <%= el.render :image %>
+  <% end %>
+<% end %>
+```
 
-# app/views/alchemy/elements/_product_category_view.html.erb
-<%= element.ingredient('spree_taxon') %>
+Or for a list of taxon products
+
+```erb
+<!-- app/views/alchemy/elements/_product_category_view.html.erb -->
+<% cache element do %>
+  <%= element_view_for element do |el| %>
+    <h2><%= el.render :headline %></h2>
+    <%= el.render :description %>
+
+    <% taxon = el.ingredient(:spree_taxon) %>
+    <% taxon.products.each do |product| %>
+      <%= link_to product.name, spree.product_path(product) %>
+    <% end %>
+  <% end %>
+<% end %>
 ```
 
 Alchemy :heart: Solidus!

data/Rakefile

@@ -21,7 +21,7 @@ task :test_setup do
       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 alchemy:solidus:install --auto-accept
+      bin/rails g alchemy:solidus:install --auto-accept --force
     SETUP
     exit($?.exitstatus) unless $?.success?
   end

data/config/initializers/alchemy.rb

@@ -5,7 +5,9 @@ alchemy_module = {
     controller: 'spree/admin/orders',
     action: 'index',
     name: 'Store',
-    image: 'alchemy/solidus/alchemy_module_icon.png',
+    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: [
       {

data/lib/alchemy/solidus/engine.rb

@@ -8,12 +8,6 @@ module Alchemy
     class Engine < ::Rails::Engine
       engine_name 'alchemy_solidus'
 
-      initializer 'alchemy_solidus.assets' do |app|
-        app.config.assets.precompile += [
-          'alchemy/solidus/alchemy_module_icon.png'
-        ]
-      end
-
       config.to_prepare do
         Alchemy.register_ability ::Spree::Ability
         ::Spree::Ability.register_ability ::Alchemy::Permissions

data/lib/alchemy/solidus/version.rb

@@ -1,5 +1,5 @@
 module Alchemy
   module Solidus
-    VERSION = "2.3.2"
+    VERSION = "2.4.0"
   end
 end

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

@@ -5,7 +5,9 @@ Alchemy::Modules.register_module({
     controller: 'spree/admin/orders',
     action: 'index',
     name: 'Store',
-    image: 'alchemy/solidus/alchemy_module_icon.png',
+    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: [
       {

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: alchemy-solidus
 version: !ruby/object:Gem::Version
-  version: 2.3.2
+  version: 2.4.0
 platform: ruby
 authors:
 - Thomas von Deyen
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0.beta
+        version: 4.1.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '5.0'
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0.beta
+        version: 4.1.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '5.0'
@@ -34,30 +34,42 @@ dependencies:
   name: solidus_core
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: solidus_backend
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: solidus_support
   requirement: !ruby/object:Gem::Requirement
@@ -166,7 +178,6 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- app/assets/images/alchemy/solidus/alchemy_module_icon.png
 - app/models/alchemy/essence_spree_product.rb
 - app/models/alchemy/essence_spree_taxon.rb
 - app/views/alchemy/essences/_essence_spree_product_editor.html.erb