trollied 0.1.0

data/lib/order_status.rb

@@ -0,0 +1,121 @@
+# off the top of my head possible states:
+# current (i.e. user building order)
+# ordered (i.e. user checkout)
+# queued (first phase of user checkout)
+# payment_pending (system) - to be defined in module
+# payment_received (system) - to be defined in module
+# orderd (system)
+# in_process (being prepared by staff)
+# altered (staff altered, awaiting user approval)
+# alteration_approved (user approves staff alteration)
+# cancelled (user or staff)
+# fulfilled (staff)
+# ready_to_be_shipped
+# shipped (staff) - to be defined in module
+# received (user) - to be defined in module
+# completed (system or staff)
+module OrderStatus
+  def self.included(klass)
+    klass.extend ClassMethods
+
+    klass.class_eval do
+      include Workflow
+
+      workflow do
+        state :current do
+          # event :checkout, :transitions_to => :ordered
+          event :checkout, :transitions_to => :in_process
+        end
+
+        # anticipating an interim step between checkout
+        # and the system queueing the order for fulfillment
+        # in the future, other events, such as "pay", "shipping_info_added"
+        # might be added here
+        # state :ordered do
+        # event :queue, :transitions_to => :in_process
+        # end
+
+        state :in_process do
+          event :cancel, :transition_to => :cancelled
+          event :alter, :transitions_to => :user_review
+          event :accept, :transitions_to => :accepted
+          event :fulfilled_without_acceptance, :transitions_to => :ready
+        end
+
+        state :user_review do
+          event :alteration_approve, :transitions_to => :in_process
+        end
+        
+        state :accepted do
+          event :fulfilled, :transitions_to => :ready
+          event :complete, :transitions_to => :completed
+        end
+
+        state :ready do
+          event :finish, :transitions_to => :completed
+        end
+
+        state :cancelled
+        state :completed
+      end
+
+      # create a named_scope for each of our declared states
+      workflow_spec.state_names.each do |name|
+        scope_name = "with_state_#{name}".to_sym
+        named_scope scope_name, :conditions => { :workflow_state => name.to_s }
+      end
+
+      # in(state_name)
+      named_scope :in, lambda { |*args|
+        options = args.last.is_a?(Hash) ? args.pop : Hash.new
+        state = args.is_a?(Array) ? args.first : args
+
+        if state == 'all'
+          options
+        else
+          { :conditions => { :workflow_state => state.to_s }.merge(options) }
+        end
+      }
+
+      def state_ok_to_delete_line_item?
+        return false if %w(user_review cancelled completed ready).include?(workflow_state)
+        true
+      end
+
+      # write methods named the same as your states
+      # to handle things like notifications in your apps
+      # when your order moves to that particular state 
+
+
+      def new_note(note)
+        # trigger transition to user_review state if note is added to ready or in_process order
+        alter! if !user_review? && note.user != user
+      end
+    end
+  end
+
+  module ClassMethods
+    # returns a Hash where keys are event name and values are event object
+    def workflow_events
+      events = workflow_spec.states.values.collect &:events
+
+      # skip blank values
+      events = events.select { |e| e.present? }
+
+      # flatten
+      events_hash = Hash.new
+      events.each do |v|
+        v.each do |key,value|
+          events_hash[key] = value
+        end
+      end
+
+      events_hash
+    end
+
+    def workflow_event_names
+      workflow_events.keys
+    end
+  end
+end
+

data/lib/trollied.rb

@@ -0,0 +1,5 @@
+require 'gets_trollied'
+require 'gets_trollied_controller_helpers'
+require 'has_trolley'
+require 'has_trolley_controller_helpers'
+require 'order_status'

data/rails/init.rb

@@ -0,0 +1,10 @@
+require 'workflow'
+
+ActionController::Base.send(:include, GetsTrolliedControllerHelpers)
+ActionController::Base.send(:include, HasTrolleyControllerHelpers)
+ActionController::Base.send(:helper, GetsTrolliedHelper)
+ActionController::Base.send(:helper, OrdersHelper)
+ActionController::Base.send(:helper, LineItemsHelper)
+
+# load our locales
+I18n.load_path += Dir[ File.join(File.dirname(__FILE__), '..', 'config', 'locales', '*.{rb,yml}') ]

