fx 0.1.0

data/spec/fx/configuration_spec.rb

@@ -0,0 +1,21 @@
+require "spec_helper"
+
+describe Fx::Configuration do
+  it "defaults the database adapter to postgres" do
+    expect(Fx.configuration.database).to be_a Fx::Adapters::Postgres
+    expect(Fx.database).to be_a Fx::Adapters::Postgres
+  end
+
+  it "allows the database adapter to be set" do
+    adapter = double("Fx Adapter")
+
+    Fx.configure do |config|
+      config.database = adapter
+    end
+
+    expect(Fx.configuration.database).to eq adapter
+    expect(Fx.database).to eq adapter
+
+    Fx.configuration = Fx::Configuration.new
+  end
+end

data/spec/fx/definition_spec.rb

@@ -0,0 +1,111 @@
+require "spec_helper"
+
+describe Fx::Definition do
+  describe "#to_sql" do
+    context "representing a function definition" do
+      it "returns the content of a function definition" do
+        sql_definition = <<~EOS
+          CREATE OR REPLACE FUNCTION test()
+          RETURNS text AS $$
+          BEGIN
+              RETURN 'test';
+          END;
+          $$ LANGUAGE plpgsql;
+        EOS
+        allow(File).to receive(:read).and_return(sql_definition)
+
+        definition = Fx::Definition.new(name: "test", version: 1)
+
+        expect(definition.to_sql).to eq sql_definition
+      end
+
+      it "raises an error if the file is empty" do
+        allow(File).to receive(:read).and_return("")
+        definition = Fx::Definition.new(name: "test", version: 1)
+
+        expect { definition.to_sql }.to raise_error(
+          RuntimeError,
+          %r(Define function in db/functions/test_v01.sql before migrating),
+        )
+      end
+    end
+
+    context "representing a trigger definition" do
+      it "returns the content of a trigger definition" do
+        sql_definition = <<~EOS
+          CREATE TRIGGER check_update
+          BEFORE UPDATE ON accounts
+          FOR EACH ROW
+          EXECUTE PROCEDURE check_account_update();
+        EOS
+        allow(File).to receive(:read).and_return(sql_definition)
+
+        definition = Fx::Definition.new(
+          name: "test",
+          version: 1,
+          type: "trigger",
+        )
+
+        expect(definition.to_sql).to eq sql_definition
+      end
+
+      it "raises an error if the file is empty" do
+        allow(File).to receive(:read).and_return("")
+        definition = Fx::Definition.new(
+          name: "test",
+          version: 1,
+          type: "trigger",
+        )
+
+        expect { definition.to_sql }.to raise_error(
+          RuntimeError,
+          %r(Define trigger in db/triggers/test_v01.sql before migrating),
+        )
+      end
+    end
+  end
+
+  describe "#path" do
+    context "representing a function definition" do
+      it "returns a sql file with padded version and function name" do
+        definition = Fx::Definition.new(name: "test", version: 1)
+
+        expect(definition.path).to eq "db/functions/test_v01.sql"
+      end
+    end
+
+    context "representing a trigger definition" do
+      it "returns a sql file with padded version and trigger name" do
+        definition = Fx::Definition.new(
+          name: "test",
+          version: 1,
+          type: "trigger",
+        )
+
+        expect(definition.path).to eq "db/triggers/test_v01.sql"
+      end
+    end
+  end
+
+  describe "#full_path" do
+    it "joins the path with Rails.root" do
+      definition = Fx::Definition.new(name: "test", version: 15)
+
+      expect(definition.full_path).to eq Rails.root.join(definition.path)
+    end
+  end
+
+  describe "#version" do
+    it "pads the version number with 0" do
+      definition = Fx::Definition.new(name: :_, version: 1)
+
+      expect(definition.version).to eq "01"
+    end
+
+    it "does not pad more than 2 characters" do
+      definition = Fx::Definition.new(name: :_, version: 15)
+
+      expect(definition.version).to eq "15"
+    end
+  end
+end

data/spec/fx/schema_dumper/function_spec.rb

@@ -0,0 +1,22 @@
+require "spec_helper"
+
+describe Fx::SchemaDumper::Function, :db do
+  it "dumps a create_function for a function in the database" do
+    sql_definition = <<~EOS
+      CREATE OR REPLACE FUNCTION test()
+      RETURNS text AS $$
+      BEGIN
+          RETURN 'test';
+      END;
+      $$ LANGUAGE plpgsql;
+    EOS
+    connection.create_function :test, sql_definition: sql_definition
+    stream = StringIO.new
+
+    ActiveRecord::SchemaDumper.dump(connection, stream)
+
+    output = stream.string
+    expect(output).to include "create_function :test, sql_definition: <<-SQL"
+    expect(output).to include "RETURN 'test';"
+  end
+end

