spree_active_sale 1.0.6 → 1.3.0

data/app/controllers/spree/store_controller_decorator.rb

@@ -0,0 +1,11 @@
+module Spree
+  StoreController.class_eval do
+
+    # Check if all products in cart are still live.
+    # Also, delete line item if any of the products from cart is expired.
+    def check_active_products_in_order
+      current_order.delete_inactive_items unless current_order.nil?
+    end
+
+  end
+end

data/app/controllers/{taxons_controller_decorator.rb → spree/taxons_controller_decorator.rb}

@@ -5,7 +5,7 @@ module Spree
       @taxon = Spree::Taxon.find_by_permalink!(params[:id])
       return unless @taxon
 
-      if Spree::ActiveSale::Event.is_live? @taxon
+      if @taxon.live?
         @searcher = Spree::Config.searcher_class.new(params.merge(:taxon => @taxon.id))
         @products = @searcher.retrieve_products
 

data/app/helpers/spree/active_sale_events_helper.rb

@@ -0,0 +1,46 @@
+module Spree
+  module ActiveSaleEventsHelper
+    
+    def sale_event_timer(event = nil, layout = nil)
+      return I18n.t('spree.active_sale.event.can_not_be_nil') if (event == nil) || (event.class.name != "Spree::ActiveSaleEvent")
+      layout ||= '{dn} DAYS {hnn}{sep}{mnn}{sep}{snn}'
+      content_tag(:span, I18n.t('spree.active_sale.event.ending_message'), :class => 'sale_event_message') + " " + content_tag(:span, event.end_date.strftime('%Y-%m-%dT%H:%M:%S'), "data-timer" => event.end_date.strftime('%Y-%m-%dT%H:%M:%S'), "data-layout" => layout, :class => 'sale_event_message')
+    end
+
+    def method_missing(method_name, *args, &block)
+      if image_style = image_style_from_method_name_for_sale(method_name)
+        define_sale_image_method(image_style)
+        self.send(method_name, *args)
+      else
+        super
+      end
+    end
+
+    def sale_image_available?(sale_event)
+      !sale_event.sale_images.empty? || sale_event.eventable_image_available?
+    end
+
+    private
+
+    # Returns style of image or nil
+    def image_style_from_method_name_for_sale(method_name)
+      if style = method_name.to_s.sub(/_event_image$/, '')
+        possible_styles = Spree::SaleImage.attachment_definitions[:attachment][:styles]
+        style if style.in? possible_styles.with_indifferent_access
+      end
+    end
+
+    def define_sale_image_method(style)
+      self.class.send :define_method, "#{style}_event_image" do |sale_event, *options|
+        options = options.first || {}
+        if sale_event.sale_images.empty?
+          image_tag "noimage/#{style}.png", options
+        else
+          image = sale_event.sale_images.first
+          options.reverse_merge! :alt => image.alt.blank? ? sale_event.name : image.alt
+          image_tag image.attachment.url(style), options
+        end
+      end
+    end
+  end
+end

data/app/helpers/spree/active_sales_helper.rb

@@ -0,0 +1,4 @@
+module Spree
+  module ActiveSalesHelper
+  end
+end

data/app/models/spree/active_sale.rb

@@ -3,14 +3,20 @@
 # For example: 'January 2013' sale, which can have many sale events in it.
 #
 module Spree
-  class ActiveSale < ActiveRecord::Base
-    has_many :events, :class_name => "Spree::ActiveSale::Event"
-    belongs_to :taxon, :class_name => "Spree::Taxon"
-
-    attr_accessible :name
+  class ActiveSale < Spree::SaleEvent
+    acts_as_nested_set :dependent => :destroy
+    has_many :active_sale_events
 
     validates :name, :presence => true
 
