faker-indian 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: de6eb2615cdfb3ca1ad1a1186da1d98522b9da95827b507266b1ae188b79c670
+  data.tar.gz: d8fe29db43869ea2c43b9f6037aeeea829e4caf12adeec923f34989b08a135ca
+SHA512:
+  metadata.gz: c13a7c3db4650cd13149feff73e962ef257e13b4bb07ea0410dfd86878e410375ca43633ffca6ce178d650bd8347e195d5831bc7315a3b8ecc79daf85c13e0fc
+  data.tar.gz: 2b4ad2eeabbc018525ba738f838515abe10e65ae46c57fe1c32a26a47e2d0b575fd9efd7ff44bf45a42b1a285917e705f7fab1d7ebba29d6e0249917bf83679d

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  TargetRubyVersion: 3.1
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2026-05-14
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 Jyoti Sharma
+
+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,405 @@
+# faker-indian
+
+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.
+
+Perfect for:
+
+- Rails seed data
+- FactoryBot fixtures
+- API mocks
+- Testing & development
+- Demo applications
+
+---
+
+## Features
+
+- 🇮🇳 Indian-first fake data generation
+- 👤 Indian names & identities
+- 🌐 Regional language names (Hindi, Tamil, Telugu, and more)
+- 💳 Payment & banking details
+- 🚗 Vehicle registration numbers
+- 🏠 Indian addresses & PIN codes
+- 📞 Mobile numbers
+- 🍛 Indian dishes, cuisines, and restaurants
+- 📁 YAML-backed data — easy to extend without changing logic
+- ⚡ Lightweight and easy to use
+
+---
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'faker-indian'
+```
+
+Then execute:
+
+```bash
+bundle install
+```
+
+Or install manually:
+
+```bash
+gem install faker-indian
+```
+
+---
+
+## Quick Start
+
+```ruby
+require "faker/indian"
+
+Faker::Indian::Name.full_name
+# => "Arjun Sharma"
+
+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::
+Faker::Indian::Languages.full_name(language: :tamil)
+# => "Karthik Iyer"
+
+Faker::Indian::Food.dish
+# => "Masala Dosa"
+```
+
+---
+
+## Available Generators
+
+### Name
+
+Generate Indian names.
+
+```ruby
+Faker::Indian::Name.first_name
+# => "Priya"
+
+Faker::Indian::Name.last_name
+# => "Patel"
+
+Faker::Indian::Name.full_name
+# => "Rohan Verma"
+
+Faker::Indian::Name.prefix
+# => "Dr."
+```
+
+---
+
+### Languages
+
+Generate names and metadata for major Indian languages.
+
+Supported languages: Hindi, Tamil, Telugu, Bengali, Marathi, Gujarati, Kannada, Malayalam, and Punjabi.
+
+Pass a language as a symbol (`:hindi`), language name, or ISO-style code (`"hi"`, `"ta"`). Omit `language:` to pick one at random.
+
+```ruby
+Faker::Indian::Languages.name
+# => "Tamil"
+
+Faker::Indian::Languages.name(language: :hindi)
+# => "Hindi"
+
+Faker::Indian::Languages.native_name(language: :tamil)
+# => "தமிழ்"
+
+Faker::Indian::Languages.code(language: :bengali)
+# => "bn"
+
+Faker::Indian::Languages.first_name(language: :punjabi)
+# => "Simran"
+
+Faker::Indian::Languages.full_name(language: :gujarati)
+# => "Jay Patel"
+
+Faker::Indian::Languages.available
+# => [:hindi, :tamil, :telugu, :bengali, :marathi, :gujarati, :kannada, :malayalam, :punjabi]
+```
+
+---
+
+### Identity
+
+Generate Indian identity-related data.
+
+```ruby
+Faker::Indian::Identity.pan
+# => "ABCDE1234F"
+
+Faker::Indian::Identity.aadhaar
+# => "1234 5678 9012"
+
+Faker::Indian::Identity.gstin
+# => "27ABCDE1234F1Z5"
+
+Faker::Indian::Identity.voter_id
+# => "ABC1234567"
+
+Faker::Indian::Identity.passport
+# => "N1234567"
+```
+
+---
+
+### Payment
+
+Generate fake Indian banking and payment data.
+
+```ruby
+Faker::Indian::Payment.upi_id
+# => "amit@oksbi"
+
+Faker::Indian::Payment.ifsc
+# => "HDFC0001234"
+
+Faker::Indian::Payment.bank_name
+# => "State Bank of India"
+
+Faker::Indian::Payment.account_number
+# => "123456789012"
+```
+
+Aliases: `upi` (for `upi_id`), `ifsc_code` (for `ifsc`).
+
+---
+
+### Vehicle
+
+Generate Indian vehicle registration numbers.
+
+```ruby
+Faker::Indian::Vehicle.registration_number
+# => "KA01MJ4587"
+
+Faker::Indian::Vehicle.state_code
+# => "MH"
+```
+
+---
+
+### Address
+
+Generate realistic Indian addresses.
+
+```ruby
+Faker::Indian::Address.city
+# => "Pune"
+
+Faker::Indian::Address.state
+# => "Maharashtra"
+
+Faker::Indian::Address.pincode
+# => "411001"
+
+Faker::Indian::Address.full_address
+# => "221 MG Road, Pune, Maharashtra - 411001"
+```
+
+---
+
+### Phone
+
+Generate Indian mobile numbers.
+
+```ruby
+Faker::Indian::Phone.mobile_number
+# => "+91 9876543210"
+```
+
+---
+
+### Food
+
+Generate Indian food-related data.
+
+```ruby
+Faker::Indian::Food.dish
+# => "Hyderabadi Biryani"
+
+Faker::Indian::Food.restaurant_name
+# => "Saravana Bhavan"
+
+Faker::Indian::Food.cuisine
+# => "South Indian"
+
+Faker::Indian::Food.street_food
+# => "Pani Puri"
+
+Faker::Indian::Food.sweet
+# => "Gulab Jamun"
+```
+
+---
+
+## Data Files
+
+Static data lives in YAML files under `lib/faker/indian/data/` and is loaded by `Faker::Indian::Data`:
+
+
+| File            | Used by     |
+| --------------- | ----------- |
+| `name.yml`      | `Name`      |
+| `languages.yml` | `Languages` |
+| `identity.yml`  | `Identity`  |
+| `payment.yml`   | `Payment`   |
+| `vehicle.yml`   | `Vehicle`   |
+| `address.yml`   | `Address`   |
+| `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)`.
+
+---
+
+## Rails Usage
+
+### Seeds
+
+```ruby
+10.times do
+  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
+  )
+end
+```
+
+### FactoryBot
+
+```ruby
+FactoryBot.define do
+  factory :user do
+    name  { Faker::Indian::Name.full_name }
+    phone { Faker::Indian::Phone.mobile_number }
+    pan   { Faker::Indian::Identity.pan }
+  end
+
+  factory :restaurant do
+    name    { Faker::Indian::Food.restaurant_name }
+    cuisine { Faker::Indian::Food.cuisine }
+  end
+end
+```
+
+---
+
+## Validation Notice
+
+This gem generates fake but format-valid data intended only for:
+
+- Testing
+- Development
+- Mock APIs
+- Demo applications
+
+Generated values are **not real identities** and must not be used for fraud, impersonation, or verification systems.
+
+---
+
+## Roadmap
+
+Planned generators:
+
+- Driving License Number
+- CIN Number
+- Demat Account
+- Regional language names
+- Telecom operators
+- Railway PNR
+
+---
+
+## Contributing
+
+Bug reports and pull requests are welcome.
+
+1. Fork the repository
+2. Create your feature branch
+
+```bash
+git checkout -b feature/my-feature
+```
+
+1. Commit changes
+
+```bash
+git commit -m "Add new generator"
+```
+
+1. Push to branch
+
+```bash
+git push origin feature/my-feature
+```
+
+1. Open a Pull Request
+
+When adding generators, include YAML data, Ruby class, and RSpec tests.
+
+---
+
+## Development
+
+Run tests:
+
+```bash
+bundle exec rspec
+```
+
+Run linting:
+
+```bash
+bundle exec rubocop
+```
+
+---
+
+## License
+
+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"
+}
+```
+
+---
+
+## Why faker-indian?
+
+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.

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/lib/faker/indian/address.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require "faker"
+
+module Faker
+  module Indian
+    class Address
+      _data = Data.load(:address)
+
+      LOCATIONS = _data.fetch(:locations).freeze
+      STREETS = _data.fetch(:streets).freeze
+
+      class << self
+        def city
+          sample_location[:city]
+        end
+
+        def state
+          sample_location[:state]
+        end
+
+        def pincode
+          sample_location[:pincode]
+        end
+
+        def full_address
+          loc = sample_location
+          "#{random_street_number} #{random_street}, #{loc[:city]}, #{loc[:state]} - #{loc[:pincode]}"
+        end
+
+        private
+
+        def random
+          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] }
+        end
+
+        def random_street
+          STREETS.sample(random: random)
+        end
+
+        def random_street_number
+          random.rand(1..999)
+        end
+      end
+    end
+  end
+end

data/lib/faker/indian/data/address.yml

@@ -0,0 +1,40 @@
+locations:
+  Mumbai:
+    state: Maharashtra
+    pincode: "400001"
+  Pune:
+    state: Maharashtra
+    pincode: "411001"
+  Delhi:
+    state: Delhi
+    pincode: "110001"
+  Bengaluru:
+    state: Karnataka
+    pincode: "560001"
+  Chennai:
+    state: Tamil Nadu
+    pincode: "600001"
+  Hyderabad:
+    state: Telangana
+    pincode: "500001"
+  Ahmedabad:
+    state: Gujarat
+    pincode: "380001"
+  Kolkata:
+    state: West Bengal
+    pincode: "700001"
+  Jaipur:
+    state: Rajasthan
+    pincode: "302001"
+  Lucknow:
+    state: Uttar Pradesh
+    pincode: "226001"
+
+streets:
+  - MG Road
+  - FC Road
+  - Park Street
+  - Brigade Road
+  - Linking Road
+  - Anna Salai
+  - Ring Road