spree_compare_products 0.40.90

data/.gitignore

@@ -0,0 +1,4 @@
+pkg/*
+public/stylesheets/sass/.sass-cache/*
+*.gem
+.bundle

data/Gemfile

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+source 'http://rubygems.org'
+
+# Specify your gem's dependencies in spree-compare_products.gemspec
+gemspec

data/README.markdown

@@ -0,0 +1,34 @@
+SPREE COMPARE PRODUCTS
+======================
+
+DESCRIPTION:
+------------
+
+Provides product comparison with other products within the same taxon.
+
+This is a fork of [spree-compare-products](https://github.com/calas/spree-compare-products) by Jorge Calás.
+
+REQUIREMENTS:
+-------------
+
+* {Spree}(https://github.com/railsdog/spree) (Version >= 0.50.99)
+
+FEATURES:
+---------
+
+* Allows the admin user to select which taxonomies are comparable.
+* Provides a bookmark-able URL.
+* Only allows products comparison in comparable taxonomies.
+* Only compares products in the same exact taxon.
+* Compares up to 4 products.
+* Redirects to the product's taxon page if only one product is provided.
+* If javascript is available:
+  * Disabling submit button when less than 2 products are selected.
+  * Submit to the correct URL (to avoid server-side redirection).
+
+TODOS:
+------
+
+* Add tests
+* Bring back all features provided by the original extension 
+* Don't rely on javascript

data/Rakefile

@@ -0,0 +1,3 @@
+require 'bundler'
+
+Bundler::GemHelper.install_tasks

data/app/controllers/compare_products_controller.rb

@@ -0,0 +1,60 @@
+class CompareProductsController < Spree::BaseController
+  
+  before_filter :find_taxon
+  before_filter :verify_comparable_taxon
+  before_filter :find_products
+  
+  helper :products, :taxons
+  
+  def show
+    @properties = @products.map(&:properties).flatten.uniq # We return the list of properties here so we can use them latter.
+  end
+  
+  private
+  
+  # Find the taxon from the url.
+  def find_taxon
+    permalink = ''
+    
+    if params[:taxon_path]
+      permalink = "#{params[:taxon_path]}/"
+    elsif params[:taxon]
+      permalink = "#{params[:taxon]}/"
+    end
+    
+    @taxon = Taxon.find_by_permalink(permalink) unless permalink.blank?
+    
+    if @taxon.nil?
+      flash[:error] = I18n.t('compare_products.invalid_taxon')
+      
+      redirect_to products_path
+    end
+  end
+  
+  # Verifies that the comparison can be made inside this taxon.
+  def verify_comparable_taxon
+    unless @taxon.is_comparable?
+      flash[:error] = I18n.t('compare_products.taxon_not_comparable')
+      
+      redirect_to "/t/#{@taxon.permalink}"
+    end
+  end
+  
+  # Find the products inside the taxon, manually adding product ids to
+  # the url will silently be ignored if they can't be compared inside
+  # the taxon or don't exists.
+  def find_products
+    product_ids = params[:product_ids].split('/')
+    
+    if product_ids.length > 4
+      flash[:notice] = I18n.t('compare_products.limit_is_4')
+      product_ids = product_ids[0..3]
+    elsif product_ids.length < 2
+      flash[:error] = I18n.t('compare_products.insufficient_data')
+      redirect_to "/t/#{@taxon.permalink}"
+    end
+    
+    @products = @taxon.products.find(:all, :conditions => { :id => product_ids}, :include => { :product_properties => :property }, :limit => 4)
+  end
+  
+end

data/app/helpers/compare_products_helper.rb

@@ -0,0 +1,44 @@
+module CompareProductsHelper
+  # Return the transposed matrix of the comparison table.
+  # 
+  # Example:
+  #   [
+  #     ["Product", "product1 image", "product2 image"],
+  #     ["Name",    "product1 name",  "product2 name"],
+  #     ...
+  #     ["Price",   "product1 price", "product2 price"]
+  #   ]
+  def comparison_rows_for(products, properties)
+    fields = [comparison_fields_for(products, properties)]
+    products.each do |product|
+      fields << (fields_for(product, properties))
+    end
+    fields.transpose
+  end
+  
+  # Return an array with the values of the fields to be compared for
+  # the specified product.
+  # 
+  # Example:
+  #   ["product1 image", "product1 name", ..., "product1 price"]
+  def fields_for(product, properties)
+    [ link_to(small_image(product), product), link_to(product.name, product)].tap { |fields|
+      properties.each do |property|
+        fields << product.product_properties.find_by_property_id(property.id).try(:value)
+      end
+    }.tap { |fields| fields << number_to_currency(product.price) }
+  end
+  
+  # Returns an array with the translated names of the fields to be
+  # compared.
+  # 
+  # Example:
+  #   ["Product", "Name", ..., "Price"]
+  def comparison_fields_for(products, properties)
+    [t('product'), t('name')].tap { |fields|
+      properties.each { |property| fields << property.presentation }
+    }.tap { |fields|
+      fields << t('price')
+    }
+  end
+end

data/app/metal/bookmarkable_comparison.rb

@@ -0,0 +1,15 @@
+class BookmarkableComparison
+  
+  def self.call(env)
+    req = Rack::Request.new(env)
+    
+    if req.path_info =~ /^\/compare_products/
+      products = (req.params['product_id'] || []).join('/')
+      url = "/t/#{req.params['taxon']}/compare/#{products}"
+      return [303, {"Location" => url}, []]
+    end
+    
+    [ 404, { 'Content-Type' => 'text/html' }, [ 'Not Found' ] ]
+  end
+  
+end

data/app/views/admin/taxonomies/_comparable_field.html.erb

@@ -0,0 +1,4 @@
+<% field_container :taxonomy, :comparable do %>
+  <%= check_box :taxonomy, :comparable  %>
+  <%= label :taxonomy, :comparable, t('compare_products.comparable_container') %>
+<% end %>

data/app/views/admin/taxonomies/_list.html.erb

@@ -0,0 +1,17 @@
+<table class="index">
+  <tr>
+    <th><%= t('name') %></th>
+    <th><%= t('compare_products.comparable_container') %></th>
+    <th></th>
+  </tr>
+  
+  <% for taxonomy in @taxonomies %>
+    <tr id="<%= dom_id taxonomy %>">
+      <td><%= taxonomy.name %></td>
+      <td><%= icon('tick') if taxonomy.comparable? %></td>
+      <td class="actions">
+        <%= link_to_edit taxonomy.id %> &nbsp; <%= link_to_delete taxonomy %>
+      </td>
+    </tr>
+  <% end %>
+</table>

data/app/views/compare_products/show.html.erb

@@ -0,0 +1,25 @@
+<% content_for :head do %>
+  <%= stylesheet_link_tag 'compiled/compare_products' %>
+<% end %>
+
+<% content_for :sidebar do %>
+  <%= render :partial => 'shared/taxonomies' %>
+<% end %>
+
+<h1>
+  <%= t('compare_products.product_comparison') %>
+</h1>
+
+<table>
+  <% comparison_rows_for(@products, @properties).each do |row| %>
+    <tr>
+      <th><%= row.shift -%></th>
+      
+      <% row.each do |field| %>
+        <td><%= field || raw('&mdash;') %></td>
+      <% end %>
+    </tr>
+  <% end %>
+</table>
+
+<%= link_to t('continue_shopping'), seo_url(@taxon), :class => 'continue button' %>

data/app/views/shared/_compare_product_field.html.erb

@@ -0,0 +1,5 @@
+<% if @comparable %>
+<span class="comparable">
+  <%= check_box_tag('product_id[]', product.id, false, :id => "compare_product_#{product.id}", :class => 'compare') %>
+</span>
+<% end %>

data/app/views/taxons/_comparable_taxon.html.erb

@@ -0,0 +1,12 @@
+<% content_for :head do %>
+  <%= javascript_include_tag 'product_comparison' %>
+  
+  <%= stylesheet_link_tag 'compiled/compare_products' %>
+<% end %>
+
+<% form_tag(compare_products_path, :method => :get) do %>
+  <%= hidden_field_tag('taxon_permalink', params[:id]) %>
+  <% @comparable = true %>
+  <%= render 'shared/products.html.erb', :products => @products, :taxon => @taxon %>
+  <%= submit_tag t('compare_products.compare'), :id => 'compare', :class => 'button' %>
+<% end %>

data/app/views/taxons/_taxon_products.html.erb

@@ -0,0 +1,5 @@
+<% if @taxon && @taxon.taxonomy.comparable? && @products.length > 1 %>
+  <%= render('taxons/comparable_taxon') %>
+<% else %>
+  <%= render('shared/products.html.erb', :products => @products, :taxon => @taxon) %>
+<% end %>

data/config/locales/en-US.yml

@@ -0,0 +1,10 @@
+en:
+  compare_products:
+    comparable_container: Enable product comparison
+    compare: Compare
+    compare_selected: Compare selected products
+    insufficient_data: Insufficient data. You need to select at least 2 products.
+    invalid_taxon: Invalid taxon
+    limit_is_4: You can only compare up to 4 products.
+    product_comparison: Product comparison
+    taxon_not_comparable: "Products inside this taxon can't be compared"

data/config/locales/es.yml

@@ -0,0 +1,10 @@
+es:
+  compare_products:
+    comparable_container: Habilitar comparación de productos
+    compare: Comparar
+    compare_selected: Comparar los productos seleccionados
+    limit_is_4: Solo puedes comparar hasta 4 productos.
+    insufficient_data: Datos insuficientes. Debe seleccionar al menos 2 products.
+    invalid_taxon: Taxón no válido
+    product_comparison: Comparación de productos
+    taxon_not_comparable: No se pueden comparar products dentro de este taxón.

data/config/locales/pl.yml

@@ -0,0 +1,11 @@
+--- 
+pl: 
+  compare_products: 
+    comparable_container: "Włącz porównywanie produktów"
+    compare: Porównaj
+    compare_selected: "Porównaj zaznaczone produkty"
+    insufficient_data: "Brak wystarczających danych. Zaznacz co najmniej 2 produkty."
+    invalid_taxon: "Niepoprawna kategoria"
+    limit_is_4: "Możesz porównać maksymalnie 4 produkty."
+    product_comparison: "Porównanie produktów."
+    taxon_not_comparable: "Produty w tej kategorii nie mogą zostać porównane"

data/config/locales/ru.yml

@@ -0,0 +1,10 @@
+ru:
+  compare_products:
+    comparable_container: "разрешить сравнение товаров"
+    compare: "Сравнить"
+    compare_selected: "Сравнить выбранные товары"
+    insufficient_data: "Недостаточно данных, нужно выбрать хотя бы 2 товара."
+    invalid_taxon: "Нельзя сравнивать товары из разных категорий"
+    limit_is_4: "Вы можете сравнить не более четырёх товаров одновременно."
+    product_comparison: "Сравнение товаров"
+    taxon_not_comparable: "Товары данной категории не могут быть сравнены."

data/config/routes.rb

@@ -0,0 +1,4 @@
+Rails.application.routes.draw do
+  match '/t/compare_products' => 'compare_products#show', :as => 'compare_products'
+  match '/t/*taxon_path/compare/*product_ids' => 'compare_products#show'
+end

data/lib/spree_compare_products/comparable_container.rb

@@ -0,0 +1,12 @@
+module SpreeCompareProducts
+  module ComparableContainer
+    def self.included(base)
+      base.class_eval do
+        preference :enable_product_comparison, :boolean, :default => false
+        alias_method :comparable, :prefers_enable_product_comparison?
+        alias_method :comparable?, :prefers_enable_product_comparison?
+        alias_method :comparable=, :prefers_enable_product_comparison=
+      end
+    end
+  end
+end

data/lib/spree_compare_products/version.rb

@@ -0,0 +1,3 @@
+module SpreeCompareProducts
+  VERSION = '0.40.90'
+end

data/lib/spree_compare_products.rb

@@ -0,0 +1,30 @@
+require 'spree_core'
+require 'spree_compare_products_hooks'
+require 'spree_compare_products/comparable_container'
+
+module SpreeCompareProducts
+  class Engine < Rails::Engine
+    
+    config.autoload_paths += %W(#{config.root}/lib)
+    
+    def self.activate
+      Dir.glob(File.join(File.dirname(__FILE__), '../app/**/*_decorator*.rb')) do |c|
+        Rails.env.production? ? require(c) : load(c)
+      end
+      
+      Taxonomy.class_eval do
+        include SpreeCompareProducts::ComparableContainer
+      end
+      
+      Taxon.class_eval do
+        include SpreeCompareProducts::ComparableContainer
+        
+        def is_comparable?
+          comparable? || taxonomy.comparable?
+        end
+      end
+    end
+    
+    config.to_prepare &method(:activate).to_proc
+  end
+end

