rails-nl2sql 0.2.4 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2ad0e3b00db210b1b61ef7b0081cc2d270929f9564e1b9431881389bbe5cf74a
-  data.tar.gz: f1240e38861cc58b0754fe20276d399a9206c8280b3b01a54b4795eec0296222
+  metadata.gz: 32ceb33965fb596a339bbf54e8945aa3d03df7cd53224076263363694776f699
+  data.tar.gz: ad845d46819e09cf9b2ba74bf24529f4f370829f19a5b1564183ce06b6089188
 SHA512:
-  metadata.gz: cef48fc2a9f8ea4ed06b6345f64963efe4342677901c1a35406b5296141539dfa6f4f33d7bd15727db9534f25a0df0f8673164f05a117dabae998dfa02519243
-  data.tar.gz: 7aa4bd9311438ed6d77e423325ee64d5a4d79bedf1f8bbe4f54bef5d6ba3e0a63b2de2b5f5094252a95a06bf67c47e6cf5645a77eacd4fd0d645ed2eb1d5d802
+  metadata.gz: 00bf7f7132cefed3bfdcf1d3936b2264e495d8db545aac8551d72273454d9d1605e017cecfd1e1c09f6a4a9a7db625502601feb28ac5b5ada18f68e7fe34b584
+  data.tar.gz: efb583c44acee0a05c636f8f462bec47119dbf48e102c9736940e1ecd665ebc90bdde3fb57bf7dba9907e3dbd3e648c752b58196cdbe7af6eea896c85a188329

data/.gitignore

@@ -13,3 +13,6 @@
 /spec/rails_helper.rb
 /spec/spec_helper.rb
 CLAUDE.md
