rightnow_oms 0.1.4 → 0.1.6

data/CHANGELOG

@@ -1,3 +1,15 @@
+*Rightnow OMS 0.1.6 (Mon 01:43, Mar 05, 2012)*
+
+* Fixed 0.1.5 release error
+
+*Rightnow OMS 0.1.5 (Mon 01:43, Mar 05, 2012)*
+
+* Upgraded ember and ember-data
+* Fixed lots of bugs
+* Support I18n
+* Created associations between models
+* Added a few unit tests for javascript
+
 *Rightnow OMS 0.1.4 (Wed 11:57, Feb 22, 2012)*
 
 * Upgraded Ember.JS to 0.9.5

data/README.md

@@ -14,6 +14,7 @@ Add the following gems to your Gemfile:
   gem 'acts_as_api'
   gem 'haml-rails'
   gem 'confstruct'
+  gem 'ransack'
 
   group :assets do
     gem 'uglifier'
@@ -32,89 +33,73 @@ Make sure that all requirements are met and add RightnowOms to your Gemfile.
 
 and run `bundle install`
 
-## Usage
+## Setup
 
-Mount RightnowOms to your application.
+Mount `rightnow_oms` to your application.
 
 ```ruby
   # config/routes.rb
-  mount RightnowOms::Engine => "rightnow_oms"
+  mount RightnowOms::Engine => "rightnow_oms", as: :rightnow_oms
 ```
 
-Create the migrations with:
+Install the migrations of `rightnow_oms`:
 
 ```bash
   rake rightnow_oms:install:migrations
   rake db:migrate
 ```
 
-Run `bundle install` and require ember and ember-data in your `app/assets/javascripts/application.js`:
+`rightnow_oms` is built based on ember, ember-data and ember-i18n, so you need to
+install these libs first. Or you can use the files in
+`rightnow_oms`. So you need to add the following lines to your `app/assets/javascripts/application.js`:
 
 ```
-  = require rightnow_oms/vendor/ember-0.9.5
+  = require rightnow_oms/vendor/ember
   = require rightnow_oms/vendor/ember-data
+  = require rightnow_oms/vendor/ember-i18n
 ```
 
-Add the following line to your `app/assets/javascripts/application.js`:
+After ember libs installed, you need to add `rightnow_oms/application`
+to your `app/assets/javascripts/application.js`:
 
 ```
   = require rightnow_oms/application
 ```
 
-Add the stylesheets to your `app/assets/stylesheets/application.css`:
+To enable the default theme of `rightnow_oms`, you need to link the
+default stylesheet into your `app/assets/stylesheets/application.css`:
 
 ```
   = require rightnow_oms/application
 ```
 
-Create a layout for your detailed cart view like:
+The configurations of `rightnow_oms` ember application are saved in key-value
+pairs. To override the default configurations, you only need to call
+`RightnowOms.configure` and reset the values of the configurations.
 
-```haml
-  # app/views/layouts/rightnow_oms/cart.html.haml
-  !!!
-  %html
-    %head
-      %title RightnowOms
-      = stylesheet_link_tag    "application"
-      = javascript_include_tag "application"
-      = csrf_meta_tags
+```javascript
+  RightnowOms.configure(function(config) {
+    // Disable autoCommit
+    config.set('autoCommit', false);
 
-    %body
-      = yield
+    // Set the default locale to zh_CN
+    config.set('defaultLocale', 'zh_CN');
+  });
 ```
 
-You need to configure your new order url in RightnowOms:
+## Usage
 
-```ruby
-  # config/initializers/rightnow_oms.rb
-  RightnowOms.configure do
-    new_order_url '/orders/new'
-  end
-```
+### Add a Float Cart to Your Pages
 
-Add before filters to your controllers which need to use the cart:
+First, you need to load/create a cart for your pages. By adding a before
+filter `load_or_create_cart` to your controllers, you can get the cart.
 
 ```ruby
   # This before filter will create an instance variable @cart
   before_filter :load_or_create_cart
 ```
 
-Create cartable models in your application:
-
-```ruby
-class Product < ActiveRecord::Base
-  acts_as_cartable
-end
-```
-
-By default, Cart loads the name and price of cartable models by
-attributes named name and price. You can customize these attributes:
-
-```ruby
-  acts_as_cartable { name: :your_name_attr, price: :your_price_attr }
-```
-
-Add a place holder for your cart in your views:
+Secondly, you need to add a place holder for your cart in your views:
 
 ```html
   <div id="rightnow-oms">
@@ -124,7 +109,7 @@ Add a place holder for your cart in your views:
   </div>
 ```
 
-and load your cart in the view:
+And then you can load the cart:
 
 ```javascript
   $(function() {
@@ -132,43 +117,133 @@ and load your cart in the view:
   });
 ```
 
-You can add cartables to the cart by:
+### Add Cartable Things to Your Cart
+
+`rightnow_oms` can only accept cartable model, so the things you added
+to the cart must be a cartable model. To define a cartable model, you
+just need to call the extended method `acts_as_cartable` in the model
+class.
+
+``` ruby
+  class Product < ActiveRecord::Base
+    acts_as_cartable
+  end
+```
+
+By default, Cart loads the name and price of cartable models by
+attributes named name and price. But you can define your own name and
+price attributes as follows:
+
+```ruby
+  class Product < ActiveRecord::Base
+    acts_as_cartable name: :your_name_attr, price: :your_price_attr
+  end
+```
+
+Now you can add cartables to the cart.
 
 ```javascript
   RightnowOms.cartController.addCartItem({
     cartable_id: 1,             // required
     cartable_type: 'Product',   // required
     price: '10.00',             // required
-
-    // optional, indicating this is a child node of another one
-    parent_id: 2,
-
+    name: 'Parent Product',    // optional
+    quantity: 1,                // optional
     // optional, grouping cart items
-    group: 'booking'
-  }, function(cartItem) {
-    // Do something after the cart item is created
+    group: 'booking',
+    // optional
+    children: [{
+      cartable_id: 2,             // required
+      cartable_type: 'Product',   // required
+      price: '5.00',              // required
+      name: 'Child Product',      // optional
+      quantity: 1,                // optional
+      // optional, grouping cart items
+      group: 'booking',
+    })
   })
 ```
 
-### Strategy to sync data with remote
+### Manage Your Cart
 
-By default, RightnowOms sync the data immediately when you change the
-data objects in the store. But by setting `autoCommit` to `false`, you
-can change the default behavior. 
+Create a layout for your detailed cart view like:
+
+```haml
+  # app/views/layouts/rightnow_oms/cart.html.haml
+  !!!
+  %html
+    %head
+      %title RightnowOms
+      = stylesheet_link_tag    "application"
+      = javascript_include_tag "application"
+      = csrf_meta_tags
+
+    %body
+      = yield
+```
+
+### Create an Order with the Cart
+
+To create an order, you need to specify the url of the page which the
+customer will add more detailed information on it. After you click the
+submit button on the detailed cart page, you will be redirected to the
+url which you have set.
+
+```ruby
+  # config/initializers/rightnow_oms.rb
+  RightnowOms.configure do
+    new_order_url '/orders/new'
+  end
+```
+
+### Checkout
+
+WIP
+
+## I18n
+
+`rightnow_oms` supports I18n now. By default it only includes two
+locales: en and zh_CN, but you can create your own locales easily.
+First, you need to define your translations, for example:
 
 ```javascript
-  RightnowOms.config.set('autoCommit', false)
+  var zh_CN = { 
+    'cart.cartable.counter': '购物车'
+    'cart.total': '总计'
+
+    'cart_item.name': '名称'
+    'cart_item.price': '价格'
+    'cart_item.quantity': '数量'
+    'cart_item.total': '小计'
+
+    'currency.unit': '￥'
+    
+    'buttons.check_cart': '查看我的购物车'
+    'buttons.delete': '删除'
+    'buttons.clean_cart': '清空购物车'
+    'buttons.continue_to_shop': '继续购物'
+    'buttons.new_order': '提交订单'
+
+    'titles.cart': '我的购物车'
+
+    'alerts.saving_cart': '正在保存购物车，请稍后。。。'
+
+    'confirmations.delete_cart_item': '您确定要删除该商品吗？'
+    'confirmations.clean_up_cart': '您确定要清空您的购物车吗？'
+  };
 ```
 
-If you turn off auto-commit, you need to sync the data explicitly. When
-you have created, updated and deleted any data object in the client
-side, you ought to commit these changes by yourself.
+And then add your translations to `rightnow_oms` and set it as the
+default locale:
 
 ```javascript
-  RightnowOms.commit(true)
+  RightnowOms.configure(function(config) {
+    config.set('locales.zh_CN', zh_CN);
+    config.set('defaultLocale', 'zh_CN');
+  });
 ```
 
-Now you have all things done. Wish you have a good day.
+It's welcome to create a pull request for your locale.
 
 ## Development
 
@@ -176,9 +251,9 @@ RightnowOms is developed with Ruby 1.9.3-p0 and Rails 3.1.3
 
 First of all, you need to create a database config for RightnowOms.
 There are already some useful templates for you under
-`spec/dummy/config/`. RightnowOms use PostgreSQL by default. If you want
-to setup other databases, for example mysql, you need to modify the
-Gemfile by yourself.
+`spec/dummy/config/`. RightnowOms use MySQL by default. If you want
+to setup to use other databases, for example PostgreSQL, you need to modify the
+Gemfile and add the adapters by yourself.
 
 ```bash
   bundle install
