trollied 0.1.0

data/app/views/line_items/_line_item.html.erb

@@ -0,0 +1,12 @@
+<tr>
+  <td><%= link_to_purchasable_in(line_item) -%></td>
+  <%  if can_delete_line_item?(order) -%>
+  <td>
+    <%= link_to t('line_items.line_item.delete'), { :controller => :orders,
+    :action => :destroy,
+    :id => line_item,
+    :order_id => order,
+    :trolley_id => trolley },
+    :confirm => t('line_items.line_item.are_you_sure'), :method => :delete %></td>
+  <% end -%>
+</tr>

data/app/views/line_items/new.html.erb

@@ -0,0 +1,11 @@
+<% @button_text = t("line_items.new.confirm") 
+   @title = t("line_items.new.confirm_order")
+-%>
+
+<h1><%= @title -%></h1>
+
+<% form_for([@purchasable_item, @line_item]) do |f| %>
+
+<%= render :partial => f -%>
+
+<% end %>

data/app/views/notes/_form.html.erb

@@ -0,0 +1,7 @@
+<%= form.error_messages %>
+
+<%= form.hidden_field :user_id, :value => user.id  -%>
+
+<%= form.text_area :body, { :cols => 90, :rows => 5 } %>
+
+<%= form.submit t(".send") %>

data/app/views/notes/_new.html.erb

@@ -0,0 +1,14 @@
+<% note ||= order.notes.new
+   add_note_msg = t('.add_note_to_order_for_user')
+   add_note_msg = t('.add_note_to_order_for_admin') unless current_user == order.user  -%>
+
+<div class="note-form" id="note-form-for-<%= order.id -%>">
+
+<h4><%= add_note_msg -%></h4>
+
+<% form_for([order, note]) do |f| %>
+
+<%= render :partial => 'notes/form', :locals => { :form => f, :user => current_user } -%>
+
+<% end %>
+</div>

data/app/views/notes/_note.html.erb

@@ -0,0 +1,4 @@
+<li class="note-body">
+  <%= link_to_profile_for(note.user) -%> <%= t '.said' -%>
+  <%= note.body -%>
+</li>

data/app/views/notes/index.html.erb

@@ -0,0 +1,13 @@
+<% @title = t(".title") -%>
+
+<h1><%= @title -%></h1>
+
+<% if @notes.size > 0 -%>
+  <h2><%= t(".notes") -%></h2>
+
+  <%= render @notes -%>
+
+<% else -%>
+  <p><%= t(".no_notes") %></p>
+<% end -%>
+

data/app/views/notes/new.html.erb

@@ -0,0 +1,5 @@
+<% @title = t(".title") -%>
+
+<h1><%= @title -%></h1>
+
+<% render :partial => 'new', :locals => { :order => @order, :note =>@note } -%>

data/app/views/orders/_date_pickers.html.erb

@@ -0,0 +1,15 @@
+<% if Order.count > 0 -%>
+  <div class="date-form">
+    <% form_tag url_for_options_for_orders_index, :method => 'get' do %>
+    <%= hidden_field_tag 'state', @state  if @state %>
+    <%= hidden_field_tag 'user', @user  if @user %>
+    <%= hidden_field_tag 'trolley_id', @trolley.id if @trolley %>
+
+    <label><%= t '.from'  -%></label>
+    <%= text_field_tag 'from', @from, :class => 'date-picker' %>
+    <label><%= t '.until' -%></label>
+    <%= text_field_tag 'until', @until, :class => 'date-picker' %>
+    <%= submit_tag t '.update' %>
+    <% end %>
+  </div>
+<% end -%>

data/app/views/orders/_order.html.erb

@@ -0,0 +1,53 @@
+<% trolley ||= order.trolley -%>
+
+<fieldset class="order">
+
+<% if params[:controller] == 'orders' -%>
+  <h3><%= t '.user' -%> <%= link_to_orders_for(order.user) -%></h3>
+<% end -%>
+
+<table class="order">
+  <tr>
+    <th abbr="Line Item"><%= t '.purchasable_item_description' %></th>
+  </tr>
+
+  <%= render :partial => 'line_items/line_item', :collection => order.line_items, :locals => { :order => order, :trolley => trolley } -%>
+
+  <% if order.current? -%>
+  <tr>
+    <td><%= button_to_checkout order -%></td>
+    <td><%= button_to_clear order -%></td>
+  </tr>
+  <% end -%>
+
+  <% if order.in_process? -%>
+  <tr>
+    <td><%= button_to_cancel order -%></td>
+  
+    <% if can_trigger_fulfilled_without_acceptance? -%>
+      <td><%= button_to_fulfilled_without_acceptance order -%></td>
+    <% end -%>
+  </tr>
+  <% end -%>
+
+  <% if order.ready? && can_trigger_finish? -%>
+  <tr>
+      <td><%= button_to_finish order -%></td>
+  </tr>
+  <% end -%>
+
+</table>
+
+</fieldset>
+
+<% if  order.notes.size != 0 -%>
+<h3><%= t('.order_notes')  -%></h3>
+ <% end -%>
+
+<ul class="notes" id="notes-for-<%= order.id -%>">
+  <% if order.notes.size != 0 -%>
+    <%= render :partial => 'notes/note', :collection => order.notes -%>
+  <% end -%>
+</ul>
+
+<%= render :partial => 'notes/new', :locals => { :order => order,  :user => current_user } if order.may_note? -%>

