company_number 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d4b40991721f4eb047e7060a428f3d85593cc4ce3dd15bb427d95ed629cbb37
-  data.tar.gz: cfedbc59ad70b411b385ba55813e5ebf32247ebaf2b2628f324b3d77799b6aed
+  metadata.gz: 15d093084ab43783fcd77f0d6b369c54bf0741e2da3ccb086b329f71b904bee6
+  data.tar.gz: 0b6942d8d8c036bcd5bb2a1ced0abe8f04b83e3e02a134651419cd6316e28eed
 SHA512:
-  metadata.gz: 7f012c7724dddab12ef370a57d7e5f5d00d6f556cbd5bb4aa5f0b11c33298bcc2eee4a523cce73dbcb1e669c4824d57bd14c8a67780741bb3186b65ed568ac68
-  data.tar.gz: d51f55008b3cfd58a48e312af82a9538f00e75f6e857b0601d83c684bbfdd30612f031e89ee809811ccc99614e91af1653f761106cda6f00f1c7d34959bab1c4
+  metadata.gz: 71f2d3a6a3ef2e6af33562af3c89167113946e8dd993ee2d61c1d44e2049cb773d9ba18477e2f81083aecdf47a0c28cb1ca2e309ccc085b1b3c259d45a1df371
+  data.tar.gz: c86a9a62d0fa7194f60dd4ed9191a670a58f8bd4ad111a084df71d0466b889674008473b53fcbf5ab625457e2292db008b857e54c701364e6b64c0f4cf82730f

data/.rubocop.yml

@@ -7,6 +7,9 @@ Style/FrozenStringLiteralComment:
 Style/StringLiterals:
   Enabled: false
 
+Style/Documentation:
+  Enabled: false
+
 Metrics/BlockLength:
   Exclude:
     - spec/**/*
@@ -17,8 +20,19 @@ Metrics/CyclomaticComplexity:
 Metrics/MethodLength:
   Max: 20
 
+Metrics/BlockLength:
+  Exclude:
+    - '**/*.gemspec'
+    - 'spec/**/*'
+
 Layout/LineLength:
   Max: 80
+  Exclude:
+    - '**/*.gemspec'
+    - 'spec/**/*'
 
 Naming/MemoizedInstanceVariableName:
    EnforcedStyleForLeadingUnderscores: optional
+
+Gemspec/RequiredRubyVersion:
+  Enabled: false

data/CHANGELOG.md

@@ -1,12 +1,22 @@
 ## Changelog
 
+### 0.1.2 - 2022-04-21
+  * Features:
+    * Add custom configurations - aae0d51
+      - custom_dictionary
+      - strict_validation
+      - excluded_countries
+
+  * Enhancements:
+    * Update RuboCop configuration - dcd9852
+
 ### 0.1.1 - 2022-04-04
   * Features:
     * Add dictionary to return the company number metadata - b19c8d9
 
   * Deprecations:
-    * Remove `regexp` attr_reader (moved to metadata) - #3
-    * Remove `countries` attr_reader to use `CompanyNumber::Number#valid_countries` - #3
+    * Remove `regexp` attr_reader (moved to metadata)
+    * Remove `countries` attr_reader to use `CompanyNumber::Number#valid_countries`
 
   * Bug fixes:
     * Fix `CompanyNumber::Number#to_s` method not to return trailing whitespace when country code is not filled in - 9b4f3c53

data/README.md

@@ -33,12 +33,9 @@ company_number = CompanyNumber.parse('123456789', :fr)
 Then you can run validation methods
 
 ```ruby
-company_number.valid?
-# => true
-company_number.valid_country?
-# => true
-company_number.valid_for_country?(:at)
-# => false
+company_number.valid?                  # => true
+company_number.valid_country?          # => true
+company_number.valid_for_country?(:at) # => false
 ```
 
 You can also fetch valid countries
