extensobr 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 47761fcd0aadc7f026970577b3cb526493179f0385f1e66c0138d017191a806f
-  data.tar.gz: 3c8c0f4ede5cc204a7707d28b38e37491d5204a645c2467e25f5424e383c95a8
+  metadata.gz: 4c16a2759e6723989331737ab04867c31e50ca3275cefc8fde86652eb9b7a520
+  data.tar.gz: 2c66fa8ffd5355bf4f6bb708738a9e931e4e162a2fb95705fbe17510b0c62cc3
 SHA512:
-  metadata.gz: 3952552c3c843939cd9fc46ef94dc844b7be36aa678627b7d15782567d860baac257e49423b95c4b6dddf9d91e655c8cbf503b3f58a3cae0c9f0d97aca45dde8
-  data.tar.gz: 246b3f4d254338a0b9d95050e597cf8a42e3cb64120ca4adec304dcbac3333fdd16e1c1533b07ea7a489d2a1da999120787a76e3d887c9d8f6ac45590ae28510
+  metadata.gz: cec73bb125afb3f8259a762c3448943735add98a341f565ec6a988a4f935ddb58abb04ac27e13b7a50cb99be848264211e1e7bc3696fd98734e7f93a19f5ce65
+  data.tar.gz: 731f65901ed947174eb506549eb16607994a4df289b47c1bc7f68794fd016a8ef0fa25ae227efdb140fa2a7e1bacc9bff9fac467759680451280c745962be8df

data/.github/workflows/codeql-analysis.yml

@@ -0,0 +1,70 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ master ]
+  schedule:
+    - cron: '15 7 * * 5'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'ruby' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+        # Learn more about CodeQL language support at https://git.io/codeql-language-support
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v1
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        # queries: ./path/to/local/query, your-org/your-repo/queries@main
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v1
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 https://git.io/JvXDl
+
+    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+    #    and modify them (or add more) to build your code if your project
+    #    uses a compiled language
+
+    #- run: |
+    #   make bootstrap
+    #   make release
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v1

data/.gitignore

@@ -1,10 +1,12 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-*.gem
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem
+.DS_Store
+.byebug_history

data/README.md

@@ -1,63 +1,93 @@
-# Extensobr
-
-Esta gem foi desenvolvida para auxiliar no desenvolvimento de aplicações onde é necessário escrever ou imprimir números ou moedas por extenso como por exemplo em recibos, contratos entre outros.
-
-
-## Instalação
-
-Adicionando em sua Gemfile:
-
-```ruby
-gem 'extensobr'
-```
-
-Ou instale você mesmo:
-
-    $ gem install extensobr
-
-## Exemplos de uso
-
-Para obter o extenso de um número, utilize Extenso.numero() OBS: Ovalor deve ser do tipo "INTEGER".
-
-    irb
-
-require 'Extensobr.rb'
- 
-    puts Extenso.numero(832); # oitocentos e trinta e dois
-    puts Extenso.numero(832, Extenso::GENERO_FEM) # oitocentas e trinta e duas
-
-Para obter o extenso de um valor monetário, utilize Extenso.moeda() OBS: Ovalor deve ser do tipo "FLOAT".
-
-    require 'Extenso.rb'
- 
-## IMPORTANTE: este método recebe um valor inteiro(int), para a contagem das casas decimais!
-    
-    puts Extenso.moeda(154.02) # cento e cinquenta e quatro reais e dois centavos
-    puts Extenso.moeda(0.47)   # quarenta e sete centavos
-    puts Extenso.moeda(3570.82, 2, ['peseta', 'pesetas', Extenso::GENERO_FEM], ['cêntimo', 'cêntimos', Extenso::GENERO_MASC])
-
-## três mil, quinhentas e setenta pesetas e oitenta e dois cêntimos
-
-Para obter o valor em real de um número, utilize Extenso.real_formatado.
-
-    Extenso.real_formatado(154.55) # R$ 154,55
-    Extenso.real_formatado(0) # R$ 0,00
-    Extenso.real_formatado(1) # R$ 1,00
-
-# Developers
-
-[Henrique Max](https://github.com/rickmax),
-[Fausto G. Cintra](https://github.com/goncin),
-[Victor Eduardo](https://github.com/victoreduardo)
-
-## Como contribuir?
-
-1. Fazer um fork do projeto
-1. Fazer os devidos ajustes com os respectivos testes
-1. Fazer pull request
-
-
-## Licença
-
-Está Gem esta disponível sob ostermos de licença [MIT License](http://opensource.org/licenses/MIT).
-
+# Extensobr
+
+Esta gem foi desenvolvida para auxiliar no desenvolvimento de aplicações onde é necessário escrever ou números ou moedas por extenso como por exemplo em recibos, contratos entre outros.
+
+
+## Instalação
+
+Adicionando em sua Gemfile:
+
+```ruby
+gem 'extensobr'
+```
+
+Ou instale você mesmo:
+
+    $ gem install extensobr
+
+## Exemplos de uso
+### IMPORTANTE: este método recebe um valor inteiro(integer)
+Para obter o extenso de um número, utilize Extenso.numero() OBS: Ovalor deve ser do tipo "INTEGER".
+Padrão de genero da escrita é passado com um parâmetro do tipo integer, Masculino: 0, Feminino: 1, sendo que o padrão é masculino. 
+
+    irb
+
+require 'Extensobr.rb'
+ 
+    puts Extenso.numero(832); # oitocentos e trinta e dois
+    puts Extenso.numero(832, 1) # oitocentas e trinta e duas
+
+    # Novo método usando a classes do ruby a partir da versão 1.2 em diante.
+    puts 832.por_extenso; # oitocentos e trinta e dois
+    puts 832.por_extenso(1) # oitocentas e trinta e duas
+    puts "832".por_extenso; # oitocentos e trinta e dois
+    puts "832".por_extenso(1) # oitocentas e trinta e duas
+ 
+### IMPORTANTE: este método recebe um valor decimal(float), para a contagem das casas decimais
+
+Para obter o extenso de um valor monetário, utilize Extenso.moeda() OBS: Ovalor deve ser do tipo "FLOAT".
+
+require 'Extenso.rb'
+
+    puts Extenso.moeda(154.02) # cento e cinquenta e quatro reais e dois centavos
+    puts Extenso.moeda(0.47)   # quarenta e sete centavos
+    
+    # Novos métodos usando a classes do ruby a partir da versão 1.2 em diante.
+    puts 154.02.por_extenso # cento e cinquenta e quatro reais e dois centavos
+    puts 0.47.por_extenso   # quarenta e sete centavos
+    puts "154.02".por_extenso # cento e cinquenta e quatro reais e dois centavos
+    puts "0.47".por_extenso   # quarenta e sete centavos
+
+### Customize sua moéda passando como parâmetro
+    
+    puts Extenso.moeda(3570.82, 2, ['peseta', 'pesetas', Extenso::GENERO_FEM], ['cêntimo', 'cêntimos', Extenso::GENERO_MASC])
+    # Três mil, Quinhentas e Setenta pesetas e Oitenta e Dois cêntimos
+
+### Para obter o valor numérico em reais de um número decimal
+
+    Extenso.real_formatado(154.55) # R$ 154,55
+    Extenso.real_formatado(0) # R$ 0,00
+    Extenso.real_formatado(1) # R$ 1,00
+
+### Configurando exeptions para valores nulos
+É possivel que na sua regra de negócio ou caso de uso, seja passado um valor nulo ou vazio para tentar escrever por extenso, nesses casos por padrão será retornado "Zero" para inteiros e "Zero centavos" para decimais. No entanto você pode configurar para receber uma exceção caso seja necessário. Em suas váriáis de ambiente adicione a seguinte chave e valor:
+    
+    EXTENSO_RAISE_FOR_NIL=true
+
+E adicione um arquivo "config/extensobr.yml", com a seguinte configuração:
+    
+    raise_for_nil: ENV['EXTENSO_RAISE_FOR_NIL'] || 'false'
+
+Dessa forma, você pode esperar em seus testes a seguinte excessão:
+
+    RuntimeError: [Exceção em Extenso.numero] Parâmetro 'valor' é nulo
+    
+
+# Developers
+
+[Henrique Max](https://github.com/rickmax),
+[Renan Garcia](https://github.com/renan-garcia),
+[Fausto G. Cintra](https://github.com/goncin),
+[Victor Eduardo](https://github.com/victoreduardo)
+
+## Como contribuir?
+
+1. Faça um fork do projeto;
+1. Adicione os devidos ajustes ou melhorias com os respectivos testes;
+1. Envie pull request;
+
+
+## Licença
+
+Está Gem esta disponível sob os termos de licença [MIT License](http://opensource.org/licenses/MIT).
+

data/SECURITY.md

@@ -0,0 +1,21 @@
+# Security Policy
+
+## Supported Versions
+
+Use this section to tell people about which versions of your project are
+currently being supported with security updates.
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 5.1.x   | :white_check_mark: |
+| 5.0.x   | :x:                |
+| 4.0.x   | :white_check_mark: |
+| < 4.0   | :x:                |
+
+## Reporting a Vulnerability
+
+Use this section to tell people how to report a vulnerability.
+
+Tell them where to go, how often they can expect to get an update on a
+reported vulnerability, what to expect if the vulnerability is accepted or
+declined, etc.

data/extensobr.gemspec

@@ -1,29 +1,29 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'extensobr/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = "extensobr"
-  spec.version       = Extensobr::VERSION
-  spec.authors       = ["Henrique Max"]
-  spec.email         = ["rickmaxg3@hotmail.com"]
-
-  spec.summary       = %q{ExtendoBr escreve números e moeda por extenso.}
-  spec.description   = %q{ExtensoBr é uma gem que foi desenvolvida para auxiliar na impressão de números e moedas por extenso em portugês do Brasil.}
-  spec.homepage      = "https://github.com/rickmax/extensobr"
-  spec.license       = "MIT"
-
-  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
-  # to allow pushing to a single host or delete this section to allow pushing to any host.
-
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
-  end
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-  spec.add_development_dependency "bundler", "~> 2.2.15"
-  spec.add_development_dependency "rake", "~> 12.3.3"
-  spec.add_development_dependency "rspec"
-end
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'extensobr/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "extensobr"
+  spec.version       = Extensobr::VERSION
+  spec.authors       = ["Henrique Max"]
+  spec.email         = ["rickmaxg3@hotmail.com"]
+
+  spec.summary       = %q{ExtendoBr escreve números e moeda por extenso.}
+  spec.description   = %q{ExtensoBr é uma gem que foi desenvolvida para auxiliar na impressão de números e moedas por extenso em portugês do Brasil.}
+  spec.homepage      = "https://github.com/rickmax/extensobr"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.add_development_dependency "bundler", "~> 2.2.15"
+  spec.add_development_dependency "rake", "~> 12.3.3"
+  spec.add_development_dependency "rspec"
+end

data/lib/core_exts/float.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'extensobr'
+
+# Extende a classe Float adicionando o metodo por_extenso
+Float.class_eval do
+  def por_extenso(*args)
+    Extenso.moeda(self, *args)
+  end
+end

data/lib/core_exts/integer.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'extensobr'
+
+# Extende a classe Integer adicionando o metodo por_extenso e por_extenso_ordinal
+Integer.class_eval do
+  def por_extenso(*args)
+    Extenso.numero(self, *args)
+  end
+
+  def por_extenso_ordinal(*args)
+    Extenso.ordinal(self, *args)
+  end
+end

data/lib/core_exts/string.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'extensobr'
+
+# Extende a classe Integer adicionando o metodo por_extenso, por_extenso_moeda e por_extenso_numero
+String.class_eval do
+  # Um wapper para o metodo Extenso.numero ou Extenso.moeda
+  # PARÂMETROS:
+  # type (Symbol) O tipo especifico que deseja gerar
+  #
+  # Caso o tipo não seja informado é inferido primeiro tentando encontrar um padrão de Float
+  # caso encontre ele supõe que o tipo é moeda. Caso contrario o tipo será numero.
+  def por_extenso(*args)
+    return por_extenso_numero(*args) if args.include? :numero
+
+    return por_extenso_moeda(*args) if args.include? :moeda
+
+    return por_extenso_ordinal(*args) if args.include? :ordinal
+
+    number = scan(/\d+[,.]\d+/).first
+    return por_extenso_moeda(*args) unless number.nil? || number.empty?
+
+    por_extenso_numero(*args)
+  end
+
+  def por_extenso_moeda(*args)
+    number = gsub('_', '').scan(/\d+[,.]\d+/).first
+    params = args - [:moeda]
+    Extenso.moeda(number.to_f, *params)
+  end
+
+  def por_extenso_numero(*args)
+    number = scan(/\d/)&.join('')
+    Extenso.numero(number&.to_i, *args)
+  end
+
+  def por_extenso_ordinal(*args)
+    number = scan(/\d/)&.join('')
+    Extenso.ordinal(number&.to_i, *args)
+  end
+end

data/lib/extensobr/version.rb

@@ -1,3 +1,3 @@
-module Extensobr
-  VERSION = "1.0.0"
-end
+module Extensobr
+  VERSION = "1.2.0"
+end