solidus_sale_pricing 2.0.1

data/app/models/spree/product_decorator.rb

@@ -0,0 +1,49 @@
+Spree::Product.class_eval do
+
+  # Essentially all read values here are delegated to reading the value on the Master variant
+  # All write values will write to all variants (including the Master) unless that method's all_variants parameter is set to false, in which case it will only write to the Master variant
+
+  delegate_belongs_to :master, :active_sale_in, :current_sale_in, :next_active_sale_in, :next_current_sale_in, :sale_price_in, :on_sale_in?, :original_price_in, :discount_percent_in, :sale_price, :original_price, :on_sale?, :sale_prices
+
+  # attr_accessible :sale_price, :original_price
+  # TODO Should the all_variants flag be on option you set on creating the sale and then it always behaves as such? Seems unsafe to pass this flag one way during create and use a different value for it later (they can actively bypass by accessing each variant directly and changing the values)
+
+  # TODO also accept a class reference for calculator type instead of only a string
+  def put_on_sale(attrs={}, all_variants=true)
+    run_on_variants(all_variants) { |v| v.put_on_sale(attrs) }
+  end
+  alias :create_sale :put_on_sale
+
+  def enable_sale(all_variants = true)
+    run_on_variants(all_variants) { |v| v.enable_sale }
+  end
+
+  def disable_sale(all_variants = true)
+    run_on_variants(all_variants) { |v| v.disable_sale }
+  end
+
+  def start_sale(end_time = nil, all_variants = true)
+    run_on_variants(all_variants) { |v| v.start_sale(end_time) }
+  end
+
+  def stop_sale(all_variants = true)
+    run_on_variants(all_variants) { |v| v.stop_sale }
+  end
+
+  def update_sale(attrs={}, all_variants = true)
+    run_on_variants(all_variants) { |v| v.update_sale(attrs) }
+  end
+
+  def active_sale_prices?
+    sale_prices.where(enabled: true)
+  end
+
+  private
+
+  def run_on_variants(all_variants, &block)
+    if all_variants && variants.present?
+      variants.each { |v| block.call v }
+    end
+    block.call master
+  end
+end

data/app/models/spree/sale_price.rb

@@ -0,0 +1,55 @@
+module Spree
+  class SalePrice < ActiveRecord::Base
+    # TODO validations
+    belongs_to :price, class_name: 'Spree::Price'
+    has_one :calculator, class_name: 'Spree::Calculator', as: :calculable, dependent: :destroy
+    accepts_nested_attributes_for :calculator
+    validates :value, presence: true
+    validates :calculator, presence: true
+
+    scope :active, lambda {
+      where("enabled = 't' AND (start_at <= ? OR start_at IS NULL) AND (end_at >= ? OR end_at IS NULL)", Time.now, Time.now)
+    }
+
+    # TODO make this work or remove it
+    #def self.calculators
+    #  Rails.application.config.spree.calculators.send(self.to_s.tableize.gsub('/', '_').sub('spree_', ''))
+    #end
+
+    def calculator_type
+      calculator.class.to_s if calculator
+    end
+
+    def calculator_type=(calculator_type)
+      clazz = calculator_type.constantize if calculator_type
+      self.calculator = clazz.new if clazz and not self.calculator.is_a? clazz
+    end
+
+    def price
+      calculator.compute self
+    end
+
+    def enable
+      update_attributes(end_at: nil, enabled: true)
+    end
+
+    def disable
+      update_attribute(:enabled, false)
+    end
+
+    def start(end_time = nil)
+      end_time = nil if end_time.present? && end_time <= Time.now # if end_time is not in the future then make it nil (no end)
+      attr = { end_at: end_time, enabled: true }
+      attr[:start_at] = Time.now if self.start_at.present? && self.start_at > Time.now # only set start_at if it's not set in the past
+      update_attributes(attr)
+    end
+
+    def stop
+      update_attributes(end_at: Time.now, enabled: false)
+    end
+
+    def update(attrs={})
+      update_attributes(attrs)
+    end
+  end
+end

data/app/models/spree/variant_decorator.rb

