mercosur_plate_converter 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 862163d8a94a20e03f1e3a769d06d2ac4b7ad088c53c97cc94f4f89cfc1fbcbc
-  data.tar.gz: 7ae93d28afe4a90a236d9af6ef2baf2242dfc1c268c94fe5f8a31cc43f61433b
+  metadata.gz: 17c212f2e3b7ec528fc9c8d20d284b73c24875454de1bd03711c8c90435f0707
+  data.tar.gz: bd95caa8adafa4517e7988c85b38a04abc784a0c3ca790ec316a72f131f7422c
 SHA512:
-  metadata.gz: 68ac243bd0507c78c3100549afa807c35b15be3324534d9aa96d41d13e11e29d0cc8d9e7a366b24e7f5c5f1d7800aff027ef59408ed9ca8d86e8e005d24be6ec
-  data.tar.gz: 48dcc46e83c960c2ada799ab97b7e5fc4e62339a3e729d9d1d2ed41e7fb5f42d266e775a4d2f72e952a828249b60705a2239d2f7d1f46f675d40b9c50f6938db
+  metadata.gz: 3ca183dadab4659ce4c8fa527d61800438c88a3ff45c5c8f1b72ca709e0f858d2535683e281cd2db3df0a62c23acac57ce240c96344bf094edaf4d35a6eacca5
+  data.tar.gz: 1e767c92ae29a8f434adacdf229f3482e08bb5c348167e26bf89b3226f7d8be2f67a0532121ccce501944899ba8155fdae4ea30c73d372c86b256d7ee34dac32

data/lib/mercosur_plate_converter/converter.rb

@@ -3,70 +3,91 @@
 module MercosurPlateConverter
   # MercosurPlateConverter::Converter.new("ABC1C34") where "ABC1C34" is the vehicle's plate.
   class Converter
-    FIFTH_TERM_MAP = ("A".."J").to_a.freeze
+    # Pre-computed mapping for better performance
+    FIFTH_TERM_MAP = %w[A B C D E F G H I J].freeze
+    FIFTH_TERM_MAP_REVERSE = FIFTH_TERM_MAP.each_with_index.to_h.freeze
+    private_constant :FIFTH_TERM_MAP_REVERSE
+
+    MERCOSUR_REGEX = /\A(BR\s?)?[A-Z]{3}[0-9][A-Z][0-9]{2}\z/
+    LEGACY_REGEX = /\A[A-Z]{3}[0-9]{4}\z/
 
     attr_reader :original_plate, :type, :plate
 
     def initialize(plate)
       @original_plate = sanitize_plate(plate)
       @plate = @original_plate.dup
-      @type = nil
 
-      validate_plate
+      validate_plate_presence
       detect_type
+      validate_plate_format
       convert
     end
 
-    def convert
-      send("convert_from_#{type}")
-    end
-
     def valid?
-      mercosur? || old_brazilian?
+      !@type.nil?
     end
 
     def mercosur?
-      @original_plate.match?(/^(BR\s?)?[A-Z]{3}[0-9]{1}[A-Z]{1}[0-9]{2}$/)
+      @type == :mercosur
+    end
+
+    def legacy?
+      @type == :legacy
     end
 
     def old_brazilian?
-      @original_plate.match?(/^[A-Z]{3}[0-9]{4}$/)
+      warn "[DEPRECATION] `old_brazilian?` is deprecated. Use `legacy?` instead."
+      legacy?
     end
 
     private
 
-    def convert_from_old_brazilian
-      return @plate if @type == :mercosur
+    def convert
+      case @type
+      when :mercosur
+        convert_from_mercosur
+      when :legacy
+        convert_from_legacy
+      else
+        @plate
+      end
+    end
 
-      @plate[4] = FIFTH_TERM_MAP[@plate[4].to_i]
+    def convert_from_legacy
+      # Convert 5th position from number to letter
+      digit = @plate[4].to_i
+      @plate[4] = FIFTH_TERM_MAP[digit] if digit < FIFTH_TERM_MAP.size
       @plate
     end
 
     def convert_from_mercosur
-      return @plate if @type == :old_brazilian
-
-      @plate = @plate.gsub(/^(BR\s?)?/, "")
-      @plate[4] = FIFTH_TERM_MAP.index(@plate[4]).to_s
+      # Remove optional BR prefix and convert 5th position from letter to number
+      @plate = @plate.delete_prefix("BR")
+      letter_index = FIFTH_TERM_MAP_REVERSE[@plate[4]]
+      @plate[4] = letter_index.to_s if letter_index
       @plate
     end
 
     def detect_type
-      @type = if mercosur?
+      @type = if @original_plate.match?(MERCOSUR_REGEX)
                 :mercosur
-              elsif old_brazilian?
-                :old_brazilian
+              elsif @original_plate.match?(LEGACY_REGEX)
+                :legacy
               end
     end
 
     def sanitize_plate(plate)
       return unless plate
 
-      plate.to_s.upcase.gsub(/[^0-9A-Z]/, "")
+      plate.to_s.upcase.delete("^A-Z0-9")
+    end
+
+    def validate_plate_presence
+      raise MissingPlateError, "Missing plate" if @plate.nil? || @plate.empty?
     end
 
