opensteam 0.9.2 → 0.9.3

data/lib/opensteam/container.rb

@@ -0,0 +1,196 @@
+#	openSteam - http://www.opensteam.net
+#  Copyright (C) 2008  DiamondDogs Webconsulting
+#
+#  This program is free software; you can redistribute it and/or modify
+#  it under the terms of the GNU General Public License as published by
+#  the Free Software Foundation; version 2 of the License.
+#
+#  This program is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#  GNU General Public License for more details.
+#
+#  You should have received a copy of the GNU General Public License along
+#  with this program; if not, write to the Free Software Foundation, Inc.,
+#  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+module Opensteam
+  
+  
+  module Container
+    
+    
+    # Container Base Class
+    # used for Cart, Orders, Wishlists, etc
+    # TODO: check self.abstract == useful
+    class Base < ActiveRecord::Base
+      def self.table_name ; "containers" ; end
+      
+      has_many :items, :class_name => "Opensteam::Container::Item",
+        :foreign_key => 'container_id',
+        :dependent => :destroy
+      
+      
+      
+      belongs_to :customer, :class_name => 'Opensteam::UserBase::User'
+      
+      
+      # move all items from container +c+ to current container +self+
+      def move_items_from c
+        c.items.each do |v|
+          v.update_attribute( :container, self )
+        end
+        
+      end
+      
+      # copy all items from container +c+ to current container +self+
+      def copy_items_from c
+        c.items.each do |v|
+          items.build( v.attributes )
+        end
+      end
+
+      
+      
+    end
+    
+    
+    # Shopping Cart implementation
+    # SubClass of Opensteam::Container::Base
+    class Cart < Opensteam::Container::Base
+      
+      
+
+      
+      # access items as array
+      def []( id ) ; items[id.to_i] ; end
+  
+      # push/add item to container
+      # if item exists, increment quantity
+      def push( item )
+        unless( i = find_item( item ) )
+          items.create( :item => item )
+        else
+          i.incr
+        end
+      end
+      
+      def update!
+        update_tax( :country => "Austria" )
+      end
+      
+      
+      # access index of items
+      def index(i)
+        @items.index(i)
+      end
+      
+      
+      # find +item+
+      def find_item( item )
+        Array(items).find { |i| i.item == item }
+      end
+  
+      
+      def total_price
+        items.collect(&:total_price).sum
+      end
+  
+      # set quantity for items in +h+ (hash)
+      #   container.set_quantity = { "0" => 123, "1" => 345 }
+      # where key is the array index of +items+
+      def set_quantity=(h)
+        h.each_pair { |k,v| self.items[k.to_i].set_quantity(v) }
+      end
+  
+      
+      # alias for push
+      alias :<< :push
+      alias :add :push
+      
+      
+       
+      
+    end
+    
+    
+    # Items for Container Class
+    # used for CartItems, OrderItems, etc
+    #
+    # implements quantity mechanism (increment, decrement, set_quantity). if quantity == 0, item destroys itself.
+    # implements a method_missing to delegate all unknown method calls to (polymorphic) item.
+    class Item < ActiveRecord::Base
+      
+      def self.table_name ; "container_items" ; end
+
+
+      before_create :init_price, :init_quantity
+      after_save :check_quantity
+      before_save :update_total_price
+  
+      belongs_to :container, :class_name => 'Opensteam::Container::Base',
+        :counter_cache => "items_count"
+      
+      
+
+      belongs_to :item, :polymorphic => true
+  
+      
+      belongs_to :invoice, :class_name => 'Opensteam::InvoiceBase::Invoice'
+      belongs_to :shipment, :class_name => 'Opensteam::ShipmentBase::Shipment'
+      
+      
+      # increment quantity
+      def incr ; self.increment!( :quantity, 1 ) ; end
+  
+      # decrement quantity
+      def decr ; self.decrement!( :quantity, 1 ) ; end
+  
+  
+      # set quantity and save item
+      def set_quantity( qnt )
+        self.quantity = qnt
+        save
+      end
+  
+      # delegate all missing methods to item, if item responds
+      def method_missing(name, *args, &block )
+        self.item.respond_to?( name ) ? self.item.__send__( name, *args, &block ) : super
+      end
+  
+      private
+      
+      # init quantity
+      def init_quantity
+        self.quantity = 1 ;
+        update_total_price
+      end
+
+
+      
+      def init_price
+        self.price = self.item.price
+      end
+      
+
+      def update_total_price
+        self.total_price = self.quantity * self.price
+      end
+      
+      
+      # if quantity == 0, destroy yourself
+      def check_quantity
+        if self.quantity <= 0
+          self.destroy
+        end
+      end
+      
+      
+  
+    end
+    
+    
+  end
+end
+
+Cart = Opensteam::Container::Cart

