spree 0.0.9 → 0.2.0

data/CHANGELOG

@@ -1,3 +1,9 @@
+== 0.2.0 2008-06-05
+
+* Extension support.
+* Improved user/address model.
+* Improved payment gateway configuraiton.
+
 == 0.0.9 2008-04-23
 
 * Changed source code layout.  Spree now runs in stand alone, gem and application modes. 

data/README.markdown

@@ -0,0 +1,88 @@
+SUMMARY
+=======
+
+Spree is a complete open source commerce solution for Ruby on Rails.
+It was developed by Sean Schofield under the original name of Rails
+Cart before changing its name to Spree.
+
+QUICK START
+===========
+
+1. Install spree Gem
+
+        $ sudo gem install spree
+
+    **NOTE:** This may take a while. The gem currently includes a
+      frozen version of Rails 2.0.2
+
+2. Create Spree Application
+
+        $ spree <app_name>
+
+3. Create your database and edit the _config/database.yml_ to taste. You
+can skip this step if using sqlite3 as your database.
+
+4. Bootstrap
+
+        $ cd <app-name>
+        $ rake db:bootstrap
+
+5. Launch Application
+
+        $ script/server
+
+Browse Store
+------------
+
+http://localhost:xxxx/store
+
+Browse Admin Interface
+----------------------
+
+http://localhost:xxxx/admin
+
+Is Spree Ready for Production?
+==============================
+
+I have been asked by several people about the status of the Spree
+project. I thought I would take a moment to address the current state
+of the codebase and whether or not its “production ready.”
+
+In my opinion, you can use Spree in a real world commerce application
+right now. This is especially true if you are already committed to
+using Ruby on Rails. What are the drawbacks to doing this? The major
+drawback is that Spree is still “rough around the edges” so you will
+be doing a lot of the polishing yourself. For instance, if you want to
+have FedEx shipping calculations you will need to write/port your own.
+On the other hand, the basic admin functionality is working and the
+ActiveMerchant plugin support means you don’t have to worry about
+credit cards. In fact, I have already built two production sites with
+this software (under the old RailsCart name).
+
+The only other Rails commerce application I am aware of is Substruct.
+The last I looked at this project it was fairly basic as well. So if
+you are going to start building your Rails project today, you have
+three choices.
+
+1. Write your own
+2. Use Spree as your starting point and do lots of custom coding
+3. Use Substruct as your starting point and do lots of custom coding
+
+If you are uncomfortable with these three options then you should
+consider another application framework.
+
+The good news is that Spree is rapidly improving with each passing
+day. The major effort right now is to rejigger the data model so that
+it is rock solid. There is nothing “wrong” with the current data model
+which is why it is ok to build a production Spree app with the
+existing software. We’re just trying to make the data model as “future
+proof” as possible. The more we improve the data model now, the less
+disruptive it will be for users to upgrade to subsequent versions of
+the software.
+
+When will this refactoring be done? Our goal is to have our first beta
+release in time for RailsConf (May 29). This means we will pushing
+hard for another 6-8 weeks on all things data model. Once we go “beta”
+we be on the next level of stability. There will be a lot less coding
+needed to use Spree for your production site and we also hope to have
+a standardized approach for the custom code you do need to write.

data/app/controllers/account_controller.rb

@@ -1,7 +1,4 @@
 class AccountController < Spree::BaseController
-  # Be sure to include AuthenticationSystem in Application Controller instead
-  include AuthenticatedSystem
-  # If you want "remember me" functionality, add this before_filter to Application Controller
   before_filter :login_from_cookie
   
   layout 'admin'
@@ -18,7 +15,7 @@ class AccountController < Spree::BaseController
         self.current_user.remember_me
         cookies[:auth_token] = { :value => self.current_user.remember_token , :expires => self.current_user.remember_token_expires_at }
       end
-      redirect_back_or_default(:controller => '/account', :action => 'index')
+      redirect_back_or_default(:controller => 'store', :action => 'index')
       flash.now[:notice] = "Logged in successfully"
     else
       flash.now[:error] = "Login authentication failed."

data/app/controllers/admin/base_controller.rb