+Gemfile.lock
+/docs/*
+/docs

data/CHANGELOG.md

@@ -0,0 +1,53 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+
+
+## [0.2.5] - 2025-07-18
+### Fixed
+- Fixed the ERB Template Variable Binding Issue
+
+## [0.2.4] - 2025-07-18
+### Fixed
+- Fixed undefined variable error in ERB template processing
+
+## [0.2.3] - 2025-07-18
+### Added
+- Pluggable LLM provider system with support for OpenAI, Anthropic, and Llama
+- Custom prompt templates via ERB
+- Context window management with configurable schema line limits
+- Comprehensive error handling and validation
+
+### Enhanced
+- Improved security with query validation and banned keywords
+- Better schema caching for performance
+- Support for multiple database types (PostgreSQL, MySQL, SQLite, etc.)
+
+## [0.2.0] - 2025-07-17
+### Added
+- ActiveRecord integration with `from_nl` method
+- Schema caching for improved performance
+- Multiple provider support (OpenAI, Anthropic, Llama)
+- Configurable prompt templates
+- Enhanced query validation and security
+
+### Changed
+- Improved architecture with provider abstraction
+- Better error handling and user feedback
+- More robust SQL generation and validation
+
+## [0.1.0] - 2025-07-17
+### Added
+- Initial release
+- Basic natural language to SQL conversion
+- OpenAI integration
+- Rails generator for easy setup
+- Query validation and security features
+- Support for table inclusion/exclusion
+- Basic schema introspection

data/Rakefile

@@ -1,2 +1,6 @@
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
 task :default => :spec

data/lib/generators/rails/nl2sql/templates/rails_nl2sql.rb

@@ -1,7 +1,17 @@
 Rails::Nl2sql.configure do |config|
-  config.api_key = "YOUR_API_KEY"
+  # Set your API key. It's recommended to use an environment variable for security.
+  config.api_key = ENV["OPENAI_API_KEY"]
+  
+  # Optional: Set the model to use (default: "gpt-3.5-turbo-instruct")
   # config.model = "gpt-3.5-turbo-instruct"
+  
+  # Optional: Set a custom provider (default: OpenAI)
   # config.provider = Rails::Nl2sql::Providers::OpenaiProvider.new(api_key: config.api_key)
-  # config.prompt_template_path = Rails::Nl2sql.prompt_template_path
+  # config.provider = Rails::Nl2sql::Providers::AnthropicProvider.new(api_key: ENV["ANTHROPIC_API_KEY"])
+  
+  # Optional: Set custom prompt template path
+  # config.prompt_template_path = Rails.root.join("config", "nl2sql_prompts.yml.erb")
+  
+  # Optional: Limit schema lines to fit within model context window (default: 200)
   # config.max_schema_lines = 200
 end

data/lib/generators/rails_nl2sql/install/templates/rails_nl2sql.rb

@@ -1,7 +1,17 @@
 Rails::Nl2sql.configure do |config|
-  config.api_key = "YOUR_API_KEY"
+  # Set your API key. It's recommended to use an environment variable for security.
+  config.api_key = ENV["OPENAI_API_KEY"]
+  
+  # Optional: Set the model to use (default: "gpt-3.5-turbo-instruct")
   # config.model = "gpt-3.5-turbo-instruct"
+  
+  # Optional: Set a custom provider (default: OpenAI)
   # config.provider = Rails::Nl2sql::Providers::OpenaiProvider.new(api_key: config.api_key)
-  # config.prompt_template_path = Rails::Nl2sql.prompt_template_path
+  # config.provider = Rails::Nl2sql::Providers::AnthropicProvider.new(api_key: ENV["ANTHROPIC_API_KEY"])
+  
+  # Optional: Set custom prompt template path
+  # config.prompt_template_path = Rails.root.join("config", "nl2sql_prompts.yml.erb")
+  
+  # Optional: Limit schema lines to fit within model context window (default: 200)
   # config.max_schema_lines = 200
 end

data/lib/rails/nl2sql/query_generator.rb

@@ -78,9 +78,24 @@ module Rails
 
       def build_prompts(input, db_server, retrieved_context)
         template = Rails::Nl2sql.prompt_template
-        template_binding = binding
-        system_prompt = ERB.new(template['system']).result(template_binding)
-        user_prompt = ERB.new(template['user']).result(template_binding)
+        
+        # Create ERB context with explicit local variables
+        erb_context = Object.new
+        erb_context.instance_variable_set(:@input, input)
+        erb_context.instance_variable_set(:@db_server, db_server)
+        erb_context.instance_variable_set(:@retrieved_context, retrieved_context)
+        
+        erb_context.define_singleton_method(:get_binding) do
+          binding
+        end
+        
+        # Define accessor methods for the ERB template
+        erb_context.define_singleton_method(:input) { @input }
+        erb_context.define_singleton_method(:db_server) { @db_server }
+        erb_context.define_singleton_method(:retrieved_context) { @retrieved_context }
+        
+        system_prompt = ERB.new(template['system']).result(erb_context.get_binding)
+        user_prompt = ERB.new(template['user']).result(erb_context.get_binding)
         [system_prompt, user_prompt]
       end
 

data/lib/rails/nl2sql/schema_builder.rb

@@ -68,7 +68,13 @@ module Rails
       end
 
       def self.build_table_schema(table)
-        columns = ActiveRecord::Base.connection.columns(table)
+        begin
+          columns = ActiveRecord::Base.connection.columns(table)
+        rescue => e
+          # Skip tables that can't be introspected (e.g., PostGIS system tables)
+          Rails.logger.debug "Skipping table #{table} due to introspection error: #{e.message}" if defined?(Rails)
+          return "-- Table #{table} skipped due to introspection error"
+        end
         
         schema = "CREATE TABLE #{table} (\n"
         
@@ -122,7 +128,22 @@ module Rails
         when :json
           "JSON"
         else
-          column.sql_type || "TEXT"
+          # Handle PostGIS geometry types and other spatial types
+          sql_type = column.sql_type || "TEXT"
+          case sql_type.downcase
+          when /geometry/
+            "GEOMETRY"
+          when /geography/
+            "GEOGRAPHY"
+          when /point/
+            "POINT"
+          when /polygon/
+            "POLYGON"
+          when /linestring/
+            "LINESTRING"
+          else
+            sql_type
+          end
         end
       end
 
@@ -159,7 +180,34 @@ module Rails
           'sys'
         ]
         
-        system_tables.any? { |sys_table| table.include?(sys_table) }
+        # PostGIS system tables
+        postgis_system_tables = [
+          'geometry_columns',
+          'geography_columns',
+          'spatial_ref_sys',
+          'raster_columns',
+          'raster_overviews',
+          'topology',
+          'layer',
+          'topology_layer'
+        ]
+        
+        # PostgreSQL system schemas
+        pg_system_schemas = [
+          'pg_',
+          'information_schema'
+        ]
+        
+        # Check regular system tables
+        return true if system_tables.any? { |sys_table| table.include?(sys_table) }
+        
+        # Check PostGIS system tables
+        return true if postgis_system_tables.any? { |sys_table| table == sys_table }
+        
+        # Check PostgreSQL system schemas
+        return true if pg_system_schemas.any? { |schema| table.start_with?(schema) }
+        
+        false
       end
 
       # Legacy method for backward compatibility

data/lib/rails/nl2sql/version.rb

@@ -1,5 +1,5 @@
 module Rails
   module Nl2sql
-    VERSION = "0.2.4"
+    VERSION = "0.2.6"
   end
 end

data/lib/rails/nl2sql.rb

@@ -39,10 +39,9 @@ module Rails
     end
 
     def self.prompt_template
-      @prompt_template ||= begin
-        erb = ERB.new(File.read(prompt_template_path))
-        YAML.safe_load(erb.result)
-      end
+      # Load the YAML template without evaluating ERB so we can
+      # interpolate variables later when building prompts.
+      @prompt_template ||= YAML.safe_load(File.read(prompt_template_path))
     end
 
     class Processor

data/rails-nl2sql.gemspec

@@ -39,7 +39,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency "openai", "~> 0.3"
   spec.add_dependency "anthropic", ">= 0.1"
   spec.add_development_dependency "bundler", ">= 2.0"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "rspec-rails", "~> 6.0"
   spec.add_dependency "railties", ">= 6.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails-nl2sql
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.6
 platform: ruby
 authors:
 - Russell Van Curen
@@ -58,14 +58,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -105,6 +119,7 @@ extra_rdoc_files: []
 files:
 - ".DS_Store"
 - ".gitignore"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt