spree_promo 0.60.6 → 0.70.RC1

data/LICENSE

@@ -0,0 +1,26 @@
+Copyright (c) 2007-2010, Rails Dog LLC and other contributors
+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/app/assets/javascripts/admin/promotions.js

@@ -0,0 +1,131 @@
+
+var initProductRuleSourceField = function(){
+
+  $products_source_field = jQuery('.products_rule_products_source_field input');
+  $products_source_field.click(function() {
+    $rule_container = jQuery(this).parents('.promotion-rule');
+    if(this.checked){
+      if(this.value == 'manual'){
+        $rule_container.find('.products_rule_products').show();
+        $rule_container.find('.products_rule_product_group').hide();
+      } else {
+        $rule_container.find('.products_rule_products').hide();
+        $rule_container.find('.products_rule_product_group').show();
+      }
+    }
+  });
+  $products_source_field.each(function() {
+    $(this).triggerHandler('click');
+  });
+
+};
+
+var initProductActions = function(){
+
+  $('.calculator-fields').each(function(){
+    var $fields_container = $(this);
+    var $type_select = $fields_container.find('.type-select');
+    var $settings = $fields_container.find('.settings');
+    var $warning = $fields_container.find('.warning');
+    var originalType = $type_select.val();
+
+    $warning.hide();
+    $type_select.change(function(){
+      if( $(this).val() == originalType ){
+        $warning.hide();
+        $settings.show();
+        $settings.find('input').removeAttr('disabled');
+      } else {
+        $warning.show();
+        $settings.hide();
+        $settings.find('input').attr('disabled', 'disabled');
+      }
+    });
+  });
+
+
+  //
+  // CreateLineItems Promotion Action
+  //
+  ( function(){
+    // Autocomplete product and populate variant select
+    if($('.promotion_action.create_line_items ').is('*')){
+      $(".promotion_action.create_line_items input[name='add_product_name']").autocomplete("/admin/products.json?authenticity_token=" + $('meta[name=csrf-token]').attr("content"), {
+        parse: prep_autocomplete_data,
+        formatItem: function(item) {
+          return format_autocomplete(item);
+        }
+      }).result(function(event, data, formatted) {
+        if(data){
+          // $('#add_product_id').val(data.product.id);
+          var url = "/admin/products/" + data.product.permalink + "/variants.json?authenticity_token=" + $('meta[name=csrf-token]').attr("content");
+          var $variant_select = $("select[name='add_line_item_variant_id']");
+          $variant_select.html('');
+          $.getJSON(url, {}, function(variants_data){
+            $.each(variants_data, function(){
+              $variant_select.append($("<option />").val(this.id).text(this.label));
+            });
+          });
+        }
+      }
+      );
+    }
+
+    var hideOrShowItemTables = function(){
+      $('.promotion_action table').each(function(){
+        if($(this).find('td').length == 0){
+          $(this).hide();
+        } else {
+          $(this).show();
+        }
+      });
+    };
+    hideOrShowItemTables();
+
+    // Remove line item
+    var setupRemoveLineItems = function(){
+      $(".promotion_action.create_line_items table img").unbind('click').click(function(){
+        var $container = $(this).parents('.promotion_action');
+        var $hiddenField = $container.find("input[type='hidden']");
+        var $row = $(this).parents('tr');
+        var index = $row.parents('table').find('tr').index($row.get(0));
+        // Remove variant_id quantity pair from the string
+        var items = _($hiddenField.val().split(',')).compact();
+        items.splice(index - 1, 1);
+        $hiddenField.val(items.join(','));
+        $(this).parents('tr').remove();
+        hideOrShowItemTables();
+      });
+    };
+    setupRemoveLineItems();
+    // Add line item to list
+    $(".promotion_action.create_line_items button.add").click(function(){
+      var $container = $(this).parents('.promotion_action');
+      var product_name = $container.find("input[name='add_product_name']").val();
+      var variant_id = $container.find("select[name='add_line_item_variant_id']").val();
+      var variant_name = $container.find("select[name='add_line_item_variant_id'] option:selected").text();
+      var quantity = $container.find("input[name='add_quantity']").val();
+      if(variant_id){
+        // Add to the table
+        var newRow = "<tr><td>" + product_name + "</td><td>" + variant_name + "</td><td>" + quantity + "</td><td><img src='/admin/images/icons/cross.png' /></td></tr>";
+        $container.find('table').append(newRow);
+        // Add to serialized string in hidden text field
+        var $hiddenField = $container.find("input[type='hidden']");
+        $hiddenField.val($hiddenField.val() + "," + variant_id + "x" + quantity);
+        setupRemoveLineItems();
+        hideOrShowItemTables();
+      }
+      return false;
+    });
+
+  } )();
+
+}
+
+$(document).ready(function() {
+  initProductRuleSourceField();
+  initProductActions();
+});
+
+
+

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

