fx 0.3.0 → 0.3.1

data/lib/fx/adapters/postgres.rb

@@ -23,6 +23,19 @@ module Fx
     #    config.adapter = Fx::Adapters::Postgres.new
     #  end
     class Postgres
+      # 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
       def initialize(connectable = ActiveRecord::Base)
         @connectable = connectable
       end

data/lib/fx/function.rb

@@ -1,6 +1,8 @@
 module Fx
   # @api private
   class Function
+    include Comparable
+
     attr_reader :name, :definition
     delegate :<=>, to: :name
 

data/lib/fx/statements/function.rb

@@ -36,6 +36,7 @@ module Fx
             "version or sql_definition must be specified",
           )
         end
+        sql_definition = sql_definition.strip_heredoc if sql_definition
         sql_definition ||= Fx::Definition.new(name: name, version: version).to_sql
 
         Fx.database.create_function(sql_definition)
@@ -49,8 +50,8 @@ module Fx
       #   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)
+      # @example Drop a function, rolling back to version 2 on rollback
+      #   drop_function(:uppercase_users_name, revert_to_version: 2)
       #
       def drop_function(name, revert_to_version: nil)
         Fx.database.drop_function(name)
@@ -93,6 +94,7 @@ module Fx
           )
         end
 
+        sql_definition = sql_definition.strip_heredoc if sql_definition
         sql_definition ||= Fx::Definition.new(
           name: name,
           version: version,

data/lib/fx/statements/trigger.rb

@@ -39,6 +39,7 @@ module Fx
           version = 1
         end
 
+        sql_definition = sql_definition.strip_heredoc if sql_definition
         sql_definition ||= Fx::Definition.new(
           name: name,
           version: version,
@@ -116,6 +117,7 @@ module Fx
           raise ArgumentError, "on is required"
         end
 
+        sql_definition = sql_definition.strip_heredoc if sql_definition
         sql_definition ||= Fx::Definition.new(
           name: name,
           version: version,

data/lib/fx/trigger.rb

@@ -1,6 +1,8 @@
 module Fx
   # @api private
   class Trigger
+    include Comparable
+
     attr_reader :name, :definition
     delegate :<=>, to: :name
 

data/lib/fx/version.rb

@@ -1,4 +1,4 @@
 module Fx
   # @api private
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

data/spec/acceptance_helper.rb

@@ -23,7 +23,8 @@ RSpec.configure do |config|
     Dir.chdir("spec/dummy") do
       ActiveRecord::Base.connection.disconnect!
       system <<-CMD
-        rake db:drop db:create &&
+        echo &&
+        rake db:environment:set db:drop db:create &&
         git add -A &&
         git reset --hard HEAD 1>/dev/null &&
         rm -rf .git/ 1>/dev/null

data/spec/dummy/Rakefile

@@ -4,3 +4,10 @@
 require File.expand_path('../config/application', __FILE__)
 
 Rails.application.load_tasks
+
+unless Rake::Task.task_defined?('db:environment:set')
+  desc 'dummy task for rails versions where this task does not exist'
+  task 'db:environment:set' do
+    # no-op
+  end
+end

data/spec/fx/adapters/postgres/functions_spec.rb

@@ -0,0 +1,37 @@
+require "spec_helper"
+
+module Fx
+  module Adapters
+    describe Postgres::Functions, :db do
+      describe ".all" do
+        it "returns `Function` objects" do
+          connection = ActiveRecord::Base.connection
+          connection.execute <<-EOS.strip_heredoc
+            CREATE OR REPLACE FUNCTION test()
+            RETURNS text AS $$
+            BEGIN
+                RETURN 'test';
+            END;
+            $$ LANGUAGE plpgsql;
+          EOS
+
+          functions = Postgres::Functions.new(connection).all
+
+          first = functions.first
+          expect(functions.size).to eq 1
+          expect(first.name).to eq "test"
+          expect(first.definition).to eq <<-EOS.strip_heredoc
+            CREATE OR REPLACE FUNCTION public.test()
+             RETURNS text
+             LANGUAGE plpgsql
+            AS $function$
+            BEGIN
+                RETURN 'test';
+            END;
+            $function$
+          EOS
+        end
+      end
+    end
+  end
+end

data/spec/fx/adapters/postgres/triggers_spec.rb

@@ -0,0 +1,44 @@
+require "spec_helper"
+
+module Fx
+  module Adapters
+    describe Postgres::Triggers, :db do
+      describe ".all" do
+        it "returns `Trigger` objects" do
+          connection = ActiveRecord::Base.connection
+          connection.execute <<-EOS.strip_heredoc
+            CREATE TABLE users (
+                id int PRIMARY KEY,
+                name varchar(256),
+                upper_name varchar(256)
+            );
+          EOS
+          connection.execute <<-EOS.strip_heredoc
+            CREATE OR REPLACE FUNCTION uppercase_users_name()
+            RETURNS trigger AS $$
+            BEGIN
+              NEW.upper_name = UPPER(NEW.name);
+              RETURN NEW;
+            END;
+            $$ LANGUAGE plpgsql;
+          EOS
+          connection.execute <<-EOS.strip_heredoc
+            CREATE TRIGGER uppercase_users_name
+                BEFORE INSERT ON users
+                FOR EACH ROW
+                EXECUTE PROCEDURE uppercase_users_name();
+          EOS
+
+          triggers = Postgres::Triggers.new(connection).all
+
+          first = triggers.first
+          expect(triggers.size).to eq 1
+          expect(first.name).to eq "uppercase_users_name"
+          expect(first.definition).to eq <<-EOS.strip_heredoc.strip
+            CREATE TRIGGER uppercase_users_name BEFORE INSERT ON users FOR EACH ROW EXECUTE PROCEDURE uppercase_users_name()
+          EOS
+        end
+      end
+    end
+  end
+end

data/spec/fx/function_spec.rb

@@ -0,0 +1,55 @@
+require "spec_helper"
+require "fx/function"
+
+module Fx
+  describe Function do
+    describe "#<=>" do
+      it "delegates to `name`" do
+        function_a = Function.new(
+          "name" => "name_a",
+          "definition" => "some defintion",
+        )
+        function_b = Function.new(
+          "name" => "name_b",
+          "definition" => "some defintion",
+        )
+        function_c = Function.new(
+          "name" => "name_c",
+          "definition" => "some defintion",
+        )
+
+        expect(function_b).to be_between(function_a, function_c)
+      end
+    end
+
+    describe "#==" do
+      it "compares `name` and `definition`" do
+        function_a = Function.new(
+          "name" => "name_a",
+          "definition" => "some defintion",
+        )
+        function_b = Function.new(
+          "name" => "name_b",
+          "definition" => "some other defintion",
+        )
+
+        expect(function_a).not_to eq(function_b)
+      end
+    end
+
+    describe "#to_schema" do
+      it "returns a schema compatible version of the function" do
+        function = Function.new(
+          "name" => "uppercase_users_name",
+          "definition" => "CREATE OR REPLACE TRIGGER uppercase_users_name ...",
+        )
+
+        expect(function.to_schema).to eq <<-EOS
+  create_function :uppercase_users_name, sql_definition: <<-\SQL
+      CREATE OR REPLACE TRIGGER uppercase_users_name ...
+  SQL
+        EOS
+      end
+    end
+  end
+end

data/spec/fx/trigger_spec.rb

@@ -0,0 +1,55 @@
+require "spec_helper"
+require "fx/trigger"
+
+module Fx
+  describe Trigger do
+    describe "#<=>" do
+      it "delegates to `name`" do
+        trigger_a = Trigger.new(
+          "name" => "name_a",
+          "definition" => "some defintion",
+        )
+        trigger_b = Trigger.new(
+          "name" => "name_b",
+          "definition" => "some defintion",
+        )
+        trigger_c = Trigger.new(
+          "name" => "name_c",
+          "definition" => "some defintion",
+        )
+
+        expect(trigger_b).to be_between(trigger_a, trigger_c)
+      end
+    end
+
+    describe "#==" do
+      it "compares `name` and `definition`" do
+        trigger_a = Trigger.new(
+          "name" => "name_a",
+          "definition" => "some defintion",
+        )
+        trigger_b = Trigger.new(
+          "name" => "name_b",
+          "definition" => "some other defintion",
+        )
+
+        expect(trigger_a).not_to eq(trigger_b)
+      end
+    end
+
+    describe "#to_schema" do
+      it "returns a schema compatible version of the trigger" do
+        trigger = Trigger.new(
+          "name" => "uppercase_users_name",
+          "definition" => "CREATE TRIGGER uppercase_users_name ...",
+        )
+
+        expect(trigger.to_schema).to eq <<-EOS
+  create_trigger :uppercase_users_name, sql_definition: <<-\SQL
+      CREATE TRIGGER uppercase_users_name ...
+  SQL
+        EOS
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fx
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Teo Ljungberg
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-18 00:00:00.000000000 Z
+date: 2018-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: appraisal
@@ -188,7 +188,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".hound.yml"
 - ".rspec"
+- ".rubocop.yml"
 - ".ruby-version"
 - ".travis.yml"
 - ".yardopts"
@@ -212,6 +214,8 @@ files:
 - gemfiles/rails42.gemfile.lock
 - gemfiles/rails50.gemfile
 - gemfiles/rails50.gemfile.lock
+- gemfiles/rails_edge.gemfile
+- gemfiles/rails_edge.gemfile.lock
 - lib/fx.rb
 - lib/fx/adapters/postgres.rb
 - lib/fx/adapters/postgres/connection.rb
@@ -259,15 +263,19 @@ files:
 - spec/features/functions/revert_spec.rb
 - spec/features/triggers/migrations_spec.rb
 - spec/features/triggers/revert_spec.rb
+- spec/fx/adapters/postgres/functions_spec.rb
+- spec/fx/adapters/postgres/triggers_spec.rb
 - spec/fx/adapters/postgres_spec.rb
 - spec/fx/command_recorder/arguments_spec.rb
 - spec/fx/command_recorder_spec.rb
 - spec/fx/configuration_spec.rb
 - spec/fx/definition_spec.rb
+- spec/fx/function_spec.rb
 - spec/fx/schema_dumper/function_spec.rb
 - spec/fx/schema_dumper/trigger_spec.rb
 - spec/fx/statements/function_spec.rb
 - spec/fx/statements/trigger_spec.rb
+- spec/fx/trigger_spec.rb
 - spec/generators/fx/function/function_generator_spec.rb
 - spec/generators/fx/trigger/trigger_generator_spec.rb
 - spec/spec_helper.rb
@@ -294,7 +302,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2.1
 signing_key: 
 specification_version: 4
 summary: Support for database functions and triggers in Rails migrations
@@ -317,15 +325,19 @@ test_files:
 - spec/features/functions/revert_spec.rb
 - spec/features/triggers/migrations_spec.rb
 - spec/features/triggers/revert_spec.rb
+- spec/fx/adapters/postgres/functions_spec.rb
+- spec/fx/adapters/postgres/triggers_spec.rb
 - spec/fx/adapters/postgres_spec.rb
 - spec/fx/command_recorder/arguments_spec.rb
 - spec/fx/command_recorder_spec.rb
 - spec/fx/configuration_spec.rb
 - spec/fx/definition_spec.rb
+- spec/fx/function_spec.rb
 - spec/fx/schema_dumper/function_spec.rb
 - spec/fx/schema_dumper/trigger_spec.rb
 - spec/fx/statements/function_spec.rb
 - spec/fx/statements/trigger_spec.rb
+- spec/fx/trigger_spec.rb
 - spec/generators/fx/function/function_generator_spec.rb
 - spec/generators/fx/trigger/trigger_generator_spec.rb
 - spec/spec_helper.rb