stall 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 93101cd6c71bd164e54d7f7a96009894eaee815d
-  data.tar.gz: e9e552e25b8fa6a49ac0423cacac158b267585ab
+  metadata.gz: 282c715e0c37f5b8581b410bcc70a30777973284
+  data.tar.gz: cc5283aa96ce4dd6cbb89678fc1ef73a812be26d
 SHA512:
-  metadata.gz: ad0c5c29e895dcadf8aff1631374685f209ce73db2e6c28ff313648e33c67093dbb0fbef762d34abcaaf9b3eb4f015a6a151285b47f8327fb194c3e162f0dfa1
-  data.tar.gz: ad331dadf79752be6c13933ef96060aa07c4b7ae5ebbea33f42757d2160bfb10825d30c2f6dbe0092d91edb1df82abbb419bc8e55f3b5583274bd889a1b3e7ad
+  metadata.gz: 256db2643c7db87598b7c55f6101b4c88b180ce7b27b17cb6d2596230cd36077b48265ef0b07e7b1c7cd8a5c45ce0addc58b5198fce5768075086c20bd02c6d7
+  data.tar.gz: 1cb10a57017e254f1fcabdf2e57e613fda6b1aee3f0392a74e0d7d7932eb4062554eae49e2100dc29f68940365da710b82192d1da67fe7322519cbd2af1e61f1

data/README.md

@@ -38,7 +38,16 @@ This will generate :
 
 ## Usage
 
