spree_favorite_products 1.0.0

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Provides basic authentication functionality for testing parts of your engine
+gem 'spree_auth_devise', github: 'spree/spree_auth_devise'
+
+gemspec

data/LICENSE

@@ -0,0 +1,26 @@
+Copyright (c) 2013 [name of plugin creator]
+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,43 @@
+SpreeFavoriteProducts
+=====================
+
+This extension adds the following features:
+1. Adds a link 'Mark as favorite' on product detail page.
+2. Favorite Products tab on header
+3. Favorite Products tab in admin section 
+
+Installation
+------------
+
+Add spree_favorite_products to your Gemfile:
+
+```ruby
+gem 'spree_favorite_products'
+```
+
+Bundle your dependencies and run the installation generator:
+
+```shell
+bundle
+bundle exec rails g spree_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 'spree_favorite_products/factories'
+```
+
+Copyright (c) 2013 [name of extension creator], released under the New BSD 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'] = 'spree_favorite_products'
+  Rake::Task['extension:test_app'].invoke
+end

data/Versionfile

@@ -0,0 +1,11 @@
+# This file is used to designate compatibilty with different versions of Spree
+# Please see http://spreecommerce.com/documentation/extensions.html#versionfile for details
+
+# Examples
+#
+# '1.2.x'  => { :branch => 'master' }
+# '1.1.x'  => { :branch => '1-1-stable' }
+# '1.0.x'  => { :branch => '1-0-stable' }
+# '0.70.x' => { :branch => '0-70-stable' }
+# '0.40.x' => { :tag => 'v1.0.0', :version => '1.0.0' }
+

data/app/assets/javascripts/admin/spree_favorite_products.js

@@ -0,0 +1 @@
+//= require admin/spree_backend

data/app/assets/javascripts/store/spree_favorite_products.js

@@ -0,0 +1 @@
+//= require store/spree_frontend

data/app/assets/stylesheets/admin/spree_favorite_products.css

@@ -0,0 +1,3 @@
+/*
+ *= require admin/spree_backend
+*/

data/app/assets/stylesheets/store/spree_favorite_products.css

@@ -0,0 +1,3 @@
+/*
+ *= require store/spree_frontend
+*/

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

@@ -0,0 +1,15 @@
+module Spree
+  module Admin
+    class FavoriteProductsController < Spree::Admin::BaseController
+
+      def index
+        @favorite_products = Spree::Product.favorite.page(params[:page])
+      end
+
+      def users
+        @product = Spree::Product.where(:id => params[:id]).first
+        @users = @product.favorite_users.page(params[:page])
+      end
+    end
+  end
+end

data/app/controllers/spree/favorite_products_controller.rb

@@ -0,0 +1,31 @@
+module Spree
+  class FavoriteProductsController < Spree::StoreController
+
+    before_filter :authenticate_spree_user!, :only => [:index, :create, :destroy]
+
+    def index
+      @favorite_products = spree_current_user.favorite_products
+    end
+
+    def create
+      favorite = spree_current_user.favorites.new :product_id => params[:id]
+      if @success = favorite.save
+        @message = "Product has been successfully marked as favorite"
+      else
+        @message = favorite.errors.full_messages.to_sentence
+      end
+      respond_to do |format|
+        format.js
+      end
+    end
+
+    def destroy
+      if @product_id = Spree::Product.where(:permalink => params[:id]).first.try(:id)
+        @favorite_product = Spree::Favorite.where("user_id = ? and product_id = ?", spree_current_user.id, @product_id).first
+        @success = @favorite_product.try(:destroy)
+      else
+        @success = false
+      end
+    end
+  end
+end

data/app/models/spree/favorite.rb

@@ -0,0 +1,10 @@
+module Spree
+  class Favorite < ActiveRecord::Base
+    attr_accessible :product_id
+    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
+  end
+end

data/app/models/spree/product_decorator.rb

@@ -0,0 +1,8 @@
+Spree::Product.class_eval do
+  has_many :favorites
+  has_many :favorite_users, :through => :favorites, :class_name => 'Spree::User', :source => 'user'
+
+  def self.favorite
+    joins(:favorites).uniq
+  end
+end

data/app/models/spree/user_decorator.rb

@@ -0,0 +1,4 @@
+Spree::User.class_eval do 
+  has_many :favorites
+  has_many :favorite_products, :through => :favorites, :class_name => 'Spree::Product', :source => 'product'
+end

data/app/overrides/add_favorite_products_tab.rb

@@ -0,0 +1,6 @@
+Deface::Override.new(
+  :virtual_path => 'spree/admin/shared/_product_sub_menu',
+  :name => 'add_favorite_products_tab',
+  :insert_bottom => "ul#sub_nav",
+  :text => "<%= tab :favorite_products %>"
+)

data/app/overrides/add_link_to_mark_product_as_favorite.rb

@@ -0,0 +1,6 @@
+Deface::Override.new(
+  :virtual_path => 'spree/products/show',
+  :name => 'add_link_to_mark_product_as_favorite',
+  :insert_after => "div[itemprop='description']",
+  :text => "<%= link_to 'Mark as favorite', favorite_products_path(:id => @product.id), :method => :post, :remote => spree_user_signed_in? %>"
+)

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,46 @@
+<% content_for :page_title do %>
+  <%= Spree.t(:listing_favorite_products) %>
+<% end %>
+
+<%= render :partial => 'spree/admin/shared/product_sub_menu' %>
+
+<%= paginate @favorite_products %>
+
+<% if @favorite_products.any? %>
+  <table class="index" 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"><%= Spree.t(:name) %></th>
+        <th><%= Spree.t(:master_price) %></th>
+        <th>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>
+            <td><%= product.try(:name) %></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,32 @@
+<% content_for :page_title do %>
+  <%= Spree.t(:listing_favorite_products_users) %>
+<% end %>
+
+<%= render :partial => 'spree/admin/shared/product_sub_menu' %>
+
+<%= paginate @users %>
+
+<% if @users.any? %>
+  <table class="index" id="listing_favorite_products_users">
+    <thead>
+      <tr data-hook="admin_products_index_headers">
+        <th>Email</th>
+      </tr>
+    </thead>
+    <tbody>
+      <% @users.each do |user| %>
+        <tr>
+          <td>
+            <%= user.email %>
+          </tr>
+      <% end %>
+    </tbody>
+  </table>
+<% else %>
+  <div class="no-objects-found">
+    <%= Spree.t(:no_results) %>
+  </div>
+<% end %>
+
+<%= paginate @users %>
+

data/app/views/spree/favorite_products/create.js.erb

@@ -0,0 +1 @@
+alert("<%=j @message%>");

data/app/views/spree/favorite_products/destroy.js.erb

@@ -0,0 +1,6 @@
+<% if @success %>
+  $("#favorite_product_<%= @product_id%>").remove();
+  alert("Successfully removed favorite product from your list")
+<% else %>
+  alert("Could not remove product form your list")
+<% end %>

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

@@ -0,0 +1,25 @@
+<div data-hook="account_my_favorite_products" class="account-my-favorite-products commonform">
+  <h3><%= Spree.t(:my_favorite_products) %></h3>
+  <% if @favorite_products.present? %>
+    <table class="favorite-products order-summary">
+      <thead>
+      <tr>
+        <th class="favorite-product-image"><%= Spree.t(:product_image) %></th>
+        <th class="favorite-product-name"><%= Spree.t(:product_name) %></th>
+        <th class="favorite-product-action">Action</th>        
+      </tr>
+      </thead>
+      <tbody>
+      <% @favorite_products.each do |product| %>
+        <tr class="<%= cycle('even', 'odd') %>" id="favorite_product_<%= product.id %>">
+          <td class="favorite-product-image"><%= link_to small_image(product), product_path(product) %></td>
+          <td class="favorite-product-name"><%= product.name %></td>
+          <td class="favorite-product-remove"><%= link_to 'Remove', favorite_product_path(product), :method => :delete, :remote => true %>
+        </tr>
+      <% end %>
+      </tbody>
+    </table>
+  <% else %>
+    <p><%= Spree.t(:you_have_no_favorite_products_yet) %></p>
+  <% end %>
+</div>

