pg_objects 1.4.7 → 1.5.0

data/lib/pg_objects/yaml_configurable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # A module that provides a method to load configuration settings from a YAML file.
 module YamlConfigurable
   # Loads configuration settings from a YAML file.
@@ -6,17 +8,33 @@ module YamlConfigurable
   def load_from_yaml(file_path)
     return unless File.exist?(file_path)
 
-    config_hash = YAML.load_file(file_path)
-
-    set_if_present(config, :before_path, config_hash.dig('directories', 'before'))
-    set_if_present(config, :after_path, config_hash.dig('directories', 'after'))
-    set_if_present(config, :extensions, config_hash['extensions'])
-    set_if_present(config, :silent, config_hash['silent'])
+    settings_from(YAML.load_file(file_path)).each do |key, value|
+      set_if_present(config, key, value)
+    end
+  rescue Psych::SyntaxError => e
+    warn "[pg_objects] Ignoring malformed YAML config #{file_path}: #{e.message}"
   end
 
   private
 
+  # Maps configuration keys to their values in the parsed YAML hash.
+  def settings_from(config_hash)
+    {
+      before_path: config_hash.dig('directories', 'before'),
+      after_path: config_hash.dig('directories', 'after'),
+      extensions: config_hash['extensions'],
+      silent: config_hash['silent'],
+      transactional: config_hash['transactional'],
+      auto_hook_migrations: config_hash['auto_hook_migrations']
+    }
+  end
+
+  # Applies the value unless it is nil or an empty string/array. Booleans
+  # (including +false+) have no +empty?+ and are always applied.
   def set_if_present(config, key, value)
-    config.public_send("#{key}=", value) if value.present?
+    return if value.nil?
+    return if value.respond_to?(:empty?) && value.empty?
+
+    config.public_send("#{key}=", value)
   end
 end

data/lib/pg_objects.rb

@@ -1,10 +1,61 @@
+# frozen_string_literal: true
+
 require_relative 'pg_objects/version'
 
 module PgObjects
-  class AmbiguousDependencyError < StandardError; end
-  class CyclicDependencyError < StandardError; end
-  class DependencyNotExistError < StandardError; end
+  # Raised when a dependency name resolves to more than one object. Carries
+  # the matching objects' file paths via +candidates+ and the file that
+  # declared the dependency via +referrer+; the message lists them all. Also
+  # accepts a bare name for compatibility.
+  class AmbiguousDependencyError < StandardError
+    attr_reader :candidates, :referrer
+
+    def initialize(dep_name = nil, candidates: [], referrer: nil)
+      @candidates = candidates
+      @referrer = referrer
+      message = build_message(dep_name)
+      message.empty? ? super() : super(message)
+    end
+
+    private
+
+    def build_message(dep_name)
+      message = dep_name.to_s
+      message += " (referenced by #{referrer})" if referrer
+      message += " matches: #{candidates.join(', ')}" unless candidates.empty?
+      message
+    end
+  end
+
+  # Raised when object dependencies form a cycle. Carries the resolution chain
+  # that closed the cycle (e.g. ["a", "b", "a"]) via +cycle_path+; the message
+  # renders it as "a -> b -> a". Also accepts a single name for compatibility.
+  class CyclicDependencyError < StandardError
+    attr_reader :cycle_path
+
+    def initialize(cycle_path = nil)
+      @cycle_path = Array(cycle_path)
+      @cycle_path.empty? ? super() : super(@cycle_path.join(' -> '))
+    end
+  end
+
+  # Raised when a declared dependency matches no loaded object. Carries the
+  # file that declared the dependency via +referrer+ and includes it in the
+  # message. Also accepts a bare name for compatibility.
+  class DependencyNotExistError < StandardError
+    attr_reader :referrer
+
+    def initialize(dep_name = nil, referrer: nil)
+      @referrer = referrer
+      message = dep_name.to_s
+      message += " (referenced by #{referrer})" unless referrer.to_s.empty?
+      message.empty? ? super() : super(message)
+    end
+  end
+
   class UnsupportedAdapterError < StandardError; end
+  class UnknownObjectTypeError < StandardError; end
+  class MalformedStatementError < StandardError; end
 end
 
 require 'pg_objects/railtie' if defined?(Rails)
@@ -12,7 +63,6 @@ require 'pg_objects/railtie' if defined?(Rails)
 require 'dry-configurable'
 require 'dry-container'
 require 'dry-auto_inject'