data/test/full_2_3_5_app_with_tests/.gitignore

@@ -0,0 +1,27 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+webrat*
+test.sqlite3
+test/debug.log
+db/development.sqlite3
+db/test.sqlite3
+log/*.log

data/test/full_2_3_5_app_with_tests/README

@@ -0,0 +1 @@
+This is a full Rails app used to test the gem's functionality.

data/test/full_2_3_5_app_with_tests/Rakefile

@@ -0,0 +1,10 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require(File.join(File.dirname(__FILE__), 'config', 'boot'))
+
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+require 'tasks/rails'

data/test/full_2_3_5_app_with_tests/app/controllers/application_controller.rb

@@ -0,0 +1,14 @@
+# Filters added to this controller apply to all controllers in the application.
+# Likewise, all the methods added will be available for all controllers.
+
+class ApplicationController < ActionController::Base
+  helper :all # include all helpers, all the time
+  protect_from_forgery # See ActionController::RequestForgeryProtection for details
+
+  # for now, for testing purposes, just returns a user
+  def current_user
+    User.first || User.create!(:name => "Franz Ficklestein")
+  end
+
+  helper_method :current_user
+end

data/test/full_2_3_5_app_with_tests/app/controllers/items_controller.rb

@@ -0,0 +1,85 @@
+class ItemsController < ApplicationController
+  # GET /items
+  # GET /items.xml
+  def index
+    @items = Item.all
+
+    respond_to do |format|
+      format.html # index.html.erb
+      format.xml  { render :xml => @items }
+    end
+  end
+
+  # GET /items/1
+  # GET /items/1.xml
+  def show
+    @item = Item.find(params[:id])
+
+    respond_to do |format|
+      format.html # show.html.erb
+      format.xml  { render :xml => @item }
+    end
+  end
+
+  # GET /items/new
+  # GET /items/new.xml
+  def new
+    @item = Item.new
+
+    respond_to do |format|
+      format.html # new.html.erb
+      format.xml  { render :xml => @item }
+    end
+  end
+
+  # GET /items/1/edit
+  def edit
+    @item = Item.find(params[:id])
+  end
+
+  # POST /items
+  # POST /items.xml
+  def create
+    @item = Item.new(params[:item])
+
+    respond_to do |format|
+      if @item.save
+        flash[:notice] = 'Item was successfully created.'
+        format.html { redirect_to(@item) }
+        format.xml  { render :xml => @item, :status => :created, :location => @item }
+      else
+        format.html { render :action => "new" }
+        format.xml  { render :xml => @item.errors, :status => :unprocessable_entity }
+      end
+    end
+  end
+
+  # PUT /items/1
+  # PUT /items/1.xml
+  def update
+    @item = Item.find(params[:id])
+
+    respond_to do |format|
+      if @item.update_attributes(params[:item])
+        flash[:notice] = 'Item was successfully updated.'
+        format.html { redirect_to(@item) }
+        format.xml  { head :ok }
+      else
+        format.html { render :action => "edit" }
+        format.xml  { render :xml => @item.errors, :status => :unprocessable_entity }
+      end
+    end
+  end
+
+  # DELETE /items/1
+  # DELETE /items/1.xml
+  def destroy
+    @item = Item.find(params[:id])
+    @item.destroy
+
+    respond_to do |format|
+      format.html { redirect_to(items_url) }
+      format.xml  { head :ok }
+    end
+  end
+end

data/test/full_2_3_5_app_with_tests/app/controllers/user_controller.rb

@@ -0,0 +1,2 @@
+class UserController < ApplicationController
+end

data/test/full_2_3_5_app_with_tests/app/helpers/application_helper.rb

@@ -0,0 +1,3 @@
+# Methods added to this helper will be available to all templates in the application.
+module ApplicationHelper
+end

data/test/full_2_3_5_app_with_tests/app/helpers/items_helper.rb

@@ -0,0 +1,2 @@
+module ItemsHelper
+end

data/test/full_2_3_5_app_with_tests/app/helpers/user_helper.rb

@@ -0,0 +1,2 @@
+module UserHelper
+end

data/test/full_2_3_5_app_with_tests/app/models/item.rb

@@ -0,0 +1,4 @@
+class Item < ActiveRecord::Base
+  include GetsTrollied
+  set_up_to_get_trollied :described_as => :label
+end

data/test/full_2_3_5_app_with_tests/app/models/user.rb

@@ -0,0 +1,3 @@
+class User < ActiveRecord::Base
+  include HasTrolley
+end

data/test/full_2_3_5_app_with_tests/app/views/items/edit.html.erb

@@ -0,0 +1,20 @@
+<h1>Editing item</h1>
+
+<% form_for(@item) do |f| %>
+  <%= f.error_messages %>
+
+  <p>
+    <%= f.label :label %><br />
+    <%= f.text_field :label %>
+  </p>
+  <p>
+    <%= f.label :value %><br />
+    <%= f.text_field :value %>
+  </p>
+  <p>
+    <%= f.submit 'Update' %>
+  </p>
+<% end %>
+
+<%= link_to 'Show', @item %> |
+<%= link_to 'Back', items_path %>

data/test/full_2_3_5_app_with_tests/app/views/items/index.html.erb

@@ -0,0 +1,22 @@
+<h1>Listing items</h1>
+
+<table>
+  <tr>
+    <th>Label</th>
+    <th>Value</th>
+  </tr>
+
+<% @items.each do |item| %>
+  <tr>
+    <td><%=h item.label %></td>
+    <td><%=h item.value %></td>
+    <td><%= link_to 'Show', item %></td>
+    <td><%= link_to 'Edit', edit_item_path(item) %></td>
+    <td><%= link_to 'Destroy', item, :confirm => 'Are you sure?', :method => :delete %></td>
+  </tr>
+<% end %>
+</table>
+
+<br />
+
+<%= link_to 'New item', new_item_path %>

data/test/full_2_3_5_app_with_tests/app/views/items/new.html.erb

@@ -0,0 +1,19 @@
+<h1>New item</h1>
+
+<% form_for(@item) do |f| %>
+  <%= f.error_messages %>
+
+  <p>
+    <%= f.label :label %><br />
+    <%= f.text_field :label %>
+  </p>
+  <p>
+    <%= f.label :value %><br />
+    <%= f.text_field :value %>
+  </p>
+  <p>
+    <%= f.submit 'Create' %>
+  </p>
+<% end %>
+
+<%= link_to 'Back', items_path %>

data/test/full_2_3_5_app_with_tests/app/views/items/show.html.erb

@@ -0,0 +1,13 @@
+<p>
+  <b>Label:</b>
+  <%=h @item.label %>
+</p>
+
+<p>
+  <b>Value:</b>
+  <%=h @item.value %>
+</p>
+
+<%= link_to 'Edit', edit_item_path(@item) %> |
+<%= link_to 'Back', items_path %> |
+<%= in_trolley_status_or_button_to_place_in_trolley(@item) -%>

data/test/full_2_3_5_app_with_tests/app/views/layouts/application.html.erb

@@ -0,0 +1,19 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+       "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <meta http-equiv="content-type" content="text/html;charset=UTF-8" />
+  <title><%= @title -%></title>
+  <%= yield :add_on_scripts_and_links %>
+  <%= stylesheet_link_tag 'scaffold' %>
+  <%= javascript_include_tag :defaults %>
+</head>
+<body>
+
+<p style="color: green"><%= flash[:notice] %></p>
+
+<%= yield %>
+
+</body>
+</html>

data/test/full_2_3_5_app_with_tests/app/views/layouts/items.html.erb

@@ -0,0 +1,19 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+       "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <meta http-equiv="content-type" content="text/html;charset=UTF-8" />
+  <title>Items: <%= controller.action_name %></title>
+  <%= yield :add_on_scripts_and_links %>
+  <%= stylesheet_link_tag 'scaffold' %>
+  <%= javascript_include_tag :defaults %>
+</head>
+<body>
+
+<p style="color: green"><%= flash[:notice] %></p>
+
+<%= yield %>
+
+</body>
+</html>

data/test/full_2_3_5_app_with_tests/config/boot.rb

@@ -0,0 +1,110 @@
+# Don't change this file!
+# Configure your app in config/environment.rb and config/environments/*.rb
+
+RAILS_ROOT = "#{File.dirname(__FILE__)}/.." unless defined?(RAILS_ROOT)
+
+module Rails
+  class << self
+    def boot!
+      unless booted?
+        preinitialize
+        pick_boot.run
+      end
+    end
+
+    def booted?
+      defined? Rails::Initializer
+    end
+
+    def pick_boot
+      (vendor_rails? ? VendorBoot : GemBoot).new
+    end
+
+    def vendor_rails?
+      File.exist?("#{RAILS_ROOT}/vendor/rails")
+    end
+
+    def preinitialize
+      load(preinitializer_path) if File.exist?(preinitializer_path)
+    end
+
+    def preinitializer_path
+      "#{RAILS_ROOT}/config/preinitializer.rb"
+    end
+  end
+
+  class Boot
+    def run
+      load_initializer
+      Rails::Initializer.run(:set_load_path)
+    end
+  end
+
+  class VendorBoot < Boot
+    def load_initializer
+      require "#{RAILS_ROOT}/vendor/rails/railties/lib/initializer"
+      Rails::Initializer.run(:install_gem_spec_stubs)
+      Rails::GemDependency.add_frozen_gem_path
+    end
+  end
+
+  class GemBoot < Boot
+    def load_initializer
+      self.class.load_rubygems
+      load_rails_gem
+      require 'initializer'
+    end
+
+    def load_rails_gem
+      if version = self.class.gem_version
+        gem 'rails', version
+      else
+        gem 'rails'
+      end
+    rescue Gem::LoadError => load_error
+      $stderr.puts %(Missing the Rails #{version} gem. Please `gem install -v=#{version} rails`, update your RAILS_GEM_VERSION setting in config/environment.rb for the Rails version you do have installed, or comment out RAILS_GEM_VERSION to use the latest version installed.)
+      exit 1
+    end
+
+    class << self
+      def rubygems_version
+        Gem::RubyGemsVersion rescue nil
+      end
+
+      def gem_version
+        if defined? RAILS_GEM_VERSION
+          RAILS_GEM_VERSION
+        elsif ENV.include?('RAILS_GEM_VERSION')
+          ENV['RAILS_GEM_VERSION']
+        else
+          parse_gem_version(read_environment_rb)
+        end
+      end
+
+      def load_rubygems
+        min_version = '1.3.2'
+        require 'rubygems'
+        unless rubygems_version >= min_version
+          $stderr.puts %Q(Rails requires RubyGems >= #{min_version} (you have #{rubygems_version}). Please `gem update --system` and try again.)
+          exit 1
+        end
+
+      rescue LoadError
+        $stderr.puts %Q(Rails requires RubyGems >= #{min_version}. Please install RubyGems and try again: http://rubygems.rubyforge.org)
+        exit 1
+      end
+
+      def parse_gem_version(text)
+        $1 if text =~ /^[^#]*RAILS_GEM_VERSION\s*=\s*["']([!~<>=]*\s*[\d.]+)["']/
+      end
+
+      private
+        def read_environment_rb
+          File.read("#{RAILS_ROOT}/config/environment.rb")
+        end
+    end
+  end
+end
+
+# All that for this:
+Rails.boot!

data/test/full_2_3_5_app_with_tests/config/database.yml

@@ -0,0 +1,22 @@
+# SQLite version 3.x
+#   gem install sqlite3-ruby (not necessary on OS X Leopard)
+development:
+  adapter: sqlite3
+  database: db/development.sqlite3
+  pool: 5
+  timeout: 5000
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  adapter: sqlite3
+  database: db/test.sqlite3
+  pool: 5
+  timeout: 5000
+
+production:
+  adapter: sqlite3
+  database: db/production.sqlite3
+  pool: 5
+  timeout: 5000

data/test/full_2_3_5_app_with_tests/config/environment.rb

@@ -0,0 +1,57 @@
+# Be sure to restart your server when you modify this file
+
+# Specifies gem version of Rails to use when vendor/rails is not present
+RAILS_GEM_VERSION = '2.3.5' unless defined? RAILS_GEM_VERSION
+
+# Bootstrap the Rails environment, frameworks, and default configuration
+require File.join(File.dirname(__FILE__), 'boot')
+
+# thanks to http://www.justinball.com/2009/06/16/testing-rails-engine-gems/
+class TestGemLocator < Rails::Plugin::Locator
+  def plugins
+    Rails::Plugin.new(File.join(File.dirname(__FILE__), *%w(.. .. ..)))
+  end 
+end
+
+Rails::Initializer.run do |config|
+  # Settings in config/environments/* take precedence over those specified here.
+  # Application configuration should go into files in config/initializers
+  # -- all .rb files in that directory are automatically loaded.
+
+  # Add additional load paths for your own custom dirs
+  # config.load_paths += %W( #{RAILS_ROOT}/extras )
+
+  # Specify gems that this application depends on and have them installed with rake gems:install
+  # config.gem "bj"
+  # config.gem "hpricot", :version => '0.6', :source => "http://code.whytheluckystiff.net"
+  # config.gem "sqlite3-ruby", :lib => "sqlite3"
+  # config.gem "aws-s3", :lib => "aws/s3"
+  # this allows us to place locale in URL
+  # without messing with the rest of the rails routing mechanism
+  # config.gem "routing_filter" # using plugin for the moment
+  # config.gem "mongo_translatable"
+  config.plugin_locators << TestGemLocator
+
+  # config.gem "trollied"
+  config.gem "will_paginate"
+
+  # Only load the plugins named here, in the order given (default is alphabetical).
+  # :all can be used as a placeholder for all plugins not explicitly named
+  # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
+
+  # Skip frameworks you're not going to use. To use Rails without a database,
+  # you must remove the Active Record framework.
+  # config.frameworks -= [ :active_record, :active_resource, :action_mailer ]
+
+  # Activate observers that should always be running
+  # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
+
+  # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+  # Run "rake -D time" for a list of tasks for finding time zone names.
+  config.time_zone = 'UTC'
+
+  # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+  # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}')]
+  # config.i18n.default_locale = :de
+end
+

data/test/full_2_3_5_app_with_tests/config/environments/development.rb

@@ -0,0 +1,17 @@
+# Settings specified here will take precedence over those in config/environment.rb
+
+# In the development environment your application's code is reloaded on
+# every request.  This slows down response time but is perfect for development
+# since you don't have to restart the webserver when you make code changes.
+config.cache_classes = false
+
+# Log error messages when you accidentally call methods on nil.
+config.whiny_nils = true
+
+# Show full error reports and disable caching
+config.action_controller.consider_all_requests_local = true
+config.action_view.debug_rjs                         = true
+config.action_controller.perform_caching             = false
+
+# Don't care if the mailer can't send
+config.action_mailer.raise_delivery_errors = false

data/test/full_2_3_5_app_with_tests/config/environments/production.rb

@@ -0,0 +1,28 @@
+# Settings specified here will take precedence over those in config/environment.rb
+
+# The production environment is meant for finished, "live" apps.
+# Code is not reloaded between requests
+config.cache_classes = true
+
+# Full error reports are disabled and caching is turned on
+config.action_controller.consider_all_requests_local = false
+config.action_controller.perform_caching             = true
+config.action_view.cache_template_loading            = true
+
+# See everything in the log (default is :info)
+# config.log_level = :debug
+
+# Use a different logger for distributed setups
+# config.logger = SyslogLogger.new
+
+# Use a different cache store in production
+# config.cache_store = :mem_cache_store
+
+# Enable serving of images, stylesheets, and javascripts from an asset server
+# config.action_controller.asset_host = "http://assets.example.com"
+
+# Disable delivery errors, bad email addresses will be ignored
+# config.action_mailer.raise_delivery_errors = false
+
+# Enable threaded mode
+# config.threadsafe!