data/lib/spree_compare_products_hooks.rb

@@ -0,0 +1,9 @@
+class SpreeCompareProductsHooks < Spree::ThemeSupport::HookListener
+  
+  insert_after :admin_inside_taxonomy_form, 'admin/taxonomies/comparable_field'
+  
+  replace :taxon_products, 'taxons/taxon_products'
+  
+  insert_after :products_list_item, 'shared/compare_product_field'
+  
+end

data/lib/tasks/install.rake

@@ -0,0 +1,25 @@
+namespace :spree_compare_products do
+  desc 'Copies all migrations and assets (NOTE: This will be obsolete with Rails 3.1)'
+  task :install do
+    Rake::Task['spree_compare_products:install:migrations'].invoke
+    Rake::Task['spree_compare_products:install:assets'].invoke
+  end
+  
+  namespace :install do
+    desc 'Copies all migrations (NOTE: This will be obsolete with Rails 3.1)'
+    task :migrations do
+      source = File.join(File.dirname(__FILE__), '..', '..', 'db')
+      destination = File.join(Rails.root, 'db')
+      Spree::FileUtilz.mirror_files(source, destination)
+    end
+    
+    desc 'Copies all assets (NOTE: This will be obsolete with Rails 3.1)'
+    task :assets do
+      source = File.join(File.dirname(__FILE__), '..', '..', 'public')
+      destination = File.join(Rails.root, 'public')
+      puts "INFO: Mirroring assets from #{source} to #{destination}"
+      Spree::FileUtilz.mirror_files(source, destination)
+    end
+  end
+
+end

