easy_rails_money 0.0.1

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+.rvmrc
+NOTES

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in easy_rails_money.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Deepak Kannan
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,165 @@
+Under Development. only the migration part is done now
+
+# EasyRailsMoney
+
+This library provides integration of [money](http://github.com/Rubymoney/money) gem with Rails.
+
+Use 'money' to specify which fields you want to be backed by a Money
+object
+
+[money-rails](https://github.com/RubyMoney/money-rails) is much more
+popular and full-featured. Definately try it out. I have actually
+submitted a PR to that project and it is actively maintained.
+
+I have tried to create a simpler version of [money-rails](https://github.com/RubyMoney/money-rails)
+With a better API and database schema, in my opinion
+I created this project to scratch my itch.
+
+Have stolen lots of code from [money-rails](https://github.com/RubyMoney/money-rails)
+API and tests are written from scratch
+
+## How it works
+
+Let us say you want to store a Rupee Money object in the database
+
+```ruby
+principal = Money.new(100, "inr")
+```  
+
+Option 1:
+```ruby
+class CreateLoan < ActiveRecord::Migration
+  def change
+    create_table :loans do |t|
+      t.integer       :principal
+      t.string        :principal_currency
+    end
+  end
+end
+```
+
+Option 2:
+Another option would be
+```ruby
+class CreateLoan < ActiveRecord::Migration
+  def change
+    create_table :loans do |t|
+      t.integer       :principal_as_paise
+    end
+  end
+end
+```
+
+Note that we are storing the base unit in the database. If the amount
+is in dollars we store in cents or if the amount is in Indian Rupees
+we store in paise and so on. This is done because FLoats do not have a
+accurate representation but Integers do. Can store BigDecimal as well
+but it is slower. This is why the Money gem stores amounts as integer
+Watch [Rubyconf 2011 Float-is-legacy](http://www.confreaks.com/videos/698-rubyconf2011-float-is-legacy) for more details
+
+We have encoded the currency in the column name. I like it because
+there is no need to define another column and it is simple. But the
+disadvantage is that it is inflexible and changing the column name in
+Mysql might require downtime for a big table
+
+So let us go with the first option. The disadvantage is that currency
+is stored as a string. Integer might be better for storing in the database
+
+Now let us say we want to store multiple columns:
+
+```ruby
+principal = Money.new(100, "inr")
+repaid    = Money.new(20, "inr")
+npa       = Money.new(10, "inr")
+```  
+
+Now we would represent it as
+
+```ruby
+class CreateLoan < ActiveRecord::Migration
+  def change
+    create_table :loans do |t|
+      t.integer       :principal
+      t.string        :principal_currency
+      t.integer       :repaid
+      t.string        :repaid_currency
+      t.integer       :npa
+      t.string        :npa_currency
+    end
+  end
+end
+```
+
+We are repeating ourself and mostly all currencies for a record will be
+the same. So we can configure the currency on a per-record basis and write
+
+Option 3:
+```ruby
+class CreateLoan < ActiveRecord::Migration
+  def change
+    create_table :loans do |t|
+      t.string        :currency
+      t.integer       :principal
+      t.integer       :repaid
+      t.integer       :npa
+    end
+  end
+end
+```
+
+It might be possible that we set a currency once for the whole app and
+never change it. But this seems like a nice tradeoff api-wise
+
+### TODO's
+1. currency is stored as a string. Integer might be better for storing in the database
+2. store a snapshot of the exchange rate as well when the record was
+   inserted or if we want to "freeze" the exchange rate per-record
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'easy_rails_money'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install easy_rails_money
+
+## Usage
+
+### ActiveRecord
+
+Only ActiveRecord is supported for now
+
+#### Migration helpers
+
+If you want to add money field to product model you may use ```add_money``` helper
+
+```ruby
+class MonetizeLoan < ActiveRecord::Migration
+  def change
+    add_money :loans, :principal
+
+    # OR
+
+    change_table :products do |t|
+      t.money :principal
+    end
+  end
+end
+```
+
+```add_money``` helper is revertable, so you may use it inside ```change``` migrations.
+If you writing separate ```up``` and ```down``` methods, you may use ```remove_money``` helper.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+# If you want to make this the default task
+task :default => :spec

data/easy_rails_money.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'easy_rails_money/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "easy_rails_money"
+  gem.version       = EasyRailsMoney::VERSION
+  gem.authors       = ["Deepak Kannan"]
+  gem.email         = ["kannan.deepak@gmail.com"]
+  gem.description   = %q{Integrate Rails's ActiveRecord gem and the money gem. Focus is on a simple code and API}
+  gem.summary       = %q{Integrate rails and the money gem}
+  gem.homepage      = "https://github.com/deepak/easy_rails_money"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency "money",         "~> 5.1.1"
+  gem.add_dependency "activesupport", "~> 3.2"
+  
+  gem.add_development_dependency "rspec",        "~> 2.12"
+  gem.add_development_dependency "rails",        "~> 3.2"
+  gem.add_development_dependency "activerecord", "~> 3.2"
+  gem.add_development_dependency "sqlite3",      "~> 1.3.7"
+  gem.add_development_dependency "debugger",     "~> 1.3.3"
+end

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

@@ -0,0 +1,21 @@
+module EasyRailsMoney
+  module ActiveRecord
+    module Migration
+      module SchemaStatements
+        def add_money(table_name, *columns)
+          columns.each do |name|
+            add_column table_name, name,               :integer
+            add_column table_name, "#{name}_currency", :string
+          end
+        end
+
+        def remove_money(table_name, *columns)
+          columns.each do |name|
+            remove_column table_name, name
+            remove_column table_name, "#{name}_currency"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+module EasyRailsMoney
+  module ActiveRecord
+    module Migration
+      module Table
+        def money(*columns)
+          columns.each do |name|
+            column name,               :integer
+            column "#{name}_currency", :string
+          end
+        end
+
+        def remove_money(*columns)
+          columns.each do |name|
+            remove name,               :integer
+            remove "#{name}_currency", :string
+          end
+        end
+      end
+    end
+  end
+end

data/lib/easy_rails_money/active_record/money_dsl.rb

@@ -0,0 +1,17 @@
+require 'active_support/concern'
+require 'active_support/core_ext/array/extract_options'
+
+module EasyRailsMoney
+  module ActiveRecord
+    module MoneyDsl
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+        def money(field, *args)
+          options = args.extract_options!          
+        end
+      end
+      
+    end
+  end
+end

data/lib/easy_rails_money/active_record.rb

@@ -0,0 +1,8 @@
+require "easy_rails_money/active_record/money_dsl"
+require "easy_rails_money/active_record/migration/schema_statements"
+require "easy_rails_money/active_record/migration/table"
+
+ActiveRecord::Base.send :include, EasyRailsMoney::ActiveRecord::MoneyDsl
+ActiveRecord::Migration.send :include, EasyRailsMoney::ActiveRecord::Migration::SchemaStatements
+ActiveRecord::ConnectionAdapters::TableDefinition.send :include, EasyRailsMoney::ActiveRecord::Migration::Table
+ActiveRecord::ConnectionAdapters::Table.send :include, EasyRailsMoney::ActiveRecord::Migration::Table

data/lib/easy_rails_money/configuration.rb

@@ -0,0 +1,13 @@
+require 'active_support/core_ext/module/delegation'
+
+module EasyRailsMoney
+  module Configuration
+    def configure
+      yield self
+    end
+
+    # Configuration parameters
+    delegate :default_currency=, :to => :Money
+    delegate :default_currency, :to => :Money
+  end
+end

data/lib/easy_rails_money/version.rb

@@ -0,0 +1,3 @@
+module EasyRailsMoney
+  VERSION = "0.0.1"
+end

data/lib/easy_rails_money.rb

@@ -0,0 +1,11 @@
+require "money"
+require "easy_rails_money/version"
+require "easy_rails_money/configuration"
+
+module EasyRailsMoney
+  extend Configuration
+end
+
+if defined? ActiveRecord
+  require "easy_rails_money/active_record"
+end

data/spec/active_record/migration_spec.rb

@@ -0,0 +1,120 @@
+require 'spec_helper'
+require 'active_record_spec_helper'
+require 'tempfile'
+
+class String
+  def strip_spaces
+    strip.gsub(/\s+/, ' ')
+  end
+end
+
+if defined? ActiveRecord
+
+  require 'active_record/schema_dumper'
+
+  class CreateLoanWithPrincipal < ActiveRecord::Migration
+    def change
+      suppress_messages do
+        create_table :loans do |t|
+          t.string :name
+        end
+        add_money :loans, :principal
+      end
+    end
+  end
+
+  class RemovePrincipalFromLoan < ActiveRecord::Migration
+    def change
+      suppress_messages do
+        remove_money :loans, :principal
+      end
+    end
+  end
+
+  class CreateLoanWithPrincipalUsingTableApi < ActiveRecord::Migration
+    def change
+      suppress_messages do
+        create_table :loans do |t|
+          t.string :name
+          t.money  :principal
+        end
+      end
+    end
+  end
+
+  class RemovePrincipalFromLoanUsingTableApi < ActiveRecord::Migration
+    def change
+      suppress_messages do
+        change_table :loans do |t|
+          t.remove_money :principal
+        end
+      end
+    end
+  end
+  
+  # class Loan < ActiveRecord::Base   
+  #   attr_accessible :principal, :name
+  #   # money :principal
+  # end
+  
+  describe "migration" do
+
+    let(:schema_with_principal) do
+      <<-EOF.strip_spaces
+  create_table "loans", :force => true do |t|
+    t.string  "name"
+    t.integer "principal"
+    t.string  "principal_currency"
+  end
+EOF
+    end
+
+    let(:schema_with_only_name) do
+      <<-EOF.strip_spaces
+  create_table "loans", :force => true do |t|
+    t.string  "name"
+  end
+EOF
+    end
+
+    context "schema_statements" do
+      before(:each) do
+        migrate CreateLoanWithPrincipal
+      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
+        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)
+        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
+        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)
+        end
+      end
+    end
+    
+    
+  end
+end
+
+

data/spec/active_record/money_dsl_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+require 'active_record_spec_helper'
+
+if defined? ActiveRecord
+  describe EasyRailsMoney::ActiveRecord::MoneyDsl do
+    describe "money" do
+      # validations
+      # accessors
+    end
+  end
+end

data/spec/active_record_spec_helper.rb

@@ -0,0 +1,42 @@
+module SchemaHelpers
+  def dump_schema
+    Tempfile.open('schema', encoding: "utf-8") do |schema_file|
+      ActiveRecord::SchemaDumper.send(:new, ActiveRecord::Base.connection).send(:tables, schema_file)
+      schema_file.rewind
+      schema_file.read.strip_spaces
+    end
+  end
+
+  def create_ar_connection
+    conn = { :adapter => 'sqlite3', :database => ':memory:' }
+
+    begin
+      ActiveRecord::Base.establish_connection(conn)
+      ActiveRecord::Base.connection
+    rescue Exception => e
+      $stderr.puts e, *(e.backtrace)
+      $stderr.puts "Couldn't create database for #{conn.inspect}"
+      return
+    end
+  end
+
+  def migrate klass
+    klass.migrate(:up)
+  end
+end
+
+module ActiveRecord
+  class Migration
+    def announce(message)
+      # noop
+    end
+  end
+end
+
+RSpec.configure do |c|
+  c.include SchemaHelpers
+
+  c.before(:each) do
+    create_ar_connection
+  end
+end

data/spec/configuration_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe "Configuration" do
+
+  describe "#default_currency=" do
+    let(:existing_currency) { Money::Currency.new(:usd) }
+    let(:new_currency) { Money::Currency.new(:inr) }
+
+    before(:each) do       
+      Money.default_currency = existing_currency
+    end
+    
+    it "sets default currency" do
+      expect { EasyRailsMoney.default_currency = new_currency }.
+        to change { Money.default_currency }.
+        from(existing_currency).
+        to(new_currency)
+    end
+
+    it "reads default currency" do
+      expect { EasyRailsMoney.default_currency = new_currency }.
+        to change { EasyRailsMoney.default_currency }.
+        from(existing_currency).
+        to(new_currency)
+    end
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'active_record'
+require_relative '../lib/easy_rails_money'
+
+

metadata

@@ -0,0 +1,181 @@
+--- !ruby/object:Gem::Specification
+name: easy_rails_money
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Deepak Kannan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: money
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 5.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 5.1.1
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.12'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.7
+- !ruby/object:Gem::Dependency
+  name: debugger
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.3
+description: Integrate Rails's ActiveRecord gem and the money gem. Focus is on a simple
+  code and API
+email:
+- kannan.deepak@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- easy_rails_money.gemspec
+- lib/easy_rails_money.rb
+- lib/easy_rails_money/active_record.rb
+- lib/easy_rails_money/active_record/migration/schema_statements.rb
+- lib/easy_rails_money/active_record/migration/table.rb
+- lib/easy_rails_money/active_record/money_dsl.rb
+- lib/easy_rails_money/configuration.rb
+- lib/easy_rails_money/version.rb
+- spec/active_record/migration_spec.rb
+- spec/active_record/money_dsl_spec.rb
+- spec/active_record_spec_helper.rb
+- spec/configuration_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/deepak/easy_rails_money
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Integrate rails and the money gem
+test_files:
+- spec/active_record/migration_spec.rb
+- spec/active_record/money_dsl_spec.rb
+- spec/active_record_spec_helper.rb
+- spec/configuration_spec.rb
+- spec/spec_helper.rb