data/app/views/orders/index.html.erb

@@ -0,0 +1,22 @@
+<% @title = t("orders.index.title") -%>
+
+<h1><%= @title -%></h1>
+
+<% if Order.count > 0 -%>
+  <h3><%= t '.filters' -%></h3>
+<% end -%>
+
+<%= state_links -%>
+<%= render :partial => 'date_pickers' -%>
+
+<% if @orders.size > 0 -%>
+
+  <h2><%= orders_state_headline -%><%= clear_extra_params -%></h2>
+
+  <%= render :partial => 'orders/order', :collection => @orders, :locals => { :trolley => @trolley, :status => @state } -%>
+  
+  <div id="prev-next"><%= will_paginate @orders, :params => params %></div>
+<% else -%>
+  <p><%= t("orders.index.no_orders") %></p>
+<% end -%>
+

data/app/views/orders/show.html.erb

@@ -0,0 +1,14 @@
+<%
+   if current_user == @order.user
+     @title = t(".your_order")
+   else
+   # TODO: interpolate user name
+   # (means name method has to be implemented for user model)
+     @title = t(".for_user_title", :name => @order.user.trolley_user_display_name)
+   end
+-%>
+
+<h1><%= @title -%></h1>
+
+<%= render @order -%>
+

data/app/views/trolleys/_orders.html.erb

@@ -0,0 +1,13 @@
+<% if @trolley.orders.send("with_state_#{status}".to_sym).size > 0 -%>
+
+  <h2><%= t("trolleys.orders.#{status}") -%></h2>
+
+  <%= render :partial => 'orders/order',
+  :collection => @trolley.orders.send("with_state_#{status}"),
+  :locals => { :trolley => trolley, :status => status } -%>
+
+<% elsif status == 'current' -%>
+  <h2><%= t("trolleys.orders.current") -%></h2>
+  <p><%= t("trolleys.orders.none_pending") %></p>
+<% end -%>
+

data/app/views/trolleys/show.html.erb

@@ -0,0 +1,16 @@
+<%
+   if current_user == @trollied_user
+     @title = t(".your_title")
+   else
+   # TODO: interpolate user name
+   # (means name method has to be implemented for user model)
+     @title = t(".for_user_title", :name => @trollied_user.trolley_user_display_name)
+   end
+-%>
+
+<h1><%= @title -%></h1>
+
+<% %w(current user_review ready in_process completed).each do |status| -%>
+  <%= render :partial => 'orders', :locals => { :status => status, :trolley => @trolley } -%>
+<% end -%>
+

data/config/locales/en.yml

