solidus_related_products 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 796ec99b0714a1e62195cac718d7ee685e444885
+  data.tar.gz: 383f4d8974811a381e1ab46ca51078bdd4bb00d2
+SHA512:
+  metadata.gz: df78c358ae876c2d31319614c7122020379ccdd6b7c1720646874b69b15c2164afe2fd03c22671093f6af4d236e0725b98cb0bbbfcf9932c71749741d2e0df75
+  data.tar.gz: 335f7498dbe1557d39fed0f93dadb058fbfce3bec0e66ef213b8d2953b479e3bf28d7d28c90a769bc66a60bd8111f317bffd58301a96951948b4b3cb8e77866c

data/.gitignore

@@ -0,0 +1,12 @@
+*.swp
+.DS_Store
+.rvmrc
+Gemfile.lock
+pkg
+spec/dummy
+*~
+tmp
+.localeapp
+coverage
+.ruby-version
+.ruby-gemset

data/.hound.yml

@@ -0,0 +1,25 @@
+---
+# Too picky.
+LineLength:
+  Enabled: false
+
+# This should truly be on for well documented gems.
+Documentation:
+  Enabled: false
+
+# Neatly aligned code is too swell.
+SpaceBeforeFirstArg:
+  Enabled: false
+
+# Don't mess with RSpec DSL.
+Blocks:
+  Exclude:
+    - 'spec/**/*'
+
+# It say we should use fail over raise.
+SignalException:
+  Enabled: false
+
+# Avoid contradictory style rules by enforce single quotes.
+StringLiterals:
+  EnforcedStyle: single_quotes

data/.rspec

@@ -0,0 +1,3 @@
+--color
+-r spec_helper
+-f documentation

data/.rubocop.yml