@@ -0,0 +1,65 @@
+Spree::Variant.class_eval do
+  delegate_belongs_to :default_price, :sale_price, :sale_prices, :original_price, :on_sale?
+
+  # TODO also accept a class reference for calculator type instead of only a string
+  def put_on_sale(attrs={}, all_currencies=true)
+    run_on_prices(all_currencies) { |p| p.put_on_sale(attrs) }
+  end
+  alias :create_sale :put_on_sale
+
+  def active_sale_in(currency)
+    price_in(currency).active_sale
+  end
+  alias :current_sale_in :active_sale_in
+
+  def next_active_sale_in(currency)
+    price_in(currency).next_active_sale
+  end
+  alias :next_current_sale_in :next_active_sale_in
+
+  def sale_price_in(currency)
+    Spree::Price.new variant_id: self.id, currency: currency, amount: price_in(currency).sale_price
+  end
+
+  def discount_percent_in(currency)
+    price_in(currency).discount_percent
+  end
+
+  def on_sale_in?(currency)
+    price_in(currency).on_sale?
+  end
+
+  def original_price_in(currency)
+    Spree::Price.new variant_id: self.id, currency: currency, amount: price_in(currency).original_price
+  end
+
+  def enable_sale(all_currencies = true)
+    run_on_prices(all_currencies) { |p| p.enable_sale }
+  end
+
+  def disable_sale(all_currencies = true)
+    run_on_prices(all_currencies) { |p| p.disable_sale }
+  end
+
+  def start_sale(end_time = nil, all_currencies = true)
+    run_on_prices(all_currencies) { |p| p.start_sale end_time }
+  end
+
+  def stop_sale(all_currencies=true)
+    run_on_prices(all_currencies) { |p| p.stop_sale }
+  end
+
+  def update_sale(attrs, all_currencies=true)
+    run_on_prices(all_currencies) { |p| p.update_sale(attrs) }
+  end
+
+  private
+
+  def run_on_prices(all_currencies, &block)
+    if all_currencies && prices.present?
+      prices.each { |p| block.call p }
+    else
+      block.call default_price
+    end
+  end
+end

data/app/overrides/add_sale_price_to_product_view.rb

@@ -0,0 +1,12 @@
+Deface::Override.new(
+  virtual_path: 'spree/shared/_products',
+  name: 'add_sale_price_to_product',
+  replace: 'span.price'
+) do
+  "<% if product.on_sale? %>
+    <span class='price sale' itemprop='sale_price'><%= number_to_currency(product.sale_price) %></span>
+    <span class='price selling' itemprop='price'><%= display_price(product) %></span>
+  <% else %>
+    <span class='price selling' itemprop='price'><%= display_price(product) %></span>
+  <% end %>"
+end

data/app/overrides/add_sale_product_admin_tabs.rb

@@ -0,0 +1,6 @@
+Deface::Override.new(
+  virtual_path: 'spree/admin/shared/_product_tabs',
+  name: 'add_sale_products_admin_tab',
+  insert_bottom: '[data-hook="admin_product_tabs"]',
+  partial: 'spree/admin/products/sale_products'
+)

data/app/views/spree/admin/products/_sale_products.html.erb

@@ -0,0 +1,3 @@
+<li<%== ' class="active"' if current == "On Sale" %>>
+  <%= link_to Spree.t(:'admin.tab.sale_products'), admin_product_sale_prices_url(@product) %>
+</li>

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

@@ -0,0 +1,31 @@
+<div data-hook='admin_sale_price_form_fields' class='row'>
+  <div class='alpha four columns'>
+    <div class='field'>
+      <%= f.field_container :value do %>
+        <%= f.label :value, Spree.t(:value) %><br />
+        <%= f.text_field :value, class: 'fullwidth' %>
+        <%= f.error_message_on :value %>
+      <% end %>
+    </div>
+  </div>
+
+  <div class='alpha four columns'>
+    <div class='field'>
+      <%= f.field_container :start_at do %>
+        <%= f.label :start_at, Spree.t(:start_at) %><br />
+        <%= f.text_field :start_at, value: datepicker_field_value(@sale_price.start_at), class: 'datepicker fullwidth' %>
+        <%= f.error_message_on :start_at %>
+      <% end %>
+    </div>
+  </div>
+
+  <div class='alpha four columns'>
+    <div class='field'>
+      <%= f.field_container :end_at do %>
+        <%= f.label :end_at, Spree.t(:end_at) %><br />
+        <%= f.text_field :end_at, value: datepicker_field_value(@sale_price.end_at), class: 'datepicker fullwidth' %>
+        <%= f.error_message_on :end_at %>
+      <% end %>
+    </div>
+  </div>
+</div>

data/app/views/spree/admin/sale_prices/edit.html.erb

