codicefiscale_ruby 0.1.0

data/lib/codice_fiscale/generator.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+require "date"
+
+module CodiceFiscale
+  # Generator class to create Italian and foreign Codice Fiscale codes
+  # based on personal information such as name, date of birth, gender,
+  # and place of birth.
+  class Generator
+    MONTH_CODES = {
+      1 => "A", 2 => "B", 3 => "C", 4 => "D", 5 => "E", 6 => "H",
+      7 => "L", 8 => "M", 9 => "P", 10 => "R", 11 => "S", 12 => "T"
+    }.freeze
+
+    ODD_TABLE = {
+      "0" => 1, "1" => 0, "2" => 5, "3" => 7, "4" => 9,
+      "5" => 13, "6" => 15, "7" => 17, "8" => 19, "9" => 21,
+      "A" => 1, "B" => 0, "C" => 5, "D" => 7, "E" => 9,
+      "F" => 13, "G" => 15, "H" => 17, "I" => 19, "J" => 21,
+      "K" => 2, "L" => 4, "M" => 18, "N" => 20, "O" => 11,
+      "P" => 3, "Q" => 6, "R" => 8, "S" => 12, "T" => 14,
+      "U" => 16, "V" => 10, "W" => 22, "X" => 25, "Y" => 24, "Z" => 23
+    }.freeze
+
+    EVEN_TABLE = {
+      "0" => 0, "1" => 1, "2" => 2, "3" => 3, "4" => 4,
+      "5" => 5, "6" => 6, "7" => 7, "8" => 8, "9" => 9,
+      "A" => 0, "B" => 1, "C" => 2, "D" => 3, "E" => 4,
+      "F" => 5, "G" => 6, "H" => 7, "I" => 8, "J" => 9,
+      "K" => 10, "L" => 11, "M" => 12, "N" => 13, "O" => 14,
+      "P" => 15, "Q" => 16, "R" => 17, "S" => 18, "T" => 19,
+      "U" => 20, "V" => 21, "W" => 22, "X" => 23, "Y" => 24, "Z" => 25
+    }.freeze
+
+    def initialize(params)
+      @first_name = params[:first_name].upcase.strip
+      @last_name  = params[:last_name].upcase.strip
+      @gender     = params[:gender].upcase.strip
+      @date_of_birth = params[:date_of_birth]
+      @place_of_birth = params[:place_of_birth].upcase.strip
+    end
+
+    def generate
+      cf = surname_code + name_code + date_code + place_code
+      cf + control_character(cf)
+    end
+
+    def formatted
+      raw = generate
+      "#{raw[0, 3]} #{raw[3, 3]} #{raw[6, 5]} #{raw[11, 4]} #{raw[15]}"
+    end
+
+    private
+
+    def surname_code
+      code_letters(@last_name)
+    end
+
+    def name_code
+      consonants = @first_name.gsub(/[^BCDFGHJKLMNPQRSTVWXYZ]/, "").chars
+      vowels = @first_name.gsub(/[^AEIOU]/, "").chars
+      letters = consonants.size >= 4 ? consonants[0] + consonants[2] + consonants[3] : consonants.join
+      (letters + vowels.join)[0, 3].ljust(3, "X")
+    end
+
+    def code_letters(name)
+      consonants = name.gsub(/[^BCDFGHJKLMNPQRSTVWXYZ]/, "")
+      vowels = name.gsub(/[^AEIOU]/, "")
+      (consonants + vowels)[0, 3].ljust(3, "X")
+    end
+
+    def date_code
+      year = @date_of_birth.year.to_s[-2..]
+      month = MONTH_CODES[@date_of_birth.month]
+      day = @gender == "F" ? (@date_of_birth.day + 40).to_s.rjust(2, "0") : @date_of_birth.day.to_s.rjust(2, "0")
+      "#{year}#{month}#{day}"
+    end
+
+    def place_code
+      code = CodiceFiscale::PlaceLookup.find(@place_of_birth)
+      raise CodiceFiscale::Error, "Unknown place #{@place_of_birth}" unless code
+
+      code
+    end
+
+    # Computes the control character of a CF
+    def control_character(cf_first)
+      total = cf_first.chars.each_with_index.reduce(0) do |sum, (c, idx)|
+        sum + (idx.even? ? ODD_TABLE[c] : EVEN_TABLE[c])
+      end
+      ("A".ord + (total % 26)).chr
+    end
+  end
+end