@@ -0,0 +1,8 @@
+---
+inherit_from: .hound.yml
+
+AllCops:
+  Exclude:
+    - spec/dummy/**/*
+    - bin/*
+    - Guardfile

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+rvm:
+  - 2.1
+  - 2.2
+sudo: false
+cache: bundler
+env:
+  matrix:
+    - SOLIDUS_BRANCH=master
+    - SOLIDUS_BRANCH=v1.2
+    - SOLIDUS_BRANCH=v1.1
+before_script:
+  - bundle exec rake test_app
+script:
+  - bundle exec rspec spec

data/CONTRIBUTING.md

@@ -0,0 +1,81 @@
+# Contributing
+
+Spree Related Products is an open source project and we encourage contributions. Please see the [contributors guidelines](http://spreecommerce.com/documentation/contributing_to_spree.html) for more information before contributing.
+
+In the spirit of [free software][1], **everyone** is encouraged to help improve this project.
+
+Here are some ways *you* can contribute:
+
+* by using prerelease versions
+* by reporting [bugs][2]
+* by suggesting new features
+* by writing [translations][3]
+* by writing or editing documentation
+* by writing specifications
+* by writing code (*no patch is too small*: fix typos, add comments, clean up inconsistent whitespace)
+* by refactoring code
+* by resolving [issues][2]
+* by reviewing patches
+
+---
+
+## Filing an issue
+
+When filing an issue on this extension, please first do these things:
+
+* Verify you can reproduce this issue in a brand new application.
+* Run through the steps to reproduce the issue again.
+
+In the issue itself please provide:
+
+* A comprehensive list of steps to reproduce the issue.
+* What you're *expecting* to happen compared with what's *actually* happening.
+* The version of Spree *and* the version of Rails.
+* A list of all extensions.
+* Any relevant stack traces ("Full trace" preferred)
+* Your `Gemfile`
+
+In 99% of cases, this information is enough to determine the cause and solution to the problem that is being described.
+
+---
+
+## Pull requests
+
+We gladly accept pull requests to fix bugs and, in some circumstances, add new features to this extension.
+
+Here's a quick guide:
+
+1. Fork the repo.
+
+2. Run the tests. We only take pull requests with passing tests, and it's great to know that you have a clean slate.
+
+3. Create new branch then make changes and add tests for your changes. Only refactoring and documentation changes require no new tests. If you are adding functionality or fixing a bug, we need tests!
+
+4. Push to your fork and submit a pull request. If the changes will apply cleanly to the latest stable branches and master branch, you will only need to submit one pull request.
+
+At this point you're waiting on us. We may suggest some changes or improvements or alternatives.
+
+Some things that will increase the chance that your pull request is accepted, taken straight from the Ruby on Rails guide:
+
+* Use Rails idioms and helpers.
+* Include tests that fail without your code, and pass with it.
+* Update the documentation, the surrounding one, examples elsewhere, guides, whatever is affected by your contribution.
+
+---
+
+## TL;DR
+
+* Fork the repo
+* Clone your repo
+* Run `bundle install`
+* Run `bundle exec rake test_app` to create the test application in `spec/dummy`
+* Make your changes
+* Ensure specs pass by running `bundle exec rspec spec`
+* Ensure all syntax ok by running `rubocop .`
+* Submit your pull request
+
+And in case we didn't emphasize it enough: **we love tests!**
+
+[1]: http://www.fsf.org/licensing/essays/free-sw.html
+[2]: https://github.com/spree-contrib/spree_related_products/issues
+[3]: https://github.com/spree-contrib/spree_related_products/tree/master/config/locales

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+branch = ENV.fetch('SOLIDUS_BRANCH', 'master')
+gem 'solidus', github: 'solidusio/solidus', branch: branch
+
+gemspec

data/Guardfile

@@ -0,0 +1,10 @@
+guard 'rspec', cmd: 'bundle exec rspec' do
+  watch('spec/spec_helper.rb')                       { 'spec' }
+  watch('config/routes.rb')                          { 'spec/controllers' }
+  watch(%r{^spec/(.+)_spec\.rb$})                    { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.+)_decorator\.rb$})                { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.+)\.rb$})                          { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb)$})                       { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^lib/(.+)\.rb$})                          { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$}) { |m| "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb" }
+end

data/LICENSE.md

@@ -0,0 +1,26 @@
+Copyright (c) 2010-2015 Brian Quinn and contributors.
+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 Spree 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 OWNER 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,80 @@
+# Related Products
+
+[![Build Status](https://travis-ci.org/solidusio-contrib/solidus_related_products.svg?branch=master)](https://travis-ci.org/solidusio-contrib/solidus_related_products)
+[![Gem](https://img.shields.io/gem/v/solidus_related_products.svg)](https://rubygems.org/gems/solidus_related_products)
+[![License](http://img.shields.io/badge/license-BSD-yellowgreen.svg)](LICENSE.md)
+
+This extension provides a generic way for you to define different types of relationships between your products, by defining a RelationType for each type of relationship you'd like to maintain.
+
+You can manage RelationTypes via the admin configuration menu, and you can maintain product relationships via __Related Products__ tab on the edit product UI.
+
+## Installation
+
+Add to `Gemfile`:
+```ruby
+gem 'spree_related_products'
+```
+
+Run:
+```sh
+$ bundle install
+$ bundle exec rails g solidus_related_products:install
+```
+
+## Possible uses
+
+* Accessories
+* Cross Sells
+* Up Sells
+* Compatible Products
+* Replacement Products
+* Warranty & Support Products
+
+## Relation Types
+
+When you create a RelationType you can access that set of related products by referencing the relation_type name, see below for an example:
+```ruby
+rt = Spree::RelationType.create(name: 'Accessories', applies_to: 'Spree::Product')
+ => #<Spree::RelationType id: 4, name: "Accessories" ...>
+product = Spree::Product.last
+ => #<Spree::Product id: 1060500592 ...>
+product.accessories
+ => []
+```
+
+Since respond_to? will not work in this case, you can test whether a relation_type method exists with has_related_products?(method):
+
+```ruby
+product.has_related_products?('accessories')
+# => true
+
+if product.has_related_products?('accessories')
+  # Display an accessories box..
+end
+```
+
+You can access all related products regardless of RelationType by:
+```ruby
+product.relations
+ => []
+```
+
+**Discounts**
+You can optionally specify a discount amount to be applied if a customer purchases both products.
+
+Note: In order for the coupon to be automatically applied, you must create a promotion leaving the __code__ value empty, and adding an Action of type : __RelatedProductDiscount__  (blank codes are required for coupons to be automatically applied).
+
+## Contributing
+
+See corresponding [guidelines][4]
+
+---
+
+Copyright (c) 2010-2015 [Brian Quinn][5] and [contributors][6], released under the [New BSD License][3]
+
+[1]: http://www.fsf.org/licensing/essays/free-sw.html
+[2]: https://github.com/spree-contrib/spree_related_products/issues
+[3]: https://github.com/spree-contrib/spree_related_products/blob/master/LICENSE.md
+[4]: https://github.com/spree-contrib/spree_related_products/blob/master/CONTRIBUTING.md
+[5]: https://github.com/BDQ
+[6]: https://github.com/spree-contrib/spree_related_products/graphs/contributors

data/Rakefile

@@ -0,0 +1,15 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+require 'spree/testing_support/common_rake'
+
+RSpec::Core::RakeTask.new
+
+task default: :spec
+
+desc 'Generates a dummy app for testing'
+task :test_app do
+  ENV['LIB_NAME'] = 'solidus_related_products'
+  Rake::Task['common:test_app'].invoke
+end

data/app/assets/javascripts/spree/backend/solidus_related_products.js

@@ -0,0 +1 @@
+//= require spree/backend

data/app/assets/javascripts/spree/frontend/solidus_related_products.js

@@ -0,0 +1 @@
+//= require spree/frontend

data/app/assets/stylesheets/spree/backend/solidus_related_products.css

@@ -0,0 +1,3 @@
+/*
+ *= require spree/backend
+*/