data/lib/opensteam/extension_base.rb

@@ -1,5 +1,23 @@
+#	openSteam - http://www.opensteam.net
+#  Copyright (C) 2008  DiamondDogs Webconsulting
+#
+#  This program is free software; you can redistribute it and/or modify
+#  it under the terms of the GNU General Public License as published by
+#  the Free Software Foundation; version 2 of the License.
+#
+#  This program is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#  GNU General Public License for more details.
+#
+#  You should have received a copy of the GNU General Public License along
+#  with this program; if not, write to the Free Software Foundation, Inc.,
+#  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
 module Opensteam
   
+  # module to handle Opensteam Extensions
+  # (not in use right now)
   module ExtensionBase #:nodoc:
     
     mattr_accessor :extension_path
@@ -69,7 +87,7 @@ module Opensteam
       
     end
 
-    class Backend < Extension
+    class Backend < Extension #:nodoc:
     end
     
   end

data/lib/opensteam/finder.rb

@@ -166,7 +166,7 @@ module Opensteam
   end #Finder
 
 
-  # dummy class to access the finder-methods without including the model.
+  # dummy class to access the finder-methods without including the module.
   class Find
     include Opensteam::Finder
   end

data/lib/opensteam/helpers/config_table_helper.rb

@@ -1,4 +1,20 @@
-module Opensteam::Helpers
+#	openSteam - http://www.opensteam.net
+#  Copyright (C) 2008  DiamondDogs Webconsulting
+#
+#  This program is free software; you can redistribute it and/or modify
+#  it under the terms of the GNU General Public License as published by
+#  the Free Software Foundation; version 2 of the License.
+#
+#  This program is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#  GNU General Public License for more details.
+#
+#  You should have received a copy of the GNU General Public License along
+#  with this program; if not, write to the Free Software Foundation, Inc.,
+#  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+module Opensteam::Helpers #:nodoc:
   
   
   module ConfigTableHelper
@@ -8,10 +24,6 @@ module Opensteam::Helpers
       base.class_eval do
         include InstanceMethods
         
-        
-        
-        
-        
       end
       
     end
@@ -117,7 +129,7 @@ module Opensteam::Helpers
         html_options = opts[:html] || {}
         
         concat( 
-          content_tag( :div, { :class => 'configured_table_containter' } ) do
+          content_tag( :div, { :class => 'osteam_configured_table_div' } ) do
             content_tag( :table, html_options ) do
               content
             end

data/lib/opensteam/initializer.rb

@@ -81,7 +81,7 @@ module Opensteam
     end
     
     
-    def require_libs
+    def require_libs #:nodoc:
       require 'opensteam/version'
       require 'opensteam/config'
       require 'opensteam/finder'
@@ -90,17 +90,37 @@ module Opensteam
       require 'opensteam/base'
       require 'opensteam/history'
       require 'opensteam/state_machine'
-      require 'opensteam/invoice_base'
       require 'opensteam/shipment_base'
+      require 'opensteam/invoice_base'
+      require 'opensteam/container'
+      
+      require 'opensteam/security'
+      require 'opensteam/payment'
+      
       require 'opensteam/order_base'
+            
       require 'opensteam/state_logic'
       require 'opensteam/extension_base'
+      
+      # require all payment types
+      Dir.glob( File.join( File.dirname(__FILE__), "payment", "*.rb" ) ) { |f| 
+        require f
+      }
+      
+
       require 'opensteam/shopping_cart'
-      require 'opensteam/cart_base'
+      #    require 'opensteam/cart_base'
       require 'opensteam/checkout'
       require 'opensteam/inventory_base'
+      
+
+      
+
+      #      require 'opensteam/order_container'
    
+      #   require 'opensteam/tax'
     
+      require 'opensteam/money'
     
     end
     
@@ -109,7 +129,7 @@ module Opensteam
   
   
   
-  class Configuration
+  class Configuration #:nodoc:
     
     def say_something
     

data/lib/opensteam/inventory_base.rb

@@ -43,6 +43,7 @@ module Opensteam
     # Inventory Model
     class Inventory < ActiveRecord::Base
       
+      
       has_many :order_items, :class_name => "Opensteam::OrderBase::OrderItem"
       
       belongs_to :product, :polymorphic => true
@@ -52,12 +53,16 @@ module Opensteam
       
       validates_presence_of :price, :storage
       
+      named_scope :by_properties, lambda { |properties| { :include => :properties,
+          :conditions => { "properties.id" => properties.collect(&:id) },
+          :group => "inventories.id HAVING COUNT( inventories.id ) = #{properties.size}" } }
+
       
       def products
         find(:all, :include => :product ).collect(&:product)
       end
       
-      
+      [:name, :description ].each { |m| delegate m, :to => :product }
       
      
 

data/lib/opensteam/invoice_base.rb

@@ -20,29 +20,20 @@ module Opensteam
   # Base Module for all Invoice-specific modules + classes
   module InvoiceBase
 
-
-
-    # available States for an Invoice-Instance
-    module States
-
-    end
-
-
-
+    module States ; end
+    
 
     # Invoice Model
     class Invoice < ActiveRecord::Base
-      include Opensteam::StateMachine
       
       belongs_to :order, :class_name => 'Opensteam::OrderBase::Order'
       belongs_to :customer, :class_name => 'Opensteam::UserBase::User'
       belongs_to :address, :class_name => 'Opensteam::UserBase::Address'
 
-      has_many :order_items, :class_name => 'Opensteam::OrderBase::OrderItem'
-      
+      has_many :order_items, :class_name => 'Opensteam::Container::Item'
       
       named_scope :by_order, lambda { |order_id| { :include => :order, :conditions => { :order_id => order_id } } }
-      named_scope :order_by, lambda { |by| { :include => Invoice.osteam_configtable.default_include, :order => Array(by).join(",") , :conditions => "orders.id = orders.id" } }
+      named_scope :order_by, lambda { |by| { :include => Invoice.osteam_configtable.default_include, :order => Array(by).join(",") , :conditions => "addresses.id = addresses.id" } }
       
       
       def initialize(*args)
@@ -54,6 +45,14 @@ module Opensteam
       end
       
       
+      def amount_in_cents
+        ( price * 100 ).to_i
+      end
+      
+      
+      def items ; order_items ; end
+      
+      
     end
 
 

data/lib/opensteam/money.rb

@@ -0,0 +1,230 @@
+#	openSteam - http://www.opensteam.net
+#  Copyright (C) 2008  DiamondDogs Webconsulting
+#
+#  This program is free software; you can redistribute it and/or modify
+#  it under the terms of the GNU General Public License as published by
+#  the Free Software Foundation; version 2 of the License.
+#
+#  This program is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#  GNU General Public License for more details.
+#
+#  You should have received a copy of the GNU General Public License along
+#  with this program; if not, write to the Free Software Foundation, Inc.,
+#  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+
+module Opensteam
+  
+  # module for all Money specific modules and classes
+  # 
+  # includes:
+  # - helper methods for View, Opensteam::Money::Helper
+  # - class for rounding, Opensteam::Money::Rounding
+  # - Tax specific modules and classes, Opensteam::Money::Tax
+  #
+  module Money
+    
+    module Helper
+      
+      def get_rate_for item, country = nil
+        item.get_rate( :country => country || Opensteam::Config[ :default_country ] )
+      end
+      
+      def calculate_tax_for item, country = nil
+        item.calculate_tax( :country => country || Opensteam::Config[ :default_country ] )
+      end
+      
+    end
+
+    
+    module Rounding
+      
+      # TODO: define rounding methods for zones
+      
+      
+      # normal rounding
+      def round f
+        BigDecimal.new( f.to_s ).round(2)
+      end
+      
+      
+      # rappen rounding (for CH)
+      def round_rappen f
+        ( BigDecimal.new( f.to_s ) * 20 ).round / 20
+      end
+    
+    end
+    
+    
+    
+    
+    # Contains all tax specific modules and classes
+    module Tax
+      
+
+      module Calculation
+        include Opensteam::Money::Rounding
+        
+        def calculate_tax( address )
+          round( self.price * ( get_rate( address ) / 100  ) )
+        end
+        
+        def get_rate( address )
+          return 0.0 unless self.tax_group
+          
+          zones = self.tax_group.tax_zones.by_address( address ) 
+          
+          if !zones || zones.empty?
+            return 0.0
+          else
+            zones.first.rate
+          end
+          
+        end
+        
+        
+        
+      end
+      
+
+      
+      # TaxZones
+      # defines rates
+      class TaxZone < ActiveRecord::Base
+        self.table_name = "tax_zones"
+
+        has_many :tax_rules, :class_name => "Opensteam::Money::Tax::TaxRule"
+      
+        named_scope :order_by, lambda { |by| { :order => Array(by).join(",") } }
+        named_scope :by_product_tax_group, lambda { |a| { :include => { :tax_rules => :product_tax_group },
+            :conditions => { "tax_groups.name" => a } } }
+      
+        named_scope :by_address, lambda { |a| { :conditions => a } }
+
+      end
+    
+    
+    
+      # Base Class for TaxGroups
+      class TaxGroup < ActiveRecord::Base
+        self.table_name = "tax_groups"
+        named_scope :order_by, lambda { |by| { :order => Array(by).join(",") } }
+      
+      end
+    
+    
+      # Tax Groups for a Custmoer, not yet implemented !!
+      class CustomerTaxGroup < TaxGroup
+      
+        has_many :customers, :class_name => "Opensteam::UserBase::User", :foreign_key => "tax_group_id" 
+      
+        has_many :tax_rules, :foreign_key => "customer_tax_groupd_id", :class_name => "Opensteam::Money::Tax::TaxRule"
+        has_many :tax_zones, :through => :tax_rules, :class_name => "Opensteam::Money::Tax::TaxZone"
+      end
+
+
+    
+      # Tax Groups for a Product (Inventory)
+      class ProductTaxGroup < TaxGroup
+      
+        has_many :inventories, :class_name => 'Opensteam::InventoryBase::Inventory', :foreign_key => "tax_group_id"
+      
+        has_many :tax_rules, :foreign_key => "product_tax_group_id", :class_name => "Opensteam::Money::Tax::TaxRule"
+        has_many :tax_zones, :through => :tax_rules, :class_name => "Opensteam::Money::Tax::TaxZone"
+      
+        validates_presence_of :name
+        validates_uniqueness_of :name
+      
+        after_update :save_tax_rules
+
+
+        def new_tax_rule_attributes=( rule_attributes )
+          rules = []
+          rule_attributes.each do |attributes|
+            tax_rules.build( attributes ) unless rules.include?( attributes["tax_zone_id"] )
+            rules << attributes["tax_zone_id"]
+          end
+        end
+      
+        def existing_tax_rule_attributes=( rule_attributes )
+          tax_rules.reject(&:new_record?).each do |tax_rule|
+            attributes = rule_attributes[tax_rule.id.to_s]
+            if attributes
+              tax_rule.attributes = attributes
+            else
+              tax_rules.delete( tax_rule )
+            end
+          end
+        end
+      
+        def save_tax_rules
+          tax_rules.each { |rule| rule.save(false) } 
+        end
+      
+      
+        def tax_rules=( rules )
+          return false unless save
+          self.tax_rules.delete_all
+          rules.each { |r| self.tax_rules.create( r ) }
+        end
+      
+      end
+    
+    
+    
+      # TaxRules
+      # maps TaxGroups to TaxZones
+      class TaxRule < ActiveRecord::Base
+        self.table_name = "tax_rules"
+     
+      
+        belongs_to :customer_tax_group, :class_name => "Opensteam::Money::Tax::TaxGroup"
+        belongs_to :product_tax_group, :class_name => "Opensteam::Money::Tax::TaxGroup"
+      
+        belongs_to :tax_zone
+  
+        named_scope :by_product_tax_group, lambda { |p| { :include => :product_tax_group, :conditions => { "tax_groups.name" => p } } }
+      end
+
+      
+      
+
+    end
+    
+    
+  end
+  
+end
+
+
+
+TaxZone = Opensteam::Money::Tax::TaxZone
+TaxRule = Opensteam::Money::Tax::TaxRule
+TaxGroup = Opensteam::Money::Tax::TaxGroup
+ProductTaxGroup = Opensteam::Money::Tax::ProductTaxGroup
+CustomerTaxGroup = Opensteam::Money::Tax::CustomerTaxGroup
+
+
+Opensteam::Container::Item.send( :include, Opensteam::Money::Tax::Calculation )
+
+Opensteam::InventoryBase::Inventory.class_eval do
+  belongs_to :tax_group, :class_name => 'Opensteam::Money::Tax::ProductTaxGroup'
+end
+      
+
+
+#Opensteam::InventoryBase::Inventory.send( :include, Opensteam::Money::Tax::InventoryHelper )
+#Opensteam::OrderBase::OrderItem.send( :include, Opensteam::Money::Tax::OrderItemHelper )
+#Opensteam::OrderBase::Order.send( :include, Opensteam::Tax::OrderHelper)
+#
+#
+#Opensteam::Container::Cart.send( :include, Opensteam::Tax::ContainerHelper )
+#Opensteam::Container::Item.send( :include, Opensteam::Tax::ContainerItemHelper)
+
+
+
+
+
+