alchemy-solidus 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5df79cbf96a886200a6dc90ed749a92e3b10db90
+  data.tar.gz: ed76a4ccf6ca300da5d06a2a5ffc68d6f4b10581
+SHA512:
+  metadata.gz: a13760c47272faa5dc452879ac36e614600ff153eb5832a732c30ca0c9607370561ea7612bce44aca4a202ed294784fb0697f83b878645e89ec3d2368335cc54
+  data.tar.gz: bb155668e332b5adb205ed991f39663a672b2bb9c0fce3b2947820cc86225e44405bb6ea838e177b614404a9a7ec6acd71c324d3822477fed4e25567c53c4037

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in alchemy-solidus.gemspec
+gemspec
+
+gem 'sqlite3'
+gem 'alchemy-devise'

data/LICENSE

@@ -0,0 +1,24 @@
+Copyright (c) 2012-14, magic labs*
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice,
+  this list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation and/or
+  other materials provided with the distribution.
+
+* Neither the name of magic labs* nor the names of its contributors may be used to
+  endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR
+IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS
+BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
+OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
+EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,226 @@
+# Alchemy CMS Solidus Integration
+
+The World's Most Flexible E-Commerce Platform meets The World's Most Flexible Content Management System!
+
+This gem is a [Alchemy CMS](https://github.com/AlchemyCMS/alchemy_cms) and [Solidus](https://github.com/solidusio/solidus) connector.
+
+### For now it does this:
+
+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
+
+## Solidus
+
+This version runs with Solidus 1.0 and above.
+
+## Alchemy
+
+This version runs with Alchemy 3.2 and above.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'alchemy-solidus', github: 'AlchemyCMS/alchemy-solidus', branch: 'master'
+```
+
+Install the gem with:
+
+```shell
+$ bundle install
+```
+
+### 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.
+
+Here are the steps for each option:
+
+#### 1. Option: Use [Solidus Auth Devise](https://github.com/solidusio/solidus_auth_devise)
+
+**Recommended for:**
+  - An existing Solidus installation (`gem 'solidus_auth_devise'` should already be in your Gemfile).
+  - You are just adding Alchemy
+
+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'
+
+# 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
+```
+
+#### 2. Option: Use [Alchemy Devise](https://github.com/AlchemyCMS/alchemy-devise)
+
+**Recommended for:**
+  - An existing Alchemy installation
+  - You don't have an authentication system and don't want to role an authentication system on your own.
+
+Add `alchemy-devise` to your `Gemfile`
+
+```ruby
+# Gemfile
+gem 'alchemy-devise', '~> 3.2'
+```
+
+and install it:
+
+```shell
+$ bundle install
+$ bundle exec rails g alchemy:devise:install
+```
+
+Run the Solidus installer:
+
+*NOTE*: Skip this if you already have a running Solidus installation.
+
+```shell
+$ bundle exec rails g spree:install
+```
+
+Then run the solidus custom user generator:
+
+```shell
+$ bundle exec rails g spree:custom_user Alchemy::User
+```
+
+Now you'll need to instruct Solidus to use the Alchemy User class:
+
+```ruby
+# config/initializers/spree.rb
+...
+Spree.user_class = "Alchemy::User"
+require 'alchemy/solidus/alchemy_user_decorator'
+...
+```
+
+and tell Solidus about Alchemy's path helpers:
+
+```ruby
+# lib/spree/authentication_helpers.rb
+    ...
+    def spree_login_path
+      alchemy.login_path
+    end
+
+    def spree_signup_path
+      alchemy.signup_path
+    end
+
+    def spree_logout_path
+      alchemy.logout_path
+    end
+    ...
+```
+
+#### 3. Option: Build their 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.
+
+#### In either case
+
+Install the migrations
+
+```shell
+$ bundle exec rake alchemy_solidus:install:migrations
+```
+
+Run the installer of Alchemy
+
+```shell
+$ bundle exec rake alchemy:install
+```
+
+and follow the on screen instructions.
+
+### 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.
+
+```ruby
+# config/initializers/solidus.rb
+...
+Spree::BaseController.class_eval do
+  include Alchemy::ControllerActions
+end
+```
+
+#### With Solidus::Auth::Devise
+
+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.
+
+```ruby
+# config/initializers/spree.rb
+...
+Spree::UserSessionsController.class_eval do
+  include Alchemy::ControllerActions
+end
+```
+
+## Usage
+
+### Create a new Element for Alchemy
+
+```yaml
+# config/alchemy/elements.yml
+- name: product
+  contents:
+  - name: spree_product
+    type: EssenceSpreeProduct
+
+- name: product_category
+  contents:
+  - name: spree_taxon
+    type: EssenceSpreeTaxon
+```
+
+### Generate the views
+
+```sh
+$ rails g alchemy:elements --skip
+```
+
+### Place this element on a page layout
+
+```yaml
+# config/alchemy/page_layouts.yml
+- name: product
+  elements: [product]
+- name: products
+  elements: [product_category]
+```
+
+### You can haz Solidus product and taxons!
+
+```erb
+# app/views/alchemy/elements/_product_view.html.erb
+<%= element.ingredient('spree_product') %>
+
+# app/views/alchemy/elements/_product_category_view.html.erb
+<%= element.ingredient('spree_taxon') %>
+```
+
+Alchemy :heart: Solidus!
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,23 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+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
+
+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
+
+Bundler::GemHelper.install_tasks

data/alchemy-solidus.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/alchemy/solidus/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Thomas von Deyen"]
+  gem.email         = ["tvd@magiclabs.de"]
+  gem.description   = %q{A Alchemy CMS and Solidus connector}
+  gem.summary       = %q{The World's Most Flexible E-Commerce Platform meets The World's Most Flexible Content Management System!}
+  gem.homepage      = "https://github.com/AlchemyCMS/alchemy-solidus"
+  gem.license       = 'BSD New'
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "alchemy-solidus"
+  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('deface', ['~> 1.0'])
+end

data/app/models/alchemy/essence_spree_product.rb

@@ -0,0 +1,14 @@
+module Alchemy
+  class EssenceSpreeProduct < ActiveRecord::Base
+    belongs_to :product, class_name: "Spree::Product", foreign_key: 'spree_product_id'
+
+    acts_as_essence(
+      ingredient_column: 'spree_product_id',
+      preview_text_method: 'name'
+    )
+
+    def ingredient
+      product
+    end
+  end
+end

data/app/models/alchemy/essence_spree_taxon.rb

@@ -0,0 +1,14 @@
+module Alchemy
+  class EssenceSpreeTaxon < ActiveRecord::Base
+    belongs_to :taxon, class_name: "Spree::Taxon", foreign_key: 'taxon_id'
+
+    acts_as_essence(
+      ingredient_column: 'taxon_id',
+      preview_text_method: 'name'
+    )
+
+    def ingredient
+      taxon
+    end
+  end
+end

data/app/overrides/alchemy_solidus_tab.rb

@@ -0,0 +1,6 @@
+Deface::Override.new(
+  virtual_path: "spree/admin/shared/_menu",
+  name: "alchemy_cms_tab",
+  insert_bottom: '[data-hook="admin_tabs"]',
+  partial: "alchemy/admin/shared/alchemy_solidus_tab"
+)

data/app/views/alchemy/admin/shared/_alchemy_solidus_tab.html.erb

@@ -0,0 +1,3 @@
+<% if Spree.user_class && can?(:edit_content, Alchemy::Page) %>
+  <%= tab *[:cms], url: alchemy.admin_pages_path, icon: 'copy' %>
+<% end %>

data/app/views/alchemy/essences/_essence_spree_product_editor.html.erb

@@ -0,0 +1,9 @@
+<div class="content_editor essence_spree_product">
+  <label><%= render_content_name(content) %></label>
+  <%= select_tag(
+    content.form_field_name,
+    options_from_collection_for_select(Spree::Product.not_deleted, :id, :name, content.essence.spree_product_id),
+    class: ['alchemy_selectbox very_long', html_options[:class]].join(' '),
+    style: html_options[:style]
+  ) %>
+</div>

data/app/views/alchemy/essences/_essence_spree_taxon_editor.html.erb

@@ -0,0 +1,16 @@
+<div class="content_editor">
+  <label><%= render_content_name(content) %></label>
+  <%= select_tag(
+    content.form_field_name,
+    option_groups_from_collection_for_select(
+      Spree::Taxon.all,
+      :children,
+      :name,
+      :id,
+      :name,
+      content.essence.taxon_id
+    ),
+    :class => ['alchemy_selectbox very_long', html_options[:class]].join(' '),
+    :style => html_options[:style]
+  ) %>
+</div>

data/config/initializers/alchemy.rb

@@ -0,0 +1,10 @@
+Alchemy::Modules.register_module({
+  engine_name: 'spree',
+  name: 'solidus',
+  navigation: {
+    controller: 'spree/admin/orders',
+    action: 'index',
+    name: 'Shop',
+    image: 'alchemy/solidus/alchemy_module_icon.png'
+  }
+})

data/db/migrate/20120229160509_create_alchemy_essence_spree_products.rb

@@ -0,0 +1,8 @@
+class CreateAlchemyEssenceSpreeProducts < ActiveRecord::Migration
+	def change
+		create_table 'alchemy_essence_spree_products' do |t|
+			t.integer :spree_product_id
+		end
+		add_index :alchemy_essence_spree_products, :spree_product_id
+	end
+end

data/db/migrate/20131030140218_create_alchemy_essence_spree_taxons.rb

@@ -0,0 +1,10 @@
+class CreateAlchemyEssenceSpreeTaxons < ActiveRecord::Migration
+  def change
+    create_table :alchemy_essence_spree_taxons do |t|
+      t.references :taxon
+
+      t.timestamps
+    end
+    add_index :alchemy_essence_spree_taxons, :taxon_id
+  end
+end

data/lib/alchemy-solidus.rb

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

data/lib/alchemy/solidus/alchemy_user_decorator.rb

@@ -0,0 +1,10 @@
+Alchemy::User.class_eval do
+
+  def spree_roles
+    if admin?
+      ::Spree::Role.where(name: 'admin')
+    else
+      ::Spree::Role.none
+    end
+  end
+end

data/lib/alchemy/solidus/engine.rb

@@ -0,0 +1,13 @@
+module Alchemy
+  module Solidus
+    class Engine < ::Rails::Engine
+      engine_name 'alchemy_solidus'
+
+      def self.activate
+        Alchemy.register_ability(::Spree::Ability)
+      end
+
+      config.to_prepare &method(:activate).to_proc
+    end
+  end
+end

data/lib/alchemy/solidus/spree_user_decorator.rb

@@ -0,0 +1,10 @@
+Spree::User.class_eval do
+
+  def alchemy_roles
+    if has_spree_role?(:admin)
+      %w(admin)
+    else
+      []
+    end
+  end
+end

data/lib/alchemy/solidus/version.rb

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

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: alchemy-solidus
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Thomas von Deyen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: alchemy_cms
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: solidus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: deface
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: A Alchemy CMS and Solidus connector
+email:
+- tvd@magiclabs.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- alchemy-solidus.gemspec
+- app/assets/images/alchemy/solidus/alchemy_module_icon.png
+- app/models/alchemy/essence_spree_product.rb
+- app/models/alchemy/essence_spree_taxon.rb
+- app/overrides/alchemy_solidus_tab.rb
+- app/views/alchemy/admin/shared/_alchemy_solidus_tab.html.erb
+- app/views/alchemy/essences/_essence_spree_product_editor.html.erb
+- app/views/alchemy/essences/_essence_spree_product_view.html.erb
+- app/views/alchemy/essences/_essence_spree_taxon_editor.html.erb
+- app/views/alchemy/essences/_essence_spree_taxon_view.html.erb
+- config/initializers/alchemy.rb
+- 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/engine.rb
+- lib/alchemy/solidus/spree_user_decorator.rb
+- lib/alchemy/solidus/version.rb
+homepage: https://github.com/AlchemyCMS/alchemy-solidus
+licenses:
+- BSD New
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: The World's Most Flexible E-Commerce Platform meets The World's Most Flexible
+  Content Management System!
+test_files: []