data/app/assets/stylesheets/spree/frontend/solidus_related_products.css

@@ -0,0 +1,3 @@
+/*
+ *= require spree/frontend
+*/

data/app/controllers/spree/admin/products_controller_decorator.rb

@@ -0,0 +1,10 @@
+module Spree
+  module Admin
+    ProductsController.class_eval do
+      def related
+        load_resource
+        @relation_types = Spree::Product.relation_types
+      end
+    end
+  end
+end

data/app/controllers/spree/admin/relation_types_controller.rb

@@ -0,0 +1,6 @@
+module Spree
+  module Admin
+    class RelationTypesController < ResourceController
+    end
+  end
+end

data/app/controllers/spree/admin/relations_controller.rb

@@ -0,0 +1,80 @@
+module Spree
+  module Admin
+    class RelationsController < BaseController
+      before_action :load_data, only: [:create, :destroy]
+
+      respond_to :js, :html
+
+      def create
+        @relation = Relation.new(relation_params)
+        @relation.relatable = @product
+        @relation.related_to = Spree::Variant.find(relation_params[:related_to_id]).product
+        @relation.save
+
+        respond_with(@relation)
+      end
+
+      def update
+        @relation = Relation.find(params[:id])
+        @relation.update_attribute :discount_amount, relation_params[:discount_amount] || 0
+
+        redirect_to(related_admin_product_url(@relation.relatable))
+      end
+
+      def update_positions
+        params[:positions].each do |id, index|
+          model_class.where(id: id).update_all(position: index)
+        end
+
+        respond_to do |format|
+          format.js { render text: 'Ok' }
+        end
+      end
+
+      def destroy
+        @relation = Relation.find(params[:id])
+        if @relation.destroy
+          flash[:success] = flash_message_for(@relation, :successfully_removed)
+
+          respond_with(@relation) do |format|
+            format.html { redirect_to location_after_destroy }
+            format.js   { render :partial => "spree/admin/shared/destroy" }
+          end
+
+        else
+
+          respond_with(@relation) do |format|
+            format.html { redirect_to location_after_destroy }
+          end
+        end
+      end
+
+      private
+
+      def relation_params
+        params.require(:relation).permit(*permitted_attributes)
+      end
+
+      def permitted_attributes
+        [
+          :related_to,
+          :relation_type,
+          :relatable,
+          :related_to_id,
+          :discount_amount,
+          :relation_type_id,
+          :related_to_type,
+          :position
+        ]
+      end
+
+      def load_data
+        @product = Spree::Product.friendly.find(params[:product_id])
+      end
+
+      def model_class
+        Spree::Relation
+      end
+    end
+  end
+end

data/app/controllers/spree/api/relations_controller.rb

@@ -0,0 +1,78 @@
+module Spree
+  module Api
+    class RelationsController < Spree::Api::BaseController
+      before_action :load_data, only: [:create, :destroy]
+      before_action :find_relation, only: [:update, :destroy]
+
+      def create
+        authorize! :create, Relation
+        @relation = @product.relations.new(relation_params)
+        @relation.relatable = @product
+        @relation.related_to = Spree::Variant.find(relation_params[:related_to_id]).product
+        if @relation.save
+          respond_with(@relation, status: 201, default_template: :show)
+        else
+          invalid_resource!(@relation)
+        end
+      end
+
+      def update
+        authorize! :update, Relation
+        if @relation.update_attributes(relation_params)
+          respond_with(@relation, status: 200, default_template: :show)
+        else
+          invalid_resource!(@relation)
+        end
+      end
+
+      def update_positions
+        authorize! :update, Relation
+        params[:positions].each do |id, index|
+          model_class.where(id: id).update_all(position: index)
+        end
+
+        respond_to do |format|
+          format.json { render nothing: true, status: 200 }
+          format.js { render text: 'Ok' }
+        end
+      end
+
+      def destroy
+        authorize! :destroy, Relation
+        @relation.destroy
+        respond_with(@relation, status: 204)
+      end
+
+      private
+
+      def relation_params
+        params.require(:relation).permit(*permitted_attributes)
+      end
+
+      def permitted_attributes
+        [
+          :related_to,
+          :relation_type,
+          :relatable,
+          :related_to_id,
+          :discount_amount,
+          :relation_type_id,
+          :related_to_type,
+          :position
+        ]
+      end
+
+      def load_data
+        @product = Spree::Product.friendly.find(params[:product_id])
+      end
+
+      def find_relation
+        @relation = Relation.find(params[:id])
+      end
+
+      def model_class
+        Spree::Relation
+      end
+    end
+  end
+end