pg_aggregates 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d75685b8a6abb03dda216865bad3cbffc419d6d472b06695b98a5c92a5e05df0
+  data.tar.gz: 8445256690fb9a3bba119b749e1bb8d356f5024472527413402a05312a9c935e
+SHA512:
+  metadata.gz: 67babad257045327620a6b6d99c3bba1abc0821c9490ee00fb744aae15b843c63b27294f71be65c3b00efb52e231ecf63e4ca88db8c18d3125e5eaf1d70c243c
+  data.tar.gz: cf6465126ee2fbeeea0e5504463b4d0520ac9690917948b2bead65a10accffbc292a4e44fa3369535bb2f01bbd51023085c6115f4ba8e50c9b390aaa6ad9e231

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-11-04
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 mhenrixon
+
+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,122 @@
+# PgAggregates
+
+PgAggregates provides Rails integration for managing PostgreSQL aggregate functions. It allows you to version your aggregate functions and handle them through migrations, similar to how you manage database schema changes.
+
+## Features
+
+- Versioned aggregate functions
+- Rails generator for creating new aggregates
+- Migration support for adding/removing aggregates
+- Proper schema.rb dumping
+- Support for multiple PostgreSQL versions
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pg_aggregates'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+## Usage
+
+### Creating a New Aggregate
+
+Generate a new aggregate function:
+
+```bash
+$ rails generate pg:aggregate sum_squares
+```
+
+This will create:
+- A SQL file in `db/aggregates/sum_squares_v1.sql`
+- A migration file to create the aggregate
+
+You can specify a version:
+
+```bash
+$ rails generate pg:aggregate array_sum --version 2
+```
+
+### SQL Definition
+
+Edit the generated SQL file (`db/aggregates/sum_squares_v1.sql`):
+
+```sql
+CREATE AGGREGATE sum_squares(numeric) (
+  sfunc = numeric_add,
+  stype = numeric,
+  initcond = '0'
+);
+```
+
+### Migrations
+
+The generated migration will look like:
+
+```ruby
+class CreateAggregateSumSquares < ActiveRecord::Migration[7.0]
+  def change
+    create_aggregate "sum_squares", version: 1
+  end
+end
+```
+
+You can also create aggregates inline:
+
+```ruby
+class CreateAggregateArraySum < ActiveRecord::Migration[7.0]
+  def change
+    create_aggregate "array_sum", sql_definition: <<-SQL
+      CREATE AGGREGATE array_sum(numeric[]) (
+        sfunc = array_append,
+        stype = numeric[],
+        initcond = '{}'
+      );
+    SQL
+  end
+end
+```
+
+### Managing Versions
+
+When you need to update an aggregate, create a new version:
+
+1. Generate a new version:
+```bash
+$ rails generate pg:aggregate sum_squares --version 2
+```
+
+2. Update the SQL in `db/aggregates/sum_squares_v2.sql`
+
+3. Create a migration to update to the new version:
+```ruby
+class UpdateAggregateSumSquares < ActiveRecord::Migration[7.0]
+  def change
+    drop_aggregate "sum_squares", "numeric"
+    create_aggregate "sum_squares", version: 2
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/mhenrixon/pg_aggregates. 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/mhenrixon/pg_aggregates/blob/main/CODE_OF_CONDUCT.md).
+
+## 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 PgAggregates project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/mhenrixon/pg_aggregates/blob/main/CODE_OF_CONDUCT.md).

data/lib/generators/pg/aggregate/aggregate_generator.rb

@@ -0,0 +1,48 @@
+require "rails/generators"
+require "rails/generators/active_record"
+
+module Pg
+  module Generators
+    class AggregateGenerator < Rails::Generators::NamedBase
+      include Rails::Generators::Migration
+      
+      source_root File.expand_path("templates", __dir__)
+      
+      class_option :version,
+                 type: :string,
+                 default: "1",
+                 desc: "Specify a version for the aggregate"
+
+      def create_aggregate_file
+        @version = options[:version]
+        @aggregate_name = file_name
+        
+        template(
+          "aggregate.sql.erb",
+          "db/aggregates/#{file_name}_v#{@version}.sql"
+        )
+      end
+      
+      def create_migration_file
+        @version = options[:version]
+        @aggregate_name = file_name
+        @migration_version = migration_version
+        
+        migration_template(
+          "migration.rb.erb",
+          "db/migrate/create_aggregate_#{file_name}.rb"
+        )
+      end
+
+      private
+
+      def self.next_migration_number(dirname)
+        ActiveRecord::Generators::Base.next_migration_number(dirname)
+      end
+
+      def migration_version
+        "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]"
+      end
+    end
+  end
+end

data/lib/generators/pg/aggregate/templates/aggregate.sql.erb

@@ -0,0 +1,13 @@
+CREATE AGGREGATE <%= @aggregate_name %>(
+  -- Specify your input type(s)
+  anyelement
+) (
+  -- State function - called for each input value
+  sfunc = array_append,
+  
+  -- State data type
+  stype = anyarray,
+  
+  -- Initial state value
+  initcond = '{}'
+);

data/lib/generators/pg/aggregate/templates/migration.rb.erb

@@ -0,0 +1,5 @@
+class CreateAggregate<%= @aggregate_name.camelize %> < ActiveRecord::Migration<%= @migration_version %>
+  def change
+    create_aggregate "<%= @aggregate_name %>", version: <%= @version %>
+  end
+end

data/lib/pg_aggregates/aggregate_definition.rb

@@ -0,0 +1,22 @@
+module PgAggregates
+  class AggregateDefinition
+    attr_reader :name, :version
+
+    def initialize(name, version:)
+      @name = name
+      @version = version
+    end
+
+    def to_sql
+      File.read(path)
+    end
+
+    def path
+      Rails.root.join("db", "aggregates", "#{name}_v#{version}.sql").to_s
+    end
+
+    def full_name
+      name.to_s.include?(".") ? name.to_s : "public.#{name}"
+    end
+  end
+end

data/lib/pg_aggregates/command_recorder.rb

@@ -0,0 +1,19 @@
+module PgAggregates
+  module CommandRecorder
+    def create_aggregate(*args, &block)
+      record(:create_aggregate, args, &block)
+    end
+
+    def drop_aggregate(*args)
+      record(:drop_aggregate, args)
+    end
+
+    def invert_create_aggregate(args)
+      [:drop_aggregate, args]
+    end
+
+    def invert_drop_aggregate(args)
+      [:create_aggregate, args]
+    end
+  end
+end

data/lib/pg_aggregates/file_version.rb

@@ -0,0 +1,25 @@
+module PgAggregates
+  class FileVersion
+    attr_reader :path, :name, :version
+
+    def initialize(path)
+      @path = Pathname.new(path)
+      @name = @path.basename.to_s.sub(/_v\d+\.sql$/, "")
+      @version = extract_version
+    end
+
+    def sql_definition
+      File.read(path).strip
+    end
+
+    private
+
+    def extract_version
+      if (match = @path.basename.to_s.match(/_v(\d+)\.sql$/))
+        match[1].to_i
+      else
+        0
+      end
+    end
+  end
+end

data/lib/pg_aggregates/railtie.rb

@@ -0,0 +1,11 @@
+module PgAggregates
+  class Railtie < Rails::Railtie
+    initializer "postgres_aggregates.load" do
+      ActiveSupport.on_load(:active_record) do
+        ActiveRecord::ConnectionAdapters::AbstractAdapter.include PgAggregates::SchemaStatements
+        ActiveRecord::Migration::CommandRecorder.include PgAggregates::CommandRecorder
+        ActiveRecord::SchemaDumper.prepend PgAggregates::SchemaDumper
+      end
+    end
+  end
+end

data/lib/pg_aggregates/schema_dumper.rb

@@ -0,0 +1,45 @@
+module PgAggregates
+  module SchemaDumper
+    def tables(stream)
+      # First dump aggregates
+      dump_custom_aggregates(stream)
+      stream.puts
+
+      super
+    end
+
+    private
+
+    def dump_custom_aggregates(stream)
+      # Group all versions of each aggregate
+      aggregate_versions = {}
+      
+      Dir.glob(Rails.root.join("db/aggregates/*_v*.sql").to_s).each do |file|
+        file_version = FileVersion.new(file)
+        aggregate_versions[file_version.name] ||= []
+        aggregate_versions[file_version.name] << file_version
+      end
+
+      # For each aggregate, use the latest version
+      latest_versions = aggregate_versions.transform_values do |versions|
+        versions.max_by(&:version)
+      end
+
+      # Sort by name to ensure consistent ordering
+      latest_versions.keys.sort.each do |aggregate_name|
+        file_version = latest_versions[aggregate_name]
+        
+        # Add a comment showing the version history
+        all_versions = aggregate_versions[aggregate_name].map(&:version).sort
+        version_comment = all_versions.size > 1 ? " -- versions: #{all_versions.join(', ')}" : ""
+        
+        stream.puts <<-AGG
+  create_aggregate "#{aggregate_name}", sql_definition: <<-SQL#{version_comment}
+    #{file_version.sql_definition}
+  SQL
+
+        AGG
+      end
+    end
+  end
+end

data/lib/pg_aggregates/schema_statements.rb

@@ -0,0 +1,27 @@
+module PgAggregates
+  module SchemaStatements
+    def create_aggregate(name, version: nil, sql_definition: nil)
+      raise ArgumentError, "Must provide either sql_definition or version" if sql_definition.nil? && version.nil?
+
+      if sql_definition
+        execute sql_definition
+      else
+        # Fallback to file-based definition if needed
+        aggregate_definition = PgAggregates::AggregateDefinition.new(name, version: version)
+        
+        # Check if file exists before trying to read it
+        unless File.exist?(aggregate_definition.path)
+          raise ArgumentError, "Could not find aggregate definition file: #{aggregate_definition.path}"
+        end
+        
+        execute aggregate_definition.to_sql
+      end
+    end
+
+    def drop_aggregate(name, *arg_types, force: false)
+      arg_types_sql = arg_types.any? ? "(#{arg_types.join(', ')})" : ""
+      force_clause = force ? " CASCADE" : ""
+      execute "DROP AGGREGATE IF EXISTS #{name}#{arg_types_sql}#{force_clause}"
+    end
+  end
+end

data/lib/pg_aggregates/version.rb

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

data/lib/pg_aggregates.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "active_record/railtie"
+
+require_relative "pg_aggregates/file_version"
+require_relative "pg_aggregates/aggregate_definition"
+require_relative "pg_aggregates/schema_statements"
+require_relative "pg_aggregates/command_recorder"
+require_relative "pg_aggregates/schema_dumper"
+require_relative "pg_aggregates/railtie"
+
+module PgAggregates
+  class Error < StandardError; end
+  
+  class << self
+    def database
+      ActiveRecord::Base.connection
+    end
+  end
+end

data/sig/pg_aggregates.rbs

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

metadata

@@ -0,0 +1,176 @@
+--- !ruby/object:Gem::Specification
+name: pg_aggregates
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- mhenrixon
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-11-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: ammeter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner-active_record
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Manage PostgreSQL aggregate functions in your Rails application with
+  versioned migrations and schema handling. This cuts the need for keeping a structure.sql
+email:
+- mikael@mhenrixon.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- lib/generators/pg/aggregate/aggregate_generator.rb
+- lib/generators/pg/aggregate/templates/aggregate.sql.erb
+- lib/generators/pg/aggregate/templates/migration.rb.erb
+- lib/pg_aggregates.rb
+- lib/pg_aggregates/aggregate_definition.rb
+- lib/pg_aggregates/command_recorder.rb
+- lib/pg_aggregates/file_version.rb
+- lib/pg_aggregates/railtie.rb
+- lib/pg_aggregates/schema_dumper.rb
+- lib/pg_aggregates/schema_statements.rb
+- lib/pg_aggregates/version.rb
+- sig/pg_aggregates.rbs
+homepage: https://github.com/mhenrixon/pg_aggregates
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/mhenrixon/pg_aggregates
+  source_code_uri: https://github.com/mhenrixon/pg_aggregates
+  changelog_uri: https://github.com/mhenrixon/pg_aggregates/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: Rails integration for PostgreSQL aggregate functions
+test_files: []