solidus_favorite_products 2.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1336257eb0d7516d9afde7364887ea22c1ef2df6
+  data.tar.gz: 0560780a0201e39767ba8150e4430cf9239c3dca
+SHA512:
+  metadata.gz: 520aba523d389e9e38de267aef542c8632dfdca204bda8525516d05577a29016ba257d9d5cb246132fa2d573c34f6ddefb5c80482bfa696116dd1796b2c118da
+  data.tar.gz: f4f80f4ce7f5c594d715b47fe45b933a616303c33df7662a9952d324ba551b75b957096cd7eac1a0c9f0cb364fda9dc00943ba1640c4ebc2bc41db013d74a887

data/.gitignore

@@ -0,0 +1,6 @@
+/spec/dummy
+/coverage
+.DS_STORE
+.ruby-version
+Gemfile.lock
+.byebug_history

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - ruby-2.1.6
+script:
+  - bundle exec rake test_app
+  - bundle exec rspec spec

data/Gemfile

@@ -0,0 +1,18 @@
+source 'https://rubygems.org'
+
+# Provides basic authentication functionality for testing parts of your engine
+gem 'solidus', '>= 2.1.0'
+gem 'solidus_auth_devise'
+
+gem 'byebug', '~> 9.0.6'
+
+group :test do
+  gem 'rspec-rails', '~> 3.5.2'
+  gem 'shoulda-matchers', '3.1.1'
+  gem 'simplecov', '~> 0.12.0', require: false
+  gem 'database_cleaner', '~> 1.5.3'
+  gem 'rspec-activemodel-mocks', '~> 1.0.3'
+  gem 'rails-controller-testing', '~> 1.0.1'
+end
+
+gemspec

data/LICENSE