@@ -82,6 +79,95 @@ CompanyNumber.dictionary
 # => {:at=>{:country=>"Austria", :name=>"Firmenbuchnummer", :regexp=>"^([a-zA-Z]{2}\\d{1,6}|\\d{1,6})[A-Z]$", :pattern=>"2 letters + 6 numbers + 1 letter (LLXXXXXXL)", :variations=>"1-6 numbers + 1 letter (XXXXXXL)"}, ...}
 ```
 
+## Configuration
+You can configure your own dictionary using **custom_dictionary**.
+It should be a hash with the country codes as keys and the associated metadata as values.
+
+Available metadata keys:
+- country
+- name
+- regexp
+- pattern
+- variations
+
+**Example:**
+```ruby
+CompanyNumber.parse('123456789', :fr).valid?      # => true
+CompanyNumber.parse('12345678901234', :fr).valid? # => true
+
+CompanyNumber.configure do |config|
+  config.custom_dictionary = { fr: { regexp: '^\d{14}$' } }
+end
+
+CompanyNumber.parse('123456789', :fr).valid?      # => false
+CompanyNumber.parse('12345678901234', :fr).valid? # => true
+```
+
+**strict_validation:**
+
+You can also enable strict validation to reject unknow countries:
+
+```ruby
+CompanyNumber.parse('123456789').valid?      # => true
+CompanyNumber.parse('123456789', :tt).valid? # => true
+
+CompanyNumber.configure do |config|
+  config.strict_validation = true
+end
+
+CompanyNumber.parse('123456789').valid?      # => false
+CompanyNumber.parse('123456789', :tt).valid? # => false
+```
+
+**excluded_countries:**
+
+You may want to exclude some countries, this allows you to automatically validate the country's company number when strict validation is not enabled. You can also exclude a country to overwrite all its metadata and define it later in a custom dictionary.
+
+**Example:**
+```ruby
+CompanyNumber.parse('123456789', :be).valid? # => false
+
+CompanyNumber.configure do |config|
+  config.excluded_countries = [:be]
+end
+
+CompanyNumber.parse('123456789', :be).valid? # => true
+```
+
+## Default dictionary:
+
+- `:at` - **Austria** - Firmenbuchnummer
+- `:be` - **Belgium** - Numéro d'entreprise Vestigingseenheidsnummer
+- `:bg` - **Bulgaria** - ЕИК (EIK)/ПИК (PIK) (UIC/PIC)
+- `:hr` - **Croatia** - Matični broj poslovnog subjekta (MBS)
+- `:cy` - **Cyprus** - Αριθμός Μητρώου Εταιρίας Şirket kayıt numarası
+- `:cz` - **Czech** - epublic (Identifikační číslo
+- `:dk` - **Denmark** - CVR-nummer
+- `:ee` - **Estonia** - Kood
+- `:fi` - **Finland** - Y-tunnus FO-nummer
+- `:fr` - **France** - Numéro SIREN ou SIRET
+- `:de` - **Germany** - Nummer der Firma Registernummer
+- `:gr` - **Greece** - Αριθμό Φορολογικού Μητρώου (Α.Φ.Μ.)
+- `:hu` - **Hungary** - Cégjegyzékszáma
+- `:ie` - **Ireland** - Company Number
+- `:is` - **Island** - TIN
+- `:it` - **Italy** - Codice fiscale
+- `:lv` - **Latvia** - Reģistrācijas numurs
+- `:li` - **Liechtenstein** - UID
+- `:lt` - **Lithuania** - Juridinio asmens kodas
+- `:lu` - **Luxembourg** - Numéro d'immatriculation
+- `:mt` - **Malta** - Registration Number
+- `:nl` - **Netherlands** - KvK-nummer
+- `:no` - **Norway** - TIN
+- `:pl` - **Poland** - Numer w Krajowym Rejestrze Sądowym (numer KRS)) NIPC)
+- `:ro` - **Romania** - Număr de ordine în Registrul Comerţului
+- `:sk` - **Slovakia** - Identifikačného čísla Identification number
+- `:si` - **Slovenia** - Matična številka
+- `:es` - **Spain** - Número de identificación fiscal (NIF)
+- `:se` - **Sweden** - Registreringsnummer
+- `:ch` - **Switzerland** - UID
+- `:gb` - **United Kingdom** - Company Number Registration Number
+
 ## 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.

data/lib/company_number/configuration.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module CompanyNumber
+  class Configuration
+    attr_reader :excluded_countries,
+                :custom_dictionary,
+                :strict_validation
+
+    def initialize
+      @excluded_countries = []
+      @custom_dictionary  = {}
+      @strict_validation  = nil
+    end
+
+    def dictionary
+      @dictionary ||= CompanyNumber::Dictionary.new(@custom_dictionary)
+    end
+
+    def strict_validation?
+      !!@strict_validation
+    end
+
+    def custom_dictionary=(value)
+      Validation.check_dictionary_structure(value)
+
+      @dictionary        = nil
+      @custom_dictionary = value
+    end
+
+    def excluded_countries=(value)
+      Validation.check_object_class(value, [Array])
+
+      @dictionary         = nil
+      @excluded_countries = value
+    end
+
+    def strict_validation=(value)
+      Validation.check_object_class(value, [TrueClass, FalseClass, NilClass])
+
+      @strict_validation = value
+    end
+  end
+end

data/lib/company_number/dictionary.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module CompanyNumber
+  class Dictionary
+    attr_reader :country_codes_metadata, :default_hash
+
+    def self.default_dictionary_path
+      File.join(File.dirname(__FILE__), '../../config/dictionary.yml')
+    end
+
+    def initialize(country_codes_metadata = {})
+      @country_codes_metadata = country_codes_metadata
+      @default_hash           = load_default_hash
+
+      validate_country_codes_metadata
+    end
+
+    def values
+      @_values ||= fetch_values
+    end
+
+    private
+
+    def fetch_values
+      transformed_hash =
+        @default_hash.merge(@country_codes_metadata) do |country_code, _, value|
+          @default_hash[country_code.downcase].merge(value)
+        end
+
+      transformed_hash.reject do |country_code, _metadata|
+        CompanyNumber.configuration.excluded_countries.include?(country_code)
+      end
+    end
+
+    def load_default_hash
+      YAML.safe_load(
+        File.read(self.class.default_dictionary_path),
+        symbolize_names: true
+      )
+    end
+
+    def validate_country_codes_metadata
+      Validation.check_object_class(@country_codes_metadata, [Hash])
+
+      @country_codes_metadata.each do |country_code, metadata|
+        Validation.check_string_format(country_code, /^[A-Za-z]{2}$/)
+        Validation.check_country_code_metadata(metadata)
+      end
+    end
+  end
+end

data/lib/company_number/number.rb

@@ -1,10 +1,13 @@
+# frozen_string_literal: true
+
 module CompanyNumber
   class Number
     attr_reader :company_number, :country_code, :metadata
 
     def initialize(company_number, country_code = nil)
-      check_param_type(company_number, [String])
-      check_param_type(country_code, [NilClass, Symbol, String])
+      Validation.check_object_class(company_number, [String])
+      Validation.check_object_class(country_code, [NilClass, Symbol, String])
+      Validation.check_iso_code_format(country_code)
 
       @company_number = company_number
       @country_code   = country_code&.downcase&.to_sym
@@ -28,17 +31,22 @@ module CompanyNumber
     end
 
     def valid?
-      !valid_country? || valid_for_country?(@country_code)
+      if CompanyNumber.strict_validation?
+        country_code_present_and_valid_country?
+      else
+        no_country_code_or_valid_country?
+      end
     end
 
     def valid_country?
-      CompanyNumber.dictionary.keys.include?(@country_code)
+      CompanyNumber.dictionary.keys.include?(@country_code) ||
+        (!CompanyNumber.strict_validation? && !!@country_code)
     end
 
     def valid_for_country?(country_code)
-      check_param_type(country_code, [Symbol])
-
-      !!(@company_number =~ country_code_regexp(country_code))
+      Validation.check_iso_code_format(country_code)
+      regexp = CompanyNumber.dictionary.dig(country_code, :regexp)
+      (!CompanyNumber.strict_validation? && !regexp) || valid_code?(regexp)
     end
 
     def valid_countries
@@ -52,17 +60,16 @@ module CompanyNumber
 
     private
 
-    def country_code_regexp(country_code)
-      regexp = CompanyNumber.dictionary.dig(country_code, :regexp)
-
-      Regexp.new(regexp) unless regexp.nil?
+    def no_country_code_or_valid_country?
+      !@country_code || valid_for_country?(@country_code)
     end
 
-    def check_param_type(param, expected_classes = [])
-      return if expected_classes.include?(param.class)
+    def country_code_present_and_valid_country?
+      !!@country_code && valid_for_country?(@country_code)
+    end
 
-      raise ArgumentError,
-            "Expect class of #{param} to be #{expected_classes.join(', ')}"
+    def valid_code?(regexp = nil)
+      !!regexp && !!(@company_number =~ Regexp.new(regexp))
     end
   end
 end

data/lib/company_number/validation.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module CompanyNumber
+  module Validation
+    ISO_CODE_REGEXP = /^[A-Za-z]{2}$/.freeze
+
+    AVAILABLE_METADATA_KEYS = %i[
+      variations
+      pattern
+      country
+      regexp
+      name
+    ].freeze
+
+    class << self
+      def check_object_class(object, expected_classes = [])
+        return if expected_classes.include?(object.class)
+
+        raise ArgumentError,
+              "Expect #{object} class to be #{expected_classes.join(', ')}"
+      end
+
+      def check_object_inclusion(object, expected_objects = [])
+        return if expected_objects.include?(object)
+
+        raise ArgumentError,
+              "Expect #{object} to be part of #{expected_objects}"
+      end
+
+      def check_string_format(string, regexp)
+        return if string =~ regexp
+
+        raise ArgumentError, "Expect #{string} to match regexp: #{regexp}"
+      end
+
+      def check_iso_code_format(country_code)
+        return unless country_code
+
+        check_object_class(country_code, [Symbol, String])
+        check_string_format(country_code.to_s, ISO_CODE_REGEXP)
+      end
+
+      def check_country_code_metadata(metadata)
+        metadata.each do |key, value|
+          check_object_inclusion(key, AVAILABLE_METADATA_KEYS)
+          check_object_class(value, [String])
+        end
+      end
+
+      def check_dictionary_structure(value)
+        Validation.check_object_class(value, [Hash])
+
+        value.each do |country_code, metadata|
+          Validation.check_object_class(country_code, [Symbol])
+          Validation.check_object_class(metadata, [Hash])
+        end
+      end
+    end
+  end
+end

data/lib/company_number/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CompanyNumber
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/lib/company_number.rb

@@ -2,20 +2,40 @@
 
 require "yaml"
 require_relative "company_number/version"
+require_relative "company_number/validation"
 
 module CompanyNumber
-  autoload :Number, 'company_number/number'
+  autoload :Configuration, 'company_number/configuration'
+  autoload :Dictionary,    'company_number/dictionary'
+  autoload :Number,        'company_number/number'
 
   class << self
     def parse(company_number, country_code = nil)
       CompanyNumber::Number.new(company_number, country_code)
     end
 
+    def configuration
+      @_configuration ||= CompanyNumber::Configuration.new
+    end
+
+    def configure
+      yield configuration
+    end
+
     def dictionary
-      @_dictionary ||= YAML.safe_load(
-        File.read(File.join(File.dirname(__FILE__), '../config/dictionary.yml')),
-        symbolize_names: true
-      )
+      configuration.dictionary.values
+    end
+
+    def excluded_countries
+      configuration.excluded_countries
+    end
+
+    def custom_dictionary
+      configuration.custom_dictionary
+    end
+
+    def strict_validation?
+      configuration.strict_validation?
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: company_number
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - victorauthiat
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-04-04 00:00:00.000000000 Z
+date: 2022-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -102,7 +102,10 @@ files:
 - company_number.gemspec
 - config/dictionary.yml
 - lib/company_number.rb
+- lib/company_number/configuration.rb
+- lib/company_number/dictionary.rb
 - lib/company_number/number.rb
+- lib/company_number/validation.rb
 - lib/company_number/version.rb
 homepage: https://github.com/victorauthiat/company_number
 licenses: