AIFaker 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7bde2c3f571fa5b745523114e1313f79ea768b1c48408918cbe9a1f2975e9c2a
+  data.tar.gz: 1fe46a60220f6fb95ef4308db036b317a8e17ac7508c4af8b72db0f480ee9b2c
+SHA512:
+  metadata.gz: bf33a25da19a490ef4337bb59794c59919b380ccf76138617c42015de4f0243b56cf0d54fd6958c21db02721930674f0f7575e20d2b38e4a7d9032a9e9a88e78
+  data.tar.gz: 54ad8a9d77abd245309fd8c0fa0f1b8791b2e46b28ff2a8c4913a0fc4959a675aac2d277d5b4645069641f84804a6ad7e55fa2bdbd1b56bcf2eea754d15eee7a

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 TODO: Write your name
+
+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,245 @@
+# AIFaker
+
+AI-powered, schema-aware Rails seeding for modern teams.
+
+`AIFaker` helps developers, startups, and product teams generate realistic demo and test data in minutes instead of spending hours writing and maintaining manual `db/seeds.rb` logic.
+
+It reads your Rails schema and model relationships, uses an LLM to generate meaningful attributes, and creates records in dependency order (`belongs_to` parents first) so your data is usable from day one.
+
+Why teams use AIFaker:
+
+- realistic data for demos, QA, staging, and local development
+- faster onboarding for new developers (no manual seed setup)
+- schema-aware generation that respects model structure and validations
+- automatic retry + repair flow for common seeding failures
+- provider flexibility (`openai`, `claude`/`anthropic`, `gemini`, `deepseek`, `bedrock`)
+
+## Installation
+
+Add both gems to your Rails app:
+
+```bash
+bundle add AIFaker
+bundle add ruby_llm
+```
+
+Or in `Gemfile`:
+
+```ruby
+gem "AIFaker"
+gem "ruby_llm"
+```
+
+## Quick Start
+
+Set provider + API key in your shell:
+
+```bash
+export AIFAKER_PROVIDER=openai
+export OPENAI_API_KEY="your_key_here"
+```
+
+Create `db/seeds.rb`:
+
+```ruby
+client = AIFaker.connect
+client.seed!
+```
+
+Run:
+
+```bash
+rails db:seed
+```
+
+## What To Write In `db/seeds.rb`
+
+### 1) Interactive mode (default)
+
+If you do not set `automode`, it stays `false` by default.
+
+```ruby
+client = AIFaker.connect
+client.seed!
+```
+
+Behavior:
+
+- asks confirmation before seeding
+- asks count per table (range: 5..50)
+- asks per model/table whether to seed or skip
+
+### 2) Non-interactive mode (`client.automode = true`)
+
+```ruby
+client = AIFaker.connect
+client.automode = true
+client.seed!
+```
+
+Behavior:
+
+- no prompts (auto-yes everywhere)
+- random count per table (`10..20`)
+- seeds all models in planned order
+
+Equivalent shorthand:
+
+```ruby
+client = AIFaker.connect
+client.automode!
+client.seed!
+```
+
+### 3) Explicit provider in code
+
+```ruby
+client = AIFaker.connect("gemini")
+client.automode = true
+client.seed!
+```
+
+`AIFaker.connect` provider fallback order:
+
+1. explicit argument (`AIFaker.connect("gemini")`)
+2. `ENV["AIFAKER_PROVIDER"]`
+3. default `"openai"`
+
+`claude` is also supported as a friendly alias for Anthropic:
+
+```ruby
+client = AIFaker.connect("claude") # internally uses anthropic provider
+client.seed!
+```
+
+## Environment Variables
+
+### Provider selection
+
+- `AIFAKER_PROVIDER` -> `openai | anthropic | claude | gemini | deepseek | bedrock`
+
+### Provider credentials
+
+- `OPENAI_API_KEY` for `openai`
+- `ANTHROPIC_API_KEY` for `anthropic` and `claude`
+- `GEMINI_API_KEY` for `gemini`
+- `DEEPSEEK_API_KEY` for `deepseek`
+- `BEDROCK_API_KEY`, `BEDROCK_SECRET_KEY`, `BEDROCK_REGION` for `bedrock`
+- `BEDROCK_SESSION_TOKEN` (optional)
+
+### Model and request tuning
+
+- `AIFAKER_MODEL` -> force a specific model id
+- `AIFAKER_TIMEOUT` -> request timeout in seconds
+
+Examples:
+
+```bash
+export AIFAKER_PROVIDER=gemini
+export GEMINI_API_KEY="your_key_here"
+export AIFAKER_MODEL="models/gemini-1.5-flash"
+export AIFAKER_TIMEOUT=120
+```
+
+```bash
+export AIFAKER_PROVIDER=openai
+export OPENAI_API_KEY="your_key_here"
+export AIFAKER_MODEL="gpt-4.1-mini"
+```
+
+```bash
+export AIFAKER_PROVIDER=claude
+export ANTHROPIC_API_KEY="your_key_here"
+# optional: choose a specific Claude model
+export AIFAKER_MODEL="claude-3-5-sonnet-latest"
+```
+
+## Provider Notes
+
+### Gemini
+
+- If a discovered model is unsupported for `generateContent` (for example `models/aqa`), AIFaker automatically tries other available provider models.
+- You can still force a model via `AIFAKER_MODEL`.
+
+## How Seeding Works
+
+During `client.seed!`, AIFaker:
+
+1. connects to LLM provider
+2. reads schema
+3. reads models + associations
+4. builds dependency-aware seed plan
+5. generates attributes and creates records
+6. auto-repairs common failures (including uniqueness retries)
+
+When record creation fails, AIFaker shares failure context back to the LLM (error details + attempted attributes + uniqueness exclusions) to improve the next attempt.
+
+## Typical `db/seeds.rb` Templates
+
+### Template A: local development (interactive)
+
+```ruby
+client = AIFaker.connect
+client.seed!
+```
+
+### Template B: CI / scripted runs
+
+```ruby
+client = AIFaker.connect
+client.automode = true
+client.seed!
+```
+
+### Template C: fixed provider + fixed model
+
+```ruby
+client = AIFaker.connect("gemini")
+client.automode = true
+client.seed!
+```
+
+Then:
+
+```bash
+export GEMINI_API_KEY="your_key_here"
+export AIFAKER_MODEL="models/gemini-1.5-flash"
+rails db:seed
+```
+
+## Security
+
+- Never hardcode API keys in `db/seeds.rb`.
+- Prefer shell env vars, `.env`, or encrypted credentials.
+- If a key is ever exposed in logs/chat/history, rotate it immediately.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [AIFaker](https://github.com/VaibhavDJain/AIFaker). 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/VaibhavDJain/AIFaker/blob/master/CODE_OF_CONDUCT.md).
+
+## Author
+
+- Name: Vaibhav Jain
+- Email: [hiivaibhav1@gmail.com](mailto:hiivaibhav1@gmail.com)
+- GitHub: [VaibhavDJain](https://github.com/VaibhavDJain)
+- LinkedIn: [vaibhav-jain-6454971a4](https://linkedin.com/in/vaibhav-jain-6454971a4)
+- Medium: [vaibhavdjain.medium.com](https://vaibhavdjain.medium.com/)
+- Stack Overflow: [vaibhav-jain](https://stackoverflow.com/users/14558544/vaibhav-jain)
+
+## Contributors
+
+- [Vaibhav Jain](https://github.com/VaibhavDJain)
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the AIFaker project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/VaibhavDJain/AIFaker/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+task default: :test

data/lib/AIFaker/version.rb

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

data/lib/AIFaker.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require_relative "AIFaker/version"
+require_relative "AIFaker/errors"
+require_relative "AIFaker/client"
+
+module AIFaker
+  # Connects to an LLM provider and returns a client object.
+  #
+  # @param provider [String, Symbol, nil] e.g. :openai, :gemini. Defaults to ENV or "openai".
+  # @param options [Hash] provider-specific options
+  # @return [AIFaker::Client]
+  def self.connect(provider = nil, **options)
+    Client.connect(provider, **options)
+  end
+
+  class << self
+    alias_method :client, :connect
+  end
+end

data/sig/AIFaker.rbs

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

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: AIFaker
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Vaibhav Jain
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2026-03-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby_llm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+description: Reads schema + associations and generates realistic seed data using an
+  LLM (via ruby_llm).
+email:
+- hiivaibhav1@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/AIFaker.rb
+- lib/AIFaker/version.rb
+- sig/AIFaker.rbs
+homepage: https://github.com/VaibhavDJain/AIFaker
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/VaibhavDJain/AIFaker
+  source_code_uri: https://github.com/VaibhavDJain/AIFaker
+  changelog_uri: https://github.com/VaibhavDJain/AIFaker
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: AI-powered, schema-aware Rails seeding
+test_files: []