has_accounts 0.2.0 → 0.2.1

data/README.md

@@ -15,16 +15,19 @@ In Rails 3 simply add
 Example
 =======
 
-There is a new class method made available to ActiveRecord::Base
-by this plugin:
+A few models are available:
 
-* has_accounts(options = {})
+  class Booking
+  class Account
+  class AccountType
 
-Use it like this:
+There's also a ready to use module available to attach accountable
+functionality to existing models.
+
+To use it, simply add the following to your Model:
+
+  include HasAccounts::Model
 
-class Doctor < ActiveRecord::Base
-  has_vcards
-end
 
 License
 =======

data/lib/booking.rb~

@@ -0,0 +1,92 @@
+class Booking < ActiveRecord::Base
+  # Validation
+  validates_presence_of :debit_account, :credit_account, :title, :amount, :value_date
+  validates_time :value_date
+
+  belongs_to :debit_account, :foreign_key => 'debit_account_id', :class_name => "Account"
+  belongs_to :credit_account, :foreign_key => 'credit_account_id', :class_name => "Account"
+
+  # Scoping
+  named_scope :by_value_date, lambda {|value_date| { :conditions => { :value_date => value_date } } }
+  named_scope :by_value_period, lambda {|from, to| { :conditions => { :value_date => from..to } } }
+  
+  named_scope :by_account, lambda {|account_id|
+    { :conditions => ["debit_account_id = :account_id OR credit_account_id = :account_id", {:account_id => account_id}] }
+  } do
+    # Returns array of all booking titles.
+    def titles
+      find(:all, :group => :title).map{|booking| booking.title}
+    end
+    
+    # Statistics per booking title.
+    #
+    # The statistics are an array of hashes with keys title, count, sum, average.
+    def statistics
+      find(:all, :select => "title, count(*) AS count, sum(amount) AS sum, avg(amount) AS avg", :group => :title).map{|stat| stat.attributes}
+    end
+  end
+
+  # Returns array of all years we have bookings for
+  def self.fiscal_years
+    with_exclusive_scope do
+      find(:all, :select => "year(value_date) AS year", :group => "year(value_date)").map{|booking| booking.year}
+    end
+  end
+
+  def self.scope_by_value_date(value_date)
+    scoping = self.default_scoping - [@by_value_scope]
+    
+    @by_value_scope = {:find => {:conditions => {:value_date => value_date}}}
+    scoping << @by_value_scope
+    
+    Thread.current["#{self}_scoped_methods"] = nil
+    self.default_scoping = scoping
+  end
+  
+  def self.filter(controller, &block)
+    if controller.value_date_scope
+      with_scope(:find => {:conditions => {:value_date => controller.value_date_scope}}, &block)
+    else
+      block.call
+    end
+  end
+  
+  # Standard methods
+  def to_s(format = :default)
+    case format
+    when :short
+      "#{value_date.strftime('%d.%m.%Y')}: #{credit_account.code} / #{debit_account.code} CHF #{amount_as_string} "
+    else
+      "#{value_date.strftime('%d.%m.%Y')}: #{credit_account.title} (#{credit_account.code}) an #{debit_account.title} (#{debit_account.code}) CHF #{amount_as_string}, #{title} " +
+        (comments.blank? ? "" :"(#{comments})")
+    end
+  end
+
+  # Helpers
+  def accounted_amount(account)
+    if credit_account == account
+      return amount
+    elsif debit_account == account
+      return -(amount)
+    else
+      return 0.0
+    end
+  end
+
+  def amount_as_string
+    '%0.2f' % amount
+  end
+  
+  def amount_as_string=(value)
+    self.amount = value
+  end
+  
+  # Reference
+  belongs_to :reference, :polymorphic => true
+  after_save :notify_references
+
+  private
+  def notify_references
+    reference.booking_saved(self) if reference.respond_to?(:booking_saved)
+  end
+end

data/lib/has_accounts.rb

@@ -1,3 +1,4 @@
 require 'has_accounts/model'
+require 'has_accounts/core_ext/rounding'
 
 require 'has_accounts/railtie' if defined?(::Rails::Railtie)

data/lib/has_accounts.rb~

@@ -1 +1,3 @@
-require 'has_accounts/railtie' if defined?(::Rails::Railtie)
+require 'has_accounts/model'
+
+require 'has_accounts/railtie' if defined?(::Rails::Railtie)

data/lib/has_accounts/core_ext/rounding.rb~

@@ -0,0 +1,31 @@
+module HasAccounts #:nodoc:
+  module CoreExtensions #:nodoc:
+    module Rounding
+      # Rounds the float according to currency rules.
+      # Currently targeted to Swiss Francs (CHF), usable
+      # for all currencies having 0.05 as smallest unit.
+      #
+      #   x = 1.337
+      #   x.round    # => 1.35
+      def currency_round
+        if self.nil?
+          return 0.0
+        else
+          return (self * 20).round / 20.0
+        end
+      end
+    end
+    
+    module BigDecimal
+      module Rounding
+        def currency_round
+          if self.nil?
+            return BigDecimal.new("0")
+          else
+            return (self * 20).round / 20
+          end
+        end
+      end
+    end
+  end
+end

data/lib/has_accounts/model.rb

@@ -26,11 +26,6 @@ module HasAccounts
     end
 
     module ClassMethods
-      def sidebar(options = true)
-        if options.is_a? TrueClass
-          self.sidebars = ["#{controller_name}/sidebar"]
-        end
-      end
     end
     
     module InstanceMethods

data/lib/has_accounts/railtie.rb~

@@ -0,0 +1,10 @@
+require 'has_accounts'
+require 'rails'
+
+module HasAccounts
+  class Railtie < Rails::Engine
+    Float.send :include, HasAccounts::CoreExtensions::Rounding
+    Fixnum.send :include, HasAccounts::CoreExtensions::Rounding
+    BigDecimal.send :include, HasAccounts::CoreExtensions::Rounding
+  end
+end

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: has_accounts
 version: !ruby/object:Gem::Version 
-  hash: 23
-  prerelease: 
+  prerelease: false
   segments: 
   - 0
   - 2
-  - 0
-  version: 0.2.0
+  - 1
+  version: 0.2.1
 platform: ruby
 authors: 
 - "Simon H\xC3\xBCrlimann (CyT)"
@@ -15,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-10 00:00:00 +02:00
+date: 2011-04-11 00:00:00 +02:00
 default_executable: 
 dependencies: []
 
@@ -32,15 +31,18 @@ files:
 - app/models/account_scope_extension.rb
 - app/models/bank.rb
 - app/models/account.rb
-- app/models/bank_account.rb
-- app/models/account_type.rb
 - app/models/booking.rb
-- lib/has_accounts/railtie.rb
+- app/models/account_type.rb
+- app/models/bank_account.rb
+- lib/has_accounts.rb~
+- lib/has_accounts.rb
+- lib/booking.rb~
 - lib/has_accounts/class_methods.rb
+- lib/has_accounts/railtie.rb~
+- lib/has_accounts/core_ext/rounding.rb~
 - lib/has_accounts/core_ext/rounding.rb
+- lib/has_accounts/railtie.rb
 - lib/has_accounts/model.rb
-- lib/has_accounts.rb~
-- lib/has_accounts.rb
 - MIT-LICENSE
 - Rakefile
 - README.md
@@ -54,27 +56,23 @@ rdoc_options: []
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.5.2
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: HasAccounts provides models for financial accounting.