@@ -1,7 +1,6 @@
-# this clas was inspired (heavily) from the mephisto admin architecture
+# this class was inspired (heavily) from the mephisto admin architecture
 
 class Admin::BaseController < Spree::BaseController
-  before_filter :login_required
   helper :search
   layout 'admin'
 end

data/app/controllers/admin/categories_controller.rb

@@ -18,7 +18,6 @@ class Admin::CategoriesController < Admin::BaseController
     load_data
     if request.post?
       @category = Category.new(params[:category])
-      @category.tax_treatments = TaxTreatment.find(params[:tax_treatments]) if params[:tax_treatments]
       if @category.save
         flash[:notice] = 'Category was successfully created.'
         redirect_to :action => 'list'
@@ -36,11 +35,6 @@ class Admin::CategoriesController < Admin::BaseController
 
   def update
     @category = Category.find(params[:id])
-    # clear out previous tax treatments since deselecting them will not communicated via POST
-    @category.tax_treatments.clear
-    @category.tax_treatments = TaxTreatment.find(params[:tax_treatments]) if params[:tax_treatments]
-    @category.save
-      
     if @category.update_attributes(params[:category])
       flash[:notice] = 'Category was successfully updated.'
       redirect_to :action => 'index'
@@ -56,28 +50,10 @@ class Admin::CategoriesController < Admin::BaseController
     redirect_to :action => 'list'
   end
 
-  # AJAX method to show tax treatments based on change in parent category 
-  def tax_treatments
-    category = Category.find_or_initialize_by_id(params[:category_id])
-    if params[:parent_id].blank?
-      category.parent = nil
-    else
-      category.parent = Category.find(params[:parent_id])      
-    end
-
-    @all_tax_treatments = TaxTreatment.find(:all)
-
-    render  :partial => 'shared/tax_treatments', 
-            :locals => {:tax_treatments => @all_tax_treatments, :selected_treatments => category.tax_treatments},
-            :layout => false
-  end
-
   private
   
       def load_data
         @all_categories = Category.find(:all, :order=>"name") 
         @all_categories.unshift Category.new(:name => "<None>")
-        @all_tax_treatments = TaxTreatment.find(:all)
       end
-end       
-       
+end 

data/app/controllers/admin/extensions_controller.rb

@@ -0,0 +1,5 @@
+class Admin::ExtensionsController < Admin::BaseController
+  def index
+    @extensions = Spree::Extension.descendants.sort_by { |e| e.extension_name }
+  end  
+end

data/app/controllers/admin/inventory_units_controller.rb

@@ -1,6 +1,5 @@
 class Admin::InventoryUnitsController < Admin::BaseController
-  require_role "admin"
-  
+    
   def adjust
     @variant = Variant.find(params[:id])
     if request.post?

data/app/controllers/admin/orders_controller.rb

@@ -1,5 +1,4 @@
 class Admin::OrdersController < Admin::BaseController
-  require_role "admin"
   
   in_place_edit_for :address, :firstname
   in_place_edit_for :address, :lastname

data/app/controllers/admin/products_controller.rb

@@ -1,5 +1,4 @@
 class Admin::ProductsController < Admin::BaseController
-  require_role "admin"
   
   def index
     if params[:search]
@@ -63,14 +62,20 @@ class Admin::ProductsController < Admin::BaseController
       if params[:variant]
         @product.variants.update params[:variant].keys, params[:variant].values
       end
+      
+      if params[:new_variant]
+        variant = Variant.new(:product => @product)
+        option_values = params[:new_variant]
+        option_values.each_value {|id| variant.option_values << OptionValue.find(id)}
+        @product.variants << variant
+        @product.save
+      end
 
       if params[:image]
         @product.images << Image.new(params[:image])
+        @product.save
       end
       
-      @product.tax_treatments = TaxTreatment.find(params[:tax_treatments]) if params[:tax_treatments]
-      @product.save
-      
       if @product.update_attributes(params[:product])
         flash[:notice] = 'Product was successfully updated.'
         redirect_to :action => 'edit', :id => @product
@@ -111,20 +116,6 @@ class Admin::ProductsController < Admin::BaseController
             :layout => false
   end  
 