@@ -0,0 +1,115 @@
+en:
+  base:
+    cart: "cart"
+    shopping_cart: "shopping cart"
+  line_item:
+    already_in_order: "has already been placed"
+  line_items:
+    new:
+      confirm: "Confirm"
+      confirm_order: "Confirm Order"
+    edit:
+      update: "Update"
+    form:
+    helpers:
+    index:
+      are_you_sure: "Are you sure?"
+      back: "Back"
+      delete: "Delete"
+      edit: "Edit"
+      new: "New Line Item"
+    line_item:
+      delete: "Delete"
+      are_you_sure: "Are you sure?"
+    show:
+      edit: "Edit"
+      translations: "Translations"
+    controllers:
+      created: "Added to order"
+      updated: "Updated in order"
+      deleted: "Deleted from order"
+  notes:
+    controllers:
+      created: "Note created."
+    form:
+      send: "Send"
+    note:
+      said: "said"
+    new:
+      add_note_to_order_for_admin: "Add a note about this order for staff."
+      add_note_to_order_for_user: "Add a note about this order for the order's owner."
+  orders:
+    edit:
+      update: "Update"
+    date_pickers:
+      from: "From:"
+      until: "Until:"
+      update: "Update wth Date Filter"
+    form:
+    helpers:
+      by: "by"
+      cancelled_orders: "Cancelled Orders"
+      clear_params: "clear extra settings"
+      completed_orders: "Completed Orders"
+      current_orders: "Current Orders"
+      from: "from"
+      in_process_orders: "Orders Awaiting processing"
+      ready_orders: "Ready Orders"
+      until: "until"
+      user_review_orders: "Orders needing user attention"
+    index:
+      are_you_sure: "Are you sure?"
+      back: "Back"
+      cancelled: "cancelled"
+      completed: "completed"
+      current: "current"
+      delete: "Delete"
+      edit: "Edit"
+      filters: "Filters:"
+      in_process: "Awaiting processing"
+      new: "New Order"
+      no_orders: "No orders match your criteria."
+      ready: "ready"
+      title: "Orders"
+      user_review: "needing user attention"
+    new:
+      create: "Create"
+    order:
+      are_you_sure: "Are you sure?"
+      cancel: "Cancel"
+      checkout: "Checkout"
+      destroy: "Clear all"
+      finish: "Mark as completed"
+      fulfilled_without_acceptance: "Mark as ready"
+      order_notes: "Notes for this order:"
+      purchasable_item_description: "Item"
+      user: "User:"
+    show:
+      your_title: "Your Order"
+      for_user_title: "Order for {{name}}"
+    controllers:
+      change_to_cancel: "Order Cancelled"
+      change_to_checkout: "Order Checked Out"
+      change_to_finish: "Order Completed"
+      change_to_fulfilled_without_acceptance: "Order Ready"
+      created: "Created order"
+      updated: "Updated order"
+      deleted: "Deleted order"
+      checkout: "Your order has now been placed."
+  trolleys:
+    helpers:
+    orders:
+      cancelled: "Cancelled Orders"
+      completed: "Completed Orders"
+      current: "Current Orders"
+      in_process: "Awaiting processing"
+      none_pending: "No orders pending."
+      ready: "Ready Orders"
+      user_review: "Orders needing your attention"
+    show:
+      your_title: "Your Cart"
+      for_user_title: "Cart for {{name}}"
+    controllers:
+  gets_trollied_helper:
+    add_to_trolley: "+ Add to cart"
+    in_trolley: "Previously added to cart"

data/config/routes.rb

@@ -0,0 +1,8 @@
+members = Order.workflow_event_names.inject(Hash.new) do |hash, event_name|
+  hash[event_name.to_sym] = :post
+  hash
+end
+
+ActionController::Routing::Routes.draw do |map|
+  map.resources :orders, :member => members, :except => [:new, :create], :has_many => :line_items, :has_many => :notes
+end

data/generators/trollied_migrations/USAGE

@@ -0,0 +1,2 @@
+Description:
+	Generates the migrations necessary for using the trollied gem in your Ruby on Rails application. Namely trolley, order, and line item.

data/generators/trollied_migrations/templates/line_items_migration.rb

@@ -0,0 +1,16 @@
+class CreateLineItems < ActiveRecord::Migration
+  def self.up
+    create_table :line_items do |t|
+      t.integer :order_id, :null => false
+      t.integer :purchasable_item_id, :null => false #, :references => nil this may blow up
+      t.string  :purchasable_item_type, :null => false
+
+      t.timestamps
+    end
+
+  end
+
+  def self.down
+    drop_table :line_items
+  end
+end

data/generators/trollied_migrations/templates/notes_migration.rb

@@ -0,0 +1,15 @@
+class CreateNotes < ActiveRecord::Migration
+  def self.up
+    create_table :notes do |t|
+      t.integer :order_id, :user_id, :null => false
+      t.string :body, :null => false
+
+      t.timestamps
+    end
+
+  end
+
+  def self.down
+    drop_table :notes
+  end
+end

data/generators/trollied_migrations/templates/orders_migration.rb

@@ -0,0 +1,15 @@
+class CreateOrders < ActiveRecord::Migration
+  def self.up
+    create_table :orders do |t|
+      t.integer :trolley_id, :null => false
+      t.string :workflow_state, :default => 'current', :null => false
+
+      t.timestamps
+    end
+
+  end
+
+  def self.down
+    drop_table :orders
+  end
+end

data/generators/trollied_migrations/templates/trolleys_migration.rb

@@ -0,0 +1,14 @@
+class CreateTrolleys < ActiveRecord::Migration
+  def self.up
+    create_table :trolleys do |t|
+      t.integer :user_id, :null => false
+
+      t.timestamps
+    end
+
+  end
+
+  def self.down
+    drop_table :trolleys
+  end
+end

data/generators/trollied_migrations/trollied_migrations_generator.rb

@@ -0,0 +1,13 @@
+class TrolliedMigrationsGenerator < Rails::Generator::Base
+  def manifest
+    record do |m|
+      m.migration_template 'trolleys_migration.rb', 'db/migrate', { :migration_file_name => "create_trolleys" }
+      m.sleep(1)
+      m.migration_template 'orders_migration.rb', 'db/migrate', { :migration_file_name => "create_orders" }
+      m.sleep(1)
+      m.migration_template 'line_items_migration.rb', 'db/migrate', { :migration_file_name => "create_line_items" }
+      m.sleep(1)
+      m.migration_template 'notes_migration.rb', 'db/migrate', { :migration_file_name => "create_notes" }
+    end
+  end
+end

