prescient 0.0.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e070d323c97eb52326235a46037b1168cd4dfb5248628e6b6b4111ec3a688d3f
-  data.tar.gz: 603443ccd445a660674414f05521621c7a1502e325d6f18c26036f52e95fca6c
+  metadata.gz: b2b41fc6acb2528a3d74e5bbc58f777a34ead604d3f7bc4e58cc1ff4f8709142
+  data.tar.gz: 665efb1e4b6cc1ed526e91470e7c06278461e98e9d81f0ace34b0872c456251f
 SHA512:
-  metadata.gz: afdbe4946f4578443c98dd828637d57dfd54034154a836b1325c35cd6ba20c8d676cb0da48ac3460417d1af0e3ca20c9263c82d868e5142df49c57bd94595183
-  data.tar.gz: 49d8cce788ff8ba94ce4a2a1a18863a93ca79cd7bb17a04e19768e035716429eed2ae38e852dd373471e8f0c20ddb249d6de419f7b53248aaa30da91ec81ecbb
+  metadata.gz: 23eeca8c5353bcb4219a634905a7f6dc565acbfde665e0e71a0682eb3277abb9384882f70afe168ee27c435f049048f0a715b92daac3fcdc8f34f4ff2b4f7de0
+  data.tar.gz: 77eccf05a9bedfad68de0a262b4ebf32d35b1c1a6d4c35f0327c1c6d16814841a6361b5123b27a8ba6f05e9d999256e2b330200d3e4c7eda0763010c98759c44

data/.env.example

@@ -0,0 +1,37 @@
+# Example environment configuration for Prescient gem
+# Copy this file to .env and configure your API keys
+
+# Ollama Configuration (Local AI)
+OLLAMA_URL=http://localhost:11434
+OLLAMA_EMBEDDING_MODEL=nomic-embed-text
+OLLAMA_CHAT_MODEL=llama3.1:8b
+
+# OpenAI Configuration
+OPENAI_API_KEY=your_openai_api_key_here
+OPENAI_EMBEDDING_MODEL=text-embedding-3-small
+OPENAI_CHAT_MODEL=gpt-3.5-turbo
+
+# Anthropic Configuration
+ANTHROPIC_API_KEY=your_anthropic_api_key_here
+ANTHROPIC_MODEL=claude-3-haiku-20240307
+
+# HuggingFace Configuration
+HUGGINGFACE_API_KEY=your_huggingface_api_key_here
+HUGGINGFACE_EMBEDDING_MODEL=sentence-transformers/all-MiniLM-L6-v2
+HUGGINGFACE_CHAT_MODEL=microsoft/DialoGPT-medium
+
+# PostgreSQL with pgvector Configuration
+DB_HOST=localhost
+DB_PORT=5432
+DB_NAME=prescient_development
+DB_USER=prescient
+DB_PASSWORD=prescient_password
+
+# Optional: Redis for caching (if using with Docker)
+REDIS_URL=redis://localhost:6379/0
+
+# Application Configuration
+PRESCIENT_DEFAULT_PROVIDER=ollama
+PRESCIENT_TIMEOUT=60
+PRESCIENT_RETRY_ATTEMPTS=3
+PRESCIENT_RETRY_DELAY=1.0

data/.rubocop.yml