-    accepts_nested_attributes_for :events, :allow_destroy => true, :reject_if => lambda { |attrs| attrs.all? { |k, v| v.blank? } }
+    accepts_nested_attributes_for :active_sale_events, :allow_destroy => true, :reject_if => lambda { |attrs| attrs.all? { |k, v| v.blank? } }
+
+    def self.config(&block)
+      yield(Spree::ActiveSaleConfig)
+    end
+
+    def children_and_active_sale_events
+      ((self.descendants.map{ |child_sale| child_sale.children_and_active_sale_events } << self) + self.active_sale_events).flatten.reject(&:blank?)
+    end
   end
 end

data/app/models/spree/active_sale_configuration.rb

@@ -0,0 +1,13 @@
+# More on Spree's preference configuration - http://guides.spreecommerce.com/preferences.html#site_wide_preferences
+module Spree
+  class ActiveSaleConfiguration < Preferences::Configuration
+    preference :paginate_sale_events_for_admin?, :boolean, :default => false
+    preference :paginate_sales_for_admin?, :boolean, :default => false
+    preference :paginate_sale_events_for_user?, :boolean, :default => false
+    preference :paginate_sales_for_user?, :boolean, :default => false
+    preference :admin_active_sales_per_page, :integer, :default => 25
+    preference :active_sales_per_page, :integer, :default => 25
+    preference :admin_active_sale_events_per_page, :integer, :default => 25
+    preference :active_sale_events_per_page, :integer, :default => 25
+  end
+end

data/app/models/spree/active_sale_event.rb

@@ -0,0 +1,58 @@
+# EVENTS
+# Events represent an entity for active sale in a flash sale/ daily deal.
+# There can be many events for one sale.
+#
+module Spree
+  class ActiveSaleEvent < Spree::SaleEvent
+    before_validation :update_permalink
+    after_save :update_parent_active_sales
+
+    has_many :sale_images, :as => :viewable, :dependent => :destroy, :order => 'position ASC'
+    belongs_to :eventable, :polymorphic => true
+    belongs_to :active_sale
+
+    attr_accessible :description, :end_date, :eventable_id, :eventable_type, :is_active, :is_hidden, :is_permanent, :name, :permalink, :active_sale_id, :start_date, :eventable_name, :discount
+
+    validates :name, :permalink, :eventable_id, :start_date, :end_date, :active_sale_id, :presence => true
+    validates :eventable_type, :presence => true, :uniqueness => { :scope => :eventable_id, :message => I18n.t('spree.active_sale.event.validation.errors.live_event') }, :if => :live?
+    validate  :validate_start_and_end_date
+
+    # Spree::ActiveSaleEvent.is_live? method 
+    # should only/ always represents live and active events and not just live events.
+    def is_live? object
+      object_class_name = object.class.name
+      return object.live_and_active? if object_class_name == self.name
+      %w(Spree::Product Spree::Variant Spree::Taxon).include?(object_class_name) ? object.live? : false
+    end
+
+    def update_permalink
+      prefix = {"Spree::Taxon" => "t", "Spree::Product" => "products"}
+      self.permalink = [prefix[self.eventable_type], self.eventable.permalink].join("/") unless self.eventable.nil?
+    end
+
+    # This callback basically makes sure that parents for an event lives longer.
+    # Or at least parents live for the time when event is live.
+    def update_parent_active_sales
+      active_sale_events = self.active_sale.children_and_active_sale_events
+      parents = self.active_sale.self_and_ancestors.flatten
+      oldest_start_date = active_sale_events.map(&:start_date).reject(&:blank?).sort.first
+      latest_end_date = active_sale_events.map(&:end_date).reject(&:blank?).sort.last
+      parents.each{ |parent| 
+        parent.update_attributes(:start_date => oldest_start_date) if parent.start_date.nil? ? true : (parent.start_date > oldest_start_date) 
+        parent.update_attributes(:end_date => latest_end_date) if parent.end_date.nil? ? true : (parent.end_date < latest_end_date)
+      }
+    end
+
+    def eventable_name
+      eventable.try(:name)
+    end
+
+    def eventable_name=(name)
+      self.eventable = self.eventable_type.constantize.find_by_name(name) if name.present?
+    end
+
+    def eventable_image_available?
+      !!eventable.try(:image_available?)
+    end
+  end
+end