data/spec/fx/schema_dumper/trigger_spec.rb

@@ -0,0 +1,40 @@
+require "spec_helper"
+
+describe Fx::SchemaDumper::Trigger, :db do
+  it "dumps a create_trigger for a trigger in the database" do
+    connection.execute <<~EOS
+      CREATE TABLE users (
+          id int PRIMARY KEY,
+          name varchar(256),
+          upper_name varchar(256)
+      );
+    EOS
+    Fx.database.create_function <<~EOS
+      CREATE OR REPLACE FUNCTION uppercase_users_name()
+      RETURNS trigger AS $$
+      BEGIN
+        NEW.upper_name = UPPER(NEW.name);
+        RETURN NEW;
+      END;
+      $$ LANGUAGE plpgsql;
+    EOS
+    sql_definition = <<~EOS
+      CREATE TRIGGER uppercase_users_name
+          BEFORE INSERT ON users
+          FOR EACH ROW
+          EXECUTE PROCEDURE uppercase_users_name();
+    EOS
+    connection.create_trigger(
+      :uppercase_users_name,
+      sql_definition: sql_definition,
+    )
+    stream = StringIO.new
+
+    ActiveRecord::SchemaDumper.dump(connection, stream)
+
+    output = stream.string
+    expect(output).to include "create_trigger :uppercase_users_name"
+    expect(output).to include "sql_definition: <<-SQL"
+    expect(output).to include "EXECUTE PROCEDURE uppercase_users_name()"
+  end
+end

data/spec/fx/statements/function_spec.rb

@@ -0,0 +1,103 @@
+require "spec_helper"
+require "fx/statements/function"
+
+describe Fx::Statements::Function, :db do
+  describe "#create_function" do
+    it "creates a function from a file" do
+      database = stubbed_database
+      definition = stubbed_definition
+
+      connection.create_function(:test)
+
+      expect(database).to have_received(:create_function).
+        with(definition.to_sql)
+      expect(Fx::Definition).to have_received(:new).
+        with(name: :test, version: 1)
+    end
+
+    it "allows creating a function with a specific version" do
+      database = stubbed_database
+      definition = stubbed_definition
+
+      connection.create_function(:test, version: 2)
+
+      expect(database).to have_received(:create_function).
+        with(definition.to_sql)
+      expect(Fx::Definition).to have_received(:new).
+        with(name: :test, version: 2)
+    end
+
+    it "raises an error if both arguments are nil" do
+      expect {
+        connection.create_function(
+          :whatever,
+          version: nil,
+          sql_definition: nil,
+        )
+      }.to raise_error(
+        ArgumentError,
+        /version or sql_definition must be specified/,
+      )
+    end
+  end
+
+  describe "#drop_function" do
+    it "drops the function" do
+      database = stubbed_database
+
+      connection.drop_function(:test)
+
+      expect(database).to have_received(:drop_function).with(:test)
+    end
+  end
+
+  describe "#update_function" do
+    it "updates the function" do
+      database = stubbed_database
+      definition = stubbed_definition
+
+      connection.update_function(:test, version: 3)
+
+      expect(database).to have_received(:update_function).
+        with(:test, definition.to_sql)
+      expect(Fx::Definition).to have_received(:new).
+        with(name: :test, version: 3)
+    end
+
+    it "updates a function from a text definition" do
+      database = stubbed_database
+
+      connection.update_function(:test, sql_definition: "a definition")
+
+      expect(database).to have_received(:update_function).with(
+        :test,
+        "a definition",
+      )
+    end
+
+    it "raises an error if not supplied a version" do
+      expect {
+        connection.update_function(
+          :whatever,
+          version: nil,
+          sql_definition: nil,
+        )
+      }.to raise_error(
+        ArgumentError,
+        /version or sql_definition must be specified/,
+      )
+    end
+  end
+
+  def stubbed_database
+    instance_spy("StubbedDatabase").tap do |stubbed_database|
+      allow(Fx).to receive(:database).and_return(stubbed_database)
+    end
+  end
+
+  def stubbed_definition
+    instance_double("Fx::Definition", to_sql: nil).tap do |stubbed_definition|
+      allow(Fx::Definition).to receive(:new).and_return(stubbed_definition)
+    end
+  end
+end

data/spec/fx/statements/trigger_spec.rb

