fx 0.1.0

data/lib/fx/statements.rb

@@ -0,0 +1,16 @@
+require "rails"
+require "fx/statements/function"
+require "fx/statements/trigger"
+
+module Fx
+  # @api private
+  module Statements
+    include Function
+    include Trigger
+  end
+end
+
+ActiveRecord::ConnectionAdapters::AbstractAdapter.send(
+  :include,
+  Fx::Statements,
+)

data/lib/fx/statements/function.rb

@@ -0,0 +1,105 @@
+require "rails"
+
+module Fx
+  module Statements
+    # Methods that are made available in migrations for managing Fx functions.
+    module Function
+      # Create a new database function.
+      #
+      # @param name [String, Symbol] The name of the database function.
+      # @param version [Fixnum] The version number of the function, used to
+      #   find the definition file in `db/functions`. This defaults to `1` if
+      #   not provided.
+      # @param sql_definition [String] The SQL query for the function schema.
+      #   If both `sql_defintion` and `version` are provided,
+      #   `sql_definition` takes prescedence.
+      # @return The database response from executing the create statement.
+      #
+      # @example Create from `db/functions/uppercase_users_name_v02.sql`
+      #   create_function(:uppercase_users_name, version: 2)
+      #
+      # @example Create from provided SQL string
+      #   create_function(:uppercase_users_name, sql_definition: <<-SQL)
+      #     CREATE OR REPLACE FUNCTION uppercase_users_name()
+      #     RETURNS trigger AS $$
+      #     BEGIN
+      #       NEW.upper_name = UPPER(NEW.name);
+      #       RETURN NEW;
+      #     END;
+      #     $$ LANGUAGE plpgsql;
+      #   SQL
+      #
+      def create_function(name, version: 1, sql_definition: nil)
+        if version.nil? && sql_definition.nil?
+          raise(
+            ArgumentError,
+            "version or sql_definition must be specified",
+          )
+        end
+        sql_definition ||= Fx::Definition.new(name: name, version: version).to_sql
+
+        Fx.database.create_function(sql_definition)
+      end
+
+      # Drop a database function by name.
+      #
+      # @param name [String, Symbol] The name of the database function.
+      # @param revert_to_version [Fixnum] Used to reverse the `drop_function`
+      #   command on `rake db:rollback`. The provided version will be passed as
+      #   the `version` argument to {#create_function}.
+      # @return The database response from executing the drop statement.
+      #
+      # @example Drop a function, rolling back to version 3 on rollback
+      #   drop_function(:uppercase_users_name, on: :users, revert_to_version: 3)
+      #
+      def drop_function(name, revert_to_version: nil)
+        Fx.database.drop_function(name)
+      end
+
+      # Update a database function.
+      #
+      # @param name [String, Symbol] The name of the database function.
+      # @param version [Fixnum] The version number of the function, used to
+      #   find the definition file in `db/functions`. This defaults to `1` if
+      #   not provided.
+      # @param sql_definition [String] The SQL query for the function schema.
+      #   If both `sql_defintion` and `version` are provided,
+      #   `sql_definition` takes prescedence.
+      # @return The database response from executing the create statement.
+      #
+      # @example Update function to a given version
+      #   update_function(
+      #     :uppercase_users_name,
+      #     version: 3,
+      #     revert_to_version: 2,
+      #   )
+      #
+      # @example Update function from provided SQL string
+      #   update_function(:uppercase_users_name, sql_definition: <<-SQL)
+      #     CREATE OR REPLACE FUNCTION uppercase_users_name()
+      #     RETURNS trigger AS $$
+      #     BEGIN
+      #       NEW.upper_name = UPPER(NEW.name);
+      #       RETURN NEW;
+      #     END;
+      #     $$ LANGUAGE plpgsql;
+      #   SQL
+      #
+      def update_function(name, version: nil, sql_definition: nil, revert_to_version: nil)
+        if version.nil? && sql_definition.nil?
+          raise(
+            ArgumentError,
+            "version or sql_definition must be specified",
+          )
+        end
+
+        sql_definition ||= Fx::Definition.new(
+          name: name,
+          version: version,
+        ).to_sql
+
+        Fx.database.update_function(name, sql_definition)
+      end
+    end
+  end
+end

data/lib/fx/statements/trigger.rb