-### Making a model sellable
+In the following sections, you'll find the following informations :
+
+1. [Making a model sellable](#1--Making-a-model-sellable)
+2. [Configuring shop defaults](#2--Configuring-shop-defaults)
+3. [Configuring the checkout flow](#3--Configuring-the-checkout-flow)
+4. [Customizing views](#4--Customizing-views)
+5. [Cleaning up aborted carts](#5--Cleaning-up-aborted-carts)
+
+
+### 1. Making a model sellable
 
 Stall allows you to make any model sellable by including the `Stall::Sellable`
 mixin into your model :
@@ -58,7 +67,21 @@ You can now add the "Add to cart" button to your templates :
 For more informations see the Wiki page :
 [Allowing customers to add products to cart](https://github.com/rails-stall/stall/wiki/Allowing-customers-to-add-products-to-cart)
 
-### Configuring the checkout flow
+### 2. Configuring shop defaults
+
+Before running the shop, please read through the generated Stall initializer
+file at `config/initializers/stall.rb` and customize their values to your
+fir your desired shop behavior.
+
+Here are the mandatory ones :
+
+- `store_name`
+- `admin_email`
+- `sender_email`
+- `default_app_domain`
+
+
+### 3. Configuring the checkout flow
 
 The checkout process is completely flexible and can be overriden easily.
 
@@ -66,7 +89,22 @@ Please see the Wiki page :
 [The checkout process](https://github.com/rails-stall/stall/wiki/The-checkout-process)
 
 
-### Cleaning up aborted carts
+### 4. Customizing views
+
+You can copy stall views to your app with the `stall:view` generator.
+The less you customize the views, the more you get it to work with future
+Stall versions.
+
+Find the templates you need by browsing the source code (ex: `bundle open stall`)
+and generate the needed views. You can pass any number of views at a time.
+
+Example :
+
+```bash
+rails generate stall:view checkout/steps/_informations checkout/steps/_payment stall/carts/_cart
+```
+
+### 5. Cleaning up aborted carts
 
 A cart is created for each new visit on the app. You may want to clean
 aborted carts to avoid the table to grow too big.

data/app/assets/javascripts/stall/add-to-cart-form.coffee

@@ -1,11 +1,40 @@
 class Stall.AddToCartForm extends Vertebra.View
   @create = ($el) ->
-    return if $el.data('stall.add-to-cart-form')
-    instance = new Stall.AddToCartForm(el: $el)
-    $el.data('stall.add-to-cart-form', instance)
+    unless (instance = $el.data('stall.add-to-cart-form'))
+      instance = new Stall.AddToCartForm(el: $el)
+      $el.data('stall.add-to-cart-form', instance)
+
+    instance.sendRequest()
 
   events:
     'ajax:success': 'onSuccess'
+    'ajax:complete': 'onComplete'
+    'change [name$="[sellable_id]"]': 'onValidatableFieldChanged'
+    'change [name$="[quantity]"]': 'onValidatableFieldChanged'
+
+  initialize: ->
+    @$button = @$('[type="submit"]')
+    @errorMessages = @$el.data('error-messages')
+
+  sendRequest: ->
+    return false unless @validate(submit: true) and !@errors.length
+    @setLoading(true)
+    true
+
+  onValidatableFieldChanged: ->
+    @validate()
+
+  validate: (options = {})->
+    @checkErrors()
+    @refreshErrorsDisplay(options)
+
+  checkErrors: ->
+    @errors = []
+    @errors.push('choose') unless @$('[name$="[sellable_id]"]').val()
+    @errors.push('quantity') unless @$('[name$="[quantity]"]').val()
+
+  onComplete: ->
+    @setLoading(false)
 
   onSuccess: (e, resp) ->
     @$modal = $(resp).appendTo('body').modal()
@@ -17,6 +46,29 @@ class Stall.AddToCartForm extends Vertebra.View
     if ($counter = $('[data-cart-quantity-counter]')).length
       $counter.text(quantity)
 
+  # Displays errors in a tooltip on the form submit button, listing different
+  # errors and disabling the submit button
+  refreshErrorsDisplay: (options = {}) ->
+    buttonIsTooltip = @$button.data('bs.tooltip')
+
+    if @errors.length
+      messages = (@errorMessages[error] for error in @errors)
+      message = messages.join('<br>')
+      @$button.attr(title: message)
+      @$button.tooltip() unless buttonIsTooltip
+      # Force tooltip display if the user just submitted the form
+      @$button.tooltip('show') if options.submit
+      @$button.prop('disabled', true)
+    else
+      @$button.attr(title: '')
+      @$button.tooltip('destroy') if buttonIsTooltip
+      @$button.prop('disabled', false)
+
+  setLoading: (loading) ->
+    state = if loading then 'loading' else 'reset'
+    @$button.button(state)
+
+
 Stall.onDomReady ->
   $('body').on 'ajax:beforeSend', '[data-add-to-cart-form]', (e) ->
     Stall.AddToCartForm.create($(e.currentTarget))

data/app/assets/javascripts/stall/addresses-fields.coffee

@@ -0,0 +1,17 @@
+class Stall.AddressesFields extends Vertebra.View
+  events:
+    'change [data-use-another-address-for-billing]': 'addressesSwitchChanged'
+
+  initialize: ->
+    @refresh()
+
+  addressesSwitchChanged: ->
+    @refresh()
+
+  refresh: ->
+    checked = @$('[data-use-another-address-for-billing]').is(':checked')
+    @$('[data-address-form="billing"]').toggleClass('hidden', !checked)
+
+Stall.onDomReady ->
+  if ($addressesFields = $('[data-addresses-fields]')).length
+    new Stall.AddressesFields(el: $addressesFields)

data/app/assets/javascripts/stall/remote-sign-in-form.coffee

@@ -0,0 +1,55 @@
+# This class handles the sign in form inside the checkout process, allowing the
+# customers to sign in directly during the checkout, without leaving the
+# process.
+#
+class Stall.RemoteSignInForm extends Vertebra.View
+  @create = ($el) ->
+    unless (instance = $el.data('stall.remote-sign-in-form'))
+      instance = new Stall.RemoteSignInForm(el: $el)
+      instance.onBeforeSend()
+      $el.data('stall.remote-sign-in-form', instance)
+
+  events:
+    'ajax:beforeSend': 'onBeforeSend'
+    'ajax:success': 'onSuccess'
+    'ajax:error': 'onError'
+
+  initialize: ->
+    # We store the current URL to allow refreshing the page after the user
+    # signed in, since Turbolinks 5 automatically forces the browser to follow
+    # server redirections by evaluating javascript in the browser. Since we
+    # don't want to configure Devise (or other gems) server-side, we work-around
+    # this issue by running a second redirection, manually, with the URL we
+    # store here
+    @currentURL = window.location.href
+
+  onBeforeSend: ->
+    @setLoading(true)
+
+  onSuccess: (e, response) ->
+    @setLoading(false)
+    @removeFlashMessage()
+    Turbolinks.visit(@currentURL)
+
+  onError: (e, jqXHR) ->
+    @setFlashMessage(jqXHR.responseText, type: 'danger')
+    @setLoading(false)
+
+  setLoading: (loading) ->
+    state = if loading then 'loading' else 'reset'
+    @$('[data-sign-in-submit-btn]').button(state)
+
+  setFlashMessage: (message, options = {}) ->
+    @removeFlashMessage()
+    alertClass = "alert alert-#{ options.type }"
+    $('<div/>', class: alertClass, 'data-flash': true)
+      .html(message).prependTo(@$el)
+
+  removeFlashMessage: ->
+    @$('[data-flash]').remove()
+
+
+Stall.onDomReady ->
+  $('[data-stall-remote-sign-in-form]').each (i, el) ->
+    $(el).one 'ajax:beforeSend', (e) ->
+      Stall.RemoteSignInForm.create($(e.currentTarget))

data/app/assets/javascripts/stall.coffee

@@ -3,11 +3,13 @@
 #= require_self
 #= require stall/add-to-cart-form
 #= require stall/cart-form
+#= require stall/addresses-fields
+#= require stall/remote-sign-in-form
 
 @Stall =
   onDomReady: (callback) ->
     event = if window.Turbolinks && window.Turbolinks.supported
-      'page:change'
+      'page:change turbolinks:load'
     else
       'ready'
 

data/app/controllers/stall/application_controller.rb

@@ -17,7 +17,7 @@ module Stall
       return Stall.config.default_layout if Stall.config.default_layout
 
       parent_controller = self.class.ancestors.find do |ancestor|
-        !ancestor.name.match(/^Stall::/)
+        !ancestor.name.to_s.match(/^Stall::/) && Class === ancestor
       end
 
       parent_controller._layout ||= 'application'

data/app/controllers/stall/carts_controller.rb

@@ -40,9 +40,7 @@ module Stall
 
     def cart_params
       params.require(:cart).permit(
-        line_items_attributes: [
-          :id, :quantity, :_destroy
-        ]
+        line_items_attributes: [:id, :quantity, :_destroy]
       )
     end
   end

data/app/controllers/stall/checkout/steps_controller.rb

@@ -3,6 +3,7 @@ module Stall
     class StepsController < Stall::ApplicationController
       include Stall::CheckoutHelper
 
+      skip_before_action :verify_authenticity_token, on: :foreign_update
       before_action :load_cart
       before_action :load_step
       before_action :ensure_cart_checkoutable
@@ -22,6 +23,8 @@ module Stall
         end
       end
 
+      alias_method :foreign_update, :update
+
       def change
         target_step = params[:step]
 
@@ -53,7 +56,7 @@ module Stall
 
         unless @cart.checkoutable?
           flash[:error] = t('stall.checkout.shared.not_checkoutable')
-          redirect_to request.referrer || root_path
+          redirect_to_referrer_or_root
         end
       end
 
@@ -67,12 +70,26 @@ module Stall
           step.inject(:cookies, cookies)
           step.inject(:request, request)
           step.inject(:flash, flash)
+          step.inject(:stall_user_signed_in?, stall_user_signed_in?)
+          step.inject(:current_stall_user, current_stall_user)
 
           if Stall.config.steps_initialization
             instance_exec(step, &Stall.config.steps_initialization)
           end
         end
       end
+
+      def redirect_to_referrer_or_root
+        referrer = URI.parse(request.referrer).path if request.referrer
+
+        redirect_target = if referrer && referrer != request.path
+          request.referrer
+        else
+          root_path
+        end
+
+        redirect_to redirect_target
+      end
     end
   end
 end

data/app/helpers/stall/checkout_helper.rb

@@ -9,14 +9,13 @@ module Stall
         calculator_class = Stall::Shipping::Calculator.for(shipping_method)
 
         unless calculator_class
-          raise Stall::Shipping::CalculatorNotFound,
-                "No calculator found for the shipping method : " +
-                "#{ shipping_method.name } " +
-                "(#{ shipping_method.identifier }). " +
-                "Please remove the Stall::ShippingMethod with id " +
-                "#{ shipping_method.id } or create the associated " +
-                "calculator with `rails g stall:shipping:calculator " +
-                "#{ shipping_method.identifier }`"
+          raise Stall::Shipping::CalculatorNotFound, <<-MSG.squish
+            No calculator found for the shipping method : #{ shipping_method.name }
+            (#{ shipping_method.identifier }).
+            Please remove the Stall::ShippingMethod with id #{ shipping_method.id }
+            or create the associated calculator with
+            `rails g stall:shipping:calculator #{ shipping_method.identifier }`
+          MSG
         end
 
         calculator = calculator_class.new(cart, shipping_method)

data/app/helpers/stall/customers_helper.rb

@@ -0,0 +1,25 @@
+module Stall
+  module CustomersHelper
+    def stall_user_signed_in?
+      !!current_stall_user
+    end
+
+    def current_stall_user
+      send(Stall.config.default_user_helper_method)
+    end
+
+    # Copy e-mail error messages from user to customer, allowing them to be
+    # displayed in customer e-mail input to the visitor
+    #
+    def with_errors_from_user(customer)
+      return customer unless (user = customer.user) && user.errors.any?
+      return unless (messages = user.errors.messages[:email]) && messages.any?
+
+      messages.each do |message|
+        customer.errors.add(:email, message)
+      end
+
+      customer
+    end
+  end
+end

data/app/models/stall/models/cart.rb

@@ -12,6 +12,8 @@ module Stall
 
         has_many :adjustments, dependent: :destroy, inverse_of: :cart
         accepts_nested_attributes_for :adjustments
+
+        attr_accessor :terms
       end
 
       def total_weight

data/app/models/stall/models/customer.rb

@@ -12,6 +12,26 @@ module Stall
         accepts_nested_attributes_for :user
 
         has_many :product_lists, dependent: :destroy
+
+        validates :email, format: { with: /\A[^@\s]+@([^@\s]+\.)+[^@\W]+\z/ },
+                          allow_blank: true
+
+        before_validation :ensure_user_email
+
+        def user_or_default
+          user || build_user
+        end
+
+        def build_user(attributes = {})
+          attributes.reverse_merge!(customer: self)
+          self.user = Stall.config.default_user_model.new(attributes)
+        end
+
+        private
+
+        def ensure_user_email
+          user.email = email if user && user.email.blank?
+        end
       end
     end
   end

data/app/models/stall/models/product_list.rb

@@ -21,6 +21,7 @@ module Stall
         after_initialize :ensure_currency
         after_initialize :ensure_state
 
+        before_save :save_customer_if_changed
         after_save :ensure_reference, on: :create
 
         scope :empty, -> {
@@ -90,6 +91,14 @@ module Stall
         true
       end
 
+      def currency
+        @currency ||= if (currency = read_attribute(:currency).presence)
+          Money::Currency.new(currency)
+        else
+          self.currency = Money.default_currency
+        end
+      end
+
       private
 
       def ensure_currency
@@ -112,6 +121,10 @@ module Stall
         end
       end
 
+      def save_customer_if_changed
+        customer.save if customer && customer.changed?
+      end
+
       module ClassMethods
         def find_by_reference(reference)
           where("data->>'reference' = ?", reference).first

data/app/views/checkout/steps/_informations.html.haml

@@ -1,41 +1,30 @@
+-# Display sign in form for users that are not signed in
+- unless stall_user_signed_in?
+  - resource = Stall.config.default_user_model.new
+  = render partial: 'stall/customers/sign_in', locals: { resource: resource, resource_name: resource.model_name.element }
+
 %h1= t('stall.checkout.informations.title')
 
 = simple_form_for cart, as: :cart, url: step_path do |form|
-  = form.fields_for :customer do |customer_form|
-    = customer_form.input :email
-
-  = form.fields_for :address_ownerships, [cart.address_ownership_for(:shipping)] do |ownership_form|
-    %fieldset{ data: { :'address-form' => :shipping } }
-      = ownership_form.hidden_field :shipping
-
-      = ownership_form.fields_for :address do |address_form|
-        = address_form.input :civility, collection: Address.civility_enum
-        = address_form.input :first_name
-        = address_form.input :last_name
-        = address_form.input :address
-        = address_form.input :address_details
-        = address_form.input :zip
-        = address_form.input :city
-        = address_form.input :country
-        = address_form.input :phone
-
-  = form.input :use_another_address_for_billing do
-    = check_box_tag :use_another_address_for_billing, '1', params[:use_another_address_for_billing]
+  .row
+    .col-md-7
+      = render partial: 'stall/customers/fields', locals: { form: form, cart: cart }
+      = render partial: 'stall/addresses/fields', locals: { form: form, cart: cart }
 
-  = form.fields_for :address_ownerships, [cart.address_ownership_for(:billing)] do |ownership_form|
-    %fieldset{ data: { :'address-form' => :billing } }
-      = ownership_form.hidden_field :billing
+    .col-md-5
+      = render partial: 'stall/carts/cart', locals: { cart: cart }
+      = render partial: 'stall/shipments/fields', locals: { form: form, cart: cart }
+      = render partial: 'stall/payments/fields',  locals: { form: form, cart: cart }
 
-      = ownership_form.fields_for :address do |address_form|
-        = address_form.input :civility, collection: Address.civility_enum
-        = address_form.input :first_name
-        = address_form.input :last_name
-        = address_form.input :address
-        = address_form.input :address_details
-        = address_form.input :zip
-        = address_form.input :city
-        = address_form.input :country
-        = address_form.input :phone
+      -# Basic implementation to display the terms acceptance checkbox before
+      -# the order is placed. Just fill in the `config.terms_path` in the
+      -# Stall initializer if you want to change the terms URL, but feel free
+      -# to customize further if needed.
+      = form.input :terms, label: false do
+        = form.check_box :terms
+        = form.label :terms, t('stall.checkout.informations.accept_the')
+        = link_to Stall.config.terms_path, target: '_blank' do
+          = form.object.class.human_attribute_name(:terms)
 
-  %button.btn.btn-primary{ type: 'submit' }
-    = t('stall.checkout.informations.validate')
+      %button.btn.btn-primary.btn-lg.btn-block{ type: 'submit' }
+        = t('stall.checkout.informations.validate')

data/app/views/checkout/steps/_payment.html.haml

@@ -1,49 +1,5 @@
 %h1= t('stall.checkout.payment.title')
 
-%table.table.table-striped
-  %thead
-    %tr
-      %th= LineItem.human_attribute_name(:name)
-      %th= LineItem.human_attribute_name(:unit_price)
-      %th= LineItem.human_attribute_name(:quantity)
-      %th= LineItem.human_attribute_name(:price)
-  %tbody
-    - cart.line_items.each do |line_item|
-      %tr{ data: { :'line-item-id' => line_item.id } }
-        %td= line_item.name
-        %td= number_to_currency(line_item.unit_price)
-        %td= line_item.quantity
-        %td= number_to_currency(line_item.price)
-
-    - if cart.subtotal != cart.total_price
-      %tr
-        %td{ colspan: 3 }= t('stall.carts.recap.subtotal')
-        %td= number_to_currency(cart.subtotal)
-
-    - if cart.shipment && cart.shipment
-      %tr
-        %td{ colspan: 3 }
-          = t('stall.carts.recap.total_shipment_price')
-          \:
-          = cart.shipment.shipping_method.name
-
-        %td= number_to_currency(cart.shipment.price)
-
-    - cart.adjustments.each do |adjustment|
-      %tr
-        %td{ colspan: 3 }= adjustment.name
-        %td= number_to_currency(adjustment.price)
-
-    %tr
-      %td{ colspan: 3 }= t('stall.carts.recap.total_eot_price')
-      %td= number_to_currency(cart.total_eot_price)
-
-    %tr
-      %td{ colspan: 3 }= t('stall.carts.recap.total_vat')
-      %td= number_to_currency(cart.total_vat)
-
-    %tr
-      %td{ colspan: 3 }= t('stall.carts.recap.total_price')
-      %td= number_to_currency(cart.total_price)
+= render partial: 'stall/carts/cart', locals: { cart: cart }
 
 = payment_button_for(cart)

data/app/views/checkout/steps/_shipping_method.html.haml

@@ -7,4 +7,3 @@
   .form-actions
     %button.btn.btn-primary{ type: 'submit' }
       = t('stall.checkout.shipping_method.validate')
-

data/app/views/stall/addresses/_fields.html.haml

@@ -0,0 +1,16 @@
+.addresses-fields{ data: { :'addresses-fields' => true } }
+  = form.fields_for :address_ownerships, [cart.address_ownership_for(:shipping)] do |ownership_form|
+    %fieldset{ data: { :'address-form' => :shipping } }
+      = ownership_form.hidden_field :shipping
+
+      = ownership_form.fields_for :address do |address_form|
+        = render partial: 'stall/addresses/nested_fields', locals: { form: address_form }
+
+  = form.input :use_another_address_for_billing, as: :boolean, input_html: { data: { :'use-another-address-for-billing' => true } }
+
+  = form.fields_for :address_ownerships, [cart.address_ownership_for(:billing)] do |ownership_form|
+    %fieldset{ class: ('hidden' unless params[:use_another_address_for_billing] == '1'), data: { :'address-form' => :billing } }
+      = ownership_form.hidden_field :billing
+
+      = ownership_form.fields_for :address do |address_form|
+        = render partial: 'stall/addresses/nested_fields', locals: { form: address_form }

data/app/views/stall/addresses/_nested_fields.html.haml

@@ -0,0 +1,14 @@
+.row
+  .col-md-2= form.input :civility, collection: Address.civility_enum
+  .col-md-5= form.input :first_name
+  .col-md-5= form.input :last_name
+.row
+  .col-xs-12= form.input :address, input_html: { rows: 1 }
+.row
+  .col-xs-12= form.input :address_details, label: false, input_html: { rows: 1 }
+.row
+  .col-md-4= form.input :country
+  .col-md-4= form.input :zip
+  .col-md-4= form.input :city
+.row
+  .col-xs-12= form.input :phone

data/app/views/stall/carts/_cart.html.haml

@@ -0,0 +1,45 @@
+%table.table.table-hover
+  %thead
+    %tr
+      %th= LineItem.human_attribute_name(:name)
+      %th= LineItem.human_attribute_name(:price)
+  %tbody
+    - cart.line_items.each do |line_item|
+      %tr{ data: { :'line-item-id' => line_item.id } }
+        %td
+          = line_item.name
+          x
+          = line_item.quantity
+        %td= number_to_currency(line_item.price)
+
+  %tfoot
+    - if cart.subtotal != cart.total_price
+      %tr
+        %td= t('stall.carts.recap.subtotal')
+        %td= number_to_currency(cart.subtotal)
+
+    - if cart.shipment.try(:persisted?)
+      %tr
+        %td
+          = t('stall.carts.recap.total_shipment_price')
+          \:
+          = cart.shipment.shipping_method.name
+
+        %td= number_to_currency(cart.shipment.price)
+
+    - cart.adjustments.each do |adjustment|
+      %tr
+        %td= adjustment.name
+        %td= number_to_currency(adjustment.price)
+
+    %tr
+      %td= t('stall.carts.recap.total_eot_price')
+      %td= number_to_currency(cart.total_eot_price)
+
+    %tr
+      %td= t('stall.carts.recap.total_vat')
+      %td= number_to_currency(cart.total_vat)
+
+    %tr
+      %td= t('stall.carts.recap.total_price')
+      %td= number_to_currency(cart.total_price)

data/app/views/stall/carts/show.html.haml

@@ -11,12 +11,12 @@
 
       %tbody
         = form.fields_for :line_items do |line_item_fields|
-          %tr{ data: { :'line-item-id' => line_item_fields.object.id } }
+          %tr.line-item-row{ data: { :'line-item-id' => line_item_fields.object.id } }
             %td= line_item_fields.object.name
             %td= line_item_fields.object.unit_price
             %td= line_item_fields.input_field :quantity, spinner: false, class: 'form-control', data: { :'quantity-field' => true }
             %td= line_item_fields.object.price
-            %td= link_to_remove_association '×'.html_safe, line_item_fields
+            %td= link_to_remove_association '×'.html_safe, line_item_fields, wrapper_class: 'line-item-row'
 
         - if @cart.subtotal != @cart.total_price
           %tr