mercosur_plate_converter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 862163d8a94a20e03f1e3a769d06d2ac4b7ad088c53c97cc94f4f89cfc1fbcbc
+  data.tar.gz: 7ae93d28afe4a90a236d9af6ef2baf2242dfc1c268c94fe5f8a31cc43f61433b
+SHA512:
+  metadata.gz: 68ac243bd0507c78c3100549afa807c35b15be3324534d9aa96d41d13e11e29d0cc8d9e7a366b24e7f5c5f1d7800aff027ef59408ed9ca8d86e8e005d24be6ec
+  data.tar.gz: 48dcc46e83c960c2ada799ab97b7e5fc4e62339a3e729d9d1d2ed41e7fb5f42d266e775a4d2f72e952a828249b60705a2239d2f7d1f46f675d40b9c50f6938db

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/Gemfile

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

@@ -0,0 +1,21 @@
+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

@@ -0,0 +1,70 @@
+# 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

@@ -0,0 +1,70 @@
+# 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

@@ -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/bin/console

@@ -0,0 +1,15 @@
+#!/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

@@ -0,0 +1,8 @@
+#!/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/lib/mercosur_plate_converter/converter.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module MercosurPlateConverter
+  # MercosurPlateConverter::Converter.new("ABC1C34") where "ABC1C34" is the vehicle's plate.
+  class Converter
+    FIFTH_TERM_MAP = ("A".."J").to_a.freeze
+
+    attr_reader :original_plate, :type, :plate
+
+    def initialize(plate)
+      @original_plate = sanitize_plate(plate)
+      @plate = @original_plate.dup
+      @type = nil
+
+      validate_plate
+      detect_type
+      convert
+    end
+
+    def convert
+      send("convert_from_#{type}")
+    end
+
+    def valid?
+      mercosur? || old_brazilian?
+    end
+
+    def mercosur?
+      @original_plate.match?(/^(BR\s?)?[A-Z]{3}[0-9]{1}[A-Z]{1}[0-9]{2}$/)
+    end
+
+    def old_brazilian?
+      @original_plate.match?(/^[A-Z]{3}[0-9]{4}$/)
+    end
+
+    private
+
+    def convert_from_old_brazilian
+      return @plate if @type == :mercosur
+
+      @plate[4] = FIFTH_TERM_MAP[@plate[4].to_i]
+      @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
+      @plate
+    end
+
+    def detect_type
+      @type = if mercosur?
+                :mercosur
+              elsif old_brazilian?
+                :old_brazilian
+              end
+    end
+
+    def sanitize_plate(plate)
+      return unless plate
+
+      plate.to_s.upcase.gsub(/[^0-9A-Z]/, "")
+    end
+
+    def validate_plate
+      raise MissingPlateError, "Missing plate" if @plate.nil?
+      raise InvalidPlateError, "Invalid plate #{@plate}" unless valid?
+    end
+  end
+end

data/lib/mercosur_plate_converter/errors.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module MercosurPlateConverter
+  class MissingPlateError < StandardError; end
+  class InvalidPlateError < StandardError; end
+end

data/lib/mercosur_plate_converter/version.rb

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

data/lib/mercosur_plate_converter.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative "mercosur_plate_converter/version"
+require_relative "mercosur_plate_converter/converter"
+require_relative "mercosur_plate_converter/errors"
+
+# MercoSurPlateConverter is a gem that converts Mercosur plates to Brazilian plates and vice versa.
+# you can call it like this: MercosurPlateConverter.from_string("ABC1C34")
+module MercosurPlateConverter
+  def self.from_string(plate)
+    Converter.new(plate)
+  end
+end

data/mercosur_plate_converter.gemspec

@@ -0,0 +1,42 @@
+# 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

data/sig/mercosur_plate_converter.rbs

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

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: mercosur_plate_converter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Renan Luiz Vendramini
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-03-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.9.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.2
+description: I created this gem to convert Mercosur plates to Brazilian plates and
+  vice versa.
+email:
+- renanlvendramini@gmail.com
+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
+  changelog_uri: https://github.com/rlvendramini/mercosur_plate_converter/blob/master/CHANGELOG.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.3.3
+signing_key:
+specification_version: 4
+summary: An easy converter of Mercosur plates to Brazilian plates.
+test_files: []