data/app/models/spree/line_item_decorator.rb

@@ -0,0 +1,6 @@
+Spree::LineItem.class_eval do
+
+  def live?
+    self.product.live?
+  end
+end

data/app/models/spree/order_decorator.rb

@@ -0,0 +1,6 @@
+Spree::Order.class_eval do
+
+  def delete_inactive_items
+    self.line_items.each{ |line_item| line_item.destroy unless line_item.live? }
+  end
+end

data/app/models/spree/product_decorator.rb

@@ -1,11 +1,22 @@
 Spree::Product.class_eval do
-  has_many :active_sale_events, :as => :eventable, :class_name => "Spree::ActiveSale::Event"
+  has_many :active_sale_events, :as => :eventable
 
+  # Find live and active taxons for a product.
   def find_live_taxons
-    Spree::ActiveSale::Event.live_active.where(:eventable_type => "Spree::Taxon", :eventable_id => self.taxons.map(&:id))
+    Spree::ActiveSaleEvent.live_active.where(:eventable_type => "Spree::Taxon", :eventable_id => self.taxons.map(&:id))
   end
 
+  # if there is at least one active sale event which is live and active.
   def live?
-    !self.active_sale_events.detect{ |event| (event.live_and_active?) }.nil? || !self.find_live_taxons.blank?
+    !self.active_sale_events.detect{ |event| event.live_and_active? }.nil? || !self.find_live_taxons.blank?
+  end
+
+  # Check if image is available for this.
+  def image_available?
+    !images.blank?
+  end
+
+  def image
+    images.first
   end
 end

data/app/models/spree/sale_event.rb

@@ -0,0 +1,86 @@
+# encoding: utf-8
+# Sale Event
+# Sale Event represents active sale and active sale event by using STI.
+# There can be many events for one sale.
+#
+module Spree
+  class SaleEvent < ActiveRecord::Base
+    attr_accessible :description, :end_date, :eventable_id, :eventable_type, :is_active, :is_hidden, :is_permanent, :name, :permalink, :active_sale_id, :start_date, :eventable_name, :type, :parent_id, :position
+
+    scope :live, lambda { where("(start_date <= :start_date AND end_date >= :end_date) OR is_permanent = :is_permanent", { :start_date => zone_time, :end_date => zone_time, :is_permanent => true }) }
+    scope :active, lambda { |*args| where(:is_active => valid_argument(args)) }
+    scope :hidden, lambda { |*args| where(:is_hidden => valid_argument(args)) }
+    scope :live_active, lambda { |*args| self.live.active(valid_argument(args)) }
+    scope :live_active_and_hidden, lambda { |*args| 
+                            args = [{}] if [nil, true, false].include? args.first
+                            self.live.active(valid_argument([args.first[:active]])).hidden(valid_argument([args.first[:hidden]])) 
+                          }
+    scope :upcoming_events, lambda { where("start_date > :start_date", { :start_date => zone_time }) }
+    scope :past_events, lambda { where("end_date < :end_date", { :end_date => zone_time }) }
+    scope :starting_today, lambda { where(:start_date => zone_time..zone_time.end_of_day) }
+    scope :ending_today, lambda { where(:end_date => zone_time..zone_time.end_of_day) }
+
+
+    def validate_start_and_end_date
+      errors.add(:start_date, I18n.t('spree.active_sale.event.validation.errors.invalid_dates')) if invalid_dates?
+    end
+
+    def live?(moment=nil)
+      moment ||= object_zone_time
+      (self.start_date <= moment and self.end_date >= moment) or self.is_permanent? if start_and_dates_available?
+    end
+
+    def upcoming?
+      current_time = object_zone_time
+      (self.start_date >= current_time and self.end_date > self.start_date) if start_and_dates_available?
+    end
+
+    def past?
+      current_time = object_zone_time
+      (self.start_date < current_time and self.end_date > self.start_date and self.end_date < current_time) if start_and_dates_available?
+    end
+
+    def live_and_active?(moment=nil)
+      self.live?(moment) and self.is_active?
+    end
+
+    def start_and_dates_available?
+      self.start_date and self.end_date
+    end
+
+    def invalid_dates?
+      self.start_and_dates_available? and (self.start_date >= self.end_date)
+    end
+
+    class << self
+      # Class methods
+      def paginate(objects_per_page, options = {})
+        options = prepare_pagination(objects_per_page, options)
+        self.page(options[:page]).per(options[:per_page])
+      end
+
+      private
+        def valid_argument args
+          (args.first == nil || args.first == true)
+        end
+
+        def prepare_pagination(objects_per_page, options)
+          per_page = options[:per_page].to_i
+          options[:per_page] = per_page > 0 ? per_page : Spree::ActiveSaleConfig[objects_per_page]
+          page = options[:page].to_i
+          options[:page] = page > 0 ? page : 1
+          options
+        end
+
+        def zone_time
+          Time.zone.now
+        end
+    end
+
+    private
+      
+      def object_zone_time
+        Time.zone.now
+      end
+  end
+end

