validates_identity 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c02ac962c5ec8b1375b107a1cd166a4242e6b0dc3d1eac6cd72c677886bc2949
-  data.tar.gz: 054340d538b549470ba24f72be4927f911ea0965114e6fa7969cceb5a59d0e98
+  metadata.gz: 3848016930f18f09b27ec31333622b53df51786d31c3eb612fe92da34c9f640a
+  data.tar.gz: c07d435462ce6caa0e3c4d1611af1aa2cfa8f06956a331696773845fafb6a02f
 SHA512:
-  metadata.gz: 44499e3ed8a5279780b2f8e331af8e33cf9d14aa6d1ab6c6c3ea6809e1c23c7904cd2e9db0f4acbfdc452ab851ce93f10e2afb9ea6e9c430d517f0e19895bdb4
-  data.tar.gz: 0e853984a43b4e75b607fd8582187685bd472acdf76262cc5b3dbe220f29d5c6d487d8f620c17e1ae1a9d6b5e34104f7314254c79081464166d220a7c806f432
+  metadata.gz: 539ce96f3cc65ca74b12ea9b83a6aaa568e3c15bb178e945c1224893092e6741f5abf6f69db65fe989163c2d528a808f34f3b9704b800b5a550e179f4a50bcea
+  data.tar.gz: ab5c1fe930362622f2efd4c928f71246aef44db216f36fd795492b5fbe4a7cdc3b11c27c295c95ba60f853ff46501b4f037dd379b2b1cf5fe681df46bcc1361f

data/.rubocop.yml

@@ -1,13 +1,19 @@
+require:
+  - rubocop-rake
+  - rubocop-rspec
+
 AllCops:
+  NewCops: enable
   TargetRubyVersion: 2.6
 
-Style/StringLiterals:
-  Enabled: true
-  EnforcedStyle: double_quotes
+Layout/LineLength:
+  Max: 150
+
+Metrics/BlockLength:
+  Enabled: false
 
-Style/StringLiteralsInInterpolation:
-  Enabled: true
-  EnforcedStyle: double_quotes
+Metrics/MethodLength:
+  Max: 15
 
-Layout/LineLength:
-  Max: 120
+Style/Documentation:
+  Enabled: false

data/.ruby-gemset

@@ -0,0 +1 @@
+validate_identity

data/.ruby-version

@@ -0,0 +1 @@
+3.3.0

data/CHANGELOG.md

@@ -1,5 +1,17 @@
-## [Unreleased]
+## [0.3.0] - 2024-02-25
+
+### Added
+
+- `Format` option to format the final identity value
+
+## [0.2.0] - 2024-02-25
+
+### Added
+
+- Initial Implementation of public API's
 
 ## [0.1.0] - 2024-02-24
 
+### Added
+
 - Initial release

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,124 @@
+PATH
+  remote: .
+  specs:
+    validates_identity (0.3.0)
+      activemodel
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (7.1.3.2)
+      activesupport (= 7.1.3.2)
+    activesupport (7.1.3.2)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      mutex_m
+      tzinfo (~> 2.0)
+    amazing_print (1.5.0)
+    ast (2.4.2)
+    base64 (0.2.0)
+    bigdecimal (3.1.6)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    concurrent-ruby (1.2.3)
+    connection_pool (2.4.1)
+    coolline (0.5.0)
+      unicode_utils (~> 1.4)
+    diff-lcs (1.5.1)
+    drb (2.2.0)
+      ruby2_keywords
+    i18n (1.14.1)
+      concurrent-ruby (~> 1.0)
+    jazz_fingers (6.2.0)
+      amazing_print (~> 1.3)
+      pry (~> 0.10)
+      pry-byebug (~> 3.9)
+      pry-coolline (~> 0.2)
+    json (2.7.1)
+    language_server-protocol (3.17.0.3)
+    method_source (1.0.0)
+    minitest (5.22.2)
+    mutex_m (0.2.0)
+    parallel (1.24.0)
+    parser (3.3.0.5)
+      ast (~> 2.4.1)
+      racc
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.10.1)
+      byebug (~> 11.0)
+      pry (>= 0.13, < 0.15)
+    pry-coolline (0.2.6)
+      coolline (~> 0.5)
+      pry (~> 0.13)
+    racc (1.7.3)
+    rainbow (3.1.1)
+    rake (13.1.0)
+    regexp_parser (2.9.0)
+    rexml (3.2.6)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
+    rubocop (1.60.2)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.30.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.30.0)
+      parser (>= 3.2.1.0)
+    rubocop-capybara (2.20.0)
+      rubocop (~> 1.41)
+    rubocop-factory_bot (2.25.1)
+      rubocop (~> 1.41)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.26.1)
+      rubocop (~> 1.40)
+      rubocop-capybara (~> 2.17)
+      rubocop-factory_bot (~> 2.22)
+    ruby-progressbar (1.13.0)
+    ruby2_keywords (0.0.5)
+    shoulda-matchers (6.1.0)
+      activesupport (>= 5.2.0)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.5.0)
+    unicode_utils (1.4.0)
+
+PLATFORMS
+  ruby
+  x86_64-darwin-21
+
+DEPENDENCIES
+  jazz_fingers
+  rake
+  rspec
+  rubocop-rake
+  rubocop-rspec
+  shoulda-matchers
+  validates_identity!
+
+BUNDLED WITH
+   2.5.3