-require 'dry/monads'
 require 'memery'
 
 require 'pg_objects/container'

data/lib/tasks/pg_objects_tasks.rake

@@ -1,23 +1,48 @@
+# frozen_string_literal: true
+
+# Resolves the connection to run against. Set PG_OBJECTS_CONNECTION_CLASS to
+# the name of an Active Record class (e.g. "AnimalsRecord") to target that
+# class's database in a multi-DB setup; unset, the global connection is used.
+pg_objects_connection = lambda do
+  class_name = ENV.fetch('PG_OBJECTS_CONNECTION_CLASS', nil)
+  next nil if class_name.nil? || class_name.strip.empty?
+
+  begin
+    Object.const_get(class_name).connection
+  rescue NameError
+    raise ArgumentError, "PG_OBJECTS_CONNECTION_CLASS is set to unknown class #{class_name.inspect}"
+  end
+end
+
 namespace :db do
   namespace :create_objects do
     desc 'Create all the database objects from "before" folder'
     task before: :environment do
-      PgObjects::Manager.new.load_files(:before).create_objects
+      PgObjects::Manager.new(connection: pg_objects_connection.call).load_files(:before).create_objects
     end
 
     desc 'Create all the database objects from "after" folder'
     task after: :environment do
-      PgObjects::Manager.new.load_files(:after).create_objects
+      PgObjects::Manager.new(connection: pg_objects_connection.call).load_files(:after).create_objects
     end
   end
 end
 
 require 'rake/hooks'
 
-before 'db:migrate' do
-  Rake::Task['db:create_objects:before'].invoke
-end
-
-after 'db:migrate' do
-  Rake::Task['db:create_objects:after'].invoke
+# Attach object-creation hooks to the tasks configured in
+# PgObjects::Config.config.hook_tasks (override in an initializer to opt out).
+# Each stage (:before/:after) maps to both the rake-hooks DSL method and the
+# matching db:create_objects:<stage> task. Set config.auto_hook_migrations to
+# false to install no hooks at all.
+if PgObjects::Config.config.auto_hook_migrations
+  PgObjects::Config.config.hook_tasks.each do |task_name, stages|
+    stages.each do |stage|
+      send(stage, task_name) do
+        task = Rake::Task["db:create_objects:#{stage}"]
+        task.reenable # allow the hook to run again within composed/repeated task runs
+        task.invoke
+      end
+    end
+  end
 end

data/pg_objects.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
@@ -12,11 +14,12 @@ Gem::Specification.new do |spec|
   spec.summary       = %q(Simple manager for PostgreSQL objects like triggers and functions)
   spec.homepage      = 'https://github.com/marinazzio/pg_objects'
 