data/lib/gets_trollied.rb

@@ -0,0 +1,38 @@
+# -*- coding: utf-8 -*-
+require "active_record"
+
+module GetsTrollied
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  module ClassMethods
+    def set_up_to_get_trollied(*args)
+      options = args.last.is_a?(Hash) ? args.pop : Hash.new
+
+      # don't allow multiple calls
+      return if self.included_modules.include?(GetsTrollied::InstanceMethods)
+
+      send :include, GetsTrollied::InstanceMethods
+
+      send :has_many, :line_items, :as => :purchasable_item, :dependent => :destroy
+
+      cattr_accessor :described_as_when_purchasing
+      self.described_as_when_purchasing = options[:described_as] || :name
+
+      cattr_accessor :as_foreign_key_sym
+      self.as_foreign_key_sym = self.name.foreign_key.to_sym
+    
+    end
+  end
+
+  module InstanceMethods
+    def place_in(trolley)
+      trolley.add(self)
+    end
+
+    def description_for_purchasing
+      send(self.class.described_as_when_purchasing)
+    end
+  end
+end

data/lib/gets_trollied_controller_helpers.rb

@@ -0,0 +1,29 @@
+module GetsTrolliedControllerHelpers
+  def self.included(klass)
+    klass.send :helper_method, :url_for_purchasable_item, :target_action, :target_controller
+  end
+
+  def target_controller(options = {})
+    purchasable_item_params_name = options.delete(:purchasable_item_params_name) || @purchasable_item_params_name
+    options.delete(:controller) || purchasable_item_params_name.pluralize || params[:controller]
+  end
+
+  def target_action(options = {})
+    options.delete(:action) || 'show'
+  end
+
+  def target_id(options = {})
+    purchasable_item = options.delete(:purchasable_item) || @purchasable_item
+    options.delete(:id) || purchasable_item
+  end
+
+  def url_for_purchasable_item(options = { })
+    defaults = {
+      :controller => target_controller(options),
+      :action => target_action(options),
+      :id => target_id(options)
+    }
+
+    url_for(defaults.merge(options))
+  end
+end

data/lib/has_trolley.rb

@@ -0,0 +1,42 @@
+# -*- coding: utf-8 -*-
+require "active_record"
+
+module HasTrolley
+  def self.included(klass)
+    klass.send :has_one, :trolley, :dependent => :destroy
+    klass.send :delegate, :correct_order, :to => :trolley
+    klass.send :after_create, :create_trolley
+    klass.extend ClassMethods
+    klass.send :include, InstanceMethods
+  end
+  
+  module ClassMethods
+    def add_trolleys_for_existing
+      all.each { |u| u.create_trolley }
+    end
+  end
+
+  module InstanceMethods
+    # implement in your application if you have another method name
+    # besides these common ones
+    # WARNING: potential security issue, definitely override
+    # if any of these options are sensitive
+    def trolley_user_display_name
+      if respond_to?(:display_name)
+        display_name
+      elsif respond_to?(:name)
+        name
+      elsif respond_to?(:username)
+        username
+      elsif respond_to?(:nickname)
+        nickname
+      end
+    end
+
+    private
+    
+    def create_trolley
+      Trolley.create!(:user => self)
+    end
+  end
+end

data/lib/has_trolley_controller_helpers.rb

@@ -0,0 +1,43 @@
+module HasTrolleyControllerHelpers
+  def self.included(klass)
+    klass.send :helper_method, :url_for_trolley
+    klass.send :include, UrlFor
+  end
+  
+  module UrlFor
+    # expects user in options or @user or trolley being set
+    def url_for_trolley(options = { })
+      user = options[:user] || @user
+      user = @trolley.user if @trolley && user.blank?
+
+      trolley = options[:trolley] || @trolley || user.trolley
+
+      # TODO: Hack, not sure if this is 2.3.5 bug or my ignorance
+      # but url_for returns marshalled trolley, in addition to correct url
+      url = url_for(:user_id => user.id,
+                    :controller => :trolleys,
+                    :action => :show).split(".%23%")[0]
+    end
+
+    # expects order
+    # either as instance variables or in options
+    def url_for_order(options = { })
+      trolley = options[:trolley] || @trolley
+      trolley = @order.trolley if @order && trolley.blank?
+
+      order = options[:order] || @order || trolley.selected_order
+      
+      url_for [trolley.user, trolley, order]
+    end
+
+    def url_for_order_or_trolley
+      raise unless @order
+
+      if @order.user == current_user
+        url_for_trolley :trolley => @order.trolley
+      else
+        url_for_order
+      end
+    end
+  end
+end