@@ -0,0 +1,26 @@
+Copyright (c) 2014 Vinsol
+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,60 @@
+Solidus Favorite Products
+=======================
+[![Code Climate](https://codeclimate.com/github/vinsol/solidus_favorite_products.svg)](https://codeclimate.com/github/vinsol/solidus_favorite_products)
+* Solidus Favorite Products is an extension that allows the user to mark/unkmark a product as favorite from the product page.
+
+* Admin can view which products have been marked as favorite, and by which users, on the Admin end.
+
+* It gives user the ability to see all products marked as favorite by him/her.
+
+Installation
+------------
+
+Add solidus_favorite_products to your Gemfile:
+
+```ruby
+gem 'solidus_favorite_products'
+```
+
+Bundle your dependencies and run the installation generator:
+
+```shell
+bundle
+bundle exec rails g solidus_favorite_products:install
+```
+
+Testing
+-------
+
+Be sure to bundle your dependencies and then create a dummy test app for the specs to run against.
+
+```shell
+bundle
+bundle exec rake test_app
+bundle exec rspec spec
+```
+
+When testing your applications integration with this extension you may use it's factories.
+Simply add this require statement to your spec_helper:
+
+```ruby
+require 'solidus_favorite_products/factories'
+```
+
+Contributing
+------------
+
+1. Fork the repo.
+2. Clone your repo.
+3. Run `bundle install`.
+4. Run `bundle exec rake test_app` to create the test application in `spec/test_app`.
+5. Make your changes.
+6. Ensure specs pass by running `bundle exec rspec spec`.
+7. Submit your pull request.
+
+Credits
+-------
+
+[![vinsol.com: Ruby on Rails, iOS and Android developers](http://vinsol.com/vin_logo.png "Ruby on Rails, iOS and Android developers")](http://vinsol.com)
+
+Copyright (c) 2017 [vinsol.com](http://vinsol.com "Ruby on Rails, iOS and Android developers"), released under the New MIT License

data/Rakefile

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

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

@@ -0,0 +1,21 @@
+module Spree
+  module Admin
+    class FavoriteProductsController < Spree::Admin::BaseController
+
+      def index
+        @search = Spree::Product.favorite.includes(master: :images).search(params[:q])
+        @favorite_products = @search.result.order_by_favorite_users_count(sort_in_ascending_users_count?).page(params[:page])
+      end
+
+      private
+        def sort_in_ascending_users_count?
+          params[:q] && params[:q][:s] == 'favorite_users_count asc'
+        end
+
+        def model_class
+          Spree::Product
+        end
+
+    end
+  end
+end

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

@@ -0,0 +1,6 @@
+Spree::Admin::ProductsController.class_eval do
+
+  def favorite_users
+    @users = @product.favorite_users.page(params[:page]).per(Spree::Config.favorite_users_per_page)
+  end
+end

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

@@ -0,0 +1,5 @@
+Spree::Admin::UsersController.class_eval do
+  def favorite_products
+    @favorite_products = @user.favorite_products.page(params[:page]).per(Spree::Config.favorite_products_per_page)
+  end
+end

data/app/controllers/spree/favorite_products_controller.rb

@@ -0,0 +1,42 @@
+module Spree
+  class FavoriteProductsController < Spree::StoreController
+
+    prepend_before_action :store_favorite_product_preference, only: :create
+    before_action :authenticate_spree_user!
+    before_action :find_favorite_product, only: :destroy
+
+    def index
+      @favorite_products = spree_current_user.favorite_products.page(params[:page]).per(Spree::Config.favorite_products_per_page)
+    end
+
+    def create
+      favorite = spree_current_user.favorites.new(product_id: params[:id])
+      if @success = favorite.save
+        @message = Spree.t(:success, scope: [:favorite_products, :create])
+      else
+        @message = favorite.errors.full_messages.to_sentence
+      end
+      respond_to do |format|
+        format.js
+      end
+    end
+
+    def destroy
+      if @favorite
+        @success = @favorite.destroy
+      end
+    end
+
+    private
+      def find_favorite_product
+        @favorite = spree_current_user.favorites.with_product_id(params[:id]).first
+      end
+
+      def store_favorite_product_preference
+        unless spree_current_user
+          session[:spree_user_return_to] = product_path(id: params[:id], favorite_product_id: params[:id])
+          redirect_to login_path, notice: Spree.t(:login_to_add_favorite)
+        end
+      end
+  end
+end

data/app/models/spree/app_configuration_decorator.rb

@@ -0,0 +1,4 @@
+Spree::AppConfiguration.class_eval do
+  preference :favorite_products_per_page, :integer, default: 20
+  preference :favorite_users_per_page, :integer, default: 20
+end

data/app/models/spree/favorite.rb

@@ -0,0 +1,12 @@
+module Spree
+  class Favorite < ActiveRecord::Base
+    with_options required: true do
+      belongs_to :product, counter_cache: :favorite_users_count
+      belongs_to :user
+    end
+
+    validates :product_id, uniqueness: { scope: :user_id, message: Spree.t(:duplicate_favorite), allow_blank: true }
+
+    scope :with_product_id, ->(id) { joins(:product).readonly(false).merge(Spree::Product.where(id: id)) }
+  end
+end

data/app/models/spree/product_decorator.rb

@@ -0,0 +1,8 @@
+Spree::Product.class_eval do
+  has_many :favorites, dependent: :destroy
+  has_many :favorite_users, through: :favorites, class_name: 'Spree::User', source: :user
+
+  scope :favorite, -> { joins(:favorites).distinct }
+
+  scope :order_by_favorite_users_count, ->(asc = false) { order(favorite_users_count: "#{asc ? 'asc' : 'desc'}") }
+end

data/app/models/spree/user_decorator.rb

@@ -0,0 +1,8 @@
+Spree::User.class_eval do
+  has_many :favorites, dependent: :destroy
+  has_many :favorite_products, through: :favorites, class_name: 'Spree::Product', source: :product
+
+  def has_favorite_product?(product_id)
+    favorites.exists? product_id: product_id
+  end
+end

data/app/overrides/add_favorite_products.rb

@@ -0,0 +1,34 @@
+Deface::Override.new(
+  virtual_path: 'spree/products/show',
+  name: 'add_favorite_products_after_login',
+  insert_after: '[data-hook="product_show"]',
+  text: %Q{
+    <%= javascript_tag do %>
+      var getQueryParams = function(qs) {
+        qs = qs.split('+').join(' ');
+
+        var params = {},
+          tokens,
+          re = /[?&]?([^=]+)=([^&]*)/g;
+
+        while (tokens = re.exec(qs)) {
+          params[decodeURIComponent(tokens[1])] = decodeURIComponent(tokens[2]);
+        }
+
+        return params;
+      }
+
+      $(document).ready(
+        function(){
+          var params = getQueryParams(document.location.search);
+          if(params['favorite_product_id'] != null){
+            $('#mark-as-favorite').attr('data-remote', true);
+            $('#mark-as-favorite').trigger('click');
+          }
+        }
+      );
+    <% end %>
+  }
+)
+
+

data/app/overrides/add_favorite_products_tab_ro_user_edit.rb

@@ -0,0 +1,11 @@
+Deface::Override.new(
+  virtual_path: 'spree/admin/users/_tabs',
+  name: 'add_favorite_products_tab_user_edit',
+  insert_bottom: '[data-hook="admin_user_tab_options"]',
+  text: %Q{
+    <%= content_tag :li, class: ('active' if current == :favorite_products) do %>
+      <%= link_to Spree.t(:favorite_products,scope: [:admin, :tab]), spree.favorite_products_admin_user_path(@user) %>
+    <% end if can?(:admin, Spree::Product) %>
+  }
+)
+

data/app/overrides/add_favorite_products_to_products_tab.rb

@@ -0,0 +1,6 @@
+Deface::Override.new(
+  virtual_path: 'spree/admin/shared/_product_sub_menu',
+  name: 'select_products_tab',
+  insert_bottom: '[data-hook="admin_product_sub_tabs"]',
+  text: %Q{ <%= tab :favorite_products if can?(:admin, Spree::Product) %> }
+)

data/app/overrides/add_favorite_users_tab_in_product_edit.rb

@@ -0,0 +1,10 @@
+Deface::Override.new(
+  virtual_path: 'spree/admin/shared/_product_tabs',
+  name: 'add_favorite_users_tab_in_product_edit',
+  insert_bottom: '[data-hook="admin_product_tabs"]',
+  text: %Q{
+    <%= content_tag :li, class: ('active' if current == 'Favorite Products') do %>
+      <%= link_to Spree.t(:favorites), spree.favorite_users_admin_product_path(@product) %>
+    <% end if can?(:admin, Spree::Product) %>
+  }
+)

data/app/overrides/add_link_to_mark_product_as_favorite.rb

@@ -0,0 +1,13 @@
+Deface::Override.new(
+  :virtual_path => 'spree/products/show',
+  :name => 'add_link_to_mark_product_as_favorite',
+  :surround_contents => "h1[itemprop='name']",
+  :text => %Q{
+    <%= render_original %>
+    <% if spree_user_signed_in? && spree_current_user.has_favorite_product?(@product.id) %>
+      <%= link_to Spree.t(:unmark_as_favorite), favorite_product_path(id: @product.id), method: :delete, remote: true, class: 'favorite_link button pull-right', id: 'unmark-as-favorite' %>
+    <% else %>
+      <%= link_to Spree.t(:mark_as_favorite), favorite_products_path(id: @product.id), method: :post, remote: spree_user_signed_in?, class: 'favorite_link button pull-right', id: 'mark-as-favorite' %>
+    <% end %>
+  }
+)

data/app/overrides/add_link_to_users_favorite_products.rb

@@ -0,0 +1,8 @@
+Deface::Override.new(
+  virtual_path: "spree/shared/_nav_bar",
+  name: "add_link_to_users_favorite_products",
+  insert_before: "li#search-bar",
+  text: "<% if spree_current_user %><li><%= link_to 'Favorite Products', favorite_products_path %></li><% end %>",
+  sequence: { before: "auth_shared_login_bar"}
+)
+

data/app/views/spree/admin/favorite_products/index.html.erb

@@ -0,0 +1,45 @@
+<% content_for :page_title do %>
+  <%= Spree.t(:listing_favorite_products) %>
+<% end %>
+
+<%= paginate @favorite_products %>
+
+<% if @favorite_products.any? %>
+  <table class="table" id="listing_products">
+    <colgroup>
+       <col style="width: 15%;">
+       <col style="width: 10%;">
+       <col style="width: 38%;">
+       <col style="width: 10%;">
+       <col style="width: 17%;">
+       <col style="width: 10%;">
+    </colgroup>
+    <thead>
+      <tr data-hook="admin_products_index_headers">
+        <th><%= Spree.t(:sku) %></th>
+        <th colspan="2"><%= sort_link @search, :name, Spree.t(:name) %></th>
+        <th><%= sort_link @search, :master_default_price_amount, Spree.t(:master_price) %></th>
+        <th><%= sort_link @search, 'Users Count', Spree.t(:user_count) %></th>
+      </tr>
+    </thead>
+    <tbody>
+      <% @favorite_products.each do |product| %>
+          <tr <%= "style='color: red;'" if product.deleted? %> id="<%= spree_dom_id product %>" data-hook="admin_products_index_rows" class="<%= cycle('odd', 'even') %>">
+            <td class="align-center"><%= product.sku rescue '' %></td>
+            <td class="align-center">
+              <%= image_tag product.display_image.attachment(:mini) %>
+            </td>
+            <td><%= link_to product.try(:name), edit_admin_product_path(product) %></td>
+            <td class="align-center"><%= product.display_price.to_html rescue '' %></td>
+            <td class='align-center'><%= link_to product.favorite_users.count, users_admin_favorite_product_path(:id => product.id) %></td>
+          </tr>
+      <% end %>
+    </tbody>
+  </table>
+<% else %>
+  <div class="no-objects-found">
+    <%= Spree.t(:no_results) %>
+  </div>
+<% end %>
+
+<%= paginate @favorite_products %>

data/app/views/spree/admin/favorite_products/users.html.erb

@@ -0,0 +1,15 @@
+<% content_for :page_title do %>
+  <%= Spree.t(:listing_favorite_products_users) %>
+<% end %>
+
+<%= paginate @users %>
+
+<% if @users.any? %>
+  <%= render 'spree/admin/shared/favorite_products/users', users: @users %>
+<% else %>
+  <div class="no-objects-found">
+    <%= Spree.t(:no_results) %>
+  </div>
+<% end %>
+
+<%= paginate @users %>

data/app/views/spree/admin/products/favorite_users.html.erb

@@ -0,0 +1,24 @@
+<% content_for :page_actions do %>
+  <% if can?(:admin, Spree::Product) %>
+    <li id="new_product_link">
+      <%= Spree.t(:listing_favorite_products_users) %>
+    </li>
+  <% end %>
+<% end %>
+
+<%= render :partial => 'spree/admin/shared/product_tabs', :locals => { :current => 'Favorite Products' } %>
+<%= render :partial => 'spree/shared/error_messages', :locals => { :target => @product } %>
+
+<% admin_breadcrumb(Spree.t(:favorite_products, scope: [:admin, :tab])) %>
+
+<%= paginate @users if @user.present? %>
+
+<% if @users.any? %>
+  <%= render 'spree/admin/shared/favorite_products/users', users: @users %>
+<% else %>
+  <div class="no-objects-found">
+    <%= Spree.t(:no_results) %>
+  </div>
+<% end %>
+
+<%= paginate @users if @user.present? %>