-  spec.required_ruby_version = '>= 3.2.0'
+  spec.required_ruby_version = '>= 3.3.0'
 
   spec.metadata = {
     'allowed_push_host' => 'https://rubygems.org',
     'bug_tracker_uri' => 'https://github.com/marinazzio/pg_objects/issues',
+    'changelog_uri' => 'https://github.com/marinazzio/pg_objects/blob/master/CHANGELOG.md',
     'documentation_uri' => 'https://github.com/marinazzio/pg_objects/blob/master/README.md',
     'homepage_uri' => 'https://github.com/marinazzio/pg_objects',
     'rubygems_mfa_required' => 'true',
@@ -46,8 +49,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'activerecord', '>= 6.1.7.0', '< 9'
   spec.add_dependency 'dry-auto_inject', '~> 1'
   spec.add_dependency 'dry-configurable', '~> 1'
-  spec.add_dependency 'dry-container', '0.11.0'
-  spec.add_dependency 'dry-monads', '~> 1.6'
+  spec.add_dependency 'dry-container', '~> 0.11'
   spec.add_dependency 'memery', '>= 1.5', '< 1.9'
   spec.add_dependency 'pg_query', '>= 5', '< 7'
   spec.add_dependency 'railties', '>= 4', '< 9'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pg_objects
 version: !ruby/object:Gem::Version
-  version: 1.4.7
+  version: 1.5.0
 platform: ruby
 authors:
 - Denis Kiselyov
@@ -59,32 +59,18 @@ dependencies:
         version: '1'
 - !ruby/object:Gem::Dependency
   name: dry-container
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.11.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.11.0
-- !ruby/object:Gem::Dependency
-  name: dry-monads
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '0.11'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '0.11'
 - !ruby/object:Gem::Dependency
   name: memery
   requirement: !ruby/object:Gem::Requirement
@@ -165,7 +151,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/copilot-instructions.md"
+- ".evilution.yml"
 - ".github/dependabot.yml"
 - ".github/workflows/bundle_audit.yml"
 - ".github/workflows/ci.yml"
@@ -174,6 +160,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -195,12 +182,21 @@ files:
 - lib/pg_objects/parsed_object.rb
 - lib/pg_objects/parsed_object/aggregate.rb
 - lib/pg_objects/parsed_object/base.rb
+- lib/pg_objects/parsed_object/base_type.rb
 - lib/pg_objects/parsed_object/conversion.rb
+- lib/pg_objects/parsed_object/domain.rb
+- lib/pg_objects/parsed_object/enum_type.rb
 - lib/pg_objects/parsed_object/event_trigger.rb
+- lib/pg_objects/parsed_object/extension.rb
 - lib/pg_objects/parsed_object/function.rb
+- lib/pg_objects/parsed_object/index.rb
 - lib/pg_objects/parsed_object/materialized_view.rb
 - lib/pg_objects/parsed_object/operator.rb
 - lib/pg_objects/parsed_object/operator_class.rb
+- lib/pg_objects/parsed_object/policy.rb
+- lib/pg_objects/parsed_object/range_type.rb
+- lib/pg_objects/parsed_object/rule.rb
+- lib/pg_objects/parsed_object/sequence.rb
 - lib/pg_objects/parsed_object/table.rb
 - lib/pg_objects/parsed_object/text_search_parser.rb
 - lib/pg_objects/parsed_object/text_search_template.rb
@@ -220,6 +216,7 @@ licenses:
 metadata:
   allowed_push_host: https://rubygems.org
   bug_tracker_uri: https://github.com/marinazzio/pg_objects/issues
+  changelog_uri: https://github.com/marinazzio/pg_objects/blob/master/CHANGELOG.md
   documentation_uri: https://github.com/marinazzio/pg_objects/blob/master/README.md
   homepage_uri: https://github.com/marinazzio/pg_objects
   rubygems_mfa_required: 'true'
@@ -236,14 +233,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.2.0
+      version: 3.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.3
+rubygems_version: 4.0.16
 specification_version: 4
 summary: Simple manager for PostgreSQL objects like triggers and functions
 test_files: []

data/.github/copilot-instructions.md

@@ -1,131 +0,0 @@
-# PG Objects
-PG Objects is a Ruby gem for managing PostgreSQL database objects like triggers and functions. It provides a simple manager that handles dependencies between database objects and integrates with Rails applications.
-
-Always reference these instructions first and fallback to search or bash commands only when you encounter unexpected information that does not match the info here.
-
-## Working Effectively
-- Bootstrap, build, and test the repository:
-  - `gem install --user-install bundler`
-  - `export PATH="$HOME/.local/share/gem/ruby/3.2.0/bin:$PATH"`
-  - `bundle config set --local path 'vendor/bundle'`
-  - `bundle install` -- takes 45-60 seconds. NEVER CANCEL. Set timeout to 120+ seconds.
-- `bundle exec rspec spec` -- takes 4 seconds. NEVER CANCEL. Set timeout to 60+ seconds.
-- `bundle exec rubocop` -- takes 3 seconds. NEVER CANCEL. Set timeout to 60+ seconds.
-- `bundle exec bundle-audit check` -- takes 2 seconds (first run downloads advisory database). NEVER CANCEL. Set timeout to 180+ seconds for first run.
-- Performance benchmarking:
-  - `bundle exec rake benchmark` -- takes 1 second. NEVER CANCEL. Set timeout to 30+ seconds.
-- Interactive console:
-  - `./bin/console` -- launches IRB with pg_objects loaded
-- Install gem locally:
-  - `bundle exec rake install` -- takes 9 seconds. NEVER CANCEL. Set timeout to 120+ seconds.
-
-## Validation
-- Always run through the complete test suite after making changes: `bundle exec rspec spec`
-- ALWAYS run linting before completing work: `bundle exec rubocop`
-- Always run bundle audit to check for security vulnerabilities: `bundle exec bundle-audit check`
-- Test parsing functionality with sample SQL files to ensure changes work correctly
-- NEVER CANCEL builds or tests - they complete quickly (under 60 seconds)
-
-## Common Tasks
-The following are outputs from frequently run commands. Reference them instead of viewing, searching, or running bash commands to save time.
-
-### Repository Root Structure
-```
-.
-├── .github/           # CI/CD workflows (ci.yml, bundle_audit.yml, publish.yml)
-├── .rspec             # RSpec configuration
-├── .rubocop.yml       # RuboCop linting configuration
-├── bin/
-│   ├── setup          # Setup script (runs bundle install)
-│   ├── console        # Interactive console
-│   └── benchmark      # Performance benchmark tool
-├── lib/
-│   ├── pg_objects.rb  # Main entry point
-│   ├── pg_objects/    # Core library files
-│   │   ├── config.rb
-│   │   ├── manager.rb
-│   │   ├── parser.rb
-│   │   └── parsed_object/ # SQL object parsers
-│   └── generators/pg_objects/install/ # Rails generator
-├── spec/              # RSpec test files
-├── Gemfile            # Gem dependencies
-├── pg_objects.gemspec # Gem specification
-├── Rakefile           # Rake tasks (spec, benchmark)
-└── README.md          # Documentation
-```
-
-### Key Files and Directories
-- **lib/pg_objects.rb**: Main entry point that requires all components
-- **lib/pg_objects/manager.rb**: Core manager for database objects
-- **lib/pg_objects/parser.rb**: SQL parsing and dependency extraction
-- **lib/pg_objects/parsed_object/**: Specific parsers for different SQL object types
-- **spec/**: Complete test suite with fixtures
-- **bin/benchmark**: Performance benchmarking tool with detailed metrics
-- **Gemfile**: Development and test dependencies (RSpec, RuboCop, etc.)
-
-### Gemfile Dependencies
-- **Runtime**: activerecord, dry-auto_inject, dry-configurable, pg_query, railties
-- **Development/Test**: rspec, rubocop, bundler-audit, faker, pry-byebug
-
-### Common Command Outputs
-#### `bundle exec rspec spec` (Expected: ~4 seconds, 54 examples, 0 failures)
-```
-54 examples, 0 failures
-Finished in 2.24 seconds
-```
-
-#### `bundle exec rubocop` (Expected: ~3 seconds, 60 files, no offenses)
-```
-60 files inspected, no offenses detected
-```
-
-#### `bundle exec bundle-audit check` (Expected: ~2 seconds after initial setup)
-```
-No vulnerabilities found
-```
-
-#### `bundle exec rake benchmark` (Expected: ~1 second)
-```
-PG Objects Performance Benchmark
-==================================================
-File I/O Performance: ~100,000+ files/s
-Parsing Performance: ~7,000 files/s 
-Full Workflow Performance: ~6,000 objects/s
-Benchmark completed successfully!
-```
-
-## Development Workflow
-1. Always run `bundle install` after cloning or changing dependencies
-2. Make changes to code in lib/ directory
-3. Add or update tests in spec/ directory for any changes
-4. Run `bundle exec rspec spec` to ensure all tests pass
-5. Run `bundle exec rubocop` to ensure code style compliance
-6. Use `bundle exec rake benchmark` to test performance impact
-7. Run `bundle exec bundle-audit check` for security validation
-
-## Troubleshooting
-- If bundler is not found: `gem install --user-install bundler && export PATH="$HOME/.local/share/gem/ruby/3.2.0/bin:$PATH"`
-- If bundle install fails with permission errors: `bundle config set --local path 'vendor/bundle'`
-- Ruby version required: >= 3.2.0 (tested with 3.2, 3.3, 3.4)
-- The gem requires PostgreSQL and uses pg_query for SQL parsing
-- Dependencies include ActiveRecord, dry gems, and memery for caching
-
-## Testing SQL Parsing
-Create test SQL files with dependencies:
-```sql
---!depends_on other_function
-CREATE OR REPLACE FUNCTION my_function(param INTEGER)
-RETURNS INTEGER AS $$
-BEGIN
-  RETURN param * 2;
-END;
-$$ LANGUAGE plpgsql;
-```
-
-Test parsing with:
-```ruby
-parser = PgObjects::Parser.new
-content = File.read('path/to/file.sql')
-object_name = parser.load(content).fetch_object_name
-dependencies = parser.fetch_directives[:depends_on]
-```