@@ -0,0 +1,3 @@
+//= require admin/spree_core
+//= require admin/spree_auth
+//= require_tree .

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

@@ -0,0 +1,2 @@
+//= require store/spree_core
+//= require store/spree_auth

data/{public → app/assets}/stylesheets/admin/promotions.css

@@ -1,4 +1,4 @@
-.promotion-rule {
+.promotion_rule, .promotion_action {
   -moz-border-radius: 5px;
   -webkit-border-radius: 5px;
   padding: 8px 40px 8px 10px;
@@ -7,48 +7,38 @@
   margin-bottom: 4px;
   position: relative;
 }
-.promotion-rule .delete {
+.promotion_rule .delete, .promotion_action .delete {
   display: block;
   position: absolute;
   right: 10px;
   top: 10px;
 }
-
-
 .products_rule_products_source_field label {
   display: inline;
 }
-
-
-
 .edit_promotion #general_fields, .edit_promotion #expiry_fields {
-	float: left;
-	width: 46%;
+  float: left;
+  width: 46%;
 }
-
 .edit_promotion #general_fields {
-	margin-right: 10px;
+  margin-right: 10px;
 }
-
-.edit_promotion #expiry_fields {
-
-}
-
+.edit_promotion #expiry_fields {}
 .edit_promotion #starts_at_field, .edit_promotion #expires_at_field {
-	width: 200px;
-	float: left;
-	clear: none;
+  width: 200px;
+  float: left;
+  clear: none;
 }
 .edit_promotion #starts_at_field label, .edit_promotion #expires_at_field label{
-	display: block;
-}
-#rule_fields {
-	position: relative;
+  display: block;
 }
-#new_product_rule_form {
-	position: absolute;
-	text-align:right;
-	width: 300px;
-	right: 30px;
-	bottom: 20px;
+#rule_fields, #action_fields {
+  position: relative;
 }
+#new_product_rule_form, #new_promotion_action_form {
+  position: absolute;
+  text-align:right;
+  width: 300px;
+  right: 30px;
+  bottom: 20px;
+}

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

@@ -0,0 +1,5 @@
+/*
+ *= require admin/spree_core
+ *= require admin/spree_auth
+ *= require admin/promotions
+*/

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

@@ -0,0 +1,4 @@
+/*
+ *= require store/spree_core
+ *= require store/spree_auth
+*/

data/app/controllers/admin/promotion_actions_controller.rb

@@ -0,0 +1,28 @@
+class Admin::PromotionActionsController < Admin::BaseController
+  def create
+    @calculators = Promotion::Actions::CreateAdjustment.calculators
+    @promotion = Promotion.find(params[:promotion_id])
+    @promotion_action = params[:promotion_action][:type].constantize.new(params[:promotion_action])
+    @promotion_action.promotion = @promotion
+    if @promotion_action.save
+      flash[:notice] = I18n.t(:successfully_created, :resource => I18n.t(:promotion_action))
+    end
+    respond_to do |format|
+      format.html { redirect_to edit_admin_promotion_path(@promotion)}
+      format.js   { render :layout => false }
+    end
+  end
+
+  def destroy
+    @promotion = Promotion.find(params[:promotion_id])
+    @promotion_action = @promotion.promotion_actions.find(params[:id])
+    if @promotion_action.destroy
+      flash[:notice] = I18n.t(:successfully_removed, :resource => I18n.t(:promotion_action))
+    end
+    respond_to do |format|
+      format.html { redirect_to edit_admin_promotion_path(@promotion)}
+      format.js   { render :layout => false }
+    end
+  end
+end
+