@@ -0,0 +1,17 @@
+<% content_for :page_actions do %>
+  <% if can?(:admin, Spree::SalePrice) %>
+    <li><%= button_link_to Spree.t(:back_to_sale_prices_list), admin_product_sale_prices_path(@product), icon: 'arrow-left' %></li>
+  <% end %>
+<% end %>
+
+<%= render partial: 'spree/admin/shared/product_tabs', locals: { current: 'On Sale' } %>
+<%= render partial: 'spree/shared/error_messages', locals: { target: @sale_price } %>
+
+<% content_for :page_title do %>
+  <%= Spree.t(:sale_price) %>
+<% end %>
+
+<%= form_for [:admin, @product, @sale_price], method: :put do |f| %>
+  <%= render 'form', f: f %>
+  <%= render 'spree/admin/shared/edit_resource_links', collection_url: admin_product_sale_prices_url %>
+<% end %>

data/app/views/spree/admin/sale_prices/index.html.erb

@@ -0,0 +1,54 @@
+<% content_for :page_title do %>
+  <%= Spree.t(:listing_sale_prices) %>
+<% end %>
+
+<% content_for :page_actions do %>
+  <%= button_link_to Spree.t(:new_sale_price), new_admin_product_sale_price_url(@product), icon: 'add', class: 'btn-success', id: 'admin_new_sale_price_link' %>
+<% end %>
+
+<%= render partial: 'spree/admin/shared/product_tabs', locals: { current: 'On Sale' } %>
+
+<% if @sale_prices.any? %>
+  <table class='table' id='listing_sale_prices'>
+    <thead>
+      <tr data-hook='admin_sale_prices_index_headers'>
+        <th class='text-center'><%= Spree.t(:original_price) %></th>
+        <th class='text-center'><%= Spree.t(:value) %></th>
+        <th class='text-center'><%= Spree.t(:start_at) %></th>
+        <th class='text-center'><%= Spree.t(:end_at) %></th>
+        <th class='text-center'><%= Spree.t(:enabled) %></th>
+        <th class='actions' data-hook='admin_sale_prices_index_header_actions'></th>
+      </tr>
+    </thead>
+
+    <tbody>
+      <% @sale_prices.each do |sale_price| %>
+        <tr id='<%= spree_dom_id sale_price %>' data-hook='admin_sale_prices_index_rows' class='<%= cycle('odd', 'even') %>'>
+          <td class='align-center'><%= number_to_currency(@product.original_price.to_f) %></td>
+          <td class='align-center'><%= number_to_currency(sale_price.value) %></td>
+          <td class='align-center'><%= format_date(sale_price.start_at) %></td>
+          <td class='align-center'><%= format_date(sale_price.end_at) %></td>
+          <td class='align-center'><%= sale_price.enabled %></td>
+          <td class='actions actions-3 text-right' data-hook='admin_sale_prices_index_row_actions'>
+            <%= link_to_edit sale_price, url: edit_admin_product_sale_price_url(@product, sale_price), no_text: true, class: 'edit' if can?(:edit, sale_price)  %>
+            &nbsp;
+            <% if sale_price.enabled? %>
+              <%= link_to_with_icon 'remove', Spree.t(:stop), admin_product_sale_price_stop_path(@product, sale_price), no_text: true, class: 'stop' if can?(:edit, sale_price)  %>
+              &nbsp;
+            <% else %>
+              <%= link_to_with_icon 'check', Spree.t(:enable), admin_product_sale_price_enable_path(@product, sale_price), no_text: true, class: 'enable' if can?(:edit, sale_price)  %>
+              &nbsp;
+            <% end %>
+            <%= link_to_delete sale_price, url: admin_product_sale_price_path(@product, sale_price), no_text: true if can?(:delete, sale_price) %>
+          </td>
+        </tr>
+      <% end %>
+    </tbody>
+  </table>
+<% else %>
+  <div class='alpha twelve columns no-objects-found'>
+    <%= render 'spree/admin/shared/no_objects_found',
+                 resource: Spree::SalePrice,
+                 new_resource_url: spree.new_admin_product_sale_price_path(@product) %>
+  </div>
+<% end %>

data/app/views/spree/admin/sale_prices/new.html.erb

@@ -0,0 +1,15 @@
+<% content_for :page_actions do %>
+  <%= button_link_to Spree.t(:back_to_sale_prices_list), admin_product_sale_prices_path(@product), icon: 'arrow-left', class: 'btn-primary' %>
+<% end %>
+
+<% content_for :page_title do %>
+  <%= Spree.t(:new_sale_price) %>
+<% end %>
+
+<%= render partial: 'spree/admin/shared/product_tabs', locals: { current: 'On Sale' } %>
+<%= render partial: 'spree/shared/error_messages', locals: { target: @sale_price } %>
+
+<%= form_for [:admin, :product, @sale_price] do |f| %>
+  <%= render 'form', f: f %>
+  <%= render 'spree/admin/shared/new_resource_links', collection_url: admin_product_sale_prices_path(@product) %>
+<% end %>

data/bin/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/solidus_sale_pricing/engine', __FILE__)
+
+require 'rails/all'
+require 'rails/engine/commands'

data/config/locales/en.yml

@@ -0,0 +1,34 @@
+# 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:
+  activerecord:
+    models:
+      spree/sale_price:
+        one: Sale Price
+        other: Sale Prices
+  spree:
+    admin:
+      tab:
+        sale_products: Sale Products
+    new_sale_price: New Sale Price
+    listing_sale_prices: Listing Sale Prices
+    creating_sale_price: Creating Sale Price
+    sale_price: Sale Price
+    sale_products: On Sale
+    price_id: Price ID
+    original_price: Original Price
+    value: Value
+    start_at: Start At
+    end_at: End At
+    enabled: Enabled
+    stop: Stop
+    enable: Enable
+    sale_price_stopped: The sale price was stopped successfully!
+    sale_price_enabled: The sale price was enabled successfully!
+    please_stop_other_sale_prices: Please stop the other sale prices
+    sale_price_successfully_created: The sale price was successfully created
+    error_on_create: Something went wrong, please check your data
+    sale_price_successfully_updated: The sale price was successfully updated
+    error_on_update: Something went wrong, please check your data
+    back_to_sale_prices_list: Back to Sale Prices List

data/config/routes.rb

@@ -0,0 +1,10 @@
+Spree::Core::Engine.routes.draw do
+  namespace :admin do
+    resources :products do
+      resources :sale_prices do
+        get :stop
+        get :enable
+      end
+    end
+  end
+end

data/db/migrate/20160622203615_add_spree_create_sale_prices_table.rb

@@ -0,0 +1,19 @@
+class AddSpreeCreateSalePricesTable < SolidusSupport::Migration[4.2]
+  def change
+    create_table :spree_sale_prices do |t|
+      t.integer :price_id
+      t.float :value
+      t.datetime :start_at
+      t.datetime :end_at
+      t.boolean :enabled
+      t.timestamps
+    end
+
+    # Getting active sale prices for a price
+    add_index :spree_sale_prices, [:price_id, :start_at, :end_at, :enabled], :name => "index_active_sale_prices_for_price"
+    # Getting all active sale prices for all prices
+    add_index :spree_sale_prices, [:start_at, :end_at, :enabled], :name => "index_active_sale_prices_for_all_variants"
+    # Getting all sale prices for a price
+    add_index :spree_sale_prices, :price_id, :name => "index_sale_prices_for_price"
+  end
+end

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

@@ -0,0 +1,31 @@
+module SolidusSalePricing
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+
+      class_option :auto_run_migrations, type: :boolean, default: false
+
+      def add_javascripts
+        append_file 'vendor/assets/javascripts/spree/frontend/all.js', "//= require spree/frontend/solidus_sale_pricing\n"
+        append_file 'vendor/assets/javascripts/spree/backend/all.js', "//= require spree/backend/solidus_sale_pricing\n"
+      end
+
+      def add_stylesheets
+        inject_into_file 'vendor/assets/stylesheets/spree/frontend/all.css', " *= require spree/frontend/solidus_sale_pricing\n", before: /\*\//, verbose: true
+        inject_into_file 'vendor/assets/stylesheets/spree/backend/all.css', " *= require spree/backend/solidus_sale_pricing\n", before: /\*\//, verbose: true
+      end
+
+      def add_migrations
+        run 'bundle exec rake railties:install:migrations FROM=solidus_sale_pricing'
+      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/solidus_sale_pricing.rb

@@ -0,0 +1,8 @@
+require 'solidus_backend'
+require 'solidus_core'
+require 'solidus_support'
+require 'solidus_sale_pricing/engine'
+require 'solidus_sale_pricing/version'
+require 'coffee_script'
+require 'sass/rails'
+require 'deface'

data/lib/solidus_sale_pricing/engine.rb

@@ -0,0 +1,22 @@
+module SolidusSalePricing
+  class Engine < Rails::Engine
+    require 'spree/core'
+    isolate_namespace Spree
+    engine_name 'solidus_sale_pricing'
+
+    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