@@ -0,0 +1,132 @@
+require "spec_helper"
+require "fx/statements/trigger"
+
+describe Fx::Statements::Trigger, :db do
+  describe "#create_trigger" do
+    it "creates a trigger from a file" do
+      database = stubbed_database
+      definition = stubbed_definition
+
+      connection.create_trigger(:test)
+
+      expect(database).to have_received(:create_trigger).
+        with(definition.to_sql)
+      expect(Fx::Definition).to have_received(:new).
+        with(name: :test, version: 1, type: "trigger")
+    end
+
+    it "allows creating a trigger with a specific version" do
+      database = stubbed_database
+      definition = stubbed_definition
+
+      connection.create_trigger(:test, version: 2)
+
+      expect(database).to have_received(:create_trigger).
+        with(definition.to_sql)
+      expect(Fx::Definition).to have_received(:new).
+        with(name: :test, version: 2, type: "trigger")
+    end
+
+    it "raises an error if both arguments are set" do
+      stubbed_database
+
+      expect {
+        connection.create_trigger(
+          :whatever,
+          version: 1,
+          sql_definition: "a definition",
+        )
+      }.to raise_error(
+        ArgumentError,
+        /cannot both be set/,
+      )
+    end
+  end
+
+  describe "#drop_trigger" do
+    it "drops the trigger" do
+      database = stubbed_database
+
+      connection.drop_trigger(:test, on: :users)
+
+      expect(database).to have_received(:drop_trigger).
+        with(:test, on: :users)
+    end
+  end
+
+  describe "#update_trigger" do
+    it "updates the trigger" do
+      database = stubbed_database
+      definition = stubbed_definition
+
+      connection.update_trigger(:test, on: :users, version: 3)
+
+      expect(database).to have_received(:update_trigger).with(
+        :test,
+        on: :users,
+        sql_definition: definition.to_sql,
+      )
+      expect(Fx::Definition).to have_received(:new).with(
+        name: :test,
+        version: 3,
+        type: "trigger",
+      )
+    end
+
+    it "updates a trigger from a text definition" do
+      database = stubbed_database
+
+      connection.update_trigger(
+        :test,
+        on: :users,
+        sql_definition: "a definition",
+      )
+
+      expect(database).to have_received(:update_trigger).with(
+        :test,
+        on: :users,
+        sql_definition: "a definition",
+      )
+    end
+
+    it "raises an error if not supplied a version" do
+      expect {
+        connection.update_trigger(
+          :whatever,
+          version: nil,
+          sql_definition: nil,
+        )
+      }.to raise_error(
+        ArgumentError,
+        /version or sql_definition must be specified/,
+      )
+    end
+
+    it "raises an error if both arguments are set" do
+      stubbed_database
+
+      expect {
+        connection.update_trigger(
+          :whatever,
+          version: 1,
+          sql_definition: "a definition",
+        )
+      }.to raise_error(
+        ArgumentError,
+        /cannot both be set/,
+      )
+    end
+  end
+
+  def stubbed_database
+    instance_spy("StubbedDatabase").tap do |stubbed_database|
+      allow(Fx).to receive(:database).and_return(stubbed_database)
+    end
+  end
+
+  def stubbed_definition
+    instance_double("Fx::Definition", to_sql: nil).tap do |stubbed_definition|
+      allow(Fx::Definition).to receive(:new).and_return(stubbed_definition)
+    end
+  end
+end

data/spec/generators/fx/function/function_generator_spec.rb

@@ -0,0 +1,34 @@
+require "spec_helper"
+require "generators/fx/function/function_generator"
+
+describe Fx::Generators::FunctionGenerator, :generator do
+  it "creates a function definition file, and a migration" do
+    migration = file("db/migrate/create_function_test.rb")
+    function_definition = file("db/functions/test_v01.sql")
+
+    run_generator ["test"]
+
+    expect(function_definition).to exist
+    expect(migration).to be_a_migration
+    expect(migration_file(migration)).to contain "CreateFunctionTest"
+  end
+
+  it "updates an existing function" do
+    with_function_definition(
+      name: "test",
+      version: 1,
+      sql_definition: "hello",
+    ) do
+      allow(Dir).to receive(:entries).and_return(["test_v01.sql"])
+      migration = file("db/migrate/update_function_test_to_version_2.rb")
+      function_definition = file("db/functions/test_v02.sql")
+
+      run_generator ["test"]
+
+      expect(function_definition).to exist
+      expect(migration).to be_a_migration
+      expect(migration_file(migration)).
+        to contain("UpdateFunctionTestToVersion2")
+    end
+  end
+end