data/lib/tasks/spree_compare_products.rake

@@ -0,0 +1 @@
+# Add custom rake tasks here

data/public/javascripts/product_comparison.js

@@ -0,0 +1,104 @@
+// ######################
+// # PRODUCT COMPARISON #
+// ######################
+
+// @param params <Object> : {
+//   target <String> : the target object
+// }
+
+var ProductComparison = function(params) {
+  // ################
+  // # DEPENDENCIES #
+  // ################
+  
+  if (typeof jQuery == 'undefined') {
+    throw new Error('InquiryAsk requires \'jQuery\'.');
+  }
+  
+  // #############
+  // # PARAMETER #
+  // #############
+  
+  // if (params.target == undefined) {
+  //   throw new Error('ProductComparison constructor requires a \'target\'.');
+  // }
+  
+  // ######################
+  // # PRIVATE ATTRIBUTES #
+  // ######################
+  
+  var self = this;
+  
+  // ######################
+  // # PRIVILEGED METHODS #
+  // ######################
+  
+  /* 
+   * @privileged
+   * 
+   * init
+   * 
+   * Initialize product comparison
+   */
+  this.init = function() {
+    _init();
+  }
+  
+  // ###################
+  // # PRIVATE METHODS #
+  // ###################
+  
+  /* 
+   * @private
+   * 
+   * _init
+   * 
+   * Initialize product comparison
+   */
+  function _init() {
+    _setForm();
+    $('input.compare:checkbox').click(_setForm);
+    $('form[action*="/t/compare_products"]').submit(_onFormSubmit);
+  }
+  
+  /* 
+   * @private
+   * 
+   * _setForm
+   */
+  function _setForm() {
+    var checkedProducts = $('input.compare:checkbox:checked').length; // Get number of checked products
+    
+    _disableIf('form[action*="/t/compare_products"] :submit', (checkedProducts < 2)); // Disable form if less than 2 products are checked
+  }
+  
+  /* 
+   * @private
+   * 
+   * _onFormSubmit
+   */
+  function _onFormSubmit() {
+    var taxon_permalink = $('input#taxon_permalink:hidden').val();
+    var product_ids = $.map($('input.compare:checkbox:checked'), function(n) { return n.value; }).join('/');
+    
+    window.location = '/t/' + taxon_permalink + '/compare/' + product_ids;
+    
+    return false;
+  };
+  
+  /* 
+   * @private
+   * 
+   * _disableIf
+   */
+  function _disableIf(query, value) {
+    $(query).attr('disabled', value);
+  }
+  
+  _init(); // Initialize product comparison
+}
+
+
+$(document).ready(function() {
+  var productComparison = new ProductComparison();
+});

