fx 0.1.0

data/gemfiles/rails41.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 4.1.0"
+gem "railties", "~> 4.1.0"
+
+gemspec :path => "../"

data/gemfiles/rails41.gemfile.lock

@@ -0,0 +1,113 @@
+PATH
+  remote: ../
+  specs:
+    fx (0.1.0)
+      activerecord (>= 4.0.0)
+      railties (>= 4.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (4.1.15)
+      actionview (= 4.1.15)
+      activesupport (= 4.1.15)
+      rack (~> 1.5.2)
+      rack-test (~> 0.6.2)
+    actionview (4.1.15)
+      activesupport (= 4.1.15)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+    activemodel (4.1.15)
+      activesupport (= 4.1.15)
+      builder (~> 3.1)
+    activerecord (4.1.15)
+      activemodel (= 4.1.15)
+      activesupport (= 4.1.15)
+      arel (~> 5.0.0)
+    activesupport (4.1.15)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    ammeter (1.1.3)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-rails (>= 2.2)
+    appraisal (2.1.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    arel (5.0.1.20140414130214)
+    builder (3.2.2)
+    coderay (1.1.1)
+    database_cleaner (1.5.3)
+    diff-lcs (1.2.5)
+    erubis (2.7.0)
+    i18n (0.7.0)
+    json (1.8.3)
+    method_source (0.8.2)
+    minitest (5.9.0)
+    pg (0.18.4)
+    pry (0.10.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rack (1.5.5)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    railties (4.1.15)
+      actionpack (= 4.1.15)
+      activesupport (= 4.1.15)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (11.1.2)
+    redcarpet (3.3.4)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.4)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-rails (3.4.2)
+      actionpack (>= 3.0, < 4.3)
+      activesupport (>= 3.0, < 4.3)
+      railties (>= 3.0, < 4.3)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    slop (3.6.0)
+    thor (0.19.1)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    yard (0.8.7.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 4.1.0)
+  ammeter (>= 1.1.3)
+  appraisal
+  bundler (>= 1.5)
+  database_cleaner
+  fx!
+  pg
+  pry
+  railties (~> 4.1.0)
+  rake
+  redcarpet
+  rspec (>= 3.3)
+  yard
+
+BUNDLED WITH
+   1.12.4

data/gemfiles/rails42.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 4.2.0"
+gem "railties", "~> 4.2.0"
+
+gemspec :path => "../"

data/gemfiles/rails42.gemfile.lock

@@ -0,0 +1,130 @@
+PATH
+  remote: ../
+  specs:
+    fx (0.1.0)
+      activerecord (>= 4.0.0)
+      railties (>= 4.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (4.2.6)
+      actionview (= 4.2.6)
+      activesupport (= 4.2.6)
+      rack (~> 1.6)
+      rack-test (~> 0.6.2)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (4.2.6)
+      activesupport (= 4.2.6)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    activemodel (4.2.6)
+      activesupport (= 4.2.6)
+      builder (~> 3.1)
+    activerecord (4.2.6)
+      activemodel (= 4.2.6)
+      activesupport (= 4.2.6)
+      arel (~> 6.0)
+    activesupport (4.2.6)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    ammeter (1.1.3)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-rails (>= 2.2)
+    appraisal (2.1.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    arel (6.0.3)
+    builder (3.2.2)
+    coderay (1.1.1)
+    database_cleaner (1.5.3)
+    diff-lcs (1.2.5)
+    erubis (2.7.0)
+    i18n (0.7.0)
+    json (1.8.3)
+    loofah (2.0.3)
+      nokogiri (>= 1.5.9)
+    method_source (0.8.2)
+    mini_portile2 (2.0.0)
+    minitest (5.9.0)
+    nokogiri (1.6.7.2)
+      mini_portile2 (~> 2.0.0.rc2)
+    pg (0.18.4)
+    pry (0.10.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rack (1.6.4)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails-deprecated_sanitizer (1.0.3)
+      activesupport (>= 4.2.0.alpha)
+    rails-dom-testing (1.0.7)
+      activesupport (>= 4.2.0.beta, < 5.0)
+      nokogiri (~> 1.6.0)
+      rails-deprecated_sanitizer (>= 1.0.1)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
+    railties (4.2.6)
+      actionpack (= 4.2.6)
+      activesupport (= 4.2.6)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (11.1.2)
+    redcarpet (3.3.4)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.4)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-rails (3.4.2)
+      actionpack (>= 3.0, < 4.3)
+      activesupport (>= 3.0, < 4.3)
+      railties (>= 3.0, < 4.3)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    slop (3.6.0)
+    thor (0.19.1)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    yard (0.8.7.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 4.2.0)
+  ammeter (>= 1.1.3)
+  appraisal
+  bundler (>= 1.5)
+  database_cleaner
+  fx!
+  pg
+  pry
+  railties (~> 4.2.0)
+  rake
+  redcarpet
+  rspec (>= 3.3)
+  yard
+
+BUNDLED WITH
+   1.12.4

data/gemfiles/rails50.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 5.0"
+gem "railties", "~> 5.0"
+
+gemspec :path => "../"

data/gemfiles/rails50.gemfile.lock

@@ -0,0 +1,126 @@
+PATH
+  remote: ../
+  specs:
+    fx (0.1.0)
+      activerecord (>= 4.0.0)
+      railties (>= 4.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (5.0.0.1)
+      actionview (= 5.0.0.1)
+      activesupport (= 5.0.0.1)
+      rack (~> 2.0)
+      rack-test (~> 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.0.0.1)
+      activesupport (= 5.0.0.1)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    activemodel (5.0.0.1)
+      activesupport (= 5.0.0.1)
+    activerecord (5.0.0.1)
+      activemodel (= 5.0.0.1)
+      activesupport (= 5.0.0.1)
+      arel (~> 7.0)
+    activesupport (5.0.0.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    ammeter (1.1.3)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-rails (>= 2.2)
+    appraisal (2.1.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    arel (7.1.4)
+    builder (3.2.2)
+    coderay (1.1.1)
+    concurrent-ruby (1.0.2)
+    database_cleaner (1.5.3)
+    diff-lcs (1.2.5)
+    erubis (2.7.0)
+    i18n (0.7.0)
+    loofah (2.0.3)
+      nokogiri (>= 1.5.9)
+    method_source (0.8.2)
+    mini_portile2 (2.1.0)
+    minitest (5.9.1)
+    nokogiri (1.6.8.1)
+      mini_portile2 (~> 2.1.0)
+    pg (0.18.4)
+    pry (0.10.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rack (2.0.1)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails-dom-testing (2.0.1)
+      activesupport (>= 4.2.0, < 6.0)
+      nokogiri (~> 1.6.0)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
+    railties (5.0.0.1)
+      actionpack (= 5.0.0.1)
+      activesupport (= 5.0.0.1)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (11.2.2)
+    redcarpet (3.3.4)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.4)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-rails (3.5.2)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    slop (3.6.0)
+    thor (0.19.1)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    yard (0.8.7.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 5.0)
+  ammeter (>= 1.1.3)
+  appraisal
+  bundler (>= 1.5)
+  database_cleaner
+  fx!
+  pg
+  pry
+  railties (~> 5.0)
+  rake
+  redcarpet
+  rspec (>= 3.3)
+  yard
+
+BUNDLED WITH
+   1.13.3

data/lib/fx.rb

@@ -0,0 +1,21 @@
+require "fx/version"
+require "fx/adapters/postgres"
+require "fx/command_recorder"
+require "fx/configuration"
+require "fx/definition"
+require "fx/function"
+require "fx/statements"
+require "fx/schema_dumper"
+require "fx/trigger"
+
+# F(x) adds methods `ActiveRecord::Migration` to create and manage database
+# triggers and functions in Rails applications.
+module Fx
+  # The current database adapter used by F(x).
+  #
+  # This defaults to {Fx::Adapters::Postgres} but can be overridden
+  # via {Configuration}.
+  def self.database
+    configuration.database
+  end
+end

data/lib/fx/adapters/postgres.rb

@@ -0,0 +1,142 @@
+require "fx/adapters/postgres/connection"
+require "fx/adapters/postgres/functions"
+require "fx/adapters/postgres/triggers"
+
+module Fx
+  # F(x) database adapters.
+  #
+  # F(x) ships with a Postgres adapter only but can be extended with
+  # additional adapters. The {Fx::Adapters::Postgres} adapter provides the
+  # interface.
+  module Adapters
+    # Creates an instance of the F(x) Postgres adapter.
+    #
+    # This is the default adapter for F(x). Configuring it via
+    # {Fx.configure} is not required, but the example below shows how one
+    # would explicitly set it.
+    #
+    # @param [#connection] connectable An object that returns the connection
+    #   for F(x) to use. Defaults to `ActiveRecord::Base`.
+    #
+    # @example
+    #  Fx.configure do |config|
+    #    config.adapter = Fx::Adapters::Postgres.new
+    #  end
+    class Postgres
+      def initialize(connectable = ActiveRecord::Base)
+        @connectable = connectable
+      end
+
+      # Returns an array of functions in the database.
+      #
+      # This collection of functions is used by the [Fx::SchemaDumper] to
+      # populate the `schema.rb` file.
+      #
+      # @return [Array<Fx::Function>]
+      def functions
+        Functions.all(connection)
+      end
+
+      # Returns an array of triggers in the database.
+      #
+      # This collection of triggers is used by the [Fx::SchemaDumper] to
+      # populate the `schema.rb` file.
+      #
+      # @return [Array<Fx::Trigger>]
+      def triggers
+        Triggers.all(connection)
+      end
+
+      # Creates a function in the database.
+      #
+      # This is typically called in a migration via
+      # {Fx::Statements::Function#create_function}.
+      #
+      # @param sql_definition The SQL schema for the function.
+      #
+      # @return [void]
+      def create_function(sql_definition)
+        execute sql_definition
+      end
+
+      # Creates a trigger in the database.
+      #
+      # This is typically called in a migration via
+      # {Fx::Statements::Trigger#create_trigger}.
+      #
+      # @param sql_definition The SQL schema for the trigger.
+      #
+      # @return [void]
+      def create_trigger(sql_definition)
+        execute sql_definition
+      end
+
+      # Updates a function in the database.
+      #
+      # This is typically called in a migration via
+      # {Fx::Statements::Function#update_function}.
+      #
+      # @param name The name of the function.
+      # @param sql_definition The SQL schema for the function.
+      #
+      # @return [void]
+      def update_function(name, sql_definition)
+        drop_function(name)
+        create_function(sql_definition)
+      end
+
+      # Updates a trigger in the database.
+      #
+      # The existing trigger is dropped and recreated using the supplied `on`
+      # and `version` parameter.
+      #
+      # This is typically called in a migration via
+      # {Fx::Statements::Function#update_trigger}.
+      #
+      # @param name The name of the trigger.
+      # @param on The associated table for the trigger to drop
+      # @param sql_definition The SQL schema for the function.
+      #
+      # @return [void]
+      def update_trigger(name, on:, sql_definition:)
+        drop_trigger(name, on: on)
+        create_trigger(sql_definition)
+      end
+
+      # Drops the function from the database
+      #
+      # This is typically called in a migration via
+      # {Fx::Statements::Function#drop_function}.
+      #
+      # @param name The name of the function to drop
+      #
+      # @return [void]
+      def drop_function(name)
+        execute "DROP FUNCTION #{name}();"
+      end
+
+      # Drops the trigger from the database
+      #
+      # This is typically called in a migration via
+      # {Fx::Statements::Trigger#drop_trigger}.
+      #
+      # @param name The name of the trigger to drop
+      # @param on The associated table for the trigger to drop
+      #
+      # @return [void]
+      def drop_trigger(name, on:)
+        execute "DROP TRIGGER #{name} ON #{on};"
+      end
+
+      private
+
+      attr_reader :connectable
+
+      delegate :execute, to: :connection
+
+      def connection
+        Connection.new(connectable.connection)
+      end
+    end
+  end
+end