-    def validate_plate
-      raise MissingPlateError, "Missing plate" if @plate.nil?
-      raise InvalidPlateError, "Invalid plate #{@plate}" unless valid?
+    def validate_plate_format
+      raise InvalidPlateError, "Invalid plate #{@plate}" unless @type
     end
   end
 end

data/lib/mercosur_plate_converter/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MercosurPlateConverter
-  VERSION = "0.1.0"
+  VERSION = "1.0.0"
 end

data/sig/mercosur_plate_converter.rbs

@@ -1,4 +1,64 @@
 module MercosurPlateConverter
   VERSION: String
-  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+
+  # Main module method to create a converter instance from a plate string
+  def self.from_string: (String? plate) -> Converter
+
+  # Custom error classes
+  class MissingPlateError < StandardError
+  end
+
+  class InvalidPlateError < StandardError
+  end
+
+  # Main converter class
+  class Converter
+    # Constants
+    FIFTH_TERM_MAP: Array[String]
+    MERCOSUR_REGEX: Regexp
+    LEGACY_REGEX: Regexp
+
+    # Attributes
+    attr_reader original_plate: String
+    attr_reader type: (:mercosur | :legacy | nil)
+    attr_reader plate: String
+
+    # Initialize with a plate string
+    def initialize: (String? plate) -> void
+
+    # Check if the plate is valid
+    def valid?: () -> bool
+
+    # Check if the plate is in Mercosur format
+    def mercosur?: () -> bool
+
+    # Check if the plate is in legacy format
+    def legacy?: () -> bool
+
+    # DEPRECATED: Use legacy? instead
+    def old_brazilian?: () -> bool
+
+    private
+
+    # Convert the plate based on detected type
+    def convert: () -> String
+
+    # Convert from legacy format to Mercosur
+    def convert_from_legacy: () -> String
+
+    # Convert from Mercosur format to legacy
+    def convert_from_mercosur: () -> String
+
+    # Detect the type of the plate
+    def detect_type: () -> void
+
+    # Sanitize the input plate string
+    def sanitize_plate: (String? plate) -> String?
+
+    # Validate presence of the plate
+    def validate_plate_presence: () -> void
+
+    # Validate the plate format
+    def validate_plate_format: () -> void
+  end
 end

metadata

@@ -1,43 +1,70 @@
 --- !ruby/object:Gem::Specification
 name: mercosur_plate_converter
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Renan Luiz Vendramini
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-03-30 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rbs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.13'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1.69'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.69'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.23'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1.23'
 - !ruby/object:Gem::Dependency
   name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
@@ -58,28 +85,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.9.0
+        version: '3.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.9.0
+        version: '3.2'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.21.2
+        version: 0.22.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.21.2
+        version: 0.22.0
 description: I created this gem to convert Mercosur plates to Brazilian plates and
   vice versa.
 email:
@@ -88,29 +115,18 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".rspec"
-- ".rubocop.yml"
-- Gemfile
-- LICENSE
-- README.md
-- README_en.md
-- Rakefile
-- bin/console
-- bin/setup
 - lib/mercosur_plate_converter.rb
 - lib/mercosur_plate_converter/converter.rb
 - lib/mercosur_plate_converter/errors.rb
 - lib/mercosur_plate_converter/version.rb
-- mercosur_plate_converter.gemspec
 - sig/mercosur_plate_converter.rbs
 homepage: https://github.com/rlvendramini/mercosur_plate_converter
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/rlvendramini/mercosur_plate_converter
-  source_code_uri: https://github.com/rlvendramini/mercosur_plate_converter/blob/master/mercosur_plate_converter.gemspec
+  source_code_uri: https://github.com/rlvendramini/mercosur_plate_converter
   changelog_uri: https://github.com/rlvendramini/mercosur_plate_converter/blob/master/CHANGELOG.md
-post_install_message:
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -118,15 +134,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: An easy converter of Mercosur plates to Brazilian plates.
 test_files: []

data/.rspec

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

data/.rubocop.yml

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

data/Gemfile

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org"
-
-# Specify your gem's dependencies in mercosur_plate_converter.gemspec
-gemspec
-
-gem "rake", "~> 13.0"
-
-gem "rspec", "~> 3.0"
-
-gem "rubocop", "~> 1.21"

data/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2022 Renan Luiz Vendramini
-
-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

