easy_rails_money 0.0.2 → 0.0.3

data/lib/easy_rails_money/active_record/migration/table_definition.rb

@@ -3,12 +3,41 @@ module EasyRailsMoney
     module Migration
       module TableDefinition
         # called for create_table
-        
+
+        # Adds a common currency column
+        #
+        # Usually we create an currency column for each money
+        # columns. We can have multiple money columns in the same
+        # record, in which case we can have a single currency
+        # column. This helper creates that common curremcy column
+        #
+        # @return is not important and can change
+        #
+        # @see EasyRailsMoney::ActiveRecord::Migration::SchemaStatements#remove_currency
         def currency
           remove_currency_columns
           column :currency, :string
         end
-        
+
+        # Creates one or two columns to represent a Money object in the named table
+        #
+        # An integer column for storing Money in its base unit
+        # eg. cents for a Dollar denomination and a string for storing
+        # its currency name. Can think of it as a persisted or serialized
+        # Money object in the database. The integer column is suffixed
+        # with '_money' to aid in reflection ie. to find all money
+        # columns. Likewise the currency column is suffixed with '_currency'
+        # If does not create an individual currency column if a
+        # common currency column is defined
+        #
+        # @param column_names [Array|Symbol|String] List of money columns to add
+        # @return is not important and can change
+        #
+        # @note If we have defined a currency column for a record then only the integer column is defined.
+        # @see EasyRailsMoney::ActiveRecord::Migration::SchemaStatements#add_money
+        # @see EasyRailsMoney::ActiveRecord::Migration::Table#money
+        # @see EasyRailsMoney::ActiveRecord::Migration::TableDefinition#currency
+        # @see EasyRailsMoney::ActiveRecord::Migration::SchemaStatements#remove_money
         def money(*column_names)
           column_names.each do |name|
             column "#{name}_money",      :integer
@@ -18,6 +47,7 @@ module EasyRailsMoney
           end
         end
 
+        protected
         def remove_currency_columns
           columns.delete_if { |x| x.name =~ /_currency/ }
         end

data/lib/easy_rails_money/version.rb

@@ -1,3 +1,3 @@
 module EasyRailsMoney
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/active_record/migration_spec.rb

@@ -6,147 +6,214 @@ if defined? ActiveRecord
 
   require 'active_record/schema_dumper'
 
-  class CreateLoan < ActiveRecord::Migration
-    def change
-      suppress_messages do
-        create_table :loans do |t|
-          t.string :name
+  # migrations used in tests. our factories/fixtures
+  # their class names are the same if they are functionally
+  # equivalent, but are organized in different modules depending on
+  # whether it is implemented using
+  # schema_statements, create_table or change_table
+  module SchemaStatements
+    class CreateLoanAndMoney < ActiveRecord::Migration
+      def change
+        suppress_messages do
+          create_table :loans do |t|
+            t.string :name
+          end
+          add_money :loans, :principal
         end
       end
     end
-  end
 
-  class AddPrincipalToLoan < ActiveRecord::Migration
-    def change
-      suppress_messages do
-        change_table :loans do |t|
-          t.money :principal
+    class CreateLoanWithCurrency < ActiveRecord::Migration
+      def change
+        suppress_messages do
+          create_table :loans do |t|
+            t.string :name
+            t.currency
+          end
+          add_money :loans, :principal, :repaid, :npa
         end
       end
     end
-  end
 
-  class CreateLoanWithPrincipal < ActiveRecord::Migration
-    def change
-      suppress_messages do
-        create_table :loans do |t|
-          t.string :name
+    class RemoveMoneyColumnsFromLoan  < ActiveRecord::Migration
+      def change
+        suppress_messages do
+          remove_money :loans, :principal, :repaid, :npa
         end
-        add_money :loans, :principal
       end
     end
-  end
 
-  class RemovePrincipalFromLoan < ActiveRecord::Migration
-    def change
-      suppress_messages do
-        remove_money :loans, :principal
+    class RemoveMoneyColumnsExceptPrincipalFromLoan < ActiveRecord::Migration
+      def change
+        suppress_messages do
+          remove_money :loans, :repaid, :npa
+        end
       end
     end
-  end
 
-  class CreateLoanWithPrincipalUsingTableApi < ActiveRecord::Migration
-    def change
-      suppress_messages do
-        create_table :loans do |t|
-          t.string :name
-          t.money  :principal
+    class RemovePrincipalFromLoan < ActiveRecord::Migration
+      def change
+        suppress_messages do
+          remove_money :loans, :principal
         end
       end
     end
-  end
 