-  # AJAX method to show tax treatments based on change in category
-  def tax_treatments
-    product = Product.find_or_initialize_by_id(params[:id])
-    if params[:category_id].blank?
-      product.category = nil
-    else
-      product.category = Category.find(params[:category_id])
-    end
-    @all_tax_treatments = TaxTreatment.find(:all)
-    render  :partial => 'shared/tax_treatments', 
-            :locals => {:tax_treatments => @all_tax_treatments, :selected_treatments => product.tax_treatments},
-            :layout => false
-  end
-    
   #AJAX method   
   def new_variant
     @product = Product.find(params[:id])
@@ -148,7 +139,6 @@ class Admin::ProductsController < Admin::BaseController
       def load_data
         @all_categories = Category.find(:all, :order=>"name")  
         @all_categories.unshift Category.new(:name => "<None>")
-        @all_tax_treatments = TaxTreatment.find(:all, :order=>"name")
       end
   
   private

data/app/controllers/admin/reports_controller.rb

@@ -1,5 +1,4 @@
 class Admin::ReportsController < Admin::BaseController
-  require_role "admin"
   
   AVAILABLE_REPORTS = {
     :sales_total => {:name => "Sales Total", :description => "Sales Total For All Orders"}

data/app/controllers/application.rb

@@ -13,7 +13,8 @@ class ApplicationController < ActionController::Base
 
   include AuthenticatedSystem
   include RoleRequirementSystem
-
+  include EasyRoleRequirementSystem
+  
   private 
   
     def instantiate_controller_and_action_names

data/app/controllers/checkout_controller.rb

@@ -1,8 +1,7 @@
 class CheckoutController < Spree::BaseController
+  before_filter :new_or_login
   before_filter :find_order, :except => [:index, :thank_you]
-  
-  require_role 'admin', :only => :comp 
-  
+    
   def index
     find_cart
     # remove any incomplete orders in the db associated with the session
@@ -15,18 +14,11 @@ class CheckoutController < Spree::BaseController
   end
 
   def addresses
-    @user = User.new
+    @user = current_user ? current_user : User.new
     @states = State.find(:all, :order => 'name')
     @countries = Country.find(:all)
     
     if request.post?
-      #TODO - eventually we need to grab user out of session once we support user accounts for orders
-      @user = User.new(params[:user]) unless params[:user].empty?
-      @user.password = "changeme"
-      @user.password_confirmation = "changeme"
-      #TODO - eventually you will be able to configure type of account support, for now its just anonymous
-      @user.login = User.generate_login
-      
       @different_shipping = params[:different_shipping]
       @bill_address = Address.new(params[:bill_address])
       #if only one country available there will be no choice (and user will post nothing)
@@ -93,7 +85,8 @@ class CheckoutController < Spree::BaseController
       redirect_to :action => :thank_you, :id => @order.id and return
     else
       @order.ship_amount = calculate_shipping(@order)
-      @order.tax_amount = calculate_tax(@order)
+      # NOTE: calculate_tax method will be mixed in by the TaxCalculator extension
+      calculate_tax(@order)
     end
   end
   
@@ -142,6 +135,12 @@ class CheckoutController < Spree::BaseController
           @order
         end
       end
+      
+      def new_or_login
+        # create a new user (or login an existing one)
+        return if logged_in?
+        redirect_to new_user_url
+      end
 
       def finalize_order
         Order.transaction do
@@ -171,10 +170,4 @@ class CheckoutController < Spree::BaseController
         sc = sm.constantize.new
         sc.shipping_cost(order)
       end
-      
-      def calculate_tax(order)
-        # use the environment to specify the name of the tax calculator class a string
-        tc = TAX_CALCULATOR.constantize
-        tc.calc_tax(order)
-      end
 end

data/app/controllers/spree/base_controller.rb

@@ -1,16 +1,6 @@
-class Spree::BaseController < ApplicationController
-  # See ActionController::RequestForgeryProtection for details
-  # Uncomment the :secret if you're not using the cookie session store
-  #protect_from_forgery :secret => '55a66755bef2c41d411bd5486c001b16'
-  
-  #include AuthenticatedSystem
-  #include RoleRequirementSystem
+class Spree::BaseController < ResourceController::Base
   
   CalendarDateSelect.format = :american
-  
-  # unique cookie name to distinguish our session data from others'
-  session :session_key => SESSION_KEY
-
   #model :order, :address
   
   filter_parameter_logging "password"
@@ -39,9 +29,4 @@ class Spree::BaseController < ApplicationController
     render :text => 'Access Forbidden', :layout => true, :status => 401
   end
   
-  # Instantiates the selected PAYMENT_GATEWAY and initializes with GATEWAY_OPTIONS (configured in environment.rb)
-  def payment_gateway
-    ActiveMerchant::Billing::Base.gateway_mode = :test unless RAILS_ENV == "production"
-    PAYMENT_GATEWAY.constantize.new(GATEWAY_OPTIONS)
-  end
 end

data/app/controllers/users_controller.rb

@@ -0,0 +1,14 @@
+class UsersController < Spree::BaseController
+  create.before do
+    @user.login = @user.email 
+  end
+
+  create.after do
+    #User.authenticate(@user.login, @user.password)    
+    self.current_user = @user       
+  end
+
+  create.response do |wants|  
+    wants.html {redirect_to :controller => :checkout, :action => :addresses}         
+  end
+end

data/app/helpers/admin/extensions_helper.rb

@@ -0,0 +1,2 @@
+module Admin::ExtensionsHelper
+end

data/app/helpers/application_helper.rb

@@ -6,4 +6,17 @@ module ApplicationHelper
     return true unless %w{thank_you}.include? @current_action
     false
   end
+
+  def stylesheets
+    stylesheets = [stylesheet_link_tag("spree"), stylesheet_link_tag("application")]
+    ["#{controller.controller_name}/_controller", "#{controller.controller_name}/#{:action_name}"].each do |stylesheet|
+      if File.exists? "#{RAILS_ROOT}/public/stylesheets/#{stylesheet}.css" 
+        stylesheets << stylesheet_link_tag(stylesheet)   
+      # TODO - consider bringing this back to use with stylesheets in the extension
+      #else
+      #  stylesheets << stylesheet_link_tag(stylesheet, :plugin=>"spree") if File.exists? "#{RAILS_ROOT}/public/plugin_assets/spree/stylesheets/#{stylesheet}.css"
+      end
+    end
+    stylesheets.compact.join("\n")
+  end  
 end

data/app/helpers/spree/base_helper.rb

@@ -1,18 +1,5 @@
 module Spree::BaseHelper
   
-  def stylesheets
-    stylesheets = [stylesheet_link_tag("spree"), stylesheet_link_tag("application")]
-    ["#{controller.controller_name}/_controller", "#{controller.controller_name}/#{:action_name}"].each do |stylesheet|
-      if File.exists? "#{RAILS_ROOT}/public/stylesheets/#{stylesheet}.css" 
-        stylesheets << stylesheet_link_tag(stylesheet)   
-      # TODO - consider bringing this back to use with stylesheets in the extension
-      #else
-      #  stylesheets << stylesheet_link_tag(stylesheet, :plugin=>"spree") if File.exists? "#{RAILS_ROOT}/public/plugin_assets/spree/stylesheets/#{stylesheet}.css"
-      end
-    end
-    stylesheets.compact.join("\n")
-  end
-  
   def windowed_pagination_links(pagingEnum, options)
     link_to_current_page = options[:link_to_current_page]
     always_show_anchors = options[:always_show_anchors]

data/app/helpers/store_helper.rb

@@ -1,3 +1,22 @@
 module StoreHelper
-
+  
+  # returns the price of the product to show for display purposes
+  def product_price(product)
+    return nil if product.master_price.nil? and product.variants?
+    return number_to_currency(product.master_price) if product.master_price
+    product.variant ? number_to_currency(product.variant.price) : number_to_currency(0)
+  end
+  
+  # returns the formatted change in price (from the master price) for the specified variant (or simply return 
+  # the variant price if no master price was supplied)
+  def variant_price_diff(variant)
+    return number_to_currency(variant.price) unless variant.product.master_price
+    diff = variant.price - variant.product.master_price
+    return nil if diff == 0
+    if diff > 0
+      "(Add: #{number_to_currency diff.abs})"
+    else
+      "(Subtract: #{number_to_currency diff.abs})"
+    end
+  end
 end