snappler_contable_multicurrency 2.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a1e2fbc479081a3898df533c376dc2d605b867b7
+  data.tar.gz: 433542dbeff287ff71ebabbb9f3afaf52236ca97
+SHA512:
+  metadata.gz: 7992a3fda9c994ea273f2633974723cbd2002e268b82ec4752825d50d6464a410c28cc0055a8433105fad687f201d3f582e04e3bfc5755bd0c1ca896eda096e8
+  data.tar.gz: 8ecfc911339bad0ae748e8cbc6956fbc798af6af9c94036141e911d50365aff67e46133f37ec01808550af11d3c63209fae623ac4b9736ffbe601e7847f1405b

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 YOURNAME
+
+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,398 @@
+# SnapplerContable
+
+Esta gema agrega a una aplicacion la capacidad de manejar cuentas contables con el modelo teorico economico.
+
+## Instalacion
+
+Agregar esta linea al Gemfile
+```ruby
+gem "snappler_contable_multicurrency"
+```
+Ejecutar
+```bash
+$ bundle install
+```
+Después de instalar se deben correr estos comandos
+```bash
+$ rails g snappler_contable:initializer
+```
+Esto va a crear el achivo:
+```bash
+# Configuracion de constantes para el sistema.
+config/initializers/snappler_contable.rb
+```
+```bash
+$ rails g snappler_contable:migrate
+```
+
+Esto va a crear las migraciones:
+```bash
+#Crea la estructura y crea cuentas base 'activo', 'pasivo', 'patrimonio_neto', 'resultado_positivo', 'resultado_negativo'
+aaaammdd_snappler_contable_migrate.rb
+
+#Agrega columnas para USD, EUR y BRL
+aaaammdd_snappler_contable_add_currencies.rb
+
+#Carga cuentas DUMMY (Esta se puede borrar si no hace falta)
+aaaammdd_snappler_contable_app_ledger_accounts.rb
+```
+```bash
+$ rake db:migrate  
+```
+
+Y listo
+
+### Extra
+```bash
+$ rails g snappler_contable:new_currency
+```
+
+Esto crea una migracion simulando una nueva moneda, ejemplo el YEN
+```bash
+#Crea la columna en 'ledger_accounts' y agrega la entidad a 'ledger_currencies'
+aaaammdd_snappler_contable_new_currency.rb
+```
+
+---
+
+
+## Problemas en Rails
+
+### Migrations
+#### Versión de ActiveRecord
+Si muestra un **error** como este al migrar:
+```
+Directly inheriting from ActiveRecord::Migration is not supported. Please specify the Rails release
+```
+Se debe agregar la versión de Rails en la definición de la superclase en las migraciones:
+
+```ruby
+# /db/migrate/aaaammdd_snappler_contable_migrate
+
+class SnapplerContableMigrate <ActiveRecord::Migration
+  ...
+```
+Agregar:
+```ruby
+# /db/migrate/aaaammdd_snappler_contable_migrate
+
+class SnapplerContableMigrate <ActiveRecord::Migration[5.1] #o lo que corresponda
+  ...
+```
+#### Error crando cuentas base (activo, pasivo...)
+Rails agregó un control 
+---```bash
+$ rails g snappler_contable:initializer
+```
+Esto va a crear el achivo:
+```bash
+# Configuracion de constantes para el sistema.
+config/initializers/snappler_contable.rb
+```
+```bash
+$ rails g snappler_contable:migrate
+```
+
+Esto va a crear las migraciones:
+```bash
+#Crea la estructura y crea cuentas base 'activo', 'pasivo', 'patrimonio_neto', 'resultado_positivo', 'resultado_negativo'
+aaaammdd_snappler_contable_migrate.rb
+
+#Agrega columnas para USD, EUR y BRL
+aaaammdd_snappler_contable_add_currencies.rb
+
+#Carga cuentas DUMMY (Esta se puede borrar si no hace falta)
+aaaammdd_snappler_contable_app_ledger_accounts.rb
+```
+```bash
+$ rake db:migrate  
+```
+
+Y listo
+
+### Extra
+```bash
+$ rails g snappler_contable:new_currency
+```
+
+Esto crea una migracion simulando una nueva moneda, ejemplo el YEN
+```bash
+#Crea la columna en 'ledger_accounts' y agrega la entidad a 'ledger_currencies'
+aaaammdd_snappler_contable_new_currency.rb
+```
+
+---
+
+
+## Problemas en Rails
+
+### Migrations
+#### Versión de ActiveRecord
+Si muestra un **error** como este al migrar:
+```
+Directly inheriting from ActiveRecord::Migration is not supported. Please specify the Rails release
+```
+Se debe agregar la versión de Rails en la definición de la superclase en las migraciones:
+
+```ruby
+# /db/migrate/aaaammdd_snappler_contable_migrate
+
+class SnapplerContableMigrate <ActiveRecord::Migration
+  ...
+```
+Agregar:
+```ruby
+# /db/migrate/aaaammdd_snappler_contable_migrate
+
+class SnapplerContableMigrate <ActiveRecord::Migration[5.1] #o lo que corresponda
+  ...
+```
+#### Error crando cuentas base (activo, pasivo...)
+Rails agregó un control 
+---```bash
+$ rails g snappler_contable:initializer
+```
+Esto va a crear el achivo:
+```bash
+# Configuracion de constantes para el sistema.
+config/initializers/snappler_contable.rb
+```
+```bash
+$ rails g snappler_contable:migrate
+```
+
+Esto va a crear las migraciones:
+```bash
+#Crea la estructura y crea cuentas base 'activo', 'pasivo', 'patrimonio_neto', 'resultado_positivo', 'resultado_negativo'
+aaaammdd_snappler_contable_migrate.rb
+
+#Agrega columnas para USD, EUR y BRL
+aaaammdd_snappler_contable_add_currencies.rb
+
+#Carga cuentas DUMMY (Esta se puede borrar si no hace falta)
+aaaammdd_snappler_contable_app_ledger_accounts.rb
+```
+```bash
+$ rake db:migrate  
+```
+
+Y listo
+
+### Extra
+```bash
+$ rails g snappler_contable:new_currency
+```
+
+Esto crea una migracion simulando una nueva moneda, ejemplo el YEN
+```bash
+#Crea la columna en 'ledger_accounts' y agrega la entidad a 'ledger_currencies'
+aaaammdd_snappler_contable_new_currency.rb
+```
+---
+
+## Uso
+
+### Traer cuentas
+```ruby
+xxxx = LedgerAccount.get('Nombre de cuenta')
+```
+#### Ejemplo:
+```ruby
+activo = LedgerAccount.get('activo')
+pasivo = LedgerAccount.get('pasivo')
+patrimonio_neto = LedgerAccount.get('patrimonio_neto')
+resultado_positivo = LedgerAccount.get('resultado_positivo')
+resultado_negativo = LedgerAccount.get('resultado_negativo') (*)
+```
+```ruby
+(*) LedgerAccount.get('resultado_negativo') == LedgerAccount.get('Resultado Negativo')
+```
+Es similar, ya que el parametro se trata poniendo en minuscula y cambiando los " " por "_"
+
+
+### Agregar cuentas hijas
+
+Agregar cuentas hija
+```ruby
+#Cuenta padre
+xxxx = LedgerAccount.get('XXXX')
+
+#Agrego YYYY como hija de XXXX 
+xxxx.add_child("YYYY", "yyyy")
+```
+
+#### Ejemplo:
+```ruby
+activo = LedgerAccount.get('activo')
+disponibilidades = activo.add_child("Disponibilidades", "disponibilidades")
+caja = disponibilidades.add_child("Caja", "caja")
+banco = disponibilidades.add_child("Banco", "banco")
+```
+    
+dejando una estructura asi: 
+```
+    1 activo
+        1.1 disponibilidades
+            1.1.1 caja
+            1.1.2 banco
+```    
+
+
+
+Agregar cuentas hija con objeto relacionado
+```ruby
+#Cuenta padre
+xxxx = LedgerAccount.get('XXXX')
+
+#En este caso lo relaciono ademas con un objeto
+xxxx.add_child("ZZZZ", "zzzz", objeto_owner)
+```
+
+#### Ejemplo:
+```ruby
+banco = LedgerAccount.get('banco')
+
+banco_1 = Bank.find(1)
+banco_acc_1 = banco.add_child(banco_1.name, "banco", banco_1)
+
+banco_2 = Bank.find(2)
+banco_acc_2 = banco.add_child(banco_2.name, "banco", banco_2)
+```
+dejando una estructura asi: 
+```
+    1 activo
+        1.1 disponibilidades
+            1.1.1 caja
+            1.1.2 banco
+                1.1.2.1 banco_1
+                1.1.2.2 banco_2
+```            
+
+### Generar Operaciones
+```ruby
+entryX = SnapplerContable.op(array_debe(*), array_haber(*), hash(**))
+```
+```
+(*) La estructura del array_debe o array_haber, es la misma, es un array de hashes, cada hash tiene la sig estructura:
+```
+```ruby
+{
+    account: cuenta_x,                  # (LedgerAccount)       
+    value: XXX.XX,                      # (puede tener hasta 2 decimales)
+    ledger_currency: 'XXX',             #Opc* (Permite código ['ARS', 'USD', etc], o id [1,2,3], o entidad(LedgerCurrency), (Si no especifico la moneda, usa por defecto la configurada en el sistema)
+    represent_value: XXX.XX,            # (puede tener hasta 2 decimales)
+    represent_ledger_currency: 'XXX',   #Opc* (Permite código ['ARS', 'USD', etc], o id [1,2,3], o entidad(LedgerCurrency), (Si no especifico la moneda, usa por defecto la configurada en el sistema)
+    currency_change: XXX.XX,            # (puede tener hasta 2 decimales)
+}
+```
+```
+(**) El hash es opcional y su estructura es:
+```
+```ruby
+{
+    code_name: '',                    #Opc* (Código que se le asigna a la entry, sirve para filtrar entries por nombre)
+    owner: ''                         #Opc* (Indica el objeto que genera la Entry)
+    datetime: DateTime                #Opc* (Por defecto si no se manda toma DateTime.now)
+}
+```
+#### Ejemplo:
+
+##### Movimiento Comun
+```ruby
+#Incremento de deuda de cliente_1 por $10
+
+entry1 = SnapplerContable.op([{account: cliente_1, value: 100}], 
+                             [{account: ventas, value: 100}])
+```
+
+##### Movimiento en otra divisa
+```ruby
+#Incremento de deuda de cliente_1 por u$s100
+
+entry2 = SnapplerContable.op([{account: cliente_1, value: 100, ledger_currency: 'USD'}], 
+                             [{account: ventas, value: 100, ledger_currency: 'USD'}])
+```
+
+
+##### Movimiento con variacion de divisas 1
+```ruby
+#Decremento de deuda de cliente_1 por u$s10
+#(El cliente en realidad paga $152, que es lo que queda en la caja, pero el valor representa un pago por u$s10 a una cotizacion de 15.2)
+
+entry3 = SnapplerContable.op([{account: caja, value: 152, ledger_currency: 'ARS'}], 
+                             [{account: cliente_1, value: 152, ledger_currency: 'ARS', represent_value: 10, represent_ledger_currency: 'USD', currency_change: 15.2}])
+```
+##### Movimiento con variacion de divisas 2
+```ruby
+#cambio de divisa sobre caja
+
+entry4 = SnapplerContable.op([{account: caja, value: 1520, ledger_currency: 'ARS'}],  
+                             [{account: caja, value: 1520, ledger_currency: 'ARS', represent_value: 100, represent_ledger_currency: 'USD', currency_change: 15.2}])
+```
+### Consultas de saldo a una cuenta
+```ruby
+#Cuenta a consultar
+xxxx = LedgerAccount.get('XXXX')
+
+#Balance de la cuenta xxxx en la moneda YYY
+xxxx.balance_YYY(hash(*))
+
+#Balance de la cuenta xxxx en todas las monedas
+xxxx.balance(hash(*))
+```
+```
+(*) El hash es opcional y su estructura es:
+```
+```ruby
+{
+    from: '',       #Opc* (Fecha desde)
+    to: DateTime    #Opc* (Fecha hasta)
+}
+```
+#### Ejemplo:
+
+```ruby
+cliente_1 = LedgerAccount.get('cliente_1')
+
+#----------------------------- Consulta de saldo en $ al momento
+cliente_1.balance_ars
+
+#----------------------------- Consulta de saldo en u$s al momento
+cliente_1.balance_usd
+
+#----------------------------- Consulta de saldo en $ a partir del 20/10/2017
+cliente_1.balance_ars({from: '20/10/2017'})
+
+#----------------------------- Consulta de saldo en u$s hasta el 20/10/2017
+cliente_1.balance_usd({to: '20/10/2017'})    
+
+#----------------------------- Consulta de saldo en u$s a partir del 20/10/2017 hasta el 22/10/2017
+cliente_1.balance_usd({from: '20/10/2017', to: '22/10/2017'})    
+
+#----------------------------- Consulta de saldo en todas las monedas
+cliente_1.balance
+
+#----------------------------- Consulta de saldo en todas las monedas a partir del 20/10/2017 hasta el 22/10/2017
+cliente_1.balance({from: '20/10/2017', to: '22/10/2017'}) 
+```
+### Helper que imprime el arbol de cuentas
+```ruby
+<%= print_accounts_tree %>
+```
+## RubyGems
+
+Esta gema está publicada en RubyGems:
+
+* https://rubygems.org/gems/snappler_contable_multicurrency
+
+**user:** juan.labattaglia@snappler.com
+
+### Actualizacion
+
+Una vez que hay una nueva versión, modificar `lib/snappler_contable/version.rb`
+
+Luego ejecutar:
+```bash
+gem build snappler_contable_multicurrency.gemspec
+gem push snappler_contable_multicurrency-[VERSION].gem
+```

data/Rakefile

@@ -0,0 +1,39 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'SnapplerContable'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+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
+end
+
+
+task :default => :test