data/README.md

@@ -1,8 +1,6 @@
 # ValidatesIdentity
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/validates_identity`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+This projects aims to validate several countries person identification documents.
 
 ## Installation
 
@@ -22,7 +20,49 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Just use as any other validator:
+
+```ruby
+class User < ActiveRecord::Base
+  # :identity_type is the attribute that will be used to determine the identity type and is required
+  validates :identity, identity: { identity_type: :identity_type }
+end
+```
+
+## Advanced Usage
+
+### Format
+
+The `format` option can be used to format the final identity value.
+
+```ruby
+class User < ActiveRecord::Base
+  # :identity_type is the attribute that will be used to determine the identity type and is required
+  validates :identity, identity: { identity_type: :identity_type, format: true }
+end
+```
+
+### Custom Validators
+
+New Identity Validators can be registered through the public apis of `ValidatesIdentity`
+
+```ruby
+ValidatesIdentity.register_identity_type('CustomIdentity', CustomIdentityValidator)
+```
+
+Each Validator should have:
+
+- a constructor with 1 param: `value`
+- a `valid?` method that returns a boolean
+- a `formatted` method that returns the value formatted
+
+### Validators Aliases
+
+In case of a legacy system where keys were already defined and differ from the official ones, aliases can be registered as well
+
+```ruby
+ValidatesIdentity.register_identity_type_alias('LegacyIdentity', 'CustomIdentity')
+```
 
 ## Development
 
@@ -32,7 +72,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/validates_identity. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/validates_identity/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/plribeiro3000/validates_identity. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/plribeiro3000/validates_identity/blob/master/CODE_OF_CONDUCT.md).
 
 ## License
 
@@ -40,4 +80,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the ValidatesIdentity project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/validates_identity/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the ValidatesIdentity project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/plribeiro3000/validates_identity/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-require "rubocop/rake_task"
+require 'rubocop/rake_task'
 
 RuboCop::RakeTask.new
 

data/lib/identity_validator.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+class IdentityValidator < ActiveModel::EachValidator
+  def validate_each(record, attribute, value)
+    identity = ValidatesIdentity::Identity.new(record, attribute, value, options)
+
+    if identity.valid?
+      record.send("#{attribute}=", identity.formatted) if options[:format]
+    else
+      ruby_prior_version_three =
+        Gem::Version.new(RUBY_VERSION) < Gem::Version.new('3.0.0')
+
+      if ruby_prior_version_three
+        record.errors.add(attribute, :invalid, options)
+      else
+        record.errors.add(attribute, :invalid, **options)
+      end
+    end
+  end
+end

data/lib/validates_identity/identity.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module ValidatesIdentity
+  class Identity
+    attr_reader :record, :attribute, :value, :options
+
+    def initialize(record, attribute, value, options)
+      @record = record
+      @attribute = attribute
+      @value = value
+      @options = options
+    end
+
+    def valid?
+      return true if value.blank?
+      return false if options[:identity_type].blank?
+
+      validator_class = ValidatesIdentity.get_validator(identity_type)
+
+      return false if validator_class.nil?
+
+      validator = validator_class.new(value)
+      validator.valid?
+    end
+
+    private
+
+    def identity_type
+      record.send(options[:identity_type])
+    rescue NoMethodError
+      :invalid
+    end
+  end
+end

data/lib/validates_identity/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ValidatesIdentity
-  VERSION = "0.1.0"
+  VERSION = '0.3.0'
 end

data/lib/validates_identity.rb

@@ -1,8 +1,34 @@
 # frozen_string_literal: true
 
-require_relative "validates_identity/version"
+require 'active_model'
+require 'identity_validator'
 
 module ValidatesIdentity
-  class Error < StandardError; end
-  # Your code goes here...
+  autoload :Identity, 'validates_identity/identity'
+
+  class << self
+    private
+
+    def identity_types
+      @identity_types ||= {}
+    end
+
+    def identity_type_aliases
+      @identity_type_aliases ||= {}
+    end
+  end
+
+  def self.register_identity_type(identity_type_acronym, identity_type_validator)
+    identity_types[identity_type_acronym] = identity_type_validator
+    identity_type_aliases[identity_type_acronym] = identity_type_acronym
+  end
+
+  def self.register_identity_type_alias(identity_type, identity_type_alias)
+    identity_type_aliases[identity_type_alias] = identity_type
+  end
+
+  def self.get_validator(identity_type)
+    identity_alias = identity_type_aliases[identity_type]
+    identity_types[identity_alias]
+  end
 end

data/validates_identity.gemspec

@@ -1,19 +1,19 @@
 # frozen_string_literal: true
 
-require_relative "lib/validates_identity/version"
+require_relative 'lib/validates_identity/version'
 
 Gem::Specification.new do |spec|
-  spec.name = "validates_identity"
+  spec.name = 'validates_identity'
   spec.version = ValidatesIdentity::VERSION
-  spec.authors = ["Paulo Ribeiro"]
-  spec.email = ["plribeiro3000@gmail.com"]
+  spec.authors = ['Paulo Ribeiro']
+  spec.email = ['plribeiro3000@gmail.com']
 
-  spec.summary = "Validates Several Identity Documents and test it with matchers in a simple way."
-  spec.homepage = "https://github.com/plribeiro3000/validates_identity"
-  spec.license = "MIT"
-  spec.required_ruby_version = ">= 2.6.0"
+  spec.summary = 'Validates Several Identity Documents and test it with matchers in a simple way.'
+  spec.homepage = 'https://github.com/plribeiro3000/validates_identity'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 2.6.0'
 
-  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = 'https://github.com/plribeiro3000/validates_identity/blob/master'
   spec.metadata['changelog_uri'] = 'https://github.com/plribeiro3000/validates_identity/blob/master/CHANGELOG.md'
 
@@ -24,13 +24,10 @@ Gem::Specification.new do |spec|
       (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
     end
   end
-  spec.bindir = "exe"
+  spec.bindir = 'exe'
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  # Uncomment to register a new dependency of your gem
-  # spec.add_dependency "example-gem", "~> 1.0"
-
-  # For more information and examples about making a new gem, check out our
-  # guide at: https://bundler.io/guides/creating_gem.html
+  spec.add_runtime_dependency 'activemodel'
+  spec.metadata['rubygems_mfa_required'] = 'true'
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: validates_identity
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Paulo Ribeiro
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-24 00:00:00.000000000 Z
-dependencies: []
+date: 2024-02-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description:
 email:
 - plribeiro3000@gmail.com
@@ -19,15 +33,19 @@ extra_rdoc_files: []
 files:
 - ".rspec"
 - ".rubocop.yml"
+- ".ruby-gemset"
+- ".ruby-version"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
+- lib/identity_validator.rb
 - lib/validates_identity.rb
+- lib/validates_identity/identity.rb
 - lib/validates_identity/version.rb
-- sig/validates_identity.rbs
 - validates_identity.gemspec
 homepage: https://github.com/plribeiro3000/validates_identity
 licenses:
@@ -36,6 +54,7 @@ metadata:
   homepage_uri: https://github.com/plribeiro3000/validates_identity
   source_code_uri: https://github.com/plribeiro3000/validates_identity/blob/master
   changelog_uri: https://github.com/plribeiro3000/validates_identity/blob/master/CHANGELOG.md
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:

data/sig/validates_identity.rbs

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