economy 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ea083151226d83d5359adb1745e8407d27b00461
+  data.tar.gz: a8c38d7e246dc84fed0a34f6f4e6387539cc74d2
+SHA512:
+  metadata.gz: d13e3f648a339a0ee0998fe7bfa929682c0e0faa21b7d56935867c3674b283edaa5445d4d84e49ce385f3ee51d38f5b6d89f46614a0ee18f9c0899b11298b4be
+  data.tar.gz: 7701b8a3bdbd7a64dd51a8f544b5af9fee23e27a5e2443f8302b1acd43d66189e6002ada1a9065fd0a67a08978e0897e6a38dc15b6c64cfd12ad48dcf7463e49

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 Mathías Montossi
+
+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,129 @@
+[![Gem Version](https://badge.fury.io/rb/economy.svg)](http://badge.fury.io/rb/economy)
+[![Code Climate](https://codeclimate.com/github/mmontossi/economy/badges/gpa.svg)](https://codeclimate.com/github/mmontossi/economy)
+[![Build Status](https://travis-ci.org/mmontossi/economy.svg)](https://travis-ci.org/mmontossi/economy)
+[![Dependency Status](https://gemnasium.com/mmontossi/economy.svg)](https://gemnasium.com/mmontossi/economy)
+
+# Economy
+
+High performance multicurrency money for rails.
+
+## Why
+
+I did this gem to add some enhancements to my projects:
+
+- Keep rates cached in redis for optimal performance and sync between instances.
+- Out of the box working rates service.
+- Be able to make sql queries without the need to convert integers to decimals.
+- Share a common currency column for multiple money fields if a need it.
+- Avoid the need to format manually the string representation in views.
+
+## Install
+
+Put this line in your Gemfile:
+```ruby
+gem 'economy'
+```
+
+Then bundle:
+```
+$ bundle
+```
+
+To install Redis you can use homebrew:
+```
+brew install redis
+```
+
+## Configuration
+
+Generate the configuration file:
+```
+rails g economy:install
+```
+
+The defaults are:
+```ruby
+Economy.configure do |config|
+
+  config.rates = :yahoo
+  config.default_currency = 'USD'
+
+  config.add_currency(
+    iso_code: 'USD',
+    iso_number: 840,
+    symbol: 'U$S',
+    decimals: 2
+  )
+
+end
+```
+
+## Definition
+
+Add the money columns to your tables:
+```ruby
+class AddPriceToProducts < ActiveRecord::Migration
+  def change
+    add_column :products, :price, :decimal, precision: 24, scale: 6
+    add_column :products, :currency, :string, limit: 3 # Or :price_currency
+  end
+end
+```
+
+Define the money field in your models:
+```ruby
+class Product < ActiveRecord::Base
+
+  monetize :price
+
+end
+```
+
+## Usage
+
+If you want to assign values, everything continuos working the same:
+```ruby
+product.price = 20.00
+product.currency = 'USD'
+```
+
+Arithmetics are intuitive:
+```ruby
+product.price * 2 # => U$S 40
+product.price / 2 # => U$S 10
+
+product.price + Economy::Money.new(10, 'USD') # => U$S 30
+product.price - Economy::Money.new(10, 'USD') # => U$S 10
+```
+
+To exchange to another currency:
+```ruby
+product.price.exchange_to 'UYU'
+```
+
+The formatting method is to_s, it uses active support, so there is no need to call a helper in your views:
+```erb
+<%= product.price %>
+```
+
+## Rates
+
+You can use rake task:
+```
+bundle exec rake economy:update_rates
+```
+
+Or the plain method:
+```ruby
+Economy.update_rates
+```
+
+NOTE: You probably want to put the rake task into a cronjob.
+
+## Credits
+
+This gem is maintained and funded by [mmontossi](https://github.com/mmontossi).
+
+## License
+
+It is free software, and may be redistributed under the terms specified in the MIT-LICENSE file.

data/Rakefile

@@ -0,0 +1,19 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+  t.warning = false
+end
+
+task default: :test

data/lib/economy.rb

@@ -0,0 +1,43 @@
+require 'generators/economy/install_generator'
+require 'economy/extensions/active_record/base'
+require 'economy/rates/base'
+require 'economy/rates/yahoo'
+require 'economy/builder'
+require 'economy/cache'
+require 'economy/configuration'
+require 'economy/currencies'
+require 'economy/currency'
+require 'economy/money'
+require 'economy/railtie'
+require 'economy/version'
+
+module Economy
+  class << self
+
+    def cache
+      @cache ||= Cache.new
+    end
+
+    def currencies
+      @currencies ||= Currencies.new
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield configuration
+    end
+
+    def update_rates
+      class_name = configuration.rates.to_s.classify
+      rates = Rates.const_get(class_name).new
+      rates.fetch.each do |from, to, rate|
+        puts "Updating exchange #{from} => #{to} with rate #{rate}"
+        Exchange.create service: class_name, from: from, to: to, rate: rate
+      end
+    end
+
+  end
+end

data/lib/economy/builder.rb

@@ -0,0 +1,81 @@
+module Economy
+  class Builder
+
+    attr_reader :model, :concern
+
+    def initialize(model)
+      @model = model
+      @concern = Module.new
+    end
+
+    def define(attributes)
+      attributes.each do |attribute|
+        if model.column_names.include?("#{attribute}_currency")
+          currency_attribute = :"#{attribute}_currency"
+        else
+          currency_attribute = :currency
+        end
+        set_validators attribute, currency_attribute
+        define_helpers attribute
+        default_currency = Economy.configuration.default_currency
+        define_getter attribute, currency_attribute, default_currency
+        define_setter attribute, currency_attribute, default_currency
+      end
+      model.include concern
+    end
+
+    private
+
+    def set_validators(attribute, currency_attribute)
+      model.validates_presence_of currency_attribute, if: -> {
+        value = read_attribute(attribute)
+        value && value > 0
+      }
+      model.validates_length_of currency_attribute, is: 3, allow_blank: true
+    end
+
+    def define_helpers(attribute)
+      concern.class_eval do
+        define_method "#{attribute}_came_from_user?" do
+          true
+        end
+        define_method "#{attribute}_before_type_cast" do
+          send(attribute).to_json
+        end
+      end
+    end
+
+    def define_getter(attribute, currency_attribute, default_currency)
+      concern.class_eval do
+        define_method attribute do
+          value = read_attribute(attribute)
+          currency = send(currency_attribute)
+          Economy::Money.new(
+            (value || 0),
+            (currency || default_currency)
+          )
+        end
+      end
+    end
+
+    def define_setter(attribute, currency_attribute, default_currency)
+      concern.class_eval do
+        define_method "#{attribute}=" do |value|
+          case value
+          when Money
+            if currency_attribute == :currency
+              currency = (send(currency_attribute) || default_currency)
+              write_attribute attribute, value.exchange_to(currency).amount
+            else
+              write_attribute attribute, value.amount
+              write_attribute currency_attribute, value.currency.iso_code
+            end
+          else
+            write_attribute attribute, value
+          end
+        end
+      end
+    end
+
+  end
+end

data/lib/economy/cache.rb

@@ -0,0 +1,26 @@
+module Economy
+  class Cache
+
+    def get(from, to)
+      client.get "exchanges/#{from.iso_code.downcase}/#{to.iso_code.downcase}"
+    end
+
+    def set(exchange)
+      client.set "exchanges/#{exchange.from.downcase}/#{exchange.to.downcase}", exchange.rate.to_s
+    end
+
+    def clear
+      client.del 'exchanges/*'
+    end
+
+    private
+
+    def client
+      @client ||= begin
+        require 'redis'
+        Redis.new url: Rails.configuration.redis_url
+      end
+    end
+
+  end
+end

data/lib/economy/configuration.rb

@@ -0,0 +1,11 @@
+module Economy
+  class Configuration
+
+    attr_accessor :rates, :default_currency
+
+    def add_currency(*args)
+      Economy.currencies.add *args
+    end
+
+  end
+end

data/lib/economy/currencies.rb

@@ -0,0 +1,34 @@
+module Economy
+  class Currencies
+
+    def exist?(id)
+      registry.has_key? id
+    end
+
+    def find(id)
+      if exist?(id)
+        registry[id]
+      else
+        raise "Currency #{id} not found"
+      end
+    end
+
+    def add(*args)
+      currency = Currency.new(*args)
+      registry[currency.iso_code] = currency
+    end
+
+    %i(each map).each do |name|
+      define_method name do |*args, &block|
+        registry.values.send name, *args, &block
+      end
+    end
+
+    private
+
+    def registry
+      @registry ||= {}
+    end
+
+  end
+end

data/lib/economy/currency.rb

@@ -0,0 +1,28 @@
+module Economy
+  class Currency
+
+    attr_reader :iso_code, :iso_number
+
+    def initialize(assignments)
+      %i(iso_code iso_number symbol decimals).each do |name|
+        instance_variable_set "@#{name}", assignments[name]
+      end
+      unless iso_code
+        raise "Iso code can't be empty"
+      end
+    end
+
+    def symbol
+      @symbol || '$'
+    end
+
+    def decimals
+      @decimals || 2
+    end
+
+    def ==(other)
+      other.is_a?(Currency) && other.iso_code == iso_code
+    end
+
+  end
+end

data/lib/economy/exchange.rb

@@ -0,0 +1,17 @@
+module Economy
+  class Exchange < ActiveRecord::Base
+
+    after_commit :cache, on: :create
+
+    validates_presence_of :service, :from, :to, :rate
+    validates_length_of :from, :to, is: 3
+    validates_numericality_of :rate, greater_than: 0
+
+    private
+
+    def cache
+      Economy.cache.set self
+    end
+
+  end
+end

data/lib/economy/extensions/active_record/base.rb

@@ -0,0 +1,18 @@
+module Economy
+  module Extensions
+    module ActiveRecord
+      module Base
+        extend ActiveSupport::Concern
+
+        module ClassMethods
+
+          def monetize(*attributes)
+            builder = Builder.new(self)
+            builder.define attributes
+          end
+
+        end
+      end
+    end
+  end
+end