data/public/stylesheets/compiled/compare_products.css

@@ -0,0 +1,8 @@
+table th {
+  background: #dddddd;
+  padding: 10px;
+  text-align: right;
+  border: 1px solid #dddddd; }
+table td {
+  border: 1px solid #dddddd;
+  text-align: center; }

data/public/stylesheets/sass/compare_products.sass

@@ -0,0 +1,9 @@
+table
+  th
+    :background #DDD
+    :padding 10px
+    :text-align right
+    :border 1px solid #DDD
+  td
+    :border 1px solid #DDD
+    :text-align center

data/spec/spec_helper.rb

@@ -0,0 +1,32 @@
+# This file is copied to ~/spec when you run 'ruby script/generate rspec'
+# from the project root directory.
+ENV['RAILS_ENV'] ||= 'test'
+
+require File.expand_path('../../../config/environment', __FILE__)
+require 'rspec/rails'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  # == 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.fixture_path = "#{::Rails.root}/spec/fixtures"
+  
+  # config.include Devise::TestHelpers, :type => :controller
+  
+  # If you're not using ActiveRecord, or you'd prefer not to run each of your
+  # examples within a transaction, comment the following line or assign false
+  # instead of true.
+  config.use_transactional_fixtures = true
+end
+
+@configuration ||= AppConfiguration.find_or_create_by_name('Default configuration')

data/spree_compare_products.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'spree_compare_products/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'spree_compare_products'
+  s.version     = SpreeCompareProducts::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = [ 'Jorge Calás', 'Maik Kempe' ]
+  s.email       = [ 'calas@qvitta.net', 'dev@breaking-limits.com' ]
+  s.homepage    = 'https://github.com/mkempe/spree_compare_products'
+  s.summary     = %q{Provides product comparison with other products within the same taxon.}
+  # s.description = %q{}
+  
+  s.rubyforge_project = 'spree_compare_products'
+  
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = [ 'lib' ]
+  s.requirements  << 'none'
+  
+  s.required_ruby_version = '>= 1.8.7'
+  
+  s.add_dependency('spree_core', '>= 0.40.99')
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification 
+name: spree_compare_products
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 40
+  - 90
+  version: 0.40.90
+platform: ruby
+authors: 
+- "Jorge Cal\xC3\xA1s"
+- Maik Kempe
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-20 00:00:00 +03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: spree_core
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 40
+        - 99
+        version: 0.40.99
+  type: :runtime
+  version_requirements: *id001
+description: 
+email: 
+- calas@qvitta.net
+- dev@breaking-limits.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.markdown
+- Rakefile
+- app/controllers/compare_products_controller.rb
+- app/helpers/compare_products_helper.rb
+- app/metal/bookmarkable_comparison.rb
+- app/views/admin/taxonomies/_comparable_field.html.erb
+- app/views/admin/taxonomies/_list.html.erb
+- app/views/compare_products/show.html.erb
+- app/views/shared/_compare_product_field.html.erb
+- app/views/taxons/_comparable_taxon.html.erb
+- app/views/taxons/_taxon_products.html.erb
+- config/locales/en-US.yml
+- config/locales/es.yml
+- config/locales/pl.yml
+- config/locales/ru.yml
+- config/routes.rb
+- lib/spree_compare_products.rb
+- lib/spree_compare_products/comparable_container.rb
+- lib/spree_compare_products/version.rb
+- lib/spree_compare_products_hooks.rb
+- lib/tasks/install.rake
+- lib/tasks/spree_compare_products.rake
+- public/javascripts/product_comparison.js
+- public/stylesheets/compiled/compare_products.css
+- public/stylesheets/sass/compare_products.sass
+- spec/spec_helper.rb
+- spree_compare_products.gemspec
+has_rdoc: true
+homepage: https://github.com/mkempe/spree_compare_products
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 8
+      - 7
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: 
+- none
+rubyforge_project: spree_compare_products
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Provides product comparison with other products within the same taxon.
+test_files: []
+