-  class RemovePrincipalFromLoanUsingTableApi < ActiveRecord::Migration
-    def change
-      suppress_messages do
-        change_table :loans do |t|
-          t.remove_money :principal
+    class RemoveCurrencyFromLoan < ActiveRecord::Migration
+      def change
+        suppress_messages do
+          remove_currency :loans
         end
       end
     end
-  end
+  end # module SchemaStatements
 
-  class CreateLoanWithMultipleMoneyColumns < ActiveRecord::Migration
-    def change
-      suppress_messages do
-        create_table :loans, force: true do |t|
-          t.string :name
-          t.money  :principal
-          t.money  :repaid
-          t.money  :npa
+  module ChangeTable
+    class AddPrincipalToLoan < ActiveRecord::Migration
+      def change
+        suppress_messages do
+          change_table :loans do |t|
+            t.money :principal
+          end
         end
       end
     end
-  end
 
-  class CreateLoanWithSingleCurrencyColumnGivenLast < ActiveRecord::Migration
-    def change
-      suppress_messages do
-        create_table :loans, force: true do |t|
-          t.string :name
-          t.money  :principal
-          t.money  :repaid
-          t.money  :npa
-          t.currency
+    class RemoveCurrencyFromLoan < ActiveRecord::Migration
+      def change
+        suppress_messages do
+          change_table :loans, force: true do |t|
+            t.remove_currency
+          end
         end
       end
     end
-  end
 
-  class CreateLoanWithSingleCurrencyColumnGivenFirst < ActiveRecord::Migration
-    def change
-      suppress_messages do
-        create_table :loans, force: true do |t|
-          t.string :name
-          t.currency
-          t.money  :principal
-          t.money  :repaid
-          t.money  :npa
+    class RemovePrincipalFromLoan < ActiveRecord::Migration
+      def change
+        suppress_messages do
+          change_table :loans do |t|
+            t.remove_money :principal
+          end
+        end
+      end
+    end
+    
+    class AddSingleCurrencyToLoan < ActiveRecord::Migration
+      def change
+        suppress_messages do
+          change_table :loans, force: true do |t|
+            t.currency
+          end
         end
       end
     end
-  end
 
-  class CreateLoanWithSingleCurrencyColumnOrderDoesNotMatter < ActiveRecord::Migration
-    def change
-      suppress_messages do
-        create_table :loans, force: true do |t|
-          t.string :name
-          t.money  :principal
-          t.money  :repaid
-          t.currency
-          t.money  :npa
+    class RemoveMoneyColumnsFromLoan < ActiveRecord::Migration
+      def change
+        suppress_messages do
+          change_table :loans, force: true do |t|
+            t.remove_money :principal, :repaid, :npa
+          end
         end
       end
     end
-  end
 
-  class RemoveCurrencyFromLoan < ActiveRecord::Migration
-    def change
-      suppress_messages do
-        change_table :loans, force: true do |t|
-          t.remove_currency
+    class RemoveMoneyColumnsExceptPrincipalFromLoan < ActiveRecord::Migration
+      def change
+        suppress_messages do
+          change_table :loans, force: true do |t|
+            t.remove_money :repaid, :npa
+          end
         end
       end
     end
-  end
+  end # module ChangeTable
 
-  class AddSingleCurrencyToLoan < ActiveRecord::Migration
-    def change
-      suppress_messages do
-        change_table :loans, force: true do |t|
-          t.currency
+  module CreateTableDefinition
+    class CreateLoan < ActiveRecord::Migration
+      def change
+        suppress_messages do
+          create_table :loans do |t|
+            t.string :name
+          end
         end
       end
     end
-  end
+
+    class CreateLoanAndMoney < ActiveRecord::Migration
+      def change
+        suppress_messages do
+          create_table :loans do |t|
+            t.string :name
+            t.money  :principal
+          end
+        end
+      end
+    end
+
+    class CreateLoanWithCurrency < ActiveRecord::Migration
+      def change
+        suppress_messages do
+          create_table :loans, force: true do |t|
+            t.string :name
+            t.money  :principal
+            t.money  :repaid
+            t.money  :npa
+            t.currency
+          end
+        end
+      end
+    end
+
+    class CreateLoanWithoutCurrency < ActiveRecord::Migration
+      def change
+        suppress_messages do
+          create_table :loans, force: true do |t|
+            t.string :name
+            t.money  :principal
+            t.money  :repaid
+            t.money  :npa
+          end
+        end
+      end
+    end
+    
+    class CreateLoanWithCurrencySpecifiedFirst < ActiveRecord::Migration
+      def change
+        suppress_messages do
+          create_table :loans, force: true do |t|
+            t.string :name
+            t.currency
+            t.money  :principal
+            t.money  :repaid
+            t.money  :npa
+          end
+        end
+      end
+    end
+
+    class CreateLoanWithCurrencySpecifiedInBetween  < ActiveRecord::Migration
+      def change
+        suppress_messages do
+          create_table :loans, force: true do |t|
+            t.string :name
+            t.money  :principal
+            t.money  :repaid
+            t.currency
+            t.money  :npa
+          end
+        end
+      end
+    end
+  end # module CreateTableDefinition
   
   # class Loan < ActiveRecord::Base   
   #   attr_accessible :principal, :name
   #   # money :principal
   # end
   
