uomi 0.2.15 → 0.2.16

data/Gemfile

@@ -4,8 +4,9 @@ source "http://rubygems.org"
 gemspec
 
 group :development do
-  gem 'rspec'
-  gem 'rspec-rails'
+  gem 'rspec', '2.8.0'
+  gem 'rspec-rails', '2.8.1'
   gem 'sqlite3'
   gem 'database_cleaner', '>= 1.2.0'
+  gem 'andand'
 end

data/lib/uomi.rb

@@ -9,18 +9,21 @@ module Uomi
   end
   
   def self.generate_invoice(&block)
-    invoice = Invoice.new
-    invoice.instance_eval(&block)
-    invoice.save!
-    invoice
+    ActiveRecord::Base.transaction do
+      invoice = Invoice.new
+      invoice.instance_eval(&block)
+      invoice.save!
+      invoice
+    end
   end
 
   def self.generate_credit_note(&block)
-    credit_note = CreditNote.new
-    credit_note.instance_eval(&block)
-    credit_note.save!
-    credit_note.issue!
-    credit_note
+    ActiveRecord::Base.transaction do
+      credit_note = CreditNote.new
+      credit_note.instance_eval(&block)
+      credit_note.save!
+      credit_note
+    end
   end
   
 end

data/lib/uomi/credit_note.rb

@@ -2,21 +2,21 @@ module Uomi
   class CreditNote < Invoice
     alias_attribute :receipt_number, :invoice_number
 
-    has_one :credit_note_invoice, dependent: :destroy
-    has_one :invoice, through: :credit_note_invoice
+    has_many :credit_note_invoices, dependent: :destroy
+    has_many :invoices, through: :credit_note_invoices
     has_many :credit_note_credit_transactions, dependent: :destroy
 
     def issue(issued_at = Time.now)
       self.issued_at = issued_at
       create_initial_transaction!
-      record_transaction_against_invoice!
+      record_transaction_against_invoice! unless self.invoices.blank?
       record_credit_notes!
+      record_transaction!
     end
 
     def record_transaction_against_invoice!
-      raise RuntimeError, "You must allocate a credit note against an invoice" if invoice.blank?
-      raise RuntimeError, "You must allocate a credit note against an issued invoice" unless invoice.issued?
-
+      invoice = invoices.first
+      validate(invoice: invoice, amount: self.total)
       invoice.add_credit_transaction(amount: total)
       invoice.save!
       CreditNoteCreditTransaction.create!(transaction: invoice.transactions.last, credit_note_id: self.id)
@@ -24,10 +24,10 @@ module Uomi
 
     def credit(options={})
       add_line_item(
-        invoiceable: options[:line_item].invoiceable,
+        invoiceable: options[:line_item].andand.invoiceable,
         amount: options[:amount] || 0,
         tax: options[:tax] || 0,
-        description: options[:description] || "Credit note against #{options[:line_item].description}" #?
+        description: options[:description] || "Credit note against #{options[:line_item].andand.description}" #?
       )
     end
 
@@ -35,11 +35,17 @@ module Uomi
       raise RuntimeError, "You must allocate a credit note against an invoice" if invoice.blank?
       raise RuntimeError, "You must allocate a credit note against an issued invoice" unless invoice.issued?
       
-      self.credit_note_invoice = CreditNoteInvoice.new(invoice_id: invoice.id)
+      self.credit_note_invoices << CreditNoteInvoice.new(invoice_id: invoice.id)
       self.buyer = invoice.buyer
       self.seller = invoice.seller
     end
 
+    def record_transaction!
+      unless self.invoices.blank?
+        add_debit_transaction(amount: total)
+      end
+    end
+
     def record_credit_notes!
       line_items.each do |line_item|
         invoiceable = line_item.invoiceable
@@ -66,5 +72,30 @@ module Uomi
 
       save!
     end
