spree_favorite_products 3.0.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f11f3c8880f83651bdb24fe9c818946085b4d8d0
-  data.tar.gz: 6628a06e36d08be97e9c6fd6b567b8f9228c1a78
+  metadata.gz: 4c1b87a8f8374a8725e42a237cd480c073b4b6de
+  data.tar.gz: 737eac610412ab5534ec669d222f95ea3e1378d8
 SHA512:
-  metadata.gz: 6fe013be6540e9c4797b8a71ec3f0c87d8f52841a8cfe18639a380bc4cd7e1b6d99cebd41730d1a16ff3910339d99b516a6213747a4220b56f2add2040803a09
-  data.tar.gz: 0d72ec7b52bb628f6b0e67fc056da1c79b610c90264257f4a129a448f48572dbb1aa87e1e6bcf2ee85ac3fd5119440cbd6def1350de2def05fd884e2f87afe24
+  metadata.gz: ed5fc3f665c0d97711605b053c5577ada2c60a36b962181d3298af38122054e4d04d09fa12a77124ce85087fa612f6864e985b2b73606f9bced90f2aacace407
+  data.tar.gz: bdb7d0aa97295a80e25969276eab56aef30bae46d94f20a42ae44b75d47ddc4278083c07c74bbf276ba0a669fa3a98722eecc6a9bec5a1962882e5238c7a0ac7

data/.gitignore

@@ -2,3 +2,5 @@
 /coverage
 .DS_STORE
 .ruby-version
+Gemfile.lock
+.byebug_history

data/.rspec

@@ -1 +1 @@
---color
+--color

data/Gemfile

@@ -1,19 +1,18 @@
 source 'https://rubygems.org'
 
 # Provides basic authentication functionality for testing parts of your engine
-gem 'spree', '~> 3.0.0'
-gem 'spree_auth_devise', github: 'spree/spree_auth_devise', branch: '3-0-stable'
-gem 'mysql2'
-gem 'sass-rails', '~> 5.0'
+gem 'spree', github: 'spree/spree', branch: '3-2-stable'
+gem 'spree_auth_devise', github: 'spree/spree_auth_devise', branch: 'master'
 
-group :assets do 
-  gem 'coffee-rails', '4.0.1'
-end
+gem 'byebug', '~> 9.0.6'
 
 group :test do
-  gem 'rspec-rails', '~> 2.10'
-  gem 'shoulda-matchers', '2.2.0'
-  gem 'simplecov', :require => false
-  gem 'database_cleaner'
+  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/README.md