@@ -0,0 +1,133 @@
+module Fx
+  module Statements
+    # Methods that are made available in migrations for managing Fx triggers.
+    module Trigger
+      # @api private
+      DEFINTION_TYPE = "trigger".freeze
+
+      # Create a new database trigger.
+      #
+      # @param name [String, Symbol] The name of the database trigger.
+      # @param version [Fixnum] The version number of the trigger, used to
+      #   find the definition file in `db/triggers`. This defaults to `1` if
+      #   not provided.
+      # @param sql_definition [String] The SQL query for the function. An error
+      #   will be raised if `sql_definition` and `version` are both set,
+      #   as they are mutually exclusive.
+      # @return The database response from executing the create statement.
+      #
+      # @example Create trigger from `db/triggers/uppercase_users_name_v01.sql`
+      #   create_trigger(:uppercase_users_name, version: 1)
+      #
+      # @example Create trigger from provided SQL string
+      #   create_trigger(:uppercase_users_name, sql_definition: <<-SQL)
+      #     CREATE TRIGGER uppercase_users_name
+      #         BEFORE INSERT ON users
+      #         FOR EACH ROW
+      #         EXECUTE PROCEDURE uppercase_users_name();
+      #    SQL
+      #
+      def create_trigger(name, version: nil, on: nil, sql_definition: nil)
+        if version.present? && sql_definition.present?
+          raise(
+            ArgumentError,
+            "sql_definition and version cannot both be set",
+          )
+        end
+
+        if version.nil?
+          version = 1
+        end
+
+        sql_definition ||= Fx::Definition.new(
+          name: name,
+          version: version,
+          type: DEFINTION_TYPE,
+        ).to_sql
+
+        Fx.database.create_trigger(sql_definition)
+      end
+
+      # Drop a database trigger by name.
+      #
+      # @param name [String, Symbol] The name of the database trigger.
+      # @param on [String, Symbol] The name of the table the database trigger
+      #   is associated with.
+      # @param revert_to_version [Fixnum] Used to reverse the `drop_trigger`
+      #   command on `rake db:rollback`. The provided version will be passed as
+      #   the `version` argument to {#create_trigger}.
+      # @return The database response from executing the drop statement.
+      #
+      # @example Drop a trigger, rolling back to version 3 on rollback
+      #   drop_trigger(:log_inserts, on: :users, revert_to_version: 3)
+      #
+      def drop_trigger(name, on:, revert_to_version: nil)
+        Fx.database.drop_trigger(name, on: on)
+      end
+
+      # Update a database trigger to a new version.
+      #
+      # The existing trigger is dropped and recreated using the supplied `on`
+      # and `version` parameter.
+      #
+      # @param name [String, Symbol] The name of the database trigger.
+      # @param version [Fixnum] The version number of the trigger.
+      # @param on [String, Symbol] The name of the table the database trigger
+      #   is associated with.
+      # @param sql_definition [String] The SQL query for the function. An error
+      #   will be raised if `sql_definition` and `version` are both set,
+      #   as they are mutually exclusive.
+      # @param revert_to_version [Fixnum] The version number to rollback to on
+      #   `rake db rollback`
+      # @return The database response from executing the create statement.
+      #
+      # @example Update trigger to a given version
+      #   update_trigger(
+      #     :log_inserts,
+      #     on: :users,
+      #     version: 3,
+      #     revert_to_version: 2,
+      #   )
+      #
+      # @example Update trigger from provided SQL string
+      #   update_trigger(:uppercase_users_name, sql_definition: <<-SQL)
+      #     CREATE TRIGGER uppercase_users_name
+      #         BEFORE INSERT ON users
+      #         FOR EACH ROW
+      #         EXECUTE PROCEDURE uppercase_users_name();
+      #    SQL
+      #
+      def update_trigger(name, version: nil, on: nil, sql_definition: nil, revert_to_version: nil)
+        if version.nil? && sql_definition.nil?
+          raise(
+            ArgumentError,
+            "version or sql_definition must be specified",
+          )
+        end
+
+        if version.present? && sql_definition.present?
+          raise(
+            ArgumentError,
+            "sql_definition and version cannot both be set",
+          )
+        end
+
+        if on.nil?
+          raise ArgumentError, "on is required"
+        end
+
+        sql_definition ||= Fx::Definition.new(
+          name: name,
+          version: version,
+          type: DEFINTION_TYPE,
+        ).to_sql
+
+        Fx.database.update_trigger(
+          name,
+          on: on,
+          sql_definition: sql_definition,
+        )
+      end
+    end
+  end
+end

data/lib/fx/trigger.rb

@@ -0,0 +1,24 @@
+module Fx
+  # @api private
+  class Trigger
+    attr_reader :name, :definition
+    delegate :<=>, to: :name
+
+    def initialize(function_row)
+      @name = function_row.fetch("name")
+      @definition = function_row.fetch("definition")
+    end
+
+    def ==(other)
+      name == other.name && definition == other.definition
+    end
+
+    def to_schema
+      <<-SCHEMA
+  create_trigger :#{name}, sql_definition: <<-\SQL
+      #{definition}
+  SQL
+      SCHEMA
+    end
+  end
+end

data/lib/fx/version.rb

