code_to_query 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 46846303df2e09d6bcfcd98759381a486f760cc280c5d9a8f171fad62e7b1009
+  data.tar.gz: cebec7881b707d8f135b1c97e56ae8678b7fdbd84cb824ec121e9ad869e26138
+SHA512:
+  metadata.gz: 21e4c488f347e132ef62f09db92989b2b7015d4eeb69e3eb6ae55b44429bed6b8988734ee14e6d5db7cb18aa008c2b1cf29d17cc1b7d0cbab90a437a983b566f
+  data.tar.gz: a52f6f1ddea3f4e6f80ffdecba78d1eeb781d9d3f15cf3f6e998287a3a3fe1755f8d4d8102b6b33e7b9614a243dd585b9531e25512e65cb26a6024d46a70a6d7

data/CHANGELOG.md

@@ -0,0 +1,22 @@
+# Changelog
+
+This file tracks the major changes in each release.
+
+## [0.1.0] - 2025-08-14
+
+### Added
+- Support for OpenAI and local AI providers
+- SQL safety checks with table allowlists and EXPLAIN analysis
+- Automatic policy enforcement for row-level security
+- Query performance monitoring and caching
+- CI setup for multiple Ruby and Rails versions
+- Basic gem structure and setup
+- Core Query class with SQL generation and safety checks
+- Simple query validation using dry-schema
+- Local query planning and compilation
+- MIT license and initial docs
+
+### Changed
+- Simplified the SQL linter to work better with different database adapters
+- Improved the query compiler with better Arel integration
+- Cleaner error messages and logging

data/LICENSE.txt

@@ -0,0 +1,23 @@
+MIT License
+
+Copyright (c) 2025 Alex Kholodniak
+
+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,167 @@
+# CodeToQuery
+
+A gem that converts natural language questions into SQL queries for Rails apps. It's built for teams who need to give non-developers access to data without compromising security or performance.
+
+## What it does
+
+Instead of writing SQL, your team can ask questions like "Show me top customers by revenue this month" and get back safe, parameterized queries that respect your database policies and security rules.
+
+## Key features
+
+- **Multiple AI providers**: Works with OpenAI or local models
+- **Built-in safety**: SQL linting, table allowlists, EXPLAIN plan checks
+- **Schema awareness**: Understands your models, associations, and scopes
+- **Policy enforcement**: Automatically injects tenant filters and access rules
+- **Performance monitoring**: Optional query analysis and optimization
+
+## Getting started
+
+Add to your Gemfile:
+
+```ruby
+gem 'code_to_query'
+```
+
+Run `bundle install` and create a config file:
+
+```ruby
+# config/initializers/code_to_query.rb
+CodeToQuery.configure do |config|
+  config.openai_api_key = ENV['OPENAI_API_KEY']
+  config.openai_model = 'gpt-4.1-mini'
+  
+  # Security settings
+  config.enable_explain_gate = true
+  config.allow_seq_scans = false
+  config.max_query_cost = 10000
+  config.require_limit_by_default = true
+end
+```
+
+Generate your schema context:
+
+```bash
+rails code_to_query:bootstrap
+```
+
+## Basic usage
+
+```ruby
+# Ask a question
+query = CodeToQuery.ask(
+  prompt: "Top 10 invoices by amount in July",
+  allow_tables: %w[invoices vendors],
+  current_user: current_user
+)
+
+# Check if it's safe to run
+if query.safe?
+  results = query.run
+  puts "Found #{results.rows.length} results"
+end
+
+# Or get the SQL for review
+puts query.sql
+puts query.params
+```
+
+## Configuration options
+
+### Database settings
+```ruby
+config.adapter = :postgres           # :postgres, :mysql, :sqlite
+config.readonly_role = :reporting    # Database role for queries
+config.default_limit = 100           # Default row limit
+config.max_limit = 10000             # Max allowed limit
+```
+
+### Security settings
+```ruby
+config.enable_explain_gate = true    # Block expensive queries
+config.allow_seq_scans = false       # Prevent table scans
+config.max_query_cost = 10000        # Cost threshold
+config.max_joins = 3                 # Join limit
+```
+
+### OpenAI settings
+```ruby
+config.openai_api_key = ENV['OPENAI_API_KEY']
+config.openai_model = 'gpt-4'
+config.stub_llm = false              # Set true for testing
+```
+
+## Rake tasks
+
+```bash
+rails code_to_query:bootstrap    # Generate full context pack
+rails code_to_query:schema       # Extract schema info
+rails code_to_query:scan_app     # Scan models and associations
+rails code_to_query:verify       # Check context pack integrity
+```
+
+## Security features
+
+- **SQL injection prevention**: All queries are parameterized
+- **Access control**: Table allowlists and row-level policies
+- **Performance limits**: EXPLAIN plan analysis and cost thresholds
+- **Readonly execution**: Uses dedicated readonly database connections
+
+## Advanced usage
+
+### Custom policies
+```ruby
+config.policy_adapter = ->(user) do
+  return {} unless user
+  
+  {
+    company_id: user.company_id,
+    user_id: user.admin? ? nil : user.id
+  }
+end
+```
+
+### Custom schema
+```ruby
+schema = {
+  tables: [
+    {
+      name: "users",
+      columns: [
+        { name: "id", sql_type: "integer" },
+        { name: "email", sql_type: "varchar" }
+      ]
+    }
+  ]
+}
+
+query = CodeToQuery.ask(
+  prompt: "Recent users",
+  schema: schema,
+  allow_tables: ["users"]
+)
+```
+
+## Error handling
+
+```ruby
+begin
+  query = CodeToQuery.ask(prompt: "Complex query")
+  results = query.run if query.safe?
+rescue CodeToQuery::ExecutionError => e
+  Rails.logger.error "Query failed: #{e.message}"
+rescue CodeToQuery::ConnectionError => e
+  Rails.logger.error "Database issue: #{e.message}"
+end
+```
+
+## Contributing
+
+1. Fork the repo
+2. Create a feature branch
+3. Make your changes
+4. Add tests
+5. Submit a pull request
+
+## License
+
+MIT License - see LICENSE file for details.