data/app/models/spree/sale_image.rb

@@ -0,0 +1,51 @@
+module Spree
+  class SaleImage < Asset
+    validates_attachment_presence :attachment
+    validate :no_attachment_errors
+
+    attr_accessible :alt, :attachment, :position, :viewable_type, :viewable_id
+
+    has_attached_file :attachment,
+                      :styles => { :mini => '48x48>', :small => '100x100>', :sale => '240x240>', :large => '600x600>' },
+                      :default_style => :sale,
+                      :url => '/spree/sales/:id/:style/:basename.:extension',
+                      :path => ':rails_root/public/spree/sales/:id/:style/:basename.:extension',
+                      :convert_options => { :all => '-strip' }
+    # save the w,h of the original image (from which others can be calculated)
+    # we need to look at the write-queue for images which have not been saved yet
+    after_post_process :find_dimensions
+
+    include Spree::Core::S3Support
+    supports_s3 :attachment
+
+    Spree::Image.attachment_definitions[:attachment][:styles] = ActiveSupport::JSON.decode(Spree::Config[:attachment_styles])
+    Spree::Image.attachment_definitions[:attachment][:path] = Spree::Config[:attachment_path]
+    Spree::Image.attachment_definitions[:attachment][:url] = Spree::Config[:attachment_url]
+    Spree::Image.attachment_definitions[:attachment][:default_url] = Spree::Config[:attachment_default_url]
+    Spree::Image.attachment_definitions[:attachment][:default_style] = Spree::Config[:attachment_default_style]
+
+    #used by admin sales autocomplete
+    def mini_url
+      attachment.url(:mini, false)
+    end
+
+    def find_dimensions
+      temporary = attachment.queued_for_write[:original]
+      filename = temporary.path unless temporary.nil?
+      filename = attachment.path if filename.blank?
+      geometry = Paperclip::Geometry.from_file(filename)
+      self.attachment_width  = geometry.width
+      self.attachment_height = geometry.height
+    end
+
+    # if there are errors from the plugin, then add a more meaningful message
+    def no_attachment_errors
+      unless attachment.errors.empty?
+        # uncomment this to get rid of the less-than-useful interrim messages
+        # errors.clear
+        errors.add :attachment, "Paperclip returned errors for file '#{attachment_file_name}' - check ImageMagick installation or image source file."
+        false
+      end
+    end
+  end
+end

data/app/models/spree/taxon_decorator.rb

@@ -1,7 +1,16 @@
 Spree::Taxon.class_eval do
-  has_many :active_sale_events, :as => :eventable, :class_name => "Spree::ActiveSale::Event"
+  has_many :active_sale_events, :as => :eventable
 
+  # if there is at least one active sale event which is live and active.
   def live?
-    !self.active_sale_events.detect{ |event| (event.live_and_active?) }.nil?
+    !self.active_sale_events.detect{ |event| event.live_and_active? }.nil?
+  end
+
+  def image_available?
+    icon?
+  end
+
+  def image
+    icon
   end
 end

data/app/models/spree/variant_decorator.rb

@@ -1,7 +1,7 @@
 Spree::Variant.class_eval do
-  has_many :active_sale_events, :as => :eventable, :class_name => "Spree::ActiveSale::Event"
+  has_many :active_sale_events, :as => :eventable
 
   def live?
-    !self.active_sale_events.detect{ |event| (event.live_and_active?) }.nil? || self.product.live?
+    !self.active_sale_events.detect{ |event| event.live_and_active? }.nil? || self.product.live?
   end
 end

data/app/overrides/admin_active_sales_tab.rb

@@ -0,0 +1,6 @@
+Deface::Override.new(
+            :name => "active_sale_tab",
+            :virtual_path => "spree/layouts/admin",
+            :insert_bottom => "[data-hook='admin_tabs'], #admin_tabs[data-hook]",
+            :text => "<%= tab :active_sales, :icon => 'icon-th-list' %>"
+)

data/app/views/spree/admin/active_sale_events/_form.html.erb

@@ -0,0 +1,136 @@
+<% if @active_sale_event.try(:errors).present? %>
+  <%= render :partial => 'spree/shared/error_messages', :locals => { :target => @active_sale_event } %>
+<% end %>
+
+<%= form_for [:admin, @active_sale, @active_sale_event], :html => { :id => 'admin_active_sale_event', :multipart => true } do |f| %>
+  <fieldset data-hook="admin_active_sale_event_form_fields">
+
+    <div class="clearfix">
+      <div class="left eight columns alpha" data-hook="admin_active_sale_event_form_left">
+          <%= f.field_container :name do %>
+            <%= f.label :name, raw(t('spree.active_sale.event.active_record.name') + content_tag(:span, ' *', :class => 'required')) %>
+            <%= f.text_field :name, :class => 'fullwidth' %>
+            <%= f.error_message_on :name %>
+          <% end %>
+          <%= f.field_container :description do %>
+            <%= f.label :description, t('spree.active_sale.event.active_record.description') %>
+            <%= f.text_area :description, {:cols => 60, :rows => 10, :class => 'fullwidth'} %>
+            <%= f.error_message_on :description %>
+          <% end %>
+      </div>
+
+      <div class="right eight columns omega" data-hook="admin_active_sale_event_form_right">
+        <div class="row">
+          <div class="alpha four columns">
+  
+            <%= f.field_container :start_date do %>
+              <%= f.label :start_date, t('spree.active_sale.event.active_record.start_date') %>
+              <%= f.error_message_on :start_date %>
+              <% if @active_sale_event.start_date? %>
+                <% start_date = l(@active_sale_event.start_date, :format => t('spree.active_sale.event.datetimepicker.format')) %>
+              <% else %>
+                <% start_date = l(Time.zone.now, :format => t('spree.active_sale.event.datetimepicker.format')) %>
+              <% end %>
+              <%= f.text_field :start_date, :value => start_date, :class => 'timepicker' %>
+            <% end %>
+          </div>
+  
+          <div class="omega four columns">
+            <%= f.field_container :end_date do %>
+              <%= f.label :end_date, t('spree.active_sale.event.active_record.end_date') %>
+              <%= f.error_message_on :end_date %>
+              <% end_date = l((@active_sale_event.end_date? ? @active_sale_event.end_date : Time.zone.now+1.day), :format => t('spree.active_sale.event.datetimepicker.format')) %>
+              <%= f.text_field :end_date, :value => end_date, :class => 'timepicker' %>
+            <% end %>
+          </div>
+        </div>
+        <div class="row">
+          <div class="alpha four columns">
+            <%= f.label :eventable, t('spree.active_sale.event.active_record.eventable_type', :default => :evenetable) %>
+            <p class='hint'><%= t('spree.active_sale.event.eventable_hint') %></p>
+            <%= f.select :eventable_type, [["Product","Spree::Product"], ["Taxon","Spree::Taxon"]], { :include_blank => false }, { :class => 'select2' } %>
+            <%= f.error_message_on :eventable %>
+          </div>
+  
+          <div class="omega four columns">
+            <%= f.label :eventable_name, t('spree.active_sale.event.active_record.eventable_name', :default => :eventable_name) %>
+            <p class='hint'><%= t('spree.active_sale.event.eventable_name_hint') %></p>
+            <%= f.error_message_on :eventable_name %>
+            <%= f.text_field :eventable_name, :class => 'autocomplete', :data => { :auto_complete_url => eventables_admin_active_sale_active_sale_events_url(:active_sale_id => @active_sale.id) } %>
+          </div>
+        </div>
+        <div class="row">
+          <div class="alpha four columns clearfix">
+            <%= f.field_container :is_active, :class => ['checkbox'] do %>
+              <label>
+                <%= f.check_box :is_active %>
+                <%= t('spree.active_sale.event.active_record.is_active') %>
+                <%= f.error_message_on :is_active %>
+              </label>
+            <% end %>
+  
+            <%= f.field_container :is_hidden, :class => ['checkbox'] do %>
+              <label>
+                <%= f.check_box :is_hidden %>
+                <%= t('spree.active_sale.event.active_record.is_hidden') %>
+                <%= f.error_message_on :is_hidden %>
+              </label>
+            <% end %>
+  
+            <%= f.field_container :is_permanent, :class => ['checkbox'] do %>
+              <label>
+                <%= f.check_box :is_permanent %>
+                <%= t('spree.active_sale.event.active_record.is_permanent') %>
+                <%= f.error_message_on :is_permanent %>
+              </label>
+            <% end %>
+          </div>
+  
+          <div class="omega four columns">
+          <%= f.field_container :discount do %>
+            <%= f.label :discount, t('spree.active_sale.event.active_record.discount', :default => :discount) %>
+            <p class='hint'><%= t('spree.active_sale.event.discount_hint') %></p>
+            <%= f.error_message_on :discount %>
+            <%= f.text_field :discount, :size => 2, :maxlength => 2 %>
+          <% end %>
+          </div>
+        </div>
+
+      </div>
+    </div>
+
+    <% unless @active_sale_event.new_record? %>
+      <ul class="inline-menu">
+        <li><%= link_to_with_icon('icon-plus', t(:new_image), new_admin_active_sale_active_sale_event_sale_image_url(@active_sale, @active_sale_event), :id => 'new_sale_image_link', :class => 'button') %></li>
+      </ul>
+      <br/>
+      <%= render 'spree/admin/shared/sale_images' %>
+    <% end %>
+
+
+    <p class="form-buttons" data-hook="admin_active_sale_form_buttons">
+      <% if @active_sale_event.new_record? %>
+        <%= render :partial => 'spree/admin/shared/new_resource_links' %>
+      <% else %>
+        <%= render :partial => 'spree/admin/shared/edit_resource_links' %>
+      <% end %>
+    </p>
+  </fieldset>
+<% end %>
+
+<%= javascript_tag do -%>
+  var properties = "<%= raw(@properties.to_json) %>";
+
+  $("#admin_active_sale_event input.autocomplete").live("keydown", function(){
+    var eventable_type = $('#active_sale_event_eventable_type :selected').val();
+    var eventable_name = $('#active_sale_event_eventable_name').val();
+    var url = $(this).data('auto-complete-url')
+    already_auto_completed = $(this).is('ac_input');
+    if (!already_auto_completed) {
+      $(this).autocomplete({
+        source: url+"?eventable_type="+eventable_type+"&name="+eventable_name
+      });
+      $(this).focus();
+    }
+  });
+<% end -%>