data/config/locales/en.yml

@@ -0,0 +1,5 @@
+# Sample localization file for English. Add more files in this directory for other locales.
+# See https://github.com/svenfuchs/rails-i18n/tree/master/rails%2Flocale for starting points.
+
+en:
+  hello: "Hello world"

data/config/routes.rb

@@ -0,0 +1,10 @@
+Spree::Core::Engine.routes.draw do
+  # Add your extension routes here
+  namespace :admin do
+    resources :favorite_products, :only => :index do
+      get :users, :on => :member
+    end
+  end
+
+  resources :favorite_products, :only => [:index, :create, :destroy]
+end

data/db/migrate/20130705080641_create_table_favorites.rb

@@ -0,0 +1,9 @@
+class CreateTableFavorites < ActiveRecord::Migration
+  def change
+    create_table :favorites do |t|
+      t.integer :user_id
+      t.integer :product_id
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20130710105100_rename_favorites_to_spree_favorites.rb

@@ -0,0 +1,7 @@
+class RenameFavoritesToSpreeFavorites < ActiveRecord::Migration
+  def change
+    rename_table :favorites, :spree_favorites
+    add_index :spree_favorites, [:user_id, :product_id], :unique => true
+    add_index :spree_favorites, :user_id
+  end
+end

data/lib/generators/spree_favorite_products/install/install_generator.rb

@@ -0,0 +1,31 @@
+module SpreeFavoriteProducts
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+
+      class_option :auto_run_migrations, :type => :boolean, :default => false
+
+      def add_javascripts
+        append_file 'app/assets/javascripts/store/all.js', "//= require store/spree_favorite_products\n"
+        append_file 'app/assets/javascripts/admin/all.js', "//= require admin/spree_favorite_products\n"
+      end
+
+      def add_stylesheets
+        inject_into_file 'app/assets/stylesheets/store/all.css', " *= require store/spree_favorite_products\n", :before => /\*\//, :verbose => true
+        inject_into_file 'app/assets/stylesheets/admin/all.css', " *= require admin/spree_favorite_products\n", :before => /\*\//, :verbose => true
+      end
+
+      def add_migrations
+        run 'bundle exec rake railties:install:migrations FROM=spree_favorite_products'
+      end
+
+      def run_migrations
+        run_migrations = options[:auto_run_migrations] || ['', 'y', 'Y'].include?(ask 'Would you like to run the migrations now? [Y/n]')
+        if run_migrations
+          run 'bundle exec rake db:migrate'
+        else
+          puts 'Skipping rake db:migrate, don\'t forget to run it!'
+        end
+      end
+    end
+  end
+end

data/lib/spree_favorite_products.rb

@@ -0,0 +1,2 @@
+require 'spree_core'
+require 'spree_favorite_products/engine'

data/lib/spree_favorite_products/engine.rb

@@ -0,0 +1,22 @@
+module SpreeFavoriteProducts
+  class Engine < Rails::Engine
+    require 'spree/core'
+    isolate_namespace Spree
+    engine_name 'spree_favorite_products'
+
+    config.autoload_paths += %W(#{config.root}/lib)
+
+    # use rspec for tests
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+
+    def self.activate
+      Dir.glob(File.join(File.dirname(__FILE__), '../../app/**/*_decorator*.rb')) do |c|
+        Rails.configuration.cache_classes ? require(c) : load(c)
+      end
+    end
+
+    config.to_prepare &method(:activate).to_proc
+  end
+end

data/lib/spree_favorite_products/factories.rb

@@ -0,0 +1,6 @@
+FactoryGirl.define do
+  # Define your Spree extensions Factories within this file to enable applications, and other extensions to use and override them.
+  #
+  # Example adding this to your spec_helper will load these Factories for use:
+  # require 'spree_favorite_products/factories'
+end

data/script/rails

@@ -0,0 +1,7 @@
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/spree_favorite_products/engine', __FILE__)
+
+require 'rails/all'
+require 'rails/engine/commands'

data/spec/controllers/spree/admin/favorite_products_controller_spec.rb

@@ -0,0 +1,70 @@
+require 'spec_helper'
+
+describe Spree::Admin::FavoriteProductsController do
+  let(:role) { Spree::Role.create!(:name => 'user') }
+  let(:roles) { [role] }
+  let(:product) { mock_model( Spree::Product) }
+
+  before(:each) do
+    @user = mock_model(Spree::User, :generate_spree_api_key! => false)
+    @user.stub_chain(:roles, :includes).and_return([])
+    @user.stub(:has_spree_role?).with('admin').and_return(true)
+    controller.stub(:spree_user_signed_in?).and_return(true)
+    controller.stub(:spree_current_user).and_return(@user)
+    @user.stub(:roles).and_return(roles)
+    roles.stub(:includes).with(:permissions).and_return(roles)
+    controller.stub(:authorize_admin).and_return(true)
+    controller.stub(:authorize!).and_return(true)
+  end
+
+  describe "GET index" do
+    def send_request
+      get :index, :page => 1 ,:use_route => 'spree'
+    end
+
+    before(:each) do
+      @favorite_products = double('favorite_products')
+      @favorite_products.stub(:page).and_return(@favorite_products)
+      Spree::Product.stub(:favorite).and_return(@favorite_products)
+    end
+
+    it "returns favorite products" do
+      Spree::Product.should_receive(:favorite)
+      send_request
+    end
+
+    it "paginates favorite products" do
+      @favorite_products.should_receive(:page).with("1")
+      send_request
+    end
+
+    it "renders favorite products template" do
+      send_request
+      response.should render_template(:favorite)
+    end
+  end
+
+  describe "#users" do
+    before do
+      product.stub(:favorite_users).and_return([@user])
+      @products = [product]
+      Spree::Product.stub(:where).with(:id => product.id).and_return(@products)
+    end
+
+    def send_request
+      get :users, :use_route => 'spree', :id => product.id, :format => :js
+    end
+
+    it 'fetches the product' do
+      Spree::Product.should_receive(:where).with(:id => product.id).and_return(@products)
+    end
+
+    it 'fetches the users who marked the product as favorite' do
+      product.should_receive(:favorite_users).and_return([@user])
+    end
+
+    after do
+      send_request
+    end
+  end
+end

data/spec/controllers/spree/favorite_products_controller_spec.rb

@@ -0,0 +1,181 @@
+require 'spec_helper'
+
+describe Spree::FavoriteProductsController do
+
+  shared_examples_for "request which requires user authentication" do
+    it "authenticates user" do
+      controller.should_receive(:authenticate_spree_user!)
+      send_request      
+    end
+  end
+
+  describe 'POST create' do
+    def send_request
+      post :create, :id => 1, :format => :js, :use_route => 'spree'
+    end
+
+    before(:each) do
+      @favorite = mock_model(Spree::Favorite, :save => true)
+      controller.stub(:authenticate_spree_user!).and_return(true)
+      Spree::Favorite.stub(:new).and_return(@favorite)
+      @user = mock_model(Spree::User, :favorites => Spree::Favorite, :generate_spree_api_key! => false, :last_incomplete_spree_order => nil)
+      controller.stub(:spree_current_user).and_return(@user)
+    end
+
+    it_behaves_like "request which requires user authentication"
+
+      
+    it "creates favorite" do
+      Spree::Favorite.should_receive(:new).with(:product_id => 1)
+      send_request
+    end
+
+    it "saves favorite" do
+      @favorite.should_receive(:save)
+      send_request
+    end
+
+    context "when favorite saved successfully" do
+      it "renders create" do
+        send_request
+        response.should render_template(:create)
+      end
+
+      it "should assign success message" do
+        send_request
+        assigns(:message).should eq("Product has been successfully marked as favorite")
+      end
+    end
+
+    context "when favorite not saved sucessfully" do
+      before(:each) do
+        @favorite.stub(:save).and_return(false)
+        @favorite.stub_chain(:errors, :full_messages).and_return(["Product already marked as favorite"])
+      end
+
+      it "renders create template" do
+        send_request
+        response.should render_template(:create)
+      end
+
+      it "should assign error message" do
+        send_request
+        assigns(:message).should eq("Product already marked as favorite")
+      end
+    end
+  end
+
+  describe 'GET index' do
+    def send_request
+      get :index, :use_route => 'spree'
+    end
+
+    before(:each) do
+      @favorite_product = mock_model(Spree::Product)
+      @user = mock_model(Spree::User, :favorite_products => [@favorite_product], :generate_spree_api_key! => false, :last_incomplete_spree_order => nil)
+      controller.stub(:authenticate_spree_user!).and_return(true)
+      controller.stub(:spree_current_user).and_return(@user)
+    end
+
+    it "authenticates user" do
+      controller.should_receive(:authenticate_spree_user!)
+      send_request
+    end
+
+    it "finds favorite products of current user" do
+      @user.should_receive(:favorite_products)
+      send_request
+    end
+
+    it "assigns @favorite_products" do
+      send_request
+      assigns(:favorite_products).should eq([@favorite_product])
+    end
+  end
+
+  describe 'destroy' do
+    def send_request(params = {})
+      post :destroy, params.merge({:use_route => 'spree', :method => :delete, :format => :js})
+    end
+
+    before do
+      @favorite_product = mock_model(Spree::Favorite)
+      @product = mock_model(Spree::Product, :permalink => 'my_product', :id => 100)
+      @user = mock_model(Spree::User, :favorite_products => [@favorite_product], :generate_spree_api_key! => false, :last_incomplete_spree_order => nil)
+      controller.stub(:authenticate_spree_user!).and_return(true)
+      controller.stub(:spree_current_user).and_return(@user)
+    end
+
+    it_behaves_like "request which requires user authentication"
+
+    context 'when favorite product entry for the requested product exits' do
+      before do
+        Spree::Product.stub(:where).with(:permalink => @product.permalink).and_return([@product])
+        Spree::Favorite.stub(:where).with("user_id = ? and product_id = ?", @user.id, 100).and_return([@favorite_product])
+      end
+
+      it 'assigns its id to product_id' do
+        send_request(:id => @product.permalink)
+        assigns(:product_id).should eq(100)
+      end
+
+      it 'assigns favorite product object to favorite_product' do
+        send_request(:id => @product.permalink)
+        assigns(:favorite_product).should eq(@favorite_product)
+      end
+
+      it 'calls for destroy on the favorite_product' do
+        @favorite_product.should_receive(:destroy)        
+        send_request(:id => @product.permalink)
+      end 
+
+      context 'and is destroyed successfully' do
+        before do
+          @favorite_product.stub(:destroy).and_return(true)
+        end
+
+        it 'assigns true to success' do
+          send_request(:id => @product.permalink)
+          assigns(:success).should be_true
+        end
+      end
+
+      context 'and is not destroyed successfully' do
+        before do
+          @favorite_product.stub(:destroy).and_return(false)
+        end
+
+        it 'assigns false to success' do
+          send_request(:id => @product.permalink)
+          assigns(:success).should be_false
+        end
+      end
+    end
+
+    context 'when favorite product entry for the requested product does not exit' do
+      before do
+        Spree::Product.stub(:where).with(:permalink => @product.permalink).and_return([])
+      end
+
+      it 'does not assign any id to product_id' do
+        send_request(:id => @product.permalink)
+        assigns(:product_id).should be_nil
+      end
+
+      it 'assigns favorite product object to favorite_product' do
+        send_request(:id => @product.permalink)
+        assigns(:favorite_product).should be_nil
+      end
+
+      it 'calls for destroy on the favorite_product' do
+        send_request(:id => @product.permalink)
+        @favorite_product.should_not_receive(:destroy)        
+      end
+
+      it 'assigns false to success' do
+        send_request(:id => @product.permalink)
+        assigns(:success).should be_false
+      end 
+    end
+  end
+end

data/spec/models/spree/favorite_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe Spree::Favorite do
+  it { should allow_mass_assignment_of :product_id }
+  it { should belong_to(:product) }
+  it { should belong_to(:user) }
+  it { should validate_uniqueness_of(:product_id).scoped_to(:user_id).with_message("already marked as favorite") }
+  it { should validate_presence_of(:user_id) }
+  it { should validate_presence_of(:product_id) }
+
+  context "when product_id is present" do
+    before(:each) do
+      @favorite = Spree::Favorite.new :product_id => 'invalid product id'
+    end
+    it "checks for the presence of product" do
+      @favorite.valid?
+      @favorite.errors[:product].should eq(["is invalid"])
+    end
+  end
+
+  context "when product_id is not present" do
+    before(:each) do
+      @favorite = Spree::Favorite.new
+    end
+
+    it "does not validate the presence of product" do
+      @favorite.valid?
+      @favorite.errors[:product].should eq([])
+    end
+  end
+end

data/spec/models/spree/product_decorator_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe Spree::Product do
+  it { should have_many(:favorites) }
+  it { should have_many(:favorite_users).through(:favorites).class_name('Spree::User') }
+
+  describe "Spree::Product.favorite" do
+    before(:each) do
+      @favorite_product1 = Spree::Product.create! :name => 'favorite_product1', :price => 100
+      @favorite_product2 = Spree::Product.create! :name => 'favorite_product2', :price => 100
+      @product1 = Spree::Product.create! :name => 'product1', :price => 100
+      @product2 = Spree::Product.create! :name => 'product2', :price => 100
+      @user1 = Spree::User.create! :email => 'user1@example.com', :password => 'example', :password_confirmation => "example"
+      @user2 = Spree::User.create! :email => 'user2@example.com', :password => "example", :password_confirmation => 'example'
+      @user1.favorites.create! :product_id => @favorite_product1.id
+      @user2.favorites.create! :product_id => @favorite_product1.id
+      @user2.favorites.create! :product_id => @favorite_product2.id
+    end
+
+    it "returns favorite products" do
+      Spree::Product.favorite.should =~ [@favorite_product1, @favorite_product2]
+    end
+  end
+end

data/spec/models/spree/user_decorator_spec.rb

@@ -0,0 +1,6 @@
+require 'spec_helper'
+
+describe Spree::User do
+  it { should have_many(:favorites) }
+  it { should have_many(:favorite_products).through(:favorites).class_name('Spree::Product') }
+end

data/spec/spec_helper.rb

@@ -0,0 +1,81 @@
+# Run Coverage report
+require 'simplecov'
+SimpleCov.start do
+  add_group 'Controllers', 'app/controllers'
+  add_group 'Helpers', 'app/helpers'
+  add_group 'Mailers', 'app/mailers'
+  add_group 'Models', 'app/models'
+  add_group 'Views', 'app/views'
+  add_group 'Libraries', 'lib'
+end
+
+# Configure Rails Environment
+ENV['RAILS_ENV'] = 'test'
+
+require File.expand_path('../dummy/config/environment.rb',  __FILE__)
+
+require 'rspec/rails'
+require 'database_cleaner'
+require 'ffaker'
+
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir[File.join(File.dirname(__FILE__), 'support/**/*.rb')].each { |f| require f }
+
+# Requires factories defined in spree_core
+require 'spree/testing_support/factories'
+require 'spree/testing_support/controller_requests'
+require 'spree/testing_support/authorization_helpers'
+require 'spree/testing_support/url_helpers'
+
+# Requires factories defined in lib/spree_favorite_products/factories.rb
+require 'spree_favorite_products/factories'
+
+RSpec.configure do |config|
+  config.include FactoryGirl::Syntax::Methods
+
+  # == URL Helpers
+  #
+  # Allows access to Spree's routes in specs:
+  #
+  # visit spree.admin_path
+  # current_path.should eql(spree.products_path)
+  config.include Spree::TestingSupport::UrlHelpers
+
+  # == Mock Framework
+  #
+  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+  config.mock_with :rspec
+  config.color = true
+
+  # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
+  config.fixture_path = "#{::Rails.root}/spec/fixtures"
+
+  # Capybara javascript drivers require transactional fixtures set to false, and we use DatabaseCleaner
+  # to cleanup after each test instead.  Without transactional fixtures set to false the records created
+  # to setup a test will be unavailable to the browser, which runs under a seperate server instance.
+  config.use_transactional_fixtures = false
+
+  # Ensure Suite is set to use transactions for speed.
+  config.before :suite do
+    DatabaseCleaner.strategy = :transaction
+    DatabaseCleaner.clean_with :truncation
+  end
+
+  # Before each spec check if it is a Javascript test and switch between using database transactions or not where necessary.
+  config.before :each do
+    DatabaseCleaner.strategy = example.metadata[:js] ? :truncation : :transaction
+    DatabaseCleaner.start
+  end
+
+  # After each spec clean the database.
+  config.after :each do
+    DatabaseCleaner.clean
+  end
+
+  config.fail_fast = ENV['FAIL_FAST'] || false
+end

data/spree_favorite_products.gemspec

@@ -0,0 +1,21 @@
+# encoding: UTF-8
+Gem::Specification.new do |s|
+  s.platform    = Gem::Platform::RUBY
+  s.name        = 'spree_favorite_products'
+  s.version     = '1.0.0'
+  s.summary     = 'users can mark product as favorite'
+  s.description = 'This extension adds the following features: 1. Adds a link Mark as favorite on product detail page. 2. Favorite Products tab on header 3. Favorite Products tab in admin section'
+  s.required_ruby_version = '>= 1.9.3'
+
+  s.author    = 'Mohit Bansal'
+  s.email     = 'info@vinsol.com'
+  s.homepage  = 'http://vinsol.com'
+  s.license   = "MIT"
+
+  s.files       = `git ls-files`.split("\n")
+  #s.test_files  = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.require_path = 'lib'
+  s.requirements << 'none'
+
+  s.add_dependency 'spree_core', '~> 2.0.3'
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: spree_favorite_products
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Mohit Bansal
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: spree_core
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.3
+description: ! 'This extension adds the following features: 1. Adds a link Mark as
+  favorite on product detail page. 2. Favorite Products tab on header 3. Favorite
+  Products tab in admin section'
+email: info@vinsol.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- Versionfile
+- app/.DS_Store
+- app/assets/javascripts/admin/spree_favorite_products.js
+- app/assets/javascripts/store/spree_favorite_products.js
+- app/assets/stylesheets/admin/spree_favorite_products.css
+- app/assets/stylesheets/store/spree_favorite_products.css
+- app/controllers/spree/admin/favorite_products_controller.rb
+- app/controllers/spree/favorite_products_controller.rb
+- app/models/spree/favorite.rb
+- app/models/spree/product_decorator.rb
+- app/models/spree/user_decorator.rb
+- app/overrides/.DS_Store
+- app/overrides/add_favorite_products_tab.rb
+- app/overrides/add_link_to_mark_product_as_favorite.rb
+- app/overrides/add_link_to_users_favorite_products.rb
+- app/views/spree/.DS_Store
+- app/views/spree/admin/favorite_products/index.html.erb
+- app/views/spree/admin/favorite_products/users.html.erb
+- app/views/spree/favorite_products/create.js.erb
+- app/views/spree/favorite_products/destroy.js.erb
+- app/views/spree/favorite_products/index.html.erb
+- config/locales/en.yml
+- config/routes.rb
+- db/migrate/20130705080641_create_table_favorites.rb
+- db/migrate/20130710105100_rename_favorites_to_spree_favorites.rb
+- lib/generators/spree_favorite_products/install/install_generator.rb
+- lib/spree_favorite_products.rb
+- lib/spree_favorite_products/engine.rb
+- lib/spree_favorite_products/factories.rb
+- script/rails
+- spec/controllers/spree/admin/favorite_products_controller_spec.rb
+- spec/controllers/spree/favorite_products_controller_spec.rb
+- spec/models/spree/favorite_spec.rb
+- spec/models/spree/product_decorator_spec.rb
+- spec/models/spree/user_decorator_spec.rb
+- spec/spec_helper.rb
+- spree_favorite_products.gemspec
+homepage: http://vinsol.com
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- none
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: users can mark product as favorite
+test_files: []