@@ -193,5 +268,9 @@ Gemfile by yourself.
   rails s
 ```
 
+For the javascript unit tests, you need to start the dummy application
+first, and then open your browser and visit
+[http://localhost:3000/test/qunit](http://localhost:3000/test/qunit)
+
 ## Copyright
 Copyright 2011-2012 Beijing Menglifang Network Technology and Science Co.,Ltd. All rights reserved.

data/app/assets/javascripts/rightnow_oms/app/app.js.coffee

@@ -9,11 +9,19 @@ window.RightnowOms = Ember.Application.create
 
   _commitTimer: null
 
-window.RightnowOms.store = DS.Store.create
+  config: Em.Object.create()
+
+  configure: (reconfigure) ->
+    reconfigure(RightnowOms.config) if reconfigure
+    
+    defaultLocale = RightnowOms.config.get('defaultLocale') || 'en'
+    locale = 'locales.' + defaultLocale
+    Em.I18n.translations = RightnowOms.config.get(locale)
+
+
+RightnowOms.store = DS.Store.create
+  revision: 2
   adapter:
     DS.MyRESTAdapter.create
       bulkCommit: false
       namespace: 'rightnow_oms'
-
-window.RightnowOms.config = Em.Object.create()
-window.RightnowOms.config.set('autoCommit', true)

data/app/assets/javascripts/rightnow_oms/app/controllers/cart.js.coffee

@@ -1,6 +1,10 @@
 RightnowOms.cartController = Ember.Object.create
   store: RightnowOms.store
 
+  #find: (id) ->
+    #cart = @store.find(RightnowOms.Cart, id)
+    #@set('content', cart)
+
   load: (cart) ->
     RightnowOms.store.load(RightnowOms.Cart, cart.id, cart)
     @set('content', RightnowOms.store.find(RightnowOms.Cart, cart.id))
@@ -10,29 +14,13 @@ RightnowOms.cartController = Ember.Object.create
 
   # item: a hash
   addCartItem: (item) ->
+    cartItem = @get('content').findCartItemByCartable(item.cartable_id, item.cartable_type)
+    if cartItem && cartItem.isProcessing()
+      return alert(Em.I18n.t('alerts.saving_cart'))
+
     cartItem = @get('content').addCartItem(item)
     RightnowOms.commit()
-
-    return if !(item.children && item.children.length > 0)
-
-    self = @
-
-    addChildren = (parent, children) ->
-      children.forEach((c) ->
-        c.parent_id = parent.get('id')
-        self.addCartItem(c)
-      )
-
-    return addChildren(cartItem, item.children) if cartItem.get('id')?
-
-    afterCartItemCreated = ->
-      if (!cartItem.get('isDirty')) && (!cartItem.get('isDeleted'))
-        addChildren(cartItem, item.children)
-        cartItem.removeObserver('isDirty', afterCartItemCreated)
-        RightnowOms.commit(true) unless RightnowOms.config.get('autoCommit')
-
-    cartItem.addObserver('isDirty', afterCartItemCreated)
-
+  
   # @id: id of the cart item to be updated
   # @properties: a hash which is the new properties of the cart item.
   # 
@@ -43,27 +31,24 @@ RightnowOms.cartController = Ember.Object.create
   #   'quantity': 2
   # })
   updateCartItem: (id, properties) ->
-    if RightnowOms.CartItem.findById(id).isProcessing()
-      alert('正在保存购物车，请稍后。。。')
-      return
+    if @get('content').findCartItemById(id).isProcessing()
+      return alert(Em.I18n.t('alerts.saving_cart'))
 
     @get('content').updateCartItem(id, properties)
     RightnowOms.commit()
 
   increaseCartItem: (id) ->
-    if RightnowOms.CartItem.findById(id).isProcessing()
-      alert('正在保存购物车，请稍后。。。')
-      return
+    if @get('content').findCartItemById(id).isProcessing()
+      return alert(Em.I18n.t('alerts.saving_cart'))
 
     cartItem = @get('content').increaseCartItem(id)
     RightnowOms.commit(true)
 
   decreaseCartItem: (id) ->
-    cartItem = RightnowOms.CartItem.findById(id)
+    cartItem = @get('content').findCartItemById(id)
 
     if cartItem.isProcessing()
-      alert('正在保存购物车，请稍后。。。')
-      return
+      return alert(Em.I18n.t('alerts.saving_cart'))
 
     if cartItem.get('isDecreasable')
       @get('content').decreaseCartItem(id)
@@ -73,14 +58,14 @@ RightnowOms.cartController = Ember.Object.create
 
   removeCartItem: (id, silent) ->
     remove = true
-    remove = confirm('您确定要删除该商品吗？') unless silent
+    remove = confirm(Em.I18n.t('confirmations.delete_cart_item')) unless silent
 
     if remove
       @get('content').removeCartItem(id)
       RightnowOms.commit(true)
 
   cleanUp: ->
-    if confirm('您确定要清空您的购物车吗？')
+    if confirm(Em.I18n.t('confirmations.clean_up_cart'))
       @get('content').cleanUp()
       RightnowOms.commit(true)
 

data/app/assets/javascripts/rightnow_oms/app/models/cart.js.coffee

@@ -1,80 +1,102 @@
 RightnowOms.Cart = DS.Model.extend
-  cartItems: (->
-    RightnowOms.CartItem.all()
-  ).property()
+  cart_items: DS.hasMany('RightnowOms.CartItem', { embedded: true })
 
-  cartableCount: (->
+  # TODO Use cart_items instead
+  cartItems: Ember.computed(->
+    @get('cart_items')
+  ).property("cart_items")
+
+  cartableCount: Ember.computed(->
     count = 0
-    @get('cartItems').forEach (item) ->
+    @get('cart_items').forEach (item) ->
       count += item.get('quantity') unless item.get('hasParent')
 
     count
-  ).property("cartItems.@each.quantity")
+  ).property("cart_items.@each.quantity")
 
-  total: (->
+  total: Ember.computed(->
     total = 0
-    @get('cartItems').forEach (item) ->
+    @get('cart_items').forEach (item) ->
       total += item.get('price') * item.get('quantity') unless item.get('hasParent')
 
     round(total, 2)
-  ).property("cartItems.@each.quantity", "cartItems.@each.price")
+  ).property("cart_items.@each.quantity", "cart_items.@each.price")
 
   addCartItem: (item) ->
     return @createCartItem(item) if item.mergable == false
 
-    cartItem = RightnowOms.CartItem.findByCartableAndParentId(item.cartable_id, item.cartable_type, item.parent_id)
+    cartItem = @findCartItemByCartable(item.cartable_id, item.cartable_type)
 
-    if cartItem?
-      cartItem.increase() unless cartItem.get('parent')?
+    if cartItem? && !cartItem.get('hasParent')
+      cartItem.increase()
     else
       cartItem = @createCartItem(item)
 
     cartItem
 
   createCartItem: (item)->
-    cartItem = RightnowOms.store.createRecord(RightnowOms.CartItem, item)
+    cartItem = RightnowOms.CartItem.createRecord(item)
+    @get('cart_items').pushObject(cartItem)
+
+    return cartItem if !(item.children && item.children.length > 0)
+
+    return cartItem.addChild(c) for c in item.children if cartItem.get('id')?
 
-    if cartItem.get('hasParent')
-      cartItem.get('parent').set('children', RightnowOms.CartItem.findByParentId(cartItem.get('id')))
+    afterCartItemCreated = ->
+      if (!cartItem.get('isDirty')) && (!cartItem.get('isDeleted'))
+        cartItem.addChild(c) for c in item.children
+        cartItem.removeObserver('isDirty', afterCartItemCreated)
+        RightnowOms.commit(true) if RightnowOms.config.get('autoCommit')
+
+    cartItem.addObserver('isDirty', afterCartItemCreated)
 
     cartItem
 
   updateCartItem: (id, properties) ->
-    cartItem = RightnowOms.CartItem.findById(id)
+    cartItem = @findCartItemById(id)
     cartItem.setProperties(properties) if cartItem?
     
   cleanUp: ->
-    cartItemIds = @get('cartItems').map (item) ->
+    cartItemIds = @get('cart_items').map (item) ->
       return item.get('id')
 
+    self = @
     cartItemIds.forEach (id) ->
-      item = RightnowOms.CartItem.findById(id)
-
-      # INFO Children will be deleted when the parent is deleted
-      item.deleteRecord() if item && !item.get('hasParent')
+      self.removeCartItem(id)
 
   removeCartItem: (id) ->
-    cartItem = RightnowOms.CartItem.findById(id)
-    
+    cartItem = @findCartItemById(id)
+    @get('cart_items').removeObject(cartItem)
     cartItem.deleteRecord() if cartItem?
 
     cartItem
 
   increaseCartItem: (id) ->
-    cartItem = RightnowOms.CartItem.findById(id)
-
+    cartItem = @findCartItemById(id)
     cartItem.increase()
+
     cartItem
 
   decreaseCartItem: (id) ->
-    cartItem = RightnowOms.CartItem.findById(id)
-
+    cartItem = @findCartItemById(id)
     cartItem.decrease()
+
     cartItem
 
+  # TODO Rename to findAllCartItemsInGroup()
   findCartItemsByGroup: (group) ->
-    @get('cartItems').filter (item) ->
+    @get('cart_items').filter (item) ->
       return true if item.get('group') == group
 
+  # @private
+  findCartItemById: (id) ->
+    @get('cart_items').filterProperty('id', id)[0]
+
+  # @private
+  findCartItemByCartable: (cartableId, cartableType) ->
+    @get('cart_items').filter((item) ->
+      return true if item.get('cartable_id') == cartableId && item.get('cartable_type') == cartableType
+    ).get('firstObject')
+
 RightnowOms.Cart.reopenClass
   isSingleton: true