@@ -1,70 +0,0 @@
-# MercosurPlateConverter
-
-[ENGLISH 🇺🇸🇬🇧](README_en.md)
-
-A motivação por trás dessa GEM é validar e converter placas de veículos brasileiros do antigo modelo para o novo modelo adotado pelo Mercosul (e vice-versa).
-
-O padrão de numeração das placas de veículos brasileiros é o antigo modelo.
-O padrão de numeração das placas de veículos mercosul é o novo modelo.
-
-O padrão mercosul é composto por 3 letras, 1 número, 1 letra e 2 números.
-Para fazer a conversão do modelo antigo para o novo, é necessário que o número seja convertido para a letra equivalente.
-Essa conversão é feita a partir de uma sequência, como em um `Array`, onde cada elemento é uma letra de A a J de acordo com o índice desse `Array`.
-
-Assim sendo:
-
-|Número|Letra|
-|-----|------|
-|0|A|
-|1|B|
-|2|C|
-|3|D|
-|4|E|
-|5|F|
-|6|G|
-|7|H|
-|8|I|
-|9|J|
-
-## Instalação
-
-Insira a linha abaixo em seu Gemfile:
-
-```ruby
-gem 'mercosur_plate_converter'
-```
-
-E então execute no terminal:
-
-    $ bundle install
-
-Ou instale manualmente, também via terminal:
-
-    $ gem install mercosur_plate_converter
-
-## Uso
-
-Crie uma instância da classe MercosurPlateConverter e use os métodos para validar e converter placas.
-
-O exemplo abaixo considera que você fornece uma placa válida do tipo Mercosul:
-
-```ruby
-plate = MercosurPlateConverter.from_string("ABC1C34")
-
-plate.original_plate #=> "ABC1C34"
-plate.plate #=> "ABC1234"
-plate.type #=> :mercosur
-plate.valid? #=> true
-plate.mercosur? #=> true
-plate.old_brazilian? #=> false
-```
-
-## Desenvolvimento
-
-Após verificar o repositório, execute `bin/setup` para instalar as dependências. Em seguida, execute `rake spec` para executar os testes. Você também pode executar `bin/console` para um prompt interativo que permitirá que você experimente.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Como contribuir?
-
-Relatórios de bugs e pull requests são bem-vindos no GitHub em [github.com/rlvendramini/mercosur_plate_converter](https://github.com/rlvendramini/mercosur_plate_converter).

data/README_en.md

@@ -1,70 +0,0 @@
-# MercosurPlateConverter
-
-[PORTUGUESE 🇧🇷](README.md)
-
-With this GEM you can validate and convert Brazilian plates from the old model to the new model used by Mercosul (and vice-versa).
-
-The numbering standard for Brazilian vehicle license plates is the old model.
-The mercosur vehicle license plate numbering standard is the new model.
-
-The Mercosur standard is composed of 3 letters, 1 number, 1 letter and 2 numbers.
-To convert from the old model to the new one, it is necessary that the number be converted to the equivalent letter.
-This conversion is done from a sequence, as in an `Array`, where each element is a letter from A to J according to the index of that `Array`.
-
-So, for example:
-
-|Number|Letter|
-|-----|------|
-|0|A|
-|1|B|
-|2|C|
-|3|D|
-|4|E|
-|5|F|
-|6|G|
-|7|H|
-|8|I|
-|9|J|
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'mercosur_plate_converter'
-```
-
-And then execute:
-
-    $ bundle install
-
-Or install it yourself as:
-
-    $ gem install mercosur_plate_converter
-
-## Usage
-
-Instantiate MercosurPlateConverter class and use the methods to validate and convert plates.
-
-The example below assumes that you supply a valid Mercosur-type license plate:
-
-```ruby
-plate = MercosurPlateConverter.from_string("ABC1C34")
-
-plate.original_plate #=> "ABC1C34"
-plate.plate #=> "ABC1234"
-plate.type #=> :mercosur
-plate.valid? #=> true
-plate.mercosur? #=> true
-plate.old_brazilian? #=> false
-```
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/mercosur_plate_converter.

data/Rakefile

@@ -1,12 +0,0 @@
-# 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/bin/console

@@ -1,15 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require "bundler/setup"
-require "mercosur_plate_converter"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here

data/mercosur_plate_converter.gemspec

@@ -1,42 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "lib/mercosur_plate_converter/version"
-
-Gem::Specification.new do |spec|
-  spec.name = "mercosur_plate_converter"
-  spec.version = MercosurPlateConverter::VERSION
-  spec.authors = ["Renan Luiz Vendramini"]
-  spec.email = ["renanlvendramini@gmail.com"]
-
-  spec.summary = "An easy converter of Mercosur plates to Brazilian plates."
-  spec.description = "I created this gem to convert Mercosur plates to Brazilian plates and vice versa."
-  spec.homepage = "https://github.com/rlvendramini/mercosur_plate_converter"
-  spec.required_ruby_version = ">= 2.6.0"
-  spec.license = "MIT"
-
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "#{spec.homepage}/blob/master/mercosur_plate_converter.gemspec"
-  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/master/CHANGELOG.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(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject do |f|
-      (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
-    end
-  end
-  spec.bindir = "exe"
-  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  # Uncomment to register a new dependency of your gem
-  # spec.add_dependency "example-gem", "~> 1.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "rubocop", "~> 1.2"
-  spec.add_development_dependency "rubocop-rake", "~> 0.6.0"
-  spec.add_development_dependency "rubocop-rspec", "~> 2.9.0"
-  spec.add_development_dependency "simplecov", "~> 0.21.2"
-
-  # For more information and examples about making a new gem, check out our
-  # guide at: https://bundler.io/guides/creating_gem.html
-end