faker-indian 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: de6eb2615cdfb3ca1ad1a1186da1d98522b9da95827b507266b1ae188b79c670
-  data.tar.gz: d8fe29db43869ea2c43b9f6037aeeea829e4caf12adeec923f34989b08a135ca
+  metadata.gz: ee4f61cd669d6888e72f22186c89e0e5059ff6a9c2e36021d78306be5741d6ee
+  data.tar.gz: '0699f78e34c57d567426daea6f253f3feaf6ab3d8602d8d1c2015336077e9687'
 SHA512:
-  metadata.gz: c13a7c3db4650cd13149feff73e962ef257e13b4bb07ea0410dfd86878e410375ca43633ffca6ce178d650bd8347e195d5831bc7315a3b8ecc79daf85c13e0fc
-  data.tar.gz: 2b4ad2eeabbc018525ba738f838515abe10e65ae46c57fe1c32a26a47e2d0b575fd9efd7ff44bf45a42b1a285917e705f7fab1d7ebba29d6e0249917bf83679d
+  metadata.gz: ccab041cad1ad3e9a7cc9dd18cdef831264b7a0ea84b544505d736c69c277495ea3ac81ba5c19f0d24f42b70eae6fe3b2d9831a7e32b336c5f46153ae2ab0201
+  data.tar.gz: 7c1fd92568fb6e6d22732c890ea1253bfd81305776eadf850275ca582ec1c202420c3d6bb78f2674e8be7026718b7a09d1cb949f51fac1e741d35a9b1a80f429

data/CHANGELOG.md

@@ -1,5 +1,29 @@
 ## [Unreleased]
 
+## [0.2.0] - 2026-07-01
+
+### Added
+
+- `Faker::Indian::Company` with `name`, `type`, and `cin`
+- `Faker::Indian::Travel` with `pnr`, `train_name`, and `station`
+- `Faker::Indian::Profile.generate` and `Faker::Indian.profile` for one-shot seed data
+- `phone.yml` for telecom operator and STD code data
+- `company.yml` and `travel.yml` data files
+
+### Changed
+
+- **Address** — fixed YAML nesting for 40+ cities; added `district`, `landmark`, `line1`, `state_code`, and `state:` filtering on location methods
+- **Identity** — added `driving_license`, `aadhaar_masked`, and `gstin(pan:)`
+- **Payment** — added `demat_account`, `bank_details`, and `upi_id(name:)`
+- **Phone** — added `operator`, `landline`, `whatsapp_number`, and `mobile_number(formatted:)`
+- **Vehicle** — added `registration_number(state:)`, public `rto_code`, and state name/code resolution
+- **Name** — added `middle_name`, `suffix`, and `full_name(language:)`
+- **Food** — added `meal`, `beverage`, `combo`, and `spice_level`
+- **address.yml** — added `state_codes`, `districts`, and `landmarks`
+
 ## [0.1.0] - 2026-05-14
 
-- Initial release
+### Added
+
+- Initial release with `Name`, `Identity`, `Payment`, `Vehicle`, `Address`, `Phone`, `Food`, and `Languages` generators
+- YAML-backed data loading via `Faker::Indian::Data`

data/README.md

@@ -2,7 +2,7 @@
 
 India-first fake data generator for Ruby apps.
 
-`faker-indian` helps you generate realistic fake Indian data such as names, PAN numbers, Aadhaar numbers, GSTINs, UPI IDs, vehicle registration numbers, phone numbers, addresses, regional-language names, food items, and more.
+`faker-indian` helps you generate realistic fake Indian data — names, identities, payments, addresses, vehicles, regional-language names, food, companies, railway PNRs, and more.
 
 Perfect for:
 
@@ -17,13 +17,16 @@ Perfect for:
 ## Features
 
 - 🇮🇳 Indian-first fake data generation
-- 👤 Indian names & identities
+- 👤 Indian names & identities (PAN, Aadhaar, GSTIN, driving license, and more)
 - 🌐 Regional language names (Hindi, Tamil, Telugu, and more)
-- 💳 Payment & banking details
+- 💳 Payment & banking details (UPI, IFSC, demat account)
+- 🏢 Company names & CIN numbers
+- 🚂 Railway PNR, train names, and stations
 - 🚗 Vehicle registration numbers
