spree_favorite_products 1.0.0 → 1.0.1

data/.rspec

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

data/.travis.yml

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

data/Gemfile

@@ -1,6 +1,15 @@
 source 'https://rubygems.org'
 
 # Provides basic authentication functionality for testing parts of your engine
-gem 'spree_auth_devise', github: 'spree/spree_auth_devise'
+gem 'spree', '2.0.3'
+gem 'rails', '3.2.15'
+gem 'spree_auth_devise', github: 'spree/spree_auth_devise', branch: '2-0-stable'
+gem 'mysql2'
 
+group :test do
+  gem 'rspec-rails', '~> 2.10'
+  gem 'shoulda-matchers', '2.2.0'
+  gem 'simplecov', :require => false
+  gem 'database_cleaner'
+end
 gemspec

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2013 [name of plugin creator]
+Copyright (c) 2014 Vinsol
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification,

data/README.md

@@ -1,4 +1,4 @@
-SpreeFavoriteProducts
+SpreeFavoriteProducts [![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)
 =====================
 
 This extension adds the following features:
@@ -40,4 +40,9 @@ Simply add this require statement to your spec_helper:
 require 'spree_favorite_products/factories'
 ```
 
-Copyright (c) 2013 [name of extension creator], released under the New BSD License
+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

data/Rakefile

@@ -11,5 +11,6 @@ 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/controllers/spree/favorite_products_controller.rb

@@ -1,10 +1,11 @@
 module Spree
   class FavoriteProductsController < Spree::StoreController
 
-    before_filter :authenticate_spree_user!, :only => [:index, :create, :destroy]
+    before_filter :authenticate_spree_user!
+    before_filter :find_favorite_product, :only => :destroy
 
     def index
-      @favorite_products = spree_current_user.favorite_products
+      @favorite_products = spree_current_user.favorite_products.page(params[:page]).per(Spree::Config.favorite_products_per_page)
     end
 
     def create
@@ -20,12 +21,14 @@ module Spree
     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
+      if @favorite
+        @success = @favorite.destroy
       end
     end
+
+    private
+      def find_favorite_product
+        @favorite = spree_current_user.favorites.joins(:product).where(:spree_products => {:id => params[:id]}).first
+      end
   end
 end

data/app/models/spree/app_configuration_decorator.rb

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

data/app/models/spree/user_decorator.rb

@@ -1,4 +1,8 @@
 Spree::User.class_eval do 
   has_many :favorites
   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_per_page_configuration.rb

@@ -0,0 +1,16 @@
+Deface::Override.new(
+  :virtual_path => 'spree/admin/general_settings/edit',
+  :name => 'add_favorite_products_per_page_configuration',
+  :insert_after => "#preferences .row",
+  :text => %Q{
+    <div class="row">
+      <fieldset class="no-border-bottom">
+        <legend align="center"><%= Spree.t(:favorite_products_settings) %></legend>
+        <div class="field">
+          <%= label_tag :favorite_products_per_page, Spree.t(:favorite_products_per_page) %><br>
+          <%= text_field_tag :favorite_products_per_page, Spree::Config[:favorite_products_per_page], :size => 3 %>
+        </div>
+      </fieldset>
+    </div>
+  }
+)

data/app/overrides/add_link_to_mark_product_as_favorite.rb

@@ -2,5 +2,11 @@ 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? %>"
+  :text => %Q{
+    <% 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' %>
+    <% else %>
+      <%= link_to Spree.t(:mark_as_favorite), favorite_products_path(:id => @product.id), :method => :post, :remote => spree_user_signed_in?, :class => 'favorite_link' %>
+    <% end %>
+  }
 )

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

@@ -1 +1,4 @@
+<% if @success %>
+  $('.favorite_link').attr('href', '<%= favorite_product_path(:id => params[:id]) %>').data('method', 'delete').text('<%= Spree.t(:unmark_as_favorite) %>')
+<% end %>
 alert("<%=j @message%>");

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

@@ -1,6 +1,11 @@
 <% if @success %>
-  $("#favorite_product_<%= @product_id%>").remove();
-  alert("Successfully removed favorite product from your list")
+  if($('.favorite_link').length) {
+    $('.favorite_link').attr('href', '<%= favorite_products_path(:id => @favorite.product_id) %>').data('method', 'post').text('<%= Spree.t(:mark_as_favorite) %>');
+    alert('Successfully unmarked as favorite');
+  } else {
+    $("#favorite_product_<%= @favorite.product_id%>").remove();
+    alert("Successfully removed favorite product from your list");
+  }
 <% else %>
-  alert("Could not remove product form your list")
+  alert("Could not remove product form your list");
 <% end %>

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

@@ -14,7 +14,7 @@
         <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 %>
+          <td class="favorite-product-remove"><%= link_to 'Remove', favorite_product_path(:id => product.id), :method => :delete, :remote => true %>
         </tr>
       <% end %>
       </tbody>
@@ -22,4 +22,6 @@
   <% else %>
     <p><%= Spree.t(:you_have_no_favorite_products_yet) %></p>
   <% end %>
+  
+  <%= paginate @favorite_products %>
 </div>

data/config/locales/en.yml

@@ -3,3 +3,8 @@
 
 en:
   hello: "Hello world"
+  spree:
+    favorite_products_settings: "Favorite Products Settings"
+    favorite_products_per_page: "Per Page"
+    mark_as_favorite: "Mark as favorite"
+    unmark_as_favorite: "Unmark as favorite"

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

@@ -5,8 +5,8 @@ module SpreeFavoriteProducts
       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"
+        append_file 'app/assets/javascripts/store/all.js', "\n//= require store/spree_favorite_products\n"
+        append_file 'app/assets/javascripts/admin/all.js', "\n//= require admin/spree_favorite_products\n"
       end
 
       def add_stylesheets

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

@@ -46,7 +46,9 @@ describe Spree::Admin::FavoriteProductsController do
 
   describe "#users" do
     before do
-      product.stub(:favorite_users).and_return([@user])
+      @users = [@user]
+      @users.stub(:page).and_return(@users)
+      product.stub(:favorite_users).and_return(@users)
       @products = [product]
       Spree::Product.stub(:where).with(:id => product.id).and_return(@products)
     end
@@ -60,7 +62,7 @@ describe Spree::Admin::FavoriteProductsController do
     end
 
     it 'fetches the users who marked the product as favorite' do
-      product.should_receive(:favorite_users).and_return([@user])
+      product.should_receive(:favorite_users).and_return(@users)
     end
 
     after do

data/spec/controllers/spree/favorite_products_controller_spec.rb

@@ -9,6 +9,18 @@ describe Spree::FavoriteProductsController do
     end
   end
 
+  shared_examples_for "request which finds favorite product" do
+    it "finds favorite product" do
+      @current_user_favorites.should_receive(:where).with(:spree_products => {:id => 'permalink'})
+      send_request
+    end
+
+    it "assigns @favorite" do
+      send_request
+      assigns(:favorite).should eq(@favorite)
+    end
+  end
+
   describe 'POST create' do
     def send_request
       post :create, :id => 1, :format => :js, :use_route => 'spree'
@@ -67,12 +79,15 @@ describe Spree::FavoriteProductsController do
 
   describe 'GET index' do
     def send_request
-      get :index, :use_route => 'spree'
+      get :index, :page => 'current_page', :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)
+      @favorite_products = double('favorite_products')
+      @favorite_products.stub(:page).and_return(@favorite_products)
+      @favorite_products.stub(:per).and_return(@favorite_products)
+      Spree::Config.stub(:favorite_products_per_page).and_return('favorite_products_per_page')
+      @user = mock_model(Spree::User, :favorite_products => @favorite_products, :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
@@ -89,93 +104,71 @@ describe Spree::FavoriteProductsController do
 
     it "assigns @favorite_products" do
       send_request
-      assigns(:favorite_products).should eq([@favorite_product])
+      assigns(:favorite_products).should eq(@favorite_products)
+    end
+
+    it "paginates favorite products" do
+      @favorite_products.should_receive(:page).with('current_page')
+      send_request
+    end
+
+    it "shows Spree::Config.favorite_products_per_page" do
+      @favorite_products.should_receive(:per).with('favorite_products_per_page')
+      send_request
     end
   end
 
   describe 'destroy' do
     def send_request(params = {})
-      post :destroy, params.merge({:use_route => 'spree', :method => :delete, :format => :js})
+      post :destroy, params.merge({:use_route => 'spree', :method => :delete, :format => :js, :id => 'permalink'})
     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)
+      @favorite = mock_model(Spree::Favorite)
+      @current_user_favorites = double('spree_favorites')
+      @current_user_favorites.stub(:where).and_return([@favorite])
+      @favorites = double('spree_favorites')
+      @favorites.stub(:joins).with(:product).and_return(@current_user_favorites)
+      @user = mock_model(Spree::User, :favorites => @favorites, :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"
+    it_behaves_like "request which finds favorite product"
 
-    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)
+    context 'when @favorite  exist' do
+      before(:each) do
+        controller.instance_variable_set(:@favorite, @favorite)
       end
 
-      it 'assigns favorite product object to favorite_product' do
-        send_request(:id => @product.permalink)
-        assigns(:favorite_product).should eq(@favorite_product)
+      it 'destroys' do
+        @favorite.should_receive(:destroy)
+        send_request
       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)
+      context 'when destroyed successfully' do
+        before(:each) do
+          @favorite.stub(:destroy).and_return(true)
         end
 
-        it 'assigns true to success' do
-          send_request(:id => @product.permalink)
-          assigns(:success).should be_true
-        end
+        it "sets @success to true" do
+          send_request
+          assigns(:success).should eq(true)
+        end 
       end
 
-      context 'and is not destroyed successfully' do
-        before do
-          @favorite_product.stub(:destroy).and_return(false)
+      context 'when not destroyed' do
+        before(:each) do
+          @favorite.stub(:destroy).and_return(false)
         end
 
-        it 'assigns false to success' do
-          send_request(:id => @product.permalink)
-          assigns(:success).should be_false
+        it 'sets @success to false' do
+          send_request
+          assigns(:success).should eq(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/app_configuration_decorator_spec.rb

@@ -0,0 +1,3 @@
+describe Spree::AppConfiguration do
+  it { Spree::Config.favorite_products_per_page.should eq 10 }
+end

data/spec/models/spree/product_decorator_spec.rb

@@ -6,10 +6,11 @@ describe Spree::Product do
 
   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
+      shipping_category = Spree::ShippingCategory.create! :name => 'shipping_category'
+      @favorite_product1 = Spree::Product.create! :name => 'favorite_product1', :price => 100, :shipping_category_id => shipping_category.id
+      @favorite_product2 = Spree::Product.create! :name => 'favorite_product2', :price => 100, :shipping_category_id => shipping_category.id
+      @product1 = Spree::Product.create! :name => 'product1', :price => 100, :shipping_category_id => shipping_category.id
+      @product2 = Spree::Product.create! :name => 'product2', :price => 100, :shipping_category_id => shipping_category.id
       @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

data/spec/models/spree/user_decorator_spec.rb

@@ -1,6 +1,28 @@
 require 'spec_helper'
 
 describe Spree::User do
+  
+  before(:each) do
+    @user = Spree::User.create! :email => 'test@example.com', :password => 'spree123'
+    @product1 = Spree::Product.create! :name => 'product1', :price => 100, :shipping_category_id => 1
+    @product2 = Spree::Product.create! :name => 'product2', :price => 100, :shipping_category_id => 1
+    favorite = Spree::Favorite.new
+    favorite.product_id = @product1.id
+    favorite.user_id = @user.id
+    favorite.save!
+  end
+
   it { should have_many(:favorites) }
   it { should have_many(:favorite_products).through(:favorites).class_name('Spree::Product') }
+
+
+  describe "has_favorite_product?" do
+    context "when product in user's favorite products" do
+      it { @user.has_favorite_product?(@product1.id).should be_true }
+    end
+
+    context 'when product is not in users favorite products' do
+      it { @user.has_favorite_product?(@product2.id).should be_false }
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -23,16 +23,16 @@ require 'ffaker'
 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/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'
+# require 'spree_favorite_products/factories'
 
 RSpec.configure do |config|
-  config.include FactoryGirl::Syntax::Methods
+  # config.include FactoryGirl::Syntax::Methods
 
   # == URL Helpers
   #

data/spree_favorite_products.gemspec

@@ -2,7 +2,7 @@
 Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.name        = 'spree_favorite_products'
-  s.version     = '1.0.0'
+  s.version     = '1.0.1'
   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'

metadata

@@ -1,40 +1,49 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: spree_favorite_products
-version: !ruby/object:Gem::Version
-  version: 1.0.0
+version: !ruby/object:Gem::Version 
+  hash: 21
   prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 1
+  version: 1.0.1
 platform: ruby
-authors:
+authors: 
 - Mohit Bansal
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-21 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2014-03-07 00:00:00 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
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 2
+        - 0
+        - 3
         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'
+  type: :runtime
+  version_requirements: *id001
+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:
+
+files: 
+- .rspec
+- .travis.yml
 - Gemfile
 - LICENSE
 - README.md
@@ -47,10 +56,12 @@ files:
 - 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/app_configuration_decorator.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_per_page_configuration.rb
 - 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
@@ -71,35 +82,46 @@ files:
 - script/rails
 - spec/controllers/spree/admin/favorite_products_controller_spec.rb
 - spec/controllers/spree/favorite_products_controller_spec.rb
+- spec/models/spree/app_configuration_decorator_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:
+licenses: 
 - MIT
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 53
+      segments: 
+      - 1
+      - 9
+      - 3
       version: 1.9.3
-required_rubygems_version: !ruby/object:Gem::Requirement
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-requirements:
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: 
 - none
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: users can mark product as favorite
 test_files: []
+