-  describe "migration" do
+  describe "Migrating Money columns" do
 
     let(:schema_with_principal) do
       <<-EOF.strip_spaces
@@ -158,6 +225,16 @@ if defined? ActiveRecord
 EOF
     end
 
+    let(:schema_with_principal_and_single_currency_column) do
+      <<-EOF.strip_spaces
+  create_table "loans", :force => true do |t|
+    t.string  "name"
+    t.integer "principal_money"
+    t.string  "currency"
+  end
+EOF
+    end
+
     let(:schema_with_only_name) do
       <<-EOF.strip_spaces
   create_table "loans", :force => true do |t|
@@ -192,75 +269,132 @@ EOF
 EOF
     end
 
-    context "schema_statements" do
-      before(:each) do
-        migrate CreateLoanWithPrincipal
-      end
+    context "and testing schema statements", :schema_statements do
+      context "which have one currency column for each money column" do
+        before(:each) do
+          migrate SchemaStatements::CreateLoanAndMoney
+        end
 
-      describe "add_money" do
-        it "creates integer column for money and a string column for currency" do
-          expect(dump_schema).to eq schema_with_principal
+        describe "#add_money" do
+          it "creates two columns for each money attribute. one to store the lower denomination as an integer and the currency as a string" do
+            expect(dump_schema).to eq schema_with_principal
+          end
         end
-      end
       
-      describe "remove_money" do
-        it "remove integer column for money and a string column for currency" do        
-          expect { migrate RemovePrincipalFromLoan }.to change { dump_schema }.from(schema_with_principal).to(schema_with_only_name)
+        describe "#remove_money" do
+          it "drops two columns for each money attribute. one which stored the lower denomination as an integer and the currency as a string" do
+            expect { migrate SchemaStatements::RemovePrincipalFromLoan }.to change { dump_schema }.from(schema_with_principal).to(schema_with_only_name)
+          end
         end
       end
-    end
 
-    context "table_statements" do
-      before(:each) do
-        migrate CreateLoanWithPrincipalUsingTableApi
-      end
-      
-      describe "add_money" do
-        it "creates integer column for money and a string column for currency" do
-          expect(dump_schema).to eq schema_with_principal
+      context "which has a single currency", :single_currency do
+        before(:each) do
+          migrate SchemaStatements::CreateLoanWithCurrency
         end
-      end
-      
-      describe "remove_money" do
-        it "remove integer column for money and a string column for currency" do        
-          expect { migrate RemovePrincipalFromLoanUsingTableApi }.to change { dump_schema }.from(schema_with_principal).to(schema_with_only_name)
+
+        describe "#add_money" do
+          it "creates one column for each money attribute, to store the lower denomination as an integer. currency is stored in a common column" do
+            expect(dump_schema).to eq schema_with_single_currency_column
+          end
         end
-      end
-    end
 
-    context "single currency column", :single_currency do
-      it "creates integer columns for money and a single string column for currency" do
-        migrate CreateLoanWithSingleCurrencyColumnGivenLast
-        expect(dump_schema).to eq schema_with_single_currency_column
-      end
+        describe "#remove_money" do
+          it "drops the money column for each money attribute and the common currency column as well", :fixme, :fixme_need_to_clear_table_cache do
+            expect { migrate SchemaStatements::RemoveMoneyColumnsFromLoan }.to change { dump_schema }.from(schema_with_single_currency_column).to(schema_with_only_name)
+          end
 
-      context "order does not matter" do
-        it "creates integer columns for money and a single string column for currency even when currency column is given first"  do
-          migrate CreateLoanWithSingleCurrencyColumnGivenFirst
-          expect(dump_schema).to eq schema_with_single_currency_column
+          it "drops the money column for each money attribute but keeps the common currency column because some money columns still remain" do
+            expect { migrate SchemaStatements::RemoveMoneyColumnsExceptPrincipalFromLoan }.to change { dump_schema }.
+              from(schema_with_single_currency_column).
+              to(schema_with_principal_and_single_currency_column)
+          end
         end
 
-        it "creates integer columns for money and a single string column for currency even when currency column is given in between" do
-          migrate CreateLoanWithSingleCurrencyColumnOrderDoesNotMatter
-          expect(dump_schema).to eq schema_with_single_currency_column
+        describe "#remove_currency" do
+          it "drops the common currency column and adds a currency columns to each of the existing money columns" do
+            expect { migrate SchemaStatements::RemoveCurrencyFromLoan }.to change { dump_schema }.from(schema_with_single_currency_column).to(schema_with_multiple_currency_columns)
+          end
+
+          pending "remove currency while side-by-side adding a money column"
         end
       end
+    end # context "schema_statements"
 
-      it "can remove the currency column later" do
-        migrate CreateLoanWithSingleCurrencyColumnGivenLast
-        expect { migrate RemoveCurrencyFromLoan }.to change { dump_schema }.from(schema_with_single_currency_column).to(schema_with_multiple_currency_columns)
-      end
+    context "and testing table statements", :table_statements do
+      context "which have one currency column for each money column" do
+        before(:each) do
+          migrate CreateTableDefinition::CreateLoanAndMoney
+        end
+        
+        describe "#add_money" do
+          it "creates two columns for each money attribute. one to store the lower denomination as an integer and the currency as a string" do
+            expect(dump_schema).to eq schema_with_principal
+          end
+        end
 
-      it "can add a single currrency column later" do
-        migrate CreateLoanWithMultipleMoneyColumns
-        expect { migrate AddSingleCurrencyToLoan }.to change { dump_schema }.from(schema_with_multiple_currency_columns).to(schema_with_single_currency_column)
+        describe "#remove_money" do
+          it "drops two columns for each money attribute. one which stored the lower denomination as an integer and the currency as a string" do
+            expect { migrate ChangeTable::RemovePrincipalFromLoan }.to change { dump_schema }.from(schema_with_principal).to(schema_with_only_name)
+          end
+        end
       end
-    end
+
+      context "which has a single currency", :single_currency do
+        describe "#add_money" do
+          context "and tests that order of statements does not matter" do
+            it "creates money and common currency cilumns when currency column is specified last" do
+              migrate CreateTableDefinition::CreateLoanWithCurrency
+              expect(dump_schema).to eq schema_with_single_currency_column
+            end
+            
+            it "creates money and common currency cilumns when currency column is specified first" do
+              migrate CreateTableDefinition::CreateLoanWithCurrencySpecifiedFirst
+              expect(dump_schema).to eq schema_with_single_currency_column
+            end
+
+            it "creates money and common currency cilumns when currency column is specified in-between" do
+              migrate CreateTableDefinition::CreateLoanWithCurrencySpecifiedInBetween
+              expect(dump_schema).to eq schema_with_single_currency_column
+            end
+          end
+        end
+
+        describe "#remove_money" do
+          before(:each) do
+            migrate CreateTableDefinition::CreateLoanWithCurrency
+          end
+          
+          it "drops the money column for each money attribute and the common currency column as well" do
+            expect { migrate ChangeTable::RemoveMoneyColumnsFromLoan }.to change { dump_schema }.from(schema_with_single_currency_column).to(schema_with_only_name)
+          end
+          
+          it "drops the money column for each money attribute but keeps the common currency column because some money columns still remain" do
+            expect { migrate ChangeTable::RemoveMoneyColumnsExceptPrincipalFromLoan }.to change { dump_schema }.
+              from(schema_with_single_currency_column).
+              to(schema_with_principal_and_single_currency_column)
+          end
+        end
+        
+        describe "#remove_currency" do
+          it "drops the common currency column and adds a currency columns to each of the existing money columns" do
+            migrate CreateTableDefinition::CreateLoanWithCurrency
+            expect { migrate ChangeTable::RemoveCurrencyFromLoan }.to change { dump_schema }.from(schema_with_single_currency_column).to(schema_with_multiple_currency_columns)
+          end
+        end
+          
+        it "can add a single currrency column later" do
+          migrate CreateTableDefinition::CreateLoanWithoutCurrency
+          expect { migrate ChangeTable::AddSingleCurrencyToLoan }.to change { dump_schema }.from(schema_with_multiple_currency_columns).to(schema_with_single_currency_column)
+        end
+      end # context "which has a single currency"
+    end # context "and testing table statements"
 
     it "can add a money column later" do
-      migrate CreateLoan
-      expect { migrate AddPrincipalToLoan }.to change { dump_schema }.from(schema_with_only_name).to(schema_with_principal)
+      migrate CreateTableDefinition::CreateLoan
+      expect { migrate ChangeTable::AddPrincipalToLoan }.to change { dump_schema }.from(schema_with_only_name).to(schema_with_principal)
     end
 
-  end # describe "migration"
+    pending "separate up and down migration methods. using add_money and remove_money"
+  end # describe "Migrating Money columns"
 end # if defined? ActiveRecord