-- 🏠 Indian addresses & PIN codes
-- 📞 Mobile numbers
+- 🏠 Indian addresses across 70+ cities
+- 📞 Mobile, landline, and telecom operators
 - 🍛 Indian dishes, cuisines, and restaurants
+- 📋 One-shot `Faker::Indian.profile` for seed data
 - 📁 YAML-backed data — easy to extend without changing logic
 - ⚡ Lightweight and easy to use
 
@@ -34,7 +37,7 @@ Perfect for:
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'faker-indian'
+gem "faker-indian"
 ```
 
 Then execute:
@@ -62,20 +65,17 @@ Faker::Indian::Name.full_name
 Faker::Indian::Identity.pan
 # => "ABCDE1234F"
 
-Faker::Indian::Identity.aadhaar
-# => "4567 8912 3456"
-
-Faker::Indian::Identity.aadhaar
-# => "4567 8912 3456"
-
 Faker::Indian::Payment.upi_id
-# => "rahul123@paytm"
-Faker::Vehicle::
+# => "rahul42@paytm"
+
 Faker::Indian::Languages.full_name(language: :tamil)
 # => "Karthik Iyer"
 
-Faker::Indian::Food.dish
-# => "Masala Dosa"
+Faker::Indian::Company.cin
+# => "U72200MH2010PTC123456"
+
+Faker::Indian.profile
+# => { name: "...", phone: "...", pan: "...", ... }
 ```
 
 ---
@@ -93,11 +93,20 @@ Faker::Indian::Name.first_name
 Faker::Indian::Name.last_name
 # => "Patel"
 
+Faker::Indian::Name.middle_name
+# => "Kumar"
+
 Faker::Indian::Name.full_name
 # => "Rohan Verma"
 
+Faker::Indian::Name.full_name(language: :hindi)
+# => "Ananya Sharma"
+
 Faker::Indian::Name.prefix
 # => "Dr."
+
+Faker::Indian::Name.suffix
+# => "Ji"
 ```
 
 ---
@@ -146,14 +155,26 @@ Faker::Indian::Identity.pan
 Faker::Indian::Identity.aadhaar
 # => "1234 5678 9012"
 
+Faker::Indian::Identity.aadhaar_masked
+# => "XXXX XXXX 4567"
+
 Faker::Indian::Identity.gstin
 # => "27ABCDE1234F1Z5"
 
+Faker::Indian::Identity.gstin(pan: "ABCDE1234F")
+# => "27ABCDE1234F1Z5"  # embeds the given PAN
+
 Faker::Indian::Identity.voter_id
 # => "ABC1234567"
 
 Faker::Indian::Identity.passport
 # => "N1234567"
+
+Faker::Indian::Identity.driving_license
+# => "MH-12-2018-4567890"
+
+Faker::Indian::Identity.driving_license(state: "Karnataka")
+# => "KA-04-2022-1234567"
 ```
 
 ---
@@ -166,6 +187,9 @@ Generate fake Indian banking and payment data.
 Faker::Indian::Payment.upi_id
 # => "amit@oksbi"
 
+Faker::Indian::Payment.upi_id(name: "Rahul Sharma")
+# => "rahulsharma42@paytm"
+
 Faker::Indian::Payment.ifsc
 # => "HDFC0001234"
 
@@ -174,12 +198,52 @@ Faker::Indian::Payment.bank_name
 
 Faker::Indian::Payment.account_number
 # => "123456789012"
+
+Faker::Indian::Payment.demat_account
+# => "120816001234567"
+
+Faker::Indian::Payment.bank_details
+# => { bank_name: "HDFC Bank", ifsc: "HDFC0001234", account_number: "123456789012" }
 ```
 
 Aliases: `upi` (for `upi_id`), `ifsc_code` (for `ifsc`).
 
 ---
 
+### Company
+
+Generate Indian company names and CIN numbers.
+
+```ruby
+Faker::Indian::Company.name
+# => "Bharat Tech Solutions Pvt Ltd"
+
+Faker::Indian::Company.type
+# => "Private Limited"
+
+Faker::Indian::Company.cin
+# => "U72200MH2010PTC123456"
+```
+
+---
+
+### Travel
+
+Generate railway-related fake data.
+
+```ruby
+Faker::Indian::Travel.pnr
+# => "4829173056"
+
+Faker::Indian::Travel.train_name
+# => "Rajdhani Express"
+
+Faker::Indian::Travel.station
+# => "Mumbai CST"
+```
+
+---
+
 ### Vehicle
 
 Generate Indian vehicle registration numbers.
@@ -188,39 +252,77 @@ Generate Indian vehicle registration numbers.
 Faker::Indian::Vehicle.registration_number
 # => "KA01MJ4587"
 
+Faker::Indian::Vehicle.registration_number(state: "MH")
+# => "MH14DT4321"
+
 Faker::Indian::Vehicle.state_code
 # => "MH"
+
+Faker::Indian::Vehicle.rto_code
+# => "12"
 ```
 
 ---
 
 ### Address
 