+
+    def validate(options={})
+      raise RuntimeError, "You must allocate this credit against an invoice" if options[:invoice].blank?
+      raise RuntimeError, "You must allocate this credit against a Uomi Invoice" unless options[:invoice].is_a?(Uomi::Invoice)
+      raise RuntimeError, "You cannot allocate nothing to the invoice" if (options[:amount].blank? || options[:amount].zero?)
+    end
+
+    # Refund section
+
+    def refund(&block)
+      instance_eval(&block)
+      save!
+    end
+
+    def set_balance_off(options={})
+      validate(options)
+      invoice = options[:invoice]
+
+      invoice.add_credit_transaction(amount: options[:amount])
+      against_invoice(invoice)
+      invoice.save!
+
+      self.add_debit_transaction(amount: options[:amount])
+      CreditNoteCreditTransaction.create!(transaction: invoice.transactions.last, credit_note_id: self.id)
+    end
   end
 end

data/lib/uomi/version.rb

@@ -1,3 +1,3 @@
 module Uomi
-  VERSION = "0.2.15"
+  VERSION = "0.2.16"
 end

data/spec/lib/uomi/credit_note_spec.rb

@@ -60,11 +60,9 @@ describe Uomi::CreditNote do
           against_invoice invoice
         end
 
-        @invoice.reload
-      end
+        @credit_note.issue!
 
-      it "should be issued" do
-        @credit_note.should be_issued
+        @invoice.reload
       end
 
       it "should have a receipt number" do
@@ -81,7 +79,7 @@ describe Uomi::CreditNote do
       end
 
       it "should know if it is linked to an invoice" do
-        @credit_note.invoice.should == @invoice
+        @credit_note.invoices.should == [@invoice]
       end
 
       it "should be linked to the credit transaction paid against the invoice" do
@@ -103,6 +101,124 @@ describe Uomi::CreditNote do
         @credit_note.seller.sellerable.should == @invoice_seller
       end
 
+      it "should set the balance to 0 if applied against an invoice" do
+        @credit_note.balance.should == 0
+      end
+
+      it "should mark the credit note as settled" do
+        @credit_note.should be_settled
+      end
+
+    end
+
+    context "Ad Hoc Credit Note not applied to any invoices" do
+      before(:each) do
+        @credit_note = Uomi::generate_credit_note do
+          credit amount: 5000, description: 'Description'
+          credit amount: 2000, description: 'Another Description'
+        end
+        @credit_note.issue!
+      end
+
+      it "should generate a credit note to the value of 70.00" do
+        @credit_note.total.should == 7000
+      end
+
+      it "should have a balance of 70.00" do
+        @credit_note.balance.should == 7000
+      end
+
+      context "Applying credit note to multiple invoices" do
+        before(:each) do
+          @invoice1 = Uomi::generate_invoice do
+            line_item description: "Line Item 1", amount: 5000, line_item_type_id: 1
+          end
+          @invoice1.issue!
+
+          @invoice2 = Uomi::generate_invoice do
+            line_item description: "Line Item 1", amount: 2000, line_item_type_id: 1
+          end
+          @invoice2.issue!
+        end
+
+        context "Apply credit to invoice 1 and 2" do
+          before(:each) do
+            inv = @invoice1
+
+            @credit_note.refund do
+              set_balance_off invoice: inv, amount: 5000
+            end
+
+            @credit_note.reload
+            @invoice1.reload
+          end
+
+          it "should set a credit note against an invoice" do
+            @invoice1.credit_notes.should == [@credit_note]
+          end
+
+          it "should settle the invoice" do
+            @invoice1.should be_settled
+          end
+
+          it "should set the balance on the credit note to 20" do
+            @credit_note.balance.should == 2000
+          end
+
+          it "should have created a debit transaction on the credit note to the value of 50.00" do
+            @credit_note.debit_transactions.last.amount.should == 5000
+          end
+
+          it "should have created a credit transaction against the invoice for 50.00" do
+            @invoice1.credit_transactions.last.amount.should == 5000
+          end
+
+          it "should know which invoice the credit note has transacted against" do
+            t = @credit_note.credit_note_credit_transactions.last
+            t.transaction.invoice.should == @invoice1
+          end
+
+          context "apply 20-00 to invoice 2" do
+            before(:each) do
+              inv = @invoice2
+
+              @credit_note.refund do
+                set_balance_off invoice: inv, amount: 2000
+              end
+
+              @credit_note.reload
+              @invoice2.reload
+            end
+
+            it "should set a credit note against an invoice1 and invoice 2" do
+              @invoice1.credit_notes.should == [@credit_note]
+              @invoice2.credit_notes.should == [@credit_note]
+            end
+
+            it "should settle the invoice" do
+              @invoice2.should be_settled
+            end
+
+            it "should settle the credit note" do
+              @credit_note.balance.should == 0
+              @credit_note.should be_settled
+            end
+
+            it "should have created a debit transaction on the credit note to the value of 50.00" do
+              @credit_note.debit_transactions.last.amount.should == 2000
+            end
+
+            it "should have created a credit transaction against the invoice for 50.00" do
+              @invoice2.credit_transactions.last.amount.should == 2000
+            end
+
+            it "should know which invoice the credit note has transacted against" do
+              t = @credit_note.credit_note_credit_transactions.last
+              t.transaction.invoice.should == @invoice2
+            end
+          end
+        end
+      end
     end
 
     context "When applying credits to the invoiceables" do
@@ -119,19 +235,6 @@ describe Uomi::CreditNote do
       end
 
     end
-
-    context "trying to create a standalone credit note" do
-
-      it "should raise an error if no invoice is specified" do
-        expect {Uomi::generate_credit_note do
-          line_items.each do |line_item|
-            credit amount: 500, description: "Credit note for Line Item #{line_item.id}", tax: 0
-          end
-          decorate_with tenant_name: "Peter"
-        end}.to raise_error(RuntimeError, "You must allocate a credit note against an invoice")
-      end
-    end
-
   end
   
 end

data/uomi.gemspec

@@ -22,6 +22,7 @@ Gem::Specification.new do |s|
   s.add_dependency "activerecord", "~> 3.0"
   s.add_dependency "i18n"
   s.add_dependency "workflow", '= 0.8.7'
+  s.add_dependency "andand"
   
   s.add_development_dependency 'combustion', '~> 0.3.1'
   s.add_development_dependency 'database_cleaner', '~> 1.2.0'

metadata

@@ -1,121 +1,132 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: uomi
-version: !ruby/object:Gem::Version
-  version: 0.2.15
-  prerelease: 
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 16
+  version: 0.2.16
 platform: ruby
-authors:
+authors: 
 - Douglas Anderson
 - Jeffrey van Aswegen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-09 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2014-09-16 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: activerecord
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '3.0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
   type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activerecord
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: i18n
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        version: "3.0"
   type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: i18n
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
   name: workflow
-  requirement: !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 8
+        - 7
         version: 0.8.7
   type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: andand
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.8.7
-- !ruby/object:Gem::Dependency
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
   name: combustion
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.3.1
-  type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 3
+        - 1
         version: 0.3.1
-- !ruby/object:Gem::Dependency
-  name: database_cleaner
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.2.0
   type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: database_cleaner
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 0
         version: 1.2.0
-description: ! ' Manage invoices. '
-email:
+  type: :development
+  version_requirements: *id007
+description: " Manage invoices. "
+email: 
 - i.am.douglas.anderson@gmail.com
 - jeffmess@gmail.com
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - .gitignore
 - .rvmrc
 - .travis.yml
@@ -158,31 +169,39 @@ files:
 - spec/lib/uomi/overdue_invoice_spec.rb
 - spec/spec_helper.rb
 - uomi.gemspec
+has_rdoc: true
 homepage: https://github.com/tehtorq/invoicing
 licenses: []
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: uomi
-rubygems_version: 1.8.24
+rubygems_version: 1.3.7.1
 signing_key: 
 specification_version: 3
 summary: An uomi gem.
-test_files:
+test_files: 
 - spec/README
 - spec/internal/config/database.yml.sample
 - spec/internal/config/routes.rb