data/lib/codice_fiscale/place_lookup.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "json"
+
+module CodiceFiscale
+  # Module to look up Italian and foreign place codes for CF generation
+  module PlaceLookup
+    DATA_PATH = File.join(__dir__, "data", "places.json")
+    PLACE_DATA = JSON.parse(File.read(DATA_PATH)).freeze
+
+    def self.find(str)
+      return nil if str.nil? || str.strip.empty?
+
+      normalized = str.upcase.strip
+      place = PLACE_DATA.find do |p|
+        p["name"].upcase == normalized || p["code"].upcase == normalized
+      end
+      place&.dig("code")
+    end
+  end
+end

data/lib/codice_fiscale/validator.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module CodiceFiscale
+  # Validator for Codice Fiscale codes
+  class Validator
+    # Returns true if the CF code is valid, false otherwise
+    def self.valid?(_code)
+      # Replace the following line with your actual validation logic
+      # For example, you might call: CodiceFiscale::Generator.validate(_code)
+      false
+    rescue StandardError
+      false
+    end
+  end
+end

data/lib/codice_fiscale/version.rb

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

data/lib/codice_fiscale.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require_relative "codice_fiscale/version"
+require_relative "codice_fiscale/place_lookup"
+require_relative "codice_fiscale/generator"
+require_relative "codice_fiscale/validator"
+
+module CodiceFiscale
+  # Generator class to create Italian and foreign Codice Fiscale codes
+  # using personal information like first name, last name, date of birth,
+  # gender, and place of birth.
+  class Generator
+    class Error < StandardError; end
+
+    # Store generated CFs in memory (hash)
+    @generated_cfs = {}
+
+    class << self
+      # Generate CF and store it
+      def generate(params)
+        cf = Generator.new(params).generate
+        # Key can be anything, e.g., user's full name or a unique ID
+        key = "#{params[:first_name].upcase}-#{params[:last_name].upcase}-#{params[:date_of_birth]}"
+        @generated_cfs[key] = cf
+        cf
+      end
+
+      # Get all stored CFs
+      def all_generated
+        @generated_cfs
+      end
+
+      # Validate CF against stored ones
+      def validate(code)
+        @generated_cfs.value?(code)
+      end
+
+      # Formatted CF
+      def formatted(params)
+        Generator.new(params).formatted
+      end
+    end
+  end
+end

data/sig/codice_fiscale.rbs

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

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: codicefiscale_ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Amshu Pokharel
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2026-01-13 00:00:00.000000000 Z
+dependencies: []
+description: |
+  A Ruby gem to generate Codice Fiscale for Italian and foreign individuals
+  and validate given CF codes.
+email:
+- pokharelamshu@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- codice_fiscale.gemspec
+- lib/codice_fiscale.rb
+- lib/codice_fiscale/data/places.json
+- lib/codice_fiscale/generator.rb
+- lib/codice_fiscale/place_lookup.rb
+- lib/codice_fiscale/validator.rb
+- lib/codice_fiscale/version.rb
+- sig/codice_fiscale.rbs
+homepage: https://github.com/udira-re/codice-fiscale
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/udira-re/codice-fiscale
+  source_code_uri: https://github.com/udira-re/CF-gem-.git
+  changelog_uri: https://github.com/udira-re/codice-fiscale/blob/main/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.4.10
+signing_key:
+specification_version: 4
+summary: Generate and validate Italian and foreign Codice Fiscale
+test_files: []