data/app/controllers/admin/promotions_controller.rb

@@ -10,12 +10,12 @@ class Admin::PromotionsController < Admin::ResourceController
     end
     @promotion
   end
-  
+
   def location_after_save
     edit_admin_promotion_url(@promotion)
   end
 
   def load_data
-    @calculators = Promotion.calculators
+    @calculators = Promotion::Actions::CreateAdjustment.calculators
   end
 end

data/app/controllers/content_controller_decorator.rb

@@ -0,0 +1,8 @@
+# Keep a record ot all static page paths visited for promotions that require them
+ContentController.class_eval do
+  after_filter :store_visited_path
+  def store_visited_path
+    session[:visited_paths] ||= []
+    session[:visited_paths] = (session[:visited_paths]  + [params[:path]]).compact.uniq
+  end
+end

data/app/controllers/orders_controller_decorator.rb

@@ -1,10 +1,19 @@
 OrdersController.class_eval do
-  after_filter :clear_promotions
 
-  private
-  def clear_promotions
-    current_order.promotion_credits.destroy_all if current_order
+  def update
+    @order = current_order
+    if @order.update_attributes(params[:order])
+
+      if @order.coupon_code.present?
+        fire_event('spree.checkout.coupon_code_added', :coupon_code => @order.coupon_code)
+      end
+
+      @order.line_items = @order.line_items.select {|li| li.quantity > 0 }
+      fire_event('spree.order.contents_changed')
+      respond_with(@order) { |format| format.html { redirect_to cart_path } }
+    else
+      respond_with(@order)
+    end
   end
 
 end
-

data/app/models/adjustment_decorator.rb

@@ -0,0 +1,3 @@
+Adjustment.class_eval do
+  scope :promotion, lambda { where('label LIKE ?', "#{I18n.t(:promotion)}%") }
+end

data/app/models/order_decorator.rb

@@ -0,0 +1,24 @@
+Order.class_eval do
+
+  attr_accessible :coupon_code
+  attr_accessor :coupon_code
+
+  def promotion_credit_exists?(promotion)
+    !! adjustments.promotion.reload.detect { |credit| credit.originator.promotion.id == promotion.id }
+  end
+
+  def products
+    line_items.map {|li| li.variant.product}
+  end
+
+  unless self.instance_methods.include?("update_adjustments_with_promotion_limiting")
+    def update_adjustments_with_promotion_limiting
+      update_adjustments_without_promotion_limiting
+      return if adjustments.promotion.eligible.none?
+      most_valuable_adjustment = adjustments.promotion.eligible.max{|a,b| a.amount.abs <=> b.amount.abs}
+      ( adjustments.promotion.eligible - [most_valuable_adjustment] ).each{|adjustment| adjustment.update_attribute_without_callbacks(:eligible, false)}
+    end
+    alias_method_chain :update_adjustments, :promotion_limiting
+  end
+
+end

data/app/models/product_decorator.rb

@@ -0,0 +1,10 @@
+Product.class_eval do
+  has_and_belongs_to_many :promotion_rules
+
+  def possible_promotions
+    rules_with_matching_product_groups = product_groups.map(&:promotion_rules).flatten
+    all_rules = promotion_rules + rules_with_matching_product_groups
+    promotion_ids = all_rules.map(&:activator_id).uniq
+    Promotion.advertised.where(:id => promotion_ids)
+  end
+end

data/app/models/product_group_decorator.rb

@@ -0,0 +1,3 @@
+ProductGroup.class_eval do
+  has_many :promotion_rules
+end

data/app/models/promotion.rb

@@ -1,13 +1,37 @@
-class Promotion < ActiveRecord::Base
-  has_many  :promotion_credits,    :as => :source
-  calculated_adjustments
-  alias credits promotion_credits
+class Promotion < Activator
 