@@ -0,0 +1,330 @@
+# frozen_string_literal: true
+
+# RuboCop configuration for Prescient gem
+# Modern Ruby best practices with sensible defaults
+
+plugins:
+  - rubocop-minitest
+  - rubocop-performance
+  - rubocop-rake
+
+AllCops:
+  # Target Ruby 3.1+ (matches gemspec requirement)
+  TargetRubyVersion: 3.1
+
+  # Use new cops by default
+  NewCops: enable
+
+  # Exclude common directories
+  Exclude:
+    - 'vendor/**/*'
+    - 'bin/*'
+    - 'tmp/**/*'
+    - 'coverage/**/*'
+    - 'pkg/**/*'
+    - '*.gemspec'
+    - 'Gemfile'
+    - 'Rakefile'
+    - 'examples/**/*'
+
+# === LAYOUT & FORMATTING ===
+
+Layout/LineLength:
+  Max: 120
+  Exclude:
+    - 'test/**/*'
+    - 'lib/prescient.rb'  # Configuration can have long lines
+  AllowedPatterns:
+    - '^\s*#'  # Comments
+    - '^\s*it\s'  # Test descriptions
+    - '^\s*context\s'  # Test contexts
+    - '^\s*describe\s'  # Test descriptions
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Layout/FirstHashElementIndentation:
+  EnforcedStyle: consistent
+
+Layout/FirstArrayElementIndentation:
+  EnforcedStyle: consistent
+
+Layout/HashAlignment:
+  EnforcedHashRocketStyle: table
+  EnforcedColonStyle: table
+
+Layout/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: space
+
+Layout/EmptyLinesAroundModuleBody:
+  Enabled: false
+
+Layout/EmptyLinesAroundClassBody:
+  Enabled: false
+
+# === STYLE ===
+
+Style/StringLiterals:
+  EnforcedStyle: single_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: single_quotes
+
+Style/FrozenStringLiteralComment:
+  Enabled: true
+  EnforcedStyle: always
+  Exclude:
+    - 'examples/**/*'
+
+Style/Documentation:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  EnforcedStyle: compact
+
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/HashSyntax:
+  EnforcedStyle: ruby19_no_mixed_keys
+
+Style/Lambda:
+  EnforcedStyle: literal
+
+Style/NumericLiterals:
+  MinDigits: 6
+
+Style/BlockDelimiters:
+  EnforcedStyle: semantic
+  AllowedMethods:
+    - expect
+    - let
+    - subject
+
+Style/WordArray:
+  EnforcedStyle: brackets
+
+Style/SymbolArray:
+  EnforcedStyle: brackets
+
+Style/FormatString:
+  EnforcedStyle: percent
+
+Style/CollectionMethods:
+  PreferredMethods:
+    collect: map
+    collect!: map!
+    detect: find
+    find_all: select
+    reduce: inject
+
+Style/Alias:
+  EnforcedStyle: prefer_alias_method
+
+Style/AccessorGrouping:
+  EnforcedStyle: separated
+
+Style/BisectedAttrAccessor:
+  Enabled: true
+
+Style/RedundantAssignment:
+  Enabled: true
+
+Style/RedundantFetchBlock:
+  Enabled: true
+
+Style/RedundantFileExtensionInRequire:
+  Enabled: true
+
+Style/RedundantRegexpCharacterClass:
+  Enabled: true
+
+Style/RedundantRegexpEscape:
+  Enabled: true
+
+Style/SlicingWithRange:
+  Enabled: true
+
+Style/ExponentialNotation:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
+Style/RedundantReturn:
+  AllowMultipleReturnValues: true
+
+# === METRICS ===
+
+Metrics/ModuleLength:
+  Max: 150
+
+Metrics/ClassLength:
+  Enabled: false
+  Max: 150
+  Exclude:
+    - 'test/**/*'
+
+Metrics/MethodLength:
+  Enabled: false
+  Max: 25
+  Exclude:
+    - 'test/**/*'
+    - 'db/**/*'
+    - 'lib/prescient/provider/*.rb'
+
+Metrics/BlockLength:
+  Enabled: false
+  Max: 25
+  Exclude:
+    - 'test/**/*'
+    - 'lib/prescient.rb'  # Configuration block
+
+Metrics/AbcSize:
+  Max: 20
+  Exclude:
+    - 'test/**/*'
+    - 'db/**/*'
+    - 'lib/prescient/provider/*.rb'
+
+Metrics/CyclomaticComplexity:
+  Max: 8
+  Exclude:
+    - 'lib/prescient/provider/*.rb'
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+  Max: 8
+  Exclude:
+    - 'lib/prescient/provider/*.rb'
+
+Metrics/ParameterLists:
+  Max: 5
+  CountKeywordArgs: false
+
+# === LINT ===
+
+Lint/RaiseException:
+  Enabled: true
+
+Lint/StructNewOverride:
+  Enabled: true
+
+Lint/DeprecatedOpenSSLConstant:
+  Enabled: true
+
+Lint/MixedRegexpCaptureTypes:
+  Enabled: true
+
+Lint/DuplicateElsifCondition:
+  Enabled: true
+
+Lint/BinaryOperatorWithIdenticalOperands:
+  Enabled: true
+
+Lint/DuplicateRescueException:
+  Enabled: true
+
+Lint/EmptyConditionalBody:
+  Enabled: true
+
+Lint/FloatComparison:
+  Enabled: true
+
+Lint/MissingSuper:
+  Enabled: true
+
+Lint/OutOfRangeRegexpRef:
+  Enabled: true
+
+Lint/SelfAssignment:
+  Enabled: true
+
+Lint/TopLevelReturnWithArgument:
+  Enabled: true
+
+Lint/UnreachableLoop:
+  Enabled: true
+
+# === NAMING ===
+
+Naming/PredicatePrefix:
+  ForbiddenPrefixes:
+    - is_
+  AllowedMethods:
+    - is_a?
+
+Naming/MemoizedInstanceVariableName:
+  EnforcedStyleForLeadingUnderscores: required
+
+Naming/VariableNumber:
+  EnforcedStyle: snake_case
+
+# === SECURITY ===
+
+Security/Open:
+  Enabled: true
+
+Security/YAMLLoad:
+  Enabled: true
+
+Security/JSONLoad:
+  Enabled: true
+
+# === PERFORMANCE ===
+
+Performance/AncestorsInclude:
+  Enabled: true
+
+Performance/BigDecimalWithNumericArgument:
+  Enabled: true
+
+Performance/RedundantSortBlock:
+  Enabled: true
+
+Performance/RedundantStringChars:
+  Enabled: true
+
+Performance/ReverseFirst:
+  Enabled: true
+
+Performance/SortReverse:
+  Enabled: true
+
+Performance/Squeeze:
+  Enabled: true
+
+Performance/StringInclude:
+  Enabled: true
+
+Performance/Sum:
+  Enabled: true
+
+# === MINITEST ===
+
+Minitest/MultipleAssertions:
+  Max: 10
+
+Minitest/AssertTruthy:
+  Enabled: true
+
+Minitest/AssertWithExpectedArgument:
+  Enabled: true
+
+Minitest/RefuteFalse:
+  Enabled: true
+
+Minitest/RefuteNil:
+  Enabled: true
+
+Minitest/TestMethodName:
+  Enabled: true

data/.yardopts

@@ -0,0 +1,14 @@
+--markup markdown
+--markup-provider kramdown
+--main README.md
+--output-dir doc
+--protected
+--private
+--title "Prescient Documentation"
+lib/**/*.rb
+-
+README.md
+CHANGELOG.md
+LICENSE.txt
+INTEGRATION_GUIDE.md
+VECTOR_SEARCH_GUIDE.md

data/CHANGELOG.md

@@ -0,0 +1,64 @@
+# 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).
+
+## [0.1.0] - 2025-08-05
+
+### Added
+
+- Added new featire: Providers fallbacks mechanism
+
+## [0.1.0] - 2025-08-05
+
+### Added
+
+- Initial release of Prescient gem
+- Support for four AI providers:
+  - **Ollama**: Local AI provider with embedding and text generation
+  - **Anthropic**: Claude models for text generation
+  - **OpenAI**: GPT models and embeddings
+  - **HuggingFace**: Open-source models and embeddings
+- Unified client interface for all providers
+- Comprehensive error handling with provider-specific exceptions:
+  - `ConnectionError` for network issues
+  - `AuthenticationError` for API key problems
+  - `RateLimitError` for rate limiting
+  - `ModelNotAvailableError` for missing models
+  - `InvalidResponseError` for malformed responses
+- Automatic retry logic with configurable attempts and delays
+- Health monitoring capabilities for all providers
+- Environment variable configuration support
+- Programmatic configuration system
+- Context-aware generation support with context items
+- Text preprocessing and embedding normalization
+- Provider availability checking
+- Model listing capabilities (where supported)
+- Comprehensive test suite with RSpec
+- Documentation and usage examples
+
+### Provider-Specific Features
+
+- **Ollama**: Model management (pull, list), local deployment
+- **Anthropic**: Latest Claude 3 models (Haiku, Sonnet, Opus)
+- **OpenAI**: Multiple embedding dimensions, latest GPT models
+- **HuggingFace**: Open-source model support, research-friendly API
+
+### Development
+
+- RSpec test suite with WebMock and VCR
+- RuboCop code style enforcement
+- SimpleCov test coverage reporting
+- Comprehensive documentation
+- Example usage scripts
+- Rake tasks for testing and linting
+
+## [0.0.0] - 2025-08-05
+
+### Added
+
+- Project initialization
+- Basic gem structure
+- Core interfaces defined

data/Dockerfile.example

@@ -0,0 +1,41 @@
+# Example Dockerfile for running Prescient gem applications
+FROM ruby:3.4-alpine
+
+# Install system dependencies
+RUN apk add --no-cache \
+    build-base \
+    curl \
+    git \
+    postgresql-dev \
+    tzdata
+
+# Set working directory
+WORKDIR /app
+
+# Create non-root user
+RUN addgroup -g 1000 -S appuser && \
+    adduser -u 1000 -S appuser -G appuser
+
+# Copy Gemfile and Gemfile.lock
+COPY Gemfile* ./
+COPY prescient.gemspec ./
+COPY lib/prescient/version.rb ./lib/prescient/
+
+# Install gems
+RUN bundle config --global frozen 1 && \
+    bundle install --jobs 4 --retry 3
+
+# Copy application code
+COPY . .
+
+# Change ownership to appuser
+RUN chown -R appuser:appuser /app
+
+# Switch to non-root user
+USER appuser
+
+# Expose port (if running a web service)
+EXPOSE 3000
+
+# Default command
+CMD ["bundle", "exec", "ruby", "examples/custom_contexts.rb"]