-Generate realistic Indian addresses.
+Generate realistic Indian addresses across 70+ cities.
+
+Pass `state:` as a state name (`"Maharashtra"`) or code (`"MH"`) to filter location methods.
 
 ```ruby
 Faker::Indian::Address.city
 # => "Pune"
 
+Faker::Indian::Address.city(state: "Karnataka")
+# => "Bengaluru"
+
 Faker::Indian::Address.state
 # => "Maharashtra"
 
 Faker::Indian::Address.pincode
 # => "411001"
 
+Faker::Indian::Address.state_code
+# => "MH"
+
+Faker::Indian::Address.district
+# => "Koramangala"
+
+Faker::Indian::Address.landmark
+# => "Near Metro Station"
+
+Faker::Indian::Address.line1
+# => "221 MG Road"
+
 Faker::Indian::Address.full_address
-# => "221 MG Road, Pune, Maharashtra - 411001"
+# => "221 MG Road, Koramangala, Pune, Maharashtra - 411001"
+
+Faker::Indian::Address.full_address(state: "Gujarat")
+# => "45 Ring Road, Satellite, Ahmedabad, Gujarat - 380001"
 ```
 
 ---
 
 ### Phone
 
-Generate Indian mobile numbers.
+Generate Indian phone numbers and telecom data.
 
 ```ruby
 Faker::Indian::Phone.mobile_number
 # => "+91 9876543210"
+
+Faker::Indian::Phone.mobile_number(formatted: false)
+# => "9876543210"
+
+Faker::Indian::Phone.landline
+# => "022-1234567"
+
+Faker::Indian::Phone.operator
+# => "Jio"
+
+Faker::Indian::Phone.whatsapp_number
+# => "+91 9123456789"
 ```
 
 ---
@@ -244,6 +346,43 @@ Faker::Indian::Food.street_food
 
 Faker::Indian::Food.sweet
 # => "Gulab Jamun"
+
+Faker::Indian::Food.meal
+# => "lunch"
+
+Faker::Indian::Food.beverage
+# => "Filter Coffee"
+
+Faker::Indian::Food.combo
+# => "Masala Dosa with Filter Coffee"
+
+Faker::Indian::Food.spice_level
+# => "medium"
+```
+
+---
+
+### Profile
+
+Generate a complete Indian user profile in one call — ideal for seeds and demos.
+
+```ruby
+Faker::Indian.profile
+# or
+Faker::Indian::Profile.generate
+
+# =>
+# {
+#   name: "Sneha Kulkarni",
+#   phone: "+91 9123456789",
+#   pan: "BQWPE1234K",
+#   aadhaar: "4567 1234 8910",
+#   gstin: "27BQWPE1234K1Z5",
+#   upi: "sneha@okicici",
+#   vehicle: "MH14DT4321",
+#   address: "221 FC Road, Andheri, Pune, Maharashtra - 411001",
+#   dish: "Masala Dosa"
+# }
 ```
 
 ---
@@ -252,17 +391,18 @@ Faker::Indian::Food.sweet
 
 Static data lives in YAML files under `lib/faker/indian/data/` and is loaded by `Faker::Indian::Data`:
 
-
-| File            | Used by     |
-| --------------- | ----------- |
-| `name.yml`      | `Name`      |
+| File | Used by |
+|------|---------|
+| `name.yml` | `Name` |
 | `languages.yml` | `Languages` |
-| `identity.yml`  | `Identity`  |
-| `payment.yml`   | `Payment`   |
-| `vehicle.yml`   | `Vehicle`   |
-| `address.yml`   | `Address`   |
-| `food.yml`      | `Food`      |
-
+| `identity.yml` | `Identity` |
+| `payment.yml` | `Payment` |
+| `company.yml` | `Company` |
+| `travel.yml` | `Travel` |
+| `vehicle.yml` | `Vehicle` |
+| `address.yml` | `Address` |
+| `phone.yml` | `Phone` |
+| `food.yml` | `Food` |
 
 To add entries, edit the relevant YAML file. To add a new generator, create a new YAML file and a matching Ruby class that calls `Data.load(:your_file)`.
 
@@ -274,11 +414,14 @@ To add entries, edit the relevant YAML file. To add a new generator, create a ne
 
 ```ruby
 10.times do
+  profile = Faker::Indian.profile
+
   User.create!(
-    name: Faker::Indian::Name.full_name,
-    phone: Faker::Indian::Phone.mobile_number,
-    pan: Faker::Indian::Identity.pan,
-    upi: Faker::Indian::Payment.upi_id
+    name: profile[:name],
+    phone: profile[:phone],
+    pan: profile[:pan],
+    upi: profile[:upi],
+    address: profile[:address]
   )
 end
 ```
@@ -297,6 +440,11 @@ FactoryBot.define do
     name    { Faker::Indian::Food.restaurant_name }
     cuisine { Faker::Indian::Food.cuisine }
   end
+
+  factory :company do
+    name { Faker::Indian::Company.name }
+    cin  { Faker::Indian::Company.cin }
+  end
 end
 ```
 
@@ -319,12 +467,15 @@ Generated values are **not real identities** and must not be used for fraud, imp
 
 Planned generators:
 
-- Driving License Number
-- CIN Number
-- Demat Account
-- Regional language names
-- Telecom operators
-- Railway PNR
+- [ ] Driving License Number *(format implemented — checksum validation pending)*
+- [x] CIN Number
+- [x] Demat Account
+- [x] Regional language names
+- [x] Telecom operators
+- [x] Railway PNR
+- [ ] Indian company names *(basic generator added — expand data)*
+- [ ] Commerce (HSN codes, invoice numbers)
+- [ ] Education (schools, universities)
 
 ---
 
@@ -339,19 +490,19 @@ Bug reports and pull requests are welcome.
 git checkout -b feature/my-feature
 ```
 
-1. Commit changes
+3. Commit changes
 
 ```bash
 git commit -m "Add new generator"
 ```
 
-1. Push to branch
+4. Push to branch
 
 ```bash
 git push origin feature/my-feature
 ```
 
-1. Open a Pull Request
+5. Open a Pull Request
 
 When adding generators, include YAML data, Ruby class, and RSpec tests.
 
@@ -382,18 +533,28 @@ Released under the MIT License.
 ## Example Output
 
 ```ruby
-{
-  name: "Sneha Kulkarni",
-  regional_name: "அருண் ஐயர்",
-  pan: "BQWPE1234K",
-  aadhaar: "4567 1234 8910",
-  phone: "+91 9123456789",
-  upi: "sneha@okicici",
-  vehicle: "MH14DT4321",
-  address: "221 FC Road, Pune, Maharashtra - 411001",
-  dish: "Masala Dosa",
-  sweet: "Gulab Jamun"
-}
+profile = Faker::Indian.profile
+
+# {
+#   name: "Sneha Kulkarni",
+#   phone: "+91 9123456789",
+#   pan: "BQWPE1234K",
+#   aadhaar: "4567 1234 8910",
+#   gstin: "27BQWPE1234K1Z5",
+#   upi: "sneha@okicici",
+#   vehicle: "MH14DT4321",
+#   address: "221 FC Road, Andheri, Pune, Maharashtra - 411001",
+#   dish: "Masala Dosa"
+# }
+
+Faker::Indian::Languages.full_name(language: :tamil)
+# => "Arun Iyer"
+
+Faker::Indian::Travel.pnr
+# => "4829173056"
+
+Faker::Indian::Company.name
+# => "Hindustan Logistics LLP"
 ```
 
 ---
@@ -402,4 +563,4 @@ Released under the MIT License.
 
 Most fake-data libraries are heavily US-centric.
 
-`faker-indian` focuses specifically on Indian systems, formats, and identifiers, making it easier to build and test applications for the Indian market.
+`faker-indian` focuses specifically on Indian systems, formats, and identifiers, making it easier to build and test applications for the Indian market.

data/lib/faker/indian/address.rb

@@ -5,27 +5,46 @@ require "faker"
 module Faker
   module Indian
     class Address
-      _data = Data.load(:address)
+      data = Data.load(:address)
 
-      LOCATIONS = _data.fetch(:locations).freeze
-      STREETS = _data.fetch(:streets).freeze
+      LOCATIONS = data.fetch(:locations).freeze
+      STREETS = data.fetch(:streets).freeze
+      STATE_CODES = data.fetch(:state_codes).freeze
+      DISTRICTS = data.fetch(:districts).freeze
+      LANDMARKS = data.fetch(:landmarks).freeze
 
       class << self
-        def city
-          sample_location[:city]
+        def city(state: nil)
+          sample_location(state: state)[:city]
         end
 
-        def state
-          sample_location[:state]
+        def state(state: nil)
+          sample_location(state: state)[:state]
         end
 
-        def pincode
-          sample_location[:pincode]
+        def pincode(state: nil)
+          sample_location(state: state)[:pincode]
         end
 
-        def full_address
-          loc = sample_location
-          "#{random_street_number} #{random_street}, #{loc[:city]}, #{loc[:state]} - #{loc[:pincode]}"
+        def state_code(state: nil)
+          sample_location(state: state)[:state_code]
+        end
+
+        def district
+          DISTRICTS.sample(random: random)
+        end
+
+        def landmark
+          LANDMARKS.sample(random: random)
+        end
+
+        def line1
+          "#{random_street_number} #{random_street}"
+        end
+
+        def full_address(state: nil)
+          loc = sample_location(state: state)
+          "#{line1}, #{district}, #{loc[:city]}, #{loc[:state]} - #{loc[:pincode]}"
         end
 
         private
@@ -34,9 +53,36 @@ module Faker
           Faker::Config.random
         end
 
-        def sample_location
-          city_name, details = LOCATIONS.to_a.sample(random: random)
-          { city: city_name, state: details[:state], pincode: details[:pincode] }
+        def sample_location(state: nil)
+          city_name, details = filtered_locations(state).to_a.sample(random: random)
+          state_name = details[:state]
+          {
+            city: city_name,
+            state: state_name,
+            pincode: details[:pincode],
+            state_code: lookup_state_code(state_name)
+          }
+        end
+
+        def filtered_locations(state)
+          return LOCATIONS if state.nil?
+
+          matches = LOCATIONS.select { |_, details| state_match?(details[:state], state) }
+          raise Error, "unknown state: #{state}" if matches.empty?
+
+          matches
+        end
+
+        def state_match?(state_name, filter)
+          normalized = filter.to_s.downcase.tr("_", " ")
+          return true if state_name.to_s.downcase == normalized
+
+          code = lookup_state_code(state_name)
+          code&.casecmp?(filter.to_s)
+        end
+
+        def lookup_state_code(state_name)
+          STATE_CODES[state_name.to_sym] || STATE_CODES[state_name.to_s]
         end
 
         def random_street

data/lib/faker/indian/company.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require "faker"
+
+module Faker
+  module Indian
+    class Company
+      data = Data.load(:company)
+
+      PREFIXES = data.fetch(:prefixes).freeze
+      CORES = data.fetch(:cores).freeze
+      SUFFIXES = data.fetch(:suffixes).freeze
+      TYPES = data.fetch(:types).freeze
+
+      class << self
+        def name
+          "#{PREFIXES.sample(random: random)} #{CORES.sample(random: random)} #{SUFFIXES.sample(random: random)}"
+        end
+
+        def type
+          TYPES.sample(random: random)
+        end
+
+        def cin
+          state = Address::STATE_CODES.values.sample(random: random)
+          year = random.rand(2000..2024)
+          industry = format("%05d", random.rand(10_000..99_999))
+          serial = format("%06d", random.rand(100_000..999_999))
+
+          "U#{industry}#{state}#{year}PTC#{serial}"
+        end
+
+        private
+
+        def random
+          Faker::Config.random
+        end
+      end
+    end
+  end
+end