simulador_aplicacao 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4671cc366b1055f5411ec85ffbfdf12fab95c39e7379a30fa25848877f8b5726
+  data.tar.gz: e095c7ad8658331e3aca68ee54754cb571e4d5441416e5ec0f802eb65fb7d0a1
+SHA512:
+  metadata.gz: 01c192b2a739a86c09bff3f2b8c74a943ff97e73dcaf779160934a6c58ba4b485bb62f058da923c7d4f447d8b60260e270954d15580e23095c20b10eda93d026
+  data.tar.gz: 31313e598373bccbb6bb3fe46550b4fc9292e294800bf6ec1f3fed8e5e673ac4edc2fdf9e9f442462ab2c4450bfcd5bc71f5399e2b8b999bf596b8f694f0c37b

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 vinifmatos
+
+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,20 @@
+# Simulador de Aplicacao
+
+Uma gem para simular uma aplicação financeira com o CDI, SELIC ou IPCA.
+
+## Instalação
+
+    gem install simulador_aplicacao
+
+## Como Usar
+
+Execute o comando `simulador_aplicacao`  
+E depois informe os dados requisitados
+
+## Contriuindo
+
+Bug reports e pull requests serão bem vindos no GitHub https://github.com/vinifmatos/simulador_aplicacao.
+
+## Licença
+
+Essa gem está publicada sob os termos sa licença [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/exe/simulador_aplicacao

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+require "tty-prompt"
+require "tty-table"
+require "simulador_aplicacao"
+
+prompt = TTY::Prompt.new
+
+parametros = {
+  aporte_inicial: prompt.ask(
+    "Informe o valor da aplicação inicial:",
+    convert: :float,
+    default: 1000.0,
+    required: true
+  ),
+  indice: prompt.select("Qual vai ser o indice da aplicação?") do |menu|
+    SimuladorAplicacao::URL_API_BACEN.keys.map do |k|
+      menu.choice k.to_s.upcase, k
+    end
+    menu.default 1
+  end,
+  periodo: prompt.ask(
+    "Informe o tempo de aplicação (em meses):",
+    convert: :int,
+    default: 12,
+    required: true
+  )
+}
+
+tera_aporte_mensal = prompt.yes?("Deseja fazer aportes mensais?") do |q|
+  q.default false
+  q.positive "Sim"
+  q.negative "Não"
+end
+
+if tera_aporte_mensal
+  parametros[:aporte_mensal] = prompt.ask(
+    "Informe o valor do aporte mensal:",
+    convert: :float,
+    required: true
+  )
+else
+  parametros[:aporte_mensal] = 0.0
+end
+
+tera_resgate_mensal = prompt.yes?("Deseja fazer resgates mensais?") do |q|
+  q.default false
+  q.positive "Sim"
+  q.negative "Não"
+end
+
+if tera_resgate_mensal
+  parametros[:resgate_mensal] = prompt.ask(
+    "Informe o valor do resgate mensal:",
+    convert: :float,
+    required: true
+  )
+  parametros[:inicio_resgate] = prompt.ask(
+    "Informe o mês de iníco do resgate:",
+    default: 1,
+    required: true,
+    convert: :int
+  ) do |q|
+    q.in("1-#{parametros[:periodo]}")
+  end
+else
+  parametros[:resgate_mensal] = 0.0
+  parametros[:inicio_resgate] = parametros[:periodo]
+end
+
+simulacao = SimuladorAplicacao.simulacao(
+  parametros[:aporte_inicial],
+  parametros[:periodo],
+  parametros[:indice],
+  parametros[:aporte_mensal],
+  parametros[:resgate_mensal],
+  parametros[:inicio_resgate]
+)
+
+tabela_simulacao = TTY::Table.new(
+  header: [
+    "Mês",
+    "Saldo Inicial",
+    "Taxa",
+    "Rendimento Bruto",
+    "Alíquota I.R.",
+    "I.R",
+    "Rendimento Líquido",
+    "Aporte",
+    "Resgate",
+    "Total Investido",
+    "Resultado",
+    "Total Acumulado"
+  ],
+  rows: simulacao.map do |mes|
+    mes.map do |k, v|
+      if k == :aliquota_imposto_renda
+        "#{format("%.2f", v * 100)}%"
+      else
+        v.is_a?(Float) ? format("%.2f", v).gsub(".", ",").gsub(/(\d)(?=(\d{3})+,)/, '\1.') : v
+      end
+    end
+  end
+)
+
+puts tabela_simulacao.render(:unicode, padding: [0, 1], alignment: :center, resize: true, multiline: false)

data/lib/simulador_aplicacao/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SimuladorAplicacao
+  VERSION = "0.2.0"
+end

data/lib/simulador_aplicacao.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+require_relative "simulador_aplicacao/version"
+require "net/http"
+require "uri"
+require "json"
+require "optparse"
+
+module SimuladorAplicacao
+  URL_API_BACEN = {
+    cdi: "https://api.bcb.gov.br/dados/serie/bcdata.sgs.4392/dados/ultimos/1?formato=json",
+    selic: "https://api.bcb.gov.br/dados/serie/bcdata.sgs.1178/dados/ultimos/1?formato=json",
+    ipca: "https://api.bcb.gov.br/dados/serie/bcdata.sgs.13522/dados/ultimos/1?formato=json"
+  }.freeze
+
+  def self.simulacao(aporte_inicial, periodo, indice, aporte_mensal, resgate_mensal, inicio_resgate)
+    taxa_anual = obter_taxa_anual_atualizada(indice)
+    taxa_juros_mensal = taxa_anual_para_mensal(taxa_anual)
+    total_acumulado = aporte_inicial
+    total_investido = aporte_inicial
+    rendimento_acumulado = 0
+    rendimento_a_tributar = 0
+    imposto_renda_pago = 0
+    puts "Simulando com #{indice.to_s.upcase} #{format("%.2f", taxa_anual * 100)}% a.a"
+    resultado_mensal = [
+      {
+        mes: 0,
+        inicial: total_acumulado,
+        taxa: "#{taxa_juros_mensal * 100}% a.m",
+        rendimento_bruto: 0.0,
+        aliquota_imposto_renda: 0.0,
+        imposto_renda: 0.0,
+        rendimento_liquido: 0.0,
+        aporte: 0.0,
+        resgate: 0.0,
+        total_investido: total_investido,
+        resultado: 0.0,
+        acumulado: total_acumulado
+      }
+    ]
+    (1..periodo).each do |mes|
+      incial = total_acumulado
+      rendimento = incial * taxa_juros_mensal
+      rendimento_acumulado += rendimento
+      total_acumulado += rendimento
+      rendimento_a_tributar += rendimento
+      if mes >= inicio_resgate
+        imposto_renda = rendimento_a_tributar * aliquota_ir(mes)
+        resgate = resgate_mensal
+        total_acumulado -= (resgate + imposto_renda)
+        imposto_renda_pago += imposto_renda
+        rendimento_a_tributar = 0
+      else
+        imposto_renda = 0.0
+        resgate = 0.0
+      end
+      total_acumulado += aporte_mensal
+      total_investido += aporte_mensal
+      resultado_mensal << {
+        mes: mes,
+        inicial: total_acumulado,
+        taxa: "#{taxa_juros_mensal * 100}% a.m",
+        rendimento_bruto: rendimento,
+        aliquota_imposto_renda: aliquota_ir(mes),
+        imposto_renda: imposto_renda,
+        rendimento_liquido: rendimento - imposto_renda,
+        aporte: aporte_mensal,
+        resgate: resgate,
+        total_investido: total_investido,
+        resultado: rendimento - imposto_renda - resgate + aporte_mensal,
+        acumulado: total_acumulado
+      }
+    end
+    resultado_mensal
+  end
+
+  def self.aliquota_ir(mes)
+    case
+    when mes < 3 then 22.5
+    when mes < 12 then 20
+    when mes < 24 then 17.5
+    else 15
+    end / 100.0
+  end
+
+  def self.taxa_anual_para_mensal(taxa_anual)
+    ((1.0 + taxa_anual)**(1.0 / 12.0) - 1.0).round(4)
+  end
+
+  def self.obter_taxa_anual_atualizada(indice)
+    puts "Obtendo #{indice.to_s.upcase} atual..."
+    taxa = JSON.parse(Net::HTTP.get(URI.parse(URL_API_BACEN[indice]))).first.fetch("valor").to_f
+    puts "Concluído"
+    taxa / 100.0
+  rescue StandardError => e
+    puts "Erro ao consultar a API"
+    puts e
+    exit
+  end
+end

data/sig/simulador_aplicacao.rbs

@@ -0,0 +1,4 @@
+module SimuladorAplicacao
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

data/simulador_aplicacao.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative "lib/simulador_aplicacao/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "simulador_aplicacao"
+  spec.version = SimuladorAplicacao::VERSION
+  spec.authors = ["vinifmatos"]
+  spec.email = ["viniciusfreire4@gmail.com"]
+
+  spec.summary = "Simulador de Aplicação Financeira"
+  spec.description = "Essa gem faz uma simulação de uma aplicação financeira utilizando como índice o CDI, o SELIC ou o IPCA, para um montante inicial pelo periodo desejado."
+  spec.homepage = "https://github.com/vinifmatos"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/vinifmatos/simulador_aplicacao"
+  spec.metadata["changelog_uri"] = "https://github.com/vinifmatos/simulador_aplicacao/README.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor Gemfile])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = ["simulador_aplicacao"]
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency "tty-prompt", "~> 0.23"
+  spec.add_dependency "tty-table", "~> 0.12"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: simulador_aplicacao
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- vinifmatos
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-06-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: tty-prompt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.23'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.23'
+- !ruby/object:Gem::Dependency
+  name: tty-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+description: Essa gem faz uma simulação de uma aplicação financeira utilizando como
+  índice o CDI, o SELIC ou o IPCA, para um montante inicial pelo periodo desejado.
+email:
+- viniciusfreire4@gmail.com
+executables:
+- simulador_aplicacao
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- LICENSE.txt
+- README.md
+- Rakefile
+- exe/simulador_aplicacao
+- lib/simulador_aplicacao.rb
+- lib/simulador_aplicacao/version.rb
+- sig/simulador_aplicacao.rbs
+- simulador_aplicacao.gemspec
+homepage: https://github.com/vinifmatos
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/vinifmatos
+  source_code_uri: https://github.com/vinifmatos/simulador_aplicacao
+  changelog_uri: https://github.com/vinifmatos/simulador_aplicacao/README.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.21
+signing_key: 
+specification_version: 4
+summary: Simulador de Aplicação Financeira
+test_files: []