@@ -0,0 +1,4 @@
+module Fx
+  # @api private
+  VERSION = "0.1.0"
+end

data/lib/generators.rb

@@ -0,0 +1,11 @@
+module Fx
+  # Fx provides generators for creating and updating functions and triggers.
+  #
+  # See:
+  #
+  # * {file:lib/generators/fx/function/USAGE Function Generator}
+  # * {file:lib/generators/fx/trigger/USAGE Trigger Generator}
+  # * {file:README.md README}
+  module Generators
+  end
+end

data/lib/generators/fx/function/USAGE

@@ -0,0 +1,9 @@
+Description:
+  Create a new database function for your application. This will create a new
+  function definition file and the accompanying migration.
+
+Examples:
+    rails generate fx:function test
+
+      create: db/functions/test_v01.sql
+      create: db/migrate/[TIMESTAMP]_create_test.rb

data/lib/generators/fx/function/function_generator.rb

@@ -0,0 +1,98 @@
+require "rails/generators"
+require "rails/generators/active_record"
+
+module Fx
+  module Generators
+    # @api private
+    class FunctionGenerator < Rails::Generators::NamedBase
+      include Rails::Generators::Migration
+      source_root File.expand_path("../templates", __FILE__)
+
+      def create_functions_directory
+        unless function_definition_path.exist?
+          empty_directory(function_definition_path)
+        end
+      end
+
+      def create_function_definition
+        if creating_new_function?
+          create_file definition.path
+        else
+          copy_file previous_definition.full_path, definition.full_path
+        end
+      end
+
+      def create_migration_file
+        if updating_existing_function?
+          migration_template(
+            "db/migrate/update_function.erb",
+            "db/migrate/update_function_#{file_name}_to_version_#{version}.rb",
+          )
+        else
+          migration_template(
+            "db/migrate/create_function.erb",
+            "db/migrate/create_function_#{file_name}.rb",
+          )
+        end
+      end
+
+      def self.next_migration_number(dir)
+        ::ActiveRecord::Generators::Base.next_migration_number(dir)
+      end
+
+      no_tasks do
+        def previous_version
+          @_previous_version ||= Dir.entries(function_definition_path).
+            map { |name| version_regex.match(name).try(:[], "version").to_i }.
+            max
+        end
+
+        def version
+          @_version ||= previous_version.next
+        end
+
+        def migration_class_name
+          if updating_existing_function?
+            "UpdateFunction#{class_name}ToVersion#{version}"
+          else
+            super
+          end
+        end
+
+        def formatted_name
+          if singular_name.include?(".")
+            "\"#{singular_name}\""
+          else
+            ":#{singular_name}"
+          end
+        end
+      end
+
+      private
+
+      def function_definition_path
+        @_function_definition_path ||= Rails.root.join(*%w(db functions))
+      end
+
+      def version_regex
+        /\A#{file_name}_v(?<version>\d+)\.sql\z/
+      end
+
+      def updating_existing_function?
+        previous_version > 0
+      end
+
+      def creating_new_function?
+        previous_version == 0
+      end
+
+      def definition
+        Fx::Definition.new(name: file_name, version: version)
+      end
+
+      def previous_definition
+        Fx::Definition.new(name: file_name, version: previous_version)
+      end
+    end
+  end
+end

data/lib/generators/fx/function/templates/db/migrate/create_function.erb

@@ -0,0 +1,5 @@
+class <%= migration_class_name %> < ActiveRecord::Migration
+  def change
+    create_function <%= formatted_name %>
+  end
+end

data/lib/generators/fx/function/templates/db/migrate/update_function.erb

@@ -0,0 +1,5 @@
+class <%= migration_class_name %> < ActiveRecord::Migration
+  def change
+    update_function <%= formatted_name %>, version: <%= version %>, revert_to_version: <%= previous_version %>
+  end
+end

data/lib/generators/fx/trigger/USAGE

@@ -0,0 +1,18 @@
+Description:
+  Create a new database trigger for your application. This will create a new
+  trigger definition file and the accompanying migration.
+
+  If a trigger of the given name already exists, create a new version of the
+  trigger and a migration to replace the old version with the new.
+
+Examples:
+
+    rails generate fx:trigger test
+
+      create: db/triggers/test_v01.sql
+      create: db/migrate/[TIMESTAMP]_create_trigger_test.rb
+
+    rails generate fx:trigger test
+
+      create: db/triggers/test_v02.sql
+      create: db/migrate/[TIMESTAMP]_update_trigger_test_to_version_2.rb

data/lib/generators/fx/trigger/templates/db/migrate/create_trigger.erb

@@ -0,0 +1,5 @@
+class <%= migration_class_name %> < ActiveRecord::Migration
+  def change
+    create_trigger <%= formatted_name %>, on: <%= formatted_table_name %>
+  end
+end