stall 0.2.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 282c715e0c37f5b8581b410bcc70a30777973284
-  data.tar.gz: cc5283aa96ce4dd6cbb89678fc1ef73a812be26d
+  metadata.gz: 98069c4e8cde848ade9836933bf11f176aae37b5
+  data.tar.gz: baf0ab5fd49de75964401f8b01003c03446e4663
 SHA512:
-  metadata.gz: 256db2643c7db87598b7c55f6101b4c88b180ce7b27b17cb6d2596230cd36077b48265ef0b07e7b1c7cd8a5c45ce0addc58b5198fce5768075086c20bd02c6d7
-  data.tar.gz: 1cb10a57017e254f1fcabdf2e57e613fda6b1aee3f0392a74e0d7d7932eb4062554eae49e2100dc29f68940365da710b82192d1da67fe7322519cbd2af1e61f1
+  metadata.gz: 2edc779f219c016fb3b1a440c1a53cd2b8c6954e09845381ae3a90e8dec033fc30761e2765523aa0e5953bc64cd2f5ecc0b3b7407a09055fcf7066e87d1c2143
+  data.tar.gz: d27a12120af62029f503c481f3ca07d82630a1b5504ce7c39f9b06cc9bee5642c3879573c25600262a11b38cc4c1380245372b54abeae436e47634b4a7515071

data/README.md

@@ -1,7 +1,7 @@
 # Stall
 
 [![Build Status](https://api.travis-ci.org/rails-stall/stall.svg?branch=master)](http://travis-ci.org/rails-stall/stall)
-[![Code Climate](https://codeclimate.com/github/rails-stall/stall.svg)](https://codeclimate.com/github/rails-stall/stall)
+[![Test Coverage](https://codeclimate.com/github/rails-stall/stall/badges/coverage.svg)](https://codeclimate.com/github/rails-stall/stall/coverage)
 
 Stall is a flexible e-commerce framework for Rails with some specific concerns
 in mind :
@@ -40,14 +40,58 @@ This will generate :
 
 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. [Configuring shop defaults](#1-configuring-shop-defaults)
+2. [Configuring shop users](#2-configuring-shop-users)
+3. [Making a model sellable](#3-making-a-model-sellable)
+4. [Configuring the checkout flow](#4-configuring-the-checkout-flow)
+5. [Customizing views](#5-customizing-views)
+6. [Cleaning up aborted carts](#6-cleaning-up-aborted-carts)
 
 
-### 1. Making a model sellable
+### 1. Configuring shop defaults
+
+Before running the shop, please read through the generated Stall initializer
+file at `config/initializers/stall.rb` and customize the default values to fit
+your desired shop behavior.
+
+Here are the mandatory ones :
+
+- `store_name`
+- `admin_email`
+- `sender_email`
+- `default_app_domain`
+
+### 2. Configuring shop users
+
+The default cart behavior admits that you have a user model, named `User` and
+that you are using [Devise](https://github.com/plataformatec/devise)
+compatible helpers in your controllers (`current_user`).
+
+You can configure those settings by setting the following initializer config
+parameters :
+
+- `default_user_model_name`
+- `default_user_helper_method`
+
+Also, the user should include an inverse `:customer` relation targeting the
+Stall's customer model like the following :
+
+```ruby
+has_one :customer, as: :user
+```
+
+#### Remove user management
+
+If you don't want to associate a user account to your customers, you'll need
+to set those variables to `nil` and remove the user creation form in the
+informations checkout step (See
+[Configuring the checkout flow](#4-configuring-the-checkout-flow) and
+[Customizing views](#5-customizing-views) for more informations on how to
+do this).
+
+Note that this is untested for now, but should be doable quite easily.
+
+### 3. Making a model sellable
 
 Stall allows you to make any model sellable by including the `Stall::Sellable`
 mixin into your model :
@@ -64,24 +108,17 @@ You can now add the "Add to cart" button to your templates :
 = add_to_cart_form_for(@book)
 ```
 
-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)
+To display the cart widget in your layout, just render the cart widget partial :
 
-### 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 :
+```ruby
+= render partial: 'stall/carts/widget', locals: { cart: current_cart }
+```
 
-- `store_name`
-- `admin_email`
-- `sender_email`
-- `default_app_domain`
+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)
 
 
-### 3. Configuring the checkout flow
+### 4. Configuring the checkout flow
 
 The checkout process is completely flexible and can be overriden easily.
 
@@ -89,7 +126,7 @@ Please see the Wiki page :
 [The checkout process](https://github.com/rails-stall/stall/wiki/The-checkout-process)
 
 
-### 4. Customizing views
+### 5. 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
@@ -104,7 +141,7 @@ Example :
 rails generate stall:view checkout/steps/_informations checkout/steps/_payment stall/carts/_cart
 ```
 
-### 5. Cleaning up aborted carts
+### 6. 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/para/stall.coffee

@@ -0,0 +1 @@
+#= require para/stall/inputs/variants-matrix

data/app/assets/javascripts/para/stall/inputs/variant-select.coffee

@@ -0,0 +1,62 @@
+class VariantSelectInput extends Vertebra.View
+  events:
+    'change [data-variant-select-property]': 'onInputChanged'
+
+  initialize: ->
+    @variants = @$el.data('variant-select-data')
+    @$properties = @$('[data-variant-select-property]')
+    @$foreignKey = @$('[data-variant-select-foreign-key]')
+    @preparePriceTarget()
+    @refreshSelectedVariant()
+
+  preparePriceTarget: ->
+    @$priceTarget = $(@$el.data('price-target'))
+    return unless @$priceTarget.length
+    @originalPrice = @$priceTarget.html()
+
+  onInputChanged: ->
+    @refreshSelectedVariant()
+
+  refreshSelectedVariant: ->
+    selectedProperties = @serializeSelectedProperties()
+    variant = @fetchVariantWithProperties(selectedProperties)
+    @updateSelectedVariantWith(variant)
+
+  serializeSelectedProperties: ->
+    selectedProperties = {}
+
+    @$properties.each (i, el) ->
+      $property = $(el)
+      name = $property.data('variant-select-property')
+
+      value = if $property.is('[data-preselected]')
+        $property.find('[data-preselected-value]').val()
+      else
+        $property.find('input:checked, select').val()
+
+      selectedProperties[name] = parseInt(value, 10)
+
+    selectedProperties
+
+  fetchVariantWithProperties: (properties) ->
+    for variant in @variants
+      matches = true
+      matches = (matches and variant[key] is value) for key, value of properties when properties.hasOwnProperty(key)
+      return variant if matches
+
+    null
+
+  updateSelectedVariantWith: (variant) ->
+    value = if variant then variant.id else null
+    @$foreignKey.val(value)
+    @$foreignKey.trigger('change')
+    @updatePriceWith(variant)
+
+  updatePriceWith: (variant) ->
+    return unless @$priceTarget.length
+    price = if variant then variant.price else @originalPrice
+    @$priceTarget.html(price)
+
+$(document).on 'page:change turbolinks:load', ->
+  $('[data-variant-select-input]').each (i, el) ->
+    new VariantSelectInput(el: el)

data/app/assets/javascripts/para/stall/inputs/variants-matrix.coffee

@@ -0,0 +1,12 @@
+#= require_self
+#= require ./variants-matrix/helpers
+#= require ./variants-matrix/nested-fields
+#= require ./variants-matrix/properties_select
+#= require ./variants-matrix/input
+#= require ./variants-matrix/variant
+
+@VariantsMatrix = {}
+
+$(document).on 'page:change turbolinks:load', ->
+  $('[data-variants-matrix-input]').each (i, el) ->
+    new VariantsMatrix.Input(el: el)

data/app/assets/javascripts/para/stall/inputs/variants-matrix/helpers.coffee

@@ -0,0 +1,40 @@
+# Shallow clone objects
+#
+# Method borrowed from first snippet from :
+# http://stackoverflow.com/questions/728360/how-do-i-correctly-clone-a-javascript-object
+#
+VariantsMatrix.clone = (obj) ->
+  return obj if null is obj or 'object' isnt typeof obj
+  copy = obj.constructor()
+
+  for key, value of obj when obj.hasOwnProperty(key)
+    copy[key] = if 'object' is typeof obj
+      VariantsMatrix.clone(value)
+    else
+      value
+
+  copy
+
+VariantsMatrix.objectLength = (obj) ->
+  length = 0
+  length++ for key, _ of obj when obj.hasOwnProperty(key)
+  length
+
+VariantsMatrix.objectsAreEqual = (objectA, objectB) ->
+  compareObjects = (a, b) ->
+    for key, _ of a
+      continue unless a.hasOwnProperty(key) or b.hasOwnProperty(key)
+
+      return true if !a and !b
+      return false unless a and b
+
+      keyValuesAreEqual = if 'object' is typeof a[key]
+        VariantsMatrix.objectsAreEqual(a[key], b[key])
+      else
+        a[key] is b[key]
+
+      return false unless keyValuesAreEqual
+
+    true
+
+  compareObjects(objectA, objectB) and compareObjects(objectB, objectA)

data/app/assets/javascripts/para/stall/inputs/variants-matrix/input.coffee

@@ -0,0 +1,133 @@
+class VariantsMatrix.Input extends Vertebra.View
+  initialize: ->
+    @$variantsContainer = @$('[data-variants-matrix-variants-container]')
+    @$variantsTableHeader = @$('[data-variants-matrix-variants-table-header]')
+
+    @propertiesSelect = new VariantsMatrix.PropertiesSelect(el: @$('[data-variants-matrix-properties-select]'))
+    @listenTo(@propertiesSelect, 'change', @onPropertySelectChanged)
+
+    @nestedFieldsManager = new VariantsMatrix.NestedFields(@$('[data-variants-matrix-new-row-button]'))
+
+    @buildVariants()
+
+  buildVariants: ->
+    existingCombinations = @buildPossibleCombinations()
+
+    @variants = for row in @$('[data-variants-matrix-variant-row]').get()
+      combination = @findCombinationForRow(row, existingCombinations)
+      variant = new VariantsMatrix.Variant(el: row, combination: combination, input: this)
+      @listenTo(variant, 'destroy', @onVariantDestroyed)
+
+      variant
+
+  findCombinationForRow: (row, existingCombinations) ->
+    propertyValues = for propertyCell in $(row).find('[data-variants-matrix-variant-property]').get()
+      $property = $(propertyCell)
+      propertyId = $property.data('variants-matrix-variant-property')
+      valueId = $property.find('[data-property-value-id]').val()
+      { propertyId: propertyId, id: valueId }
+
+    return combination for combination in existingCombinations when @combinationMatches(propertyValues, combination)
+
+  combinationMatches: (propertyValues, combination) ->
+    for combinationProperty in combination
+      propertyValue = value for value in propertyValues when value.propertyId is combinationProperty.propertyId
+      combinationValueMatches = combinationProperty and combinationProperty.id is propertyValue.id
+
+      return false unless combinationValueMatches
+
+    # Return true if all property values where found in combination
+    true
+
+
+  onPropertySelectChanged: (e) ->
+    @refreshAvailableProperties()
+    @refreshAvailableVariants()
+
+  refreshAvailableProperties: ->
+    propertyHeaderCells = for property in @propertiesSelect.getSelectedProperties() when property.active
+      $('<th/>', 'data-variants-matrix-variant-property-cell': '').text(property.name)
+
+    @$variantsTableHeader.find('[data-variants-matrix-variant-property-cell]').remove()
+    $enabledCell = @$variantsTableHeader.find('[data-variants-matrix-variant-enabled-cell]')
+    $enabledCell.after(propertyHeaderCells)
+
+  refreshAvailableVariants: ->
+    combinations = @buildPossibleCombinations()
+    @removeVariantsNotIn(combinations)
+    @createVariantsIn(combinations)
+
+  removeVariantsNotIn: (combinations) ->
+    removeableVariants = []
+
+    for variant, index in @variants
+      continue unless variant
+      matches = false
+      matches = true for combination in combinations when variant.matches(combination)
+      removeableVariants.push(variant) unless matches
+
+    # We remove variants after iterating, avoiding to change array indexes
+    # while we loop through it to match removeable variants
+    variant.remove() for variant in removeableVariants
+
+  createVariantsIn: (combinations) ->
+    for combination in combinations
+      existingVariant = @findVariantFor(combination)
+      variant = existingVariant or @createVariantFor(combination)
+      variant.show()
+
+  findVariantFor: (combination) ->
+    return variant for variant, index in @variants when variant.matches(combination)
+
+  createVariantFor: (combination) ->
+    variant = new VariantsMatrix.Variant(combination: combination, input: this)
+    variant.renderTo(@$variantsContainer)
+    @listenTo(variant, 'destroy', @onVariantDestroyed)
+    @variants.push(variant)
+
+    variant
+
+  # This methods loops through all select property options to create an array
+  # of possible variant combinations to pre
+  buildPossibleCombinations: ->
+    selection = @propertiesSelect.getSelectedProperties()
+
+    combinations = []
+
+    for property, index in selection
+      new_combinations = []
+
+      # If a property has no option selected, we go to the next iteration,
+      # leaving the combinations array untouched
+      continue unless property.values.length
+
+      # For the first property array, we just fill the combinations array with
+      # our property values
+      if combinations.length is 0
+        for value in property.values
+          combination = []
+          combination.push(value)
+          new_combinations.push(combination)
+
+      # For other property arrays, we create a new array by combining each
+      # existing combination with each property values of the current set
+      else
+        for item in combinations
+          for value in property.values
+            combination = VariantsMatrix.clone(item)
+            combination.push(value)
+            new_combinations.push(combination)
+
+      # When the new combinations array is created, we replace the previous
+      # one for next iterations to use it
+      combinations = new_combinations
+
+    combinations
+
+  # Cleanup destroyed variants
+  #
+  onVariantDestroyed: (destroyedVariant) ->
+    destroyedVariant.destroy()
+    # Remove variant from @variants array
+    @variants.splice(index, 1) for variant, index in @variants when variant?.matches(destroyedVariant.combination)
+

data/app/assets/javascripts/para/stall/inputs/variants-matrix/nested-fields.coffee

@@ -0,0 +1,38 @@
+nestedFieldsElementCounter = 0
+
+# Class that allows rendering new nested fields as variant matrix rows, allowing
+# usual cocoon-based nested fields rendering options, and para's model-scoped
+# templates rendering as `admin/<model_name>/_variants_row.html.haml`
+#
+# The class is borrowed from Cocoon code to allow using existing server-side
+# code. We couldn't directly use Cocoon's API since there's only a DOM event
+# based API and no public access to underlying methods
+#
+class VariantsMatrix.NestedFields
+  constructor: (@$button) ->
+    @$button.remove()
+
+  render: ->
+    assoc                = @$button.data('association')
+    assocs               = @$button.data('associations')
+    content              = @$button.data('association-insertion-template')
+    regexpBraced         = new RegExp('\\[new_' + assoc + '\\](.*?\\s)', 'g')
+    regexpUnderscored    = new RegExp('_new_' + assoc + '_(\\w*)', 'g')
+    newId                = @createNewId()
+    newContent           = content.replace(regexpBraced, @newContentBraced(newId))
+
+    if newContent is content
+      regexpBraced     = new RegExp('\\[new_' + assocs + '\\](.*?\\s)', 'g')
+      regexpUnderscored = new RegExp('_new_' + assocs + '_(\\w*)', 'g')
+      newContent       = content.replace(regexpBraced, @newContentBraced(newId))
+
+    newContent.replace(regexpUnderscored, @newContentUnderscored(newId))
+
+  createNewId: ->
+    new Date().getTime() + nestedFieldsElementCounter++
+
+  newContentBraced: (id) ->
+    "[#{ id }]$1"
+
+  newContentUnderscored: (id) ->
+    "_#{ id }_$1"

data/app/assets/javascripts/para/stall/inputs/variants-matrix/properties_select.coffee

@@ -0,0 +1,45 @@
+class VariantsMatrix.PropertiesSelect extends Vertebra.View
+  events:
+    'change [data-variants-matrix-property-select]': 'onPropertySelectChanged'
+    'change [data-variants-matrix-property-selector-input]': 'onPropertyChanged'
+    'click [data-variants-matrix-property-selector-label]': 'onPropertyLabelClicked'
+
+  initialize: ->
+    @$propertySelects = @$('[data-variants-matrix-property-select]').selectize
+      plugins: ['remove_button']
+
+  # Serializes all selected properties into an array of hashes containing the
+  # field name and the selected property values ids
+  #
+  getSelectedProperties: ->
+    for el in @$propertySelects.get()
+      $field = $(el)
+
+      # Ensure the property is enabled
+      $propertyListItem = $field.closest('[data-variants-matrix-property-id]')
+      continue unless $propertyListItem.is(':visible')
+
+      propertyId = parseInt($propertyListItem.data('variants-matrix-property-id'), 10)
+
+      fieldName = $field.data('variants-matrix-property-select')
+      values = @serializeFieldValues($field, propertyId)
+      { id: propertyId, name: fieldName, values: values, active: !!values.length }
+
+  serializeFieldValues: ($field, propertyId) ->
+    for option in $field.find(':selected').get()
+      $option = $(option)
+      { id: $option.attr('value'), name: $option.text(), propertyId: propertyId }
+
+  onPropertyChanged: (e) ->
+    $checkbox = $(e.currentTarget)
+    isActive = $checkbox.is(':checked')
+    propertyId = $checkbox.val()
+    $target = @$("[data-variants-matrix-property-id='#{ propertyId }']")
+    $target.toggleClass('hidden', !isActive)
+    @trigger('change')
+
+  onPropertyLabelClicked: (e) ->
+    e.stopPropagation()
+
+  onPropertySelectChanged: (e) ->
+    @trigger('change')