-  has_many :promotion_rules, :autosave => true
-  accepts_nested_attributes_for :promotion_rules
+
+  MATCH_POLICIES = %w(all any)
+
+  preference :usage_limit, :integer
+  preference :match_policy, :string, :default => MATCH_POLICIES.first
+  preference :code, :string
+  preference :advertise, :boolean, :default => false
+
+  [:usage_limit, :match_policy, :code, :advertise].each do |field|
+    alias_method field, "preferred_#{field}"
+    alias_method "#{field}=", "preferred_#{field}="
+  end
+  
+  has_many :promotion_rules, :foreign_key => 'activator_id', :autosave => true, :dependent => :destroy
   alias_method :rules, :promotion_rules
+  accepts_nested_attributes_for :promotion_rules
+
+  has_many :promotion_actions, :foreign_key => 'activator_id', :autosave => true, :dependent => :destroy
+  alias_method :actions, :promotion_actions
+  accepts_nested_attributes_for :promotion_actions
+
+  # TODO: This shouldn't be necessary with :autosave option but nested attribute updating of actions is broken without it
+  after_save :save_rules_and_actions
+  def save_rules_and_actions
+    (rules + actions).each &:save
+  end
+
 
   validates :name, :presence => true
+  validates :preferred_code, :presence => true, :if => lambda{|r| r.event_name == 'spree.ceckout.coupon_code_added' }
+
+  scope :advertised, includes(:stored_preferences).where(:preferences => {:name => 'advertise', :value => '1'})
 
   # TODO: Remove that after fix for https://rails.lighthouseapp.com/projects/8994/tickets/4329-has_many-through-association-does-not-link-models-on-association-save
   # is provided
@@ -17,52 +41,32 @@ class Promotion < ActiveRecord::Base
     end
   end
 
-  MATCH_POLICIES = %w(all any)
-
-  scope :automatic, where("code IS NULL OR code = ''")
-  scope :manual, where("code IS NOT NULL AND code <> ''")
-
-  def eligible?(order)
-    !expired? && rules_are_eligible?(order)
-  end
 
-  def expired?
-    starts_at && Time.now < starts_at ||
-    expires_at && Time.now > expires_at ||
-    usage_limit && credits_count >= usage_limit
+  def activate(payload)
+    if eligible?(payload[:order], payload)
+      actions.each do |action|
+        action.perform(payload)
+      end
+    end
   end
 
-  def credits_count
-    credits.with_order.count
+  def eligible?(order, options = {})
+    !expired? && rules_are_eligible?(order, options) && coupon_is_eligible?(order, options[:coupon_code])
   end
 
-  def rules_are_eligible?(order)
+  def rules_are_eligible?(order, options = {})
     return true if rules.none?
     if match_policy == 'all'
-      rules.all?{|r| r.eligible?(order)}
+      rules.all?{|r| r.eligible?(order, options)}
     else
-      rules.any?{|r| r.eligible?(order)}
-    end
-  end
-
-  def create_discount(order)
-    return if order.promotion_credit_exists?(self)
-    if eligible?(order) and amount = compute(order)
-      order.promotion_credits.reload.clear unless combine? and order.promotion_credits.all? { |credit| credit.source.combine? }
-      order.update!
-      PromotionCredit.create!({
-          :label => "#{I18n.t(:coupon)} (#{code})",
-          :source => self,
-          :amount => -amount.abs,
-          :order => order
-        })
+      rules.any?{|r| r.eligible?(order, options)}
     end
   end
 
-  def compute(order)
-    amount = calculator.compute(order)
-    amount = order.item_total if amount > order.item_total
-    -amount
+  def coupon_is_eligible?(order, code = nil)
+    return true if order && order.promotion_credit_exists?(self)
+    return true if event_name != 'spree.checkout.coupon_code_added'
+    code.to_s.strip.downcase == preferred_code.to_s.strip.downcase
   end
 
   # Products assigned to all product rules
@@ -70,4 +74,20 @@ class Promotion < ActiveRecord::Base
     @products ||= rules.of_type("Promotion::Rules::Product").map(&:products).flatten.uniq
   end
 
+  def expired?
+    super || usage_limit_exceeded?
+  end
+
+  def usage_limit_exceeded?
+    preferred_usage_limit.present? && preferred_usage_limit > 0 && credits_count >= preferred_usage_limit
+  end
+
+  def credits
+    Adjustment.where(:originator_id => actions.map(&:id))
+  end
+
+  def credits_count
+    credits.count
+  end
+
 end