@@ -1,11 +1,11 @@
-Spree Favorite Products [![Code Climate](https://codeclimate.com/github/vinsol/spree_favorite_products.png)](https://codeclimate.com/github/vinsol/spree_favorite_products) [![Build Status](https://travis-ci.org/vinsol/spree_favorite_products.png?branch=master)](https://travis-ci.org/vinsol/spree_favorite_products)
-=====================
+Spree Favorite Products
+=======================
 
-This extension adds the following features:
+* Spree Favorite Products is an extension that allows the user to mark/unkmark a product as favorite from the product page.
 
-1. Adds a link 'Mark as favorite' on product detail page.
-2. Favorite Products tab on header
-3. Favorite Products tab in admin section 
+* 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
 ------------
@@ -13,24 +13,7 @@ Installation
 Add spree_favorite_products to your Gemfile:
 
 ```ruby
-gem 'spree_favorite_products', github: 'vinsol/spree_favorite_products', branch: '3-0-stable'
-```
-
-For older versions of spree.
-
-```ruby
-# Spree 2.2.x
-gem 'spree_favorite_products', '2.2.3'
-```
-
-```ruby
-# Spree 2.1.x
-gem 'spree_favorite_products', '2.0.3'
-```
-
-```ruby
-# Spree 2.0.x
-gem 'spree_favorite_products', '1.0.0'
+gem 'spree_favorite_products'
 ```
 
 Bundle your dependencies and run the installation generator:
@@ -74,4 +57,4 @@ 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) 2014 [vinsol.com](http://vinsol.com "Ruby on Rails, iOS and Android developers"), released under the New MIT License
+Copyright (c) 2016 [vinsol.com](http://vinsol.com "Ruby on Rails, iOS and Android developers"), released under the New MIT License

data/Rakefile

@@ -6,11 +6,10 @@ require 'spree/testing_support/extension_rake'
 
 RSpec::Core::RakeTask.new
 
-task :default => [:spec]
+task default: [:spec]
 
 desc 'Generates a dummy app for testing'
 task :test_app do
   ENV['LIB_NAME'] = 'spree_favorite_products'
-  ENV['DB'] = 'mysql'
   Rake::Task['extension:test_app'].invoke
 end

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

@@ -0,0 +1,23 @@
+var getQueryParams = function(queryString) {
+  queryString = queryString.split('+').join(' ');
+
+  var params = {},
+    tokens,
+    re = /[?&]?([^=]+)=([^&]*)/g;
+
+  while (tokens = re.exec(queryString)) {
+    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');
+    }
+  }
+);

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

@@ -3,13 +3,22 @@ module Spree
     class FavoriteProductsController < Spree::Admin::BaseController
 
       def index
-        @search = Spree::Product.favorite.search(params[:q])
+        @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
 
-      def users
-        @product = Spree::Product.where(:id => params[:id]).first
-        @users = @product.favorite_users.page(params[:page])
+      def destroy
+        @favorite = Spree::Favorite.find_by(id: params[:id])
+        if @favorite.destroy
+          flash[:success] = flash_message_for(@favorite, :successfully_removed)
+        else
+          flash[:error] = @favorite.errors.full_messages.join(', ')
+        end
+
+        respond_with(@favorite) do |format|
+          format.html { redirect_to location_after_destroy }
+          format.js   { render_js_for_destroy }
+        end
       end
 
       private
@@ -18,4 +27,4 @@ module Spree
         end
     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_products_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

@@ -1,17 +1,18 @@
 module Spree
   class FavoriteProductsController < Spree::StoreController
 
-    before_filter :authenticate_spree_user!
-    before_filter :find_favorite_product, :only => :destroy
+    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]
+      favorite = spree_current_user.favorites.new product_id: params[:id]
       if @success = favorite.save
-        @message = "Product has been successfully marked as favorite"
+        @message = Spree.t(:success, scope: [:favorite_products, :create])
       else
         @message = favorite.errors.full_messages.to_sentence
       end
@@ -28,7 +29,14 @@ module Spree
 
     private
       def find_favorite_product
-        @favorite = spree_current_user.favorites.joins(:product).readonly(false).where(:spree_products => {:id => params[:id]}).first
+        @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
+end

data/app/models/spree/app_configuration_decorator.rb

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

data/app/models/spree/favorite.rb

@@ -1,9 +1,12 @@
 module Spree
   class Favorite < ActiveRecord::Base
-    belongs_to :product
-    belongs_to :user
-    validates :user_id, :product_id, :presence => true
-    validates :product_id, :uniqueness => { :scope => :user_id, :message => "already marked as favorite" }
-    validates :product, :presence => { :message => "is invalid" }, :if => :product_id
+    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
+end

data/app/models/spree/product_decorator.rb

@@ -1,12 +1,8 @@
 Spree::Product.class_eval do
-  has_many :favorites, :dependent => :destroy
-  has_many :favorite_users, :through => :favorites, :class_name => 'Spree::User', :source => 'user'
+  has_many :favorites, dependent: :destroy
+  has_many :favorite_users, through: :favorites, class_name: 'Spree::User', source: :user
 
-  def self.favorite
-    joins(:favorites).group('spree_favorites.product_id')
-  end
-  
-  def self.order_by_favorite_users_count(asc=false)
-    order("count(spree_favorites.user_id) #{asc ? 'asc' : 'desc'}")
-  end
-end
+  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

@@ -1,8 +1,8 @@
-Spree::User.class_eval do 
-  has_many :favorites, :dependent => :destroy
-  has_many :favorite_products, :through => :favorites, :class_name => 'Spree::Product', :source => 'product'
+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
+    favorites.exists? product_id: product_id
   end
-end
+end

data/app/overrides/add_favorite_products_per_page_configuration.rb

@@ -1,13 +1,13 @@
 Deface::Override.new(
-  :virtual_path => 'spree/admin/general_settings/edit',
-  :name => 'add_favorite_products_per_page_configuration',
-  :insert_before => "#preferences fieldset .form-actions",
-  :text => %Q{
+  virtual_path: 'spree/admin/general_settings/edit',
+  name: 'add_favorite_products_per_page_configuration',
+  insert_before: "#preferences fieldset .form-actions",
+  text: %Q{
     <div class="row">
       <div class="col-md-6">
         <div class="form-group" data-hook="admin_general_setting_favorite_products_per_page">
           <%= label_tag :favorite_products_per_page, Spree.t(:favorite_products_per_page) %>
-          <%= text_field_tag :favorite_products_per_page, Spree::Config[:favorite_products_per_page], :size => 3 %>
+          <%= text_field_tag :favorite_products_per_page, Spree::Config[:favorite_products_per_page], size: 3 %>
         </div>
       </div>
     </div>

data/app/overrides/add_favorite_products_to_products_tab.rb

@@ -1,6 +1,6 @@
 Deface::Override.new(
-  :virtual_path => 'spree/admin/shared/sub_menu/_product',
-  :name => 'select_products_tab',
-  :insert_bottom => "#sidebar-product",
-  :text => %Q{ <%= tab :favorite_products %> }
+  virtual_path: 'spree/admin/shared/sub_menu/_product',
+  name: 'select_products_tab',
+  insert_bottom: "#sidebar-product",
+  text: %Q{ <%= tab :favorite_products %> }
 )

data/app/overrides/add_favorite_users_tab_to_products.rb

@@ -0,0 +1,10 @@
+Deface::Override.new(
+  virtual_path: 'spree/admin/shared/_product_tabs',
+  name: 'add_favorite_users_tab_to_products',
+  insert_bottom: "[data-hook='admin_product_tabs']",
+  text: %Q{
+          <li<%== ' class="active"' if current == :favorited_by %>>
+            <%= link_to_with_icon 'user', Spree.t(:favorited_by), spree.favorite_users_admin_product_path(@product) %>
+          </li>
+        }
+)

data/app/overrides/add_link_to_mark_product_as_favorite.rb

@@ -1,12 +1,13 @@
 Deface::Override.new(
-  :virtual_path => 'spree/products/show',
-  :name => 'add_link_to_mark_product_as_favorite',
-  :insert_after => "div[itemprop='description']",
-  :text => %Q{
+  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' %>
+      <%= link_to Spree.t(:unmark_as_favorite), favorite_product_path(id: @product.id), method: :delete, remote: true, class: 'favorite_link btn btn-primary 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' %>
+      <%= link_to Spree.t(:mark_as_favorite), favorite_products_path(id: @product.id), method: :post, remote: spree_user_signed_in?, class: 'favorite_link btn btn-primary pull-right', id: 'mark-as-favorite' %>
     <% end %>
   }
-)
+)

data/app/overrides/add_link_to_users_favorite_products.rb

@@ -1,8 +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"}
+  virtual_path: "spree/shared/_main_nav_bar",
+  name: "add_link_to_users_favorite_products",
+  insert_after: "#home-link",
+  text: "<% if spree_current_user %><li><%= link_to 'Favorite Products', favorite_products_path %></li><% end %>",
+  sequence: { before: "auth_shared_login_bar"}
 )
 

data/app/overrides/addd_favorite_products_tab_to_users.rb

@@ -0,0 +1,10 @@
+Deface::Override.new(
+  virtual_path: 'spree/admin/users/_sidebar',
+  name: 'add_favorite_products_tab_to_users',
+  insert_bottom: "[data-hook='admin_user_tab_options']",
+  text: %Q{
+          <li<%== ' class="active"' if current == :favorite_products %>>
+            <%= link_to_with_icon 'th-large', Spree.t(:favorite_product), spree.favorite_products_admin_user_path(@user) %>
+          </li>
+        }
+)

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

@@ -0,0 +1,25 @@
+<% if @users.any? %>
+  <table class="table table-striped" id="listing_favorite_products_users">
+    <thead>
+      <tr data-hook="admin_products_index_headers">
+        <th><%= Spree.t(:email) %></th>
+        <th data-hook="admin_users_index_header_actions" class="actions text-right"> <%= Spree.t(:action) %></th>
+      </tr>
+    </thead>
+    <tbody>
+      <% @users.each do |user| %>
+        <tr id="<%= spree_dom_id user %>" data-hook="admin_users_index_rows">
+          <td class='user_email'><%=link_to user.email, edit_admin_user_url(user) %></td>
+          <td data-hook="admin_users_index_row_actions" class="actions actions-2 text-right">
+            <%= link_to_edit user,{ no_text: true, url: edit_admin_user_path(id: user) } %>
+            <%= link_to_delete user, no_text: true, url: admin_favorite_product_path(id: user.favorites.where(product_id: @product.id).first) %>
+          </td>
+        </tr>
+      <% end %>
+    </tbody>
+  </table>
+<% else %>
+  <div class="no-objects-found">
+    <%= Spree.t(:no_results) %>
+  </div>
+<% end %>

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

@@ -5,31 +5,24 @@
 <%= 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>
+  <table class="table table-striped" id="listing_products">
     <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><%= Spree.t(:image) %></th>
+        <th><%= 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, 'favorite_users_count', 'Favorite Users' %></th>
+        <th class="text-right"><%= sort_link @search, 'favorite_users_count', Spree.t(:favorite_users) %></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"><%= mini_image(product) %></td>
+          <tr data-hook="admin_products_index_rows">
+            <td ><%= product.sku rescue '' %></td>
+            <td ><%= mini_image(product) %></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>
+            <td ><%= product.display_price.to_html rescue '' %></td>
+            <td class="text-right"><%= link_to product.favorite_users.count, users_admin_favorite_product_path(id: product.id) %></td>
           </tr>
       <% end %>
     </tbody>